security (MSM) Element
Applies to: desktop apps only
The security (MSM) element contains various security settings.
<xs:element name="security"
minOccurs="0"
>
<xs:complexType>
<xs:sequence>
<xs:element name="authEncryption">
<xs:complexType>
<xs:sequence>
<xs:element name="authentication">
<xs:simpleType>
<xs:restriction
base="string"
>
<xs:enumeration
value="open"
/>
<xs:enumeration
value="shared"
/>
<xs:enumeration
value="WPA"
/>
<xs:enumeration
value="WPAPSK"
/>
<xs:enumeration
value="WPA2"
/>
<xs:enumeration
value="WPA2PSK"
/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="encryption">
<xs:simpleType>
<xs:restriction
base="string"
>
<xs:enumeration
value="none"
/>
<xs:enumeration
value="WEP"
/>
<xs:enumeration
value="TKIP"
/>
<xs:enumeration
value="AES"
/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="useOneX"
type="boolean"
minOccurs="0"
/>
<xs:any
processContents="lax"
minOccurs="0"
maxOccurs="unbounded"
namespace="##other"
/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="sharedKey"
minOccurs="0"
>
<xs:complexType>
<xs:sequence>
<xs:element name="keyType">
<xs:simpleType>
<xs:restriction
base="string"
>
<xs:enumeration
value="networkKey"
/>
<xs:enumeration
value="passPhrase"
/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="protected"
type="boolean"
/>
<xs:element name="keyMaterial"
type="string"
/>
<xs:any
processContents="lax"
minOccurs="0"
maxOccurs="unbounded"
namespace="##other"
/>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="keyIndex"
minOccurs="0"
>
<xs:simpleType>
<xs:restriction
base="integer"
>
<xs:minInclusive
value="0"
/>
<xs:maxInclusive
value="3"
/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="PMKCacheMode"
minOccurs="0"
>
<xs:simpleType>
<xs:restriction
base="string"
>
<xs:enumeration
value="disabled"
/>
<xs:enumeration
value="enabled"
/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="PMKCacheTTL"
minOccurs="0"
>
<xs:simpleType>
<xs:restriction
base="integer"
>
<xs:minInclusive
value="5"
/>
<xs:maxInclusive
value="1400"
/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="PMKCacheSize"
minOccurs="0"
>
<xs:simpleType>
<xs:restriction
base="integer"
>
<xs:minInclusive
value="1"
/>
<xs:maxInclusive
value="255"
/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="preAuthMode"
minOccurs="0"
>
<xs:simpleType>
<xs:restriction
base="string"
>
<xs:enumeration
value="disabled"
/>
<xs:enumeration
value="enabled"
/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:element name="preAuthThrottle"
minOccurs="0"
>
<xs:simpleType>
<xs:restriction
base="integer"
>
<xs:minInclusive
value="1"
/>
<xs:maxInclusive
value="16"
/>
</xs:restriction>
</xs:simpleType>
</xs:element>
<xs:any
processContents="lax"
minOccurs="0"
maxOccurs="unbounded"
namespace="##other"
/>
</xs:sequence>
</xs:complexType>
</xs:element>
The element is defined by the MSM element.
Child elements
| Element | Type | Description |
|---|---|---|
| authEncryption |
Specifies the authentication and encryption pair to be used for this profile. | |
| authentication |
Specifies the authentication and encryption pair to be used for this profile. | |
| encryption |
Sets the data encryption to use to connect to the wireless LAN. | |
| keyIndex |
Specifies which key index must be used to encrypt wireless traffic. This is only used when keyType is set to networkKey. | |
| keyMaterial | string |
Contains the network key or passphrase. |
| keyType |
Type of key. | |
| PMKCacheMode |
Indicates whether PMK caching will be used. This element is valid only for WPA2-defined networks.
| |
| PMKCacheSize |
Specifies the number of entries in the OMK cache on the client. This element is valid only for WPA2-defined networks with PMKCache mode set to enabled. If PMKCache mode is enabled, and this element is absent, the size of the cache defaults to 128 entries.
| |
| PMKCacheTTL |
Indicates the length of time, in minutes, that a PMK cache will be kept. This element is valid only for WPA2-defined networks with PMKCache mode set to enabled.
| |
| preAuthMode |
Determines if pre-authentication will be used by the client. Pre-authentication enables WPA2 secure fast roaming. This element is valid only for WPA2-defined networks with PMKCache mode set to enabled. If PMKCache mode is enabled, and this element is absent, the default value is disabled.
| |
| preAuthThrottle |
Indicates the number of tries when preauthenticating to neighboring APs. This element is valid only for WPA2-defined networks with PMKCache mode set to enabled. If PMKCache mode is enabled, and this element is absent, the number of tries defaults to 3.
| |
| protected | boolean |
Indicates whether the key is encrypted.
|
| sharedKey |
Contains the shared key information. This element is only required if WEP or PSK keys are required for the authentication and encryption pair. | |
| useOneX | boolean |
Indicates whether 802.1X is used. This flag is optional. |
Remarks
The FIPSMode element can be inserted as a child of the authEncryption element. The OneX element can be inserted as a child of the security (MSM) element.
Examples
To view sample profiles that use the security element, see Wireless Profile Samples.
Requirements
|
Minimum supported client | Windows Vista, Windows XP with SP3 |
|---|---|
|
Minimum supported server | Windows Server 2008 |
|
Redistributable | Wireless LAN API for Windows XP with SP2 |
See also
- Wireless Profile Samples
- Definition context of element in schema
- MSM
- Possible immediate parent element in schema instance
- MSM (WLANProfile)
Send comments about this topic to Microsoft
Build date: 2/3/2012
