keyMaterial

Article
05/13/2021

Defines a network key or pass phrase. If protected is true, then the key material is encrypted; otherwise, the key material is unencrypted. Encrypted key material is expressed in hexadecimal form.

Element hierarchy

<WLANProfile>

<MSM>

<security>

<sharedKey>: <keyMaterial>

Syntax

<keyMaterial>

  string

</keyMaterial>

Attributes and Elements

Attributes

None.

Child Elements

None.

Parent Elements

Parent Element	Description
sharedKey	Defines optional shared key information to be used by this profile to connect to a WLAN.

Remarks

The range of valid values for the keyMaterial element varies by the type of authentication and encryption used, as specified by the authentication and encryption elements. It also varies by keyType.

The following table shows valid keyMaterial values for some authentication and encryption pairs:

authentication value	encryption value	keyType value	Valid keyMaterial values
open or shared	WEP	networkKey	This element contains a WEP key of 5 or 13 ANSI characters, or of 10 or 26 hexadecimal characters.
WPAPSK or WPA2PSK	TKIP or AES	passPhrase	This element contains a pass phrase of 8 to 63 ASCII characters, that is, 8 to 63 ANSI characters in the range of 32 to 126. Key values must comply with the requirements specified by 802.11i.
WPAPSK or WPA2PSK	TKIP or AES	networkKey	This element contains a key of 64 hexadecimal characters.

Unicode characters may be entered where ANSI or ASCII characters are specified above. However, if the supplied Unicode characters cannot be mapped to ANSI or ASCII characters, then the supplied key material is rejected.

Requirements

	Value
Namespace	`http://www.microsoft.com/networking/CarrierControl/WLAN/v1`