2 * WPA Supplicant / Configuration file structures
3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 #define DEFAULT_EAPOL_VERSION 1
13 #ifdef CONFIG_NO_SCAN_PROCESSING
14 #define DEFAULT_AP_SCAN 2
15 #else /* CONFIG_NO_SCAN_PROCESSING */
16 #define DEFAULT_AP_SCAN 1
17 #endif /* CONFIG_NO_SCAN_PROCESSING */
18 #define DEFAULT_USER_MPM 1
19 #define DEFAULT_MAX_PEER_LINKS 99
20 #define DEFAULT_MESH_MAX_INACTIVITY 300
22 * The default dot11RSNASAERetransPeriod is defined as 40 ms in the standard,
23 * but use 1000 ms in practice to avoid issues on low power CPUs.
25 #define DEFAULT_DOT11_RSNA_SAE_RETRANS_PERIOD 1000
26 #define DEFAULT_FAST_REAUTH 1
27 #define DEFAULT_P2P_GO_INTENT 7
28 #define DEFAULT_P2P_INTRA_BSS 1
29 #define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
30 #define DEFAULT_P2P_OPTIMIZE_LISTEN_CHAN 0
31 #define DEFAULT_BSS_MAX_COUNT 200
32 #define DEFAULT_BSS_EXPIRATION_AGE 180
33 #define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
34 #define DEFAULT_MAX_NUM_STA 128
35 #define DEFAULT_ACCESS_NETWORK_TYPE 15
36 #define DEFAULT_SCAN_CUR_FREQ 0
37 #define DEFAULT_P2P_SEARCH_DELAY 500
38 #define DEFAULT_RAND_ADDR_LIFETIME 60
39 #define DEFAULT_KEY_MGMT_OFFLOAD 1
40 #define DEFAULT_CERT_IN_CB 1
41 #define DEFAULT_P2P_GO_CTWINDOW 0
42 #define DEFAULT_WPA_RSC_RELAXATION 1
44 #include "config_ssid.h"
46 #include "common/ieee802_11_defs.h"
47 #include "common/ieee802_11_common.h"
52 * next - Next credential in the list
54 * This pointer can be used to iterate over all credentials. The head
55 * of this list is stored in the cred field of struct wpa_config.
57 struct wpa_cred *next;
60 * id - Unique id for the credential
62 * This identifier is used as a unique identifier for each credential
63 * block when using the control interface. Each credential is allocated
64 * an id when it is being created, either when reading the
65 * configuration file or when a new credential is added through the
71 * temporary - Whether this credential is temporary and not to be saved
76 * priority - Priority group
78 * By default, all networks and credentials get the same priority group
79 * (0). This field can be used to give higher priority for credentials
80 * (and similarly in struct wpa_ssid for network blocks) to change the
81 * Interworking automatic networking selection behavior. The matching
82 * network (based on either an enabled network block or a credential)
83 * with the highest priority value will be selected.
88 * pcsc - Use PC/SC and SIM/USIM card
93 * realm - Home Realm for Interworking
98 * username - Username for Interworking network selection
103 * password - Password for Interworking network selection
108 * ext_password - Whether password is a name for external storage
113 * ca_cert - CA certificate for Interworking network selection
118 * client_cert - File path to client certificate file (PEM/DER)
120 * This field is used with Interworking networking selection for a case
121 * where client certificate/private key is used for authentication
122 * (EAP-TLS). Full path to the file should be used since working
123 * directory may change when wpa_supplicant is run in the background.
125 * Alternatively, a named configuration blob can be used by setting
126 * this to blob://blob_name.
131 * private_key - File path to client private key file (PEM/DER/PFX)
133 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
134 * commented out. Both the private key and certificate will be read
135 * from the PKCS#12 file in this case. Full path to the file should be
136 * used since working directory may change when wpa_supplicant is run
139 * Windows certificate store can be used by leaving client_cert out and
140 * configuring private_key in one of the following formats:
142 * cert://substring_to_match
144 * hash://certificate_thumbprint_in_hex
146 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
148 * Note that when running wpa_supplicant as an application, the user
149 * certificate store (My user account) is used, whereas computer store
150 * (Computer account) is used when running wpasvc as a service.
152 * Alternatively, a named configuration blob can be used by setting
153 * this to blob://blob_name.
158 * private_key_passwd - Password for private key file
160 char *private_key_passwd;
163 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
168 * milenage - Milenage parameters for SIM/USIM simulator in
169 * <Ki>:<OPc>:<SQN> format
174 * domain_suffix_match - Constraint for server domain name
176 * If set, this FQDN is used as a suffix match requirement for the AAA
177 * server certificate in SubjectAltName dNSName element(s). If a
178 * matching dNSName is found, this constraint is met. If no dNSName
179 * values are present, this constraint is matched against SubjectName CN
180 * using same suffix match comparison. Suffix match here means that the
181 * host/domain name is compared one label at a time starting from the
182 * top-level domain and all the labels in @domain_suffix_match shall be
183 * included in the certificate. The certificate may include additional
184 * sub-level labels in addition to the required labels.
186 * For example, domain_suffix_match=example.com would match
187 * test.example.com but would not match test-example.com.
189 char *domain_suffix_match;
192 * domain - Home service provider FQDN(s)
194 * This is used to compare against the Domain Name List to figure out
195 * whether the AP is operated by the Home SP. Multiple domain entries
196 * can be used to configure alternative FQDNs that will be considered
202 * num_domain - Number of FQDNs in the domain array
207 * roaming_consortium - Roaming Consortium OI
209 * If roaming_consortium_len is non-zero, this field contains the
210 * Roaming Consortium OI that can be used to determine which access
211 * points support authentication with this credential. This is an
212 * alternative to the use of the realm parameter. When using Roaming
213 * Consortium to match the network, the EAP parameters need to be
214 * pre-configured with the credential since the NAI Realm information
215 * may not be available or fetched.
217 u8 roaming_consortium[15];
220 * roaming_consortium_len - Length of roaming_consortium
222 size_t roaming_consortium_len;
224 u8 required_roaming_consortium[15];
225 size_t required_roaming_consortium_len;
228 * eap_method - EAP method to use
230 * Pre-configured EAP method to use with this credential or %NULL to
231 * indicate no EAP method is selected, i.e., the method will be
232 * selected automatically based on ANQP information.
234 struct eap_method_type *eap_method;
237 * phase1 - Phase 1 (outer authentication) parameters
239 * Pre-configured EAP parameters or %NULL.
244 * phase2 - Phase 2 (inner authentication) parameters
246 * Pre-configured EAP parameters or %NULL.
250 struct excluded_ssid {
251 u8 ssid[SSID_MAX_LEN];
254 size_t num_excluded_ssid;
256 struct roaming_partner {
262 size_t num_roaming_partner;
264 int update_identifier;
267 * provisioning_sp - FQDN of the SP that provisioned the credential
269 char *provisioning_sp;
272 * sp_priority - Credential priority within a provisioning SP
274 * This is the priority of the credential among all credentials
275 * provisionined by the same SP (i.e., for entries that have identical
276 * provisioning_sp value). The range of this priority is 0-255 with 0
277 * being the highest and 255 the lower priority.
281 unsigned int min_dl_bandwidth_home;
282 unsigned int min_ul_bandwidth_home;
283 unsigned int min_dl_bandwidth_roaming;
284 unsigned int min_ul_bandwidth_roaming;
287 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
288 * This value is used as the maximum channel utilization for network
289 * selection purposes for home networks. If the AP does not advertise
290 * BSS Load or if the limit would prevent any connection, this
291 * constraint will be ignored.
293 unsigned int max_bss_load;
295 unsigned int num_req_conn_capab;
296 u8 *req_conn_capab_proto;
297 int **req_conn_capab_port;
300 * ocsp - Whether to use/require OCSP to check server certificate
302 * 0 = do not use OCSP stapling (TLS certificate status extension)
303 * 1 = try to use OCSP stapling, but not require response
304 * 2 = require valid OCSP stapling response
309 * sim_num - User selected SIM identifier
311 * This variable is used for identifying which SIM is used if the system
318 #define CFG_CHANGED_DEVICE_NAME BIT(0)
319 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
320 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
321 #define CFG_CHANGED_OS_VERSION BIT(3)
322 #define CFG_CHANGED_UUID BIT(4)
323 #define CFG_CHANGED_COUNTRY BIT(5)
324 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
325 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
326 #define CFG_CHANGED_WPS_STRING BIT(8)
327 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
328 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
329 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
330 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
331 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
332 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
333 #define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
334 #define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
337 * struct wpa_config - wpa_supplicant configuration data
339 * This data structure is presents the per-interface (radio) configuration
340 * data. In many cases, there is only one struct wpa_config instance, but if
341 * more than one network interface is being controlled, one instance is used
346 * ssid - Head of the global network list
348 * This is the head for the list of all the configured networks.
350 struct wpa_ssid *ssid;
353 * pssid - Per-priority network lists (in priority order)
355 struct wpa_ssid **pssid;
358 * num_prio - Number of different priorities used in the pssid lists
360 * This indicates how many per-priority network lists are included in
366 * cred - Head of the credential list
368 * This is the head for the list of all the configured credentials.
370 struct wpa_cred *cred;
373 * eapol_version - IEEE 802.1X/EAPOL version number
375 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
376 * defines EAPOL version 2. However, there are many APs that do not
377 * handle the new version number correctly (they seem to drop the
378 * frames completely). In order to make wpa_supplicant interoperate
379 * with these APs, the version number is set to 1 by default. This
380 * configuration value can be used to set it to the new version (2).
385 * ap_scan - AP scanning/selection
387 * By default, wpa_supplicant requests driver to perform AP
388 * scanning and then uses the scan results to select a
389 * suitable AP. Another alternative is to allow the driver to
390 * take care of AP scanning and selection and use
391 * wpa_supplicant just to process EAPOL frames based on IEEE
392 * 802.11 association information from the driver.
394 * 1: wpa_supplicant initiates scanning and AP selection (default).
396 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
397 * association parameters (e.g., WPA IE generation); this mode can
398 * also be used with non-WPA drivers when using IEEE 802.1X mode;
399 * do not try to associate with APs (i.e., external program needs
400 * to control association). This mode must also be used when using
401 * wired Ethernet drivers.
403 * 2: like 0, but associate with APs using security policy and SSID
404 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
405 * drivers to enable operation with hidden SSIDs and optimized roaming;
406 * in this mode, the network blocks in the configuration are tried
407 * one by one until the driver reports successful association; each
408 * network block should have explicit security policy (i.e., only one
409 * option in the lists) for key_mgmt, pairwise, group, proto variables.
411 * Note: ap_scan=2 should not be used with the nl80211 driver interface
412 * (the current Linux interface). ap_scan=1 is optimized work working
413 * with nl80211. For finding networks using hidden SSID, scan_ssid=1 in
414 * the network block can be used with nl80211.
419 * bgscan - Background scan and roaming parameters or %NULL if none
421 * This is an optional set of parameters for background scanning and
422 * roaming within a network (ESS). For more detailed information see
423 * ssid block documentation.
425 * The variable defines default bgscan behavior for all BSS station
426 * networks except for those which have their own bgscan configuration.
431 * disable_scan_offload - Disable automatic offloading of scan requests
433 * By default, %wpa_supplicant tries to offload scanning if the driver
434 * indicates support for this (sched_scan). This configuration
435 * parameter can be used to disable this offloading mechanism.
437 int disable_scan_offload;
440 * ctrl_interface - Parameters for the control interface
442 * If this is specified, %wpa_supplicant will open a control interface
443 * that is available for external programs to manage %wpa_supplicant.
444 * The meaning of this string depends on which control interface
445 * mechanism is used. For all cases, the existence of this parameter
446 * in configuration is used to determine whether the control interface
449 * For UNIX domain sockets (default on Linux and BSD): This is a
450 * directory that will be created for UNIX domain sockets for listening
451 * to requests from external programs (CLI/GUI, etc.) for status
452 * information and configuration. The socket file will be named based
453 * on the interface name, so multiple %wpa_supplicant processes can be
454 * run at the same time if more than one interface is used.
455 * /var/run/wpa_supplicant is the recommended directory for sockets and
456 * by default, wpa_cli will use it when trying to connect with
459 * Access control for the control interface can be configured
460 * by setting the directory to allow only members of a group
461 * to use sockets. This way, it is possible to run
462 * %wpa_supplicant as root (since it needs to change network
463 * configuration and open raw sockets) and still allow GUI/CLI
464 * components to be run as non-root users. However, since the
465 * control interface can be used to change the network
466 * configuration, this access needs to be protected in many
467 * cases. By default, %wpa_supplicant is configured to use gid
468 * 0 (root). If you want to allow non-root users to use the
469 * control interface, add a new group and change this value to
470 * match with that group. Add users that should have control
471 * interface access to this group.
473 * When configuring both the directory and group, use following format:
474 * DIR=/var/run/wpa_supplicant GROUP=wheel
475 * DIR=/var/run/wpa_supplicant GROUP=0
476 * (group can be either group name or gid)
478 * For UDP connections (default on Windows): The value will be ignored.
479 * This variable is just used to select that the control interface is
480 * to be created. The value can be set to, e.g., udp
481 * (ctrl_interface=udp).
483 * For Windows Named Pipe: This value can be used to set the security
484 * descriptor for controlling access to the control interface. Security
485 * descriptor can be set using Security Descriptor String Format (see
486 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
487 * The descriptor string needs to be prefixed with SDDL=. For example,
488 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
491 char *ctrl_interface;
494 * ctrl_interface_group - Control interface group (DEPRECATED)
496 * This variable is only used for backwards compatibility. Group for
497 * UNIX domain sockets should now be specified using GROUP=group in
498 * ctrl_interface variable.
500 char *ctrl_interface_group;
503 * fast_reauth - EAP fast re-authentication (session resumption)
505 * By default, fast re-authentication is enabled for all EAP methods
506 * that support it. This variable can be used to disable fast
507 * re-authentication (by setting fast_reauth=0). Normally, there is no
508 * need to disable fast re-authentication.
513 * opensc_engine_path - Path to the OpenSSL engine for opensc
515 * This is an OpenSSL specific configuration option for loading OpenSC
516 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
518 char *opensc_engine_path;
521 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
523 * This is an OpenSSL specific configuration option for loading PKCS#11
524 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
526 char *pkcs11_engine_path;
529 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
531 * This is an OpenSSL specific configuration option for configuring
532 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
533 * module is not loaded.
535 char *pkcs11_module_path;
538 * openssl_ciphers - OpenSSL cipher string
540 * This is an OpenSSL specific configuration option for configuring the
541 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
544 char *openssl_ciphers;
547 * pcsc_reader - PC/SC reader name prefix
549 * If not %NULL, PC/SC reader with a name that matches this prefix is
550 * initialized for SIM/USIM access. Empty string can be used to match
551 * the first available reader.
556 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
558 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
559 * EAP-AKA. If left out, this will be asked through control interface.
564 * external_sim - Use external processing for SIM/USIM operations
569 * driver_param - Driver interface parameters
571 * This text string is passed to the selected driver interface with the
572 * optional struct wpa_driver_ops::set_param() handler. This can be
573 * used to configure driver specific options without having to add new
574 * driver interface functionality.
579 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
581 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
582 * cache (unit: seconds).
584 unsigned int dot11RSNAConfigPMKLifetime;
587 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
589 * dot11 MIB variable for the percentage of the PMK lifetime
590 * that should expire before an IEEE 802.1X reauthentication occurs.
592 unsigned int dot11RSNAConfigPMKReauthThreshold;
595 * dot11RSNAConfigSATimeout - Security association timeout
597 * dot11 MIB variable for the maximum time a security association
598 * shall take to set up (unit: seconds).
600 unsigned int dot11RSNAConfigSATimeout;
603 * update_config - Is wpa_supplicant allowed to update configuration
605 * This variable control whether wpa_supplicant is allow to re-write
606 * its configuration with wpa_config_write(). If this is zero,
607 * configuration data is only changed in memory and the external data
608 * is not overriden. If this is non-zero, wpa_supplicant will update
609 * the configuration data (e.g., a file) whenever configuration is
610 * changed. This update may replace the old configuration which can
611 * remove comments from it in case of a text file configuration.
616 * blobs - Configuration blobs
618 struct wpa_config_blob *blobs;
621 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
626 * device_name - Device Name (WPS)
627 * User-friendly description of device; up to 32 octets encoded in
633 * manufacturer - Manufacturer (WPS)
634 * The manufacturer of the device (up to 64 ASCII characters)
639 * model_name - Model Name (WPS)
640 * Model of the device (up to 32 ASCII characters)
645 * model_number - Model Number (WPS)
646 * Additional device description (up to 32 ASCII characters)
651 * serial_number - Serial Number (WPS)
652 * Serial number of the device (up to 32 characters)
657 * device_type - Primary Device Type (WPS)
659 u8 device_type[WPS_DEV_TYPE_LEN];
662 * config_methods - Config Methods
664 * This is a space-separated list of supported WPS configuration
665 * methods. For example, "label virtual_display virtual_push_button
667 * Available methods: usba ethernet label display ext_nfc_token
668 * int_nfc_token nfc_interface push_button keypad
669 * virtual_display physical_display
670 * virtual_push_button physical_push_button.
672 char *config_methods;
675 * os_version - OS Version (WPS)
676 * 4-octet operating system version number
681 * country - Country code
683 * This is the ISO/IEC alpha2 country code for which we are operating
689 * wps_cred_processing - Credential processing
691 * 0 = process received credentials internally
692 * 1 = do not process received credentials; just pass them over
693 * ctrl_iface to external program(s)
694 * 2 = process received credentials internally and pass them over
695 * ctrl_iface to external program(s)
697 int wps_cred_processing;
699 #define MAX_SEC_DEVICE_TYPES 5
701 * sec_device_types - Secondary Device Types (P2P)
703 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
704 int num_sec_device_types;
706 int p2p_listen_reg_class;
707 int p2p_listen_channel;
708 int p2p_oper_reg_class;
709 int p2p_oper_channel;
711 char *p2p_ssid_postfix;
712 int persistent_reconnect;
714 unsigned int num_p2p_pref_chan;
715 struct p2p_channel *p2p_pref_chan;
716 struct wpa_freq_range_list p2p_no_go_freq;
717 int p2p_add_cli_chan;
718 int p2p_ignore_shared_freq;
719 int p2p_optimize_listen_chan;
721 struct wpabuf *wps_vendor_ext_m1;
723 #define MAX_WPS_VENDOR_EXT 10
725 * wps_vendor_ext - Vendor extension attributes in WPS
727 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
730 * p2p_group_idle - Maximum idle time in seconds for P2P group
732 * This value controls how long a P2P group is maintained after there
733 * is no other members in the group. As a GO, this means no associated
734 * stations in the group. As a P2P client, this means no GO seen in
735 * scan results. The maximum idle time is specified in seconds with 0
736 * indicating no time limit, i.e., the P2P group remains in active
737 * state indefinitely until explicitly removed. As a P2P client, the
738 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
739 * this parameter is mainly meant for GO use and for P2P client, it can
740 * only be used to reduce the default timeout to smaller value. A
741 * special value -1 can be used to configure immediate removal of the
742 * group for P2P client role on any disconnection after the data
743 * connection has been established.
748 * p2p_go_freq_change_policy - The GO frequency change policy
750 * This controls the behavior of the GO when there is a change in the
751 * map of the currently used frequencies in case more than one channel
754 * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
755 * possible. In case the GO is the only interface using its frequency
756 * and there are other station interfaces on other frequencies, the GO
757 * will migrate to one of these frequencies.
759 * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
760 * but a transition is possible only in case one of the other used
761 * frequencies is one of the frequencies in the intersection of the
762 * frequency list of the local device and the peer device.
764 * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
766 * @P2P_GO_FREQ_MOVE_SCM_ECSA: Same as
767 * P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS but a transition is possible only
768 * if all the group members advertise eCSA support.
771 P2P_GO_FREQ_MOVE_SCM = 0,
772 P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS = 1,
773 P2P_GO_FREQ_MOVE_STAY = 2,
774 P2P_GO_FREQ_MOVE_SCM_ECSA = 3,
775 P2P_GO_FREQ_MOVE_MAX = P2P_GO_FREQ_MOVE_SCM_ECSA,
776 } p2p_go_freq_change_policy;
778 #define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
781 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
783 * This parameter controls the length of the random passphrase that is
784 * generated at the GO.
786 unsigned int p2p_passphrase_len;
789 * bss_max_count - Maximum number of BSS entries to keep in memory
791 unsigned int bss_max_count;
794 * bss_expiration_age - BSS entry age after which it can be expired
796 * This value controls the time in seconds after which a BSS entry
797 * gets removed if it has not been updated or is not in use.
799 unsigned int bss_expiration_age;
802 * bss_expiration_scan_count - Expire BSS after number of scans
804 * If the BSS entry has not been seen in this many scans, it will be
805 * removed. A value of 1 means that entry is removed after the first
806 * scan in which the BSSID is not seen. Larger values can be used
807 * to avoid BSS entries disappearing if they are not visible in
808 * every scan (e.g., low signal quality or interference).
810 unsigned int bss_expiration_scan_count;
813 * filter_ssids - SSID-based scan result filtering
815 * 0 = do not filter scan results
816 * 1 = only include configured SSIDs in scan results/BSS table
821 * filter_rssi - RSSI-based scan result filtering
823 * 0 = do not filter scan results
824 * -n = filter scan results below -n dBm
829 * max_num_sta - Maximum number of STAs in an AP/P2P GO
831 unsigned int max_num_sta;
834 * freq_list - Array of allowed scan frequencies or %NULL for all
836 * This is an optional zero-terminated array of frequencies in
837 * megahertz (MHz) to allow for narrowing scanning range.
842 * scan_cur_freq - Whether to scan only the current channel
844 * If true, attempt to scan only the current channel if any other
845 * VIFs on this radio are already associated on a particular channel.
850 * changed_parameters - Bitmap of changed parameters since last update
852 unsigned int changed_parameters;
855 * disassoc_low_ack - Disassocicate stations with massive packet loss
857 int disassoc_low_ack;
860 * interworking - Whether Interworking (IEEE 802.11u) is enabled
865 * access_network_type - Access Network Type
867 * When Interworking is enabled, scans will be limited to APs that
868 * advertise the specified Access Network Type (0..15; with 15
869 * indicating wildcard match).
871 int access_network_type;
874 * hessid - Homogenous ESS identifier
876 * If this is set (any octet is non-zero), scans will be used to
877 * request response only from BSSes belonging to the specified
878 * Homogeneous ESS. This is used only if interworking is enabled.
888 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
890 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
891 * by acting as a Registrar and using M1 from the AP. The config
892 * methods attribute in that message is supposed to indicate only the
893 * configuration method supported by the AP in Enrollee role, i.e., to
894 * add an external Registrar. For that case, PBC shall not be used and
895 * as such, the PushButton config method is removed from M1 by default.
896 * If pbc_in_m1=1 is included in the configuration file, the PushButton
897 * config method is left in M1 (if included in config_methods
898 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
899 * a label in the AP).
904 * autoscan - Automatic scan parameters or %NULL if none
906 * This is an optional set of parameters for automatic scanning
907 * within an interface in following format:
908 * <autoscan module name>:<module parameters>
913 * wps_nfc_pw_from_config - NFC Device Password was read from config
915 * This parameter can be determined whether the NFC Device Password was
916 * included in the configuration (1) or generated dynamically (0). Only
917 * the former case is re-written back to the configuration file.
919 int wps_nfc_pw_from_config;
922 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
924 int wps_nfc_dev_pw_id;
927 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
929 struct wpabuf *wps_nfc_dh_pubkey;
932 * wps_nfc_dh_privkey - NFC DH Private Key for password token
934 struct wpabuf *wps_nfc_dh_privkey;
937 * wps_nfc_dev_pw - NFC Device Password for password token
939 struct wpabuf *wps_nfc_dev_pw;
942 * ext_password_backend - External password backend or %NULL if none
944 * format: <backend name>[:<optional backend parameters>]
946 char *ext_password_backend;
949 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
951 * This timeout value is used in P2P GO mode to clean up
953 * By default: 300 seconds.
955 int p2p_go_max_inactivity;
957 struct hostapd_wmm_ac_params wmm_ac_params[4];
960 * auto_interworking - Whether to use network selection automatically
962 * 0 = do not automatically go through Interworking network selection
963 * (i.e., require explicit interworking_select command for this)
964 * 1 = perform Interworking network selection if one or more
965 * credentials have been configured and scan did not find a
966 * matching network block
968 int auto_interworking;
971 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
973 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
974 * Note that regulatory constraints and driver capabilities are
975 * consulted anyway, so setting it to 1 can't do real harm.
976 * By default: 0 (disabled)
981 * p2p_go_vht - Default mode for VHT enable when operating as GO
983 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
984 * Note that regulatory constraints and driver capabilities are
985 * consulted anyway, so setting it to 1 can't do real harm.
986 * By default: 0 (disabled)
991 * p2p_go_ctwindow - CTWindow to use when operating as GO
993 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
994 * the length of the CTWindow in TUs.
999 * p2p_disabled - Whether P2P operations are disabled for this interface
1004 * p2p_no_group_iface - Whether group interfaces can be used
1006 * By default, wpa_supplicant will create a separate interface for P2P
1007 * group operations if the driver supports this. This functionality can
1008 * be disabled by setting this parameter to 1. In that case, the same
1009 * interface that was used for the P2P management operations is used
1010 * also for the group operation.
1012 int p2p_no_group_iface;
1015 * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1017 * If this parameter is set to 1, a connected P2P Client will receive
1018 * and handle Probe Request frames. Setting this parameter to 0
1019 * disables this option. Default value: 0.
1021 * Note: Setting this property at run time takes effect on the following
1022 * interface state transition to/from the WPA_COMPLETED state.
1027 * okc - Whether to enable opportunistic key caching by default
1029 * By default, OKC is disabled unless enabled by the per-network
1030 * proactive_key_caching=1 parameter. okc=1 can be used to change this
1036 * pmf - Whether to enable/require PMF by default
1038 * By default, PMF is disabled unless enabled by the per-network
1039 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
1040 * this default behavior.
1042 enum mfp_options pmf;
1045 * sae_groups - Preference list of enabled groups for SAE
1047 * By default (if this parameter is not set), the mandatory group 19
1048 * (ECC group defined over a 256-bit prime order field) is preferred,
1049 * but other groups are also enabled. If this parameter is set, the
1050 * groups will be tried in the indicated order.
1055 * dtim_period - Default DTIM period in Beacon intervals
1057 * This parameter can be used to set the default value for network
1058 * blocks that do not specify dtim_period.
1063 * beacon_int - Default Beacon interval in TU
1065 * This parameter can be used to set the default value for network
1066 * blocks that do not specify beacon_int.
1071 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1073 * This parameter can be used to define additional vendor specific
1074 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1075 * format for these element(s) is a hexdump of the raw information
1076 * elements (id+len+payload for one or more elements).
1078 struct wpabuf *ap_vendor_elements;
1081 * ignore_old_scan_res - Ignore scan results older than request
1083 * The driver may have a cache of scan results that makes it return
1084 * information that is older than our scan trigger. This parameter can
1085 * be used to configure such old information to be ignored instead of
1086 * allowing it to update the internal BSS table.
1088 int ignore_old_scan_res;
1091 * sched_scan_interval - schedule scan interval
1093 unsigned int sched_scan_interval;
1096 * tdls_external_control - External control for TDLS setup requests
1098 * Enable TDLS mode where external programs are given the control
1099 * to specify the TDLS link to get established to the driver. The
1100 * driver requests the TDLS setup to the supplicant only for the
1101 * specified TDLS peers.
1103 int tdls_external_control;
1107 u8 ip_addr_start[4];
1111 * osu_dir - OSU provider information directory
1113 * If set, allow FETCH_OSU control interface command to be used to fetch
1114 * OSU provider information into all APs and store the results in this
1120 * wowlan_triggers - Wake-on-WLAN triggers
1122 * If set, these wowlan triggers will be configured.
1124 char *wowlan_triggers;
1127 * p2p_search_delay - Extra delay between concurrent search iterations
1129 * Add extra delay (in milliseconds) between search iterations when
1130 * there is a concurrent operation to make p2p_find friendlier to
1131 * concurrent operations by avoiding it from taking 100% of radio
1134 unsigned int p2p_search_delay;
1137 * mac_addr - MAC address policy default
1139 * 0 = use permanent MAC address
1140 * 1 = use random MAC address for each ESS connection
1141 * 2 = like 1, but maintain OUI (with local admin bit set)
1143 * By default, permanent MAC address is used unless policy is changed by
1144 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1145 * change this default behavior.
1150 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1152 unsigned int rand_addr_lifetime;
1155 * preassoc_mac_addr - Pre-association MAC address policy
1157 * 0 = use permanent MAC address
1158 * 1 = use random MAC address
1159 * 2 = like 1, but maintain OUI (with local admin bit set)
1161 int preassoc_mac_addr;
1164 * key_mgmt_offload - Use key management offload
1166 * Key management offload should be used if the device supports it.
1167 * Key management offload is the capability of a device operating as
1168 * a station to do the exchange necessary to establish temporal keys
1169 * during initial RSN connection, after roaming, or during a PTK
1170 * rekeying operation.
1172 int key_mgmt_offload;
1175 * user_mpm - MPM residency
1177 * 0: MPM lives in driver.
1178 * 1: wpa_supplicant handles peering and station allocation.
1180 * If AMPE or SAE is enabled, the MPM is always in userspace.
1185 * max_peer_links - Maximum number of peer links
1187 * Maximum number of mesh peering currently maintained by the STA.
1192 * cert_in_cb - Whether to include a peer certificate dump in events
1194 * This controls whether peer certificates for authentication server and
1195 * its certificate chain are included in EAP peer certificate events.
1200 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1202 * This timeout value is used in mesh STA to clean up inactive stations.
1203 * By default: 300 seconds.
1205 int mesh_max_inactivity;
1208 * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1210 * This timeout value is used in mesh STA to retransmit
1211 * SAE Authentication frame.
1212 * By default: 1000 milliseconds.
1214 int dot11RSNASAERetransPeriod;
1217 * passive_scan - Whether to force passive scan for network connection
1219 * This parameter can be used to force only passive scanning to be used
1220 * for network connection cases. It should be noted that this will slow
1221 * down scan operations and reduce likelihood of finding the AP. In
1222 * addition, some use cases will override this due to functional
1223 * requirements, e.g., for finding an AP that uses hidden SSID
1224 * (scan_ssid=1) or P2P device discovery.
1229 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1231 int reassoc_same_bss_optim;
1234 * wps_priority - Priority for the networks added through WPS
1236 * This priority value will be set to each network profile that is added
1237 * by executing the WPS protocol.
1242 * fst_group_id - FST group ID
1247 * fst_priority - priority of the interface within the FST group
1252 * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1258 * wpa_rsc_relaxation - RSC relaxation on GTK installation
1261 * 0 - use the EAPOL-Key RSC value on GTK installation
1262 * 1 - use the null RSC if a bogus RSC value is detected in message 3
1263 * of 4-Way Handshake or message 1 of Group Key Handshake.
1265 int wpa_rsc_relaxation;
1268 * sched_scan_plans - Scan plans for scheduled scan
1270 * Each scan plan specifies the interval between scans and the number of
1271 * iterations. The last scan plan only specifies the scan interval and
1272 * will be run infinitely.
1274 * format: <interval:iterations> <interval2:iterations2> ... <interval>
1276 char *sched_scan_plans;
1280 /* Prototypes for common functions from config.c */
1282 void wpa_config_free(struct wpa_config *ssid);
1283 void wpa_config_free_ssid(struct wpa_ssid *ssid);
1284 void wpa_config_foreach_network(struct wpa_config *config,
1285 void (*func)(void *, struct wpa_ssid *),
1287 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1288 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1289 int wpa_config_remove_network(struct wpa_config *config, int id);
1290 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1291 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1293 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1295 int wpa_config_dump_values(struct wpa_config *config, char *buf,
1297 int wpa_config_get_value(const char *name, struct wpa_config *config,
1298 char *buf, size_t buflen);
1300 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1301 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1302 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1303 void wpa_config_update_psk(struct wpa_ssid *ssid);
1304 int wpa_config_add_prio_network(struct wpa_config *config,
1305 struct wpa_ssid *ssid);
1306 int wpa_config_update_prio_list(struct wpa_config *config);
1307 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1309 void wpa_config_set_blob(struct wpa_config *config,
1310 struct wpa_config_blob *blob);
1311 void wpa_config_free_blob(struct wpa_config_blob *blob);
1312 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
1313 void wpa_config_flush_blobs(struct wpa_config *config);
1315 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1316 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1317 int wpa_config_remove_cred(struct wpa_config *config, int id);
1318 void wpa_config_free_cred(struct wpa_cred *cred);
1319 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1320 const char *value, int line);
1321 char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
1323 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1324 const char *driver_param);
1325 #ifndef CONFIG_NO_STDOUT_DEBUG
1326 void wpa_config_debug_dump_networks(struct wpa_config *config);
1327 #else /* CONFIG_NO_STDOUT_DEBUG */
1328 #define wpa_config_debug_dump_networks(c) do { } while (0)
1329 #endif /* CONFIG_NO_STDOUT_DEBUG */
1332 /* Prototypes for common functions from config.c */
1333 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1335 int wpa_config_get_num_global_field_names(void);
1337 const char * wpa_config_get_global_field_name(unsigned int i, int *no_var);
1339 /* Prototypes for backend specific functions from the selected config_*.c */
1342 * wpa_config_read - Read and parse configuration database
1343 * @name: Name of the configuration (e.g., path and file name for the
1344 * configuration file)
1345 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
1346 * Returns: Pointer to allocated configuration data or %NULL on failure
1348 * This function reads configuration data, parses its contents, and allocates
1349 * data structures needed for storing configuration information. The allocated
1350 * data can be freed with wpa_config_free().
1352 * Each configuration backend needs to implement this function.
1354 struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
1357 * wpa_config_write - Write or update configuration data
1358 * @name: Name of the configuration (e.g., path and file name for the
1359 * configuration file)
1360 * @config: Configuration data from wpa_config_read()
1361 * Returns: 0 on success, -1 on failure
1363 * This function write all configuration data into an external database (e.g.,
1364 * a text file) in a format that can be read with wpa_config_read(). This can
1365 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1366 * new network is added or a password is changed.
1368 * Each configuration backend needs to implement this function.
1370 int wpa_config_write(const char *name, struct wpa_config *config);
1372 #endif /* CONFIG_H */