NAME

Config::Apple::Profile::Payload::Wi-Fi - Class for the Wi-Fi payload type.

DESCRIPTION

This class implements the Wi-Fi payload.

INSTANCE METHODS

The following instance methods are provided by this class.

validate_key($key, $value)

Performs additional validation for certain payload keys in this class:

EncryptionType

Only WEP, WPA, Any, and None are accepted as values.
MCCAndMNCs

Only six-digit numbers are accepted.
ProxyPort

This must be a number within the range 1 to 65,535, inclusive.

This is done in addition to the validation performed by the parent class.

See also the documentation in Config::Apple::Profile::Payload::Common.

PAYLOAD KEYS

All of the payload keys defined in Config::Apple::Profile::Payload::Common are used by this payload.

This payload has the following additional keys:

General Configuration

`SSID_STR`

A string, this is the SSID (the name) of the Wi-Fi network.

`HIDDEN_NETWORK`

Optional

If true, this Wi-Fi network does not broadcast itself, meaning that the SSID and encryption information must be specified in this configuration.

Defaults to false.

`AutoJoin`

Optional

If true, the device will automatically join the Wi-Fi network if it is detected. If the device sees multiple Wi-Fi networks that have auto-join enabled, only one Wi-Fi network will be joined.

Defaults to true.

`EncryptionType`

A string. The type of encryption to support. Valid values are Any, None, WEP, and WPA. WPA includes WPA and WPA2, the -Personal and -Enterprise versions.

The encryption type specified must exactly match what is configured on the access point. For maximum flexibility, with the higher possibility of connecting to an unexpected access point, use the value Any.

Encryption Configuration

`EAPClientConfiguration`

Optional, for use with WPA- and WPA2-Enterprise encryption.

An object of the class Config::Apple::Profile::Payload::WiFi::EAPClientConfiguration. This object becomes a dict containing the list of supported EAP types and all other EAP-related configuration, except for a password or identity certificate.

See Config::Apple::Profile::Payload::WiFi::EAPClientConfiguration.

`Password`

Optional

A string. If password-based authentication is used (such as WEP, WPA-Personal, WPA2-Personal, or -Enterprise with a password-based EAP), this is the password to use. If no other authentication methods are available, the user may be prompted for a password.

`PayloadCertificateUUID`

Optional, for use with WPA- and WPA2-Enterprise encryption and EAP-TLS.

A UUID. This is the UUID of an identity certificate that has already been loaded onto the device, using a payload class of type Config::Apple::Profile::Payload::Certificate::PKCS12. The identity certificate may be included in the same configuration profile, or in a previously-installed profile.

See Config::Apple::Profile::Payload::Certificate::PKCS12.

Hotspot Configuration

The payload keys in this section refer to Hotspot 2.0, also known as Wi-Fi CERTIFIED Passpoint. More information on Hotspot 2.0 is available here:

http://www.wi-fi.org/discover-wi-fi/wi-fi-certified-passpoint
http://en.wikipedia.org/wiki/Hotspot_(Wi-Fi)#Hotspot_2.0