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
22 * The default dot11RSNASAERetransPeriod is defined as 40 ms in the standard,
23 * but use 1000 ms in practice to avoid issues on low power CPUs.
25 #define DEFAULT_DOT11_RSNA_SAE_RETRANS_PERIOD 1000
26 #define DEFAULT_FAST_REAUTH 1
27 #define DEFAULT_P2P_GO_INTENT 7
28 #define DEFAULT_P2P_INTRA_BSS 1
29 #define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
30 #define DEFAULT_P2P_OPTIMIZE_LISTEN_CHAN 0
31 #define DEFAULT_BSS_MAX_COUNT 200
32 #define DEFAULT_BSS_EXPIRATION_AGE 180
33 #define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
34 #define DEFAULT_MAX_NUM_STA 128
35 #define DEFAULT_ACCESS_NETWORK_TYPE 15
36 #define DEFAULT_SCAN_CUR_FREQ 0
37 #define DEFAULT_P2P_SEARCH_DELAY 500
38 #define DEFAULT_RAND_ADDR_LIFETIME 60
39 #define DEFAULT_KEY_MGMT_OFFLOAD 1
40 #define DEFAULT_CERT_IN_CB 1
41 #define DEFAULT_P2P_GO_CTWINDOW 0
42 #define DEFAULT_WPA_RSC_RELAXATION 1
43 #define DEFAULT_MBO_CELL_CAPA MBO_CELL_CAPA_NOT_SUPPORTED
45 #include "config_ssid.h"
47 #include "common/ieee802_11_defs.h"
48 #include "common/ieee802_11_common.h"
53 * next - Next credential in the list
55 * This pointer can be used to iterate over all credentials. The head
56 * of this list is stored in the cred field of struct wpa_config.
58 struct wpa_cred *next;
61 * id - Unique id for the credential
63 * This identifier is used as a unique identifier for each credential
64 * block when using the control interface. Each credential is allocated
65 * an id when it is being created, either when reading the
66 * configuration file or when a new credential is added through the
72 * temporary - Whether this credential is temporary and not to be saved
77 * priority - Priority group
79 * By default, all networks and credentials get the same priority group
80 * (0). This field can be used to give higher priority for credentials
81 * (and similarly in struct wpa_ssid for network blocks) to change the
82 * Interworking automatic networking selection behavior. The matching
83 * network (based on either an enabled network block or a credential)
84 * with the highest priority value will be selected.
89 * pcsc - Use PC/SC and SIM/USIM card
94 * realm - Home Realm for Interworking
99 * username - Username for Interworking network selection
104 * password - Password for Interworking network selection
109 * ext_password - Whether password is a name for external storage
114 * ca_cert - CA certificate for Interworking network selection
119 * client_cert - File path to client certificate file (PEM/DER)
121 * This field is used with Interworking networking selection for a case
122 * where client certificate/private key is used for authentication
123 * (EAP-TLS). Full path to the file should be used since working
124 * directory may change when wpa_supplicant is run in the background.
126 * Alternatively, a named configuration blob can be used by setting
127 * this to blob://blob_name.
132 * private_key - File path to client private key file (PEM/DER/PFX)
134 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
135 * commented out. Both the private key and certificate will be read
136 * from the PKCS#12 file in this case. Full path to the file should be
137 * used since working directory may change when wpa_supplicant is run
140 * Windows certificate store can be used by leaving client_cert out and
141 * configuring private_key in one of the following formats:
143 * cert://substring_to_match
145 * hash://certificate_thumbprint_in_hex
147 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
149 * Note that when running wpa_supplicant as an application, the user
150 * certificate store (My user account) is used, whereas computer store
151 * (Computer account) is used when running wpasvc as a service.
153 * Alternatively, a named configuration blob can be used by setting
154 * this to blob://blob_name.
159 * private_key_passwd - Password for private key file
161 char *private_key_passwd;
164 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
169 * milenage - Milenage parameters for SIM/USIM simulator in
170 * <Ki>:<OPc>:<SQN> format
175 * domain_suffix_match - Constraint for server domain name
177 * If set, this FQDN is used as a suffix match requirement for the AAA
178 * server certificate in SubjectAltName dNSName element(s). If a
179 * matching dNSName is found, this constraint is met. If no dNSName
180 * values are present, this constraint is matched against SubjectName CN
181 * using same suffix match comparison. Suffix match here means that the
182 * host/domain name is compared one label at a time starting from the
183 * top-level domain and all the labels in @domain_suffix_match shall be
184 * included in the certificate. The certificate may include additional
185 * sub-level labels in addition to the required labels.
187 * For example, domain_suffix_match=example.com would match
188 * test.example.com but would not match test-example.com.
190 char *domain_suffix_match;
193 * domain - Home service provider FQDN(s)
195 * This is used to compare against the Domain Name List to figure out
196 * whether the AP is operated by the Home SP. Multiple domain entries
197 * can be used to configure alternative FQDNs that will be considered
203 * num_domain - Number of FQDNs in the domain array
208 * roaming_consortium - Roaming Consortium OI
210 * If roaming_consortium_len is non-zero, this field contains the
211 * Roaming Consortium OI that can be used to determine which access
212 * points support authentication with this credential. This is an
213 * alternative to the use of the realm parameter. When using Roaming
214 * Consortium to match the network, the EAP parameters need to be
215 * pre-configured with the credential since the NAI Realm information
216 * may not be available or fetched.
218 u8 roaming_consortium[15];
221 * roaming_consortium_len - Length of roaming_consortium
223 size_t roaming_consortium_len;
225 u8 required_roaming_consortium[15];
226 size_t required_roaming_consortium_len;
229 * eap_method - EAP method to use
231 * Pre-configured EAP method to use with this credential or %NULL to
232 * indicate no EAP method is selected, i.e., the method will be
233 * selected automatically based on ANQP information.
235 struct eap_method_type *eap_method;
238 * phase1 - Phase 1 (outer authentication) parameters
240 * Pre-configured EAP parameters or %NULL.
245 * phase2 - Phase 2 (inner authentication) parameters
247 * Pre-configured EAP parameters or %NULL.
251 struct excluded_ssid {
252 u8 ssid[SSID_MAX_LEN];
255 size_t num_excluded_ssid;
257 struct roaming_partner {
263 size_t num_roaming_partner;
265 int update_identifier;
268 * provisioning_sp - FQDN of the SP that provisioned the credential
270 char *provisioning_sp;
273 * sp_priority - Credential priority within a provisioning SP
275 * This is the priority of the credential among all credentials
276 * provisionined by the same SP (i.e., for entries that have identical
277 * provisioning_sp value). The range of this priority is 0-255 with 0
278 * being the highest and 255 the lower priority.
282 unsigned int min_dl_bandwidth_home;
283 unsigned int min_ul_bandwidth_home;
284 unsigned int min_dl_bandwidth_roaming;
285 unsigned int min_ul_bandwidth_roaming;
288 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
289 * This value is used as the maximum channel utilization for network
290 * selection purposes for home networks. If the AP does not advertise
291 * BSS Load or if the limit would prevent any connection, this
292 * constraint will be ignored.
294 unsigned int max_bss_load;
296 unsigned int num_req_conn_capab;
297 u8 *req_conn_capab_proto;
298 int **req_conn_capab_port;
301 * ocsp - Whether to use/require OCSP to check server certificate
303 * 0 = do not use OCSP stapling (TLS certificate status extension)
304 * 1 = try to use OCSP stapling, but not require response
305 * 2 = require valid OCSP stapling response
310 * sim_num - User selected SIM identifier
312 * This variable is used for identifying which SIM is used if the system
319 #define CFG_CHANGED_DEVICE_NAME BIT(0)
320 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
321 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
322 #define CFG_CHANGED_OS_VERSION BIT(3)
323 #define CFG_CHANGED_UUID BIT(4)
324 #define CFG_CHANGED_COUNTRY BIT(5)
325 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
326 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
327 #define CFG_CHANGED_WPS_STRING BIT(8)
328 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
329 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
330 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
331 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
332 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
333 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
334 #define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
335 #define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
336 #define CFG_CHANGED_SCHED_SCAN_PLANS BIT(17)
339 * struct wpa_config - wpa_supplicant configuration data
341 * This data structure is presents the per-interface (radio) configuration
342 * data. In many cases, there is only one struct wpa_config instance, but if
343 * more than one network interface is being controlled, one instance is used
348 * ssid - Head of the global network list
350 * This is the head for the list of all the configured networks.
352 struct wpa_ssid *ssid;
355 * pssid - Per-priority network lists (in priority order)
357 struct wpa_ssid **pssid;
360 * num_prio - Number of different priorities used in the pssid lists
362 * This indicates how many per-priority network lists are included in
368 * cred - Head of the credential list
370 * This is the head for the list of all the configured credentials.
372 struct wpa_cred *cred;
375 * eapol_version - IEEE 802.1X/EAPOL version number
377 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
378 * defines EAPOL version 2. However, there are many APs that do not
379 * handle the new version number correctly (they seem to drop the
380 * frames completely). In order to make wpa_supplicant interoperate
381 * with these APs, the version number is set to 1 by default. This
382 * configuration value can be used to set it to the new version (2).
387 * ap_scan - AP scanning/selection
389 * By default, wpa_supplicant requests driver to perform AP
390 * scanning and then uses the scan results to select a
391 * suitable AP. Another alternative is to allow the driver to
392 * take care of AP scanning and selection and use
393 * wpa_supplicant just to process EAPOL frames based on IEEE
394 * 802.11 association information from the driver.
396 * 1: wpa_supplicant initiates scanning and AP selection (default).
398 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
399 * association parameters (e.g., WPA IE generation); this mode can
400 * also be used with non-WPA drivers when using IEEE 802.1X mode;
401 * do not try to associate with APs (i.e., external program needs
402 * to control association). This mode must also be used when using
403 * wired Ethernet drivers.
405 * 2: like 0, but associate with APs using security policy and SSID
406 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
407 * drivers to enable operation with hidden SSIDs and optimized roaming;
408 * in this mode, the network blocks in the configuration are tried
409 * one by one until the driver reports successful association; each
410 * network block should have explicit security policy (i.e., only one
411 * option in the lists) for key_mgmt, pairwise, group, proto variables.
413 * Note: ap_scan=2 should not be used with the nl80211 driver interface
414 * (the current Linux interface). ap_scan=1 is optimized work working
415 * with nl80211. For finding networks using hidden SSID, scan_ssid=1 in
416 * the network block can be used with nl80211.
421 * bgscan - Background scan and roaming parameters or %NULL if none
423 * This is an optional set of parameters for background scanning and
424 * roaming within a network (ESS). For more detailed information see
425 * ssid block documentation.
427 * The variable defines default bgscan behavior for all BSS station
428 * networks except for those which have their own bgscan configuration.
433 * disable_scan_offload - Disable automatic offloading of scan requests
435 * By default, %wpa_supplicant tries to offload scanning if the driver
436 * indicates support for this (sched_scan). This configuration
437 * parameter can be used to disable this offloading mechanism.
439 int disable_scan_offload;
442 * ctrl_interface - Parameters for the control interface
444 * If this is specified, %wpa_supplicant will open a control interface
445 * that is available for external programs to manage %wpa_supplicant.
446 * The meaning of this string depends on which control interface
447 * mechanism is used. For all cases, the existence of this parameter
448 * in configuration is used to determine whether the control interface
451 * For UNIX domain sockets (default on Linux and BSD): This is a
452 * directory that will be created for UNIX domain sockets for listening
453 * to requests from external programs (CLI/GUI, etc.) for status
454 * information and configuration. The socket file will be named based
455 * on the interface name, so multiple %wpa_supplicant processes can be
456 * run at the same time if more than one interface is used.
457 * /var/run/wpa_supplicant is the recommended directory for sockets and
458 * by default, wpa_cli will use it when trying to connect with
461 * Access control for the control interface can be configured
462 * by setting the directory to allow only members of a group
463 * to use sockets. This way, it is possible to run
464 * %wpa_supplicant as root (since it needs to change network
465 * configuration and open raw sockets) and still allow GUI/CLI
466 * components to be run as non-root users. However, since the
467 * control interface can be used to change the network
468 * configuration, this access needs to be protected in many
469 * cases. By default, %wpa_supplicant is configured to use gid
470 * 0 (root). If you want to allow non-root users to use the
471 * control interface, add a new group and change this value to
472 * match with that group. Add users that should have control
473 * interface access to this group.
475 * When configuring both the directory and group, use following format:
476 * DIR=/var/run/wpa_supplicant GROUP=wheel
477 * DIR=/var/run/wpa_supplicant GROUP=0
478 * (group can be either group name or gid)
480 * For UDP connections (default on Windows): The value will be ignored.
481 * This variable is just used to select that the control interface is
482 * to be created. The value can be set to, e.g., udp
483 * (ctrl_interface=udp).
485 * For Windows Named Pipe: This value can be used to set the security
486 * descriptor for controlling access to the control interface. Security
487 * descriptor can be set using Security Descriptor String Format (see
488 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
489 * The descriptor string needs to be prefixed with SDDL=. For example,
490 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
493 char *ctrl_interface;
496 * ctrl_interface_group - Control interface group (DEPRECATED)
498 * This variable is only used for backwards compatibility. Group for
499 * UNIX domain sockets should now be specified using GROUP=group in
500 * ctrl_interface variable.
502 char *ctrl_interface_group;
505 * fast_reauth - EAP fast re-authentication (session resumption)
507 * By default, fast re-authentication is enabled for all EAP methods
508 * that support it. This variable can be used to disable fast
509 * re-authentication (by setting fast_reauth=0). Normally, there is no
510 * need to disable fast re-authentication.
515 * opensc_engine_path - Path to the OpenSSL engine for opensc
517 * This is an OpenSSL specific configuration option for loading OpenSC
518 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
520 char *opensc_engine_path;
523 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
525 * This is an OpenSSL specific configuration option for loading PKCS#11
526 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
528 char *pkcs11_engine_path;
531 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
533 * This is an OpenSSL specific configuration option for configuring
534 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
535 * module is not loaded.
537 char *pkcs11_module_path;
540 * openssl_ciphers - OpenSSL cipher string
542 * This is an OpenSSL specific configuration option for configuring the
543 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
546 char *openssl_ciphers;
549 * pcsc_reader - PC/SC reader name prefix
551 * If not %NULL, PC/SC reader with a name that matches this prefix is
552 * initialized for SIM/USIM access. Empty string can be used to match
553 * the first available reader.
558 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
560 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
561 * EAP-AKA. If left out, this will be asked through control interface.
566 * external_sim - Use external processing for SIM/USIM operations
571 * driver_param - Driver interface parameters
573 * This text string is passed to the selected driver interface with the
574 * optional struct wpa_driver_ops::set_param() handler. This can be
575 * used to configure driver specific options without having to add new
576 * driver interface functionality.
581 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
583 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
584 * cache (unit: seconds).
586 unsigned int dot11RSNAConfigPMKLifetime;
589 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
591 * dot11 MIB variable for the percentage of the PMK lifetime
592 * that should expire before an IEEE 802.1X reauthentication occurs.
594 unsigned int dot11RSNAConfigPMKReauthThreshold;
597 * dot11RSNAConfigSATimeout - Security association timeout
599 * dot11 MIB variable for the maximum time a security association
600 * shall take to set up (unit: seconds).
602 unsigned int dot11RSNAConfigSATimeout;
605 * update_config - Is wpa_supplicant allowed to update configuration
607 * This variable control whether wpa_supplicant is allow to re-write
608 * its configuration with wpa_config_write(). If this is zero,
609 * configuration data is only changed in memory and the external data
610 * is not overriden. If this is non-zero, wpa_supplicant will update
611 * the configuration data (e.g., a file) whenever configuration is
612 * changed. This update may replace the old configuration which can
613 * remove comments from it in case of a text file configuration.
618 * blobs - Configuration blobs
620 struct wpa_config_blob *blobs;
623 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
628 * device_name - Device Name (WPS)
629 * User-friendly description of device; up to 32 octets encoded in
635 * manufacturer - Manufacturer (WPS)
636 * The manufacturer of the device (up to 64 ASCII characters)
641 * model_name - Model Name (WPS)
642 * Model of the device (up to 32 ASCII characters)
647 * model_number - Model Number (WPS)
648 * Additional device description (up to 32 ASCII characters)
653 * serial_number - Serial Number (WPS)
654 * Serial number of the device (up to 32 characters)
659 * device_type - Primary Device Type (WPS)
661 u8 device_type[WPS_DEV_TYPE_LEN];
664 * config_methods - Config Methods
666 * This is a space-separated list of supported WPS configuration
667 * methods. For example, "label virtual_display virtual_push_button
669 * Available methods: usba ethernet label display ext_nfc_token
670 * int_nfc_token nfc_interface push_button keypad
671 * virtual_display physical_display
672 * virtual_push_button physical_push_button.
674 char *config_methods;
677 * os_version - OS Version (WPS)
678 * 4-octet operating system version number
683 * country - Country code
685 * This is the ISO/IEC alpha2 country code for which we are operating
691 * wps_cred_processing - Credential processing
693 * 0 = process received credentials internally
694 * 1 = do not process received credentials; just pass them over
695 * ctrl_iface to external program(s)
696 * 2 = process received credentials internally and pass them over
697 * ctrl_iface to external program(s)
699 int wps_cred_processing;
701 #define MAX_SEC_DEVICE_TYPES 5
703 * sec_device_types - Secondary Device Types (P2P)
705 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
706 int num_sec_device_types;
708 int p2p_listen_reg_class;
709 int p2p_listen_channel;
710 int p2p_oper_reg_class;
711 int p2p_oper_channel;
713 char *p2p_ssid_postfix;
714 int persistent_reconnect;
716 unsigned int num_p2p_pref_chan;
717 struct p2p_channel *p2p_pref_chan;
718 struct wpa_freq_range_list p2p_no_go_freq;
719 int p2p_add_cli_chan;
720 int p2p_ignore_shared_freq;
721 int p2p_optimize_listen_chan;
723 struct wpabuf *wps_vendor_ext_m1;
725 #define MAX_WPS_VENDOR_EXT 10
727 * wps_vendor_ext - Vendor extension attributes in WPS
729 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
732 * p2p_group_idle - Maximum idle time in seconds for P2P group
734 * This value controls how long a P2P group is maintained after there
735 * is no other members in the group. As a GO, this means no associated
736 * stations in the group. As a P2P client, this means no GO seen in
737 * scan results. The maximum idle time is specified in seconds with 0
738 * indicating no time limit, i.e., the P2P group remains in active
739 * state indefinitely until explicitly removed. As a P2P client, the
740 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
741 * this parameter is mainly meant for GO use and for P2P client, it can
742 * only be used to reduce the default timeout to smaller value. A
743 * special value -1 can be used to configure immediate removal of the
744 * group for P2P client role on any disconnection after the data
745 * connection has been established.
750 * p2p_go_freq_change_policy - The GO frequency change policy
752 * This controls the behavior of the GO when there is a change in the
753 * map of the currently used frequencies in case more than one channel
756 * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
757 * possible. In case the GO is the only interface using its frequency
758 * and there are other station interfaces on other frequencies, the GO
759 * will migrate to one of these frequencies.
761 * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
762 * but a transition is possible only in case one of the other used
763 * frequencies is one of the frequencies in the intersection of the
764 * frequency list of the local device and the peer device.
766 * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
768 * @P2P_GO_FREQ_MOVE_SCM_ECSA: Same as
769 * P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS but a transition is possible only
770 * if all the group members advertise eCSA support.
773 P2P_GO_FREQ_MOVE_SCM = 0,
774 P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS = 1,
775 P2P_GO_FREQ_MOVE_STAY = 2,
776 P2P_GO_FREQ_MOVE_SCM_ECSA = 3,
777 P2P_GO_FREQ_MOVE_MAX = P2P_GO_FREQ_MOVE_SCM_ECSA,
778 } p2p_go_freq_change_policy;
780 #define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
783 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
785 * This parameter controls the length of the random passphrase that is
786 * generated at the GO.
788 unsigned int p2p_passphrase_len;
791 * bss_max_count - Maximum number of BSS entries to keep in memory
793 unsigned int bss_max_count;
796 * bss_expiration_age - BSS entry age after which it can be expired
798 * This value controls the time in seconds after which a BSS entry
799 * gets removed if it has not been updated or is not in use.
801 unsigned int bss_expiration_age;
804 * bss_expiration_scan_count - Expire BSS after number of scans
806 * If the BSS entry has not been seen in this many scans, it will be
807 * removed. A value of 1 means that entry is removed after the first
808 * scan in which the BSSID is not seen. Larger values can be used
809 * to avoid BSS entries disappearing if they are not visible in
810 * every scan (e.g., low signal quality or interference).
812 unsigned int bss_expiration_scan_count;
815 * filter_ssids - SSID-based scan result filtering
817 * 0 = do not filter scan results
818 * 1 = only include configured SSIDs in scan results/BSS table
823 * filter_rssi - RSSI-based scan result filtering
825 * 0 = do not filter scan results
826 * -n = filter scan results below -n dBm
831 * max_num_sta - Maximum number of STAs in an AP/P2P GO
833 unsigned int max_num_sta;
836 * freq_list - Array of allowed scan frequencies or %NULL for all
838 * This is an optional zero-terminated array of frequencies in
839 * megahertz (MHz) to allow for narrowing scanning range.
844 * scan_cur_freq - Whether to scan only the current channel
846 * If true, attempt to scan only the current channel if any other
847 * VIFs on this radio are already associated on a particular channel.
852 * changed_parameters - Bitmap of changed parameters since last update
854 unsigned int changed_parameters;
857 * disassoc_low_ack - Disassocicate stations with massive packet loss
859 int disassoc_low_ack;
862 * interworking - Whether Interworking (IEEE 802.11u) is enabled
867 * access_network_type - Access Network Type
869 * When Interworking is enabled, scans will be limited to APs that
870 * advertise the specified Access Network Type (0..15; with 15
871 * indicating wildcard match).
873 int access_network_type;
876 * hessid - Homogenous ESS identifier
878 * If this is set (any octet is non-zero), scans will be used to
879 * request response only from BSSes belonging to the specified
880 * Homogeneous ESS. This is used only if interworking is enabled.
890 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
892 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
893 * by acting as a Registrar and using M1 from the AP. The config
894 * methods attribute in that message is supposed to indicate only the
895 * configuration method supported by the AP in Enrollee role, i.e., to
896 * add an external Registrar. For that case, PBC shall not be used and
897 * as such, the PushButton config method is removed from M1 by default.
898 * If pbc_in_m1=1 is included in the configuration file, the PushButton
899 * config method is left in M1 (if included in config_methods
900 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
901 * a label in the AP).
906 * autoscan - Automatic scan parameters or %NULL if none
908 * This is an optional set of parameters for automatic scanning
909 * within an interface in following format:
910 * <autoscan module name>:<module parameters>
915 * wps_nfc_pw_from_config - NFC Device Password was read from config
917 * This parameter can be determined whether the NFC Device Password was
918 * included in the configuration (1) or generated dynamically (0). Only
919 * the former case is re-written back to the configuration file.
921 int wps_nfc_pw_from_config;
924 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
926 int wps_nfc_dev_pw_id;
929 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
931 struct wpabuf *wps_nfc_dh_pubkey;
934 * wps_nfc_dh_privkey - NFC DH Private Key for password token
936 struct wpabuf *wps_nfc_dh_privkey;
939 * wps_nfc_dev_pw - NFC Device Password for password token
941 struct wpabuf *wps_nfc_dev_pw;
944 * ext_password_backend - External password backend or %NULL if none
946 * format: <backend name>[:<optional backend parameters>]
948 char *ext_password_backend;
951 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
953 * This timeout value is used in P2P GO mode to clean up
955 * By default: 300 seconds.
957 int p2p_go_max_inactivity;
959 struct hostapd_wmm_ac_params wmm_ac_params[4];
962 * auto_interworking - Whether to use network selection automatically
964 * 0 = do not automatically go through Interworking network selection
965 * (i.e., require explicit interworking_select command for this)
966 * 1 = perform Interworking network selection if one or more
967 * credentials have been configured and scan did not find a
968 * matching network block
970 int auto_interworking;
973 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
975 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
976 * Note that regulatory constraints and driver capabilities are
977 * consulted anyway, so setting it to 1 can't do real harm.
978 * By default: 0 (disabled)
983 * p2p_go_vht - Default mode for VHT enable when operating as GO
985 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
986 * Note that regulatory constraints and driver capabilities are
987 * consulted anyway, so setting it to 1 can't do real harm.
988 * By default: 0 (disabled)
993 * p2p_go_ctwindow - CTWindow to use when operating as GO
995 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
996 * the length of the CTWindow in TUs.
1001 * p2p_disabled - Whether P2P operations are disabled for this interface
1006 * p2p_no_group_iface - Whether group interfaces can be used
1008 * By default, wpa_supplicant will create a separate interface for P2P
1009 * group operations if the driver supports this. This functionality can
1010 * be disabled by setting this parameter to 1. In that case, the same
1011 * interface that was used for the P2P management operations is used
1012 * also for the group operation.
1014 int p2p_no_group_iface;
1017 * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1019 * If this parameter is set to 1, a connected P2P Client will receive
1020 * and handle Probe Request frames. Setting this parameter to 0
1021 * disables this option. Default value: 0.
1023 * Note: Setting this property at run time takes effect on the following
1024 * interface state transition to/from the WPA_COMPLETED state.
1029 * okc - Whether to enable opportunistic key caching by default
1031 * By default, OKC is disabled unless enabled by the per-network
1032 * proactive_key_caching=1 parameter. okc=1 can be used to change this
1038 * pmf - Whether to enable/require PMF by default
1040 * By default, PMF is disabled unless enabled by the per-network
1041 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
1042 * this default behavior for RSN network (this is not applicable for
1045 enum mfp_options pmf;
1048 * sae_groups - Preference list of enabled groups for SAE
1050 * By default (if this parameter is not set), the mandatory group 19
1051 * (ECC group defined over a 256-bit prime order field) is preferred,
1052 * but other groups are also enabled. If this parameter is set, the
1053 * groups will be tried in the indicated order.
1058 * dtim_period - Default DTIM period in Beacon intervals
1060 * This parameter can be used to set the default value for network
1061 * blocks that do not specify dtim_period.
1066 * beacon_int - Default Beacon interval in TU
1068 * This parameter can be used to set the default value for network
1069 * blocks that do not specify beacon_int.
1074 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1076 * This parameter can be used to define additional vendor specific
1077 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1078 * format for these element(s) is a hexdump of the raw information
1079 * elements (id+len+payload for one or more elements).
1081 struct wpabuf *ap_vendor_elements;
1084 * ignore_old_scan_res - Ignore scan results older than request
1086 * The driver may have a cache of scan results that makes it return
1087 * information that is older than our scan trigger. This parameter can
1088 * be used to configure such old information to be ignored instead of
1089 * allowing it to update the internal BSS table.
1091 int ignore_old_scan_res;
1094 * sched_scan_interval - schedule scan interval
1096 unsigned int sched_scan_interval;
1099 * tdls_external_control - External control for TDLS setup requests
1101 * Enable TDLS mode where external programs are given the control
1102 * to specify the TDLS link to get established to the driver. The
1103 * driver requests the TDLS setup to the supplicant only for the
1104 * specified TDLS peers.
1106 int tdls_external_control;
1110 u8 ip_addr_start[4];
1114 * osu_dir - OSU provider information directory
1116 * If set, allow FETCH_OSU control interface command to be used to fetch
1117 * OSU provider information into all APs and store the results in this
1123 * wowlan_triggers - Wake-on-WLAN triggers
1125 * If set, these wowlan triggers will be configured.
1127 char *wowlan_triggers;
1130 * p2p_search_delay - Extra delay between concurrent search iterations
1132 * Add extra delay (in milliseconds) between search iterations when
1133 * there is a concurrent operation to make p2p_find friendlier to
1134 * concurrent operations by avoiding it from taking 100% of radio
1137 unsigned int p2p_search_delay;
1140 * mac_addr - MAC address policy default
1142 * 0 = use permanent MAC address
1143 * 1 = use random MAC address for each ESS connection
1144 * 2 = like 1, but maintain OUI (with local admin bit set)
1146 * By default, permanent MAC address is used unless policy is changed by
1147 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1148 * change this default behavior.
1153 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1155 unsigned int rand_addr_lifetime;
1158 * preassoc_mac_addr - Pre-association MAC address policy
1160 * 0 = use permanent MAC address
1161 * 1 = use random MAC address
1162 * 2 = like 1, but maintain OUI (with local admin bit set)
1164 int preassoc_mac_addr;
1167 * key_mgmt_offload - Use key management offload
1169 * Key management offload should be used if the device supports it.
1170 * Key management offload is the capability of a device operating as
1171 * a station to do the exchange necessary to establish temporal keys
1172 * during initial RSN connection, after roaming, or during a PTK
1173 * rekeying operation.
1175 int key_mgmt_offload;
1178 * user_mpm - MPM residency
1180 * 0: MPM lives in driver.
1181 * 1: wpa_supplicant handles peering and station allocation.
1183 * If AMPE or SAE is enabled, the MPM is always in userspace.
1188 * max_peer_links - Maximum number of peer links
1190 * Maximum number of mesh peering currently maintained by the STA.
1195 * cert_in_cb - Whether to include a peer certificate dump in events
1197 * This controls whether peer certificates for authentication server and
1198 * its certificate chain are included in EAP peer certificate events.
1203 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1205 * This timeout value is used in mesh STA to clean up inactive stations.
1206 * By default: 300 seconds.
1208 int mesh_max_inactivity;
1211 * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1213 * This timeout value is used in mesh STA to retransmit
1214 * SAE Authentication frame.
1215 * By default: 1000 milliseconds.
1217 int dot11RSNASAERetransPeriod;
1220 * passive_scan - Whether to force passive scan for network connection
1222 * This parameter can be used to force only passive scanning to be used
1223 * for network connection cases. It should be noted that this will slow
1224 * down scan operations and reduce likelihood of finding the AP. In
1225 * addition, some use cases will override this due to functional
1226 * requirements, e.g., for finding an AP that uses hidden SSID
1227 * (scan_ssid=1) or P2P device discovery.
1232 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1234 int reassoc_same_bss_optim;
1237 * wps_priority - Priority for the networks added through WPS
1239 * This priority value will be set to each network profile that is added
1240 * by executing the WPS protocol.
1245 * fst_group_id - FST group ID
1250 * fst_priority - priority of the interface within the FST group
1255 * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1261 * wpa_rsc_relaxation - RSC relaxation on GTK installation
1264 * 0 - use the EAPOL-Key RSC value on GTK installation
1265 * 1 - use the null RSC if a bogus RSC value is detected in message 3
1266 * of 4-Way Handshake or message 1 of Group Key Handshake.
1268 int wpa_rsc_relaxation;
1271 * sched_scan_plans - Scan plans for scheduled scan
1273 * Each scan plan specifies the interval between scans and the number of
1274 * iterations. The last scan plan only specifies the scan interval and
1275 * will be run infinitely.
1277 * format: <interval:iterations> <interval2:iterations2> ... <interval>
1279 char *sched_scan_plans;
1283 * non_pref_chan - Non-preferred channels list, separated by spaces.
1285 * format: op_class:chan:preference:reason<:detail>
1286 * Detail is optional.
1288 char *non_pref_chan;
1291 * mbo_cell_capa - Cellular capabilities for MBO
1293 enum mbo_cellular_capa mbo_cell_capa;
1294 #endif /* CONFIG_MBO */
1297 * gas_address3 - GAS Address3 field behavior
1300 * 0 - P2P specification (Address3 = AP BSSID)
1301 * 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
1302 * sent to not-associated AP; if associated, AP BSSID)
1308 /* Prototypes for common functions from config.c */
1310 void wpa_config_free(struct wpa_config *ssid);
1311 void wpa_config_free_ssid(struct wpa_ssid *ssid);
1312 void wpa_config_foreach_network(struct wpa_config *config,
1313 void (*func)(void *, struct wpa_ssid *),
1315 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1316 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1317 int wpa_config_remove_network(struct wpa_config *config, int id);
1318 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1319 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1321 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1323 int wpa_config_dump_values(struct wpa_config *config, char *buf,
1325 int wpa_config_get_value(const char *name, struct wpa_config *config,
1326 char *buf, size_t buflen);
1328 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1329 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1330 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1331 void wpa_config_update_psk(struct wpa_ssid *ssid);
1332 int wpa_config_add_prio_network(struct wpa_config *config,
1333 struct wpa_ssid *ssid);
1334 int wpa_config_update_prio_list(struct wpa_config *config);
1335 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1337 void wpa_config_set_blob(struct wpa_config *config,
1338 struct wpa_config_blob *blob);
1339 void wpa_config_free_blob(struct wpa_config_blob *blob);
1340 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
1341 void wpa_config_flush_blobs(struct wpa_config *config);
1343 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1344 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1345 int wpa_config_remove_cred(struct wpa_config *config, int id);
1346 void wpa_config_free_cred(struct wpa_cred *cred);
1347 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1348 const char *value, int line);
1349 char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
1351 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1352 const char *driver_param);
1353 #ifndef CONFIG_NO_STDOUT_DEBUG
1354 void wpa_config_debug_dump_networks(struct wpa_config *config);
1355 #else /* CONFIG_NO_STDOUT_DEBUG */
1356 #define wpa_config_debug_dump_networks(c) do { } while (0)
1357 #endif /* CONFIG_NO_STDOUT_DEBUG */
1360 /* Prototypes for common functions from config.c */
1361 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1363 int wpa_config_get_num_global_field_names(void);
1365 const char * wpa_config_get_global_field_name(unsigned int i, int *no_var);
1367 /* Prototypes for backend specific functions from the selected config_*.c */
1370 * wpa_config_read - Read and parse configuration database
1371 * @name: Name of the configuration (e.g., path and file name for the
1372 * configuration file)
1373 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
1374 * Returns: Pointer to allocated configuration data or %NULL on failure
1376 * This function reads configuration data, parses its contents, and allocates
1377 * data structures needed for storing configuration information. The allocated
1378 * data can be freed with wpa_config_free().
1380 * Each configuration backend needs to implement this function.
1382 struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
1385 * wpa_config_write - Write or update configuration data
1386 * @name: Name of the configuration (e.g., path and file name for the
1387 * configuration file)
1388 * @config: Configuration data from wpa_config_read()
1389 * Returns: 0 on success, -1 on failure
1391 * This function write all configuration data into an external database (e.g.,
1392 * a text file) in a format that can be read with wpa_config_read(). This can
1393 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1394 * new network is added or a password is changed.
1396 * Each configuration backend needs to implement this function.
1398 int wpa_config_write(const char *name, struct wpa_config *config);
1400 #endif /* CONFIG_H */