keyMaterial Element (Compact 2013)
3/26/2014
This element contains a network key or passphrase. If the protected element has a value of TRUE, this key material is encrypted; otherwise, the key material is not encrypted. Encrypted key material is expressed in hexadecimal form.
Syntax
<xs:element name="keyMaterial"
type="string"
/>
Remarks
The keyMaterial element is defined by the sharedKey Element.
The range of valid values for the keyMaterial element varies according to the type of authentication and encryption used, as specified by the authentication Element and the encryption Element. 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 made up of 5 or 13 ANSI characters, or of 10 or 26 hexadecimal characters |
WPAPSK or WPA2PSK |
TKIP or AES |
passPhrase |
This element contains a passphrase made up 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 made up of 64 hexadecimal characters |
Unicode characters can be entered where ANSI or ASCII characters are specified. However, if the supplied Unicode characters cannot be mapped to ANSI or ASCII characters, the supplied key material is rejected.
Key material returned by WlanGetProfile is always encrypted. If nonencrypted key material is passed to WlanSetProfile, the key material is automatically encrypted before it is stored in the profile store.
See Also
Reference
Profile XML Schema Elements
sharedKey Element
authentication Element
encryption Element
WlanGetProfile
WlanSetProfile
Profile XML Schema Reference