Edit

IPSEC_OFFLOAD_V2_UPDATE_SA structure (ndis.h)

  • Article

[The IPsec Task Offload feature is deprecated and should not be used.]

The IPSEC_OFFLOAD_V2_UPDATE_SA structure updates information about security associations (SAs) that a miniport driver previously added to a NIC and a pointer to the next IPSEC_OFFLOAD_V2_UPDATE_SA structure in a linked list.

Syntax

typedef struct _IPSEC_OFFLOAD_V2_UPDATE_SA {
  NDIS_OBJECT_HEADER         Header;
  NDIS_HANDLE                OffloadHandle;
  IPSEC_OFFLOAD_V2_OPERATION Operation;
  IPSEC_OFFLOAD_V2_SPI_TYPE  Spi;
  ULONG                      SequenceNumberHighOrder;
} IPSEC_OFFLOAD_V2_UPDATE_SA, *PIPSEC_OFFLOAD_V2_UPDATE_SA;

Members

Header

The NDIS_OBJECT_HEADER structure for the IPSEC_OFFLOAD_V2_UPDATE_SA structure. Set the Type member of the structure that Header specifies to NDIS_OBJECT_TYPE_DEFAULT, the Revision member to NDIS_IPSEC_OFFLOAD_V2_UPDATE_SA_REVISION_1, and the Size member to NDIS_SIZEOF_IPSEC_OFFLOAD_V2_UPDATE_SA_REVISION_1.

OffloadHandle

An NDIS handle that identifies the SA. The miniport driver provided this handle in response to an OID set request of OID_TCP_TASK_IPSEC_OFFLOAD_V2_ADD_SA.

Operation

The IPsec operation for which the SA is to be used. The IPSEC_OFFLOAD_V2_OPERATION enumeration defines the supported operations.

Spi

A 32 bit security parameters index (SPI) for the SA.

SequenceNumberHighOrder

The high-order bit of an IPsec sequence number. This bit is not included in the IPsec header.

Remarks

The IPSEC_OFFLOAD_V2_UPDATE_SA structure specifies updates for a SA and a pointer to the next IPSEC_OFFLOAD_V2_UPDATE_SA structure in a linked list. The IPSEC_OFFLOAD_V2_UPDATE_SA structure is used with the OID_TCP_TASK_IPSEC_OFFLOAD_V2_UPDATE_SA OID.

Requirements

Requirement Value
Minimum supported client Supported in NDIS 6.1 and later.
Header ndis.h (include Ndis.h)

See also

IPSEC_OFFLOAD_V2_OPERATION

NDIS_OBJECT_HEADER

OID_TCP_TASK_IPSEC_OFFLOAD_V2_ADD_SA OID_TCP_TASK_IPSEC_OFFLOAD_V2_UPDATE_SA