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.
153 * roaming_consortium - Roaming Consortium OI
155 * If roaming_consortium_len is non-zero, this field contains the
156 * Roaming Consortium OI that can be used to determine which access
157 * points support authentication with this credential. This is an
158 * alternative to the use of the realm parameter. When using Roaming
159 * Consortium to match the network, the EAP parameters need to be
160 * pre-configured with the credential since the NAI Realm information
161 * may not be available or fetched.
163 u8 roaming_consortium[15];
166 * roaming_consortium_len - Length of roaming_consortium
168 size_t roaming_consortium_len;
171 * eap_method - EAP method to use
173 * Pre-configured EAP method to use with this credential or %NULL to
174 * indicate no EAP method is selected, i.e., the method will be
175 * selected automatically based on ANQP information.
177 struct eap_method_type *eap_method;
180 * phase1 - Phase 1 (outer authentication) parameters
182 * Pre-configured EAP parameters or %NULL.
187 * phase2 - Phase 2 (inner authentication) parameters
189 * Pre-configured EAP parameters or %NULL.
195 #define CFG_CHANGED_DEVICE_NAME BIT(0)
196 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
197 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
198 #define CFG_CHANGED_OS_VERSION BIT(3)
199 #define CFG_CHANGED_UUID BIT(4)
200 #define CFG_CHANGED_COUNTRY BIT(5)
201 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
202 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
203 #define CFG_CHANGED_WPS_STRING BIT(8)
204 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
205 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
206 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
207 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
208 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
209 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
212 * struct wpa_config - wpa_supplicant configuration data
214 * This data structure is presents the per-interface (radio) configuration
215 * data. In many cases, there is only one struct wpa_config instance, but if
216 * more than one network interface is being controlled, one instance is used
221 * ssid - Head of the global network list
223 * This is the head for the list of all the configured networks.
225 struct wpa_ssid *ssid;
228 * pssid - Per-priority network lists (in priority order)
230 struct wpa_ssid **pssid;
233 * num_prio - Number of different priorities used in the pssid lists
235 * This indicates how many per-priority network lists are included in
241 * cred - Head of the credential list
243 * This is the head for the list of all the configured credentials.
245 struct wpa_cred *cred;
248 * eapol_version - IEEE 802.1X/EAPOL version number
250 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
251 * defines EAPOL version 2. However, there are many APs that do not
252 * handle the new version number correctly (they seem to drop the
253 * frames completely). In order to make wpa_supplicant interoperate
254 * with these APs, the version number is set to 1 by default. This
255 * configuration value can be used to set it to the new version (2).
260 * ap_scan - AP scanning/selection
262 * By default, wpa_supplicant requests driver to perform AP
263 * scanning and then uses the scan results to select a
264 * suitable AP. Another alternative is to allow the driver to
265 * take care of AP scanning and selection and use
266 * wpa_supplicant just to process EAPOL frames based on IEEE
267 * 802.11 association information from the driver.
269 * 1: wpa_supplicant initiates scanning and AP selection (default).
271 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
272 * association parameters (e.g., WPA IE generation); this mode can
273 * also be used with non-WPA drivers when using IEEE 802.1X mode;
274 * do not try to associate with APs (i.e., external program needs
275 * to control association). This mode must also be used when using
276 * wired Ethernet drivers.
278 * 2: like 0, but associate with APs using security policy and SSID
279 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
280 * drivers to enable operation with hidden SSIDs and optimized roaming;
281 * in this mode, the network blocks in the configuration are tried
282 * one by one until the driver reports successful association; each
283 * network block should have explicit security policy (i.e., only one
284 * option in the lists) for key_mgmt, pairwise, group, proto variables.
289 * disable_scan_offload - Disable automatic offloading of scan requests
291 * By default, %wpa_supplicant tries to offload scanning if the driver
292 * indicates support for this (sched_scan). This configuration
293 * parameter can be used to disable this offloading mechanism.
295 int disable_scan_offload;
298 * ctrl_interface - Parameters for the control interface
300 * If this is specified, %wpa_supplicant will open a control interface
301 * that is available for external programs to manage %wpa_supplicant.
302 * The meaning of this string depends on which control interface
303 * mechanism is used. For all cases, the existence of this parameter
304 * in configuration is used to determine whether the control interface
307 * For UNIX domain sockets (default on Linux and BSD): This is a
308 * directory that will be created for UNIX domain sockets for listening
309 * to requests from external programs (CLI/GUI, etc.) for status
310 * information and configuration. The socket file will be named based
311 * on the interface name, so multiple %wpa_supplicant processes can be
312 * run at the same time if more than one interface is used.
313 * /var/run/wpa_supplicant is the recommended directory for sockets and
314 * by default, wpa_cli will use it when trying to connect with
317 * Access control for the control interface can be configured
318 * by setting the directory to allow only members of a group
319 * to use sockets. This way, it is possible to run
320 * %wpa_supplicant as root (since it needs to change network
321 * configuration and open raw sockets) and still allow GUI/CLI
322 * components to be run as non-root users. However, since the
323 * control interface can be used to change the network
324 * configuration, this access needs to be protected in many
325 * cases. By default, %wpa_supplicant is configured to use gid
326 * 0 (root). If you want to allow non-root users to use the
327 * control interface, add a new group and change this value to
328 * match with that group. Add users that should have control
329 * interface access to this group.
331 * When configuring both the directory and group, use following format:
332 * DIR=/var/run/wpa_supplicant GROUP=wheel
333 * DIR=/var/run/wpa_supplicant GROUP=0
334 * (group can be either group name or gid)
336 * For UDP connections (default on Windows): The value will be ignored.
337 * This variable is just used to select that the control interface is
338 * to be created. The value can be set to, e.g., udp
339 * (ctrl_interface=udp).
341 * For Windows Named Pipe: This value can be used to set the security
342 * descriptor for controlling access to the control interface. Security
343 * descriptor can be set using Security Descriptor String Format (see
344 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
345 * The descriptor string needs to be prefixed with SDDL=. For example,
346 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
349 char *ctrl_interface;
352 * ctrl_interface_group - Control interface group (DEPRECATED)
354 * This variable is only used for backwards compatibility. Group for
355 * UNIX domain sockets should now be specified using GROUP=group in
356 * ctrl_interface variable.
358 char *ctrl_interface_group;
361 * fast_reauth - EAP fast re-authentication (session resumption)
363 * By default, fast re-authentication is enabled for all EAP methods
364 * that support it. This variable can be used to disable fast
365 * re-authentication (by setting fast_reauth=0). Normally, there is no
366 * need to disable fast re-authentication.
371 * opensc_engine_path - Path to the OpenSSL engine for opensc
373 * This is an OpenSSL specific configuration option for loading OpenSC
374 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
376 char *opensc_engine_path;
379 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
381 * This is an OpenSSL specific configuration option for loading PKCS#11
382 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
384 char *pkcs11_engine_path;
387 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
389 * This is an OpenSSL specific configuration option for configuring
390 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
391 * module is not loaded.
393 char *pkcs11_module_path;
396 * pcsc_reader - PC/SC reader name prefix
398 * If not %NULL, PC/SC reader with a name that matches this prefix is
399 * initialized for SIM/USIM access. Empty string can be used to match
400 * the first available reader.
405 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
407 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
408 * EAP-AKA. If left out, this will be asked through control interface.
413 * driver_param - Driver interface parameters
415 * This text string is passed to the selected driver interface with the
416 * optional struct wpa_driver_ops::set_param() handler. This can be
417 * used to configure driver specific options without having to add new
418 * driver interface functionality.
423 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
425 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
426 * cache (unit: seconds).
428 unsigned int dot11RSNAConfigPMKLifetime;
431 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
433 * dot11 MIB variable for the percentage of the PMK lifetime
434 * that should expire before an IEEE 802.1X reauthentication occurs.
436 unsigned int dot11RSNAConfigPMKReauthThreshold;
439 * dot11RSNAConfigSATimeout - Security association timeout
441 * dot11 MIB variable for the maximum time a security association
442 * shall take to set up (unit: seconds).
444 unsigned int dot11RSNAConfigSATimeout;
447 * update_config - Is wpa_supplicant allowed to update configuration
449 * This variable control whether wpa_supplicant is allow to re-write
450 * its configuration with wpa_config_write(). If this is zero,
451 * configuration data is only changed in memory and the external data
452 * is not overriden. If this is non-zero, wpa_supplicant will update
453 * the configuration data (e.g., a file) whenever configuration is
454 * changed. This update may replace the old configuration which can
455 * remove comments from it in case of a text file configuration.
460 * blobs - Configuration blobs
462 struct wpa_config_blob *blobs;
465 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
470 * device_name - Device Name (WPS)
471 * User-friendly description of device; up to 32 octets encoded in
477 * manufacturer - Manufacturer (WPS)
478 * The manufacturer of the device (up to 64 ASCII characters)
483 * model_name - Model Name (WPS)
484 * Model of the device (up to 32 ASCII characters)
489 * model_number - Model Number (WPS)
490 * Additional device description (up to 32 ASCII characters)
495 * serial_number - Serial Number (WPS)
496 * Serial number of the device (up to 32 characters)
501 * device_type - Primary Device Type (WPS)
503 u8 device_type[WPS_DEV_TYPE_LEN];
506 * config_methods - Config Methods
508 * This is a space-separated list of supported WPS configuration
509 * methods. For example, "label virtual_display virtual_push_button
511 * Available methods: usba ethernet label display ext_nfc_token
512 * int_nfc_token nfc_interface push_button keypad
513 * virtual_display physical_display
514 * virtual_push_button physical_push_button.
516 char *config_methods;
519 * os_version - OS Version (WPS)
520 * 4-octet operating system version number
525 * country - Country code
527 * This is the ISO/IEC alpha2 country code for which we are operating
533 * wps_cred_processing - Credential processing
535 * 0 = process received credentials internally
536 * 1 = do not process received credentials; just pass them over
537 * ctrl_iface to external program(s)
538 * 2 = process received credentials internally and pass them over
539 * ctrl_iface to external program(s)
541 int wps_cred_processing;
543 #define MAX_SEC_DEVICE_TYPES 5
545 * sec_device_types - Secondary Device Types (P2P)
547 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
548 int num_sec_device_types;
550 int p2p_listen_reg_class;
551 int p2p_listen_channel;
552 int p2p_oper_reg_class;
553 int p2p_oper_channel;
555 char *p2p_ssid_postfix;
556 int persistent_reconnect;
558 unsigned int num_p2p_pref_chan;
559 struct p2p_channel *p2p_pref_chan;
561 struct wpabuf *wps_vendor_ext_m1;
563 #define MAX_WPS_VENDOR_EXT 10
565 * wps_vendor_ext - Vendor extension attributes in WPS
567 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
570 * p2p_group_idle - Maximum idle time in seconds for P2P group
572 * This value controls how long a P2P group is maintained after there
573 * is no other members in the group. As a GO, this means no associated
574 * stations in the group. As a P2P client, this means no GO seen in
575 * scan results. The maximum idle time is specified in seconds with 0
576 * indicating no time limit, i.e., the P2P group remains in active
577 * state indefinitely until explicitly removed. As a P2P client, the
578 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
579 * this parameter is mainly meant for GO use and for P2P client, it can
580 * only be used to reduce the default timeout to smaller value. A
581 * special value -1 can be used to configure immediate removal of the
582 * group for P2P client role on any disconnection after the data
583 * connection has been established.
588 * bss_max_count - Maximum number of BSS entries to keep in memory
590 unsigned int bss_max_count;
593 * bss_expiration_age - BSS entry age after which it can be expired
595 * This value controls the time in seconds after which a BSS entry
596 * gets removed if it has not been updated or is not in use.
598 unsigned int bss_expiration_age;
601 * bss_expiration_scan_count - Expire BSS after number of scans
603 * If the BSS entry has not been seen in this many scans, it will be
604 * removed. A value of 1 means that entry is removed after the first
605 * scan in which the BSSID is not seen. Larger values can be used
606 * to avoid BSS entries disappearing if they are not visible in
607 * every scan (e.g., low signal quality or interference).
609 unsigned int bss_expiration_scan_count;
612 * filter_ssids - SSID-based scan result filtering
614 * 0 = do not filter scan results
615 * 1 = only include configured SSIDs in scan results/BSS table
620 * filter_rssi - RSSI-based scan result filtering
622 * 0 = do not filter scan results
623 * -n = filter scan results below -n dBm
628 * max_num_sta - Maximum number of STAs in an AP/P2P GO
630 unsigned int max_num_sta;
633 * changed_parameters - Bitmap of changed parameters since last update
635 unsigned int changed_parameters;
638 * disassoc_low_ack - Disassocicate stations with massive packet loss
640 int disassoc_low_ack;
643 * interworking - Whether Interworking (IEEE 802.11u) is enabled
648 * access_network_type - Access Network Type
650 * When Interworking is enabled, scans will be limited to APs that
651 * advertise the specified Access Network Type (0..15; with 15
652 * indicating wildcard match).
654 int access_network_type;
657 * hessid - Homogenous ESS identifier
659 * If this is set (any octet is non-zero), scans will be used to
660 * request response only from BSSes belonging to the specified
661 * Homogeneous ESS. This is used only if interworking is enabled.
671 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
673 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
674 * by acting as a Registrar and using M1 from the AP. The config
675 * methods attribute in that message is supposed to indicate only the
676 * configuration method supported by the AP in Enrollee role, i.e., to
677 * add an external Registrar. For that case, PBC shall not be used and
678 * as such, the PushButton config method is removed from M1 by default.
679 * If pbc_in_m1=1 is included in the configuration file, the PushButton
680 * config method is left in M1 (if included in config_methods
681 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
682 * a label in the AP).
687 * autoscan - Automatic scan parameters or %NULL if none
689 * This is an optional set of parameters for automatic scanning
690 * within an interface in following format:
691 * <autoscan module name>:<module parameters>
696 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
698 int wps_nfc_dev_pw_id;
701 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
703 struct wpabuf *wps_nfc_dh_pubkey;
706 * wps_nfc_dh_pubkey - NFC DH Private Key for password token
708 struct wpabuf *wps_nfc_dh_privkey;
711 * wps_nfc_dh_pubkey - NFC Device Password for password token
713 struct wpabuf *wps_nfc_dev_pw;
716 * ext_password_backend - External password backend or %NULL if none
718 * format: <backend name>[:<optional backend parameters>]
720 char *ext_password_backend;
724 /* Prototypes for common functions from config.c */
726 void wpa_config_free(struct wpa_config *ssid);
727 void wpa_config_free_ssid(struct wpa_ssid *ssid);
728 void wpa_config_foreach_network(struct wpa_config *config,
729 void (*func)(void *, struct wpa_ssid *),
731 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
732 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
733 int wpa_config_remove_network(struct wpa_config *config, int id);
734 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
735 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
737 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
739 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
740 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
741 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
742 void wpa_config_update_psk(struct wpa_ssid *ssid);
743 int wpa_config_add_prio_network(struct wpa_config *config,
744 struct wpa_ssid *ssid);
745 int wpa_config_update_prio_list(struct wpa_config *config);
746 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
748 void wpa_config_set_blob(struct wpa_config *config,
749 struct wpa_config_blob *blob);
750 void wpa_config_free_blob(struct wpa_config_blob *blob);
751 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
753 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
754 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
755 int wpa_config_remove_cred(struct wpa_config *config, int id);
756 void wpa_config_free_cred(struct wpa_cred *cred);
757 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
758 const char *value, int line);
760 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
761 const char *driver_param);
762 #ifndef CONFIG_NO_STDOUT_DEBUG
763 void wpa_config_debug_dump_networks(struct wpa_config *config);
764 #else /* CONFIG_NO_STDOUT_DEBUG */
765 #define wpa_config_debug_dump_networks(c) do { } while (0)
766 #endif /* CONFIG_NO_STDOUT_DEBUG */
769 /* Prototypes for common functions from config.c */
770 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
773 /* Prototypes for backend specific functions from the selected config_*.c */
776 * wpa_config_read - Read and parse configuration database
777 * @name: Name of the configuration (e.g., path and file name for the
778 * configuration file)
779 * Returns: Pointer to allocated configuration data or %NULL on failure
781 * This function reads configuration data, parses its contents, and allocates
782 * data structures needed for storing configuration information. The allocated
783 * data can be freed with wpa_config_free().
785 * Each configuration backend needs to implement this function.
787 struct wpa_config * wpa_config_read(const char *name);
790 * wpa_config_write - Write or update configuration data
791 * @name: Name of the configuration (e.g., path and file name for the
792 * configuration file)
793 * @config: Configuration data from wpa_config_read()
794 * Returns: 0 on success, -1 on failure
796 * This function write all configuration data into an external database (e.g.,
797 * a text file) in a format that can be read with wpa_config_read(). This can
798 * be used to allow wpa_supplicant to update its configuration, e.g., when a
799 * new network is added or a password is changed.
801 * Each configuration backend needs to implement this function.
803 int wpa_config_write(const char *name, struct wpa_config *config);
805 #endif /* CONFIG_H */