wpa_config Struct Reference

#include <config.h>

List of all members.

Public Attributes

int ap_scan
struct wpa_config_blobblobs
unsigned int bss_max_count
char * config_methods
char country [2]
char * ctrl_interface
char * ctrl_interface_group
char * device_name
char * device_type
unsigned int dot11RSNAConfigPMKLifetime
unsigned int dot11RSNAConfigPMKReauthThreshold
unsigned int dot11RSNAConfigSATimeout
char * driver_param
int eapol_version
int fast_reauth
int filter_ssids
char * manufacturer
char * model_name
char * model_number
int num_prio
char * opensc_engine_path
u8 os_version [4]
char * pkcs11_engine_path
char * pkcs11_module_path
struct wpa_ssid ** pssid
char * serial_number
struct wpa_ssidssid
int update_config
u8 uuid [16]
int wps_cred_processing

Detailed Description

struct wpa_config - wpa_supplicant configuration data

This data structure is presents the per-interface (radio) configuration data. In many cases, there is only one struct wpa_config instance, but if more than one network interface is being controlled, one instance is used for each.

Definition at line 38 of file config.h.


Member Data Documentation

ap_scan - AP scanning/selection

By default, wpa_supplicant requests driver to perform AP scanning and then uses the scan results to select a suitable AP. Another alternative is to allow the driver to take care of AP scanning and selection and use wpa_supplicant just to process EAPOL frames based on IEEE 802.11 association information from the driver.

1: wpa_supplicant initiates scanning and AP selection (default).

0: Driver takes care of scanning, AP selection, and IEEE 802.11 association parameters (e.g., WPA IE generation); this mode can also be used with non-WPA drivers when using IEEE 802.1X mode; do not try to associate with APs (i.e., external program needs to control association). This mode must also be used when using wired Ethernet drivers.

2: like 0, but associate with APs using security policy and SSID (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS drivers to enable operation with hidden SSIDs and optimized roaming; in this mode, the network blocks in the configuration are tried one by one until the driver reports successful association; each network block should have explicit security policy (i.e., only one option in the lists) for key_mgmt, pairwise, group, proto variables.

Definition at line 98 of file config.h.

blobs - Configuration blobs

Definition at line 248 of file config.h.

bss_max_count - Maximum number of BSS entries to keep in memory

Definition at line 339 of file config.h.

config_methods - Config Methods

This is a space-separated list of supported WPS configuration methods. For example, "label display push_button keypad". Available methods: usba ethernet label display ext_nfc_token int_nfc_token nfc_interface push_button keypad.

Definition at line 309 of file config.h.

country - Country code

This is the ISO/IEC alpha2 country code for which we are operating in

Definition at line 323 of file config.h.

ctrl_interface - Parameters for the control interface

If this is specified, wpa_supplicant will open a control interface that is available for external programs to manage wpa_supplicant. The meaning of this string depends on which control interface mechanism is used. For all cases, the existance of this parameter in configuration is used to determine whether the control interface is enabled.

For UNIX domain sockets (default on Linux and BSD): This is a directory that will be created for UNIX domain sockets for listening to requests from external programs (CLI/GUI, etc.) for status information and configuration. The socket file will be named based on the interface name, so multiple wpa_supplicant processes can be run at the same time if more than one interface is used. /var/run/wpa_supplicant is the recommended directory for sockets and by default, wpa_cli will use it when trying to connect with wpa_supplicant.

Access control for the control interface can be configured by setting the directory to allow only members of a group to use sockets. This way, it is possible to run wpa_supplicant as root (since it needs to change network configuration and open raw sockets) and still allow GUI/CLI components to be run as non-root users. However, since the control interface can be used to change the network configuration, this access needs to be protected in many cases. By default, wpa_supplicant is configured to use gid 0 (root). If you want to allow non-root users to use the control interface, add a new group and change this value to match with that group. Add users that should have control interface access to this group.

When configuring both the directory and group, use following format: DIR=/var/run/wpa_supplicant GROUP=wheel DIR=/var/run/wpa_supplicant GROUP=0 (group can be either group name or gid)

For UDP connections (default on Windows): The value will be ignored. This variable is just used to select that the control interface is to be created. The value can be set to, e.g., udp (ctrl_interface=udp).

For Windows Named Pipe: This value can be used to set the security descriptor for controlling access to the control interface. Security descriptor can be set using Security Descriptor String Format (see http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp). The descriptor string needs to be prefixed with SDDL=. For example, ctrl_interface=SDDL=D: would set an empty DACL (which will reject all connections).

Definition at line 152 of file config.h.

ctrl_interface_group - Control interface group (DEPRECATED)

This variable is only used for backwards compatibility. Group for UNIX domain sockets should now be specified using GROUP=group in ctrl_interface variable.

Definition at line 161 of file config.h.

device_name - Device Name (WPS) User-friendly description of device; up to 32 octets encoded in UTF-8

Definition at line 260 of file config.h.

device_type - Primary Device Type (WPS) Used format: categ-OUI-subcateg categ = Category as an integer value OUI = OUI and type octet as a 4-octet hex-encoded value; 0050F204 for default WPS OUI subcateg = OUI-specific Sub Category as an integer value Examples: 1-0050F204-1 (Computer / PC) 1-0050F204-2 (Computer / Server) 5-0050F204-1 (Storage / NAS) 6-0050F204-1 (Network Infrastructure / AP)

Definition at line 299 of file config.h.

dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK

dot11 MIB variable for the maximum lifetime of a PMK in the PMK cache (unit: seconds).

Definition at line 214 of file config.h.

dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold

dot11 MIB variable for the percentage of the PMK lifetime that should expire before an IEEE 802.1X reauthentication occurs.

Definition at line 222 of file config.h.

dot11RSNAConfigSATimeout - Security association timeout

dot11 MIB variable for the maximum time a security association shall take to set up (unit: seconds).

Definition at line 230 of file config.h.

driver_param - Driver interface parameters

This text string is passed to the selected driver interface with the optional struct wpa_driver_ops::set_param() handler. This can be used to configure driver specific options without having to add new driver interface functionality.

Definition at line 206 of file config.h.

eapol_version - IEEE 802.1X/EAPOL version number

wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which defines EAPOL version 2. However, there are many APs that do not handle the new version number correctly (they seem to drop the frames completely). In order to make wpa_supplicant interoperate with these APs, the version number is set to 1 by default. This configuration value can be used to set it to the new version (2).

Definition at line 69 of file config.h.

fast_reauth - EAP fast re-authentication (session resumption)

By default, fast re-authentication is enabled for all EAP methods that support it. This variable can be used to disable fast re-authentication (by setting fast_reauth=0). Normally, there is no need to disable fast re-authentication.

Definition at line 171 of file config.h.

filter_ssids - SSID-based scan result filtering

0 = do not filter scan results 1 = only include configured SSIDs in scan results/BSS table

Definition at line 347 of file config.h.

manufacturer - Manufacturer (WPS) The manufacturer of the device (up to 64 ASCII characters)

Definition at line 266 of file config.h.

model_name - Model Name (WPS) Model of the device (up to 32 ASCII characters)

Definition at line 272 of file config.h.

model_number - Model Number (WPS) Additional device description (up to 32 ASCII characters)

Definition at line 278 of file config.h.

num_prio - Number of different priorities used in the pssid lists

This indicates how many per-priority network lists are included in pssid.

Definition at line 57 of file config.h.

opensc_engine_path - Path to the OpenSSL engine for opensc

This is an OpenSSL specific configuration option for loading OpenSC engine (engine_opensc.so); if NULL, this engine is not loaded.

Definition at line 179 of file config.h.

os_version - OS Version (WPS) 4-octet operating system version number

Definition at line 315 of file config.h.

pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11

This is an OpenSSL specific configuration option for loading PKCS#11 engine (engine_pkcs11.so); if NULL, this engine is not loaded.

Definition at line 187 of file config.h.

pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module

This is an OpenSSL specific configuration option for configuring path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if NULL, this module is not loaded.

Definition at line 196 of file config.h.

pssid - Per-priority network lists (in priority order)

Definition at line 49 of file config.h.

serial_number - Serial Number (WPS) Serial number of the device (up to 32 characters)

Definition at line 284 of file config.h.

ssid - Head of the global network list

This is the head for the list of all the configured networks.

Definition at line 44 of file config.h.

update_config - Is wpa_supplicant allowed to update configuration

This variable control whether wpa_supplicant is allow to re-write its configuration with wpa_config_write(). If this is zero, configuration data is only changed in memory and the external data is not overriden. If this is non-zero, wpa_supplicant will update the configuration data (e.g., a file) whenever configuration is changed. This update may replace the old configuration which can remove comments from it in case of a text file configuration.

Definition at line 243 of file config.h.

uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS

Definition at line 253 of file config.h.

wps_cred_processing - Credential processing

0 = process received credentials internally 1 = do not process received credentials; just pass them over ctrl_iface to external program(s) 2 = process received credentials internally and pass them over ctrl_iface to external program(s)

Definition at line 334 of file config.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:15 2013