wpa_ssid Struct Reference

#include <config_ssid.h>

List of all members.

Public Types

enum  wpas_mode { WPAS_MODE_INFRA = 0, WPAS_MODE_IBSS = 1, WPAS_MODE_AP = 2 }

Public Attributes

int auth_alg
char * bgscan
u8 bssid [ETH_ALEN]
int bssid_set
int disabled
int * freq_list
int frequency
int group_cipher
int id
char * id_str
int key_mgmt
int mixed_cell
enum wpa_ssid::wpas_mode mode
struct wpa_ssidnext
int pairwise_cipher
char * passphrase
int peerkey
struct wpa_ssidpnext
int priority
int proactive_key_caching
int proto
u8 psk [32]
int psk_set
int * scan_freq
int scan_ssid
u8ssid
size_t ssid_len
u8 wep_key [NUM_WEP_KEYS][MAX_WEP_KEY_LEN]
size_t wep_key_len [NUM_WEP_KEYS]
int wep_tx_keyidx
int wpa_ptk_rekey

Detailed Description

struct wpa_ssid - Network configuration data

This structure includes all the configuration variables for a network. This data is included in the per-interface configuration data as an element of the network list, struct wpa_config::ssid. Each network block in the configuration is mapped to a struct wpa_ssid instance.

Definition at line 42 of file config_ssid.h.


Member Enumeration Documentation

mode - IEEE 802.11 operation mode (Infrastucture/IBSS)

0 = infrastructure (Managed) mode, i.e., associate with an AP.

1 = IBSS (ad-hoc, peer-to-peer)

2 = AP (access point)

Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). In addition, ap_scan has to be set to 2 for IBSS. WPA-None requires following network block options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not both), and psk must also be set (either directly or using ASCII passphrase).

Enumerator:
WPAS_MODE_INFRA 
WPAS_MODE_IBSS 
WPAS_MODE_AP 

Definition at line 283 of file config_ssid.h.


Member Data Documentation

auth_alg - Bitfield of allowed authentication algorithms

WPA_AUTH_ALG_*

Definition at line 166 of file config_ssid.h.

bgscan - Background scan and roaming parameters or NULL if none

This is an optional set of parameters for background scanning and roaming within a network (ESS) in following format: <bgscan module="" name>="">:<module parameters>="">

Definition at line 365 of file config_ssid.h.

u8 wpa_ssid::bssid[ETH_ALEN]

bssid - BSSID

If set, this network block is used only when associating with the AP using the configured BSSID

Definition at line 113 of file config_ssid.h.

bssid_set - Whether BSSID is configured for this network

Definition at line 118 of file config_ssid.h.

disabled - Whether this network is currently disabled

0 = this network can be used (default). 1 = this network block is disabled (can be enabled through ctrl_iface, e.g., with wpa_cli or wpa_gui).

Definition at line 296 of file config_ssid.h.

freq_list - Array of allowed frequencies or NULL for all

This is an optional zero-terminated array of frequencies in megahertz (MHz) to allow for selecting the BSS. If set, scan results that do not match any of the specified frequencies are not considered when selecting a BSS.

Definition at line 375 of file config_ssid.h.

frequency - Channel frequency in megahertz (MHz) for IBSS

This value is used to configure the initial channel for IBSS (adhoc) networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in the infrastructure mode. In addition, this value is only used by the station that creates the IBSS. If an IBSS network with the configured SSID is already present, the frequency of the network will be used instead of this configured value.

Definition at line 338 of file config_ssid.h.

group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*

Definition at line 147 of file config_ssid.h.

id - Unique id for the network

This identifier is used as a unique identifier for each network block when using the control interface. Each network is allocated an id when it is being created, either when reading the configuration file or when a new network is added through the control interface.

Definition at line 68 of file config_ssid.h.

id_str - Network identifier string for external scripts

This value is passed to external ctrl_iface monitors in WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR environment variable for action scripts.

Definition at line 316 of file config_ssid.h.

key_mgmt - Bitfield of allowed key management protocols

WPA_KEY_MGMT_*

Definition at line 154 of file config_ssid.h.

mixed_cell - Whether mixed cells are allowed

This option can be used to configure whether so called mixed cells, i.e., networks that use both plaintext and encryption in the same SSID, are allowed. This is disabled (0) by default. Enable by setting this to 1.

Definition at line 231 of file config_ssid.h.

mode - IEEE 802.11 operation mode (Infrastucture/IBSS)

0 = infrastructure (Managed) mode, i.e., associate with an AP.

1 = IBSS (ad-hoc, peer-to-peer)

2 = AP (access point)

Note: IBSS can only be used with key_mgmt NONE (plaintext and static WEP) and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). In addition, ap_scan has to be set to 2 for IBSS. WPA-None requires following network block options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or CCMP, but not both), and psk must also be set (either directly or using ASCII passphrase).

next - Next network in global list

This pointer can be used to iterate over all networks. The head of this list is stored in the ssid field of struct wpa_config.

Definition at line 49 of file config_ssid.h.

pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*

Definition at line 142 of file config_ssid.h.

passphrase - WPA ASCII passphrase

If this is set, psk will be generated using the SSID and passphrase configured for the network. ASCII passphrase must be between 8 and 63 characters (inclusive).

Definition at line 137 of file config_ssid.h.

peerkey - Whether PeerKey handshake for direct links is allowed

This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are enabled.

0 = disabled (default) 1 = enabled

Definition at line 307 of file config_ssid.h.

pnext - Next network in per-priority list

This pointer can be used to iterate over all networks in the same priority class. The heads of these list are stored in the pssid fields of struct wpa_config.

Definition at line 58 of file config_ssid.h.

priority - Priority group

By default, all networks will get same priority group (0). If some of the networks are more desirable, this field can be used to change the order in which wpa_supplicant goes through the networks when selecting a BSS. The priority groups will be iterated in decreasing priority (i.e., the larger the priority value, the sooner the network is matched against the scan results). Within each priority group, networks will be selected based on security policy, signal strength, etc.

Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are not using this priority to select the order for scanning. Instead, they try the networks in the order that used in the configuration file.

Definition at line 87 of file config_ssid.h.

proactive_key_caching - Enable proactive key caching

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. Enable by setting this to 1.

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.

Definition at line 221 of file config_ssid.h.

proto - Bitfield of allowed protocols, WPA_PROTO_*

Definition at line 159 of file config_ssid.h.

psk - WPA pre-shared key (256 bits)

Definition at line 123 of file config_ssid.h.

psk_set - Whether PSK field is configured

Definition at line 128 of file config_ssid.h.

scan_freq - Array of frequencies to scan or NULL for all

This is an optional zero-terminated array of frequencies in megahertz (MHz) to include in scan requests when searching for this network. This can be used to speed up scanning when the network is known to not use all possible channels.

Definition at line 356 of file config_ssid.h.

scan_ssid - Scan this SSID with Probe Requests

scan_ssid can be used to scan for APs using hidden SSIDs. Note: Many drivers do not support this. ap_mode=2 can be used with such drivers to use hidden SSIDs.

Definition at line 175 of file config_ssid.h.

ssid - Service set identifier (network name)

This is the SSID for the network. For wireless interfaces, this is used to select which network will be used. If set to NULL (or ssid_len=0), any SSID can be used. For wired interfaces, this must be set to NULL. Note: SSID may contain any characters, even nul (ASCII 0) and as such, this should not be assumed to be a nul terminated string. ssid_len defines how many characters are valid and the ssid field is not guaranteed to be nul terminated.

Definition at line 100 of file config_ssid.h.

ssid_len - Length of the SSID

Definition at line 105 of file config_ssid.h.

u8 wpa_ssid::wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN]

wep_key - WEP keys

Definition at line 196 of file config_ssid.h.

size_t wpa_ssid::wep_key_len[NUM_WEP_KEYS]

wep_key_len - WEP key lengths

Definition at line 201 of file config_ssid.h.

wep_tx_keyidx - Default key index for TX frames using WEP

Definition at line 206 of file config_ssid.h.

wpa_ptk_rekey - Maximum lifetime for PTK in seconds

This value can be used to enforce rekeying of PTK to mitigate some attacks against TKIP deficiencies.

Definition at line 346 of file config_ssid.h.


The documentation for this struct was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines


wpa_supplicant
Author(s): Package maintained by Blaise Gassend
autogenerated on Fri Jan 11 10:05:16 2013