OFFLOAD_IPSEC_ADD_UDPESP_SA (Compact 7)

3/12/2014

This structure contains information for each security association (SA) that a miniport driver adds for UDP-encapsulated ESP packets to a network adapter.

Syntax

typedef struct _OFFLOAD_IPSEC_ADD_UDPESP_SA {
  IPAddr  SrcAddr;
  IPMask  SrcMask;
  IPAddr  DestAddr;
  IPMask  DestMask;
  ULONG  Protocol;
  USHORT  SrcPort;
  USHORT  DestPort;
  IPAddr  SrcTunnelAddr;
  IPAddr  DestTunnelAddr;
  USHORT  Flags;
  SHORT  NumSAs;
  OFFLOAD_SECURITY_ASSOCIATION  SecAssoc[OFFLOAD_MAX_SAS];
  HANDLE  OffloadHandle;
  OFFLOAD_IPSEC_UDPESP_ENCAPTYPE_ENTRY  EncapTypeEntry;
  HANDLE  EncapTypeEntryOffldHandle;
  ULONG  KeyLen;
  UCHAR  KeyMat[1];
} OFFLOAD_IPSEC_ADD_UDPESP_SA, *POFFLOAD_IPSEC_ADD_UDPESP_SA;

Members

• SrcAddr
  The IP address of the source host (the host sending the packets).

• SrcMask
  The subnet mask for the source IP address.

• DestAddr
  The IP address of the destination host (the host receiving the packets).

• DestMask
  The subnet mask for the destination IP address.

• Protocol
  The IP protocol. The encoding of Protocol is identical to that of the Protocol field in an IP header. The value should be 11 (hexadecimal), which specifies UDP.

• SrcPort
  A source TCP or UDP port. If SrcPort is set to zero, the SA applies to any source TCP/UDP port.

• DestPort
  A destination TCP or UDP port. If DestPort is set to zero, the SA applies to any source TCP/UDP port.

• SrcTunnelAddr
  The IP address for the source endpoint, such as a connector, of a tunnel. The miniport driver uses SrcTunnelAddr as the source address for the tunnel IP header of packets sent on the SA. SrcTunnelAddr is specified only for an SA that applies to the tunnel part of a packet. SrcTunnelAddr is set to zero for an SA that applies to the transport part of a packet.

• DestTunnelAddr
  The IP address for the destination endpoint, such as a connector, of a tunnel. The miniport driver uses DestTunnelAddr as the destination address for the tunnel IP header of packets sent on the SA. DestTunnelAddr is specified only for an SA that applies to the tunnel part of a packet. DestTunnelAddr is set to zero for an SA that applies to the transport part of a packet.

• Flags
  A bitmask that indicates whether the SA that is being added is an incoming or outgoing SA as follows:

  • OFFLOAD_INBOUND_SA
    Specifies an incoming SA.
  • OFFLOAD_OUTBOUND_SA
    Specifies an outgoing SA.

• NumSAs
  The number of elements in the SecAssoc array. Each element in the array is an OFFLOAD_SECURITY_ASSOCIATION structure.

• SecAssoc
  A variable-length array that contains the information about the Internet Protocol security (IPsec) operations (AH or ESP) for the SA. The information for each IPsec operations is formatted as an OFFLOAD_SECURITY_ASSOCIATION structure.

  The TCP/IP transport specifies one or two OFFLOAD_SECURITY_ASSOCIATION structures in the buffer at SecAssoc. Each OFFLOAD_SECURITY_ASSOCIATION structure indicates the type of operation-authentication or encryption/decryption-for which the SA specified in the structure is to be used. The order of the OFFLOAD_SECURITY_ASSOCIATION structures in the array indicates the order in which the miniport driver should perform the operations for each SA. Only one combination of operations is supported: encryption/decryption (ESP) followed by authentication (AH).

• OffloadHandle
  The handle to the newly created SA. The miniport driver supplies this handle before completing the OID_TCP_TASK_IPSEC_ADD_SA request. The TCP/IP transport must specify this handle in the NDIS_IPSEC_PACKET_INFO structure before passing a send packet to the miniport driver. The TCP/IP transport must also specify this handle when deleting the SA with an OID_TCP_TASK_IPSEC_DELETE_SA request.

• EncapTypeEntry
  The UDP-ESP encapsulation type and destination port of a parser entry. This information is formatted as an OFFLOAD_IPSEC_UDPESP_ENCAPTYPE_ENTRY structure.

• EncapTypeEntryOffldHandle
  When Flags = OFFLOAD_INBOUND_SA and EncapTypeEntryOffldHandle is NULL, the miniport driver should check whether the parser entry specified by EncapTypeEntry is in the network adapter's parser entry list. If it is not, the miniport driver should create a parser entry, using the encapsulation type and destination port specified in EncapTypeEntry, add the parser entry to the parser entry list, and offload the specified SAs. The miniport driver should return a handle in EncapTypeEntryOffldHandle that identifies the newly created parser entry. If the specified parser entry is already in the parser entry list, the miniport should return the handle in EncapTypeEntryOffldHandle for the existing parser entry.

  When Flags = OFFLOAD_INBOUND_SA and EncapTypeEntryOffldHandle is non-NULL, EncapTypeEntryOffldHandle contains the handle to a parser entry that already is in the network adapter's parser entry list. In this case, the miniport driver should offload the specified SAs.

  When Flags = OFFLOAD_OUTBOUND_SA, the miniport driver should ignore the EncapTypeEntryOffldHandle parameter.

• KeyLen
  The length, in bytes, of the buffer at KeyMat.

• KeyMat
  A variable-length array that contains keys for the SAs specified at SecAssoc. If both a confidentiality (encryption/decryption) algorithm and an integrity (authentication) algorithm are specified by the ConfAlgo and IntegrityAlgo of an OFFLOAD_SECURITY_ASSOCIATION structure, the buffer at KeyMat contains key information for the confirmation algorithm first, followed immediately by key information for the integrity algorithm.

  The length of each key in the buffer at KeyMat is specified by algoKeyLen in the OFFLOAD_ALGO_INFO structure that specifies the confidentiality or integrity algorithm. (An OFFLOAD_ALGO_INFO structure is a member of an OFFLOAD_SECURITY_ASSOCIATION structure.)

Remarks

The OFFLOAD_IPSEC_ADD_UDPESP_SA structure is used with the OID_TCP_TASK_IPSEC_ADD_UDPESP_SA OID.

Requirements

See Also

Reference

Task Offload Structures (NDIS 5.1)
OFFLOAD_ALGO_INFO
OFFLOAD_IPSEC_ADD_SA
OFFLOAD_IPSEC_UDPESP_ENCAPTYPE_ENTRY
OFFLOAD_SECURITY_ASSOCIATION
OID_TCP_TASK_IPSEC_ADD_SA
OID_TCP_TASK_IPSEC_ADD_UDPESP_SA
OID_TCP_TASK_IPSEC_DELETE_SA