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
43 #include "config_ssid.h"
45 #include "common/ieee802_11_defs.h"
46 #include "common/ieee802_11_common.h"
51 * next - Next credential in the list
53 * This pointer can be used to iterate over all credentials. The head
54 * of this list is stored in the cred field of struct wpa_config.
56 struct wpa_cred *next;
59 * id - Unique id for the credential
61 * This identifier is used as a unique identifier for each credential
62 * block when using the control interface. Each credential is allocated
63 * an id when it is being created, either when reading the
64 * configuration file or when a new credential is added through the
70 * temporary - Whether this credential is temporary and not to be saved
75 * priority - Priority group
77 * By default, all networks and credentials get the same priority group
78 * (0). This field can be used to give higher priority for credentials
79 * (and similarly in struct wpa_ssid for network blocks) to change the
80 * Interworking automatic networking selection behavior. The matching
81 * network (based on either an enabled network block or a credential)
82 * with the highest priority value will be selected.
87 * pcsc - Use PC/SC and SIM/USIM card
92 * realm - Home Realm for Interworking
97 * username - Username for Interworking network selection
102 * password - Password for Interworking network selection
107 * ext_password - Whether password is a name for external storage
112 * ca_cert - CA certificate for Interworking network selection
117 * client_cert - File path to client certificate file (PEM/DER)
119 * This field is used with Interworking networking selection for a case
120 * where client certificate/private key is used for authentication
121 * (EAP-TLS). Full path to the file should be used since working
122 * directory may change when wpa_supplicant is run in the background.
124 * Alternatively, a named configuration blob can be used by setting
125 * this to blob://blob_name.
130 * private_key - File path to client private key file (PEM/DER/PFX)
132 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
133 * commented out. Both the private key and certificate will be read
134 * from the PKCS#12 file in this case. Full path to the file should be
135 * used since working directory may change when wpa_supplicant is run
138 * Windows certificate store can be used by leaving client_cert out and
139 * configuring private_key in one of the following formats:
141 * cert://substring_to_match
143 * hash://certificate_thumbprint_in_hex
145 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
147 * Note that when running wpa_supplicant as an application, the user
148 * certificate store (My user account) is used, whereas computer store
149 * (Computer account) is used when running wpasvc as a service.
151 * Alternatively, a named configuration blob can be used by setting
152 * this to blob://blob_name.
157 * private_key_passwd - Password for private key file
159 char *private_key_passwd;
162 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
167 * milenage - Milenage parameters for SIM/USIM simulator in
168 * <Ki>:<OPc>:<SQN> format
173 * domain_suffix_match - Constraint for server domain name
175 * If set, this FQDN is used as a suffix match requirement for the AAA
176 * server certificate in SubjectAltName dNSName element(s). If a
177 * matching dNSName is found, this constraint is met. If no dNSName
178 * values are present, this constraint is matched against SubjectName CN
179 * using same suffix match comparison. Suffix match here means that the
180 * host/domain name is compared one label at a time starting from the
181 * top-level domain and all the labels in @domain_suffix_match shall be
182 * included in the certificate. The certificate may include additional
183 * sub-level labels in addition to the required labels.
185 * For example, domain_suffix_match=example.com would match
186 * test.example.com but would not match test-example.com.
188 char *domain_suffix_match;
191 * domain - Home service provider FQDN(s)
193 * This is used to compare against the Domain Name List to figure out
194 * whether the AP is operated by the Home SP. Multiple domain entries
195 * can be used to configure alternative FQDNs that will be considered
201 * num_domain - Number of FQDNs in the domain array
206 * roaming_consortium - Roaming Consortium OI
208 * If roaming_consortium_len is non-zero, this field contains the
209 * Roaming Consortium OI that can be used to determine which access
210 * points support authentication with this credential. This is an
211 * alternative to the use of the realm parameter. When using Roaming
212 * Consortium to match the network, the EAP parameters need to be
213 * pre-configured with the credential since the NAI Realm information
214 * may not be available or fetched.
216 u8 roaming_consortium[15];
219 * roaming_consortium_len - Length of roaming_consortium
221 size_t roaming_consortium_len;
223 u8 required_roaming_consortium[15];
224 size_t required_roaming_consortium_len;
227 * eap_method - EAP method to use
229 * Pre-configured EAP method to use with this credential or %NULL to
230 * indicate no EAP method is selected, i.e., the method will be
231 * selected automatically based on ANQP information.
233 struct eap_method_type *eap_method;
236 * phase1 - Phase 1 (outer authentication) parameters
238 * Pre-configured EAP parameters or %NULL.
243 * phase2 - Phase 2 (inner authentication) parameters
245 * Pre-configured EAP parameters or %NULL.
249 struct excluded_ssid {
250 u8 ssid[SSID_MAX_LEN];
253 size_t num_excluded_ssid;
255 struct roaming_partner {
261 size_t num_roaming_partner;
263 int update_identifier;
266 * provisioning_sp - FQDN of the SP that provisioned the credential
268 char *provisioning_sp;
271 * sp_priority - Credential priority within a provisioning SP
273 * This is the priority of the credential among all credentials
274 * provisionined by the same SP (i.e., for entries that have identical
275 * provisioning_sp value). The range of this priority is 0-255 with 0
276 * being the highest and 255 the lower priority.
280 unsigned int min_dl_bandwidth_home;
281 unsigned int min_ul_bandwidth_home;
282 unsigned int min_dl_bandwidth_roaming;
283 unsigned int min_ul_bandwidth_roaming;
286 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
287 * This value is used as the maximum channel utilization for network
288 * selection purposes for home networks. If the AP does not advertise
289 * BSS Load or if the limit would prevent any connection, this
290 * constraint will be ignored.
292 unsigned int max_bss_load;
294 unsigned int num_req_conn_capab;
295 u8 *req_conn_capab_proto;
296 int **req_conn_capab_port;
299 * ocsp - Whether to use/require OCSP to check server certificate
301 * 0 = do not use OCSP stapling (TLS certificate status extension)
302 * 1 = try to use OCSP stapling, but not require response
303 * 2 = require valid OCSP stapling response
308 * sim_num - User selected SIM identifier
310 * This variable is used for identifying which SIM is used if the system
317 #define CFG_CHANGED_DEVICE_NAME BIT(0)
318 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
319 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
320 #define CFG_CHANGED_OS_VERSION BIT(3)
321 #define CFG_CHANGED_UUID BIT(4)
322 #define CFG_CHANGED_COUNTRY BIT(5)
323 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
324 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
325 #define CFG_CHANGED_WPS_STRING BIT(8)
326 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
327 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
328 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
329 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
330 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
331 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
332 #define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
333 #define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
336 * struct wpa_config - wpa_supplicant configuration data
338 * This data structure is presents the per-interface (radio) configuration
339 * data. In many cases, there is only one struct wpa_config instance, but if
340 * more than one network interface is being controlled, one instance is used
345 * ssid - Head of the global network list
347 * This is the head for the list of all the configured networks.
349 struct wpa_ssid *ssid;
352 * pssid - Per-priority network lists (in priority order)
354 struct wpa_ssid **pssid;
357 * num_prio - Number of different priorities used in the pssid lists
359 * This indicates how many per-priority network lists are included in
365 * cred - Head of the credential list
367 * This is the head for the list of all the configured credentials.
369 struct wpa_cred *cred;
372 * eapol_version - IEEE 802.1X/EAPOL version number
374 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
375 * defines EAPOL version 2. However, there are many APs that do not
376 * handle the new version number correctly (they seem to drop the
377 * frames completely). In order to make wpa_supplicant interoperate
378 * with these APs, the version number is set to 1 by default. This
379 * configuration value can be used to set it to the new version (2).
384 * ap_scan - AP scanning/selection
386 * By default, wpa_supplicant requests driver to perform AP
387 * scanning and then uses the scan results to select a
388 * suitable AP. Another alternative is to allow the driver to
389 * take care of AP scanning and selection and use
390 * wpa_supplicant just to process EAPOL frames based on IEEE
391 * 802.11 association information from the driver.
393 * 1: wpa_supplicant initiates scanning and AP selection (default).
395 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
396 * association parameters (e.g., WPA IE generation); this mode can
397 * also be used with non-WPA drivers when using IEEE 802.1X mode;
398 * do not try to associate with APs (i.e., external program needs
399 * to control association). This mode must also be used when using
400 * wired Ethernet drivers.
402 * 2: like 0, but associate with APs using security policy and SSID
403 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
404 * drivers to enable operation with hidden SSIDs and optimized roaming;
405 * in this mode, the network blocks in the configuration are tried
406 * one by one until the driver reports successful association; each
407 * network block should have explicit security policy (i.e., only one
408 * option in the lists) for key_mgmt, pairwise, group, proto variables.
413 * bgscan - Background scan and roaming parameters or %NULL if none
415 * This is an optional set of parameters for background scanning and
416 * roaming within a network (ESS). For more detailed information see
417 * ssid block documentation.
419 * The variable defines default bgscan behavior for all BSS station
420 * networks except for those which have their own bgscan configuration.
425 * disable_scan_offload - Disable automatic offloading of scan requests
427 * By default, %wpa_supplicant tries to offload scanning if the driver
428 * indicates support for this (sched_scan). This configuration
429 * parameter can be used to disable this offloading mechanism.
431 int disable_scan_offload;
434 * ctrl_interface - Parameters for the control interface
436 * If this is specified, %wpa_supplicant will open a control interface
437 * that is available for external programs to manage %wpa_supplicant.
438 * The meaning of this string depends on which control interface
439 * mechanism is used. For all cases, the existence of this parameter
440 * in configuration is used to determine whether the control interface
443 * For UNIX domain sockets (default on Linux and BSD): This is a
444 * directory that will be created for UNIX domain sockets for listening
445 * to requests from external programs (CLI/GUI, etc.) for status
446 * information and configuration. The socket file will be named based
447 * on the interface name, so multiple %wpa_supplicant processes can be
448 * run at the same time if more than one interface is used.
449 * /var/run/wpa_supplicant is the recommended directory for sockets and
450 * by default, wpa_cli will use it when trying to connect with
453 * Access control for the control interface can be configured
454 * by setting the directory to allow only members of a group
455 * to use sockets. This way, it is possible to run
456 * %wpa_supplicant as root (since it needs to change network
457 * configuration and open raw sockets) and still allow GUI/CLI
458 * components to be run as non-root users. However, since the
459 * control interface can be used to change the network
460 * configuration, this access needs to be protected in many
461 * cases. By default, %wpa_supplicant is configured to use gid
462 * 0 (root). If you want to allow non-root users to use the
463 * control interface, add a new group and change this value to
464 * match with that group. Add users that should have control
465 * interface access to this group.
467 * When configuring both the directory and group, use following format:
468 * DIR=/var/run/wpa_supplicant GROUP=wheel
469 * DIR=/var/run/wpa_supplicant GROUP=0
470 * (group can be either group name or gid)
472 * For UDP connections (default on Windows): The value will be ignored.
473 * This variable is just used to select that the control interface is
474 * to be created. The value can be set to, e.g., udp
475 * (ctrl_interface=udp).
477 * For Windows Named Pipe: This value can be used to set the security
478 * descriptor for controlling access to the control interface. Security
479 * descriptor can be set using Security Descriptor String Format (see
480 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
481 * The descriptor string needs to be prefixed with SDDL=. For example,
482 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
485 char *ctrl_interface;
488 * ctrl_interface_group - Control interface group (DEPRECATED)
490 * This variable is only used for backwards compatibility. Group for
491 * UNIX domain sockets should now be specified using GROUP=group in
492 * ctrl_interface variable.
494 char *ctrl_interface_group;
497 * fast_reauth - EAP fast re-authentication (session resumption)
499 * By default, fast re-authentication is enabled for all EAP methods
500 * that support it. This variable can be used to disable fast
501 * re-authentication (by setting fast_reauth=0). Normally, there is no
502 * need to disable fast re-authentication.
507 * opensc_engine_path - Path to the OpenSSL engine for opensc
509 * This is an OpenSSL specific configuration option for loading OpenSC
510 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
512 char *opensc_engine_path;
515 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
517 * This is an OpenSSL specific configuration option for loading PKCS#11
518 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
520 char *pkcs11_engine_path;
523 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
525 * This is an OpenSSL specific configuration option for configuring
526 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
527 * module is not loaded.
529 char *pkcs11_module_path;
532 * openssl_ciphers - OpenSSL cipher string
534 * This is an OpenSSL specific configuration option for configuring the
535 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
538 char *openssl_ciphers;
541 * pcsc_reader - PC/SC reader name prefix
543 * If not %NULL, PC/SC reader with a name that matches this prefix is
544 * initialized for SIM/USIM access. Empty string can be used to match
545 * the first available reader.
550 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
552 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
553 * EAP-AKA. If left out, this will be asked through control interface.
558 * external_sim - Use external processing for SIM/USIM operations
563 * driver_param - Driver interface parameters
565 * This text string is passed to the selected driver interface with the
566 * optional struct wpa_driver_ops::set_param() handler. This can be
567 * used to configure driver specific options without having to add new
568 * driver interface functionality.
573 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
575 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
576 * cache (unit: seconds).
578 unsigned int dot11RSNAConfigPMKLifetime;
581 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
583 * dot11 MIB variable for the percentage of the PMK lifetime
584 * that should expire before an IEEE 802.1X reauthentication occurs.
586 unsigned int dot11RSNAConfigPMKReauthThreshold;
589 * dot11RSNAConfigSATimeout - Security association timeout
591 * dot11 MIB variable for the maximum time a security association
592 * shall take to set up (unit: seconds).
594 unsigned int dot11RSNAConfigSATimeout;
597 * update_config - Is wpa_supplicant allowed to update configuration
599 * This variable control whether wpa_supplicant is allow to re-write
600 * its configuration with wpa_config_write(). If this is zero,
601 * configuration data is only changed in memory and the external data
602 * is not overriden. If this is non-zero, wpa_supplicant will update
603 * the configuration data (e.g., a file) whenever configuration is
604 * changed. This update may replace the old configuration which can
605 * remove comments from it in case of a text file configuration.
610 * blobs - Configuration blobs
612 struct wpa_config_blob *blobs;
615 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
620 * device_name - Device Name (WPS)
621 * User-friendly description of device; up to 32 octets encoded in
627 * manufacturer - Manufacturer (WPS)
628 * The manufacturer of the device (up to 64 ASCII characters)
633 * model_name - Model Name (WPS)
634 * Model of the device (up to 32 ASCII characters)
639 * model_number - Model Number (WPS)
640 * Additional device description (up to 32 ASCII characters)
645 * serial_number - Serial Number (WPS)
646 * Serial number of the device (up to 32 characters)
651 * device_type - Primary Device Type (WPS)
653 u8 device_type[WPS_DEV_TYPE_LEN];
656 * config_methods - Config Methods
658 * This is a space-separated list of supported WPS configuration
659 * methods. For example, "label virtual_display virtual_push_button
661 * Available methods: usba ethernet label display ext_nfc_token
662 * int_nfc_token nfc_interface push_button keypad
663 * virtual_display physical_display
664 * virtual_push_button physical_push_button.
666 char *config_methods;
669 * os_version - OS Version (WPS)
670 * 4-octet operating system version number
675 * country - Country code
677 * This is the ISO/IEC alpha2 country code for which we are operating
683 * wps_cred_processing - Credential processing
685 * 0 = process received credentials internally
686 * 1 = do not process received credentials; just pass them over
687 * ctrl_iface to external program(s)
688 * 2 = process received credentials internally and pass them over
689 * ctrl_iface to external program(s)
691 int wps_cred_processing;
693 #define MAX_SEC_DEVICE_TYPES 5
695 * sec_device_types - Secondary Device Types (P2P)
697 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
698 int num_sec_device_types;
700 int p2p_listen_reg_class;
701 int p2p_listen_channel;
702 int p2p_oper_reg_class;
703 int p2p_oper_channel;
705 char *p2p_ssid_postfix;
706 int persistent_reconnect;
708 unsigned int num_p2p_pref_chan;
709 struct p2p_channel *p2p_pref_chan;
710 struct wpa_freq_range_list p2p_no_go_freq;
711 int p2p_add_cli_chan;
712 int p2p_ignore_shared_freq;
713 int p2p_optimize_listen_chan;
715 struct wpabuf *wps_vendor_ext_m1;
717 #define MAX_WPS_VENDOR_EXT 10
719 * wps_vendor_ext - Vendor extension attributes in WPS
721 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
724 * p2p_group_idle - Maximum idle time in seconds for P2P group
726 * This value controls how long a P2P group is maintained after there
727 * is no other members in the group. As a GO, this means no associated
728 * stations in the group. As a P2P client, this means no GO seen in
729 * scan results. The maximum idle time is specified in seconds with 0
730 * indicating no time limit, i.e., the P2P group remains in active
731 * state indefinitely until explicitly removed. As a P2P client, the
732 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
733 * this parameter is mainly meant for GO use and for P2P client, it can
734 * only be used to reduce the default timeout to smaller value. A
735 * special value -1 can be used to configure immediate removal of the
736 * group for P2P client role on any disconnection after the data
737 * connection has been established.
742 * p2p_go_freq_change_policy - The GO frequency change policy
744 * This controls the behavior of the GO when there is a change in the
745 * map of the currently used frequencies in case more than one channel
748 * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
749 * possible. In case the GO is the only interface using its frequency
750 * and there are other station interfaces on other frequencies, the GO
751 * will migrate to one of these frequencies.
753 * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
754 * but a transition is possible only in case one of the other used
755 * frequencies is one of the frequencies in the intersection of the
756 * frequency list of the local device and the peer device.
758 * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
761 P2P_GO_FREQ_MOVE_SCM = 0,
762 P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS = 1,
763 P2P_GO_FREQ_MOVE_STAY = 2,
764 P2P_GO_FREQ_MOVE_MAX = P2P_GO_FREQ_MOVE_STAY,
765 } p2p_go_freq_change_policy;
767 #define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
770 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
772 * This parameter controls the length of the random passphrase that is
773 * generated at the GO.
775 unsigned int p2p_passphrase_len;
778 * bss_max_count - Maximum number of BSS entries to keep in memory
780 unsigned int bss_max_count;
783 * bss_expiration_age - BSS entry age after which it can be expired
785 * This value controls the time in seconds after which a BSS entry
786 * gets removed if it has not been updated or is not in use.
788 unsigned int bss_expiration_age;
791 * bss_expiration_scan_count - Expire BSS after number of scans
793 * If the BSS entry has not been seen in this many scans, it will be
794 * removed. A value of 1 means that entry is removed after the first
795 * scan in which the BSSID is not seen. Larger values can be used
796 * to avoid BSS entries disappearing if they are not visible in
797 * every scan (e.g., low signal quality or interference).
799 unsigned int bss_expiration_scan_count;
802 * filter_ssids - SSID-based scan result filtering
804 * 0 = do not filter scan results
805 * 1 = only include configured SSIDs in scan results/BSS table
810 * filter_rssi - RSSI-based scan result filtering
812 * 0 = do not filter scan results
813 * -n = filter scan results below -n dBm
818 * max_num_sta - Maximum number of STAs in an AP/P2P GO
820 unsigned int max_num_sta;
823 * freq_list - Array of allowed scan frequencies or %NULL for all
825 * This is an optional zero-terminated array of frequencies in
826 * megahertz (MHz) to allow for narrowing scanning range.
831 * scan_cur_freq - Whether to scan only the current channel
833 * If true, attempt to scan only the current channel if any other
834 * VIFs on this radio are already associated on a particular channel.
839 * changed_parameters - Bitmap of changed parameters since last update
841 unsigned int changed_parameters;
844 * disassoc_low_ack - Disassocicate stations with massive packet loss
846 int disassoc_low_ack;
849 * interworking - Whether Interworking (IEEE 802.11u) is enabled
854 * access_network_type - Access Network Type
856 * When Interworking is enabled, scans will be limited to APs that
857 * advertise the specified Access Network Type (0..15; with 15
858 * indicating wildcard match).
860 int access_network_type;
863 * hessid - Homogenous ESS identifier
865 * If this is set (any octet is non-zero), scans will be used to
866 * request response only from BSSes belonging to the specified
867 * Homogeneous ESS. This is used only if interworking is enabled.
877 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
879 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
880 * by acting as a Registrar and using M1 from the AP. The config
881 * methods attribute in that message is supposed to indicate only the
882 * configuration method supported by the AP in Enrollee role, i.e., to
883 * add an external Registrar. For that case, PBC shall not be used and
884 * as such, the PushButton config method is removed from M1 by default.
885 * If pbc_in_m1=1 is included in the configuration file, the PushButton
886 * config method is left in M1 (if included in config_methods
887 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
888 * a label in the AP).
893 * autoscan - Automatic scan parameters or %NULL if none
895 * This is an optional set of parameters for automatic scanning
896 * within an interface in following format:
897 * <autoscan module name>:<module parameters>
902 * wps_nfc_pw_from_config - NFC Device Password was read from config
904 * This parameter can be determined whether the NFC Device Password was
905 * included in the configuration (1) or generated dynamically (0). Only
906 * the former case is re-written back to the configuration file.
908 int wps_nfc_pw_from_config;
911 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
913 int wps_nfc_dev_pw_id;
916 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
918 struct wpabuf *wps_nfc_dh_pubkey;
921 * wps_nfc_dh_privkey - NFC DH Private Key for password token
923 struct wpabuf *wps_nfc_dh_privkey;
926 * wps_nfc_dev_pw - NFC Device Password for password token
928 struct wpabuf *wps_nfc_dev_pw;
931 * ext_password_backend - External password backend or %NULL if none
933 * format: <backend name>[:<optional backend parameters>]
935 char *ext_password_backend;
938 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
940 * This timeout value is used in P2P GO mode to clean up
942 * By default: 300 seconds.
944 int p2p_go_max_inactivity;
946 struct hostapd_wmm_ac_params wmm_ac_params[4];
949 * auto_interworking - Whether to use network selection automatically
951 * 0 = do not automatically go through Interworking network selection
952 * (i.e., require explicit interworking_select command for this)
953 * 1 = perform Interworking network selection if one or more
954 * credentials have been configured and scan did not find a
955 * matching network block
957 int auto_interworking;
960 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
962 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
963 * Note that regulatory constraints and driver capabilities are
964 * consulted anyway, so setting it to 1 can't do real harm.
965 * By default: 0 (disabled)
970 * p2p_go_vht - Default mode for VHT enable when operating as GO
972 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
973 * Note that regulatory constraints and driver capabilities are
974 * consulted anyway, so setting it to 1 can't do real harm.
975 * By default: 0 (disabled)
980 * p2p_go_ctwindow - CTWindow to use when operating as GO
982 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
983 * the length of the CTWindow in TUs.
988 * p2p_disabled - Whether P2P operations are disabled for this interface
993 * p2p_no_group_iface - Whether group interfaces can be used
995 * By default, wpa_supplicant will create a separate interface for P2P
996 * group operations if the driver supports this. This functionality can
997 * be disabled by setting this parameter to 1. In that case, the same
998 * interface that was used for the P2P management operations is used
999 * also for the group operation.
1001 int p2p_no_group_iface;
1004 * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1006 * If this parameter is set to 1, a connected P2P Client will receive
1007 * and handle Probe Request frames. Setting this parameter to 0
1008 * disables this option. Default value: 0.
1010 * Note: Setting this property at run time takes effect on the following
1011 * interface state transition to/from the WPA_COMPLETED state.
1016 * okc - Whether to enable opportunistic key caching by default
1018 * By default, OKC is disabled unless enabled by the per-network
1019 * proactive_key_caching=1 parameter. okc=1 can be used to change this
1025 * pmf - Whether to enable/require PMF by default
1027 * By default, PMF is disabled unless enabled by the per-network
1028 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
1029 * this default behavior.
1031 enum mfp_options pmf;
1034 * sae_groups - Preference list of enabled groups for SAE
1036 * By default (if this parameter is not set), the mandatory group 19
1037 * (ECC group defined over a 256-bit prime order field) is preferred,
1038 * but other groups are also enabled. If this parameter is set, the
1039 * groups will be tried in the indicated order.
1044 * dtim_period - Default DTIM period in Beacon intervals
1046 * This parameter can be used to set the default value for network
1047 * blocks that do not specify dtim_period.
1052 * beacon_int - Default Beacon interval in TU
1054 * This parameter can be used to set the default value for network
1055 * blocks that do not specify beacon_int.
1060 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1062 * This parameter can be used to define additional vendor specific
1063 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1064 * format for these element(s) is a hexdump of the raw information
1065 * elements (id+len+payload for one or more elements).
1067 struct wpabuf *ap_vendor_elements;
1070 * ignore_old_scan_res - Ignore scan results older than request
1072 * The driver may have a cache of scan results that makes it return
1073 * information that is older than our scan trigger. This parameter can
1074 * be used to configure such old information to be ignored instead of
1075 * allowing it to update the internal BSS table.
1077 int ignore_old_scan_res;
1080 * sched_scan_interval - schedule scan interval
1082 unsigned int sched_scan_interval;
1085 * tdls_external_control - External control for TDLS setup requests
1087 * Enable TDLS mode where external programs are given the control
1088 * to specify the TDLS link to get established to the driver. The
1089 * driver requests the TDLS setup to the supplicant only for the
1090 * specified TDLS peers.
1092 int tdls_external_control;
1096 u8 ip_addr_start[4];
1100 * osu_dir - OSU provider information directory
1102 * If set, allow FETCH_OSU control interface command to be used to fetch
1103 * OSU provider information into all APs and store the results in this
1109 * wowlan_triggers - Wake-on-WLAN triggers
1111 * If set, these wowlan triggers will be configured.
1113 char *wowlan_triggers;
1116 * p2p_search_delay - Extra delay between concurrent search iterations
1118 * Add extra delay (in milliseconds) between search iterations when
1119 * there is a concurrent operation to make p2p_find friendlier to
1120 * concurrent operations by avoiding it from taking 100% of radio
1123 unsigned int p2p_search_delay;
1126 * mac_addr - MAC address policy default
1128 * 0 = use permanent MAC address
1129 * 1 = use random MAC address for each ESS connection
1130 * 2 = like 1, but maintain OUI (with local admin bit set)
1132 * By default, permanent MAC address is used unless policy is changed by
1133 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1134 * change this default behavior.
1139 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1141 unsigned int rand_addr_lifetime;
1144 * preassoc_mac_addr - Pre-association MAC address policy
1146 * 0 = use permanent MAC address
1147 * 1 = use random MAC address
1148 * 2 = like 1, but maintain OUI (with local admin bit set)
1150 int preassoc_mac_addr;
1153 * key_mgmt_offload - Use key management offload
1155 * Key management offload should be used if the device supports it.
1156 * Key management offload is the capability of a device operating as
1157 * a station to do the exchange necessary to establish temporal keys
1158 * during initial RSN connection, after roaming, or during a PTK
1159 * rekeying operation.
1161 int key_mgmt_offload;
1164 * user_mpm - MPM residency
1166 * 0: MPM lives in driver.
1167 * 1: wpa_supplicant handles peering and station allocation.
1169 * If AMPE or SAE is enabled, the MPM is always in userspace.
1174 * max_peer_links - Maximum number of peer links
1176 * Maximum number of mesh peering currently maintained by the STA.
1181 * cert_in_cb - Whether to include a peer certificate dump in events
1183 * This controls whether peer certificates for authentication server and
1184 * its certificate chain are included in EAP peer certificate events.
1189 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1191 * This timeout value is used in mesh STA to clean up inactive stations.
1192 * By default: 300 seconds.
1194 int mesh_max_inactivity;
1197 * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1199 * This timeout value is used in mesh STA to retransmit
1200 * SAE Authentication frame.
1201 * By default: 1000 milliseconds.
1203 int dot11RSNASAERetransPeriod;
1206 * passive_scan - Whether to force passive scan for network connection
1208 * This parameter can be used to force only passive scanning to be used
1209 * for network connection cases. It should be noted that this will slow
1210 * down scan operations and reduce likelihood of finding the AP. In
1211 * addition, some use cases will override this due to functional
1212 * requirements, e.g., for finding an AP that uses hidden SSID
1213 * (scan_ssid=1) or P2P device discovery.
1218 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1220 int reassoc_same_bss_optim;
1223 * wps_priority - Priority for the networks added through WPS
1225 * This priority value will be set to each network profile that is added
1226 * by executing the WPS protocol.
1231 * fst_group_id - FST group ID
1236 * fst_priority - priority of the interface within the FST group
1241 * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1248 /* Prototypes for common functions from config.c */
1250 void wpa_config_free(struct wpa_config *ssid);
1251 void wpa_config_free_ssid(struct wpa_ssid *ssid);
1252 void wpa_config_foreach_network(struct wpa_config *config,
1253 void (*func)(void *, struct wpa_ssid *),
1255 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1256 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1257 int wpa_config_remove_network(struct wpa_config *config, int id);
1258 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1259 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1261 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1263 int wpa_config_dump_values(struct wpa_config *config, char *buf,
1265 int wpa_config_get_value(const char *name, struct wpa_config *config,
1266 char *buf, size_t buflen);
1268 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1269 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1270 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1271 void wpa_config_update_psk(struct wpa_ssid *ssid);
1272 int wpa_config_add_prio_network(struct wpa_config *config,
1273 struct wpa_ssid *ssid);
1274 int wpa_config_update_prio_list(struct wpa_config *config);
1275 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1277 void wpa_config_set_blob(struct wpa_config *config,
1278 struct wpa_config_blob *blob);
1279 void wpa_config_free_blob(struct wpa_config_blob *blob);
1280 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
1281 void wpa_config_flush_blobs(struct wpa_config *config);
1283 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1284 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1285 int wpa_config_remove_cred(struct wpa_config *config, int id);
1286 void wpa_config_free_cred(struct wpa_cred *cred);
1287 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1288 const char *value, int line);
1289 char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
1291 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1292 const char *driver_param);
1293 #ifndef CONFIG_NO_STDOUT_DEBUG
1294 void wpa_config_debug_dump_networks(struct wpa_config *config);
1295 #else /* CONFIG_NO_STDOUT_DEBUG */
1296 #define wpa_config_debug_dump_networks(c) do { } while (0)
1297 #endif /* CONFIG_NO_STDOUT_DEBUG */
1300 /* Prototypes for common functions from config.c */
1301 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1304 /* Prototypes for backend specific functions from the selected config_*.c */
1307 * wpa_config_read - Read and parse configuration database
1308 * @name: Name of the configuration (e.g., path and file name for the
1309 * configuration file)
1310 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
1311 * Returns: Pointer to allocated configuration data or %NULL on failure
1313 * This function reads configuration data, parses its contents, and allocates
1314 * data structures needed for storing configuration information. The allocated
1315 * data can be freed with wpa_config_free().
1317 * Each configuration backend needs to implement this function.
1319 struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
1322 * wpa_config_write - Write or update configuration data
1323 * @name: Name of the configuration (e.g., path and file name for the
1324 * configuration file)
1325 * @config: Configuration data from wpa_config_read()
1326 * Returns: 0 on success, -1 on failure
1328 * This function write all configuration data into an external database (e.g.,
1329 * a text file) in a format that can be read with wpa_config_read(). This can
1330 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1331 * new network is added or a password is changed.
1333 * Each configuration backend needs to implement this function.
1335 int wpa_config_write(const char *name, struct wpa_config *config);
1337 #endif /* CONFIG_H */