NetworkPkg/Application/IpsecConfig/IpSecConfig.h

   1 /** @file
   2   The internal structure and function declaration in IpSecConfig application.
   3
   4   Copyright (c) 2009 - 2016, Intel Corporation. All rights reserved.<BR>
   5
   6   This program and the accompanying materials
   7   are licensed and made available under the terms and conditions of the BSD License
   8   which accompanies this distribution.  The full text of the license may be found at
   9   http://opensource.org/licenses/bsd-license.php.
  10
  11   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
  12   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
  13
  14 **/
  15
  16 #ifndef _IPSEC_CONFIG_H_
  17 #define _IPSEC_CONFIG_H_
  18
  19 #include <Library/BaseMemoryLib.h>
  20 #include <Library/UefiLib.h>
  21 #include <Library/ShellLib.h>
  22 #include <Library/DebugLib.h>
  23 #include <Library/MemoryAllocationLib.h>
  24 #include <Library/UefiBootServicesTableLib.h>
  25 #include <Library/UefiHiiServicesLib.h>
  26 #include <Library/NetLib.h>
  27
  28 #include <Protocol/IpSecConfig.h>
  29
  30 #define ARRAY_SIZE(x) (sizeof(x) / sizeof(x[0]))
  31
  32 #define IPSECCONFIG_STATUS_NAME    L"IpSecStatus"
  33
  34 #define BIT(x)   (UINT32) (1 << (x))
  35
  36 #define IPSEC_STATUS_DISABLED    0x0
  37 #define IPSEC_STATUS_ENABLED     0x1
  38
  39 #define EFI_IP4_PROTO_ICMP       0x1
  40 #define EFI_IP4_PROTO_TCP        0x6
  41 #define EFI_IP4_PROTO_UDP        0x11
  42
  43 #define EFI_IPSEC_ANY_PROTOCOL    0xFFFF
  44 #define EFI_IPSEC_ANY_PORT        0
  45
  46 ///
  47 /// IPsec Authentication Algorithm Definition
  48 ///   The number value definition is aligned to IANA assignment
  49 ///
  50 #define IPSEC_AALG_NONE                0x00
  51 #define IPSEC_AALG_MD5HMAC             0x01
  52 #define IPSEC_AALG_SHA1HMAC            0x02
  53 #define IPSEC_AALG_SHA2_256HMAC        0x05
  54 #define IPSEC_AALG_SHA2_384HMAC        0x06
  55 #define IPSEC_AALG_SHA2_512HMAC        0x07
  56 #define IPSEC_AALG_AES_XCBC_MAC        0x09
  57 #define IPSEC_AALG_NULL                0xFB
  58
  59 ///
  60 /// IPsec Encryption Algorithm Definition
  61 ///   The number value definition is aligned to IANA assignment
  62 ///
  63 #define IPSEC_EALG_NONE                0x00
  64 #define IPSEC_EALG_DESCBC              0x02
  65 #define IPSEC_EALG_3DESCBC             0x03
  66 #define IPSEC_EALG_CASTCBC             0x06
  67 #define IPSEC_EALG_BLOWFISHCBC         0x07
  68 #define IPSEC_EALG_NULL                0x0B
  69 #define IPSEC_EALG_AESCBC              0x0C
  70 #define IPSEC_EALG_AESCTR              0x0D
  71 #define IPSEC_EALG_AES_CCM_ICV8        0x0E
  72 #define IPSEC_EALG_AES_CCM_ICV12       0x0F
  73 #define IPSEC_EALG_AES_CCM_ICV16       0x10
  74 #define IPSEC_EALG_AES_GCM_ICV8        0x12
  75 #define IPSEC_EALG_AES_GCM_ICV12       0x13
  76 #define IPSEC_EALG_AES_GCM_ICV16       0x14
  77
  78 typedef struct {
  79   CHAR16      *VarName;
  80   UINT32      Attribute1;
  81   UINT32      Attribute2;
  82   UINT32      Attribute3;
  83   UINT32      Attribute4;
  84 } VAR_CHECK_ITEM;
  85
  86 typedef struct {
  87   LIST_ENTRY        Link;
  88   CHAR16            *Name;
  89   SHELL_PARAM_TYPE  Type;
  90   CHAR16            *Value;
  91   UINTN             OriginalPosition;
  92 } SHELL_PARAM_PACKAGE;
  93
  94 typedef struct {
  95   CHAR16        *String;
  96   UINT32        Integer;
  97 } STR2INT;
  98
  99 extern EFI_IPSEC_CONFIG_PROTOCOL    *mIpSecConfig;
 100 extern EFI_HII_HANDLE               mHiiHandle;
 101 extern CHAR16                       mAppName[];
 102
 103 //
 104 // -P
 105 //
 106 extern STR2INT mMapPolicy[];
 107
 108 //
 109 // --proto
 110 //
 111 extern STR2INT mMapIpProtocol[];
 112
 113 //
 114 // --action
 115 //
 116 extern STR2INT mMapIpSecAction[];
 117
 118 //
 119 // --mode
 120 //
 121 extern STR2INT mMapIpSecMode[];
 122
 123 //
 124 // --dont-fragment
 125 //
 126 extern STR2INT mMapDfOption[];
 127
 128 //
 129 // --ipsec-proto
 130 //
 131 extern STR2INT mMapIpSecProtocol[];
 132 //
 133 // --auth-algo
 134 //
 135 extern STR2INT mMapAuthAlgo[];
 136
 137 //
 138 // --encrypt-algo
 139 //
 140 extern STR2INT mMapEncAlgo[];
 141 //
 142 // --auth-proto
 143 //
 144 extern STR2INT mMapAuthProto[];
 145
 146 //
 147 // --auth-method
 148 //
 149 extern STR2INT mMapAuthMethod[];
 150
 151 #endif