OID_DOT11_CIPHER_DEFAULT_KEY

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 object identifier (OID) requests that the miniport driver add, modify, or delete an entry in its default key or per-station default key tables.

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 the DOT11_CIPHER_DEFAULT_KEY_VALUE structure.

When the OID_DOT11_CIPHER_DEFAULT_KEY OID is set, the miniport driver must follow these guidelines:

  • If the 802.11 station does not support the cipher algorithm specified by the AlgorithmId member, fail the set request by returning NDIS_STATUS_INVALID_DATA from its MiniportOidRequest function.

  • If the specified cipher algorithm does not support the key index specified by the uKeyIndex member, fail the set request by returning NDIS_STATUS_INVALID_DATA from its MiniportOidRequest function.

  • If the dot11DesiredBSSType management information base (MIB) object is set to dot11_BSS_type_independent and the MacAddr member is not set to 0x000000000000, the key defined by the DOT11_CIPHER_KEY_MAPPING_KEY_VALUE structure is a per-station cipher key. For more information about per-station default cipher keys, see Per-Station Default Keys.

    In this situation, the miniport driver must fail the set request if any of the following are true:

    • The dot11DesiredBSSType management information base (MIB) object is not set to dot11_BSS_type_independent. In this situation, the miniport driver returns NDIS_STATUS_INVALID_DATA from its MiniportOidRequest function. For more information about the dot11DesiredBSSType MIB object, see OID_DOT11_DESIRED_BSS_TYPE.
    • MacAddr is not a valid unicast MAC address. In this situation, the miniport driver returns NDIS_STATUS_INVALID_DATA from its MiniportOidRequest function.
    • A per-station default key table referenced by MacAddr does not exist and the 802.11 station does not have the resources to add a per-station default key table. In this situation, the driver returns NDIS_STATUS_INVALID_LENGTH from its MiniportOidRequest function.

      Note The miniport driver returns the number of per-station default key tables supported by the 802.11 station when OID_DOT11_EXTSTA_CAPABILITY is queried.

  • If the bDelete member is set to TRUE, delete the key material for the key referenced by the uKeyIndex member. If the driver had previously deleted the specified key, it must accept the set request by returning NDIS_STATUS_SUCCESS from its MiniportOidRequest function.

When modifying TKIP keys, the miniport driver must synchronize the key update with the packet-processing path on the 802.11 station.

For example, the miniport driver must avoid situations in which the packet payload was decrypted using the old cipher key and verified using the new message integrity code (MIC) key.

The 802.11 station must clear its default keys in the following situations:

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

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


Send comments about this topic to Microsoft