OID_DOT11_CIPHER_DEFAULT_KEY_ID

  • Article

Important  The Native 802.11 Wireless LAN interface is deprecated in Windows 10 and later. Please use the WLAN Device Driver Interface (WDI) instead. For more information about WDI, see WLAN Universal Windows driver model.

 

When set, the OID_DOT11_CIPHER_DEFAULT_KEY_ID object identifier (OID) requests that the miniport driver set the value of the Extensible Station (ExtSTA) dot11DefaultKeyID management information base (MIB) object to the specified value.

When queried, this OID requests that the miniport driver return the value of the dot11DefaultKeyID MIB object.

The dot11DefaultKeyID MIB object specifies the index of a cipher key in the 802.11 station's default key table that the station uses for data encryption. The 802.11 station uses the cipher key referenced by the dot11DefaultKeyID MIB object as the default encryption key for transmitted packets unless a key-mapping key exists for the destination media access control (MAC) address.

For more information about the default keys, per-station default keys, and key-mapping keys, see 802.11 Cipher Key Types.

Note  Support for this OID is mandatory if the 802.11 station supports any cipher algorithms. The miniport driver returns a list of supported cipher algorithms when OID_DOT11_SUPPORTED_UNICAST_ALGORITHM_PAIR or OID_DOT11_SUPPORTED_MULTICAST_ALGORITHM_PAIR are queried.

 

The data type for this OID is a ULONG value. For standard 802.11 cipher algorithms, the default key ID must be from 0 through 3. For a cipher algorithm developed by an IHV, the default key ID can be any value within the range defined by the IHV.

The IEEE 802.11-2012 standard defines key index values from 1 through 4. The value x specified by this OID maps to the 802.11 key index (x + 1).

When transmitting 802.11 data, the 802.11 station will encrypt the MAC service data unit (MSDU) payload data using the cipher key referenced by the dot11DefaultKeyID MIB object if the following are true:

  • The basic service set (BSS) network has enabled encryption.

  • A key mapping key does not exist for the destination MAC address. For more information about key-mapping keys, see OID_DOT11_CIPHER_KEY_MAPPING_KEY.

When OID_DOT11_CIPHER_DEFAULT_KEY_ID is set, the 802.11 station must synchronize the change to the default key ID with its packet-processing path. When the default key ID is changed, the 802.11 station must use it to encrypt the next MAC protocol data unit (MPDU) data frame that it transmits.

The default value of the dot11DefaultKeyID MIB object is zero. The miniport driver must set this MIB object to its default if any of the following occur:

  • The miniport driver's MiniportInitializeEx function is called.

  • A method request of OID_DOT11_RESET_REQUEST is made to reset the MAC layer of the 802.11 station and the bSetDefaultMIB member of the DOT11_RESET_REQUEST structure is TRUE.

Requirements

Version

Available in Windows Vista and later versions of the Windows operating systems.

Header

 Windot11.h (include Ndis.h)

See also

Native 802.11 Wireless LAN OIDs