2 * WPA Supplicant / Configuration file structures
3 * Copyright (c) 2003-2005, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 #define DEFAULT_EAPOL_VERSION 1
13 #ifdef CONFIG_NO_SCAN_PROCESSING
14 #define DEFAULT_AP_SCAN 2
15 #else /* CONFIG_NO_SCAN_PROCESSING */
16 #define DEFAULT_AP_SCAN 1
17 #endif /* CONFIG_NO_SCAN_PROCESSING */
18 #define DEFAULT_FAST_REAUTH 1
19 #define DEFAULT_P2P_GO_INTENT 7
20 #define DEFAULT_P2P_INTRA_BSS 1
21 #define DEFAULT_BSS_MAX_COUNT 200
22 #define DEFAULT_BSS_EXPIRATION_AGE 180
23 #define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
24 #define DEFAULT_MAX_NUM_STA 128
25 #define DEFAULT_ACCESS_NETWORK_TYPE 15
27 #include "config_ssid.h"
31 #define CFG_CHANGED_DEVICE_NAME BIT(0)
32 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
33 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
34 #define CFG_CHANGED_OS_VERSION BIT(3)
35 #define CFG_CHANGED_UUID BIT(4)
36 #define CFG_CHANGED_COUNTRY BIT(5)
37 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
38 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
39 #define CFG_CHANGED_WPS_STRING BIT(8)
40 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
41 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
42 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
43 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
46 * struct wpa_config - wpa_supplicant configuration data
48 * This data structure is presents the per-interface (radio) configuration
49 * data. In many cases, there is only one struct wpa_config instance, but if
50 * more than one network interface is being controlled, one instance is used
55 * ssid - Head of the global network list
57 * This is the head for the list of all the configured networks.
59 struct wpa_ssid *ssid;
62 * pssid - Per-priority network lists (in priority order)
64 struct wpa_ssid **pssid;
67 * num_prio - Number of different priorities used in the pssid lists
69 * This indicates how many per-priority network lists are included in
75 * eapol_version - IEEE 802.1X/EAPOL version number
77 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
78 * defines EAPOL version 2. However, there are many APs that do not
79 * handle the new version number correctly (they seem to drop the
80 * frames completely). In order to make wpa_supplicant interoperate
81 * with these APs, the version number is set to 1 by default. This
82 * configuration value can be used to set it to the new version (2).
87 * ap_scan - AP scanning/selection
89 * By default, wpa_supplicant requests driver to perform AP
90 * scanning and then uses the scan results to select a
91 * suitable AP. Another alternative is to allow the driver to
92 * take care of AP scanning and selection and use
93 * wpa_supplicant just to process EAPOL frames based on IEEE
94 * 802.11 association information from the driver.
96 * 1: wpa_supplicant initiates scanning and AP selection (default).
98 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
99 * association parameters (e.g., WPA IE generation); this mode can
100 * also be used with non-WPA drivers when using IEEE 802.1X mode;
101 * do not try to associate with APs (i.e., external program needs
102 * to control association). This mode must also be used when using
103 * wired Ethernet drivers.
105 * 2: like 0, but associate with APs using security policy and SSID
106 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
107 * drivers to enable operation with hidden SSIDs and optimized roaming;
108 * in this mode, the network blocks in the configuration are tried
109 * one by one until the driver reports successful association; each
110 * network block should have explicit security policy (i.e., only one
111 * option in the lists) for key_mgmt, pairwise, group, proto variables.
116 * ctrl_interface - Parameters for the control interface
118 * If this is specified, %wpa_supplicant will open a control interface
119 * that is available for external programs to manage %wpa_supplicant.
120 * The meaning of this string depends on which control interface
121 * mechanism is used. For all cases, the existence of this parameter
122 * in configuration is used to determine whether the control interface
125 * For UNIX domain sockets (default on Linux and BSD): This is a
126 * directory that will be created for UNIX domain sockets for listening
127 * to requests from external programs (CLI/GUI, etc.) for status
128 * information and configuration. The socket file will be named based
129 * on the interface name, so multiple %wpa_supplicant processes can be
130 * run at the same time if more than one interface is used.
131 * /var/run/wpa_supplicant is the recommended directory for sockets and
132 * by default, wpa_cli will use it when trying to connect with
135 * Access control for the control interface can be configured
136 * by setting the directory to allow only members of a group
137 * to use sockets. This way, it is possible to run
138 * %wpa_supplicant as root (since it needs to change network
139 * configuration and open raw sockets) and still allow GUI/CLI
140 * components to be run as non-root users. However, since the
141 * control interface can be used to change the network
142 * configuration, this access needs to be protected in many
143 * cases. By default, %wpa_supplicant is configured to use gid
144 * 0 (root). If you want to allow non-root users to use the
145 * control interface, add a new group and change this value to
146 * match with that group. Add users that should have control
147 * interface access to this group.
149 * When configuring both the directory and group, use following format:
150 * DIR=/var/run/wpa_supplicant GROUP=wheel
151 * DIR=/var/run/wpa_supplicant GROUP=0
152 * (group can be either group name or gid)
154 * For UDP connections (default on Windows): The value will be ignored.
155 * This variable is just used to select that the control interface is
156 * to be created. The value can be set to, e.g., udp
157 * (ctrl_interface=udp).
159 * For Windows Named Pipe: This value can be used to set the security
160 * descriptor for controlling access to the control interface. Security
161 * descriptor can be set using Security Descriptor String Format (see
162 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
163 * The descriptor string needs to be prefixed with SDDL=. For example,
164 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
167 char *ctrl_interface;
170 * ctrl_interface_group - Control interface group (DEPRECATED)
172 * This variable is only used for backwards compatibility. Group for
173 * UNIX domain sockets should now be specified using GROUP=group in
174 * ctrl_interface variable.
176 char *ctrl_interface_group;
179 * fast_reauth - EAP fast re-authentication (session resumption)
181 * By default, fast re-authentication is enabled for all EAP methods
182 * that support it. This variable can be used to disable fast
183 * re-authentication (by setting fast_reauth=0). Normally, there is no
184 * need to disable fast re-authentication.
189 * opensc_engine_path - Path to the OpenSSL engine for opensc
191 * This is an OpenSSL specific configuration option for loading OpenSC
192 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
194 char *opensc_engine_path;
197 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
199 * This is an OpenSSL specific configuration option for loading PKCS#11
200 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
202 char *pkcs11_engine_path;
205 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
207 * This is an OpenSSL specific configuration option for configuring
208 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
209 * module is not loaded.
211 char *pkcs11_module_path;
214 * driver_param - Driver interface parameters
216 * This text string is passed to the selected driver interface with the
217 * optional struct wpa_driver_ops::set_param() handler. This can be
218 * used to configure driver specific options without having to add new
219 * driver interface functionality.
224 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
226 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
227 * cache (unit: seconds).
229 unsigned int dot11RSNAConfigPMKLifetime;
232 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
234 * dot11 MIB variable for the percentage of the PMK lifetime
235 * that should expire before an IEEE 802.1X reauthentication occurs.
237 unsigned int dot11RSNAConfigPMKReauthThreshold;
240 * dot11RSNAConfigSATimeout - Security association timeout
242 * dot11 MIB variable for the maximum time a security association
243 * shall take to set up (unit: seconds).
245 unsigned int dot11RSNAConfigSATimeout;
248 * update_config - Is wpa_supplicant allowed to update configuration
250 * This variable control whether wpa_supplicant is allow to re-write
251 * its configuration with wpa_config_write(). If this is zero,
252 * configuration data is only changed in memory and the external data
253 * is not overriden. If this is non-zero, wpa_supplicant will update
254 * the configuration data (e.g., a file) whenever configuration is
255 * changed. This update may replace the old configuration which can
256 * remove comments from it in case of a text file configuration.
261 * blobs - Configuration blobs
263 struct wpa_config_blob *blobs;
266 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
271 * device_name - Device Name (WPS)
272 * User-friendly description of device; up to 32 octets encoded in
278 * manufacturer - Manufacturer (WPS)
279 * The manufacturer of the device (up to 64 ASCII characters)
284 * model_name - Model Name (WPS)
285 * Model of the device (up to 32 ASCII characters)
290 * model_number - Model Number (WPS)
291 * Additional device description (up to 32 ASCII characters)
296 * serial_number - Serial Number (WPS)
297 * Serial number of the device (up to 32 characters)
302 * device_type - Primary Device Type (WPS)
304 u8 device_type[WPS_DEV_TYPE_LEN];
307 * config_methods - Config Methods
309 * This is a space-separated list of supported WPS configuration
310 * methods. For example, "label virtual_display virtual_push_button
312 * Available methods: usba ethernet label display ext_nfc_token
313 * int_nfc_token nfc_interface push_button keypad
314 * virtual_display physical_display
315 * virtual_push_button physical_push_button.
317 char *config_methods;
320 * os_version - OS Version (WPS)
321 * 4-octet operating system version number
326 * country - Country code
328 * This is the ISO/IEC alpha2 country code for which we are operating
334 * wps_cred_processing - Credential processing
336 * 0 = process received credentials internally
337 * 1 = do not process received credentials; just pass them over
338 * ctrl_iface to external program(s)
339 * 2 = process received credentials internally and pass them over
340 * ctrl_iface to external program(s)
342 int wps_cred_processing;
344 #define MAX_SEC_DEVICE_TYPES 5
346 * sec_device_types - Secondary Device Types (P2P)
348 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
349 int num_sec_device_types;
351 int p2p_listen_reg_class;
352 int p2p_listen_channel;
353 int p2p_oper_reg_class;
354 int p2p_oper_channel;
356 char *p2p_ssid_postfix;
357 int persistent_reconnect;
360 #define MAX_WPS_VENDOR_EXT 10
362 * wps_vendor_ext - Vendor extension attributes in WPS
364 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
367 * p2p_group_idle - Maximum idle time in seconds for P2P group
369 * This value controls how long a P2P group is maintained after there
370 * is no other members in the group. As a GO, this means no associated
371 * stations in the group. As a P2P client, this means no GO seen in
372 * scan results. The maximum idle time is specified in seconds with 0
373 * indicating no time limit, i.e., the P2P group remains in active
374 * state indefinitely until explicitly removed. As a P2P client, the
375 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
376 * this parameter is mainly meant for GO use and for P2P client, it can
377 * only be used to reduce the default timeout to smaller value.
379 unsigned int p2p_group_idle;
382 * bss_max_count - Maximum number of BSS entries to keep in memory
384 unsigned int bss_max_count;
387 * bss_expiration_age - BSS entry age after which it can be expired
389 * This value controls the time in seconds after which a BSS entry
390 * gets removed if it has not been updated or is not in use.
392 unsigned int bss_expiration_age;
395 * bss_expiration_scan_count - Expire BSS after number of scans
397 * If the BSS entry has not been seen in this many scans, it will be
398 * removed. A value of 1 means that entry is removed after the first
399 * scan in which the BSSID is not seen. Larger values can be used
400 * to avoid BSS entries disappearing if they are not visible in
401 * every scan (e.g., low signal quality or interference).
403 unsigned int bss_expiration_scan_count;
406 * filter_ssids - SSID-based scan result filtering
408 * 0 = do not filter scan results
409 * 1 = only include configured SSIDs in scan results/BSS table
414 * max_num_sta - Maximum number of STAs in an AP/P2P GO
416 unsigned int max_num_sta;
419 * changed_parameters - Bitmap of changed parameters since last update
421 unsigned int changed_parameters;
424 * disassoc_low_ack - Disassocicate stations with massive packet loss
426 int disassoc_low_ack;
429 * interworking - Whether Interworking (IEEE 802.11u) is enabled
434 * access_network_type - Access Network Type
436 * When Interworking is enabled, scans will be limited to APs that
437 * advertise the specified Access Network Type (0..15; with 15
438 * indicating wildcard match).
440 int access_network_type;
443 * hessid - Homogenous ESS identifier
445 * If this is set (any octet is non-zero), scans will be used to
446 * request response only from BSSes belonging to the specified
447 * Homogeneous ESS. This is used only if interworking is enabled.
452 * home_realm - Home Realm for Interworking
457 * home_username - Username for Interworking network selection
462 * home_password - Password for Interworking network selection
467 * home_ca_cert - CA certificate for Interworking network selection
472 * home_imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
477 * home_milenage - Milenage parameters for SIM/USIM simulator in
478 * <Ki>:<OPc>:<SQN> format
484 /* Prototypes for common functions from config.c */
486 void wpa_config_free(struct wpa_config *ssid);
487 void wpa_config_free_ssid(struct wpa_ssid *ssid);
488 void wpa_config_foreach_network(struct wpa_config *config,
489 void (*func)(void *, struct wpa_ssid *),
491 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
492 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
493 int wpa_config_remove_network(struct wpa_config *config, int id);
494 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
495 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
497 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
499 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
500 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
501 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
502 void wpa_config_update_psk(struct wpa_ssid *ssid);
503 int wpa_config_add_prio_network(struct wpa_config *config,
504 struct wpa_ssid *ssid);
505 int wpa_config_update_prio_list(struct wpa_config *config);
506 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
508 void wpa_config_set_blob(struct wpa_config *config,
509 struct wpa_config_blob *blob);
510 void wpa_config_free_blob(struct wpa_config_blob *blob);
511 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
513 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
514 const char *driver_param);
515 #ifndef CONFIG_NO_STDOUT_DEBUG
516 void wpa_config_debug_dump_networks(struct wpa_config *config);
517 #else /* CONFIG_NO_STDOUT_DEBUG */
518 #define wpa_config_debug_dump_networks(c) do { } while (0)
519 #endif /* CONFIG_NO_STDOUT_DEBUG */
522 /* Prototypes for common functions from config.c */
523 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
526 /* Prototypes for backend specific functions from the selected config_*.c */
529 * wpa_config_read - Read and parse configuration database
530 * @name: Name of the configuration (e.g., path and file name for the
531 * configuration file)
532 * Returns: Pointer to allocated configuration data or %NULL on failure
534 * This function reads configuration data, parses its contents, and allocates
535 * data structures needed for storing configuration information. The allocated
536 * data can be freed with wpa_config_free().
538 * Each configuration backend needs to implement this function.
540 struct wpa_config * wpa_config_read(const char *name);
543 * wpa_config_write - Write or update configuration data
544 * @name: Name of the configuration (e.g., path and file name for the
545 * configuration file)
546 * @config: Configuration data from wpa_config_read()
547 * Returns: 0 on success, -1 on failure
549 * This function write all configuration data into an external database (e.g.,
550 * a text file) in a format that can be read with wpa_config_read(). This can
551 * be used to allow wpa_supplicant to update its configuration, e.g., when a
552 * new network is added or a password is changed.
554 * Each configuration backend needs to implement this function.
556 int wpa_config_write(const char *name, struct wpa_config *config);
558 #endif /* CONFIG_H */