NetworkPkg/Application/IpsecConfig/PolicyEntryOperation.h File Reference


Data Structures

struct  EDIT_POLICY_ENTRY_CONTEXT
struct  INSERT_POLICY_ENTRY_CONTEXT

Defines

#define LOCAL   BIT(0)
#define REMOTE   BIT(1)
#define PROTO   BIT(2)
#define LOCAL_PORT   BIT(3)
#define REMOTE_PORT   BIT(4)
#define ICMP_TYPE   BIT(5)
#define ICMP_CODE   BIT(6)
#define NAME   BIT(7)
#define PACKET_FLAG   BIT(8)
#define ACTION   BIT(9)
#define EXT_SEQUENCE   BIT(10)
#define SEQUENCE_OVERFLOW   BIT(11)
#define FRAGMENT_CHECK   BIT(12)
#define LIFEBYTE   BIT(13)
#define LIFETIME_SOFT   BIT(14)
#define LIFETIME   BIT(15)
#define MODE   BIT(16)
#define TUNNEL_LOCAL   BIT(17)
#define TUNNEL_REMOTE   BIT(18)
#define DONT_FRAGMENT   BIT(19)
#define IPSEC_PROTO   BIT(20)
#define AUTH_ALGO   BIT(21)
#define ENCRYPT_ALGO   BIT(22)
#define SPI   BIT(23)
#define DEST   BIT(24)
#define SEQUENCE_NUMBER   BIT(25)
#define ANTIREPLAY_WINDOW   BIT(26)
#define AUTH_KEY   BIT(27)
#define ENCRYPT_KEY   BIT(28)
#define PATH_MTU   BIT(29)
#define SOURCE   BIT(30)
#define PEER_ID   BIT(0)
#define PEER_ADDRESS   BIT(1)
#define AUTH_PROTO   BIT(2)
#define AUTH_METHOD   BIT(3)
#define IKE_ID   BIT(4)
#define AUTH_DATA   BIT(5)
#define REVOCATION_DATA   BIT(6)

Typedefs

typedef EFI_STATUS(* CREATE_POLICY_ENTRY )(OUT EFI_IPSEC_CONFIG_SELECTOR **Selector, OUT VOID **Data, IN LIST_ENTRY *ParamPackage, OUT UINT32 *Mask, IN BOOLEAN CreateNew)
typedef EFI_STATUS(* COMBINE_POLICY_ENTRY )(IN OUT EFI_IPSEC_CONFIG_SELECTOR *OldSelector, IN OUT VOID *OldData, IN EFI_IPSEC_CONFIG_SELECTOR *NewSelector, IN VOID *NewData, IN UINT32 Mask, OUT BOOLEAN *CreateNew)

Functions

EFI_STATUS AddOrInsertPolicyEntry (IN EFI_IPSEC_CONFIG_DATA_TYPE DataType, IN LIST_ENTRY *ParamPackage)
EFI_STATUS EditPolicyEntry (IN EFI_IPSEC_CONFIG_DATA_TYPE DataType, IN LIST_ENTRY *ParamPackage)

Detailed Description

The function declaration of policy entry operation in IpSecConfig application.

Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.

This program and the accompanying materials are licensed and made available under the terms and conditions of the BSD License which accompanies this distribution. The full text of the license may be found at http://opensource.org/licenses/bsd-license.php.

THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.


Define Documentation

#define ACTION   BIT(9)

Referenced by CombineSpdEntry(), and CreateSpdEntry().

#define ANTIREPLAY_WINDOW   BIT(26)

Referenced by CombineSadEntry().

#define AUTH_ALGO   BIT(21)

#define AUTH_DATA   BIT(5)

Referenced by CombinePadEntry(), and CreatePadEntry().

#define AUTH_KEY   BIT(27)

Referenced by CombineSadEntry(), and CreateSadEntry().

#define AUTH_METHOD   BIT(3)

Referenced by CombinePadEntry(), and CreatePadEntry().

#define AUTH_PROTO   BIT(2)

Referenced by CombinePadEntry(), and CreatePadEntry().

#define DEST   BIT(24)

Referenced by CombineSadEntry(), and CreateSadEntry().

#define DONT_FRAGMENT   BIT(19)

Referenced by CombineSpdEntry(), and CreateSpdEntry().

#define ENCRYPT_ALGO   BIT(22)

#define ENCRYPT_KEY   BIT(28)

Referenced by CombineSadEntry(), and CreateSadEntry().

#define EXT_SEQUENCE   BIT(10)

Referenced by CombineSpdEntry(), and CreateSpdEntry().

#define FRAGMENT_CHECK   BIT(12)

Referenced by CombineSpdEntry(), and CreateSpdEntry().

#define ICMP_CODE   BIT(6)

#define ICMP_TYPE   BIT(5)

#define IKE_ID   BIT(4)

Referenced by CombinePadEntry(), and CreatePadEntry().

#define IPSEC_PROTO   BIT(20)

#define LIFEBYTE   BIT(13)

#define LIFETIME   BIT(15)

#define LIFETIME_SOFT   BIT(14)

#define LOCAL   BIT(0)

#define LOCAL_PORT   BIT(3)

#define MODE   BIT(16)

#define NAME   BIT(7)

Referenced by CombineSpdEntry(), and CreateSpdEntry().

#define PACKET_FLAG   BIT(8)

Referenced by CombineSpdEntry(), and CreateSpdEntry().

#define PATH_MTU   BIT(29)

Referenced by CombineSadEntry(), and CreateSadEntry().

#define PEER_ADDRESS   BIT(1)

Referenced by CombinePadEntry(), and CreatePadEntry().

#define PEER_ID   BIT(0)

Referenced by CombinePadEntry(), and CreatePadEntry().

#define PROTO   BIT(2)

#define REMOTE   BIT(1)

#define REMOTE_PORT   BIT(4)

#define REVOCATION_DATA   BIT(6)

Referenced by CombinePadEntry(), and CreatePadEntry().

#define SEQUENCE_NUMBER   BIT(25)

Referenced by CombineSadEntry(), and CreateSadEntry().

#define SEQUENCE_OVERFLOW   BIT(11)

Referenced by CombineSpdEntry(), and CreateSpdEntry().

#define SOURCE   BIT(30)

Referenced by CombineSadEntry(), and CreateSadEntry().

#define SPI   BIT(23)

Referenced by CombineSadEntry(), and CreateSadEntry().

#define TUNNEL_LOCAL   BIT(17)

Referenced by CombineSpdEntry(), and CreateSpdEntry().

#define TUNNEL_REMOTE   BIT(18)

Referenced by CombineSpdEntry(), and CreateSpdEntry().


Typedef Documentation

typedef EFI_STATUS(* COMBINE_POLICY_ENTRY)(IN OUT EFI_IPSEC_CONFIG_SELECTOR *OldSelector, IN OUT VOID *OldData, IN EFI_IPSEC_CONFIG_SELECTOR *NewSelector, IN VOID *NewData, IN UINT32 Mask, OUT BOOLEAN *CreateNew)

The prototype for the CombineSpdEntry()/CombineSadEntry()/CombinePadEntry(). Combine old SPD/SAD/PAD entry with new SPD/SAD/PAD entry.

Parameters:
[in,out] OldSelector The pointer to the old EFI_IPSEC_CONFIG_SELECTOR union.
[in,out] OldData The pointer to the corresponding old data.
[in] NewSelector The pointer to the new EFI_IPSEC_CONFIG_SELECTOR union.
[in] NewData The pointer to the corresponding new data.
[in] Mask The pointer to the Mask.
[out] CreateNew The switch to create new.
Return values:
EFI_SUCCESS Combined successfully.
EFI_INVALID_PARAMETER Invalid user input parameter.

typedef EFI_STATUS(* CREATE_POLICY_ENTRY)(OUT EFI_IPSEC_CONFIG_SELECTOR **Selector, OUT VOID **Data, IN LIST_ENTRY *ParamPackage, OUT UINT32 *Mask, IN BOOLEAN CreateNew)

The prototype for the CreateSpdEntry()/CreateSadEntry()/CreatePadEntry(). Fill in EFI_IPSEC_CONFIG_SELECTOR and corresponding data thru ParamPackage list.

Parameters:
[out] Selector The pointer to the EFI_IPSEC_CONFIG_SELECTOR union.
[out] Data The pointer to corresponding data.
[in] ParamPackage The pointer to the ParamPackage list.
[out] Mask The pointer to the Mask.
[in] CreateNew The switch to create new.
Return values:
EFI_SUCCESS Filled in EFI_IPSEC_CONFIG_SELECTOR and corresponding data successfully.
EFI_INVALID_PARAMETER Invalid user input parameter.


Function Documentation

EFI_STATUS AddOrInsertPolicyEntry ( IN EFI_IPSEC_CONFIG_DATA_TYPE  DataType,
IN LIST_ENTRY *  ParamPackage 
)

Insert or add entry information in database according to datatype.

Parameters:
[in] DataType The value of EFI_IPSEC_CONFIG_DATA_TYPE.
[in] ParamPackage The pointer to the ParamPackage list.
Return values:
EFI_SUCCESS Insert or add entry information successfully.
EFI_NOT_FOUND Can't find the specified entry.
EFI_BUFFER_TOO_SMALL The entry already existed.
EFI_UNSUPPORTED The operation is not supported./
Others Some mistaken case.
Insert or add entry information in database according to datatype.

Parameters:
[in] DataType The value of EFI_IPSEC_CONFIG_DATA_TYPE.
[in] ParamPackage The pointer to the ParamPackage list.
Return values:
EFI_SUCCESS Insert or add entry information successfully.
EFI_NOT_FOUND Can't find the specified entry.
EFI_BUFFER_TOO_SMALL The entry already existed.
EFI_UNSUPPORTED The operation is not supported.
Others Some mistaken case.

References INSERT_POLICY_ENTRY_CONTEXT::Data, INSERT_POLICY_ENTRY_CONTEXT::DataType, ForeachPolicyEntry(), INSERT_POLICY_ENTRY_CONTEXT::Indexer, InsertPolicyEntry(), mAppName, mConstructPolicyEntryIndexer, mCreatePolicyEntry, mHiiHandle, mIpSecConfig, INSERT_POLICY_ENTRY_CONTEXT::Selector, and INSERT_POLICY_ENTRY_CONTEXT::Status.

Referenced by InitializeIpSecConfig().

EFI_STATUS EditPolicyEntry ( IN EFI_IPSEC_CONFIG_DATA_TYPE  DataType,
IN LIST_ENTRY *  ParamPackage 
)

Edit entry information in the database according to datatype.

Parameters:
[in] DataType The value of EFI_IPSEC_CONFIG_DATA_TYPE.
[in] ParamPackage The pointer to the ParamPackage list.
Return values:
EFI_SUCCESS Edit entry information successfully.
EFI_NOT_FOUND Can't find the specified entry.
Others Some mistaken case.
Edit entry information in database according to datatype.

Parameters:
[in] DataType The value of EFI_IPSEC_CONFIG_DATA_TYPE.
[in] ParamPackage The pointer to the ParamPackage list.
Return values:
EFI_SUCCESS Edit entry information successfully.
EFI_NOT_FOUND Can't find the specified entry.
Others Some mistaken case.

References EDIT_POLICY_ENTRY_CONTEXT::Data, EDIT_POLICY_ENTRY_CONTEXT::DataType, EditOperatePolicyEntry(), ForeachPolicyEntry(), EDIT_POLICY_ENTRY_CONTEXT::Indexer, mAppName, EDIT_POLICY_ENTRY_CONTEXT::Mask, mConstructPolicyEntryIndexer, mCreatePolicyEntry, mHiiHandle, EDIT_POLICY_ENTRY_CONTEXT::Selector, and EDIT_POLICY_ENTRY_CONTEXT::Status.

Referenced by InitializeIpSecConfig().


Generated on Mon Sep 28 08:49:05 2015 for NetworkPkg[ALL] by  doxygen 1.5.7.1