[mirror_edk2.git] / NetworkPkg / IpSecDxe / IpSecImpl.h

/** @file\r
  The definitions related to IPsec protocol implementation.\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 _IP_SEC_IMPL_H_\r
#define _IP_SEC_IMPL_H_\r
\r
#include <Uefi.h>\r
#include <Library/UefiLib.h>\r
#include <Library/NetLib.h>\r
#include <Library/BaseMemoryLib.h>\r
#include <Library/UefiBootServicesTableLib.h>\r
#include <Library/MemoryAllocationLib.h>\r
#include <Protocol/IpSec.h>\r
#include <Protocol/IpSecConfig.h>\r
#include <Protocol/Dpc.h>\r
#include <Protocol/ComponentName.h>\r
#include <Protocol/ComponentName2.h>\r
\r
typedef struct _IPSEC_PRIVATE_DATA IPSEC_PRIVATE_DATA;\r
typedef struct _IPSEC_SPD_ENTRY IPSEC_SPD_ENTRY;\r
typedef struct _IPSEC_PAD_ENTRY IPSEC_PAD_ENTRY;\r
typedef struct _IPSEC_SPD_DATA IPSEC_SPD_DATA;\r
\r
#define IPSEC_PRIVATE_DATA_SIGNATURE        SIGNATURE_32 ('I', 'P', 'S', 'E')\r
\r
#define IPSEC_PRIVATE_DATA_FROM_IPSEC(a)    CR (a, IPSEC_PRIVATE_DATA, IpSec, IPSEC_PRIVATE_DATA_SIGNATURE)\r
#define IPSEC_PRIVATE_DATA_FROM_UDP4LIST(a) CR (a, IPSEC_PRIVATE_DATA, Udp4List, IPSEC_PRIVATE_DATA_SIGNATURE)\r
#define IPSEC_PRIVATE_DATA_FROM_UDP6LIST(a) CR (a, IPSEC_PRIVATE_DATA, Udp6List, IPSEC_PRIVATE_DATA_SIGNATURE)\r
#define IPSEC_UDP_SERVICE_FROM_LIST(a)      BASE_CR (a, IKE_UDP_SERVICE, List)\r
#define IPSEC_SPD_ENTRY_FROM_LIST(a)        BASE_CR (a, IPSEC_SPD_ENTRY, List)\r
#define IPSEC_SAD_ENTRY_FROM_LIST(a)        BASE_CR (a, IPSEC_SAD_ENTRY, List)\r
#define IPSEC_PAD_ENTRY_FROM_LIST(a)        BASE_CR (a, IPSEC_PAD_ENTRY, List)\r
#define IPSEC_SAD_ENTRY_FROM_SPD(a)         BASE_CR (a, IPSEC_SAD_ENTRY, BySpd)\r
\r
#define IPSEC_STATUS_DISABLED       0\r
#define IPSEC_STATUS_ENABLED        1\r
#define IPSEC_ESP_PROTOCOL          50\r
#define IPSEC_AH_PROTOCOL           51\r
#define IPSEC_DEFAULT_VARIABLE_SIZE 0x100\r
\r
//\r
// Internal Structure Definition\r
//\r
#pragma pack(1)\r
typedef struct _EFI_AH_HEADER {\r
  UINT8   NextHeader;\r
  UINT8   PayloadLen;\r
  UINT16  Reserved;\r
  UINT32  Spi;\r
  UINT32  SequenceNumber;\r
} EFI_AH_HEADER;\r
\r
typedef struct _EFI_ESP_HEADER {\r
  UINT32  Spi;\r
  UINT32  SequenceNumber;\r
} EFI_ESP_HEADER;\r
\r
typedef struct _EFI_ESP_TAIL {\r
  UINT8 PaddingLength;\r
  UINT8 NextHeader;\r
} EFI_ESP_TAIL;\r
#pragma pack()\r
\r
struct _IPSEC_SPD_DATA {\r
  CHAR16                    Name[100];\r
  UINT32                    PackageFlag;\r
  EFI_IPSEC_ACTION          Action;\r
  EFI_IPSEC_PROCESS_POLICY  *ProcessingPolicy;\r
  LIST_ENTRY                Sas;\r
};\r
\r
struct _IPSEC_SPD_ENTRY {\r
  EFI_IPSEC_SPD_SELECTOR  *Selector;\r
  IPSEC_SPD_DATA          *Data;\r
  LIST_ENTRY              List;\r
};\r
\r
typedef struct _IPSEC_SAD_DATA {\r
  EFI_IPSEC_MODE         Mode;\r
  UINT64                 SequenceNumber;\r
  UINT8                  AntiReplayWindowSize;\r
  UINT64                 AntiReplayBitmap[4];  // bitmap for received packet\r
  EFI_IPSEC_ALGO_INFO    AlgoInfo;\r
  EFI_IPSEC_SA_LIFETIME  SaLifetime;\r
  UINT32                 PathMTU;\r
  IPSEC_SPD_ENTRY        *SpdEntry;\r
  EFI_IPSEC_SPD_SELECTOR *SpdSelector;\r
  BOOLEAN                ESNEnabled;           // Extended (64-bit) SN enabled\r
  BOOLEAN                ManualSet;\r
  EFI_IP_ADDRESS         TunnelDestAddress;\r
  EFI_IP_ADDRESS         TunnelSourceAddress;\r
} IPSEC_SAD_DATA;\r
\r
typedef struct _IPSEC_SAD_ENTRY {\r
  EFI_IPSEC_SA_ID  *Id;\r
  IPSEC_SAD_DATA  *Data;\r
  LIST_ENTRY      List;\r
  LIST_ENTRY      BySpd;                      // Linked on IPSEC_SPD_DATA.Sas\r
} IPSEC_SAD_ENTRY;\r
\r
struct _IPSEC_PAD_ENTRY {\r
  EFI_IPSEC_PAD_ID    *Id;\r
  EFI_IPSEC_PAD_DATA  *Data;\r
  LIST_ENTRY          List;\r
};\r
\r
typedef struct _IPSEC_RECYCLE_CONTEXT {\r
  EFI_IPSEC_FRAGMENT_DATA *FragmentTable;\r
  UINT8                   *PayloadBuffer;\r
} IPSEC_RECYCLE_CONTEXT;\r
\r
//\r
// Struct used to store the Hash and its data.\r
//\r
typedef struct {
  UINTN DataSize;
  UINT8 *Data;
} HASH_DATA_FRAGMENT;\r
\r
struct _IPSEC_PRIVATE_DATA {\r
  UINT32                    Signature;\r
  EFI_HANDLE                Handle;           // Virtual handle to install private prtocol\r
  EFI_HANDLE                ImageHandle;\r
  EFI_IPSEC2_PROTOCOL       IpSec;\r
  EFI_IPSEC_CONFIG_PROTOCOL IpSecConfig;\r
  BOOLEAN                   SetBySelf;\r
  LIST_ENTRY                Udp4List;\r
  UINTN                     Udp4Num;\r
  LIST_ENTRY                Udp6List;\r
  UINTN                     Udp6Num;\r
  LIST_ENTRY                Ikev1SessionList;\r
  LIST_ENTRY                Ikev1EstablishedList;\r
  LIST_ENTRY                Ikev2SessionList;\r
  LIST_ENTRY                Ikev2EstablishedList;\r
  BOOLEAN                   IsIPsecDisabling;\r
};\r
\r
/**\r
  This function processes the inbound traffic with IPsec.\r
\r
  It checks the received packet security property, trims the ESP/AH header, and then \r
  returns without an IPsec protected IP Header and FragmentTable.\r
  \r
  @param[in]      IpVersion          The version of IP.\r
  @param[in, out] IpHead             Points to IP header containing the ESP/AH header \r
                                     to be trimed on input, and without ESP/AH header\r
                                     on return.\r
  @param[in, out] LastHead           The Last Header in IP header on return.\r
  @param[in, out] OptionsBuffer      Pointer to the options buffer.\r
  @param[in, out] OptionsLength      Length of the options buffer.\r
  @param[in, out] FragmentTable      Pointer to a list of fragments in form of IPsec\r
                                     protected on input, and without IPsec protected\r
                                     on return.\r
  @param[in, out] FragmentCount      The number of fragments.\r
  @param[out]     SpdEntry           Pointer to contain the address of SPD entry on return.\r
  @param[out]     RecycleEvent       The event for recycling of resources.\r
\r
  @retval EFI_SUCCESS              The operation was successful.\r
  @retval EFI_UNSUPPORTED          The IPSEC protocol is not supported.\r
\r
**/\r
EFI_STATUS\r
IpSecProtectInboundPacket (\r
  IN     UINT8                       IpVersion,\r
  IN OUT VOID                        *IpHead,\r
  IN OUT UINT8                       *LastHead,\r
  IN OUT VOID                        **OptionsBuffer,\r
  IN OUT UINT32                      *OptionsLength,\r
  IN OUT EFI_IPSEC_FRAGMENT_DATA     **FragmentTable,\r
  IN OUT UINT32                      *FragmentCount,\r
     OUT EFI_IPSEC_SPD_SELECTOR      **SpdEntry,\r
     OUT EFI_EVENT                   *RecycleEvent\r
  );\r
\r
\r
/**\r
  This fucntion processes the output traffic with IPsec.\r
\r
  It protected the sending packet by encrypting it payload and inserting ESP/AH header\r
  in the orginal IP header, then return the IpHeader and IPsec protected Fragmentable.\r
\r
  @param[in]      IpVersion          The version of IP.\r
  @param[in, out] IpHead             Point to IP header containing the orginal IP header\r
                                     to be processed on input, and inserted ESP/AH header\r
                                     on return.\r
  @param[in, out] LastHead           The Last Header in IP header.\r
  @param[in, out] OptionsBuffer      Pointer to the options buffer.\r
  @param[in, out] OptionsLength      Length of the options buffer.\r
  @param[in, out] FragmentTable      Pointer to a list of fragments to be protected by\r
                                     IPsec on input, and with IPsec protected\r
                                     on return.\r
  @param[in, out] FragmentCount      Number of fragments.\r
  @param[in]      SadEntry           Related SAD entry.\r
  @param[out]     RecycleEvent       Event for recycling of resources.\r
\r
  @retval EFI_SUCCESS              The operation is successful.\r
  @retval EFI_UNSUPPORTED          If the IPSEC protocol is not supported.\r
\r
**/\r
EFI_STATUS\r
IpSecProtectOutboundPacket (\r
  IN     UINT8                       IpVersion,\r
  IN OUT VOID                        *IpHead,\r
  IN OUT UINT8                       *LastHead,\r
  IN OUT VOID                        **OptionsBuffer,\r
  IN OUT UINT32                      *OptionsLength,\r
  IN OUT EFI_IPSEC_FRAGMENT_DATA     **FragmentTable,\r
  IN OUT UINT32                      *FragmentCount,\r
  IN     IPSEC_SAD_ENTRY             *SadEntry,\r
     OUT EFI_EVENT                   *RecycleEvent\r
  );\r
\r
/**\r
  Check if the IP Address in the address range of AddressInfos specified.\r
\r
  @param[in]  IpVersion         The IP version.\r
  @param[in]  IpAddr            Points to EFI_IP_ADDRESS to be check.\r
  @param[in]  AddressInfo       A list of EFI_IP_ADDRESS_INFO that is used to check\r
                                the IP Address is matched.\r
  @param[in]  AddressCount      The total numbers of the AddressInfo.\r
\r
  @retval   TRUE    If the Specified IP Address is in the range of the AddressInfos specified.\r
  @retval   FALSE   If the Specified IP Address is not in the range of the AddressInfos specified.\r
\r
**/\r
BOOLEAN\r
IpSecMatchIpAddress (\r
  IN UINT8                                  IpVersion,\r
  IN EFI_IP_ADDRESS                         *IpAddr,\r
  IN EFI_IP_ADDRESS_INFO                    *AddressInfo,\r
  IN UINT32                                 AddressCount\r
  );\r
\r
/**\r
  Find a PAD entry according to remote IP address.\r
\r
  @param[in]  IpVersion         The version of IP.\r
  @param[in]  IpAddr            Point to remote IP address.\r
\r
  @return The pointer of related PAD entry.\r
\r
**/\r
IPSEC_PAD_ENTRY *\r
IpSecLookupPadEntry (\r
  IN UINT8                                  IpVersion,\r
  IN EFI_IP_ADDRESS                         *IpAddr\r
  );\r
\r
/**\r
  Check if the specified IP packet can be serviced by this SPD entry.\r
\r
  @param[in]  SpdEntry          Point to SPD entry.\r
  @param[in]  IpVersion         Version of IP.\r
  @param[in]  IpHead            Point to IP header.\r
  @param[in]  IpPayload         Point to IP payload.\r
  @param[in]  Protocol          The Last protocol of IP packet.\r
  @param[in]  IsOutbound        Traffic direction.\r
  @param[out] Action            The support action of SPD entry.\r
\r
  @retval EFI_SUCCESS       Find the related SPD.\r
  @retval EFI_NOT_FOUND     Not find the related SPD entry;\r
\r
**/\r
EFI_STATUS\r
IpSecLookupSpdEntry (\r
  IN     IPSEC_SPD_ENTRY         *SpdEntry,\r
  IN     UINT8                   IpVersion,\r
  IN     VOID                    *IpHead,\r
  IN     UINT8                   *IpPayload,\r
  IN     UINT8                   Protocol,\r
  IN     BOOLEAN                 IsOutbound, \r
     OUT EFI_IPSEC_ACTION        *Action\r
  );\r
\r
/**\r
  Look up if there is existing SAD entry for specified IP packet sending.\r
\r
  This function is called by the IPsecProcess when there is some IP packet needed to\r
  send out. This function checks if there is an existing SAD entry that can be serviced\r
  to this IP packet sending. If no existing SAD entry could be used, this\r
  function will invoke an IPsec Key Exchange Negotiation.\r
\r
  @param[in]  Private           Points to private data.\r
  @param[in]  NicHandle         Points to a NIC handle.\r
  @param[in]  IpVersion         The version of IP.\r
  @param[in]  IpHead            The IP Header of packet to be sent out.\r
  @param[in]  IpPayload         The IP Payload to be sent out.\r
  @param[in]  OldLastHead       The Last protocol of the IP packet.\r
  @param[in]  SpdEntry          Points to a related SPD entry.\r
  @param[out] SadEntry          Contains the Point of a related SAD entry.\r
\r
  @retval EFI_DEVICE_ERROR  One of following conditions is TRUE:\r
                            - If don't find related UDP service.\r
                            - Sequence Number is used up.\r
                            - Extension Sequence Number is used up.\r
  @retval EFI_NOT_READY     No existing SAD entry could be used.\r
  @retval EFI_SUCCESS       Find the related SAD entry.\r
\r
**/\r
EFI_STATUS\r
IpSecLookupSadEntry (\r
  IN IPSEC_PRIVATE_DATA      *Private,\r
  IN EFI_HANDLE              NicHandle,\r
  IN UINT8                   IpVersion,\r
  IN VOID                    *IpHead,\r
  IN UINT8                   *IpPayload,\r
  IN UINT8                   OldLastHead,\r
  IN IPSEC_SPD_ENTRY         *SpdEntry,\r
  OUT IPSEC_SAD_ENTRY        **SadEntry\r
  );\r
\r
/**\r
  Find the SAD through whole SAD list.\r
\r
  @param[in]  Spi               The SPI used to search the SAD entry.\r
  @param[in]  DestAddress       The destination used to search the SAD entry.\r
  @param[in]  IpVersion         The IP version. Ip4 or Ip6.\r
\r
  @return  The pointer to a certain SAD entry.\r
\r
**/\r
IPSEC_SAD_ENTRY *\r
IpSecLookupSadBySpi (\r
  IN UINT32                                 Spi,\r
  IN EFI_IP_ADDRESS                         *DestAddress,\r
  IN UINT8                                  IpVersion\r
  )\r
;\r
\r
/**\r
  Handles IPsec packet processing for inbound and outbound IP packets.\r
\r
  The EFI_IPSEC_PROCESS process routine handles each inbound or outbound packet.\r
  The behavior is that it can perform one of the following actions:\r
  bypass the packet, discard the packet, or protect the packet.\r
\r
  @param[in]      This             Pointer to the EFI_IPSEC2_PROTOCOL instance.\r
  @param[in]      NicHandle        Instance of the network interface.\r
  @param[in]      IpVersion        IPV4 or IPV6.\r
  @param[in, out] IpHead           Pointer to the IP Header.\r
  @param[in, out] LastHead         The protocol of the next layer to be processed by IPsec.\r
  @param[in, out] OptionsBuffer    Pointer to the options buffer.\r
  @param[in, out] OptionsLength    Length of the options buffer.\r
  @param[in, out] FragmentTable    Pointer to a list of fragments.\r
  @param[in, out] FragmentCount    Number of fragments.\r
  @param[in]      TrafficDirection Traffic direction.\r
  @param[out]     RecycleSignal    Event for recycling of resources.\r
\r
  @retval EFI_SUCCESS              The packet was bypassed and all buffers remain the same.\r
  @retval EFI_SUCCESS              The packet was protected.\r
  @retval EFI_ACCESS_DENIED        The packet was discarded.\r
\r
**/\r
EFI_STATUS\r
EFIAPI\r
IpSecProcess (\r
  IN     EFI_IPSEC2_PROTOCOL              *This,\r
  IN     EFI_HANDLE                      NicHandle,\r
  IN     UINT8                           IpVersion,\r
  IN OUT VOID                            *IpHead,\r
  IN OUT UINT8                           *LastHead,\r
  IN OUT VOID                            **OptionsBuffer,\r
  IN OUT UINT32                          *OptionsLength,\r
  IN OUT EFI_IPSEC_FRAGMENT_DATA         **FragmentTable,\r
  IN OUT UINT32                          *FragmentCount,\r
  IN     EFI_IPSEC_TRAFFIC_DIR           TrafficDirection,\r
     OUT EFI_EVENT                       *RecycleSignal\r
  );\r
\r
extern EFI_DPC_PROTOCOL    *mDpc;\r
extern EFI_IPSEC2_PROTOCOL  mIpSecInstance;\r
\r
extern EFI_COMPONENT_NAME2_PROTOCOL gIpSecComponentName2;\r
extern EFI_COMPONENT_NAME_PROTOCOL  gIpSecComponentName;\r
\r
\r
#endif\r
Commit	Line	Data
a3bcde70 HT	1	/** @file\r
	2	The definitions related to IPsec protocol implementation.\r
	3	\r
47b27101	4	Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>\r
a3bcde70 HT	5	\r
	6	This program and the accompanying materials\r
	7	are licensed and made available under the terms and conditions of the BSD License\r
	8	which accompanies this distribution. The full text of the license may be found at\r
	9	http://opensource.org/licenses/bsd-license.php.\r
	10	\r
	11	THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
	12	WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
	13	\r
	14	**/\r
	15	\r
	16	#ifndef _IP_SEC_IMPL_H_\r
	17	#define _IP_SEC_IMPL_H_\r
	18	\r
	19	#include <Uefi.h>\r
	20	#include <Library/UefiLib.h>\r
	21	#include <Library/NetLib.h>\r
	22	#include <Library/BaseMemoryLib.h>\r
	23	#include <Library/UefiBootServicesTableLib.h>\r
	24	#include <Library/MemoryAllocationLib.h>\r
	25	#include <Protocol/IpSec.h>\r
	26	#include <Protocol/IpSecConfig.h>\r
	27	#include <Protocol/Dpc.h>\r
	28	#include <Protocol/ComponentName.h>\r
	29	#include <Protocol/ComponentName2.h>\r
	30	\r
	31	typedef struct _IPSEC_PRIVATE_DATA IPSEC_PRIVATE_DATA;\r
	32	typedef struct _IPSEC_SPD_ENTRY IPSEC_SPD_ENTRY;\r
	33	typedef struct _IPSEC_PAD_ENTRY IPSEC_PAD_ENTRY;\r
	34	typedef struct _IPSEC_SPD_DATA IPSEC_SPD_DATA;\r
	35	\r
	36	#define IPSEC_PRIVATE_DATA_SIGNATURE SIGNATURE_32 ('I', 'P', 'S', 'E')\r
	37	\r
	38	#define IPSEC_PRIVATE_DATA_FROM_IPSEC(a) CR (a, IPSEC_PRIVATE_DATA, IpSec, IPSEC_PRIVATE_DATA_SIGNATURE)\r
	39	#define IPSEC_PRIVATE_DATA_FROM_UDP4LIST(a) CR (a, IPSEC_PRIVATE_DATA, Udp4List, IPSEC_PRIVATE_DATA_SIGNATURE)\r
	40	#define IPSEC_PRIVATE_DATA_FROM_UDP6LIST(a) CR (a, IPSEC_PRIVATE_DATA, Udp6List, IPSEC_PRIVATE_DATA_SIGNATURE)\r
	41	#define IPSEC_UDP_SERVICE_FROM_LIST(a) BASE_CR (a, IKE_UDP_SERVICE, List)\r
	42	#define IPSEC_SPD_ENTRY_FROM_LIST(a) BASE_CR (a, IPSEC_SPD_ENTRY, List)\r
	43	#define IPSEC_SAD_ENTRY_FROM_LIST(a) BASE_CR (a, IPSEC_SAD_ENTRY, List)\r
	44	#define IPSEC_PAD_ENTRY_FROM_LIST(a) BASE_CR (a, IPSEC_PAD_ENTRY, List)\r
	45	#define IPSEC_SAD_ENTRY_FROM_SPD(a) BASE_CR (a, IPSEC_SAD_ENTRY, BySpd)\r
	46	\r
	47	#define IPSEC_STATUS_DISABLED 0\r
	48	#define IPSEC_STATUS_ENABLED 1\r
	49	#define IPSEC_ESP_PROTOCOL 50\r
	50	#define IPSEC_AH_PROTOCOL 51\r
	51	#define IPSEC_DEFAULT_VARIABLE_SIZE 0x100\r
	52	\r
	53	//\r
	54	// Internal Structure Definition\r
	55	//\r
	56	#pragma pack(1)\r
	57	typedef struct _EFI_AH_HEADER {\r
	58	UINT8 NextHeader;\r
	59	UINT8 PayloadLen;\r
	60	UINT16 Reserved;\r
	61	UINT32 Spi;\r
	62	UINT32 SequenceNumber;\r
	63	} EFI_AH_HEADER;\r
	64	\r
	65	typedef struct _EFI_ESP_HEADER {\r
	66	UINT32 Spi;\r
	67	UINT32 SequenceNumber;\r
	68	} EFI_ESP_HEADER;\r
69	\r
70	typedef struct _EFI_ESP_TAIL {\r
71	UINT8 PaddingLength;\r
72	UINT8 NextHeader;\r
73	} EFI_ESP_TAIL;\r
74	#pragma pack()\r
75	\r
76	struct _IPSEC_SPD_DATA {\r
77	CHAR16 Name[100];\r
78	UINT32 PackageFlag;\r
79	EFI_IPSEC_ACTION Action;\r
80	EFI_IPSEC_PROCESS_POLICY *ProcessingPolicy;\r
81	LIST_ENTRY Sas;\r
82	};\r
83	\r
84	struct _IPSEC_SPD_ENTRY {\r
85	EFI_IPSEC_SPD_SELECTOR *Selector;\r
86	IPSEC_SPD_DATA *Data;\r
87	LIST_ENTRY List;\r
88	};\r
89	\r
90	typedef struct _IPSEC_SAD_DATA {\r
68d3f2fb	91	EFI_IPSEC_MODE Mode;\r
	92	UINT64 SequenceNumber;\r
	93	UINT8 AntiReplayWindowSize;\r
	94	UINT64 AntiReplayBitmap[4]; // bitmap for received packet\r
	95	EFI_IPSEC_ALGO_INFO AlgoInfo;\r
	96	EFI_IPSEC_SA_LIFETIME SaLifetime;\r
	97	UINT32 PathMTU;\r
	98	IPSEC_SPD_ENTRY *SpdEntry;\r
	99	EFI_IPSEC_SPD_SELECTOR *SpdSelector;\r
	100	BOOLEAN ESNEnabled; // Extended (64-bit) SN enabled\r
	101	BOOLEAN ManualSet;\r
	102	EFI_IP_ADDRESS TunnelDestAddress;\r
	103	EFI_IP_ADDRESS TunnelSourceAddress;\r
a3bcde70 HT	104	} IPSEC_SAD_DATA;\r
	105	\r
	106	typedef struct _IPSEC_SAD_ENTRY {\r
	107	EFI_IPSEC_SA_ID *Id;\r
	108	IPSEC_SAD_DATA *Data;\r
	109	LIST_ENTRY List;\r
	110	LIST_ENTRY BySpd; // Linked on IPSEC_SPD_DATA.Sas\r
	111	} IPSEC_SAD_ENTRY;\r
	112	\r
	113	struct _IPSEC_PAD_ENTRY {\r
	114	EFI_IPSEC_PAD_ID *Id;\r
	115	EFI_IPSEC_PAD_DATA *Data;\r
	116	LIST_ENTRY List;\r
	117	};\r
	118	\r
	119	typedef struct _IPSEC_RECYCLE_CONTEXT {\r
	120	EFI_IPSEC_FRAGMENT_DATA *FragmentTable;\r
	121	UINT8 *PayloadBuffer;\r
	122	} IPSEC_RECYCLE_CONTEXT;\r
	123	\r
9166f840	124	//\r
	125	// Struct used to store the Hash and its data.\r
	126	//\r
	127	typedef struct {
	128	UINTN DataSize;
	129	UINT8 *Data;
	130	} HASH_DATA_FRAGMENT;\r
	131	\r
a3bcde70 HT	132	struct _IPSEC_PRIVATE_DATA {\r
	133	UINT32 Signature;\r
	134	EFI_HANDLE Handle; // Virtual handle to install private prtocol\r
	135	EFI_HANDLE ImageHandle;\r
68d3f2fb	136	EFI_IPSEC2_PROTOCOL IpSec;\r
a3bcde70 HT	137	EFI_IPSEC_CONFIG_PROTOCOL IpSecConfig;\r
	138	BOOLEAN SetBySelf;\r
	139	LIST_ENTRY Udp4List;\r
	140	UINTN Udp4Num;\r
	141	LIST_ENTRY Udp6List;\r
	142	UINTN Udp6Num;\r
	143	LIST_ENTRY Ikev1SessionList;\r
	144	LIST_ENTRY Ikev1EstablishedList;\r
	145	LIST_ENTRY Ikev2SessionList;\r
	146	LIST_ENTRY Ikev2EstablishedList;\r
	147	BOOLEAN IsIPsecDisabling;\r
	148	};\r
	149	\r
	150	/**\r
	151	This function processes the inbound traffic with IPsec.\r
	152	\r
9166f840	153	It checks the received packet security property, trims the ESP/AH header, and then \r
a3bcde70	154	returns without an IPsec protected IP Header and FragmentTable.\r
9166f840	155	\r
a3bcde70	156	@param[in] IpVersion The version of IP.\r
9166f840	157	@param[in, out] IpHead Points to IP header containing the ESP/AH header \r
a3bcde70 HT	158	to be trimed on input, and without ESP/AH header\r
a3bcde70 HT	159	on return.\r
9166f840	160	@param[in, out] LastHead The Last Header in IP header on return.\r
47b27101	161	@param[in, out] OptionsBuffer Pointer to the options buffer.\r
47b27101	162	@param[in, out] OptionsLength Length of the options buffer.\r
9166f840	163	@param[in, out] FragmentTable Pointer to a list of fragments in form of IPsec\r
a3bcde70 HT	164	protected on input, and without IPsec protected\r
a3bcde70 HT	165	on return.\r
9166f840	166	@param[in, out] FragmentCount The number of fragments.\r
a3bcde70	167	@param[out] SpdEntry Pointer to contain the address of SPD entry on return.\r
9166f840	168	@param[out] RecycleEvent The event for recycling of resources.\r
a3bcde70	169	\r
9166f840	170	@retval EFI_SUCCESS The operation was successful.\r
9166f840	171	@retval EFI_UNSUPPORTED The IPSEC protocol is not supported.\r
a3bcde70 HT	172	\r
	173	**/\r
	174	EFI_STATUS\r
	175	IpSecProtectInboundPacket (\r
	176	IN UINT8 IpVersion,\r
	177	IN OUT VOID *IpHead,\r
9166f840	178	IN OUT UINT8 *LastHead,\r
47b27101	179	IN OUT VOID **OptionsBuffer,\r
47b27101	180	IN OUT UINT32 *OptionsLength,\r
a3bcde70	181	IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable,\r
68d3f2fb	182	IN OUT UINT32 *FragmentCount,\r
9166f840	183	OUT EFI_IPSEC_SPD_SELECTOR **SpdEntry,\r
a3bcde70 HT	184	OUT EFI_EVENT *RecycleEvent\r
	185	);\r
	186	\r
	187	\r
	188	/**\r
	189	This fucntion processes the output traffic with IPsec.\r
	190	\r
	191	It protected the sending packet by encrypting it payload and inserting ESP/AH header\r
	192	in the orginal IP header, then return the IpHeader and IPsec protected Fragmentable.\r
	193	\r
	194	@param[in] IpVersion The version of IP.\r
	195	@param[in, out] IpHead Point to IP header containing the orginal IP header\r
	196	to be processed on input, and inserted ESP/AH header\r
	197	on return.\r
68d3f2fb	198	@param[in, out] LastHead The Last Header in IP header.\r
47b27101	199	@param[in, out] OptionsBuffer Pointer to the options buffer.\r
47b27101	200	@param[in, out] OptionsLength Length of the options buffer.\r
a3bcde70 HT	201	@param[in, out] FragmentTable Pointer to a list of fragments to be protected by\r
	202	IPsec on input, and with IPsec protected\r
	203	on return.\r
68d3f2fb	204	@param[in, out] FragmentCount Number of fragments.\r
a3bcde70 HT	205	@param[in] SadEntry Related SAD entry.\r
	206	@param[out] RecycleEvent Event for recycling of resources.\r
	207	\r
	208	@retval EFI_SUCCESS The operation is successful.\r
	209	@retval EFI_UNSUPPORTED If the IPSEC protocol is not supported.\r
	210	\r
	211	**/\r
	212	EFI_STATUS\r
	213	IpSecProtectOutboundPacket (\r
	214	IN UINT8 IpVersion,\r
	215	IN OUT VOID *IpHead,\r
68d3f2fb	216	IN OUT UINT8 *LastHead,\r
47b27101	217	IN OUT VOID **OptionsBuffer,\r
47b27101	218	IN OUT UINT32 *OptionsLength,\r
a3bcde70	219	IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable,\r
68d3f2fb	220	IN OUT UINT32 *FragmentCount,\r
a3bcde70 HT	221	IN IPSEC_SAD_ENTRY *SadEntry,\r
	222	OUT EFI_EVENT *RecycleEvent\r
	223	);\r
	224	\r
	225	/**\r
	226	Check if the IP Address in the address range of AddressInfos specified.\r
	227	\r
	228	@param[in] IpVersion The IP version.\r
	229	@param[in] IpAddr Points to EFI_IP_ADDRESS to be check.\r
	230	@param[in] AddressInfo A list of EFI_IP_ADDRESS_INFO that is used to check\r
	231	the IP Address is matched.\r
	232	@param[in] AddressCount The total numbers of the AddressInfo.\r
	233	\r
	234	@retval TRUE If the Specified IP Address is in the range of the AddressInfos specified.\r
	235	@retval FALSE If the Specified IP Address is not in the range of the AddressInfos specified.\r
	236	\r
	237	**/\r
	238	BOOLEAN\r
	239	IpSecMatchIpAddress (\r
	240	IN UINT8 IpVersion,\r
	241	IN EFI_IP_ADDRESS *IpAddr,\r
	242	IN EFI_IP_ADDRESS_INFO *AddressInfo,\r
	243	IN UINT32 AddressCount\r
	244	);\r
	245	\r
	246	/**\r
	247	Find a PAD entry according to remote IP address.\r
	248	\r
	249	@param[in] IpVersion The version of IP.\r
	250	@param[in] IpAddr Point to remote IP address.\r
	251	\r
	252	@return The pointer of related PAD entry.\r
	253	\r
	254	**/\r
	255	IPSEC_PAD_ENTRY *\r
	256	IpSecLookupPadEntry (\r
	257	IN UINT8 IpVersion,\r
	258	IN EFI_IP_ADDRESS *IpAddr\r
	259	);\r
	260	\r
9166f840	261	/**\r
	262	Check if the specified IP packet can be serviced by this SPD entry.\r
	263	\r
	264	@param[in] SpdEntry Point to SPD entry.\r
	265	@param[in] IpVersion Version of IP.\r
	266	@param[in] IpHead Point to IP header.\r
	267	@param[in] IpPayload Point to IP payload.\r
	268	@param[in] Protocol The Last protocol of IP packet.\r
	269	@param[in] IsOutbound Traffic direction.\r
	270	@param[out] Action The support action of SPD entry.\r
	271	\r
	272	@retval EFI_SUCCESS Find the related SPD.\r
	273	@retval EFI_NOT_FOUND Not find the related SPD entry;\r
	274	\r
	275	**/\r
	276	EFI_STATUS\r
	277	IpSecLookupSpdEntry (\r
	278	IN IPSEC_SPD_ENTRY *SpdEntry,\r
	279	IN UINT8 IpVersion,\r
	280	IN VOID *IpHead,\r
	281	IN UINT8 *IpPayload,\r
	282	IN UINT8 Protocol,\r
	283	IN BOOLEAN IsOutbound, \r
	284	OUT EFI_IPSEC_ACTION *Action\r
	285	);\r
	286	\r
	287	/**\r
	288	Look up if there is existing SAD entry for specified IP packet sending.\r
	289	\r
	290	This function is called by the IPsecProcess when there is some IP packet needed to\r
	291	send out. This function checks if there is an existing SAD entry that can be serviced\r
	292	to this IP packet sending. If no existing SAD entry could be used, this\r
	293	function will invoke an IPsec Key Exchange Negotiation.\r
	294	\r
	295	@param[in] Private Points to private data.\r
	296	@param[in] NicHandle Points to a NIC handle.\r
	297	@param[in] IpVersion The version of IP.\r
	298	@param[in] IpHead The IP Header of packet to be sent out.\r
	299	@param[in] IpPayload The IP Payload to be sent out.\r
	300	@param[in] OldLastHead The Last protocol of the IP packet.\r
	301	@param[in] SpdEntry Points to a related SPD entry.\r
	302	@param[out] SadEntry Contains the Point of a related SAD entry.\r
	303	\r
	304	@retval EFI_DEVICE_ERROR One of following conditions is TRUE:\r
	305	- If don't find related UDP service.\r
	306	- Sequence Number is used up.\r
	307	- Extension Sequence Number is used up.\r
	308	@retval EFI_NOT_READY No existing SAD entry could be used.\r
	309	@retval EFI_SUCCESS Find the related SAD entry.\r
	310	\r
	311	**/\r
	312	EFI_STATUS\r
	313	IpSecLookupSadEntry (\r
	314	IN IPSEC_PRIVATE_DATA *Private,\r
	315	IN EFI_HANDLE NicHandle,\r
	316	IN UINT8 IpVersion,\r
	317	IN VOID *IpHead,\r
	318	IN UINT8 *IpPayload,\r
	319	IN UINT8 OldLastHead,\r
	320	IN IPSEC_SPD_ENTRY *SpdEntry,\r
	321	OUT IPSEC_SAD_ENTRY **SadEntry\r
	322	);\r
	323	\r
a3bcde70 HT	324	/**\r
	325	Find the SAD through whole SAD list.\r
	326	\r
	327	@param[in] Spi The SPI used to search the SAD entry.\r
	328	@param[in] DestAddress The destination used to search the SAD entry.\r
9166f840	329	@param[in] IpVersion The IP version. Ip4 or Ip6.\r
a3bcde70 HT	330	\r
	331	@return The pointer to a certain SAD entry.\r
	332	\r
	333	**/\r
	334	IPSEC_SAD_ENTRY *\r
	335	IpSecLookupSadBySpi (\r
	336	IN UINT32 Spi,\r
9166f840	337	IN EFI_IP_ADDRESS *DestAddress,\r
9166f840	338	IN UINT8 IpVersion\r
a3bcde70 HT	339	)\r
	340	;\r
	341	\r
	342	/**\r
	343	Handles IPsec packet processing for inbound and outbound IP packets.\r
	344	\r
	345	The EFI_IPSEC_PROCESS process routine handles each inbound or outbound packet.\r
	346	The behavior is that it can perform one of the following actions:\r
	347	bypass the packet, discard the packet, or protect the packet.\r
	348	\r
0a7294f7	349	@param[in] This Pointer to the EFI_IPSEC2_PROTOCOL instance.\r
a3bcde70 HT	350	@param[in] NicHandle Instance of the network interface.\r
	351	@param[in] IpVersion IPV4 or IPV6.\r
	352	@param[in, out] IpHead Pointer to the IP Header.\r
68d3f2fb	353	@param[in, out] LastHead The protocol of the next layer to be processed by IPsec.\r
	354	@param[in, out] OptionsBuffer Pointer to the options buffer.\r
	355	@param[in, out] OptionsLength Length of the options buffer.\r
a3bcde70	356	@param[in, out] FragmentTable Pointer to a list of fragments.\r
68d3f2fb	357	@param[in, out] FragmentCount Number of fragments.\r
a3bcde70 HT	358	@param[in] TrafficDirection Traffic direction.\r
	359	@param[out] RecycleSignal Event for recycling of resources.\r
	360	\r
	361	@retval EFI_SUCCESS The packet was bypassed and all buffers remain the same.\r
	362	@retval EFI_SUCCESS The packet was protected.\r
	363	@retval EFI_ACCESS_DENIED The packet was discarded.\r
	364	\r
	365	**/\r
	366	EFI_STATUS\r
	367	EFIAPI\r
	368	IpSecProcess (\r
68d3f2fb	369	IN EFI_IPSEC2_PROTOCOL *This,\r
a3bcde70 HT	370	IN EFI_HANDLE NicHandle,\r
	371	IN UINT8 IpVersion,\r
	372	IN OUT VOID *IpHead,\r
68d3f2fb	373	IN OUT UINT8 *LastHead,\r
	374	IN OUT VOID **OptionsBuffer,\r
	375	IN OUT UINT32 *OptionsLength,\r
a3bcde70	376	IN OUT EFI_IPSEC_FRAGMENT_DATA **FragmentTable,\r
68d3f2fb	377	IN OUT UINT32 *FragmentCount,\r
a3bcde70 HT	378	IN EFI_IPSEC_TRAFFIC_DIR TrafficDirection,\r
	379	OUT EFI_EVENT *RecycleSignal\r
	380	);\r
	381	\r
	382	extern EFI_DPC_PROTOCOL *mDpc;\r
68d3f2fb	383	extern EFI_IPSEC2_PROTOCOL mIpSecInstance;\r
a3bcde70 HT	384	\r
	385	extern EFI_COMPONENT_NAME2_PROTOCOL gIpSecComponentName2;\r
	386	extern EFI_COMPONENT_NAME_PROTOCOL gIpSecComponentName;\r
	387	\r
	388	\r
	389	#endif\r