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)
167 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
170 * struct wpa_config - wpa_supplicant configuration data
172 * This data structure is presents the per-interface (radio) configuration
173 * data. In many cases, there is only one struct wpa_config instance, but if
174 * more than one network interface is being controlled, one instance is used
179 * ssid - Head of the global network list
181 * This is the head for the list of all the configured networks.
183 struct wpa_ssid *ssid;
186 * pssid - Per-priority network lists (in priority order)
188 struct wpa_ssid **pssid;
191 * num_prio - Number of different priorities used in the pssid lists
193 * This indicates how many per-priority network lists are included in
199 * cred - Head of the credential list
201 * This is the head for the list of all the configured credentials.
203 struct wpa_cred *cred;
206 * eapol_version - IEEE 802.1X/EAPOL version number
208 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
209 * defines EAPOL version 2. However, there are many APs that do not
210 * handle the new version number correctly (they seem to drop the
211 * frames completely). In order to make wpa_supplicant interoperate
212 * with these APs, the version number is set to 1 by default. This
213 * configuration value can be used to set it to the new version (2).
218 * ap_scan - AP scanning/selection
220 * By default, wpa_supplicant requests driver to perform AP
221 * scanning and then uses the scan results to select a
222 * suitable AP. Another alternative is to allow the driver to
223 * take care of AP scanning and selection and use
224 * wpa_supplicant just to process EAPOL frames based on IEEE
225 * 802.11 association information from the driver.
227 * 1: wpa_supplicant initiates scanning and AP selection (default).
229 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
230 * association parameters (e.g., WPA IE generation); this mode can
231 * also be used with non-WPA drivers when using IEEE 802.1X mode;
232 * do not try to associate with APs (i.e., external program needs
233 * to control association). This mode must also be used when using
234 * wired Ethernet drivers.
236 * 2: like 0, but associate with APs using security policy and SSID
237 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
238 * drivers to enable operation with hidden SSIDs and optimized roaming;
239 * in this mode, the network blocks in the configuration are tried
240 * one by one until the driver reports successful association; each
241 * network block should have explicit security policy (i.e., only one
242 * option in the lists) for key_mgmt, pairwise, group, proto variables.
247 * disable_scan_offload - Disable automatic offloading of scan requests
249 * By default, %wpa_supplicant tries to offload scanning if the driver
250 * indicates support for this (sched_scan). This configuration
251 * parameter can be used to disable this offloading mechanism.
253 int disable_scan_offload;
256 * ctrl_interface - Parameters for the control interface
258 * If this is specified, %wpa_supplicant will open a control interface
259 * that is available for external programs to manage %wpa_supplicant.
260 * The meaning of this string depends on which control interface
261 * mechanism is used. For all cases, the existence of this parameter
262 * in configuration is used to determine whether the control interface
265 * For UNIX domain sockets (default on Linux and BSD): This is a
266 * directory that will be created for UNIX domain sockets for listening
267 * to requests from external programs (CLI/GUI, etc.) for status
268 * information and configuration. The socket file will be named based
269 * on the interface name, so multiple %wpa_supplicant processes can be
270 * run at the same time if more than one interface is used.
271 * /var/run/wpa_supplicant is the recommended directory for sockets and
272 * by default, wpa_cli will use it when trying to connect with
275 * Access control for the control interface can be configured
276 * by setting the directory to allow only members of a group
277 * to use sockets. This way, it is possible to run
278 * %wpa_supplicant as root (since it needs to change network
279 * configuration and open raw sockets) and still allow GUI/CLI
280 * components to be run as non-root users. However, since the
281 * control interface can be used to change the network
282 * configuration, this access needs to be protected in many
283 * cases. By default, %wpa_supplicant is configured to use gid
284 * 0 (root). If you want to allow non-root users to use the
285 * control interface, add a new group and change this value to
286 * match with that group. Add users that should have control
287 * interface access to this group.
289 * When configuring both the directory and group, use following format:
290 * DIR=/var/run/wpa_supplicant GROUP=wheel
291 * DIR=/var/run/wpa_supplicant GROUP=0
292 * (group can be either group name or gid)
294 * For UDP connections (default on Windows): The value will be ignored.
295 * This variable is just used to select that the control interface is
296 * to be created. The value can be set to, e.g., udp
297 * (ctrl_interface=udp).
299 * For Windows Named Pipe: This value can be used to set the security
300 * descriptor for controlling access to the control interface. Security
301 * descriptor can be set using Security Descriptor String Format (see
302 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
303 * The descriptor string needs to be prefixed with SDDL=. For example,
304 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
307 char *ctrl_interface;
310 * ctrl_interface_group - Control interface group (DEPRECATED)
312 * This variable is only used for backwards compatibility. Group for
313 * UNIX domain sockets should now be specified using GROUP=group in
314 * ctrl_interface variable.
316 char *ctrl_interface_group;
319 * fast_reauth - EAP fast re-authentication (session resumption)
321 * By default, fast re-authentication is enabled for all EAP methods
322 * that support it. This variable can be used to disable fast
323 * re-authentication (by setting fast_reauth=0). Normally, there is no
324 * need to disable fast re-authentication.
329 * opensc_engine_path - Path to the OpenSSL engine for opensc
331 * This is an OpenSSL specific configuration option for loading OpenSC
332 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
334 char *opensc_engine_path;
337 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
339 * This is an OpenSSL specific configuration option for loading PKCS#11
340 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
342 char *pkcs11_engine_path;
345 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
347 * This is an OpenSSL specific configuration option for configuring
348 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
349 * module is not loaded.
351 char *pkcs11_module_path;
354 * pcsc_reader - PC/SC reader name prefix
356 * If not %NULL, PC/SC reader with a name that matches this prefix is
357 * initialized for SIM/USIM access. Empty string can be used to match
358 * the first available reader.
363 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
365 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
366 * EAP-AKA. If left out, this will be asked through control interface.
371 * driver_param - Driver interface parameters
373 * This text string is passed to the selected driver interface with the
374 * optional struct wpa_driver_ops::set_param() handler. This can be
375 * used to configure driver specific options without having to add new
376 * driver interface functionality.
381 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
383 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
384 * cache (unit: seconds).
386 unsigned int dot11RSNAConfigPMKLifetime;
389 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
391 * dot11 MIB variable for the percentage of the PMK lifetime
392 * that should expire before an IEEE 802.1X reauthentication occurs.
394 unsigned int dot11RSNAConfigPMKReauthThreshold;
397 * dot11RSNAConfigSATimeout - Security association timeout
399 * dot11 MIB variable for the maximum time a security association
400 * shall take to set up (unit: seconds).
402 unsigned int dot11RSNAConfigSATimeout;
405 * update_config - Is wpa_supplicant allowed to update configuration
407 * This variable control whether wpa_supplicant is allow to re-write
408 * its configuration with wpa_config_write(). If this is zero,
409 * configuration data is only changed in memory and the external data
410 * is not overriden. If this is non-zero, wpa_supplicant will update
411 * the configuration data (e.g., a file) whenever configuration is
412 * changed. This update may replace the old configuration which can
413 * remove comments from it in case of a text file configuration.
418 * blobs - Configuration blobs
420 struct wpa_config_blob *blobs;
423 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
428 * device_name - Device Name (WPS)
429 * User-friendly description of device; up to 32 octets encoded in
435 * manufacturer - Manufacturer (WPS)
436 * The manufacturer of the device (up to 64 ASCII characters)
441 * model_name - Model Name (WPS)
442 * Model of the device (up to 32 ASCII characters)
447 * model_number - Model Number (WPS)
448 * Additional device description (up to 32 ASCII characters)
453 * serial_number - Serial Number (WPS)
454 * Serial number of the device (up to 32 characters)
459 * device_type - Primary Device Type (WPS)
461 u8 device_type[WPS_DEV_TYPE_LEN];
464 * config_methods - Config Methods
466 * This is a space-separated list of supported WPS configuration
467 * methods. For example, "label virtual_display virtual_push_button
469 * Available methods: usba ethernet label display ext_nfc_token
470 * int_nfc_token nfc_interface push_button keypad
471 * virtual_display physical_display
472 * virtual_push_button physical_push_button.
474 char *config_methods;
477 * os_version - OS Version (WPS)
478 * 4-octet operating system version number
483 * country - Country code
485 * This is the ISO/IEC alpha2 country code for which we are operating
491 * wps_cred_processing - Credential processing
493 * 0 = process received credentials internally
494 * 1 = do not process received credentials; just pass them over
495 * ctrl_iface to external program(s)
496 * 2 = process received credentials internally and pass them over
497 * ctrl_iface to external program(s)
499 int wps_cred_processing;
501 #define MAX_SEC_DEVICE_TYPES 5
503 * sec_device_types - Secondary Device Types (P2P)
505 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
506 int num_sec_device_types;
508 int p2p_listen_reg_class;
509 int p2p_listen_channel;
510 int p2p_oper_reg_class;
511 int p2p_oper_channel;
513 char *p2p_ssid_postfix;
514 int persistent_reconnect;
516 unsigned int num_p2p_pref_chan;
517 struct p2p_channel *p2p_pref_chan;
519 struct wpabuf *wps_vendor_ext_m1;
521 #define MAX_WPS_VENDOR_EXT 10
523 * wps_vendor_ext - Vendor extension attributes in WPS
525 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
528 * p2p_group_idle - Maximum idle time in seconds for P2P group
530 * This value controls how long a P2P group is maintained after there
531 * is no other members in the group. As a GO, this means no associated
532 * stations in the group. As a P2P client, this means no GO seen in
533 * scan results. The maximum idle time is specified in seconds with 0
534 * indicating no time limit, i.e., the P2P group remains in active
535 * state indefinitely until explicitly removed. As a P2P client, the
536 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
537 * this parameter is mainly meant for GO use and for P2P client, it can
538 * only be used to reduce the default timeout to smaller value. A
539 * special value -1 can be used to configure immediate removal of the
540 * group for P2P client role on any disconnection after the data
541 * connection has been established.
546 * bss_max_count - Maximum number of BSS entries to keep in memory
548 unsigned int bss_max_count;
551 * bss_expiration_age - BSS entry age after which it can be expired
553 * This value controls the time in seconds after which a BSS entry
554 * gets removed if it has not been updated or is not in use.
556 unsigned int bss_expiration_age;
559 * bss_expiration_scan_count - Expire BSS after number of scans
561 * If the BSS entry has not been seen in this many scans, it will be
562 * removed. A value of 1 means that entry is removed after the first
563 * scan in which the BSSID is not seen. Larger values can be used
564 * to avoid BSS entries disappearing if they are not visible in
565 * every scan (e.g., low signal quality or interference).
567 unsigned int bss_expiration_scan_count;
570 * filter_ssids - SSID-based scan result filtering
572 * 0 = do not filter scan results
573 * 1 = only include configured SSIDs in scan results/BSS table
578 * filter_rssi - RSSI-based scan result filtering
580 * 0 = do not filter scan results
581 * -n = filter scan results below -n dBm
586 * max_num_sta - Maximum number of STAs in an AP/P2P GO
588 unsigned int max_num_sta;
591 * changed_parameters - Bitmap of changed parameters since last update
593 unsigned int changed_parameters;
596 * disassoc_low_ack - Disassocicate stations with massive packet loss
598 int disassoc_low_ack;
601 * interworking - Whether Interworking (IEEE 802.11u) is enabled
606 * access_network_type - Access Network Type
608 * When Interworking is enabled, scans will be limited to APs that
609 * advertise the specified Access Network Type (0..15; with 15
610 * indicating wildcard match).
612 int access_network_type;
615 * hessid - Homogenous ESS identifier
617 * If this is set (any octet is non-zero), scans will be used to
618 * request response only from BSSes belonging to the specified
619 * Homogeneous ESS. This is used only if interworking is enabled.
629 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
631 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
632 * by acting as a Registrar and using M1 from the AP. The config
633 * methods attribute in that message is supposed to indicate only the
634 * configuration method supported by the AP in Enrollee role, i.e., to
635 * add an external Registrar. For that case, PBC shall not be used and
636 * as such, the PushButton config method is removed from M1 by default.
637 * If pbc_in_m1=1 is included in the configuration file, the PushButton
638 * config method is left in M1 (if included in config_methods
639 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
640 * a label in the AP).
645 * autoscan - Automatic scan parameters or %NULL if none
647 * This is an optional set of parameters for automatic scanning
648 * within an interface in following format:
649 * <autoscan module name>:<module parameters>
654 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
656 int wps_nfc_dev_pw_id;
659 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
661 struct wpabuf *wps_nfc_dh_pubkey;
664 * wps_nfc_dh_pubkey - NFC DH Private Key for password token
666 struct wpabuf *wps_nfc_dh_privkey;
669 * wps_nfc_dh_pubkey - NFC Device Password for password token
671 struct wpabuf *wps_nfc_dev_pw;
675 /* Prototypes for common functions from config.c */
677 void wpa_config_free(struct wpa_config *ssid);
678 void wpa_config_free_ssid(struct wpa_ssid *ssid);
679 void wpa_config_foreach_network(struct wpa_config *config,
680 void (*func)(void *, struct wpa_ssid *),
682 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
683 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
684 int wpa_config_remove_network(struct wpa_config *config, int id);
685 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
686 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
688 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
690 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
691 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
692 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
693 void wpa_config_update_psk(struct wpa_ssid *ssid);
694 int wpa_config_add_prio_network(struct wpa_config *config,
695 struct wpa_ssid *ssid);
696 int wpa_config_update_prio_list(struct wpa_config *config);
697 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
699 void wpa_config_set_blob(struct wpa_config *config,
700 struct wpa_config_blob *blob);
701 void wpa_config_free_blob(struct wpa_config_blob *blob);
702 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
704 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
705 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
706 int wpa_config_remove_cred(struct wpa_config *config, int id);
707 void wpa_config_free_cred(struct wpa_cred *cred);
708 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
709 const char *value, int line);
711 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
712 const char *driver_param);
713 #ifndef CONFIG_NO_STDOUT_DEBUG
714 void wpa_config_debug_dump_networks(struct wpa_config *config);
715 #else /* CONFIG_NO_STDOUT_DEBUG */
716 #define wpa_config_debug_dump_networks(c) do { } while (0)
717 #endif /* CONFIG_NO_STDOUT_DEBUG */
720 /* Prototypes for common functions from config.c */
721 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
724 /* Prototypes for backend specific functions from the selected config_*.c */
727 * wpa_config_read - Read and parse configuration database
728 * @name: Name of the configuration (e.g., path and file name for the
729 * configuration file)
730 * Returns: Pointer to allocated configuration data or %NULL on failure
732 * This function reads configuration data, parses its contents, and allocates
733 * data structures needed for storing configuration information. The allocated
734 * data can be freed with wpa_config_free().
736 * Each configuration backend needs to implement this function.
738 struct wpa_config * wpa_config_read(const char *name);
741 * wpa_config_write - Write or update configuration data
742 * @name: Name of the configuration (e.g., path and file name for the
743 * configuration file)
744 * @config: Configuration data from wpa_config_read()
745 * Returns: 0 on success, -1 on failure
747 * This function write all configuration data into an external database (e.g.,
748 * a text file) in a format that can be read with wpa_config_read(). This can
749 * be used to allow wpa_supplicant to update its configuration, e.g., when a
750 * new network is added or a password is changed.
752 * Each configuration backend needs to implement this function.
754 int wpa_config_write(const char *name, struct wpa_config *config);
756 #endif /* CONFIG_H */