Package: android.hardware.wifi.supplicant@1.0

ISupplicantStaNetwork

interface ISupplicantStaNetwork extends ISupplicantNetwork

Interface exposed by the supplicant for each station mode network configuration it controls.

Properties

ParamSizeLimits

enum ParamSizeLimits: uint32_t

Size limits for some of the params used in this interface.

Details
Members
SSID_MAX_LEN_IN_BYTES = 32
Max length of SSID param.
PSK_PASSPHRASE_MIN_LEN_IN_BYTES = 8
Min length of PSK passphrase param.
PSK_PASSPHRASE_MAX_LEN_IN_BYTES = 63
Max length of PSK passphrase param.
WEP_KEYS_MAX_NUM = 4
Max number of WEP keys param.
WEP40_KEY_LEN_IN_BYTES = 5
Length of each WEP40 keys param.
WEP104_KEY_LEN_IN_BYTES = 13
Length of each WEP104 keys param.

KeyMgmtMask

enum KeyMgmtMask: uint32_t

Possble mask of values for KeyMgmt param.

Details
Members
WPA_EAP = 1 << 0
WPA_PSK = 1 << 1
NONE = 1 << 2
IEEE8021X = 1 << 3
FT_EAP = 1 << 5
FT_PSK = 1 << 6
OSEN = 1 << 15

ProtoMask

enum ProtoMask: uint32_t

Possble mask of values for Proto param.

Details
Members
WPA = 1 << 0
RSN = 1 << 1
OSEN = 1 << 3
Unused 1 << 2

AuthAlgMask

enum AuthAlgMask: uint32_t

Possble mask of values for AuthAlg param.

Details
Members
OPEN = 1 << 0
SHARED = 1 << 1
LEAP = 1 << 2

GroupCipherMask

enum GroupCipherMask: uint32_t

Possble mask of values for GroupCipher param.

Details
Members
WEP40 = 1 << 1
WEP104 = 1 << 2
TKIP = 1 << 3
CCMP = 1 << 4
GTK_NOT_USED = 1 << 14

PairwiseCipherMask

enum PairwiseCipherMask: uint32_t

Possble mask of values for PairwiseCipher param.

Details
Members
NONE = 1 << 0
TKIP = 1 << 3
CCMP = 1 << 4

EapMethod

enum EapMethod: uint32_t

Possble values for EapMethod param.

Details
Members
PEAP = 0
TLS = 1
TTLS = 2
PWD = 3
SIM = 4
AKA = 5
AKA_PRIME = 6
WFA_UNAUTH_TLS = 7

EapPhase2Method

enum EapPhase2Method: uint32_t

Possble values for Phase2Method param.

Details
Members
NONE = 0
PAP = 1
MSPAP = 2
MSPAPV2 = 3
GTC = 4
SIM = 5
AKA = 6
AKA_PRIME = 7

NetworkResponseEapSimGsmAuthParams

struct NetworkResponseEapSimGsmAuthParams {uint8_t kc; uint8_t sres}

Params of |sendNetworkEapSimGsmAuthResponse| request .(Refer RFC 4186 )

Details
Members
kc
sres

NetworkResponseEapSimUmtsAuthParams

struct NetworkResponseEapSimUmtsAuthParams {vec res; uint8_t ik; uint8_t ck}

Params of |sendNetworkEapSimUmtsAuthResponse| request .(Refer RFC 4187 )

Details
Members
res
ik
ck

Methods

registerCallback

registerCallback (ISupplicantStaNetworkCallback callback)
generates (SupplicantStatus status)

Register for callbacks from this network.

These callbacks are invoked for events that are specific to this network.Registration of multiple callback objects is supported.These objects must be automatically deleted when the corresponding client process is dead or if this network is removed.

Details
Parameters
callback
An instance of the |ISupplicantStaNetworkCallback| HIDL interface object.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setSsid

setSsid (Ssid ssid)
generates (SupplicantStatus status)

Set SSID for this network.

Details
Parameters
ssid
value to set.Max length of |ParamSizeLimits.SSID_MAX_LEN_IN_BYTES|.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setBssid

setBssid (Bssid bssid)
generates (SupplicantStatus status)

Set the network to only connect to an AP with provided BSSID.

Details
Parameters
bssid
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setScanSsid

setScanSsid (bool enable)
generates (SupplicantStatus status)

Set whether to send probe requests for this network(hidden).

Details
Parameters
enable
true to set, false otherwise.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setKeyMgmt

setKeyMgmt (bitfield<KeyMgmtMask> keyMgmtMask)
generates (SupplicantStatus status)

Set key management mask for the network.

Details
Parameters
keyMgmtMask
value to set.Combination of |KeyMgmtMask| values.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setProto

setProto (bitfield<ProtoMask> protoMask)
generates (SupplicantStatus status)

Set proto mask for the network.

Details
Parameters
protoMask
value to set.Combination of |ProtoMask| values.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setAuthAlg

setAuthAlg (bitfield<AuthAlgMask> authAlgMask)
generates (SupplicantStatus status)

Set auth alg mask for the network.

Details
Parameters
authAlgMask
value to set.Combination of |ProtoMask| values.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setGroupCipher

setGroupCipher (bitfield<GroupCipherMask> groupCipherMask)
generates (SupplicantStatus status)

Set group cipher mask for the network.

Details
Parameters
groupCipherMask
value to set.Combination of |ProtoMask| values.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setPairwiseCipher

setPairwiseCipher (bitfield<PairwiseCipherMask> pairwiseCipherMask)
generates (SupplicantStatus status)

Set pairwise cipher mask for the network.

Details
Parameters
pairwiseCipherMask
value to set.Combination of |ProtoMask| values.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setPskPassphrase

setPskPassphrase (string psk)
generates (SupplicantStatus status)

Set passphrase for WPA_PSK network.

Details
Parameters
psk
value to set.Length of value must be between |ParamSizeLimits.PSK_PASSPHRASE_MIN_LEN_IN_BYTES| and |ParamSizeLimits.PSK_PASSPHRASE_MAX_LEN_IN_BYTES|.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setPsk

setPsk (uint8_t[32] psk)
generates (SupplicantStatus status)

Set raw psk for WPA_PSK network.

Details
Parameters
psk
value to set as specified in IEEE 802.11i-2004 standard.This is the calculated using 'wpa_passphrase<ssid>[ passphrase]'
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setWepKey

setWepKey (uint32_t keyIdx, vec<uint8_t> wepKey)
generates (SupplicantStatus status)

Set WEP key for WEP network.

Details
Parameters
keyIdx
Index of wep key to set.Max of |ParamSizeLimits.WEP_KEYS_MAX_NUM|.
wepKey
value to set.Length of each key must be either |ParamSizeLimits.WEP40_KEY_LEN_IN_BYTES| or |ParamSizeLimits.WEP104_KEY_LEN_IN_BYTES|.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setWepTxKeyIdx

setWepTxKeyIdx (uint32_t keyIdx)
generates (SupplicantStatus status)

Set default Tx key index for WEP network.

Details
Parameters
keyIdx
value to set.Max of |ParamSizeLimits.WEP_KEYS_MAX_NUM|.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setRequirePmf

setRequirePmf (bool enable)
generates (SupplicantStatus status)

Set whether RequirePmf is enabled for this network.

Details
Parameters
enable
true to set, false otherwise.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapMethod

setEapMethod (EapMethod method)
generates (SupplicantStatus status)

Set EAP Method for this network.

Details
Parameters
method
value to be set.Must be one of |EapMethod| values.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapPhase2Method

setEapPhase2Method (EapPhase2Method method)
generates (SupplicantStatus status)

Set EAP Phase2 Method for this network.

EAP method needs to be set for this to work.

Details
Parameters
method
value to set.Must be one of |EapPhase2Method| values.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapIdentity

setEapIdentity (vec<uint8_t> identity)
generates (SupplicantStatus status)

Set EAP Identity for this network.

Details
Parameters
identity
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapAnonymousIdentity

setEapAnonymousIdentity (vec<uint8_t> identity)
generates (SupplicantStatus status)

Set EAP Anonymous Identity for this network.

Details
Parameters
identity
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapPassword

setEapPassword (vec<uint8_t> password)
generates (SupplicantStatus status)

Set EAP Password for this network.

Details
Parameters
password
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapCACert

setEapCACert (string path)
generates (SupplicantStatus status)

Set EAP CA certificate file path for this network.

Details
Parameters
path
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapCAPath

setEapCAPath (string path)
generates (SupplicantStatus status)

Set EAP CA certificate directory path for this network.

Details
Parameters
path
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapClientCert

setEapClientCert (string path)
generates (SupplicantStatus status)

Set EAP Client certificate file path for this network.

Details
Parameters
path
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapPrivateKeyId

setEapPrivateKeyId (string id)
generates (SupplicantStatus status)

Set EAP private key Id for this network.This is used if private key operations for EAP-TLS are performed using a smartcard.

Details
Parameters
id
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapSubjectMatch

setEapSubjectMatch (string match)
generates (SupplicantStatus status)

Set EAP subject match for this network.

Details
Parameters
match
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapAltSubjectMatch

setEapAltSubjectMatch (string match)
generates (SupplicantStatus status)

Set EAP Alt subject match for this network.

Details
Parameters
match
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapEngine

setEapEngine (bool enable)
generates (SupplicantStatus status)

Enable EAP Open SSL Engine for this network.

Details
Parameters
enable
true to set, false otherwise.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapEngineID

setEapEngineID (string id)
generates (SupplicantStatus status)

Set EAP Open SSL Engine ID for this network.

Details
Parameters
id
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setEapDomainSuffixMatch

setEapDomainSuffixMatch (string match)
generates (SupplicantStatus status)

Set EAP Domain suffix match for this network.

Details
Parameters
match
value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setProactiveKeyCaching

setProactiveKeyCaching (bool enable)
generates (SupplicantStatus status)

This field can be used to enable proactive key caching which is also known as opportunistic PMKSA caching for WPA2.This is disabled(0)by default unless default value is changed with the global okc=1 parameter.

Proactive key caching is used to make supplicant assume that the APs are using the same PMK and generate PMKSA cache entries without doing RSN pre-authentication.This requires support from the AP side and is normally used with wireless switches that co-locate the authenticator.

Details
Parameters
enable
true to set, false otherwise.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setIdStr

setIdStr (string idStr)
generates (SupplicantStatus status)

Set ID string for this network.Network identifier string for external scripts.

Details
Parameters
idStr
ID string value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

setUpdateIdentifier

setUpdateIdentifier (uint32_t id)
generates (SupplicantStatus status)

Set PPS MO ID for this network .(Hotspot 2.0 PerProviderSubscription/UpdateIdentifier)

Details
Parameters
id
ID value to set.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

getSsid

getSsid ()
generates (SupplicantStatus status, Ssid ssid)

Get SSID for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
ssid
value set.

getBssid

getBssid ()
generates (SupplicantStatus status, Bssid bssid)

Get the BSSID set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
bssid
value set.

getScanSsid

getScanSsid ()
generates (SupplicantStatus status, bool enabled)

Get whether Probe Requests are being sent for this network(hidden).

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
enabled
true if set, false otherwise.

getKeyMgmt

getKeyMgmt ()
generates (SupplicantStatus status, bitfield<KeyMgmtMask> keyMgmtMask)

Get the key mgmt mask set for the network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
keyMgmtMask
Combination of |KeyMgmtMask| values.

getProto

getProto ()
generates (SupplicantStatus status, bitfield<ProtoMask> protoMask)

Get the proto mask set for the network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
protoMask
Combination of |ProtoMask| values.

getAuthAlg

getAuthAlg ()
generates (SupplicantStatus status, bitfield<AuthAlgMask> authAlgMask)

Get the auth alg mask set for the network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
authAlgMask
Combination of |AuthAlgMask| values.

getGroupCipher

getGroupCipher ()
generates (SupplicantStatus status, bitfield<GroupCipherMask> groupCipherMask)

Get the group cipher mask set for the network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
groupCipherMask
Combination of |GroupCipherMask| values.

getPairwiseCipher

getPairwiseCipher ()
generates (SupplicantStatus status, bitfield<PairwiseCipherMask> pairwiseCipherMask)

Get the pairwise cipher mask set for the network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
pairwiseCipherMask
Combination of |PairwiseCipherMask| values.

getPskPassphrase

getPskPassphrase ()
generates (SupplicantStatus status, string psk)

Get passphrase for WPA_PSK network.Must return a failure if network has no passphrase set(use |getPsk| if network was configured with raw psk instead).

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
psk
value set.

getPsk

getPsk ()
generates (SupplicantStatus status, uint8_t[32] psk)

Get raw psk for WPA_PSK network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
psk
value set.

getWepKey

getWepKey (uint32_t keyIdx)
generates (SupplicantStatus status, vec<uint8_t> wepKey)

Get WEP key for WEP network.

Details
Parameters
keyIdx
Index of wep key to be fetched.Max of |WEP_KEYS_MAX_NUM|.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
wepKey
value set.

getWepTxKeyIdx

getWepTxKeyIdx ()
generates (SupplicantStatus status, uint32_t keyIdx)

Get default Tx key index for WEP network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
keyIdx
value set.

getRequirePmf

getRequirePmf ()
generates (SupplicantStatus status, bool enabled)

Get whether RequirePmf is enabled for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
enabled
true if set, false otherwise.

getEapMethod

getEapMethod ()
generates (SupplicantStatus status, EapMethod method)

Get EAP Method set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
method
value set.Must be one of |EapMethod| values.

getEapPhase2Method

getEapPhase2Method ()
generates (SupplicantStatus status, EapPhase2Method method)

Get EAP Phase2 Method set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
method
value set.Must be one of |EapPhase2Method| values.

getEapIdentity

getEapIdentity ()
generates (SupplicantStatus status, vec<uint8_t> identity)

Get EAP Identity set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
identity
value set.

getEapAnonymousIdentity

getEapAnonymousIdentity ()
generates (SupplicantStatus status, vec<uint8_t> identity)

Get EAP Anonymous Identity set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
identity
value set.

getEapPassword

getEapPassword ()
generates (SupplicantStatus status, vec<uint8_t> password)

Get EAP Password set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
password
value set.

getEapCACert

getEapCACert ()
generates (SupplicantStatus status, string path)

Get EAP CA certificate file path set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
path
value set.

getEapCAPath

getEapCAPath ()
generates (SupplicantStatus status, string path)

Get EAP CA certificate directory path set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
path
value set.

getEapClientCert

getEapClientCert ()
generates (SupplicantStatus status, string path)

Get EAP Client certificate file path set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
path
value set.

getEapPrivateKeyId

getEapPrivateKeyId ()
generates (SupplicantStatus status, string id)

Get EAP private key Id set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
id
value set.

getEapSubjectMatch

getEapSubjectMatch ()
generates (SupplicantStatus status, string match)

Get EAP subject match set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
match
value set.

getEapAltSubjectMatch

getEapAltSubjectMatch ()
generates (SupplicantStatus status, string match)

Get EAP Alt subject match set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
match
value set.

getEapEngine

getEapEngine ()
generates (SupplicantStatus status, bool enabled)

Get if EAP Open SSL Engine is enabled for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
enabled
true if set, false otherwise.

getEapEngineID

getEapEngineID ()
generates (SupplicantStatus status, string id)

Get EAP Open SSL Engine ID set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
id
value set.

getEapDomainSuffixMatch

getEapDomainSuffixMatch ()
generates (SupplicantStatus status, string match)

Get EAP Domain suffix match set for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
match
value set.

getIdStr

getIdStr ()
generates (SupplicantStatus status, string idStr)

Get ID string set for this network.Network identifier string for external scripts.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
idStr
ID string set.

getWpsNfcConfigurationToken

getWpsNfcConfigurationToken ()
generates (SupplicantStatus status, vec<uint8_t> token)

Retrieves a WPS-NFC configuration token for this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_ARGS_INVALID|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|
token
Bytes representing WPS-NFC configuration token.This is a dump of all the WPS atrributes of the AP configuration as specified in the Wi-Fi Protected Setup Specification.

enable

enable (bool noConnect)
generates (SupplicantStatus status)

Enable the network for connection purposes.

This must trigger a connection to the network if:a)|noConnect| is false, and b)This is the only network configured, and c)Is visible in the current scan results.

Details
Parameters
noConnect
Only enable the network, dont trigger a connect.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

disable

disable ()
generates (SupplicantStatus status)

Disable the network for connection purposes.

This must trigger a disconnection from the network, if currently connected to this one.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

select

select ()
generates (SupplicantStatus status)

Initiate connection to this network.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

sendNetworkEapSimGsmAuthResponse

sendNetworkEapSimGsmAuthResponse (vec<NetworkResponseEapSimGsmAuthParams> params)
generates (SupplicantStatus status)

Used to send a response to the |ISupplicantNetworkCallback.onNetworkEapSimGsmAuthRequest| request.

Details
Parameters
params
Params to be used for EAP GSM authentication.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

sendNetworkEapSimGsmAuthFailure

sendNetworkEapSimGsmAuthFailure ()
generates (SupplicantStatus status)

Used to send a response to the |ISupplicantNetworkCallback.onNetworkEapSimGsmAuthRequest| request.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

sendNetworkEapSimUmtsAuthResponse

sendNetworkEapSimUmtsAuthResponse (NetworkResponseEapSimUmtsAuthParams params)
generates (SupplicantStatus status)

Used to send a response to the |ISupplicantNetworkCallback.onNetworkEapSimUmtsAuthRequest| request.

Details
Parameters
params
Params to be used for EAP UMTS authentication.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

sendNetworkEapSimUmtsAutsResponse

sendNetworkEapSimUmtsAutsResponse (uint8_t[14] auts)
generates (SupplicantStatus status)

Used to send a response to the |ISupplicantNetworkCallback.onNetworkEapSimUmtsAuthRequest| request.

Details
Parameters
auts
Params to be used for EAP UMTS authentication.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

sendNetworkEapSimUmtsAuthFailure

sendNetworkEapSimUmtsAuthFailure ()
generates (SupplicantStatus status)

Used to send a response to the |ISupplicantNetworkCallback.onNetworkEapSimUmtsAuthRequest| request.

Details
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|

sendNetworkEapIdentityResponse

sendNetworkEapIdentityResponse (vec<uint8_t> identity)
generates (SupplicantStatus status)

Used to send a response to the |ISupplicantNetworkCallback.onNetworkEapIdentityRequest| request.

Details
Parameters
identity
Identity to be used for the network.
Generates
status
Status of the operation.Possible status codes:|SupplicantStatusCode.SUCCESS|, |SupplicantStatusCode.FAILURE_UNKNOWN|, |SupplicantStatusCode.FAILURE_NETWORK_INVALID|