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_AP_ISOLATE 0
36 #define DEFAULT_ACCESS_NETWORK_TYPE 15
37 #define DEFAULT_SCAN_CUR_FREQ 0
38 #define DEFAULT_P2P_SEARCH_DELAY 500
39 #define DEFAULT_RAND_ADDR_LIFETIME 60
40 #define DEFAULT_KEY_MGMT_OFFLOAD 1
41 #define DEFAULT_CERT_IN_CB 1
42 #define DEFAULT_P2P_GO_CTWINDOW 0
43 #define DEFAULT_WPA_RSC_RELAXATION 1
44 #define DEFAULT_MBO_CELL_CAPA MBO_CELL_CAPA_NOT_SUPPORTED
45 #define DEFAULT_DISASSOC_IMMINENT_RSSI_THRESHOLD -75
46 #define DEFAULT_OCE_SUPPORT OCE_STA
48 #include "config_ssid.h"
50 #include "common/ieee802_11_defs.h"
51 #include "common/ieee802_11_common.h"
54 #define MAX_ROAMING_CONS 36
55 #define MAX_ROAMING_CONS_OI_LEN 15
59 * next - Next credential in the list
61 * This pointer can be used to iterate over all credentials. The head
62 * of this list is stored in the cred field of struct wpa_config.
64 struct wpa_cred
*next
;
67 * id - Unique id for the credential
69 * This identifier is used as a unique identifier for each credential
70 * block when using the control interface. Each credential is allocated
71 * an id when it is being created, either when reading the
72 * configuration file or when a new credential is added through the
78 * temporary - Whether this credential is temporary and not to be saved
83 * priority - Priority group
85 * By default, all networks and credentials get the same priority group
86 * (0). This field can be used to give higher priority for credentials
87 * (and similarly in struct wpa_ssid for network blocks) to change the
88 * Interworking automatic networking selection behavior. The matching
89 * network (based on either an enabled network block or a credential)
90 * with the highest priority value will be selected.
95 * pcsc - Use PC/SC and SIM/USIM card
100 * realm - Home Realm for Interworking
105 * username - Username for Interworking network selection
110 * password - Password for Interworking network selection
115 * ext_password - Whether password is a name for external storage
120 * ca_cert - CA certificate for Interworking network selection
125 * client_cert - File path to client certificate file (PEM/DER)
127 * This field is used with Interworking networking selection for a case
128 * where client certificate/private key is used for authentication
129 * (EAP-TLS). Full path to the file should be used since working
130 * directory may change when wpa_supplicant is run in the background.
132 * Alternatively, a named configuration blob can be used by setting
133 * this to blob://blob_name.
138 * private_key - File path to client private key file (PEM/DER/PFX)
140 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
141 * commented out. Both the private key and certificate will be read
142 * from the PKCS#12 file in this case. Full path to the file should be
143 * used since working directory may change when wpa_supplicant is run
146 * Windows certificate store can be used by leaving client_cert out and
147 * configuring private_key in one of the following formats:
149 * cert://substring_to_match
151 * hash://certificate_thumbprint_in_hex
153 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
155 * Note that when running wpa_supplicant as an application, the user
156 * certificate store (My user account) is used, whereas computer store
157 * (Computer account) is used when running wpasvc as a service.
159 * Alternatively, a named configuration blob can be used by setting
160 * this to blob://blob_name.
165 * private_key_passwd - Password for private key file
167 char *private_key_passwd
;
170 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
175 * milenage - Milenage parameters for SIM/USIM simulator in
176 * <Ki>:<OPc>:<SQN> format
181 * domain_suffix_match - Constraint for server domain name
183 * If set, this FQDN is used as a suffix match requirement for the AAA
184 * server certificate in SubjectAltName dNSName element(s). If a
185 * matching dNSName is found, this constraint is met. If no dNSName
186 * values are present, this constraint is matched against SubjectName CN
187 * using same suffix match comparison. Suffix match here means that the
188 * host/domain name is compared one label at a time starting from the
189 * top-level domain and all the labels in @domain_suffix_match shall be
190 * included in the certificate. The certificate may include additional
191 * sub-level labels in addition to the required labels.
193 * For example, domain_suffix_match=example.com would match
194 * test.example.com but would not match test-example.com.
196 char *domain_suffix_match
;
199 * domain - Home service provider FQDN(s)
201 * This is used to compare against the Domain Name List to figure out
202 * whether the AP is operated by the Home SP. Multiple domain entries
203 * can be used to configure alternative FQDNs that will be considered
209 * num_domain - Number of FQDNs in the domain array
214 * roaming_consortium - Roaming Consortium OI
216 * If roaming_consortium_len is non-zero, this field contains the
217 * Roaming Consortium OI that can be used to determine which access
218 * points support authentication with this credential. This is an
219 * alternative to the use of the realm parameter. When using Roaming
220 * Consortium to match the network, the EAP parameters need to be
221 * pre-configured with the credential since the NAI Realm information
222 * may not be available or fetched.
224 u8 roaming_consortium
[15];
227 * roaming_consortium_len - Length of roaming_consortium
229 size_t roaming_consortium_len
;
232 * required_roaming_consortium - Required Roaming Consortium OI
234 * If required_roaming_consortium_len is non-zero, this field contains
235 * the Roaming Consortium OI that is required to be advertised by the AP
236 * for the credential to be considered matching.
238 u8 required_roaming_consortium
[15];
241 * required_roaming_consortium_len - Length of required_roaming_consortium
243 size_t required_roaming_consortium_len
;
246 * roaming_consortiums - Roaming Consortium OI(s) memberships
248 * This field contains one or more OIs identifying the roaming
249 * consortiums of which the provider is a member. The list is sorted
250 * from the most preferred one to the least preferred one. A match
251 * between the Roaming Consortium OIs advertised by an AP and the OIs
252 * in this list indicates that successful authentication is possible.
253 * (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
255 u8 roaming_consortiums
[MAX_ROAMING_CONS
][MAX_ROAMING_CONS_OI_LEN
];
258 * roaming_consortiums_len - Length on roaming_consortiums[i]
260 size_t roaming_consortiums_len
[MAX_ROAMING_CONS
];
263 * num_roaming_consortiums - Number of entries in roaming_consortiums
265 unsigned int num_roaming_consortiums
;
268 * eap_method - EAP method to use
270 * Pre-configured EAP method to use with this credential or %NULL to
271 * indicate no EAP method is selected, i.e., the method will be
272 * selected automatically based on ANQP information.
274 struct eap_method_type
*eap_method
;
277 * phase1 - Phase 1 (outer authentication) parameters
279 * Pre-configured EAP parameters or %NULL.
284 * phase2 - Phase 2 (inner authentication) parameters
286 * Pre-configured EAP parameters or %NULL.
290 struct excluded_ssid
{
291 u8 ssid
[SSID_MAX_LEN
];
294 size_t num_excluded_ssid
;
296 struct roaming_partner
{
302 size_t num_roaming_partner
;
304 int update_identifier
;
307 * provisioning_sp - FQDN of the SP that provisioned the credential
309 char *provisioning_sp
;
312 * sp_priority - Credential priority within a provisioning SP
314 * This is the priority of the credential among all credentials
315 * provisionined by the same SP (i.e., for entries that have identical
316 * provisioning_sp value). The range of this priority is 0-255 with 0
317 * being the highest and 255 the lower priority.
321 unsigned int min_dl_bandwidth_home
;
322 unsigned int min_ul_bandwidth_home
;
323 unsigned int min_dl_bandwidth_roaming
;
324 unsigned int min_ul_bandwidth_roaming
;
327 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
328 * This value is used as the maximum channel utilization for network
329 * selection purposes for home networks. If the AP does not advertise
330 * BSS Load or if the limit would prevent any connection, this
331 * constraint will be ignored.
333 unsigned int max_bss_load
;
335 unsigned int num_req_conn_capab
;
336 u8
*req_conn_capab_proto
;
337 int **req_conn_capab_port
;
340 * ocsp - Whether to use/require OCSP to check server certificate
342 * 0 = do not use OCSP stapling (TLS certificate status extension)
343 * 1 = try to use OCSP stapling, but not require response
344 * 2 = require valid OCSP stapling response
349 * sim_num - User selected SIM identifier
351 * This variable is used for identifying which SIM is used if the system
358 #define CFG_CHANGED_DEVICE_NAME BIT(0)
359 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
360 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
361 #define CFG_CHANGED_OS_VERSION BIT(3)
362 #define CFG_CHANGED_UUID BIT(4)
363 #define CFG_CHANGED_COUNTRY BIT(5)
364 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
365 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
366 #define CFG_CHANGED_WPS_STRING BIT(8)
367 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
368 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
369 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
370 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
371 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
372 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
373 #define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
374 #define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
375 #define CFG_CHANGED_SCHED_SCAN_PLANS BIT(17)
376 #define CFG_CHANGED_WOWLAN_TRIGGERS BIT(18)
379 * struct wpa_config - wpa_supplicant configuration data
381 * This data structure is presents the per-interface (radio) configuration
382 * data. In many cases, there is only one struct wpa_config instance, but if
383 * more than one network interface is being controlled, one instance is used
388 * ssid - Head of the global network list
390 * This is the head for the list of all the configured networks.
392 struct wpa_ssid
*ssid
;
395 * pssid - Per-priority network lists (in priority order)
397 struct wpa_ssid
**pssid
;
400 * num_prio - Number of different priorities used in the pssid lists
402 * This indicates how many per-priority network lists are included in
408 * cred - Head of the credential list
410 * This is the head for the list of all the configured credentials.
412 struct wpa_cred
*cred
;
415 * eapol_version - IEEE 802.1X/EAPOL version number
417 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
418 * defines EAPOL version 2. However, there are many APs that do not
419 * handle the new version number correctly (they seem to drop the
420 * frames completely). In order to make wpa_supplicant interoperate
421 * with these APs, the version number is set to 1 by default. This
422 * configuration value can be used to set it to the new version (2).
427 * ap_scan - AP scanning/selection
429 * By default, wpa_supplicant requests driver to perform AP
430 * scanning and then uses the scan results to select a
431 * suitable AP. Another alternative is to allow the driver to
432 * take care of AP scanning and selection and use
433 * wpa_supplicant just to process EAPOL frames based on IEEE
434 * 802.11 association information from the driver.
436 * 1: wpa_supplicant initiates scanning and AP selection (default).
438 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
439 * association parameters (e.g., WPA IE generation); this mode can
440 * also be used with non-WPA drivers when using IEEE 802.1X mode;
441 * do not try to associate with APs (i.e., external program needs
442 * to control association). This mode must also be used when using
443 * wired Ethernet drivers.
445 * 2: like 0, but associate with APs using security policy and SSID
446 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
447 * drivers to enable operation with hidden SSIDs and optimized roaming;
448 * in this mode, the network blocks in the configuration are tried
449 * one by one until the driver reports successful association; each
450 * network block should have explicit security policy (i.e., only one
451 * option in the lists) for key_mgmt, pairwise, group, proto variables.
453 * Note: ap_scan=2 should not be used with the nl80211 driver interface
454 * (the current Linux interface). ap_scan=1 is optimized work working
455 * with nl80211. For finding networks using hidden SSID, scan_ssid=1 in
456 * the network block can be used with nl80211.
461 * bgscan - Background scan and roaming parameters or %NULL if none
463 * This is an optional set of parameters for background scanning and
464 * roaming within a network (ESS). For more detailed information see
465 * ssid block documentation.
467 * The variable defines default bgscan behavior for all BSS station
468 * networks except for those which have their own bgscan configuration.
473 * disable_scan_offload - Disable automatic offloading of scan requests
475 * By default, %wpa_supplicant tries to offload scanning if the driver
476 * indicates support for this (sched_scan). This configuration
477 * parameter can be used to disable this offloading mechanism.
479 int disable_scan_offload
;
482 * ctrl_interface - Parameters for the control interface
484 * If this is specified, %wpa_supplicant will open a control interface
485 * that is available for external programs to manage %wpa_supplicant.
486 * The meaning of this string depends on which control interface
487 * mechanism is used. For all cases, the existence of this parameter
488 * in configuration is used to determine whether the control interface
491 * For UNIX domain sockets (default on Linux and BSD): This is a
492 * directory that will be created for UNIX domain sockets for listening
493 * to requests from external programs (CLI/GUI, etc.) for status
494 * information and configuration. The socket file will be named based
495 * on the interface name, so multiple %wpa_supplicant processes can be
496 * run at the same time if more than one interface is used.
497 * /var/run/wpa_supplicant is the recommended directory for sockets and
498 * by default, wpa_cli will use it when trying to connect with
501 * Access control for the control interface can be configured
502 * by setting the directory to allow only members of a group
503 * to use sockets. This way, it is possible to run
504 * %wpa_supplicant as root (since it needs to change network
505 * configuration and open raw sockets) and still allow GUI/CLI
506 * components to be run as non-root users. However, since the
507 * control interface can be used to change the network
508 * configuration, this access needs to be protected in many
509 * cases. By default, %wpa_supplicant is configured to use gid
510 * 0 (root). If you want to allow non-root users to use the
511 * control interface, add a new group and change this value to
512 * match with that group. Add users that should have control
513 * interface access to this group.
515 * When configuring both the directory and group, use following format:
516 * DIR=/var/run/wpa_supplicant GROUP=wheel
517 * DIR=/var/run/wpa_supplicant GROUP=0
518 * (group can be either group name or gid)
520 * For UDP connections (default on Windows): The value will be ignored.
521 * This variable is just used to select that the control interface is
522 * to be created. The value can be set to, e.g., udp
523 * (ctrl_interface=udp).
525 * For Windows Named Pipe: This value can be used to set the security
526 * descriptor for controlling access to the control interface. Security
527 * descriptor can be set using Security Descriptor String Format (see
528 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
529 * The descriptor string needs to be prefixed with SDDL=. For example,
530 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
533 char *ctrl_interface
;
536 * ctrl_interface_group - Control interface group (DEPRECATED)
538 * This variable is only used for backwards compatibility. Group for
539 * UNIX domain sockets should now be specified using GROUP=group in
540 * ctrl_interface variable.
542 char *ctrl_interface_group
;
545 * fast_reauth - EAP fast re-authentication (session resumption)
547 * By default, fast re-authentication is enabled for all EAP methods
548 * that support it. This variable can be used to disable fast
549 * re-authentication (by setting fast_reauth=0). Normally, there is no
550 * need to disable fast re-authentication.
555 * opensc_engine_path - Path to the OpenSSL engine for opensc
557 * This is an OpenSSL specific configuration option for loading OpenSC
558 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
560 char *opensc_engine_path
;
563 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
565 * This is an OpenSSL specific configuration option for loading PKCS#11
566 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
568 char *pkcs11_engine_path
;
571 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
573 * This is an OpenSSL specific configuration option for configuring
574 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
575 * module is not loaded.
577 char *pkcs11_module_path
;
580 * openssl_ciphers - OpenSSL cipher string
582 * This is an OpenSSL specific configuration option for configuring the
583 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
586 char *openssl_ciphers
;
589 * pcsc_reader - PC/SC reader name prefix
591 * If not %NULL, PC/SC reader with a name that matches this prefix is
592 * initialized for SIM/USIM access. Empty string can be used to match
593 * the first available reader.
598 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
600 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
601 * EAP-AKA. If left out, this will be asked through control interface.
606 * external_sim - Use external processing for SIM/USIM operations
611 * driver_param - Driver interface parameters
613 * This text string is passed to the selected driver interface with the
614 * optional struct wpa_driver_ops::set_param() handler. This can be
615 * used to configure driver specific options without having to add new
616 * driver interface functionality.
621 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
623 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
624 * cache (unit: seconds).
626 unsigned int dot11RSNAConfigPMKLifetime
;
629 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
631 * dot11 MIB variable for the percentage of the PMK lifetime
632 * that should expire before an IEEE 802.1X reauthentication occurs.
634 unsigned int dot11RSNAConfigPMKReauthThreshold
;
637 * dot11RSNAConfigSATimeout - Security association timeout
639 * dot11 MIB variable for the maximum time a security association
640 * shall take to set up (unit: seconds).
642 unsigned int dot11RSNAConfigSATimeout
;
645 * update_config - Is wpa_supplicant allowed to update configuration
647 * This variable control whether wpa_supplicant is allow to re-write
648 * its configuration with wpa_config_write(). If this is zero,
649 * configuration data is only changed in memory and the external data
650 * is not overriden. If this is non-zero, wpa_supplicant will update
651 * the configuration data (e.g., a file) whenever configuration is
652 * changed. This update may replace the old configuration which can
653 * remove comments from it in case of a text file configuration.
658 * blobs - Configuration blobs
660 struct wpa_config_blob
*blobs
;
663 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
668 * auto_uuid - Automatic UUID behavior
669 * 0 = generate static value based on the local MAC address (default)
670 * 1 = generate a random UUID every time wpa_supplicant starts
675 * device_name - Device Name (WPS)
676 * User-friendly description of device; up to 32 octets encoded in
682 * manufacturer - Manufacturer (WPS)
683 * The manufacturer of the device (up to 64 ASCII characters)
688 * model_name - Model Name (WPS)
689 * Model of the device (up to 32 ASCII characters)
694 * model_number - Model Number (WPS)
695 * Additional device description (up to 32 ASCII characters)
700 * serial_number - Serial Number (WPS)
701 * Serial number of the device (up to 32 characters)
706 * device_type - Primary Device Type (WPS)
708 u8 device_type
[WPS_DEV_TYPE_LEN
];
711 * config_methods - Config Methods
713 * This is a space-separated list of supported WPS configuration
714 * methods. For example, "label virtual_display virtual_push_button
716 * Available methods: usba ethernet label display ext_nfc_token
717 * int_nfc_token nfc_interface push_button keypad
718 * virtual_display physical_display
719 * virtual_push_button physical_push_button.
721 char *config_methods
;
724 * os_version - OS Version (WPS)
725 * 4-octet operating system version number
730 * country - Country code
732 * This is the ISO/IEC alpha2 country code for which we are operating
738 * wps_cred_processing - Credential processing
740 * 0 = process received credentials internally
741 * 1 = do not process received credentials; just pass them over
742 * ctrl_iface to external program(s)
743 * 2 = process received credentials internally and pass them over
744 * ctrl_iface to external program(s)
746 int wps_cred_processing
;
749 * wps_cred_add_sae - Whether to enable SAE automatically for WPS
751 * 0 = only add the explicitly listed WPA2-PSK configuration
752 * 1 = add both the WPA2-PSK and SAE configuration and enable PMF so
753 * that the station gets configured in WPA3-Personal transition mode
754 * (supports both WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
756 int wps_cred_add_sae
;
758 #define MAX_SEC_DEVICE_TYPES 5
760 * sec_device_types - Secondary Device Types (P2P)
762 u8 sec_device_type
[MAX_SEC_DEVICE_TYPES
][WPS_DEV_TYPE_LEN
];
763 int num_sec_device_types
;
765 int p2p_listen_reg_class
;
766 int p2p_listen_channel
;
767 int p2p_oper_reg_class
;
768 int p2p_oper_channel
;
770 char *p2p_ssid_postfix
;
771 int persistent_reconnect
;
773 unsigned int num_p2p_pref_chan
;
774 struct p2p_channel
*p2p_pref_chan
;
775 struct wpa_freq_range_list p2p_no_go_freq
;
776 int p2p_add_cli_chan
;
777 int p2p_ignore_shared_freq
;
778 int p2p_optimize_listen_chan
;
780 struct wpabuf
*wps_vendor_ext_m1
;
782 #define MAX_WPS_VENDOR_EXT 10
784 * wps_vendor_ext - Vendor extension attributes in WPS
786 struct wpabuf
*wps_vendor_ext
[MAX_WPS_VENDOR_EXT
];
789 * p2p_group_idle - Maximum idle time in seconds for P2P group
791 * This value controls how long a P2P group is maintained after there
792 * is no other members in the group. As a GO, this means no associated
793 * stations in the group. As a P2P client, this means no GO seen in
794 * scan results. The maximum idle time is specified in seconds with 0
795 * indicating no time limit, i.e., the P2P group remains in active
796 * state indefinitely until explicitly removed. As a P2P client, the
797 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
798 * this parameter is mainly meant for GO use and for P2P client, it can
799 * only be used to reduce the default timeout to smaller value. A
800 * special value -1 can be used to configure immediate removal of the
801 * group for P2P client role on any disconnection after the data
802 * connection has been established.
807 * p2p_go_freq_change_policy - The GO frequency change policy
809 * This controls the behavior of the GO when there is a change in the
810 * map of the currently used frequencies in case more than one channel
813 * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
814 * possible. In case the GO is the only interface using its frequency
815 * and there are other station interfaces on other frequencies, the GO
816 * will migrate to one of these frequencies.
818 * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
819 * but a transition is possible only in case one of the other used
820 * frequencies is one of the frequencies in the intersection of the
821 * frequency list of the local device and the peer device.
823 * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
825 * @P2P_GO_FREQ_MOVE_SCM_ECSA: Same as
826 * P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS but a transition is possible only
827 * if all the group members advertise eCSA support.
830 P2P_GO_FREQ_MOVE_SCM
= 0,
831 P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS
= 1,
832 P2P_GO_FREQ_MOVE_STAY
= 2,
833 P2P_GO_FREQ_MOVE_SCM_ECSA
= 3,
834 P2P_GO_FREQ_MOVE_MAX
= P2P_GO_FREQ_MOVE_SCM_ECSA
,
835 } p2p_go_freq_change_policy
;
837 #define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
840 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
842 * This parameter controls the length of the random passphrase that is
843 * generated at the GO.
845 unsigned int p2p_passphrase_len
;
848 * bss_max_count - Maximum number of BSS entries to keep in memory
850 unsigned int bss_max_count
;
853 * bss_expiration_age - BSS entry age after which it can be expired
855 * This value controls the time in seconds after which a BSS entry
856 * gets removed if it has not been updated or is not in use.
858 unsigned int bss_expiration_age
;
861 * bss_expiration_scan_count - Expire BSS after number of scans
863 * If the BSS entry has not been seen in this many scans, it will be
864 * removed. A value of 1 means that entry is removed after the first
865 * scan in which the BSSID is not seen. Larger values can be used
866 * to avoid BSS entries disappearing if they are not visible in
867 * every scan (e.g., low signal quality or interference).
869 unsigned int bss_expiration_scan_count
;
872 * filter_ssids - SSID-based scan result filtering
874 * 0 = do not filter scan results
875 * 1 = only include configured SSIDs in scan results/BSS table
880 * filter_rssi - RSSI-based scan result filtering
882 * 0 = do not filter scan results
883 * -n = filter scan results below -n dBm
888 * max_num_sta - Maximum number of STAs in an AP/P2P GO
890 unsigned int max_num_sta
;
893 * ap_isolate - Whether to use client isolation feature
895 * Client isolation can be used to prevent low-level bridging of
896 * frames between associated stations in the BSS. By default,
897 * this bridging is allowed (ap_isolate=0); except in P2P GO case,
898 * where p2p_intra_bss parameter is used to determine whether to allow
899 * intra-BSS forwarding (ap_isolate = !p2p_intra_bss).
901 * 0 = do not enable AP isolation
902 * 1 = enable AP isolation
907 * freq_list - Array of allowed scan frequencies or %NULL for all
909 * This is an optional zero-terminated array of frequencies in
910 * megahertz (MHz) to allow for narrowing scanning range.
915 * scan_cur_freq - Whether to scan only the current channel
917 * If true, attempt to scan only the current channel if any other
918 * VIFs on this radio are already associated on a particular channel.
923 * changed_parameters - Bitmap of changed parameters since last update
925 unsigned int changed_parameters
;
928 * disassoc_low_ack - Disassociate stations with massive packet loss
930 int disassoc_low_ack
;
933 * interworking - Whether Interworking (IEEE 802.11u) is enabled
938 * access_network_type - Access Network Type
940 * When Interworking is enabled, scans will be limited to APs that
941 * advertise the specified Access Network Type (0..15; with 15
942 * indicating wildcard match).
944 int access_network_type
;
947 * go_interworking - Whether Interworking for P2P GO is enabled
952 * go_access_network_type - P2P GO Access Network Type
954 * This indicates which access network type to advertise if Interworking
955 * is enabled for P2P GO.
957 int go_access_network_type
;
960 * go_internet - Interworking: Internet connectivity (0 or 1)
965 * go_venue_group - Interworking: Venue group
970 * go_venue_type: Interworking: Venue type
975 * hessid - Homogenous ESS identifier
977 * If this is set (any octet is non-zero), scans will be used to
978 * request response only from BSSes belonging to the specified
979 * Homogeneous ESS. This is used only if interworking is enabled.
989 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
991 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
992 * by acting as a Registrar and using M1 from the AP. The config
993 * methods attribute in that message is supposed to indicate only the
994 * configuration method supported by the AP in Enrollee role, i.e., to
995 * add an external Registrar. For that case, PBC shall not be used and
996 * as such, the PushButton config method is removed from M1 by default.
997 * If pbc_in_m1=1 is included in the configuration file, the PushButton
998 * config method is left in M1 (if included in config_methods
999 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
1000 * a label in the AP).
1005 * autoscan - Automatic scan parameters or %NULL if none
1007 * This is an optional set of parameters for automatic scanning
1008 * within an interface in following format:
1009 * <autoscan module name>:<module parameters>
1014 * wps_nfc_pw_from_config - NFC Device Password was read from config
1016 * This parameter can be determined whether the NFC Device Password was
1017 * included in the configuration (1) or generated dynamically (0). Only
1018 * the former case is re-written back to the configuration file.
1020 int wps_nfc_pw_from_config
;
1023 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
1025 int wps_nfc_dev_pw_id
;
1028 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
1030 struct wpabuf
*wps_nfc_dh_pubkey
;
1033 * wps_nfc_dh_privkey - NFC DH Private Key for password token
1035 struct wpabuf
*wps_nfc_dh_privkey
;
1038 * wps_nfc_dev_pw - NFC Device Password for password token
1040 struct wpabuf
*wps_nfc_dev_pw
;
1043 * ext_password_backend - External password backend or %NULL if none
1045 * format: <backend name>[:<optional backend parameters>]
1047 char *ext_password_backend
;
1050 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
1052 * This timeout value is used in P2P GO mode to clean up
1053 * inactive stations.
1054 * By default: 300 seconds.
1056 int p2p_go_max_inactivity
;
1058 struct hostapd_wmm_ac_params wmm_ac_params
[4];
1061 * auto_interworking - Whether to use network selection automatically
1063 * 0 = do not automatically go through Interworking network selection
1064 * (i.e., require explicit interworking_select command for this)
1065 * 1 = perform Interworking network selection if one or more
1066 * credentials have been configured and scan did not find a
1067 * matching network block
1069 int auto_interworking
;
1072 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
1074 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1075 * Note that regulatory constraints and driver capabilities are
1076 * consulted anyway, so setting it to 1 can't do real harm.
1077 * By default: 0 (disabled)
1082 * p2p_go_vht - Default mode for VHT enable when operating as GO
1084 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1085 * Note that regulatory constraints and driver capabilities are
1086 * consulted anyway, so setting it to 1 can't do real harm.
1087 * By default: 0 (disabled)
1092 * p2p_go_he - Default mode for 11ax HE enable when operating as GO
1094 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1095 * Note that regulatory constraints and driver capabilities are
1096 * consulted anyway, so setting it to 1 can't do real harm.
1097 * By default: 0 (disabled)
1102 * p2p_go_ctwindow - CTWindow to use when operating as GO
1104 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
1105 * the length of the CTWindow in TUs.
1107 int p2p_go_ctwindow
;
1110 * p2p_disabled - Whether P2P operations are disabled for this interface
1115 * p2p_no_group_iface - Whether group interfaces can be used
1117 * By default, wpa_supplicant will create a separate interface for P2P
1118 * group operations if the driver supports this. This functionality can
1119 * be disabled by setting this parameter to 1. In that case, the same
1120 * interface that was used for the P2P management operations is used
1121 * also for the group operation.
1123 int p2p_no_group_iface
;
1126 * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1128 * If this parameter is set to 1, a connected P2P Client will receive
1129 * and handle Probe Request frames. Setting this parameter to 0
1130 * disables this option. Default value: 0.
1132 * Note: Setting this property at run time takes effect on the following
1133 * interface state transition to/from the WPA_COMPLETED state.
1138 * okc - Whether to enable opportunistic key caching by default
1140 * By default, OKC is disabled unless enabled by the per-network
1141 * proactive_key_caching=1 parameter. okc=1 can be used to change this
1147 * pmf - Whether to enable/require PMF by default
1149 * By default, PMF is disabled unless enabled by the per-network
1150 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
1151 * this default behavior for RSN network (this is not applicable for
1154 enum mfp_options pmf
;
1157 * sae_groups - Preference list of enabled groups for SAE
1159 * By default (if this parameter is not set), the mandatory group 19
1160 * (ECC group defined over a 256-bit prime order field) is preferred,
1161 * but other groups are also enabled. If this parameter is set, the
1162 * groups will be tried in the indicated order.
1167 * dtim_period - Default DTIM period in Beacon intervals
1169 * This parameter can be used to set the default value for network
1170 * blocks that do not specify dtim_period.
1175 * beacon_int - Default Beacon interval in TU
1177 * This parameter can be used to set the default value for network
1178 * blocks that do not specify beacon_int.
1183 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1185 * This parameter can be used to define additional vendor specific
1186 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1187 * format for these element(s) is a hexdump of the raw information
1188 * elements (id+len+payload for one or more elements).
1190 struct wpabuf
*ap_vendor_elements
;
1193 * ignore_old_scan_res - Ignore scan results older than request
1195 * The driver may have a cache of scan results that makes it return
1196 * information that is older than our scan trigger. This parameter can
1197 * be used to configure such old information to be ignored instead of
1198 * allowing it to update the internal BSS table.
1200 int ignore_old_scan_res
;
1203 * sched_scan_interval - schedule scan interval
1205 unsigned int sched_scan_interval
;
1208 * sched_scan_start_delay - Schedule scan start delay before first scan
1210 * Delay (in seconds) before scheduling first scan plan cycle. The
1211 * driver may ignore this parameter and start immediately (or at any
1212 * other time), if this feature is not supported.
1214 unsigned int sched_scan_start_delay
;
1217 * tdls_external_control - External control for TDLS setup requests
1219 * Enable TDLS mode where external programs are given the control
1220 * to specify the TDLS link to get established to the driver. The
1221 * driver requests the TDLS setup to the supplicant only for the
1222 * specified TDLS peers.
1224 int tdls_external_control
;
1228 u8 ip_addr_start
[4];
1232 * osu_dir - OSU provider information directory
1234 * If set, allow FETCH_OSU control interface command to be used to fetch
1235 * OSU provider information into all APs and store the results in this
1241 * wowlan_triggers - Wake-on-WLAN triggers
1243 * If set, these wowlan triggers will be configured.
1245 char *wowlan_triggers
;
1248 * p2p_search_delay - Extra delay between concurrent search iterations
1250 * Add extra delay (in milliseconds) between search iterations when
1251 * there is a concurrent operation to make p2p_find friendlier to
1252 * concurrent operations by avoiding it from taking 100% of radio
1255 unsigned int p2p_search_delay
;
1258 * mac_addr - MAC address policy default
1260 * 0 = use permanent MAC address
1261 * 1 = use random MAC address for each ESS connection
1262 * 2 = like 1, but maintain OUI (with local admin bit set)
1264 * By default, permanent MAC address is used unless policy is changed by
1265 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1266 * change this default behavior.
1271 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1273 unsigned int rand_addr_lifetime
;
1276 * preassoc_mac_addr - Pre-association MAC address policy
1278 * 0 = use permanent MAC address
1279 * 1 = use random MAC address
1280 * 2 = like 1, but maintain OUI (with local admin bit set)
1282 int preassoc_mac_addr
;
1285 * key_mgmt_offload - Use key management offload
1287 * Key management offload should be used if the device supports it.
1288 * Key management offload is the capability of a device operating as
1289 * a station to do the exchange necessary to establish temporal keys
1290 * during initial RSN connection, after roaming, or during a PTK
1291 * rekeying operation.
1293 int key_mgmt_offload
;
1296 * user_mpm - MPM residency
1298 * 0: MPM lives in driver.
1299 * 1: wpa_supplicant handles peering and station allocation.
1301 * If AMPE or SAE is enabled, the MPM is always in userspace.
1306 * max_peer_links - Maximum number of peer links
1308 * Maximum number of mesh peering currently maintained by the STA.
1313 * cert_in_cb - Whether to include a peer certificate dump in events
1315 * This controls whether peer certificates for authentication server and
1316 * its certificate chain are included in EAP peer certificate events.
1321 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1323 * This timeout value is used in mesh STA to clean up inactive stations.
1324 * By default: 300 seconds.
1326 int mesh_max_inactivity
;
1329 * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1331 * This timeout value is used in mesh STA to retransmit
1332 * SAE Authentication frame.
1333 * By default: 1000 milliseconds.
1335 int dot11RSNASAERetransPeriod
;
1338 * passive_scan - Whether to force passive scan for network connection
1340 * This parameter can be used to force only passive scanning to be used
1341 * for network connection cases. It should be noted that this will slow
1342 * down scan operations and reduce likelihood of finding the AP. In
1343 * addition, some use cases will override this due to functional
1344 * requirements, e.g., for finding an AP that uses hidden SSID
1345 * (scan_ssid=1) or P2P device discovery.
1350 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1352 int reassoc_same_bss_optim
;
1355 * wps_priority - Priority for the networks added through WPS
1357 * This priority value will be set to each network profile that is added
1358 * by executing the WPS protocol.
1363 * fst_group_id - FST group ID
1368 * fst_priority - priority of the interface within the FST group
1373 * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1379 * wpa_rsc_relaxation - RSC relaxation on GTK installation
1382 * 0 - use the EAPOL-Key RSC value on GTK installation
1383 * 1 - use the null RSC if a bogus RSC value is detected in message 3
1384 * of 4-Way Handshake or message 1 of Group Key Handshake.
1386 int wpa_rsc_relaxation
;
1389 * sched_scan_plans - Scan plans for scheduled scan
1391 * Each scan plan specifies the interval between scans and the number of
1392 * iterations. The last scan plan only specifies the scan interval and
1393 * will be run infinitely.
1395 * format: <interval:iterations> <interval2:iterations2> ... <interval>
1397 char *sched_scan_plans
;
1401 * non_pref_chan - Non-preferred channels list, separated by spaces.
1403 * format: op_class:chan:preference:reason<:detail>
1404 * Detail is optional.
1406 char *non_pref_chan
;
1409 * mbo_cell_capa - Cellular capabilities for MBO
1411 enum mbo_cellular_capa mbo_cell_capa
;
1414 * disassoc_imminent_rssi_threshold - RSSI threshold of candidate AP
1415 * when disassociation imminent is set.
1417 int disassoc_imminent_rssi_threshold
;
1420 * oce - Enable OCE in STA and/or STA-CFON mode
1421 * - Set BIT(0) to enable OCE in non-AP STA mode
1422 * - Set BIT(1) to enable OCE in STA-CFON mode
1425 #endif /* CONFIG_MBO */
1428 * gas_address3 - GAS Address3 field behavior
1431 * 0 - P2P specification (Address3 = AP BSSID)
1432 * 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
1433 * sent to not-associated AP; if associated, AP BSSID)
1438 * ftm_responder - Publish FTM (fine timing measurement)
1439 * responder functionality
1442 * 0 - do not publish FTM responder functionality (Default)
1443 * 1 - publish FTM responder functionality in
1444 * bit 70 of Extended Capabilities element
1445 * Note, actual FTM responder operation is managed outside
1451 * ftm_initiator - Publish FTM (fine timing measurement)
1452 * initiator functionality
1455 * 0 - do not publish FTM initiator functionality (Default)
1456 * 1 - publish FTM initiator functionality in
1457 * bit 71 of Extended Capabilities element
1458 * Note, actual FTM initiator operation is managed outside
1464 * gas_rand_addr_lifetime - Lifetime of random MAC address for ANQP in
1467 unsigned int gas_rand_addr_lifetime
;
1470 * gas_rand_mac_addr - GAS MAC address policy
1472 * 0 = use permanent MAC address
1473 * 1 = use random MAC address
1474 * 2 = like 1, but maintain OUI (with local admin bit set)
1476 int gas_rand_mac_addr
;
1479 * dpp_config_processing - How to process DPP configuration
1481 * 0 = report received configuration to an external program for
1482 * processing; do not generate any network profile internally
1483 * 1 = report received configuration to an external program and generate
1484 * a network profile internally, but do not automatically connect
1485 * to the created (disabled) profile; the network profile id is
1486 * reported to external programs
1487 * 2 = report received configuration to an external program, generate
1488 * a network profile internally, try to connect to the created
1489 * profile automatically
1491 int dpp_config_processing
;
1494 * coloc_intf_reporting - Colocated interference reporting
1496 * dot11CoLocIntfReportingActivated
1497 * 0 = disabled (false)
1498 * 1 = enabled (true)
1500 int coloc_intf_reporting
;
1503 * p2p_device_random_mac_addr - P2P Device MAC address policy default
1505 * 0 = use permanent MAC address
1506 * 1 = use random MAC address on creating the interface if there is no
1507 * persistent groups.
1509 * By default, permanent MAC address is used.
1511 int p2p_device_random_mac_addr
;
1514 * p2p_device_persistent_mac_addr - Record last used MAC address
1516 * If there are saved persistent groups, P2P cannot generate another
1517 * random MAC address, and need to restore to last used MAC address.
1519 u8 p2p_device_persistent_mac_addr
[ETH_ALEN
];
1522 * p2p_interface_random_mac_addr - P2P Interface MAC address policy default
1524 * 0 = use permanent MAC address
1525 * 1 = use random MAC address on creating the interface.
1527 * By default, permanent MAC address is used.
1529 int p2p_interface_random_mac_addr
;
1533 /* Prototypes for common functions from config.c */
1535 void wpa_config_free(struct wpa_config
*ssid
);
1536 void wpa_config_free_ssid(struct wpa_ssid
*ssid
);
1537 void wpa_config_foreach_network(struct wpa_config
*config
,
1538 void (*func
)(void *, struct wpa_ssid
*),
1540 struct wpa_ssid
* wpa_config_get_network(struct wpa_config
*config
, int id
);
1541 struct wpa_ssid
* wpa_config_add_network(struct wpa_config
*config
);
1542 int wpa_config_remove_network(struct wpa_config
*config
, int id
);
1543 void wpa_config_set_network_defaults(struct wpa_ssid
*ssid
);
1544 int wpa_config_set(struct wpa_ssid
*ssid
, const char *var
, const char *value
,
1546 int wpa_config_set_quoted(struct wpa_ssid
*ssid
, const char *var
,
1548 int wpa_config_dump_values(struct wpa_config
*config
, char *buf
,
1550 int wpa_config_get_value(const char *name
, struct wpa_config
*config
,
1551 char *buf
, size_t buflen
);
1553 char ** wpa_config_get_all(struct wpa_ssid
*ssid
, int get_keys
);
1554 char * wpa_config_get(struct wpa_ssid
*ssid
, const char *var
);
1555 char * wpa_config_get_no_key(struct wpa_ssid
*ssid
, const char *var
);
1556 void wpa_config_update_psk(struct wpa_ssid
*ssid
);
1557 int wpa_config_add_prio_network(struct wpa_config
*config
,
1558 struct wpa_ssid
*ssid
);
1559 int wpa_config_update_prio_list(struct wpa_config
*config
);
1560 const struct wpa_config_blob
* wpa_config_get_blob(struct wpa_config
*config
,
1562 void wpa_config_set_blob(struct wpa_config
*config
,
1563 struct wpa_config_blob
*blob
);
1564 void wpa_config_free_blob(struct wpa_config_blob
*blob
);
1565 int wpa_config_remove_blob(struct wpa_config
*config
, const char *name
);
1566 void wpa_config_flush_blobs(struct wpa_config
*config
);
1568 struct wpa_cred
* wpa_config_get_cred(struct wpa_config
*config
, int id
);
1569 struct wpa_cred
* wpa_config_add_cred(struct wpa_config
*config
);
1570 int wpa_config_remove_cred(struct wpa_config
*config
, int id
);
1571 void wpa_config_free_cred(struct wpa_cred
*cred
);
1572 int wpa_config_set_cred(struct wpa_cred
*cred
, const char *var
,
1573 const char *value
, int line
);
1574 char * wpa_config_get_cred_no_key(struct wpa_cred
*cred
, const char *var
);
1576 struct wpa_config
* wpa_config_alloc_empty(const char *ctrl_interface
,
1577 const char *driver_param
);
1578 #ifndef CONFIG_NO_STDOUT_DEBUG
1579 void wpa_config_debug_dump_networks(struct wpa_config
*config
);
1580 #else /* CONFIG_NO_STDOUT_DEBUG */
1581 #define wpa_config_debug_dump_networks(c) do { } while (0)
1582 #endif /* CONFIG_NO_STDOUT_DEBUG */
1585 /* Prototypes for common functions from config.c */
1586 int wpa_config_process_global(struct wpa_config
*config
, char *pos
, int line
);
1588 int wpa_config_get_num_global_field_names(void);
1590 const char * wpa_config_get_global_field_name(unsigned int i
, int *no_var
);
1592 /* Prototypes for backend specific functions from the selected config_*.c */
1595 * wpa_config_read - Read and parse configuration database
1596 * @name: Name of the configuration (e.g., path and file name for the
1597 * configuration file)
1598 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
1599 * Returns: Pointer to allocated configuration data or %NULL on failure
1601 * This function reads configuration data, parses its contents, and allocates
1602 * data structures needed for storing configuration information. The allocated
1603 * data can be freed with wpa_config_free().
1605 * Each configuration backend needs to implement this function.
1607 struct wpa_config
* wpa_config_read(const char *name
, struct wpa_config
*cfgp
);
1610 * wpa_config_write - Write or update configuration data
1611 * @name: Name of the configuration (e.g., path and file name for the
1612 * configuration file)
1613 * @config: Configuration data from wpa_config_read()
1614 * Returns: 0 on success, -1 on failure
1616 * This function write all configuration data into an external database (e.g.,
1617 * a text file) in a format that can be read with wpa_config_read(). This can
1618 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1619 * new network is added or a password is changed.
1621 * Each configuration backend needs to implement this function.
1623 int wpa_config_write(const char *name
, struct wpa_config
*config
);
1625 #endif /* CONFIG_H */