DOT11_CIPHER_KEY_MAPPING_KEY_VALUE structure (windot11.h)

The DOT11_CIPHER_KEY_MAPPING_KEY_VALUE structure defines a key-mapping cipher key that will be added to or deleted from the key tables on the 802.11 station. For more information about this cipher key type, see 802.11 Cipher Key Types.

Syntax

typedef struct DOT11_CIPHER_KEY_MAPPING_KEY_VALUE {
  DOT11_MAC_ADDRESS      PeerMacAddr;
  DOT11_CIPHER_ALGORITHM AlgorithmId;
  DOT11_DIRECTION        Direction;
  BOOLEAN                bDelete;
  BOOLEAN                bStatic;
  USHORT                 usKeyLength;
  UCHAR                  ucKey[1];
} DOT11_CIPHER_KEY_MAPPING_KEY_VALUE, *PDOT11_CIPHER_KEY_MAPPING_KEY_VALUE;

Members

PeerMacAddr

MAC address of the peer. The peer is either an access point (AP) (for infrastructure BSS networks) or peer station (for independent BSS networks) with which the 802.11 station is associated.

This member is used to uniquely identify a key entry. For the standard 802.11 cipher algorithms, the operating system will identify the peer through peer's MAC address. For proprietary cipher algorithms developed by an independent hardware vendor (IHV), the IHV can use any method to identify a key entry.

When the NIC is in the Extensible Access Point (ExtAP) OP mode, PeerMacAddr must have a unique value.

AlgorithmId

The value of the cipher algorithm that uses this key. For more information about enumerator values for cipher algorithms, see DOT11_CIPHER_ALGORITHM.

Direction

This member specifies whether the 802.11 station uses the key for receive or transmit packets. The data type for this member is the DOT11_DIRECTION enumeration.

bDelete

If set to TRUE, the miniport driver must delete the key referenced by PeerMacAddr and Direction . If set to FALSE, the miniport driver must add or update the key referenced by PeerMacAddr and Direction .

bStatic

A Boolean value that specifies whether the miniport driver should delete the default key following a connection or roaming operation.

If set to FALSE, the miniport driver must delete the default key referenced by uKeyIndex whenever:

• The 802.11 station disconnects from the BSS network.
• The peer station disconnects from the BSS network.
• The 802.11 station reconnects to the same BSS network.

If set to TRUE, the default key referenced by uKeyIndex must not be deleted unless it is:

• Explicitly deleted through a set request of OID_DOT11_CIPHER_KEY_MAPPING_KEY.
• Implicitly deleted through a method request of OID_DOT11_RESET_REQUEST.

usKeyLength

The length, in bytes, of the key material in the ucKey array.

ucKey[*]

The key material.

If AlgorithmId is set to DOT11_CIPHER_ALGO_TKIP, the ucKey array defines the key material through the DOT11_KEY_ALGO_TKIP_MIC structure.

If AlgorithmId is set to DOT11_CIPHER_ALGO_CCMP, the ucKey array defines the key material through the DOT11_KEY_ALGO_CCMP structure.

ucKey[1]

The key material.

If AlgorithmId is set to DOT11_CIPHER_ALGO_TKIP, the ucKey array defines the key material through the DOT11_KEY_ALGO_TKIP_MIC structure.

If AlgorithmId is set to DOT11_CIPHER_ALGO_CCMP, the ucKey array defines the key material through the DOT11_KEY_ALGO_CCMP structure.

Remarks

The Native 802.11 miniport driver uniquely identifies key-mapping keys through the PeerMacAddr and Direction members. When the OID_DOT11_CIPHER_KEY_MAPPING_KEY is set, the miniport driver can modify or delete an existing key only if the values of the PeerMacAddr and Direction members from the set request match the members of the existing key.

If the bDelete member is TRUE, the following members are not valid and must be ignored:

• bStatic
• usKeyLength
• ucKey

Requirements

Requirement	Value
Minimum supported client	Available in Windows Vista and later versions of the Windows operating systems.
Header	windot11.h (include Ndis.h)

See also

OID_DOT11_CIPHER_KEY_MAPPING_KEY

DOT11_KEY_ALGO_TKIP_MIC

OID_DOT11_RESET_REQUEST

DOT11_CIPHER_ALGORITHM

OID_DOT11_DESIRED_BSS_TYPE

DOT11_KEY_ALGO_CCMP

DOT11_DIRECTION