4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/** @file
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI IPsec Configuration Protocol Definition
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The EFI_IPSEC_CONFIG_PROTOCOL provides the mechanism to set and retrieve security and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync policy related information for the EFI IPsec protocol driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Copyright (c) 2009 - 2011, Intel Corporation. All rights reserved.<BR>
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This program and the accompanying materials
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are licensed and made available under the terms and conditions of the BSD License
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync which accompanies this distribution. The full text of the license may be found at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync http://opensource.org/licenses/bsd-license.php
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @par Revision Reference:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This Protocol is introduced in UEFI Specification 2.2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#ifndef __EFI_IPSE_CCONFIG_PROTOCOL_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define __EFI_IPSE_CCONFIG_PROTOCOL_H__
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define EFI_IPSEC_CONFIG_PROTOCOL_GUID \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync { \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 0xce5e5929, 0xc7a3, 0x4602, {0xad, 0x9e, 0xc9, 0xda, 0xf9, 0x4e, 0xbf, 0xcf } \
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync }
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_CONFIG_PROTOCOL EFI_IPSEC_CONFIG_PROTOCOL;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_CONFIG_DATA_TYPE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The IPsec Security Policy Database (aka SPD) setting. In IPsec,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// an essential element of Security Association (SA) processing is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// underlying SPD that specifies what services are to be offered to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IP datagram and in what fashion. The SPD must be consulted
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// during the processing of all traffic (inbound and outbound),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// including traffic not protected by IPsec, that traverses the IPsec
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// boundary. With this DataType, SetData() function is to set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the SPD entry information, which may add one new entry, delete
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// one existed entry or flush the whole database according to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// parameter values. The corresponding Data is of type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_IPSEC_SPD_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPsecConfigDataTypeSpd,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The IPsec Security Association Database (aka SAD) setting. A
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// SA is a simplex connection that affords security services to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// traffic carried by it. Security services are afforded to an SA by the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// use of AH, or ESP, but not both. The corresponding Data is of
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// type EFI_IPSEC_SAD_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPsecConfigDataTypeSad,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The IPsec Peer Authorization Database (aka PAD) setting, which
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// provides the link between the SPD and a security association
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// management protocol. The PAD entry specifies the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// authentication protocol (e.g. IKEv1, IKEv2) method used and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// authentication data. The corresponding Data is of type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_IPSEC_PAD_DATA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPsecConfigDataTypePad,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IPsecConfigDataTypeMaximum
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_CONFIG_DATA_TYPE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IP_ADDRESS_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IP_ADDRESS_INFO {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS Address; ///< The IPv4 or IPv6 address
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 PrefixLength; ///< The length of the prefix associated with the Address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IP_ADDRESS_INFO;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_SPD_SELECTOR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_SPD_SELECTOR {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Specifies the actual number of entries in LocalAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 LocalAddressCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A list of ranges of IPv4 or IPv6 addresses, which refers to the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// addresses being protected by IPsec policy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS_INFO *LocalAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Specifies the actual number of entries in RemoteAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 RemoteAddressCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A list of ranges of IPv4 or IPv6 addresses, which are peer entities
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to LocalAddress.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS_INFO *RemoteAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Next layer protocol. Obtained from the IPv4 Protocol or the IPv6
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Next Header fields. The next layer protocol is whatever comes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// after any IP extension headers that are present. A zero value is a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// wildcard that matches any value in NextLayerProtocol field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 NextLayerProtocol;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Local Port if the Next Layer Protocol uses two ports (as do TCP,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// UDP, and others). A zero value is a wildcard that matches any
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// value in LocalPort field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 LocalPort;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A designed port range size. The start port is LocalPort, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the total number of ports is described by LocalPortRange.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field is ignored if NextLayerProtocol does not use
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// ports.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 LocalPortRange;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Remote Port if the Next Layer Protocol uses two ports. A zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// value is a wildcard that matches any value in RemotePort field.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 RemotePort;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A designed port range size. The start port is RemotePort, and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the total number of ports is described by RemotePortRange.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// This field is ignored if NextLayerProtocol does not use ports.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT16 RemotePortRange;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_SPD_SELECTOR;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_TRAFFIC_DIR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// represents the directionality in an SPD entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The EfiIPsecInBound refers to traffic entering an IPsec implementation via
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the unprotected interface or emitted by the implementation on the unprotected
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// side of the boundary and directed towards the protected interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecInBound,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The EfiIPsecOutBound refers to traffic entering the implementation via
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the protected interface, or emitted by the implementation on the protected side
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// of the boundary and directed toward the unprotected interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecOutBound
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_TRAFFIC_DIR;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_ACTION
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// represents three possible processing choices.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Refers to traffic that is not allowed to traverse the IPsec boundary.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecActionDiscard,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Refers to traffic that is allowed to cross the IPsec boundary
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// without protection.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecActionBypass,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Refers to traffic that is afforded IPsec protection, and for such
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// traffic the SPD must specify the security protocols to be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// employed, their mode, security service options, and the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// cryptographic algorithms to be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecActionProtect
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_ACTION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_SA_LIFETIME
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// defines the lifetime of an SA, which represents when a SA must be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// replaced or terminated. A value of all 0 for each field removes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the limitation of a SA lifetime.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_SA_LIFETIME {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The number of bytes to which the IPsec cryptographic algorithm
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// can be applied. For ESP, this is the encryption algorithm and for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AH, this is the authentication algorithm. The ByteCount
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// includes pad bytes for cryptographic operations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 ByteCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A time interval in second that warns the implementation to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// initiate action such as setting up a replacement SA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 SoftLifetime;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A time interval in second when the current SA ends and is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// destroyed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 HardLifetime;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_SA_LIFETIME;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_MODE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// There are two modes of IPsec operation: transport mode and tunnel mode. In
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EfiIPsecTransport mode, AH and ESP provide protection primarily for next layer protocols;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// In EfiIPsecTunnel mode, AH and ESP are applied to tunneled IP packets.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecTransport,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecTunnel
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_MODE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_TUNNEL_DF_OPTION
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The option of copying the DF bit from an outbound package to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// the tunnel mode header that it emits, when traffic is carried
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// via a tunnel mode SA. This applies to SAs where both inner and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// outer headers are IPv4.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecTunnelClearDf, ///< Clear DF bit from inner header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecTunnelSetDf, ///< Set DF bit from inner header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecTunnelCopyDf ///< Copy DF bit from inner header.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_TUNNEL_DF_OPTION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_TUNNEL_OPTION
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_TUNNEL_OPTION {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Local tunnel address when IPsec mode is EfiIPsecTunnel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS LocalTunnelAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Remote tunnel address when IPsec mode is EfiIPsecTunnel.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS RemoteTunnelAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The option of copying the DF bit from an outbound package
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// to the tunnel mode header that it emits, when traffic is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// carried via a tunnel mode SA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_TUNNEL_DF_OPTION DF;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_TUNNEL_OPTION;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_PROTOCOL_TYPE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecAH, ///< IP Authentication Header protocol which is specified in RFC 4302.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecESP ///< IP Encapsulating Security Payload which is specified in RFC 4303.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_PROTOCOL_TYPE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_PROCESS_POLICY
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// describes a policy list for traffic processing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_PROCESS_POLICY {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Extended Sequence Number. Is this SA using extended sequence
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// numbers. 64 bit counter is used if TRUE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN ExtSeqNum;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A flag indicating whether overflow of the sequence number
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// counter should generate an auditable event and prevent
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// transmission of additional packets on the SA, or whether rollover
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// is permitted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN SeqOverflow;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Is this SA using stateful fragment checking. TRUE represents
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// stateful fragment checking.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN FragCheck;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A time interval after which a SA must be replaced with a new SA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// (and new SPI) or terminated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_SA_LIFETIME SaLifetime;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPsec mode: tunnel or transport.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_MODE Mode;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Tunnel Option. TunnelOption is ignored if Mode is EfiIPsecTransport.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_TUNNEL_OPTION *TunnelOption;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPsec protocol: AH or ESP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_PROTOCOL_TYPE Proto;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Cryptographic algorithm type used for authentication.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 AuthAlgoId;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Cryptographic algorithm type used for encryption. EncAlgo is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// NULL when IPsec protocol is AH. For ESP protocol, EncAlgo
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// can also be used to describe the algorithm if a combined mode
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// algorithm is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 EncAlgoId;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_PROCESS_POLICY;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_SA_ID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// A triplet to identify an SA, consisting of the following members.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_SA_ID {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Security Parameter Index (aka SPI). An arbitrary 32-bit value
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// that is used by a receiver to identity the SA to which an incoming
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// package should be bound.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 Spi;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPsec protocol: AH or ESP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_PROTOCOL_TYPE Proto;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Destination IP address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS DestAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_SA_ID;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#define MAX_PEERID_LEN 128
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_SPD_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_SPD_DATA {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// A null-terminated ASCII name string which is used as a symbolic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// identifier for an IPsec Local or Remote address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 Name[MAX_PEERID_LEN];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Bit-mapped list describing Populate from Packet flags. When
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// creating a SA, if PackageFlag bit is set to TRUE, instantiate
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// the selector from the corresponding field in the package that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// triggered the creation of the SA, else from the value(s) in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// corresponding SPD entry. The PackageFlag bit setting for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// corresponding selector field of EFI_IPSEC_SPD_SELECTOR:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Bit 0: EFI_IPSEC_SPD_SELECTOR.LocalAddress
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Bit 1: EFI_IPSEC_SPD_SELECTOR.RemoteAddress
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Bit 2:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// EFI_IPSEC_SPD_SELECTOR.NextLayerProtocol
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Bit 3: EFI_IPSEC_SPD_SELECTOR.LocalPort
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Bit 4: EFI_IPSEC_SPD_SELECTOR.RemotePort
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Others: Reserved.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 PackageFlag;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The traffic direction of data gram.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_TRAFFIC_DIR TrafficDirection;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Processing choices to indicate which action is required by this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// policy.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_ACTION Action;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The policy and rule information for a SPD entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_PROCESS_POLICY *ProcessingPolicy;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Specifies the actual number of entries in SaId list.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN SaIdCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The SAD entry used for the traffic processing. The
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// existed SAD entry links indicate this is the manual key case.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_SA_ID SaId[1];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_SPD_DATA;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_AH_ALGO_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The security algorithm selection for IPsec AH authentication.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The required authentication algorithm is specified in RFC 4305.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_AH_ALGO_INFO {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 AuthAlgoId;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN AuthKeyLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *AuthKey;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_AH_ALGO_INFO;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_ESP_ALGO_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The security algorithm selection for IPsec ESP encryption and authentication.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// The required authentication algorithm is specified in RFC 4305.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EncAlgoId fields can also specify an ESP combined mode algorithm
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// (e.g. AES with CCM mode, specified in RFC 4309), which provides both
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// confidentiality and authentication services.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_ESP_ALGO_INFO {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 EncAlgoId;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN EncKeyLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *EncKey;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 AuthAlgoId;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN AuthKeyLength;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *AuthKey;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_ESP_ALGO_INFO;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_ALGO_INFO
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_AH_ALGO_INFO AhAlgoInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_ESP_ALGO_INFO EspAlgoInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_ALGO_INFO;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_SA_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_SA_DATA {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPsec mode: tunnel or transport.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_MODE Mode;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Sequence Number Counter. A 64-bit counter used to generate the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// sequence number field in AH or ESP headers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 SNCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Anti-Replay Window. A 64-bit counter and a bit-map used to
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// determine whether an inbound AH or ESP packet is a replay.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 AntiReplayWindows;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AH/ESP cryptographic algorithm, key and parameters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_ALGO_INFO AlgoInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Lifetime of this SA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_SA_LIFETIME SaLifetime;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Any observed path MTU and aging variables. The Path MTU
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// processing is defined in section 8 of RFC 4301.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 PathMTU;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Link to one SPD entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_SPD_SELECTOR *SpdSelector;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Indication of whether it's manually set or negotiated automatically.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If ManualSet is FALSE, the corresponding SA entry is inserted through
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IKE protocol negotiation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN ManualSet;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_SA_DATA;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_SA_DATA2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_SA_DATA2 {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IPsec mode: tunnel or transport
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_MODE Mode;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Sequence Number Counter. A 64-bit counter used to generate the sequence
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// number field in AH or ESP headers.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT64 SNCount;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Anti-Replay Window. A 64-bit counter and a bit-map used to determine
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// whether an inbound AH or ESP packet is a replay.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 AntiReplayWindows;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// AH/ESP cryptographic algorithm, key and parameters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_ALGO_INFO AlgoInfo;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Lifetime of this SA.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_SA_LIFETIME SaLifetime;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Any observed path MTU and aging variables. The Path MTU processing is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// defined in section 8 of RFC 4301.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT32 PathMTU;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Link to one SPD entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_SPD_SELECTOR *SpdSelector;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Indication of whether it's manually set or negotiated automatically.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// If ManualSet is FALSE, the corresponding SA entry is inserted through IKE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// protocol negotiation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN ManualSet;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The tunnel header IP source address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS TunnelSourceAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The tunnel header IP destination address.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS TunnelDestinationAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_SA_DATA2;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_PAD_ID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// specifies the identifier for PAD entry, which is also used for SPD lookup.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// IpAddress Pointer to the IPv4 or IPv6 address range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_PAD_ID {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Flag to identify which type of PAD Id is used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN PeerIdValid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Pointer to the IPv4 or IPv6 address range.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IP_ADDRESS_INFO IpAddress;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Pointer to a null terminated ASCII string
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// representing the symbolic names. A PeerId can be a DNS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// name, Distinguished Name, RFC 822 email address or Key ID
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// (specified in section 4.4.3.1 of RFC 4301)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINT8 PeerId[MAX_PEERID_LEN];
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync } Id;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_PAD_ID;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_CONFIG_SELECTOR
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// describes the expected IPsec configuration data selector
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// of type EFI_IPSEC_CONFIG_DATA_TYPE.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef union {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_SPD_SELECTOR SpdSelector;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_SA_ID SaId;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_PAD_ID PadId;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_CONFIG_SELECTOR;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_AUTH_PROTOCOL_TYPE
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// defines the possible authentication protocol for IPsec
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// security association management.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecAuthProtocolIKEv1,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecAuthProtocolIKEv2,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecAuthProtocolMaximum
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_AUTH_PROTOCOL_TYPE;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_AUTH_METHOD
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef enum {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Using Pre-shared Keys for manual security associations.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecAuthMethodPreSharedSecret,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// IKE employs X.509 certificates for SA establishment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecAuthMethodCertificates,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EfiIPsecAuthMethodMaximum
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_AUTH_METHOD;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_PAD_DATA
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef struct _EFI_IPSEC_PAD_DATA {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Authentication Protocol for IPsec security association management.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_AUTH_PROTOCOL_TYPE AuthProtocol;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Authentication method used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_AUTH_METHOD AuthMethod;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The IKE ID payload will be used as a symbolic name for SPD
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// lookup if IkeIdFlag is TRUE. Otherwise, the remote IP
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// address provided in traffic selector playloads will be used.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync BOOLEAN IkeIdFlag;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size of Authentication data buffer, in bytes.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN AuthDataSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Buffer for Authentication data, (e.g., the pre-shared secret or the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// trust anchor relative to which the peer's certificate will be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// validated).
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *AuthData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// The size of RevocationData, in bytes
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync UINTN RevocationDataSize;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// Pointer to CRL or OCSP data, if certificates are used for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync /// authentication method.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync VOID *RevocationData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync} EFI_IPSEC_PAD_DATA;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Set the security association, security policy and peer authorization configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information for the EFI IPsec driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is used to set the IPsec configuration information of type DataType for
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the EFI IPsec driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The IPsec configuration data has a unique selector/identifier separately to identify
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a data entry. The selector structure depends on DataType's definition.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Using SetData() with a Data of NULL causes the IPsec configuration data entry identified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync by DataType and Selector to be deleted.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataType The type of data to be set.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Selector Pointer to an entry selector on operated configuration data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified by DataType. A NULL Selector causes the entire
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified-type configuration information to be flushed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Data The data buffer to be set. The structure of the data buffer is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync associated with the DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] InsertBefore Pointer to one entry selector which describes the expected
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync position the new data entry will be added. If InsertBefore is NULL,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the new entry will be appended the end of database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The specified configuration entry data is set successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the following are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The specified DataType is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_OUT_OF_RESOURCED The required system resource could not be allocated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_IPSEC_CONFIG_SET_DATA)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_DATA_TYPE DataType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_SELECTOR *Selector,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN VOID *Data,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_SELECTOR *InsertBefore OPTIONAL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Return the configuration value for the EFI IPsec driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function lookup the data entry from IPsec database or IKEv2 configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync information. The expected data type and unique identification are described in
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataType and Selector parameters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataType The type of data to retrieve.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Selector Pointer to an entry selector which is an identifier of the IPsec
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] DataSize On output the size of data returned in Data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[out] Data The buffer to return the contents of the IPsec configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync The type of the data buffer is associated with the DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The specified configuration data is got successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Selector is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - DataSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Data is NULL and *DataSize is not zero
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The configuration data specified by Selector is not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The specified DataType is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The DataSize is too small for the result. DataSize has been
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync updated with the size needed to complete the request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_IPSEC_CONFIG_GET_DATA)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_DATA_TYPE DataType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_SELECTOR *Selector,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINTN *DataSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync OUT VOID *Data
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Enumerates the current selector for IPsec configuration data entry.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function is called multiple times to retrieve the entry Selector in IPsec
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration database. On each call to GetNextSelector(), the next entry
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Selector are retrieved into the output interface.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the entire IPsec configuration database has been iterated, the error
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_NOT_FOUND is returned.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync If the Selector buffer is too small for the next Selector copy, an
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_BUFFER_TOO_SMALL error is returned, and SelectorSize is updated to reflect
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the size of buffer needed.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On the initial call to GetNextSelector() to start the IPsec configuration database
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync search, a pointer to the buffer with all zero value is passed in Selector. Calls
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync to SetData() between calls to GetNextSelector may produce unpredictable results.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataType The type of IPsec configuration data to retrieve.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] SelectorSize The size of the Selector buffer.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in, out] Selector On input, supplies the pointer to last Selector that was
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync returned by GetNextSelector().
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync On output, returns one copy of the current entry Selector
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of a given DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The specified configuration data is got successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER One or more of the followings are TRUE:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - This is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - SelectorSize is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Selector is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The next configuration data entry was not found.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The specified DataType is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_BUFFER_TOO_SMALL The SelectorSize is too small for the result. This parameter
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync has been updated with the size needed to complete the search
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync request.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_IPSEC_CONFIG_GET_NEXT_SELECTOR)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_DATA_TYPE DataType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT UINTN *SelectorSize,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN OUT EFI_IPSEC_CONFIG_SELECTOR *Selector
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Register an event that is to be signaled whenever a configuration process on the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync specified IPsec configuration information is done.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function registers an event that is to be signaled whenever a configuration
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync process on the specified IPsec configuration data is done (e.g. IPsec security
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync policy database configuration is ready). An event can be registered for different
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataType simultaneously and the caller is responsible for determining which type
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync of configuration data causes the signaling of the event in such case.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataType The type of data to be registered the event for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Event The event to be registered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event is registered successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_ACCESS_DENIED The Event is already registered for the DataType.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The notify registration unsupported or the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataType is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_IPSEC_CONFIG_REGISTER_NOTIFY)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_DATA_TYPE DataType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/**
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Remove the specified event that is previously registered on the specified IPsec
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync This function removes a previously registered event for the specified configuration data.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] This Pointer to the EFI_IPSEC_CONFIG_PROTOCOL instance.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] DataType The configuration data type to remove the registered event for.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @param[in] Event The event to be unregistered.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_SUCCESS The event is removed successfully.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_NOT_FOUND The Event specified by DataType could not be found in the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync database.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_INVALID_PARAMETER This is NULL or Event is NULL.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync @retval EFI_UNSUPPORTED The notify registration unsupported or the specified
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync DataType is not supported.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync**/
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynctypedef
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncEFI_STATUS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync(EFIAPI *EFI_IPSEC_CONFIG_UNREGISTER_NOTIFY)(
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_PROTOCOL *This,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_IPSEC_CONFIG_DATA_TYPE DataType,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync IN EFI_EVENT Event
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync );
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_CONFIG_PROTOCOL
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// provides the ability to set and lookup the IPsec SAD (Security Association Database),
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// SPD (Security Policy Database) data entry and configure the security association
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// management protocol such as IKEv2. This protocol is used as the central
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// repository of any policy-specific configuration for EFI IPsec driver.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// EFI_IPSEC_CONFIG_PROTOCOL can be bound to both IPv4 and IPv6 stack. User can use this
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync/// protocol for IPsec configuration in both IPv4 and IPv6 environment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync///
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncstruct _EFI_IPSEC_CONFIG_PROTOCOL {
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_CONFIG_SET_DATA SetData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_CONFIG_GET_DATA GetData;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_CONFIG_GET_NEXT_SELECTOR GetNextSelector;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_CONFIG_REGISTER_NOTIFY RegisterDataNotify;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync EFI_IPSEC_CONFIG_UNREGISTER_NOTIFY UnregisterDataNotify;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync};
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncextern EFI_GUID gEfiIpSecConfigProtocolGuid;
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync#endif