2 * WPA Supplicant / Configuration file structures
3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 #define DEFAULT_EAPOL_VERSION 1
13 #ifdef CONFIG_NO_SCAN_PROCESSING
14 #define DEFAULT_AP_SCAN 2
15 #else /* CONFIG_NO_SCAN_PROCESSING */
16 #define DEFAULT_AP_SCAN 1
17 #endif /* CONFIG_NO_SCAN_PROCESSING */
18 #define DEFAULT_FAST_REAUTH 1
19 #define DEFAULT_P2P_GO_INTENT 7
20 #define DEFAULT_P2P_INTRA_BSS 1
21 #define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
22 #define DEFAULT_BSS_MAX_COUNT 200
23 #define DEFAULT_BSS_EXPIRATION_AGE 180
24 #define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
25 #define DEFAULT_MAX_NUM_STA 128
26 #define DEFAULT_ACCESS_NETWORK_TYPE 15
27 #define DEFAULT_SCAN_CUR_FREQ 0
29 #include "config_ssid.h"
31 #include "common/ieee802_11_common.h"
36 * next - Next credential in the list
38 * This pointer can be used to iterate over all credentials. The head
39 * of this list is stored in the cred field of struct wpa_config.
41 struct wpa_cred *next;
44 * id - Unique id for the credential
46 * This identifier is used as a unique identifier for each credential
47 * block when using the control interface. Each credential is allocated
48 * an id when it is being created, either when reading the
49 * configuration file or when a new credential is added through the
55 * temporary - Whether this credential is temporary and not to be saved
60 * priority - Priority group
62 * By default, all networks and credentials get the same priority group
63 * (0). This field can be used to give higher priority for credentials
64 * (and similarly in struct wpa_ssid for network blocks) to change the
65 * Interworking automatic networking selection behavior. The matching
66 * network (based on either an enabled network block or a credential)
67 * with the highest priority value will be selected.
72 * pcsc - Use PC/SC and SIM/USIM card
77 * realm - Home Realm for Interworking
82 * username - Username for Interworking network selection
87 * password - Password for Interworking network selection
92 * ext_password - Whether password is a name for external storage
97 * ca_cert - CA certificate for Interworking network selection
102 * client_cert - File path to client certificate file (PEM/DER)
104 * This field is used with Interworking networking selection for a case
105 * where client certificate/private key is used for authentication
106 * (EAP-TLS). Full path to the file should be used since working
107 * directory may change when wpa_supplicant is run in the background.
109 * Alternatively, a named configuration blob can be used by setting
110 * this to blob://blob_name.
115 * private_key - File path to client private key file (PEM/DER/PFX)
117 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
118 * commented out. Both the private key and certificate will be read
119 * from the PKCS#12 file in this case. Full path to the file should be
120 * used since working directory may change when wpa_supplicant is run
123 * Windows certificate store can be used by leaving client_cert out and
124 * configuring private_key in one of the following formats:
126 * cert://substring_to_match
128 * hash://certificate_thumbprint_in_hex
130 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
132 * Note that when running wpa_supplicant as an application, the user
133 * certificate store (My user account) is used, whereas computer store
134 * (Computer account) is used when running wpasvc as a service.
136 * Alternatively, a named configuration blob can be used by setting
137 * this to blob://blob_name.
142 * private_key_passwd - Password for private key file
144 char *private_key_passwd;
147 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
152 * milenage - Milenage parameters for SIM/USIM simulator in
153 * <Ki>:<OPc>:<SQN> format
158 * domain_suffix_match - Constraint for server domain name
160 * If set, this FQDN is used as a suffix match requirement for the AAA
161 * server certificate in SubjectAltName dNSName element(s). If a
162 * matching dNSName is found, this constraint is met. If no dNSName
163 * values are present, this constraint is matched against SubjetName CN
164 * using same suffix match comparison. Suffix match here means that the
165 * host/domain name is compared one label at a time starting from the
166 * top-level domain and all the labels in @domain_suffix_match shall be
167 * included in the certificate. The certificate may include additional
168 * sub-level labels in addition to the required labels.
170 * For example, domain_suffix_match=example.com would match
171 * test.example.com but would not match test-example.com.
173 char *domain_suffix_match;
176 * domain - Home service provider FQDN(s)
178 * This is used to compare against the Domain Name List to figure out
179 * whether the AP is operated by the Home SP. Multiple domain entries
180 * can be used to configure alternative FQDNs that will be considered
186 * num_domain - Number of FQDNs in the domain array
191 * roaming_consortium - Roaming Consortium OI
193 * If roaming_consortium_len is non-zero, this field contains the
194 * Roaming Consortium OI that can be used to determine which access
195 * points support authentication with this credential. This is an
196 * alternative to the use of the realm parameter. When using Roaming
197 * Consortium to match the network, the EAP parameters need to be
198 * pre-configured with the credential since the NAI Realm information
199 * may not be available or fetched.
201 u8 roaming_consortium[15];
204 * roaming_consortium_len - Length of roaming_consortium
206 size_t roaming_consortium_len;
208 u8 required_roaming_consortium[15];
209 size_t required_roaming_consortium_len;
212 * eap_method - EAP method to use
214 * Pre-configured EAP method to use with this credential or %NULL to
215 * indicate no EAP method is selected, i.e., the method will be
216 * selected automatically based on ANQP information.
218 struct eap_method_type *eap_method;
221 * phase1 - Phase 1 (outer authentication) parameters
223 * Pre-configured EAP parameters or %NULL.
228 * phase2 - Phase 2 (inner authentication) parameters
230 * Pre-configured EAP parameters or %NULL.
234 struct excluded_ssid {
235 u8 ssid[MAX_SSID_LEN];
238 size_t num_excluded_ssid;
240 struct roaming_partner {
246 size_t num_roaming_partner;
248 int update_identifier;
252 #define CFG_CHANGED_DEVICE_NAME BIT(0)
253 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
254 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
255 #define CFG_CHANGED_OS_VERSION BIT(3)
256 #define CFG_CHANGED_UUID BIT(4)
257 #define CFG_CHANGED_COUNTRY BIT(5)
258 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
259 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
260 #define CFG_CHANGED_WPS_STRING BIT(8)
261 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
262 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
263 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
264 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
265 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
266 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
267 #define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
270 * struct wpa_config - wpa_supplicant configuration data
272 * This data structure is presents the per-interface (radio) configuration
273 * data. In many cases, there is only one struct wpa_config instance, but if
274 * more than one network interface is being controlled, one instance is used
279 * ssid - Head of the global network list
281 * This is the head for the list of all the configured networks.
283 struct wpa_ssid *ssid;
286 * pssid - Per-priority network lists (in priority order)
288 struct wpa_ssid **pssid;
291 * num_prio - Number of different priorities used in the pssid lists
293 * This indicates how many per-priority network lists are included in
299 * cred - Head of the credential list
301 * This is the head for the list of all the configured credentials.
303 struct wpa_cred *cred;
306 * eapol_version - IEEE 802.1X/EAPOL version number
308 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
309 * defines EAPOL version 2. However, there are many APs that do not
310 * handle the new version number correctly (they seem to drop the
311 * frames completely). In order to make wpa_supplicant interoperate
312 * with these APs, the version number is set to 1 by default. This
313 * configuration value can be used to set it to the new version (2).
318 * ap_scan - AP scanning/selection
320 * By default, wpa_supplicant requests driver to perform AP
321 * scanning and then uses the scan results to select a
322 * suitable AP. Another alternative is to allow the driver to
323 * take care of AP scanning and selection and use
324 * wpa_supplicant just to process EAPOL frames based on IEEE
325 * 802.11 association information from the driver.
327 * 1: wpa_supplicant initiates scanning and AP selection (default).
329 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
330 * association parameters (e.g., WPA IE generation); this mode can
331 * also be used with non-WPA drivers when using IEEE 802.1X mode;
332 * do not try to associate with APs (i.e., external program needs
333 * to control association). This mode must also be used when using
334 * wired Ethernet drivers.
336 * 2: like 0, but associate with APs using security policy and SSID
337 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
338 * drivers to enable operation with hidden SSIDs and optimized roaming;
339 * in this mode, the network blocks in the configuration are tried
340 * one by one until the driver reports successful association; each
341 * network block should have explicit security policy (i.e., only one
342 * option in the lists) for key_mgmt, pairwise, group, proto variables.
347 * bgscan - Background scan and roaming parameters or %NULL if none
349 * This is an optional set of parameters for background scanning and
350 * roaming within a network (ESS). For more detailed information see
351 * ssid block documentation.
353 * The variable defines default bgscan behavior for all BSS station
354 * networks except for those which have their own bgscan configuration.
359 * disable_scan_offload - Disable automatic offloading of scan requests
361 * By default, %wpa_supplicant tries to offload scanning if the driver
362 * indicates support for this (sched_scan). This configuration
363 * parameter can be used to disable this offloading mechanism.
365 int disable_scan_offload;
368 * ctrl_interface - Parameters for the control interface
370 * If this is specified, %wpa_supplicant will open a control interface
371 * that is available for external programs to manage %wpa_supplicant.
372 * The meaning of this string depends on which control interface
373 * mechanism is used. For all cases, the existence of this parameter
374 * in configuration is used to determine whether the control interface
377 * For UNIX domain sockets (default on Linux and BSD): This is a
378 * directory that will be created for UNIX domain sockets for listening
379 * to requests from external programs (CLI/GUI, etc.) for status
380 * information and configuration. The socket file will be named based
381 * on the interface name, so multiple %wpa_supplicant processes can be
382 * run at the same time if more than one interface is used.
383 * /var/run/wpa_supplicant is the recommended directory for sockets and
384 * by default, wpa_cli will use it when trying to connect with
387 * Access control for the control interface can be configured
388 * by setting the directory to allow only members of a group
389 * to use sockets. This way, it is possible to run
390 * %wpa_supplicant as root (since it needs to change network
391 * configuration and open raw sockets) and still allow GUI/CLI
392 * components to be run as non-root users. However, since the
393 * control interface can be used to change the network
394 * configuration, this access needs to be protected in many
395 * cases. By default, %wpa_supplicant is configured to use gid
396 * 0 (root). If you want to allow non-root users to use the
397 * control interface, add a new group and change this value to
398 * match with that group. Add users that should have control
399 * interface access to this group.
401 * When configuring both the directory and group, use following format:
402 * DIR=/var/run/wpa_supplicant GROUP=wheel
403 * DIR=/var/run/wpa_supplicant GROUP=0
404 * (group can be either group name or gid)
406 * For UDP connections (default on Windows): The value will be ignored.
407 * This variable is just used to select that the control interface is
408 * to be created. The value can be set to, e.g., udp
409 * (ctrl_interface=udp).
411 * For Windows Named Pipe: This value can be used to set the security
412 * descriptor for controlling access to the control interface. Security
413 * descriptor can be set using Security Descriptor String Format (see
414 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
415 * The descriptor string needs to be prefixed with SDDL=. For example,
416 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
419 char *ctrl_interface;
422 * ctrl_interface_group - Control interface group (DEPRECATED)
424 * This variable is only used for backwards compatibility. Group for
425 * UNIX domain sockets should now be specified using GROUP=group in
426 * ctrl_interface variable.
428 char *ctrl_interface_group;
431 * fast_reauth - EAP fast re-authentication (session resumption)
433 * By default, fast re-authentication is enabled for all EAP methods
434 * that support it. This variable can be used to disable fast
435 * re-authentication (by setting fast_reauth=0). Normally, there is no
436 * need to disable fast re-authentication.
441 * opensc_engine_path - Path to the OpenSSL engine for opensc
443 * This is an OpenSSL specific configuration option for loading OpenSC
444 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
446 char *opensc_engine_path;
449 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
451 * This is an OpenSSL specific configuration option for loading PKCS#11
452 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
454 char *pkcs11_engine_path;
457 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
459 * This is an OpenSSL specific configuration option for configuring
460 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
461 * module is not loaded.
463 char *pkcs11_module_path;
466 * pcsc_reader - PC/SC reader name prefix
468 * If not %NULL, PC/SC reader with a name that matches this prefix is
469 * initialized for SIM/USIM access. Empty string can be used to match
470 * the first available reader.
475 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
477 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
478 * EAP-AKA. If left out, this will be asked through control interface.
483 * external_sim - Use external processing for SIM/USIM operations
488 * driver_param - Driver interface parameters
490 * This text string is passed to the selected driver interface with the
491 * optional struct wpa_driver_ops::set_param() handler. This can be
492 * used to configure driver specific options without having to add new
493 * driver interface functionality.
498 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
500 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
501 * cache (unit: seconds).
503 unsigned int dot11RSNAConfigPMKLifetime;
506 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
508 * dot11 MIB variable for the percentage of the PMK lifetime
509 * that should expire before an IEEE 802.1X reauthentication occurs.
511 unsigned int dot11RSNAConfigPMKReauthThreshold;
514 * dot11RSNAConfigSATimeout - Security association timeout
516 * dot11 MIB variable for the maximum time a security association
517 * shall take to set up (unit: seconds).
519 unsigned int dot11RSNAConfigSATimeout;
522 * update_config - Is wpa_supplicant allowed to update configuration
524 * This variable control whether wpa_supplicant is allow to re-write
525 * its configuration with wpa_config_write(). If this is zero,
526 * configuration data is only changed in memory and the external data
527 * is not overriden. If this is non-zero, wpa_supplicant will update
528 * the configuration data (e.g., a file) whenever configuration is
529 * changed. This update may replace the old configuration which can
530 * remove comments from it in case of a text file configuration.
535 * blobs - Configuration blobs
537 struct wpa_config_blob *blobs;
540 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
545 * device_name - Device Name (WPS)
546 * User-friendly description of device; up to 32 octets encoded in
552 * manufacturer - Manufacturer (WPS)
553 * The manufacturer of the device (up to 64 ASCII characters)
558 * model_name - Model Name (WPS)
559 * Model of the device (up to 32 ASCII characters)
564 * model_number - Model Number (WPS)
565 * Additional device description (up to 32 ASCII characters)
570 * serial_number - Serial Number (WPS)
571 * Serial number of the device (up to 32 characters)
576 * device_type - Primary Device Type (WPS)
578 u8 device_type[WPS_DEV_TYPE_LEN];
581 * config_methods - Config Methods
583 * This is a space-separated list of supported WPS configuration
584 * methods. For example, "label virtual_display virtual_push_button
586 * Available methods: usba ethernet label display ext_nfc_token
587 * int_nfc_token nfc_interface push_button keypad
588 * virtual_display physical_display
589 * virtual_push_button physical_push_button.
591 char *config_methods;
594 * os_version - OS Version (WPS)
595 * 4-octet operating system version number
600 * country - Country code
602 * This is the ISO/IEC alpha2 country code for which we are operating
608 * wps_cred_processing - Credential processing
610 * 0 = process received credentials internally
611 * 1 = do not process received credentials; just pass them over
612 * ctrl_iface to external program(s)
613 * 2 = process received credentials internally and pass them over
614 * ctrl_iface to external program(s)
616 int wps_cred_processing;
618 #define MAX_SEC_DEVICE_TYPES 5
620 * sec_device_types - Secondary Device Types (P2P)
622 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
623 int num_sec_device_types;
625 int p2p_listen_reg_class;
626 int p2p_listen_channel;
627 int p2p_oper_reg_class;
628 int p2p_oper_channel;
630 char *p2p_ssid_postfix;
631 int persistent_reconnect;
633 unsigned int num_p2p_pref_chan;
634 struct p2p_channel *p2p_pref_chan;
635 struct wpa_freq_range_list p2p_no_go_freq;
636 int p2p_add_cli_chan;
637 int p2p_ignore_shared_freq;
639 struct wpabuf *wps_vendor_ext_m1;
641 #define MAX_WPS_VENDOR_EXT 10
643 * wps_vendor_ext - Vendor extension attributes in WPS
645 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
648 * p2p_group_idle - Maximum idle time in seconds for P2P group
650 * This value controls how long a P2P group is maintained after there
651 * is no other members in the group. As a GO, this means no associated
652 * stations in the group. As a P2P client, this means no GO seen in
653 * scan results. The maximum idle time is specified in seconds with 0
654 * indicating no time limit, i.e., the P2P group remains in active
655 * state indefinitely until explicitly removed. As a P2P client, the
656 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
657 * this parameter is mainly meant for GO use and for P2P client, it can
658 * only be used to reduce the default timeout to smaller value. A
659 * special value -1 can be used to configure immediate removal of the
660 * group for P2P client role on any disconnection after the data
661 * connection has been established.
666 * bss_max_count - Maximum number of BSS entries to keep in memory
668 unsigned int bss_max_count;
671 * bss_expiration_age - BSS entry age after which it can be expired
673 * This value controls the time in seconds after which a BSS entry
674 * gets removed if it has not been updated or is not in use.
676 unsigned int bss_expiration_age;
679 * bss_expiration_scan_count - Expire BSS after number of scans
681 * If the BSS entry has not been seen in this many scans, it will be
682 * removed. A value of 1 means that entry is removed after the first
683 * scan in which the BSSID is not seen. Larger values can be used
684 * to avoid BSS entries disappearing if they are not visible in
685 * every scan (e.g., low signal quality or interference).
687 unsigned int bss_expiration_scan_count;
690 * filter_ssids - SSID-based scan result filtering
692 * 0 = do not filter scan results
693 * 1 = only include configured SSIDs in scan results/BSS table
698 * filter_rssi - RSSI-based scan result filtering
700 * 0 = do not filter scan results
701 * -n = filter scan results below -n dBm
706 * max_num_sta - Maximum number of STAs in an AP/P2P GO
708 unsigned int max_num_sta;
711 * freq_list - Array of allowed scan frequencies or %NULL for all
713 * This is an optional zero-terminated array of frequencies in
714 * megahertz (MHz) to allow for narrowing scanning range.
719 * scan_cur_freq - Whether to scan only the current channel
721 * If true, attempt to scan only the current channel if any other
722 * VIFs on this radio are already associated on a particular channel.
727 * changed_parameters - Bitmap of changed parameters since last update
729 unsigned int changed_parameters;
732 * disassoc_low_ack - Disassocicate stations with massive packet loss
734 int disassoc_low_ack;
737 * interworking - Whether Interworking (IEEE 802.11u) is enabled
742 * access_network_type - Access Network Type
744 * When Interworking is enabled, scans will be limited to APs that
745 * advertise the specified Access Network Type (0..15; with 15
746 * indicating wildcard match).
748 int access_network_type;
751 * hessid - Homogenous ESS identifier
753 * If this is set (any octet is non-zero), scans will be used to
754 * request response only from BSSes belonging to the specified
755 * Homogeneous ESS. This is used only if interworking is enabled.
765 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
767 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
768 * by acting as a Registrar and using M1 from the AP. The config
769 * methods attribute in that message is supposed to indicate only the
770 * configuration method supported by the AP in Enrollee role, i.e., to
771 * add an external Registrar. For that case, PBC shall not be used and
772 * as such, the PushButton config method is removed from M1 by default.
773 * If pbc_in_m1=1 is included in the configuration file, the PushButton
774 * config method is left in M1 (if included in config_methods
775 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
776 * a label in the AP).
781 * autoscan - Automatic scan parameters or %NULL if none
783 * This is an optional set of parameters for automatic scanning
784 * within an interface in following format:
785 * <autoscan module name>:<module parameters>
790 * wps_nfc_pw_from_config - NFC Device Password was read from config
792 * This parameter can be determined whether the NFC Device Password was
793 * included in the configuration (1) or generated dynamically (0). Only
794 * the former case is re-written back to the configuration file.
796 int wps_nfc_pw_from_config;
799 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
801 int wps_nfc_dev_pw_id;
804 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
806 struct wpabuf *wps_nfc_dh_pubkey;
809 * wps_nfc_dh_privkey - NFC DH Private Key for password token
811 struct wpabuf *wps_nfc_dh_privkey;
814 * wps_nfc_dev_pw - NFC Device Password for password token
816 struct wpabuf *wps_nfc_dev_pw;
819 * ext_password_backend - External password backend or %NULL if none
821 * format: <backend name>[:<optional backend parameters>]
823 char *ext_password_backend;
826 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
828 * This timeout value is used in P2P GO mode to clean up
830 * By default: 300 seconds.
832 int p2p_go_max_inactivity;
834 struct hostapd_wmm_ac_params wmm_ac_params[4];
837 * auto_interworking - Whether to use network selection automatically
839 * 0 = do not automatically go through Interworking network selection
840 * (i.e., require explicit interworking_select command for this)
841 * 1 = perform Interworking network selection if one or more
842 * credentials have been configured and scan did not find a
843 * matching network block
845 int auto_interworking;
848 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
850 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
851 * Note that regulatory constraints and driver capabilities are
852 * consulted anyway, so setting it to 1 can't do real harm.
853 * By default: 0 (disabled)
858 * p2p_go_vht - Default mode for VHT enable when operating as GO
860 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
861 * Note that regulatory constraints and driver capabilities are
862 * consulted anyway, so setting it to 1 can't do real harm.
863 * By default: 0 (disabled)
868 * p2p_disabled - Whether P2P operations are disabled for this interface
873 * p2p_no_group_iface - Whether group interfaces can be used
875 * By default, wpa_supplicant will create a separate interface for P2P
876 * group operations if the driver supports this. This functionality can
877 * be disabled by setting this parameter to 1. In that case, the same
878 * interface that was used for the P2P management operations is used
879 * also for the group operation.
881 int p2p_no_group_iface;
884 * okc - Whether to enable opportunistic key caching by default
886 * By default, OKC is disabled unless enabled by the per-network
887 * proactive_key_caching=1 parameter. okc=1 can be used to change this
893 * pmf - Whether to enable/require PMF by default
895 * By default, PMF is disabled unless enabled by the per-network
896 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
897 * this default behavior.
899 enum mfp_options pmf;
902 * sae_groups - Preference list of enabled groups for SAE
904 * By default (if this parameter is not set), the mandatory group 19
905 * (ECC group defined over a 256-bit prime order field) is preferred,
906 * but other groups are also enabled. If this parameter is set, the
907 * groups will be tried in the indicated order.
912 * dtim_period - Default DTIM period in Beacon intervals
914 * This parameter can be used to set the default value for network
915 * blocks that do not specify dtim_period.
920 * beacon_int - Default Beacon interval in TU
922 * This parameter can be used to set the default value for network
923 * blocks that do not specify beacon_int.
928 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
930 * This parameter can be used to define additional vendor specific
931 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
932 * format for these element(s) is a hexdump of the raw information
933 * elements (id+len+payload for one or more elements).
935 struct wpabuf *ap_vendor_elements;
938 * ignore_old_scan_res - Ignore scan results older than request
940 * The driver may have a cache of scan results that makes it return
941 * information that is older than our scan trigger. This parameter can
942 * be used to configure such old information to be ignored instead of
943 * allowing it to update the internal BSS table.
945 int ignore_old_scan_res;
948 * sched_scan_interval - schedule scan interval
950 unsigned int sched_scan_interval;
953 * tdls_external_control - External control for TDLS setup requests
955 * Enable TDLS mode where external programs are given the control
956 * to specify the TDLS link to get established to the driver. The
957 * driver requests the TDLS setup to the supplicant only for the
958 * specified TDLS peers.
960 int tdls_external_control;
968 * osu_dir - OSU provider information directory
970 * If set, allow FETCH_OSU control interface command to be used to fetch
971 * OSU provider information into all APs and store the results in this
978 /* Prototypes for common functions from config.c */
980 void wpa_config_free(struct wpa_config *ssid);
981 void wpa_config_free_ssid(struct wpa_ssid *ssid);
982 void wpa_config_foreach_network(struct wpa_config *config,
983 void (*func)(void *, struct wpa_ssid *),
985 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
986 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
987 int wpa_config_remove_network(struct wpa_config *config, int id);
988 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
989 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
991 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
993 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
994 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
995 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
996 void wpa_config_update_psk(struct wpa_ssid *ssid);
997 int wpa_config_add_prio_network(struct wpa_config *config,
998 struct wpa_ssid *ssid);
999 int wpa_config_update_prio_list(struct wpa_config *config);
1000 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1002 void wpa_config_set_blob(struct wpa_config *config,
1003 struct wpa_config_blob *blob);
1004 void wpa_config_free_blob(struct wpa_config_blob *blob);
1005 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
1006 void wpa_config_flush_blobs(struct wpa_config *config);
1008 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1009 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1010 int wpa_config_remove_cred(struct wpa_config *config, int id);
1011 void wpa_config_free_cred(struct wpa_cred *cred);
1012 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1013 const char *value, int line);
1015 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1016 const char *driver_param);
1017 #ifndef CONFIG_NO_STDOUT_DEBUG
1018 void wpa_config_debug_dump_networks(struct wpa_config *config);
1019 #else /* CONFIG_NO_STDOUT_DEBUG */
1020 #define wpa_config_debug_dump_networks(c) do { } while (0)
1021 #endif /* CONFIG_NO_STDOUT_DEBUG */
1024 /* Prototypes for common functions from config.c */
1025 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1028 /* Prototypes for backend specific functions from the selected config_*.c */
1031 * wpa_config_read - Read and parse configuration database
1032 * @name: Name of the configuration (e.g., path and file name for the
1033 * configuration file)
1034 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
1035 * Returns: Pointer to allocated configuration data or %NULL on failure
1037 * This function reads configuration data, parses its contents, and allocates
1038 * data structures needed for storing configuration information. The allocated
1039 * data can be freed with wpa_config_free().
1041 * Each configuration backend needs to implement this function.
1043 struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
1046 * wpa_config_write - Write or update configuration data
1047 * @name: Name of the configuration (e.g., path and file name for the
1048 * configuration file)
1049 * @config: Configuration data from wpa_config_read()
1050 * Returns: 0 on success, -1 on failure
1052 * This function write all configuration data into an external database (e.g.,
1053 * a text file) in a format that can be read with wpa_config_read(). This can
1054 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1055 * new network is added or a password is changed.
1057 * Each configuration backend needs to implement this function.
1059 int wpa_config_write(const char *name, struct wpa_config *config);
1061 #endif /* CONFIG_H */