2 * WPA Supplicant / Configuration file structures
3 * Copyright (c) 2003-2012, 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"
33 * next - Next credential in the list
35 * This pointer can be used to iterate over all credentials. The head
36 * of this list is stored in the cred field of struct wpa_config.
38 struct wpa_cred *next;
41 * id - Unique id for the credential
43 * This identifier is used as a unique identifier for each credential
44 * block when using the control interface. Each credential is allocated
45 * an id when it is being created, either when reading the
46 * configuration file or when a new credential is added through the
52 * priority - Priority group
54 * By default, all networks and credentials get the same priority group
55 * (0). This field can be used to give higher priority for credentials
56 * (and similarly in struct wpa_ssid for network blocks) to change the
57 * Interworking automatic networking selection behavior. The matching
58 * network (based on either an enabled network block or a credential)
59 * with the highest priority value will be selected.
64 * pcsc - Use PC/SC and SIM/USIM card
69 * realm - Home Realm for Interworking
74 * username - Username for Interworking network selection
79 * password - Password for Interworking network selection
84 * ca_cert - CA certificate for Interworking network selection
89 * client_cert - File path to client certificate file (PEM/DER)
91 * This field is used with Interworking networking selection for a case
92 * where client certificate/private key is used for authentication
93 * (EAP-TLS). Full path to the file should be used since working
94 * directory may change when wpa_supplicant is run in the background.
96 * Alternatively, a named configuration blob can be used by setting
97 * this to blob://blob_name.
102 * private_key - File path to client private key file (PEM/DER/PFX)
104 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
105 * commented out. Both the private key and certificate will be read
106 * from the PKCS#12 file in this case. Full path to the file should be
107 * used since working directory may change when wpa_supplicant is run
110 * Windows certificate store can be used by leaving client_cert out and
111 * configuring private_key in one of the following formats:
113 * cert://substring_to_match
115 * hash://certificate_thumbprint_in_hex
117 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
119 * Note that when running wpa_supplicant as an application, the user
120 * certificate store (My user account) is used, whereas computer store
121 * (Computer account) is used when running wpasvc as a service.
123 * Alternatively, a named configuration blob can be used by setting
124 * this to blob://blob_name.
129 * private_key_passwd - Password for private key file
131 char *private_key_passwd;
134 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
139 * milenage - Milenage parameters for SIM/USIM simulator in
140 * <Ki>:<OPc>:<SQN> format
145 * domain - Home service provider FQDN
147 * This is used to compare against the Domain Name List to figure out
148 * whether the AP is operated by the Home SP.
154 #define CFG_CHANGED_DEVICE_NAME BIT(0)
155 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
156 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
157 #define CFG_CHANGED_OS_VERSION BIT(3)
158 #define CFG_CHANGED_UUID BIT(4)
159 #define CFG_CHANGED_COUNTRY BIT(5)
160 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
161 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
162 #define CFG_CHANGED_WPS_STRING BIT(8)
163 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
164 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
165 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
166 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
169 * struct wpa_config - wpa_supplicant configuration data
171 * This data structure is presents the per-interface (radio) configuration
172 * data. In many cases, there is only one struct wpa_config instance, but if
173 * more than one network interface is being controlled, one instance is used
178 * ssid - Head of the global network list
180 * This is the head for the list of all the configured networks.
182 struct wpa_ssid *ssid;
185 * pssid - Per-priority network lists (in priority order)
187 struct wpa_ssid **pssid;
190 * num_prio - Number of different priorities used in the pssid lists
192 * This indicates how many per-priority network lists are included in
198 * cred - Head of the credential list
200 * This is the head for the list of all the configured credentials.
202 struct wpa_cred *cred;
205 * eapol_version - IEEE 802.1X/EAPOL version number
207 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
208 * defines EAPOL version 2. However, there are many APs that do not
209 * handle the new version number correctly (they seem to drop the
210 * frames completely). In order to make wpa_supplicant interoperate
211 * with these APs, the version number is set to 1 by default. This
212 * configuration value can be used to set it to the new version (2).
217 * ap_scan - AP scanning/selection
219 * By default, wpa_supplicant requests driver to perform AP
220 * scanning and then uses the scan results to select a
221 * suitable AP. Another alternative is to allow the driver to
222 * take care of AP scanning and selection and use
223 * wpa_supplicant just to process EAPOL frames based on IEEE
224 * 802.11 association information from the driver.
226 * 1: wpa_supplicant initiates scanning and AP selection (default).
228 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
229 * association parameters (e.g., WPA IE generation); this mode can
230 * also be used with non-WPA drivers when using IEEE 802.1X mode;
231 * do not try to associate with APs (i.e., external program needs
232 * to control association). This mode must also be used when using
233 * wired Ethernet drivers.
235 * 2: like 0, but associate with APs using security policy and SSID
236 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
237 * drivers to enable operation with hidden SSIDs and optimized roaming;
238 * in this mode, the network blocks in the configuration are tried
239 * one by one until the driver reports successful association; each
240 * network block should have explicit security policy (i.e., only one
241 * option in the lists) for key_mgmt, pairwise, group, proto variables.
246 * ctrl_interface - Parameters for the control interface
248 * If this is specified, %wpa_supplicant will open a control interface
249 * that is available for external programs to manage %wpa_supplicant.
250 * The meaning of this string depends on which control interface
251 * mechanism is used. For all cases, the existence of this parameter
252 * in configuration is used to determine whether the control interface
255 * For UNIX domain sockets (default on Linux and BSD): This is a
256 * directory that will be created for UNIX domain sockets for listening
257 * to requests from external programs (CLI/GUI, etc.) for status
258 * information and configuration. The socket file will be named based
259 * on the interface name, so multiple %wpa_supplicant processes can be
260 * run at the same time if more than one interface is used.
261 * /var/run/wpa_supplicant is the recommended directory for sockets and
262 * by default, wpa_cli will use it when trying to connect with
265 * Access control for the control interface can be configured
266 * by setting the directory to allow only members of a group
267 * to use sockets. This way, it is possible to run
268 * %wpa_supplicant as root (since it needs to change network
269 * configuration and open raw sockets) and still allow GUI/CLI
270 * components to be run as non-root users. However, since the
271 * control interface can be used to change the network
272 * configuration, this access needs to be protected in many
273 * cases. By default, %wpa_supplicant is configured to use gid
274 * 0 (root). If you want to allow non-root users to use the
275 * control interface, add a new group and change this value to
276 * match with that group. Add users that should have control
277 * interface access to this group.
279 * When configuring both the directory and group, use following format:
280 * DIR=/var/run/wpa_supplicant GROUP=wheel
281 * DIR=/var/run/wpa_supplicant GROUP=0
282 * (group can be either group name or gid)
284 * For UDP connections (default on Windows): The value will be ignored.
285 * This variable is just used to select that the control interface is
286 * to be created. The value can be set to, e.g., udp
287 * (ctrl_interface=udp).
289 * For Windows Named Pipe: This value can be used to set the security
290 * descriptor for controlling access to the control interface. Security
291 * descriptor can be set using Security Descriptor String Format (see
292 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
293 * The descriptor string needs to be prefixed with SDDL=. For example,
294 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
297 char *ctrl_interface;
300 * ctrl_interface_group - Control interface group (DEPRECATED)
302 * This variable is only used for backwards compatibility. Group for
303 * UNIX domain sockets should now be specified using GROUP=group in
304 * ctrl_interface variable.
306 char *ctrl_interface_group;
309 * fast_reauth - EAP fast re-authentication (session resumption)
311 * By default, fast re-authentication is enabled for all EAP methods
312 * that support it. This variable can be used to disable fast
313 * re-authentication (by setting fast_reauth=0). Normally, there is no
314 * need to disable fast re-authentication.
319 * opensc_engine_path - Path to the OpenSSL engine for opensc
321 * This is an OpenSSL specific configuration option for loading OpenSC
322 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
324 char *opensc_engine_path;
327 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
329 * This is an OpenSSL specific configuration option for loading PKCS#11
330 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
332 char *pkcs11_engine_path;
335 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
337 * This is an OpenSSL specific configuration option for configuring
338 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
339 * module is not loaded.
341 char *pkcs11_module_path;
344 * pcsc_reader - PC/SC reader name prefix
346 * If not %NULL, PC/SC reader with a name that matches this prefix is
347 * initialized for SIM/USIM access. Empty string can be used to match
348 * the first available reader.
353 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
355 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
356 * EAP-AKA. If left out, this will be asked through control interface.
361 * driver_param - Driver interface parameters
363 * This text string is passed to the selected driver interface with the
364 * optional struct wpa_driver_ops::set_param() handler. This can be
365 * used to configure driver specific options without having to add new
366 * driver interface functionality.
371 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
373 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
374 * cache (unit: seconds).
376 unsigned int dot11RSNAConfigPMKLifetime;
379 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
381 * dot11 MIB variable for the percentage of the PMK lifetime
382 * that should expire before an IEEE 802.1X reauthentication occurs.
384 unsigned int dot11RSNAConfigPMKReauthThreshold;
387 * dot11RSNAConfigSATimeout - Security association timeout
389 * dot11 MIB variable for the maximum time a security association
390 * shall take to set up (unit: seconds).
392 unsigned int dot11RSNAConfigSATimeout;
395 * update_config - Is wpa_supplicant allowed to update configuration
397 * This variable control whether wpa_supplicant is allow to re-write
398 * its configuration with wpa_config_write(). If this is zero,
399 * configuration data is only changed in memory and the external data
400 * is not overriden. If this is non-zero, wpa_supplicant will update
401 * the configuration data (e.g., a file) whenever configuration is
402 * changed. This update may replace the old configuration which can
403 * remove comments from it in case of a text file configuration.
408 * blobs - Configuration blobs
410 struct wpa_config_blob *blobs;
413 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
418 * device_name - Device Name (WPS)
419 * User-friendly description of device; up to 32 octets encoded in
425 * manufacturer - Manufacturer (WPS)
426 * The manufacturer of the device (up to 64 ASCII characters)
431 * model_name - Model Name (WPS)
432 * Model of the device (up to 32 ASCII characters)
437 * model_number - Model Number (WPS)
438 * Additional device description (up to 32 ASCII characters)
443 * serial_number - Serial Number (WPS)
444 * Serial number of the device (up to 32 characters)
449 * device_type - Primary Device Type (WPS)
451 u8 device_type[WPS_DEV_TYPE_LEN];
454 * config_methods - Config Methods
456 * This is a space-separated list of supported WPS configuration
457 * methods. For example, "label virtual_display virtual_push_button
459 * Available methods: usba ethernet label display ext_nfc_token
460 * int_nfc_token nfc_interface push_button keypad
461 * virtual_display physical_display
462 * virtual_push_button physical_push_button.
464 char *config_methods;
467 * os_version - OS Version (WPS)
468 * 4-octet operating system version number
473 * country - Country code
475 * This is the ISO/IEC alpha2 country code for which we are operating
481 * wps_cred_processing - Credential processing
483 * 0 = process received credentials internally
484 * 1 = do not process received credentials; just pass them over
485 * ctrl_iface to external program(s)
486 * 2 = process received credentials internally and pass them over
487 * ctrl_iface to external program(s)
489 int wps_cred_processing;
491 #define MAX_SEC_DEVICE_TYPES 5
493 * sec_device_types - Secondary Device Types (P2P)
495 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
496 int num_sec_device_types;
498 int p2p_listen_reg_class;
499 int p2p_listen_channel;
500 int p2p_oper_reg_class;
501 int p2p_oper_channel;
503 char *p2p_ssid_postfix;
504 int persistent_reconnect;
507 #define MAX_WPS_VENDOR_EXT 10
509 * wps_vendor_ext - Vendor extension attributes in WPS
511 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
514 * p2p_group_idle - Maximum idle time in seconds for P2P group
516 * This value controls how long a P2P group is maintained after there
517 * is no other members in the group. As a GO, this means no associated
518 * stations in the group. As a P2P client, this means no GO seen in
519 * scan results. The maximum idle time is specified in seconds with 0
520 * indicating no time limit, i.e., the P2P group remains in active
521 * state indefinitely until explicitly removed. As a P2P client, the
522 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
523 * this parameter is mainly meant for GO use and for P2P client, it can
524 * only be used to reduce the default timeout to smaller value.
526 unsigned int p2p_group_idle;
529 * bss_max_count - Maximum number of BSS entries to keep in memory
531 unsigned int bss_max_count;
534 * bss_expiration_age - BSS entry age after which it can be expired
536 * This value controls the time in seconds after which a BSS entry
537 * gets removed if it has not been updated or is not in use.
539 unsigned int bss_expiration_age;
542 * bss_expiration_scan_count - Expire BSS after number of scans
544 * If the BSS entry has not been seen in this many scans, it will be
545 * removed. A value of 1 means that entry is removed after the first
546 * scan in which the BSSID is not seen. Larger values can be used
547 * to avoid BSS entries disappearing if they are not visible in
548 * every scan (e.g., low signal quality or interference).
550 unsigned int bss_expiration_scan_count;
553 * filter_ssids - SSID-based scan result filtering
555 * 0 = do not filter scan results
556 * 1 = only include configured SSIDs in scan results/BSS table
561 * max_num_sta - Maximum number of STAs in an AP/P2P GO
563 unsigned int max_num_sta;
566 * changed_parameters - Bitmap of changed parameters since last update
568 unsigned int changed_parameters;
571 * disassoc_low_ack - Disassocicate stations with massive packet loss
573 int disassoc_low_ack;
576 * interworking - Whether Interworking (IEEE 802.11u) is enabled
581 * access_network_type - Access Network Type
583 * When Interworking is enabled, scans will be limited to APs that
584 * advertise the specified Access Network Type (0..15; with 15
585 * indicating wildcard match).
587 int access_network_type;
590 * hessid - Homogenous ESS identifier
592 * If this is set (any octet is non-zero), scans will be used to
593 * request response only from BSSes belonging to the specified
594 * Homogeneous ESS. This is used only if interworking is enabled.
600 /* Prototypes for common functions from config.c */
602 void wpa_config_free(struct wpa_config *ssid);
603 void wpa_config_free_ssid(struct wpa_ssid *ssid);
604 void wpa_config_foreach_network(struct wpa_config *config,
605 void (*func)(void *, struct wpa_ssid *),
607 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
608 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
609 int wpa_config_remove_network(struct wpa_config *config, int id);
610 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
611 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
613 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
615 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
616 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
617 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
618 void wpa_config_update_psk(struct wpa_ssid *ssid);
619 int wpa_config_add_prio_network(struct wpa_config *config,
620 struct wpa_ssid *ssid);
621 int wpa_config_update_prio_list(struct wpa_config *config);
622 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
624 void wpa_config_set_blob(struct wpa_config *config,
625 struct wpa_config_blob *blob);
626 void wpa_config_free_blob(struct wpa_config_blob *blob);
627 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
629 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
630 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
631 int wpa_config_remove_cred(struct wpa_config *config, int id);
632 void wpa_config_free_cred(struct wpa_cred *cred);
633 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
634 const char *value, int line);
636 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
637 const char *driver_param);
638 #ifndef CONFIG_NO_STDOUT_DEBUG
639 void wpa_config_debug_dump_networks(struct wpa_config *config);
640 #else /* CONFIG_NO_STDOUT_DEBUG */
641 #define wpa_config_debug_dump_networks(c) do { } while (0)
642 #endif /* CONFIG_NO_STDOUT_DEBUG */
645 /* Prototypes for common functions from config.c */
646 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
649 /* Prototypes for backend specific functions from the selected config_*.c */
652 * wpa_config_read - Read and parse configuration database
653 * @name: Name of the configuration (e.g., path and file name for the
654 * configuration file)
655 * Returns: Pointer to allocated configuration data or %NULL on failure
657 * This function reads configuration data, parses its contents, and allocates
658 * data structures needed for storing configuration information. The allocated
659 * data can be freed with wpa_config_free().
661 * Each configuration backend needs to implement this function.
663 struct wpa_config * wpa_config_read(const char *name);
666 * wpa_config_write - Write or update configuration data
667 * @name: Name of the configuration (e.g., path and file name for the
668 * configuration file)
669 * @config: Configuration data from wpa_config_read()
670 * Returns: 0 on success, -1 on failure
672 * This function write all configuration data into an external database (e.g.,
673 * a text file) in a format that can be read with wpa_config_read(). This can
674 * be used to allow wpa_supplicant to update its configuration, e.g., when a
675 * new network is added or a password is changed.
677 * Each configuration backend needs to implement this function.
679 int wpa_config_write(const char *name, struct wpa_config *config);
681 #endif /* CONFIG_H */