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

/** @file\r
  The function declaration of policy entry operation in IpSecConfig application.\r
\r
  Copyright (c) 2009 - 2010, 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 _POLICY_ENTRY_OPERATION_H_\r
#define _POLICY_ENTRY_OPERATION_H_\r
\r
#define LOCAL              BIT(0)\r
#define REMOTE             BIT(1)\r
#define PROTO              BIT(2)\r
#define LOCAL_PORT         BIT(3)\r
#define REMOTE_PORT        BIT(4)\r
#define ICMP_TYPE          BIT(5)\r
#define ICMP_CODE          BIT(6)\r
#define NAME               BIT(7)\r
#define PACKET_FLAG        BIT(8)\r
#define ACTION             BIT(9)\r
#define EXT_SEQUENCE       BIT(10)\r
#define SEQUENCE_OVERFLOW  BIT(11)\r
#define FRAGMENT_CHECK     BIT(12)\r
#define LIFEBYTE           BIT(13)\r
#define LIFETIME_SOFT      BIT(14)\r
#define LIFETIME           BIT(15)\r
#define MODE               BIT(16)\r
#define TUNNEL_LOCAL       BIT(17)\r
#define TUNNEL_REMOTE      BIT(18)\r
#define DONT_FRAGMENT      BIT(19)\r
#define IPSEC_PROTO        BIT(20)\r
#define AUTH_ALGO          BIT(21)\r
#define ENCRYPT_ALGO       BIT(22)\r
#define SPI                BIT(23)\r
#define DEST               BIT(24)\r
#define SEQUENCE_NUMBER    BIT(25)\r
#define ANTIREPLAY_WINDOW  BIT(26)\r
#define AUTH_KEY           BIT(27)\r
#define ENCRYPT_KEY        BIT(28)\r
#define PATH_MTU           BIT(29)\r
\r
#define PEER_ID            BIT(0)\r
#define PEER_ADDRESS       BIT(1)\r
#define AUTH_PROTO         BIT(2)\r
#define AUTH_METHOD        BIT(3)\r
#define IKE_ID             BIT(4)\r
#define AUTH_DATA          BIT(5)\r
#define REVOCATION_DATA    BIT(6)\r
\r
typedef struct {\r
  EFI_IPSEC_CONFIG_DATA_TYPE    DataType;\r
  EFI_IPSEC_CONFIG_SELECTOR     *Selector;    // Data to be inserted.\r
  VOID                          *Data;\r
  UINT32                        Mask;\r
  POLICY_ENTRY_INDEXER          Indexer;\r
  EFI_STATUS                    Status;       // Indicate whether insertion succeeds.\r
} EDIT_POLICY_ENTRY_CONTEXT;\r
\r
typedef struct {\r
  EFI_IPSEC_CONFIG_DATA_TYPE    DataType;\r
  EFI_IPSEC_CONFIG_SELECTOR     *Selector;    // Data to be inserted.\r
  VOID                          *Data;\r
  POLICY_ENTRY_INDEXER          Indexer;\r
  EFI_STATUS                    Status;       // Indicate whether insertion succeeds.\r
} INSERT_POLICY_ENTRY_CONTEXT;\r
\r
/**\r
  The prototype for the CreateSpdEntry()/CreateSadEntry()/CreatePadEntry().\r
  Fill in EFI_IPSEC_CONFIG_SELECTOR and corresponding data thru ParamPackage list.\r
\r
  @param[out] Selector        The pointer to the EFI_IPSEC_CONFIG_SELECTOR union.\r
  @param[out] Data            The pointer to corresponding data.\r
  @param[in]  ParamPackage    The pointer to the ParamPackage list.\r
  @param[out] Mask            The pointer to the Mask.\r
  @param[in]  CreateNew       The switch to create new.\r
\r
  @retval EFI_SUCCESS              Filled in EFI_IPSEC_CONFIG_SELECTOR and corresponding data successfully.\r
  @retval EFI_INVALID_PARAMETER    Invalid user input parameter.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(*CREATE_POLICY_ENTRY) (\r
  OUT EFI_IPSEC_CONFIG_SELECTOR    **Selector,\r
  OUT VOID                         **Data,\r
  IN  LIST_ENTRY                   *ParamPackage,\r
  OUT UINT32                       *Mask,\r
  IN  BOOLEAN                      CreateNew\r
  );\r
\r
/**\r
  The prototype for the CombineSpdEntry()/CombineSadEntry()/CombinePadEntry().\r
  Combine old SPD/SAD/PAD entry with new SPD/SAD/PAD entry.\r
\r
  @param[in, out] OldSelector    The pointer to the old EFI_IPSEC_CONFIG_SELECTOR union.\r
  @param[in, out] OldData        The pointer to the corresponding old data.\r
  @param[in]      NewSelector    The pointer to the new EFI_IPSEC_CONFIG_SELECTOR union.\r
  @param[in]      NewData        The pointer to the corresponding new data.\r
  @param[in]      Mask           The pointer to the Mask.\r
  @param[out]     CreateNew      The switch to create new.\r
\r
  @retval EFI_SUCCESS              Combined successfully.\r
  @retval EFI_INVALID_PARAMETER    Invalid user input parameter.\r
\r
**/\r
typedef\r
EFI_STATUS\r
(* COMBINE_POLICY_ENTRY) (\r
  EFI_IPSEC_CONFIG_SELECTOR    *OldSelector,\r
  VOID                         *OldData,\r
  EFI_IPSEC_CONFIG_SELECTOR    *NewSelector,\r
  VOID                         *NewData,\r
  UINT32                       Mask,\r
  BOOLEAN                      *CreateNew\r
  );\r
\r
/**\r
  Insert or add entry information in database according to datatype.\r
\r
  @param[in] DataType        The value of EFI_IPSEC_CONFIG_DATA_TYPE.\r
  @param[in] ParamPackage    The pointer to the ParamPackage list.\r
\r
  @retval EFI_SUCCESS             Insert or add entry information successfully.\r
  @retval EFI_NOT_FOUND           Can't find the specified entry.\r
  @retval EFI_BUFFER_TOO_SMALL    The entry already existed.\r
  @retval EFI_UNSUPPORTED         The operation is not supported./\r
  @retval Others                  Some mistaken case.\r
**/\r
EFI_STATUS\r
AddOrInsertPolicyEntry (\r
  IN EFI_IPSEC_CONFIG_DATA_TYPE    DataType,\r
  IN LIST_ENTRY                    *ParamPackage\r
  );\r
\r
/**\r
  Edit entry information in the database according to datatype.\r
\r
  @param[in] DataType        The value of EFI_IPSEC_CONFIG_DATA_TYPE.\r
  @param[in] ParamPackage    The pointer to the ParamPackage list.\r
\r
  @retval EFI_SUCCESS             Edit entry information successfully.\r
  @retval EFI_NOT_FOUND           Can't find the specified entry.\r
  @retval Others                  Some mistaken case.\r
**/\r
EFI_STATUS\r
EditPolicyEntry (\r
  IN EFI_IPSEC_CONFIG_DATA_TYPE    DataType,\r
  IN LIST_ENTRY                    *ParamPackage\r
  );\r
#endif\r
Commit	Line	Data
a3bcde70 HT	1	/** @file\r
	2	The function declaration of policy entry operation in IpSecConfig application.\r
	3	\r
	4	Copyright (c) 2009 - 2010, Intel Corporation. All rights reserved.<BR>\r
	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 _POLICY_ENTRY_OPERATION_H_\r
	17	#define _POLICY_ENTRY_OPERATION_H_\r
	18	\r
	19	#define LOCAL BIT(0)\r
	20	#define REMOTE BIT(1)\r
	21	#define PROTO BIT(2)\r
	22	#define LOCAL_PORT BIT(3)\r
	23	#define REMOTE_PORT BIT(4)\r
	24	#define ICMP_TYPE BIT(5)\r
	25	#define ICMP_CODE BIT(6)\r
	26	#define NAME BIT(7)\r
	27	#define PACKET_FLAG BIT(8)\r
	28	#define ACTION BIT(9)\r
	29	#define EXT_SEQUENCE BIT(10)\r
	30	#define SEQUENCE_OVERFLOW BIT(11)\r
	31	#define FRAGMENT_CHECK BIT(12)\r
	32	#define LIFEBYTE BIT(13)\r
	33	#define LIFETIME_SOFT BIT(14)\r
	34	#define LIFETIME BIT(15)\r
	35	#define MODE BIT(16)\r
	36	#define TUNNEL_LOCAL BIT(17)\r
	37	#define TUNNEL_REMOTE BIT(18)\r
	38	#define DONT_FRAGMENT BIT(19)\r
	39	#define IPSEC_PROTO BIT(20)\r
	40	#define AUTH_ALGO BIT(21)\r
	41	#define ENCRYPT_ALGO BIT(22)\r
	42	#define SPI BIT(23)\r
	43	#define DEST BIT(24)\r
	44	#define SEQUENCE_NUMBER BIT(25)\r
	45	#define ANTIREPLAY_WINDOW BIT(26)\r
	46	#define AUTH_KEY BIT(27)\r
	47	#define ENCRYPT_KEY BIT(28)\r
	48	#define PATH_MTU BIT(29)\r
	49	\r
	50	#define PEER_ID BIT(0)\r
	51	#define PEER_ADDRESS BIT(1)\r
	52	#define AUTH_PROTO BIT(2)\r
	53	#define AUTH_METHOD BIT(3)\r
	54	#define IKE_ID BIT(4)\r
	55	#define AUTH_DATA BIT(5)\r
	56	#define REVOCATION_DATA BIT(6)\r
	57	\r
	58	typedef struct {\r
	59	EFI_IPSEC_CONFIG_DATA_TYPE DataType;\r
	60	EFI_IPSEC_CONFIG_SELECTOR *Selector; // Data to be inserted.\r
	61	VOID *Data;\r
	62	UINT32 Mask;\r
	63	POLICY_ENTRY_INDEXER Indexer;\r
	64	EFI_STATUS Status; // Indicate whether insertion succeeds.\r
65	} EDIT_POLICY_ENTRY_CONTEXT;\r
66	\r
67	typedef struct {\r
68	EFI_IPSEC_CONFIG_DATA_TYPE DataType;\r
69	EFI_IPSEC_CONFIG_SELECTOR *Selector; // Data to be inserted.\r
70	VOID *Data;\r
71	POLICY_ENTRY_INDEXER Indexer;\r
72	EFI_STATUS Status; // Indicate whether insertion succeeds.\r
73	} INSERT_POLICY_ENTRY_CONTEXT;\r
74	\r
75	/**\r
76	The prototype for the CreateSpdEntry()/CreateSadEntry()/CreatePadEntry().\r
77	Fill in EFI_IPSEC_CONFIG_SELECTOR and corresponding data thru ParamPackage list.\r
78	\r
79	@param[out] Selector The pointer to the EFI_IPSEC_CONFIG_SELECTOR union.\r
80	@param[out] Data The pointer to corresponding data.\r
81	@param[in] ParamPackage The pointer to the ParamPackage list.\r
82	@param[out] Mask The pointer to the Mask.\r
83	@param[in] CreateNew The switch to create new.\r
84	\r
85	@retval EFI_SUCCESS Filled in EFI_IPSEC_CONFIG_SELECTOR and corresponding data successfully.\r
86	@retval EFI_INVALID_PARAMETER Invalid user input parameter.\r
87	\r
88	**/\r
89	typedef\r
90	EFI_STATUS\r
91	(*CREATE_POLICY_ENTRY) (\r
92	OUT EFI_IPSEC_CONFIG_SELECTOR **Selector,\r
93	OUT VOID **Data,\r
94	IN LIST_ENTRY *ParamPackage,\r
95	OUT UINT32 *Mask,\r
96	IN BOOLEAN CreateNew\r
97	);\r
98	\r
99	/**\r
100	The prototype for the CombineSpdEntry()/CombineSadEntry()/CombinePadEntry().\r
101	Combine old SPD/SAD/PAD entry with new SPD/SAD/PAD entry.\r
102	\r
103	@param[in, out] OldSelector The pointer to the old EFI_IPSEC_CONFIG_SELECTOR union.\r
104	@param[in, out] OldData The pointer to the corresponding old data.\r
105	@param[in] NewSelector The pointer to the new EFI_IPSEC_CONFIG_SELECTOR union.\r
106	@param[in] NewData The pointer to the corresponding new data.\r
107	@param[in] Mask The pointer to the Mask.\r
108	@param[out] CreateNew The switch to create new.\r
109	\r
110	@retval EFI_SUCCESS Combined successfully.\r
111	@retval EFI_INVALID_PARAMETER Invalid user input parameter.\r
112	\r
113	**/\r
114	typedef\r
115	EFI_STATUS\r
116	(* COMBINE_POLICY_ENTRY) (\r
117	EFI_IPSEC_CONFIG_SELECTOR *OldSelector,\r
118	VOID *OldData,\r
119	EFI_IPSEC_CONFIG_SELECTOR *NewSelector,\r
120	VOID *NewData,\r
121	UINT32 Mask,\r
122	BOOLEAN *CreateNew\r
123	);\r
124	\r
125	/**\r
126	Insert or add entry information in database according to datatype.\r
127	\r
128	@param[in] DataType The value of EFI_IPSEC_CONFIG_DATA_TYPE.\r
129	@param[in] ParamPackage The pointer to the ParamPackage list.\r
130	\r
131	@retval EFI_SUCCESS Insert or add entry information successfully.\r
132	@retval EFI_NOT_FOUND Can't find the specified entry.\r
133	@retval EFI_BUFFER_TOO_SMALL The entry already existed.\r
134	@retval EFI_UNSUPPORTED The operation is not supported./\r
135	@retval Others Some mistaken case.\r
136	**/\r
137	EFI_STATUS\r
138	AddOrInsertPolicyEntry (\r
139	IN EFI_IPSEC_CONFIG_DATA_TYPE DataType,\r
140	IN LIST_ENTRY *ParamPackage\r
141	);\r
142	\r
143	/**\r
144	Edit entry information in the database according to datatype.\r
145	\r
146	@param[in] DataType The value of EFI_IPSEC_CONFIG_DATA_TYPE.\r
147	@param[in] ParamPackage The pointer to the ParamPackage list.\r
148	\r
149	@retval EFI_SUCCESS Edit entry information successfully.\r
150	@retval EFI_NOT_FOUND Can't find the specified entry.\r
151	@retval Others Some mistaken case.\r
152	**/\r
153	EFI_STATUS\r
154	EditPolicyEntry (\r
155	IN EFI_IPSEC_CONFIG_DATA_TYPE DataType,\r
156	IN LIST_ENTRY *ParamPackage\r
157	);\r
158	#endif\r