security (MSM) Element (Compact 2013)

3/26/2014

This element contains various security settings.

Syntax

<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: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>
keyType
                                  Type of key.
                                                        <xs:element name="protected"
                            type="boolean"
                         />
                         />
keyMaterial
                                  Contains the network key or passphrase.                        <xs:any
                            processContents="lax"
                            minOccurs="0"
                            maxOccurs="unbounded"
                            namespace="##other"
                         />
                    </xs:sequence>
                </xs:complexType>
            </xs:element>
                minOccurs="0"
            >
                <xs:simpleType>
                    <xs:restriction
                        base="integer"
                    >
                        <xs:minInclusive
                            value="0"
                         />
                        <xs:maxInclusive
                            value="3"
                         />
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
                minOccurs="0"
            >
                <xs:simpleType>
                    <xs:restriction
                        base="string"
                    >
                        <xs:enumeration
                            value="disabled"
                         />
                        <xs:enumeration
                            value="enabled"
                         />
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
                minOccurs="0"
            >
                <xs:simpleType>
                    <xs:restriction
                        base="integer"
                    >
                        <xs:minInclusive
                            value="5"
                         />
                        <xs:maxInclusive
                            value="1400"
                         />
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
                minOccurs="0"
            >
                <xs:simpleType>
                    <xs:restriction
                        base="integer"
                    >
                        <xs:minInclusive
                            value="1"
                         />
                        <xs:maxInclusive
                            value="255"
                         />
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
                minOccurs="0"
            >
                <xs:simpleType>
                    <xs:restriction
                        base="string"
                    >
                        <xs:enumeration
                            value="disabled"
                         />
                        <xs:enumeration
                            value="enabled"
                         />
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
                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>

Child Elements

Element

Type

Description

authEncryption Element

Element

Specifies the authentication and encryption pair that must be used for this profile

authentication Element

Element

Specifies the authentication and encryption pair that must be used for this profile

encryption Element

Element

Sets the data encryption to use to connect to the wireless network

keyIndex Element

Element

Specifies the key index that must be used to encrypt wireless traffic. This element is used only when keyType Element is set to networkKey.

keyMaterial Element

String

Contains the network key or passphrase

keyType Element

Element

Type of key

PMKCacheMode Element

Element

Indicates whether PMK caching will be used. This element is valid for WPA2-defined networks only.

PMKCacheSize Element

Element

Specifies the number of entries in the OMK cache on the client. This element is valid for WPA2-defined networks that have PMKCacheMode Element mode set to ENABLED, only. If PMKCache mode is enabled and this element is absent, the cache size uses 128 entries.

PMKCacheTTL Element

Element

Indicates the length of time, in minutes, that a PMK cache will be kept. This element is valid for WPA2-defined networks that have PMKCache mode set to ENABLED, only.

preAuthMode Element

Element

Determines whether preauthentication will be used by the client. Preauthentication enables WPA2 secure fast roaming. This element is valid for WPA2-defined networks that have PMKCache mode set to enabled, only. If PMKCache mode is ENABLED and this element is absent, the default value is DISABLED.

preAuthThrottle Element

Element

Indicates the number of tries when preauthenticating to neighboring APs. This element is valid for WPA2-defined networks that have PMKCache mode set to enabled, only. If PMKCache mode is enabled and this element is absent, the default value is three (3).

protected Element

Boolean

Indicates whether the key is encrypted

sharedKey Element

Element

Contains the shared key information. This element required only if WEP or PSK keys are required for the authentication and encryption pair

useOneX Element

Boolean

Indicates whether 802.1X is used. This flag is optional.

Remarks

The security (MSM)element is defined by the MSM element.

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.

To view sample profiles that use the security (MSM) element, see Wi-Fi Profile Samples.

See Also

Reference

Profile XML Schema Elements
FIPSMode Element
OneX Element
Profile XML Schema Reference

Other Resources

Wi-Fi Profile Samples