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_USER_MPM 1
19 #define DEFAULT_MAX_PEER_LINKS 99
20 #define DEFAULT_MESH_MAX_INACTIVITY 300
21 #define DEFAULT_FAST_REAUTH 1
22 #define DEFAULT_P2P_GO_INTENT 7
23 #define DEFAULT_P2P_INTRA_BSS 1
24 #define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
25 #define DEFAULT_P2P_OPTIMIZE_LISTEN_CHAN 0
26 #define DEFAULT_BSS_MAX_COUNT 200
27 #define DEFAULT_BSS_EXPIRATION_AGE 180
28 #define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
29 #define DEFAULT_MAX_NUM_STA 128
30 #define DEFAULT_ACCESS_NETWORK_TYPE 15
31 #define DEFAULT_SCAN_CUR_FREQ 0
32 #define DEFAULT_P2P_SEARCH_DELAY 500
33 #define DEFAULT_RAND_ADDR_LIFETIME 60
34 #define DEFAULT_KEY_MGMT_OFFLOAD 1
35 #define DEFAULT_CERT_IN_CB 1
37 #include "config_ssid.h"
39 #include "common/ieee802_11_common.h"
44 * next - Next credential in the list
46 * This pointer can be used to iterate over all credentials. The head
47 * of this list is stored in the cred field of struct wpa_config.
49 struct wpa_cred *next;
52 * id - Unique id for the credential
54 * This identifier is used as a unique identifier for each credential
55 * block when using the control interface. Each credential is allocated
56 * an id when it is being created, either when reading the
57 * configuration file or when a new credential is added through the
63 * temporary - Whether this credential is temporary and not to be saved
68 * priority - Priority group
70 * By default, all networks and credentials get the same priority group
71 * (0). This field can be used to give higher priority for credentials
72 * (and similarly in struct wpa_ssid for network blocks) to change the
73 * Interworking automatic networking selection behavior. The matching
74 * network (based on either an enabled network block or a credential)
75 * with the highest priority value will be selected.
80 * pcsc - Use PC/SC and SIM/USIM card
85 * realm - Home Realm for Interworking
90 * username - Username for Interworking network selection
95 * password - Password for Interworking network selection
100 * ext_password - Whether password is a name for external storage
105 * ca_cert - CA certificate for Interworking network selection
110 * client_cert - File path to client certificate file (PEM/DER)
112 * This field is used with Interworking networking selection for a case
113 * where client certificate/private key is used for authentication
114 * (EAP-TLS). Full path to the file should be used since working
115 * directory may change when wpa_supplicant is run in the background.
117 * Alternatively, a named configuration blob can be used by setting
118 * this to blob://blob_name.
123 * private_key - File path to client private key file (PEM/DER/PFX)
125 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
126 * commented out. Both the private key and certificate will be read
127 * from the PKCS#12 file in this case. Full path to the file should be
128 * used since working directory may change when wpa_supplicant is run
131 * Windows certificate store can be used by leaving client_cert out and
132 * configuring private_key in one of the following formats:
134 * cert://substring_to_match
136 * hash://certificate_thumbprint_in_hex
138 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
140 * Note that when running wpa_supplicant as an application, the user
141 * certificate store (My user account) is used, whereas computer store
142 * (Computer account) is used when running wpasvc as a service.
144 * Alternatively, a named configuration blob can be used by setting
145 * this to blob://blob_name.
150 * private_key_passwd - Password for private key file
152 char *private_key_passwd;
155 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
160 * milenage - Milenage parameters for SIM/USIM simulator in
161 * <Ki>:<OPc>:<SQN> format
166 * domain_suffix_match - Constraint for server domain name
168 * If set, this FQDN is used as a suffix match requirement for the AAA
169 * server certificate in SubjectAltName dNSName element(s). If a
170 * matching dNSName is found, this constraint is met. If no dNSName
171 * values are present, this constraint is matched against SubjectName CN
172 * using same suffix match comparison. Suffix match here means that the
173 * host/domain name is compared one label at a time starting from the
174 * top-level domain and all the labels in @domain_suffix_match shall be
175 * included in the certificate. The certificate may include additional
176 * sub-level labels in addition to the required labels.
178 * For example, domain_suffix_match=example.com would match
179 * test.example.com but would not match test-example.com.
181 char *domain_suffix_match;
184 * domain - Home service provider FQDN(s)
186 * This is used to compare against the Domain Name List to figure out
187 * whether the AP is operated by the Home SP. Multiple domain entries
188 * can be used to configure alternative FQDNs that will be considered
194 * num_domain - Number of FQDNs in the domain array
199 * roaming_consortium - Roaming Consortium OI
201 * If roaming_consortium_len is non-zero, this field contains the
202 * Roaming Consortium OI that can be used to determine which access
203 * points support authentication with this credential. This is an
204 * alternative to the use of the realm parameter. When using Roaming
205 * Consortium to match the network, the EAP parameters need to be
206 * pre-configured with the credential since the NAI Realm information
207 * may not be available or fetched.
209 u8 roaming_consortium[15];
212 * roaming_consortium_len - Length of roaming_consortium
214 size_t roaming_consortium_len;
216 u8 required_roaming_consortium[15];
217 size_t required_roaming_consortium_len;
220 * eap_method - EAP method to use
222 * Pre-configured EAP method to use with this credential or %NULL to
223 * indicate no EAP method is selected, i.e., the method will be
224 * selected automatically based on ANQP information.
226 struct eap_method_type *eap_method;
229 * phase1 - Phase 1 (outer authentication) parameters
231 * Pre-configured EAP parameters or %NULL.
236 * phase2 - Phase 2 (inner authentication) parameters
238 * Pre-configured EAP parameters or %NULL.
242 struct excluded_ssid {
243 u8 ssid[MAX_SSID_LEN];
246 size_t num_excluded_ssid;
248 struct roaming_partner {
254 size_t num_roaming_partner;
256 int update_identifier;
259 * provisioning_sp - FQDN of the SP that provisioned the credential
261 char *provisioning_sp;
264 * sp_priority - Credential priority within a provisioning SP
266 * This is the priority of the credential among all credentials
267 * provisionined by the same SP (i.e., for entries that have identical
268 * provisioning_sp value). The range of this priority is 0-255 with 0
269 * being the highest and 255 the lower priority.
273 unsigned int min_dl_bandwidth_home;
274 unsigned int min_ul_bandwidth_home;
275 unsigned int min_dl_bandwidth_roaming;
276 unsigned int min_ul_bandwidth_roaming;
279 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
280 * This value is used as the maximum channel utilization for network
281 * selection purposes for home networks. If the AP does not advertise
282 * BSS Load or if the limit would prevent any connection, this
283 * constraint will be ignored.
285 unsigned int max_bss_load;
287 unsigned int num_req_conn_capab;
288 u8 *req_conn_capab_proto;
289 int **req_conn_capab_port;
292 * ocsp - Whether to use/require OCSP to check server certificate
294 * 0 = do not use OCSP stapling (TLS certificate status extension)
295 * 1 = try to use OCSP stapling, but not require response
296 * 2 = require valid OCSP stapling response
301 * sim_num - User selected SIM identifier
303 * This variable is used for identifying which SIM is used if the system
310 #define CFG_CHANGED_DEVICE_NAME BIT(0)
311 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
312 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
313 #define CFG_CHANGED_OS_VERSION BIT(3)
314 #define CFG_CHANGED_UUID BIT(4)
315 #define CFG_CHANGED_COUNTRY BIT(5)
316 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
317 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
318 #define CFG_CHANGED_WPS_STRING BIT(8)
319 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
320 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
321 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
322 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
323 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
324 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
325 #define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
326 #define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
329 * struct wpa_config - wpa_supplicant configuration data
331 * This data structure is presents the per-interface (radio) configuration
332 * data. In many cases, there is only one struct wpa_config instance, but if
333 * more than one network interface is being controlled, one instance is used
338 * ssid - Head of the global network list
340 * This is the head for the list of all the configured networks.
342 struct wpa_ssid *ssid;
345 * pssid - Per-priority network lists (in priority order)
347 struct wpa_ssid **pssid;
350 * num_prio - Number of different priorities used in the pssid lists
352 * This indicates how many per-priority network lists are included in
358 * cred - Head of the credential list
360 * This is the head for the list of all the configured credentials.
362 struct wpa_cred *cred;
365 * eapol_version - IEEE 802.1X/EAPOL version number
367 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
368 * defines EAPOL version 2. However, there are many APs that do not
369 * handle the new version number correctly (they seem to drop the
370 * frames completely). In order to make wpa_supplicant interoperate
371 * with these APs, the version number is set to 1 by default. This
372 * configuration value can be used to set it to the new version (2).
377 * ap_scan - AP scanning/selection
379 * By default, wpa_supplicant requests driver to perform AP
380 * scanning and then uses the scan results to select a
381 * suitable AP. Another alternative is to allow the driver to
382 * take care of AP scanning and selection and use
383 * wpa_supplicant just to process EAPOL frames based on IEEE
384 * 802.11 association information from the driver.
386 * 1: wpa_supplicant initiates scanning and AP selection (default).
388 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
389 * association parameters (e.g., WPA IE generation); this mode can
390 * also be used with non-WPA drivers when using IEEE 802.1X mode;
391 * do not try to associate with APs (i.e., external program needs
392 * to control association). This mode must also be used when using
393 * wired Ethernet drivers.
395 * 2: like 0, but associate with APs using security policy and SSID
396 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
397 * drivers to enable operation with hidden SSIDs and optimized roaming;
398 * in this mode, the network blocks in the configuration are tried
399 * one by one until the driver reports successful association; each
400 * network block should have explicit security policy (i.e., only one
401 * option in the lists) for key_mgmt, pairwise, group, proto variables.
406 * bgscan - Background scan and roaming parameters or %NULL if none
408 * This is an optional set of parameters for background scanning and
409 * roaming within a network (ESS). For more detailed information see
410 * ssid block documentation.
412 * The variable defines default bgscan behavior for all BSS station
413 * networks except for those which have their own bgscan configuration.
418 * disable_scan_offload - Disable automatic offloading of scan requests
420 * By default, %wpa_supplicant tries to offload scanning if the driver
421 * indicates support for this (sched_scan). This configuration
422 * parameter can be used to disable this offloading mechanism.
424 int disable_scan_offload;
427 * ctrl_interface - Parameters for the control interface
429 * If this is specified, %wpa_supplicant will open a control interface
430 * that is available for external programs to manage %wpa_supplicant.
431 * The meaning of this string depends on which control interface
432 * mechanism is used. For all cases, the existence of this parameter
433 * in configuration is used to determine whether the control interface
436 * For UNIX domain sockets (default on Linux and BSD): This is a
437 * directory that will be created for UNIX domain sockets for listening
438 * to requests from external programs (CLI/GUI, etc.) for status
439 * information and configuration. The socket file will be named based
440 * on the interface name, so multiple %wpa_supplicant processes can be
441 * run at the same time if more than one interface is used.
442 * /var/run/wpa_supplicant is the recommended directory for sockets and
443 * by default, wpa_cli will use it when trying to connect with
446 * Access control for the control interface can be configured
447 * by setting the directory to allow only members of a group
448 * to use sockets. This way, it is possible to run
449 * %wpa_supplicant as root (since it needs to change network
450 * configuration and open raw sockets) and still allow GUI/CLI
451 * components to be run as non-root users. However, since the
452 * control interface can be used to change the network
453 * configuration, this access needs to be protected in many
454 * cases. By default, %wpa_supplicant is configured to use gid
455 * 0 (root). If you want to allow non-root users to use the
456 * control interface, add a new group and change this value to
457 * match with that group. Add users that should have control
458 * interface access to this group.
460 * When configuring both the directory and group, use following format:
461 * DIR=/var/run/wpa_supplicant GROUP=wheel
462 * DIR=/var/run/wpa_supplicant GROUP=0
463 * (group can be either group name or gid)
465 * For UDP connections (default on Windows): The value will be ignored.
466 * This variable is just used to select that the control interface is
467 * to be created. The value can be set to, e.g., udp
468 * (ctrl_interface=udp).
470 * For Windows Named Pipe: This value can be used to set the security
471 * descriptor for controlling access to the control interface. Security
472 * descriptor can be set using Security Descriptor String Format (see
473 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
474 * The descriptor string needs to be prefixed with SDDL=. For example,
475 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
478 char *ctrl_interface;
481 * ctrl_interface_group - Control interface group (DEPRECATED)
483 * This variable is only used for backwards compatibility. Group for
484 * UNIX domain sockets should now be specified using GROUP=group in
485 * ctrl_interface variable.
487 char *ctrl_interface_group;
490 * fast_reauth - EAP fast re-authentication (session resumption)
492 * By default, fast re-authentication is enabled for all EAP methods
493 * that support it. This variable can be used to disable fast
494 * re-authentication (by setting fast_reauth=0). Normally, there is no
495 * need to disable fast re-authentication.
500 * opensc_engine_path - Path to the OpenSSL engine for opensc
502 * This is an OpenSSL specific configuration option for loading OpenSC
503 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
505 char *opensc_engine_path;
508 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
510 * This is an OpenSSL specific configuration option for loading PKCS#11
511 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
513 char *pkcs11_engine_path;
516 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
518 * This is an OpenSSL specific configuration option for configuring
519 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
520 * module is not loaded.
522 char *pkcs11_module_path;
525 * openssl_ciphers - OpenSSL cipher string
527 * This is an OpenSSL specific configuration option for configuring the
528 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
531 char *openssl_ciphers;
534 * pcsc_reader - PC/SC reader name prefix
536 * If not %NULL, PC/SC reader with a name that matches this prefix is
537 * initialized for SIM/USIM access. Empty string can be used to match
538 * the first available reader.
543 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
545 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
546 * EAP-AKA. If left out, this will be asked through control interface.
551 * external_sim - Use external processing for SIM/USIM operations
556 * driver_param - Driver interface parameters
558 * This text string is passed to the selected driver interface with the
559 * optional struct wpa_driver_ops::set_param() handler. This can be
560 * used to configure driver specific options without having to add new
561 * driver interface functionality.
566 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
568 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
569 * cache (unit: seconds).
571 unsigned int dot11RSNAConfigPMKLifetime;
574 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
576 * dot11 MIB variable for the percentage of the PMK lifetime
577 * that should expire before an IEEE 802.1X reauthentication occurs.
579 unsigned int dot11RSNAConfigPMKReauthThreshold;
582 * dot11RSNAConfigSATimeout - Security association timeout
584 * dot11 MIB variable for the maximum time a security association
585 * shall take to set up (unit: seconds).
587 unsigned int dot11RSNAConfigSATimeout;
590 * update_config - Is wpa_supplicant allowed to update configuration
592 * This variable control whether wpa_supplicant is allow to re-write
593 * its configuration with wpa_config_write(). If this is zero,
594 * configuration data is only changed in memory and the external data
595 * is not overriden. If this is non-zero, wpa_supplicant will update
596 * the configuration data (e.g., a file) whenever configuration is
597 * changed. This update may replace the old configuration which can
598 * remove comments from it in case of a text file configuration.
603 * blobs - Configuration blobs
605 struct wpa_config_blob *blobs;
608 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
613 * device_name - Device Name (WPS)
614 * User-friendly description of device; up to 32 octets encoded in
620 * manufacturer - Manufacturer (WPS)
621 * The manufacturer of the device (up to 64 ASCII characters)
626 * model_name - Model Name (WPS)
627 * Model of the device (up to 32 ASCII characters)
632 * model_number - Model Number (WPS)
633 * Additional device description (up to 32 ASCII characters)
638 * serial_number - Serial Number (WPS)
639 * Serial number of the device (up to 32 characters)
644 * device_type - Primary Device Type (WPS)
646 u8 device_type[WPS_DEV_TYPE_LEN];
649 * config_methods - Config Methods
651 * This is a space-separated list of supported WPS configuration
652 * methods. For example, "label virtual_display virtual_push_button
654 * Available methods: usba ethernet label display ext_nfc_token
655 * int_nfc_token nfc_interface push_button keypad
656 * virtual_display physical_display
657 * virtual_push_button physical_push_button.
659 char *config_methods;
662 * os_version - OS Version (WPS)
663 * 4-octet operating system version number
668 * country - Country code
670 * This is the ISO/IEC alpha2 country code for which we are operating
676 * wps_cred_processing - Credential processing
678 * 0 = process received credentials internally
679 * 1 = do not process received credentials; just pass them over
680 * ctrl_iface to external program(s)
681 * 2 = process received credentials internally and pass them over
682 * ctrl_iface to external program(s)
684 int wps_cred_processing;
686 #define MAX_SEC_DEVICE_TYPES 5
688 * sec_device_types - Secondary Device Types (P2P)
690 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
691 int num_sec_device_types;
693 int p2p_listen_reg_class;
694 int p2p_listen_channel;
695 int p2p_oper_reg_class;
696 int p2p_oper_channel;
698 char *p2p_ssid_postfix;
699 int persistent_reconnect;
701 unsigned int num_p2p_pref_chan;
702 struct p2p_channel *p2p_pref_chan;
703 struct wpa_freq_range_list p2p_no_go_freq;
704 int p2p_add_cli_chan;
705 int p2p_ignore_shared_freq;
706 int p2p_optimize_listen_chan;
708 struct wpabuf *wps_vendor_ext_m1;
710 #define MAX_WPS_VENDOR_EXT 10
712 * wps_vendor_ext - Vendor extension attributes in WPS
714 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
717 * p2p_group_idle - Maximum idle time in seconds for P2P group
719 * This value controls how long a P2P group is maintained after there
720 * is no other members in the group. As a GO, this means no associated
721 * stations in the group. As a P2P client, this means no GO seen in
722 * scan results. The maximum idle time is specified in seconds with 0
723 * indicating no time limit, i.e., the P2P group remains in active
724 * state indefinitely until explicitly removed. As a P2P client, the
725 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
726 * this parameter is mainly meant for GO use and for P2P client, it can
727 * only be used to reduce the default timeout to smaller value. A
728 * special value -1 can be used to configure immediate removal of the
729 * group for P2P client role on any disconnection after the data
730 * connection has been established.
735 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
737 * This parameter controls the length of the random passphrase that is
738 * generated at the GO.
740 unsigned int p2p_passphrase_len;
743 * bss_max_count - Maximum number of BSS entries to keep in memory
745 unsigned int bss_max_count;
748 * bss_expiration_age - BSS entry age after which it can be expired
750 * This value controls the time in seconds after which a BSS entry
751 * gets removed if it has not been updated or is not in use.
753 unsigned int bss_expiration_age;
756 * bss_expiration_scan_count - Expire BSS after number of scans
758 * If the BSS entry has not been seen in this many scans, it will be
759 * removed. A value of 1 means that entry is removed after the first
760 * scan in which the BSSID is not seen. Larger values can be used
761 * to avoid BSS entries disappearing if they are not visible in
762 * every scan (e.g., low signal quality or interference).
764 unsigned int bss_expiration_scan_count;
767 * filter_ssids - SSID-based scan result filtering
769 * 0 = do not filter scan results
770 * 1 = only include configured SSIDs in scan results/BSS table
775 * filter_rssi - RSSI-based scan result filtering
777 * 0 = do not filter scan results
778 * -n = filter scan results below -n dBm
783 * max_num_sta - Maximum number of STAs in an AP/P2P GO
785 unsigned int max_num_sta;
788 * freq_list - Array of allowed scan frequencies or %NULL for all
790 * This is an optional zero-terminated array of frequencies in
791 * megahertz (MHz) to allow for narrowing scanning range.
796 * scan_cur_freq - Whether to scan only the current channel
798 * If true, attempt to scan only the current channel if any other
799 * VIFs on this radio are already associated on a particular channel.
804 * changed_parameters - Bitmap of changed parameters since last update
806 unsigned int changed_parameters;
809 * disassoc_low_ack - Disassocicate stations with massive packet loss
811 int disassoc_low_ack;
814 * interworking - Whether Interworking (IEEE 802.11u) is enabled
819 * access_network_type - Access Network Type
821 * When Interworking is enabled, scans will be limited to APs that
822 * advertise the specified Access Network Type (0..15; with 15
823 * indicating wildcard match).
825 int access_network_type;
828 * hessid - Homogenous ESS identifier
830 * If this is set (any octet is non-zero), scans will be used to
831 * request response only from BSSes belonging to the specified
832 * Homogeneous ESS. This is used only if interworking is enabled.
842 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
844 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
845 * by acting as a Registrar and using M1 from the AP. The config
846 * methods attribute in that message is supposed to indicate only the
847 * configuration method supported by the AP in Enrollee role, i.e., to
848 * add an external Registrar. For that case, PBC shall not be used and
849 * as such, the PushButton config method is removed from M1 by default.
850 * If pbc_in_m1=1 is included in the configuration file, the PushButton
851 * config method is left in M1 (if included in config_methods
852 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
853 * a label in the AP).
858 * autoscan - Automatic scan parameters or %NULL if none
860 * This is an optional set of parameters for automatic scanning
861 * within an interface in following format:
862 * <autoscan module name>:<module parameters>
867 * wps_nfc_pw_from_config - NFC Device Password was read from config
869 * This parameter can be determined whether the NFC Device Password was
870 * included in the configuration (1) or generated dynamically (0). Only
871 * the former case is re-written back to the configuration file.
873 int wps_nfc_pw_from_config;
876 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
878 int wps_nfc_dev_pw_id;
881 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
883 struct wpabuf *wps_nfc_dh_pubkey;
886 * wps_nfc_dh_privkey - NFC DH Private Key for password token
888 struct wpabuf *wps_nfc_dh_privkey;
891 * wps_nfc_dev_pw - NFC Device Password for password token
893 struct wpabuf *wps_nfc_dev_pw;
896 * ext_password_backend - External password backend or %NULL if none
898 * format: <backend name>[:<optional backend parameters>]
900 char *ext_password_backend;
903 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
905 * This timeout value is used in P2P GO mode to clean up
907 * By default: 300 seconds.
909 int p2p_go_max_inactivity;
911 struct hostapd_wmm_ac_params wmm_ac_params[4];
914 * auto_interworking - Whether to use network selection automatically
916 * 0 = do not automatically go through Interworking network selection
917 * (i.e., require explicit interworking_select command for this)
918 * 1 = perform Interworking network selection if one or more
919 * credentials have been configured and scan did not find a
920 * matching network block
922 int auto_interworking;
925 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
927 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
928 * Note that regulatory constraints and driver capabilities are
929 * consulted anyway, so setting it to 1 can't do real harm.
930 * By default: 0 (disabled)
935 * p2p_go_vht - Default mode for VHT enable when operating as GO
937 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
938 * Note that regulatory constraints and driver capabilities are
939 * consulted anyway, so setting it to 1 can't do real harm.
940 * By default: 0 (disabled)
945 * p2p_disabled - Whether P2P operations are disabled for this interface
950 * p2p_no_group_iface - Whether group interfaces can be used
952 * By default, wpa_supplicant will create a separate interface for P2P
953 * group operations if the driver supports this. This functionality can
954 * be disabled by setting this parameter to 1. In that case, the same
955 * interface that was used for the P2P management operations is used
956 * also for the group operation.
958 int p2p_no_group_iface;
961 * okc - Whether to enable opportunistic key caching by default
963 * By default, OKC is disabled unless enabled by the per-network
964 * proactive_key_caching=1 parameter. okc=1 can be used to change this
970 * pmf - Whether to enable/require PMF by default
972 * By default, PMF is disabled unless enabled by the per-network
973 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
974 * this default behavior.
976 enum mfp_options pmf;
979 * sae_groups - Preference list of enabled groups for SAE
981 * By default (if this parameter is not set), the mandatory group 19
982 * (ECC group defined over a 256-bit prime order field) is preferred,
983 * but other groups are also enabled. If this parameter is set, the
984 * groups will be tried in the indicated order.
989 * dtim_period - Default DTIM period in Beacon intervals
991 * This parameter can be used to set the default value for network
992 * blocks that do not specify dtim_period.
997 * beacon_int - Default Beacon interval in TU
999 * This parameter can be used to set the default value for network
1000 * blocks that do not specify beacon_int.
1005 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1007 * This parameter can be used to define additional vendor specific
1008 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1009 * format for these element(s) is a hexdump of the raw information
1010 * elements (id+len+payload for one or more elements).
1012 struct wpabuf *ap_vendor_elements;
1015 * ignore_old_scan_res - Ignore scan results older than request
1017 * The driver may have a cache of scan results that makes it return
1018 * information that is older than our scan trigger. This parameter can
1019 * be used to configure such old information to be ignored instead of
1020 * allowing it to update the internal BSS table.
1022 int ignore_old_scan_res;
1025 * sched_scan_interval - schedule scan interval
1027 unsigned int sched_scan_interval;
1030 * tdls_external_control - External control for TDLS setup requests
1032 * Enable TDLS mode where external programs are given the control
1033 * to specify the TDLS link to get established to the driver. The
1034 * driver requests the TDLS setup to the supplicant only for the
1035 * specified TDLS peers.
1037 int tdls_external_control;
1041 u8 ip_addr_start[4];
1045 * osu_dir - OSU provider information directory
1047 * If set, allow FETCH_OSU control interface command to be used to fetch
1048 * OSU provider information into all APs and store the results in this
1054 * wowlan_triggers - Wake-on-WLAN triggers
1056 * If set, these wowlan triggers will be configured.
1058 char *wowlan_triggers;
1061 * p2p_search_delay - Extra delay between concurrent search iterations
1063 * Add extra delay (in milliseconds) between search iterations when
1064 * there is a concurrent operation to make p2p_find friendlier to
1065 * concurrent operations by avoiding it from taking 100% of radio
1068 unsigned int p2p_search_delay;
1071 * mac_addr - MAC address policy default
1073 * 0 = use permanent MAC address
1074 * 1 = use random MAC address for each ESS connection
1075 * 2 = like 1, but maintain OUI (with local admin bit set)
1077 * By default, permanent MAC address is used unless policy is changed by
1078 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1079 * change this default behavior.
1084 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1086 unsigned int rand_addr_lifetime;
1089 * preassoc_mac_addr - Pre-association MAC address policy
1091 * 0 = use permanent MAC address
1092 * 1 = use random MAC address
1093 * 2 = like 1, but maintain OUI (with local admin bit set)
1095 int preassoc_mac_addr;
1098 * key_mgmt_offload - Use key management offload
1100 * Key management offload should be used if the device supports it.
1101 * Key management offload is the capability of a device operating as
1102 * a station to do the exchange necessary to establish temporal keys
1103 * during initial RSN connection, after roaming, or during a PTK
1104 * rekeying operation.
1106 int key_mgmt_offload;
1109 * user_mpm - MPM residency
1111 * 0: MPM lives in driver.
1112 * 1: wpa_supplicant handles peering and station allocation.
1114 * If AMPE or SAE is enabled, the MPM is always in userspace.
1119 * max_peer_links - Maximum number of peer links
1121 * Maximum number of mesh peering currently maintained by the STA.
1126 * cert_in_cb - Whether to include a peer certificate dump in events
1128 * This controls whether peer certificates for authentication server and
1129 * its certificate chain are included in EAP peer certificate events.
1134 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1136 * This timeout value is used in mesh STA to clean up inactive stations.
1137 * By default: 300 seconds.
1139 int mesh_max_inactivity;
1142 * passive_scan - Whether to force passive scan for network connection
1144 * This parameter can be used to force only passive scanning to be used
1145 * for network connection cases. It should be noted that this will slow
1146 * down scan operations and reduce likelihood of finding the AP. In
1147 * addition, some use cases will override this due to functional
1148 * requirements, e.g., for finding an AP that uses hidden SSID
1149 * (scan_ssid=1) or P2P device discovery.
1154 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1156 int reassoc_same_bss_optim;
1160 /* Prototypes for common functions from config.c */
1162 void wpa_config_free(struct wpa_config *ssid);
1163 void wpa_config_free_ssid(struct wpa_ssid *ssid);
1164 void wpa_config_foreach_network(struct wpa_config *config,
1165 void (*func)(void *, struct wpa_ssid *),
1167 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1168 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1169 int wpa_config_remove_network(struct wpa_config *config, int id);
1170 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1171 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1173 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1175 int wpa_config_dump_values(struct wpa_config *config, char *buf,
1177 int wpa_config_get_value(const char *name, struct wpa_config *config,
1178 char *buf, size_t buflen);
1180 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1181 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1182 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1183 void wpa_config_update_psk(struct wpa_ssid *ssid);
1184 int wpa_config_add_prio_network(struct wpa_config *config,
1185 struct wpa_ssid *ssid);
1186 int wpa_config_update_prio_list(struct wpa_config *config);
1187 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1189 void wpa_config_set_blob(struct wpa_config *config,
1190 struct wpa_config_blob *blob);
1191 void wpa_config_free_blob(struct wpa_config_blob *blob);
1192 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
1193 void wpa_config_flush_blobs(struct wpa_config *config);
1195 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1196 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1197 int wpa_config_remove_cred(struct wpa_config *config, int id);
1198 void wpa_config_free_cred(struct wpa_cred *cred);
1199 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1200 const char *value, int line);
1201 char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
1203 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1204 const char *driver_param);
1205 #ifndef CONFIG_NO_STDOUT_DEBUG
1206 void wpa_config_debug_dump_networks(struct wpa_config *config);
1207 #else /* CONFIG_NO_STDOUT_DEBUG */
1208 #define wpa_config_debug_dump_networks(c) do { } while (0)
1209 #endif /* CONFIG_NO_STDOUT_DEBUG */
1212 /* Prototypes for common functions from config.c */
1213 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1216 /* Prototypes for backend specific functions from the selected config_*.c */
1219 * wpa_config_read - Read and parse configuration database
1220 * @name: Name of the configuration (e.g., path and file name for the
1221 * configuration file)
1222 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
1223 * Returns: Pointer to allocated configuration data or %NULL on failure
1225 * This function reads configuration data, parses its contents, and allocates
1226 * data structures needed for storing configuration information. The allocated
1227 * data can be freed with wpa_config_free().
1229 * Each configuration backend needs to implement this function.
1231 struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
1234 * wpa_config_write - Write or update configuration data
1235 * @name: Name of the configuration (e.g., path and file name for the
1236 * configuration file)
1237 * @config: Configuration data from wpa_config_read()
1238 * Returns: 0 on success, -1 on failure
1240 * This function write all configuration data into an external database (e.g.,
1241 * a text file) in a format that can be read with wpa_config_read(). This can
1242 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1243 * new network is added or a password is changed.
1245 * Each configuration backend needs to implement this function.
1247 int wpa_config_write(const char *name, struct wpa_config *config);
1249 #endif /* CONFIG_H */