NetworkPkg: Support print help information using -? command.

[mirror_edk2.git] / NetworkPkg / Application / IpsecConfig / IpSecConfig.h

/** @file\r
  The internal structure and function declaration in IpSecConfig application.\r
\r
  Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
\r
  This program and the accompanying materials\r
  are licensed and made available under the terms and conditions of the BSD License\r
  which accompanies this distribution.  The full text of the license may be found at\r
  http://opensource.org/licenses/bsd-license.php.\r
\r
  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
\r
**/\r
\r
#ifndef _IPSEC_CONFIG_H_\r
#define _IPSEC_CONFIG_H_\r
\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiLib.h>\r
#include <Library/ShellLib.h>\r
#include <Library/DebugLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/UefiHiiServicesLib.h>\r
#include <Library/NetLib.h>\r
\r
#include <Protocol/IpSecConfig.h>\r
\r
//\r
// String token ID of VConfig command help message text.\r
//\r
GLOBAL_REMOVE_IF_UNREFERENCED EFI_STRING_ID mStringIpSecHelpTokenId = STRING_TOKEN (STR_IPSEC_CONFIG_HELP);\r
\r
#define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))\r
\r
#define IPSECCONFIG_STATUS_NAME    L"IpSecStatus"\r
\r
#define BIT(x)   (UINT32) (1 << (x))\r
\r
#define IPSEC_STATUS_DISABLED    0x0\r
#define IPSEC_STATUS_ENABLED     0x1\r
\r
#define EFI_IP4_PROTO_ICMP       0x1\r
#define EFI_IP4_PROTO_TCP        0x6\r
#define EFI_IP4_PROTO_UDP        0x11\r
\r
#define EFI_IPSEC_ANY_PROTOCOL    0xFFFF\r
#define EFI_IPSEC_ANY_PORT        0\r
\r
///\r
/// IPsec Authentication Algorithm Definition\r
///   The number value definition is aligned to IANA assignment\r
///\r
#define IPSEC_AALG_NONE                0x00\r
#define IPSEC_AALG_MD5HMAC             0x01\r
#define IPSEC_AALG_SHA1HMAC            0x02\r
#define IPSEC_AALG_SHA2_256HMAC        0x05\r
#define IPSEC_AALG_SHA2_384HMAC        0x06\r
#define IPSEC_AALG_SHA2_512HMAC        0x07\r
#define IPSEC_AALG_AES_XCBC_MAC        0x09\r
#define IPSEC_AALG_NULL                0xFB\r
\r
///\r
/// IPsec Encryption Algorithm Definition\r
///   The number value definition is aligned to IANA assignment\r
///\r
#define IPSEC_EALG_NONE                0x00\r
#define IPSEC_EALG_DESCBC              0x02\r
#define IPSEC_EALG_3DESCBC             0x03\r
#define IPSEC_EALG_CASTCBC             0x06\r
#define IPSEC_EALG_BLOWFISHCBC         0x07\r
#define IPSEC_EALG_NULL                0x0B\r
#define IPSEC_EALG_AESCBC              0x0C\r
#define IPSEC_EALG_AESCTR              0x0D\r
#define IPSEC_EALG_AES_CCM_ICV8        0x0E\r
#define IPSEC_EALG_AES_CCM_ICV12       0x0F\r
#define IPSEC_EALG_AES_CCM_ICV16       0x10\r
#define IPSEC_EALG_AES_GCM_ICV8        0x12\r
#define IPSEC_EALG_AES_GCM_ICV12       0x13\r
#define IPSEC_EALG_AES_GCM_ICV16       0x14\r
\r
typedef struct {\r
  CHAR16      *VarName;\r
  UINT32      Attribute1;\r
  UINT32      Attribute2;\r
  UINT32      Attribute3;\r
  UINT32      Attribute4;\r
} VAR_CHECK_ITEM;\r
\r
typedef struct {\r
  LIST_ENTRY        Link;\r
  CHAR16            *Name;\r
  SHELL_PARAM_TYPE  Type;\r
  CHAR16            *Value;\r
  UINTN             OriginalPosition;\r
} SHELL_PARAM_PACKAGE;\r
\r
typedef struct {\r
  CHAR16        *String;\r
  UINT32        Integer;\r
} STR2INT;\r
\r
extern EFI_IPSEC_CONFIG_PROTOCOL    *mIpSecConfig;\r
extern EFI_HII_HANDLE               mHiiHandle;\r
extern CHAR16                       mAppName[];\r
\r
//\r
// -P\r
//\r
extern STR2INT mMapPolicy[];\r
\r
//\r
// --proto\r
//\r
extern STR2INT mMapIpProtocol[];\r
\r
//\r
// --action\r
//\r
extern STR2INT mMapIpSecAction[];\r
\r
//\r
// --mode\r
//\r
extern STR2INT mMapIpSecMode[];\r
\r
//\r
// --dont-fragment\r
//\r
extern STR2INT mMapDfOption[];\r
\r
//\r
// --ipsec-proto\r
//\r
extern STR2INT mMapIpSecProtocol[];\r
//\r
// --auth-algo\r
//\r
extern STR2INT mMapAuthAlgo[];\r
\r
//\r
// --encrypt-algo\r
//\r
extern STR2INT mMapEncAlgo[];\r
//\r
// --auth-proto\r
//\r
extern STR2INT mMapAuthProto[];\r
\r
//\r
// --auth-method\r
//\r
extern STR2INT mMapAuthMethod[];\r
\r
#endif\r