1 /*
2  * WPA Supplicant / Configuration file structures
3  * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
7  */
8 
9 #ifndef CONFIG_H
10 #define CONFIG_H
11 
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
21 #define DEFAULT_MESH_FWDING 1
22 /*
23  * The default dot11RSNASAERetransPeriod is defined as 40 ms in the standard,
24  * but use 1000 ms in practice to avoid issues on low power CPUs.
25  */
26 #define DEFAULT_DOT11_RSNA_SAE_RETRANS_PERIOD 1000
27 #define DEFAULT_FAST_REAUTH 1
28 #define DEFAULT_P2P_GO_INTENT 7
29 #define DEFAULT_P2P_INTRA_BSS 1
30 #define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
31 #define DEFAULT_P2P_OPTIMIZE_LISTEN_CHAN 0
32 #define DEFAULT_BSS_MAX_COUNT 200
33 #define DEFAULT_BSS_EXPIRATION_AGE 180
34 #define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
35 #define DEFAULT_MAX_NUM_STA 128
36 #define DEFAULT_AP_ISOLATE 0
37 #define DEFAULT_ACCESS_NETWORK_TYPE 15
38 #define DEFAULT_SCAN_CUR_FREQ 0
39 #define DEFAULT_P2P_SEARCH_DELAY 500
40 #define DEFAULT_RAND_ADDR_LIFETIME 60
41 #define DEFAULT_KEY_MGMT_OFFLOAD 1
42 #define DEFAULT_CERT_IN_CB 1
43 #define DEFAULT_P2P_GO_CTWINDOW 0
44 #define DEFAULT_WPA_RSC_RELAXATION 1
45 #define DEFAULT_MBO_CELL_CAPA MBO_CELL_CAPA_NOT_SUPPORTED
46 #define DEFAULT_DISASSOC_IMMINENT_RSSI_THRESHOLD -75
47 #define DEFAULT_OCE_SUPPORT OCE_STA
48 #define DEFAULT_EXTENDED_KEY_ID 0
49 #define DEFAULT_SCAN_RES_VALID_FOR_CONNECT 5
50 #define DEFAULT_MLD_CONNECT_BAND_PREF MLD_CONNECT_BAND_PREF_AUTO
51 
52 #include "config_ssid.h"
53 #include "wps/wps.h"
54 #include "common/ieee802_11_defs.h"
55 #include "common/ieee802_11_common.h"
56 
57 
58 #define MAX_ROAMING_CONS 36
59 #define MAX_ROAMING_CONS_OI_LEN 15
60 
61 struct wpa_cred {
62           /**
63            * next - Next credential in the list
64            *
65            * This pointer can be used to iterate over all credentials. The head
66            * of this list is stored in the cred field of struct wpa_config.
67            */
68           struct wpa_cred *next;
69 
70           /**
71            * id - Unique id for the credential
72            *
73            * This identifier is used as a unique identifier for each credential
74            * block when using the control interface. Each credential is allocated
75            * an id when it is being created, either when reading the
76            * configuration file or when a new credential is added through the
77            * control interface.
78            */
79           int id;
80 
81           /**
82            * temporary - Whether this credential is temporary and not to be saved
83            */
84           int temporary;
85 
86           /**
87            * priority - Priority group
88            *
89            * By default, all networks and credentials get the same priority group
90            * (0). This field can be used to give higher priority for credentials
91            * (and similarly in struct wpa_ssid for network blocks) to change the
92            * Interworking automatic networking selection behavior. The matching
93            * network (based on either an enabled network block or a credential)
94            * with the highest priority value will be selected.
95            */
96           int priority;
97 
98           /**
99            * pcsc - Use PC/SC and SIM/USIM card
100            */
101           int pcsc;
102 
103           /**
104            * realm - Home Realm for Interworking
105            */
106           char *realm;
107 
108           /**
109            * username - Username for Interworking network selection
110            */
111           char *username;
112 
113           /**
114            * password - Password for Interworking network selection
115            */
116           char *password;
117 
118           /**
119            * ext_password - Whether password is a name for external storage
120            */
121           int ext_password;
122 
123           /**
124            * ca_cert - CA certificate for Interworking network selection
125            */
126           char *ca_cert;
127 
128           /**
129            * client_cert - File path to client certificate file (PEM/DER)
130            *
131            * This field is used with Interworking networking selection for a case
132            * where client certificate/private key is used for authentication
133            * (EAP-TLS). Full path to the file should be used since working
134            * directory may change when wpa_supplicant is run in the background.
135            *
136            * Alternatively, a named configuration blob can be used by setting
137            * this to blob://blob_name.
138            */
139           char *client_cert;
140 
141           /**
142            * private_key - File path to client private key file (PEM/DER/PFX)
143            *
144            * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
145            * commented out. Both the private key and certificate will be read
146            * from the PKCS#12 file in this case. Full path to the file should be
147            * used since working directory may change when wpa_supplicant is run
148            * in the background.
149            *
150            * Windows certificate store can be used by leaving client_cert out and
151            * configuring private_key in one of the following formats:
152            *
153            * cert://substring_to_match
154            *
155            * hash://certificate_thumbprint_in_hex
156            *
157            * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
158            *
159            * Note that when running wpa_supplicant as an application, the user
160            * certificate store (My user account) is used, whereas computer store
161            * (Computer account) is used when running wpasvc as a service.
162            *
163            * Alternatively, a named configuration blob can be used by setting
164            * this to blob://blob_name.
165            */
166           char *private_key;
167 
168           /**
169            * private_key_passwd - Password for private key file
170            */
171           char *private_key_passwd;
172 
173           /**
174            * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
175            */
176           char *imsi;
177 
178           /**
179            * milenage - Milenage parameters for SIM/USIM simulator in
180            *        <Ki>:<OPc>:<SQN> format
181            */
182           char *milenage;
183 
184           /**
185            * imsi_privacy_cert - IMSI privacy certificate
186            *
187            * This field is used with EAP-SIM/AKA/AKA' to encrypt the permanent
188            * identity (IMSI) to improve privacy. The referenced PEM-encoded
189            * X.509v3 certificate needs to include a 2048-bit RSA public key and
190            * this is from the operator who authenticates the SIM/USIM.
191            */
192           char *imsi_privacy_cert;
193 
194           /**
195            * imsi_privacy_attr - IMSI privacy attribute
196            *
197            * This field is used to help the EAP-SIM/AKA/AKA' server to identify
198            * the used certificate (and as such, the matching private key). This
199            * is set to an attribute in name=value format if the operator needs
200            * this information.
201            */
202           char *imsi_privacy_attr;
203 
204           /**
205            * engine - Use an engine for private key operations
206            */
207           int engine;
208 
209           /**
210            * engine_id - String identifying the engine to use
211            */
212           char *engine_id;
213 
214           /**
215            * ca_cert_id - The CA certificate identifier when using an engine
216            */
217           char *ca_cert_id;
218 
219           /**
220            * cert_id - The certificate identifier when using an engine
221            */
222           char *cert_id;
223 
224           /**
225            * key_id - The private key identifier when using an engine
226            */
227           char *key_id;
228 
229           /**
230            * domain_suffix_match - Constraint for server domain name
231            *
232            * If set, this FQDN is used as a suffix match requirement for the AAA
233            * server certificate in SubjectAltName dNSName element(s). If a
234            * matching dNSName is found, this constraint is met. If no dNSName
235            * values are present, this constraint is matched against SubjectName CN
236            * using same suffix match comparison. Suffix match here means that the
237            * host/domain name is compared one label at a time starting from the
238            * top-level domain and all the labels in @domain_suffix_match shall be
239            * included in the certificate. The certificate may include additional
240            * sub-level labels in addition to the required labels.
241            *
242            * For example, domain_suffix_match=example.com would match
243            * test.example.com but would not match test-example.com.
244            */
245           char *domain_suffix_match;
246 
247           /**
248            * domain - Home service provider FQDN(s)
249            *
250            * This is used to compare against the Domain Name List to figure out
251            * whether the AP is operated by the Home SP. Multiple domain entries
252            * can be used to configure alternative FQDNs that will be considered
253            * home networks.
254            */
255           char **domain;
256 
257           /**
258            * num_domain - Number of FQDNs in the domain array
259            */
260           size_t num_domain;
261 
262           /**
263            * home_ois - Home OIs
264            *
265            * If num_home_ois is non-zero, this field contains the set of Home OIs
266            * that can be use to determine which access points support
267            * authentication with this credential. These are an alternative to the
268            * use of the realm parameter. When using Home OIs to match the network,
269            * the EAP parameters need to be pre-configured with the credentials
270            * since the NAI Realm information may not be available or fetched.
271            * A successful authentication with the access point is possible as soon
272            * as at least one Home OI from the list matches an OI in the Roaming
273            * Consortium list advertised by the access point.
274            * (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOI)
275            */
276           u8 home_ois[MAX_ROAMING_CONS][MAX_ROAMING_CONS_OI_LEN];
277 
278           /**
279            * home_ois_len - Length of home_ois[i]
280            */
281           size_t home_ois_len[MAX_ROAMING_CONS];
282 
283           /**
284            * num_home_ois - Number of entries in home_ois
285            */
286           unsigned int num_home_ois;
287 
288           /**
289            * required_home_ois - Required Home OI(s)
290            *
291            * If required_home_ois_len is non-zero, this field contains the set of
292            * Home OI(s) that are required to be advertised by the AP for the
293            * credential to be considered matching.
294            * (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOIRequired)
295            */
296           u8 required_home_ois[MAX_ROAMING_CONS][MAX_ROAMING_CONS_OI_LEN];
297 
298           /**
299            * required_home_ois_len - Length of required_home_ois
300            */
301           size_t required_home_ois_len[MAX_ROAMING_CONS];
302 
303           /**
304            * num_required_home_ois - Number of entries in required_home_ois
305            */
306           unsigned int num_required_home_ois;
307 
308           /**
309            * roaming_consortiums - Roaming Consortium OI(s) memberships
310            *
311            * This field contains one or more OIs identifying the roaming
312            * consortiums of which the provider is a member. The list is sorted
313            * from the most preferred one to the least preferred one. A match
314            * between the Roaming Consortium OIs advertised by an AP and the OIs
315            * in this list indicates that successful authentication is possible.
316            * (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
317            */
318           u8 roaming_consortiums[MAX_ROAMING_CONS][MAX_ROAMING_CONS_OI_LEN];
319 
320           /**
321            * roaming_consortiums_len - Length on roaming_consortiums[i]
322            */
323           size_t roaming_consortiums_len[MAX_ROAMING_CONS];
324 
325           /**
326            * num_roaming_consortiums - Number of entries in roaming_consortiums
327            */
328           unsigned int num_roaming_consortiums;
329 
330           /**
331            * eap_method - EAP method to use
332            *
333            * Pre-configured EAP method to use with this credential or %NULL to
334            * indicate no EAP method is selected, i.e., the method will be
335            * selected automatically based on ANQP information.
336            */
337           struct eap_method_type *eap_method;
338 
339           /**
340            * phase1 - Phase 1 (outer authentication) parameters
341            *
342            * Pre-configured EAP parameters or %NULL.
343            */
344           char *phase1;
345 
346           /**
347            * phase2 - Phase 2 (inner authentication) parameters
348            *
349            * Pre-configured EAP parameters or %NULL.
350            */
351           char *phase2;
352 
353           struct excluded_ssid {
354                     u8 ssid[SSID_MAX_LEN];
355                     size_t ssid_len;
356           } *excluded_ssid;
357           size_t num_excluded_ssid;
358 
359           struct roaming_partner {
360                     char fqdn[128];
361                     int exact_match;
362                     u8 priority;
363                     char country[3];
364           } *roaming_partner;
365           size_t num_roaming_partner;
366 
367           int update_identifier;
368 
369           /**
370            * provisioning_sp - FQDN of the SP that provisioned the credential
371            */
372           char *provisioning_sp;
373 
374           /**
375            * sp_priority - Credential priority within a provisioning SP
376            *
377            * This is the priority of the credential among all credentials
378            * provisionined by the same SP (i.e., for entries that have identical
379            * provisioning_sp value). The range of this priority is 0-255 with 0
380            * being the highest and 255 the lower priority.
381            */
382           int sp_priority;
383 
384           unsigned int min_dl_bandwidth_home;
385           unsigned int min_ul_bandwidth_home;
386           unsigned int min_dl_bandwidth_roaming;
387           unsigned int min_ul_bandwidth_roaming;
388 
389           /**
390            * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
391            * This value is used as the maximum channel utilization for network
392            * selection purposes for home networks. If the AP does not advertise
393            * BSS Load or if the limit would prevent any connection, this
394            * constraint will be ignored.
395            */
396           unsigned int max_bss_load;
397 
398           size_t num_req_conn_capab;
399           u8 *req_conn_capab_proto;
400           int **req_conn_capab_port;
401 
402           /**
403            * ocsp - Whether to use/require OCSP to check server certificate
404            *
405            * 0 = do not use OCSP stapling (TLS certificate status extension)
406            * 1 = try to use OCSP stapling, but not require response
407            * 2 = require valid OCSP stapling response
408            */
409           int ocsp;
410 
411           /**
412            * sim_num - User selected SIM identifier
413            *
414            * This variable is used for identifying which SIM is used if the system
415            * has more than one.
416            */
417           int sim_num;
418 };
419 
420 
421 #define CFG_CHANGED_DEVICE_NAME BIT(0)
422 #define CFG_CHANGED_CONFIG_METHODS BIT(1)
423 #define CFG_CHANGED_DEVICE_TYPE BIT(2)
424 #define CFG_CHANGED_OS_VERSION BIT(3)
425 #define CFG_CHANGED_UUID BIT(4)
426 #define CFG_CHANGED_COUNTRY BIT(5)
427 #define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
428 #define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
429 #define CFG_CHANGED_WPS_STRING BIT(8)
430 #define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
431 #define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
432 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
433 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
434 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
435 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
436 #define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
437 #define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
438 #define CFG_CHANGED_SCHED_SCAN_PLANS BIT(17)
439 #define CFG_CHANGED_WOWLAN_TRIGGERS BIT(18)
440 #define CFG_CHANGED_DISABLE_BTM BIT(19)
441 #define CFG_CHANGED_BGSCAN BIT(20)
442 #define CFG_CHANGED_FT_PREPEND_PMKID BIT(21)
443 
444 /**
445  * struct wpa_config - wpa_supplicant configuration data
446  *
447  * This data structure is presents the per-interface (radio) configuration
448  * data. In many cases, there is only one struct wpa_config instance, but if
449  * more than one network interface is being controlled, one instance is used
450  * for each.
451  */
452 struct wpa_config {
453           /**
454            * ssid - Head of the global network list
455            *
456            * This is the head for the list of all the configured networks.
457            */
458           struct wpa_ssid *ssid;
459 
460           /**
461            * pssid - Per-priority network lists (in priority order)
462            */
463           struct wpa_ssid **pssid;
464 
465           /**
466            * num_prio - Number of different priorities used in the pssid lists
467            *
468            * This indicates how many per-priority network lists are included in
469            * pssid.
470            */
471           size_t num_prio;
472 
473           /**
474            * cred - Head of the credential list
475            *
476            * This is the head for the list of all the configured credentials.
477            */
478           struct wpa_cred *cred;
479 
480           /**
481            * eapol_version - IEEE 802.1X/EAPOL version number
482            *
483            * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
484            * defines EAPOL version 2. However, there are many APs that do not
485            * handle the new version number correctly (they seem to drop the
486            * frames completely). In order to make wpa_supplicant interoperate
487            * with these APs, the version number is set to 1 by default. This
488            * configuration value can be used to set it to the new version (2).
489            */
490           int eapol_version;
491 
492           /**
493            * ap_scan - AP scanning/selection
494            *
495            * By default, wpa_supplicant requests driver to perform AP
496            * scanning and then uses the scan results to select a
497            * suitable AP. Another alternative is to allow the driver to
498            * take care of AP scanning and selection and use
499            * wpa_supplicant just to process EAPOL frames based on IEEE
500            * 802.11 association information from the driver.
501            *
502            * 1: wpa_supplicant initiates scanning and AP selection (default).
503            *
504            * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
505            * association parameters (e.g., WPA IE generation); this mode can
506            * also be used with non-WPA drivers when using IEEE 802.1X mode;
507            * do not try to associate with APs (i.e., external program needs
508            * to control association). This mode must also be used when using
509            * wired Ethernet drivers.
510            *
511            * 2: like 0, but associate with APs using security policy and SSID
512            * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
513            * drivers to enable operation with hidden SSIDs and optimized roaming;
514            * in this mode, the network blocks in the configuration are tried
515            * one by one until the driver reports successful association; each
516            * network block should have explicit security policy (i.e., only one
517            * option in the lists) for key_mgmt, pairwise, group, proto variables.
518            *
519            * Note: ap_scan=2 should not be used with the nl80211 driver interface
520            * (the current Linux interface). ap_scan=1 is optimized work working
521            * with nl80211. For finding networks using hidden SSID, scan_ssid=1 in
522            * the network block can be used with nl80211.
523            */
524           int ap_scan;
525 
526           /**
527            * bgscan - Background scan and roaming parameters or %NULL if none
528            *
529            * This is an optional set of parameters for background scanning and
530            * roaming within a network (ESS). For more detailed information see
531            * ssid block documentation.
532            *
533            * The variable defines default bgscan behavior for all BSS station
534            * networks except for those which have their own bgscan configuration.
535            */
536            char *bgscan;
537 
538           /**
539            * disable_scan_offload - Disable automatic offloading of scan requests
540            *
541            * By default, %wpa_supplicant tries to offload scanning if the driver
542            * indicates support for this (sched_scan). This configuration
543            * parameter can be used to disable this offloading mechanism.
544            */
545           int disable_scan_offload;
546 
547           /**
548            * ctrl_interface - Parameters for the control interface
549            *
550            * If this is specified, %wpa_supplicant will open a control interface
551            * that is available for external programs to manage %wpa_supplicant.
552            * The meaning of this string depends on which control interface
553            * mechanism is used. For all cases, the existence of this parameter
554            * in configuration is used to determine whether the control interface
555            * is enabled.
556            *
557            * For UNIX domain sockets (default on Linux and BSD): This is a
558            * directory that will be created for UNIX domain sockets for listening
559            * to requests from external programs (CLI/GUI, etc.) for status
560            * information and configuration. The socket file will be named based
561            * on the interface name, so multiple %wpa_supplicant processes can be
562            * run at the same time if more than one interface is used.
563            * /var/run/wpa_supplicant is the recommended directory for sockets and
564            * by default, wpa_cli will use it when trying to connect with
565            * %wpa_supplicant.
566            *
567            * Access control for the control interface can be configured
568            * by setting the directory to allow only members of a group
569            * to use sockets. This way, it is possible to run
570            * %wpa_supplicant as root (since it needs to change network
571            * configuration and open raw sockets) and still allow GUI/CLI
572            * components to be run as non-root users. However, since the
573            * control interface can be used to change the network
574            * configuration, this access needs to be protected in many
575            * cases. By default, %wpa_supplicant is configured to use gid
576            * 0 (root). If you want to allow non-root users to use the
577            * control interface, add a new group and change this value to
578            * match with that group. Add users that should have control
579            * interface access to this group.
580            *
581            * When configuring both the directory and group, use following format:
582            * DIR=/var/run/wpa_supplicant GROUP=wheel
583            * DIR=/var/run/wpa_supplicant GROUP=0
584            * (group can be either group name or gid)
585            *
586            * For UDP connections (default on Windows): The value will be ignored.
587            * This variable is just used to select that the control interface is
588            * to be created. The value can be set to, e.g., udp
589            * (ctrl_interface=udp).
590            *
591            * For Windows Named Pipe: This value can be used to set the security
592            * descriptor for controlling access to the control interface. Security
593            * descriptor can be set using Security Descriptor String Format (see
594            * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
595            * The descriptor string needs to be prefixed with SDDL=. For example,
596            * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
597            * all connections).
598            */
599           char *ctrl_interface;
600 
601           /**
602            * ctrl_interface_group - Control interface group (DEPRECATED)
603            *
604            * This variable is only used for backwards compatibility. Group for
605            * UNIX domain sockets should now be specified using GROUP=group in
606            * ctrl_interface variable.
607            */
608           char *ctrl_interface_group;
609 
610           /**
611            * fast_reauth - EAP fast re-authentication (session resumption)
612            *
613            * By default, fast re-authentication is enabled for all EAP methods
614            * that support it. This variable can be used to disable fast
615            * re-authentication (by setting fast_reauth=0). Normally, there is no
616            * need to disable fast re-authentication.
617            */
618           int fast_reauth;
619 
620 #ifndef CONFIG_OPENSC_ENGINE_PATH
621           /**
622            * opensc_engine_path - Path to the OpenSSL engine for opensc
623            *
624            * This is an OpenSSL specific configuration option for loading OpenSC
625            * engine (engine_opensc.so); if %NULL, this engine is not loaded.
626            */
627           char *opensc_engine_path;
628 #endif /* CONFIG_OPENSC_ENGINE_PATH */
629 
630 #ifndef CONFIG_PKCS11_ENGINE_PATH
631           /**
632            * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
633            *
634            * This is an OpenSSL specific configuration option for loading PKCS#11
635            * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
636            */
637           char *pkcs11_engine_path;
638 #endif /* CONFIG_PKCS11_ENGINE_PATH */
639 
640 #ifndef CONFIG_PKCS11_MODULE_PATH
641           /**
642            * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
643            *
644            * This is an OpenSSL specific configuration option for configuring
645            * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
646            * module is not loaded.
647            */
648           char *pkcs11_module_path;
649 #endif /* CONFIG_PKCS11_MODULE_PATH */
650 
651           /**
652            * openssl_ciphers - OpenSSL cipher string
653            *
654            * This is an OpenSSL specific configuration option for configuring the
655            * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
656            * default.
657            */
658           char *openssl_ciphers;
659 
660           /**
661            * pcsc_reader - PC/SC reader name prefix
662            *
663            * If not %NULL, PC/SC reader with a name that matches this prefix is
664            * initialized for SIM/USIM access. Empty string can be used to match
665            * the first available reader.
666            */
667           char *pcsc_reader;
668 
669           /**
670            * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
671            *
672            * This field is used to configure PIN for SIM/USIM for EAP-SIM and
673            * EAP-AKA. If left out, this will be asked through control interface.
674            */
675           char *pcsc_pin;
676 
677           /**
678            * external_sim - Use external processing for SIM/USIM operations
679            */
680           int external_sim;
681 
682           /**
683            * driver_param - Driver interface parameters
684            *
685            * This text string is passed to the selected driver interface with the
686            * optional struct wpa_driver_ops::set_param() handler. This can be
687            * used to configure driver specific options without having to add new
688            * driver interface functionality.
689            */
690           char *driver_param;
691 
692           /**
693            * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
694            *
695            * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
696            * cache (unit: seconds).
697            */
698           unsigned int dot11RSNAConfigPMKLifetime;
699 
700           /**
701            * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
702            *
703            * dot11 MIB variable for the percentage of the PMK lifetime
704            * that should expire before an IEEE 802.1X reauthentication occurs.
705            */
706           unsigned int dot11RSNAConfigPMKReauthThreshold;
707 
708           /**
709            * dot11RSNAConfigSATimeout - Security association timeout
710            *
711            * dot11 MIB variable for the maximum time a security association
712            * shall take to set up (unit: seconds).
713            */
714           unsigned int dot11RSNAConfigSATimeout;
715 
716           /**
717            * ft_prepend_pmkid - Whether to prepend PMKR1Name with PMKIDs
718            *
719            * This control whether PMKR1Name is prepended to the PMKID list
720            * insread of replacing the full list when constructing RSNE for
721            * EAPOL-Key msg 2/4 for FT cases. */
722           bool ft_prepend_pmkid;
723 
724           /**
725            * update_config - Is wpa_supplicant allowed to update configuration
726            *
727            * This variable control whether wpa_supplicant is allow to re-write
728            * its configuration with wpa_config_write(). If this is zero,
729            * configuration data is only changed in memory and the external data
730            * is not overridden. If this is non-zero, wpa_supplicant will update
731            * the configuration data (e.g., a file) whenever configuration is
732            * changed. This update may replace the old configuration which can
733            * remove comments from it in case of a text file configuration.
734            */
735           int update_config;
736 
737           /**
738            * blobs - Configuration blobs
739            */
740           struct wpa_config_blob *blobs;
741 
742           /**
743            * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
744            */
745           u8 uuid[16];
746 
747           /**
748            * auto_uuid - Automatic UUID behavior
749            * 0 = generate static value based on the local MAC address (default)
750            * 1 = generate a random UUID every time wpa_supplicant starts
751            */
752           int auto_uuid;
753 
754           /**
755            * device_name - Device Name (WPS)
756            * User-friendly description of device; up to 32 octets encoded in
757            * UTF-8
758            */
759           char *device_name;
760 
761           /**
762            * manufacturer - Manufacturer (WPS)
763            * The manufacturer of the device (up to 64 ASCII characters)
764            */
765           char *manufacturer;
766 
767           /**
768            * model_name - Model Name (WPS)
769            * Model of the device (up to 32 ASCII characters)
770            */
771           char *model_name;
772 
773           /**
774            * model_number - Model Number (WPS)
775            * Additional device description (up to 32 ASCII characters)
776            */
777           char *model_number;
778 
779           /**
780            * serial_number - Serial Number (WPS)
781            * Serial number of the device (up to 32 characters)
782            */
783           char *serial_number;
784 
785           /**
786            * device_type - Primary Device Type (WPS)
787            */
788           u8 device_type[WPS_DEV_TYPE_LEN];
789 
790           /**
791            * config_methods - Config Methods
792            *
793            * This is a space-separated list of supported WPS configuration
794            * methods. For example, "label virtual_display virtual_push_button
795            * keypad".
796            * Available methods: usba ethernet label display ext_nfc_token
797            * int_nfc_token nfc_interface push_button keypad
798            * virtual_display physical_display
799            * virtual_push_button physical_push_button.
800            */
801           char *config_methods;
802 
803           /**
804            * os_version - OS Version (WPS)
805            * 4-octet operating system version number
806            */
807           u8 os_version[4];
808 
809           /**
810            * country - Country code
811            *
812            * This is the ISO/IEC alpha2 country code for which we are operating
813            * in
814            */
815           char country[2];
816 
817           /**
818            * wps_cred_processing - Credential processing
819            *
820            *   0 = process received credentials internally
821            *   1 = do not process received credentials; just pass them over
822            *        ctrl_iface to external program(s)
823            *   2 = process received credentials internally and pass them over
824            *        ctrl_iface to external program(s)
825            */
826           int wps_cred_processing;
827 
828           /**
829            * wps_cred_add_sae - Whether to enable SAE automatically for WPS
830            *
831            * 0 = only add the explicitly listed WPA2-PSK configuration
832            * 1 = add both the WPA2-PSK and SAE configuration and enable PMF so
833            *     that the station gets configured in WPA3-Personal transition mode
834            *     (supports both WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
835            */
836           int wps_cred_add_sae;
837 
838 #define MAX_SEC_DEVICE_TYPES 5
839           /**
840            * sec_device_types - Secondary Device Types (P2P)
841            */
842           u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
843           int num_sec_device_types;
844 
845           int p2p_listen_reg_class;
846           int p2p_listen_channel;
847           int p2p_oper_reg_class;
848           int p2p_oper_channel;
849           int p2p_go_intent;
850           char *p2p_ssid_postfix;
851           int persistent_reconnect;
852           int p2p_intra_bss;
853           unsigned int num_p2p_pref_chan;
854           struct p2p_channel *p2p_pref_chan;
855           struct wpa_freq_range_list p2p_no_go_freq;
856           int p2p_add_cli_chan;
857           int p2p_ignore_shared_freq;
858           int p2p_optimize_listen_chan;
859 
860           int p2p_6ghz_disable;
861 
862           struct wpabuf *wps_vendor_ext_m1;
863 
864 #define MAX_WPS_VENDOR_EXT 10
865           /**
866            * wps_vendor_ext - Vendor extension attributes in WPS
867            */
868           struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
869 
870           /**
871            * p2p_group_idle - Maximum idle time in seconds for P2P group
872            *
873            * This value controls how long a P2P group is maintained after there
874            * is no other members in the group. As a GO, this means no associated
875            * stations in the group. As a P2P client, this means no GO seen in
876            * scan results. The maximum idle time is specified in seconds with 0
877            * indicating no time limit, i.e., the P2P group remains in active
878            * state indefinitely until explicitly removed. As a P2P client, the
879            * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
880            * this parameter is mainly meant for GO use and for P2P client, it can
881            * only be used to reduce the default timeout to smaller value. A
882            * special value -1 can be used to configure immediate removal of the
883            * group for P2P client role on any disconnection after the data
884            * connection has been established.
885            */
886           int p2p_group_idle;
887 
888           /**
889            * p2p_go_freq_change_policy - The GO frequency change policy
890            *
891            * This controls the behavior of the GO when there is a change in the
892            * map of the currently used frequencies in case more than one channel
893            * is supported.
894            *
895            * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
896            * possible. In case the GO is the only interface using its frequency
897            * and there are other station interfaces on other frequencies, the GO
898            * will migrate to one of these frequencies.
899            *
900            * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
901            * but a transition is possible only in case one of the other used
902            * frequencies is one of the frequencies in the intersection of the
903            * frequency list of the local device and the peer device.
904            *
905            * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
906            *
907            * @P2P_GO_FREQ_MOVE_SCM_ECSA: Same as
908            * P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS but a transition is possible only
909            * if all the group members advertise eCSA support.
910            */
911           enum {
912                     P2P_GO_FREQ_MOVE_SCM = 0,
913                     P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS = 1,
914                     P2P_GO_FREQ_MOVE_STAY = 2,
915                     P2P_GO_FREQ_MOVE_SCM_ECSA = 3,
916                     P2P_GO_FREQ_MOVE_MAX = P2P_GO_FREQ_MOVE_SCM_ECSA,
917           } p2p_go_freq_change_policy;
918 
919 #define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
920 
921           /**
922            * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
923            *
924            * This parameter controls the length of the random passphrase that is
925            * generated at the GO.
926            */
927           unsigned int p2p_passphrase_len;
928 
929           /**
930            * bss_max_count - Maximum number of BSS entries to keep in memory
931            */
932           unsigned int bss_max_count;
933 
934           /**
935            * bss_expiration_age - BSS entry age after which it can be expired
936            *
937            * This value controls the time in seconds after which a BSS entry
938            * gets removed if it has not been updated or is not in use.
939            */
940           unsigned int bss_expiration_age;
941 
942           /**
943            * bss_expiration_scan_count - Expire BSS after number of scans
944            *
945            * If the BSS entry has not been seen in this many scans, it will be
946            * removed. A value of 1 means that entry is removed after the first
947            * scan in which the BSSID is not seen. Larger values can be used
948            * to avoid BSS entries disappearing if they are not visible in
949            * every scan (e.g., low signal quality or interference).
950            */
951           unsigned int bss_expiration_scan_count;
952 
953           /**
954            * filter_ssids - SSID-based scan result filtering
955            *
956            *   0 = do not filter scan results
957            *   1 = only include configured SSIDs in scan results/BSS table
958            */
959           int filter_ssids;
960 
961           /**
962            * filter_rssi - RSSI-based scan result filtering
963            *
964            * 0 = do not filter scan results
965            * -n = filter scan results below -n dBm
966            */
967           int filter_rssi;
968 
969           /**
970            * max_num_sta - Maximum number of STAs in an AP/P2P GO
971            */
972           unsigned int max_num_sta;
973 
974           /**
975            * ap_isolate - Whether to use client isolation feature
976            *
977            * Client isolation can be used to prevent low-level bridging of
978            * frames between associated stations in the BSS. By default,
979            * this bridging is allowed (ap_isolate=0); except in P2P GO case,
980            * where p2p_intra_bss parameter is used to determine whether to allow
981            * intra-BSS forwarding (ap_isolate = !p2p_intra_bss).
982            *
983            * 0 = do not enable AP isolation
984            * 1 = enable AP isolation
985            */
986           int ap_isolate;
987 
988           /**
989            * freq_list - Array of allowed scan frequencies or %NULL for all
990            *
991            * This is an optional zero-terminated array of frequencies in
992            * megahertz (MHz) to allow for narrowing scanning range.
993            */
994           int *freq_list;
995 
996           /**
997            * initial_freq_list - like freq_list but for initial scan
998            *
999            * This is an optional zero-terminated array of frequencies in
1000            * megahertz (MHz) to allow for narrowing scanning range when
1001            * the application is started.
1002            *
1003            * This can be used to speed up initial connection time if the
1004            * channel is known ahead of time, without limiting the scanned
1005            * frequencies during normal use.
1006            */
1007           int *initial_freq_list;
1008 
1009           /**
1010            * scan_cur_freq - Whether to scan only the current channel
1011            *
1012            * If true, attempt to scan only the current channel if any other
1013            * VIFs on this radio are already associated on a particular channel.
1014            */
1015           int scan_cur_freq;
1016 
1017           /**
1018            * scan_res_valid_for_connect - Seconds scans are valid for association
1019            *
1020            * This configures the number of seconds old scan results are considered
1021            * valid for association. When scan results are older than this value
1022            * a new scan is triggered prior to the association.
1023            */
1024           int scan_res_valid_for_connect;
1025 
1026           /**
1027            * changed_parameters - Bitmap of changed parameters since last update
1028            */
1029           unsigned int changed_parameters;
1030 
1031           /**
1032            * disassoc_low_ack - Disassociate stations with massive packet loss
1033            */
1034           int disassoc_low_ack;
1035 
1036           /**
1037            * interworking - Whether Interworking (IEEE 802.11u) is enabled
1038            */
1039           int interworking;
1040 
1041           /**
1042            * access_network_type - Access Network Type
1043            *
1044            * When Interworking is enabled, scans will be limited to APs that
1045            * advertise the specified Access Network Type (0..15; with 15
1046            * indicating wildcard match).
1047            */
1048           int access_network_type;
1049 
1050            /**
1051             * go_interworking - Whether Interworking for P2P GO is enabled
1052             */
1053           int go_interworking;
1054 
1055           /**
1056            * go_access_network_type - P2P GO Access Network Type
1057            *
1058            * This indicates which access network type to advertise if Interworking
1059            * is enabled for P2P GO.
1060            */
1061           int go_access_network_type;
1062 
1063           /**
1064            * go_internet - Interworking: Internet connectivity (0 or 1)
1065            */
1066           int go_internet;
1067 
1068           /**
1069            * go_venue_group - Interworking: Venue group
1070            */
1071           int go_venue_group;
1072 
1073           /**
1074            * go_venue_type: Interworking: Venue type
1075            */
1076           int go_venue_type;
1077 
1078           /**
1079            * hessid - Homogeneous ESS identifier
1080            *
1081            * If this is set (any octet is non-zero), scans will be used to
1082            * request response only from BSSes belonging to the specified
1083            * Homogeneous ESS. This is used only if interworking is enabled.
1084            */
1085           u8 hessid[ETH_ALEN];
1086 
1087           /**
1088            * hs20 - Hotspot 2.0
1089            */
1090           int hs20;
1091 
1092           /**
1093            * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
1094            *
1095            * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
1096            * by acting as a Registrar and using M1 from the AP. The config
1097            * methods attribute in that message is supposed to indicate only the
1098            * configuration method supported by the AP in Enrollee role, i.e., to
1099            * add an external Registrar. For that case, PBC shall not be used and
1100            * as such, the PushButton config method is removed from M1 by default.
1101            * If pbc_in_m1=1 is included in the configuration file, the PushButton
1102            * config method is left in M1 (if included in config_methods
1103            * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
1104            * a label in the AP).
1105            */
1106           int pbc_in_m1;
1107 
1108           /**
1109            * autoscan - Automatic scan parameters or %NULL if none
1110            *
1111            * This is an optional set of parameters for automatic scanning
1112            * within an interface in following format:
1113            * <autoscan module name>:<module parameters>
1114            */
1115           char *autoscan;
1116 
1117           /**
1118            * wps_nfc_pw_from_config - NFC Device Password was read from config
1119            *
1120            * This parameter can be determined whether the NFC Device Password was
1121            * included in the configuration (1) or generated dynamically (0). Only
1122            * the former case is re-written back to the configuration file.
1123            */
1124           int wps_nfc_pw_from_config;
1125 
1126           /**
1127            * wps_nfc_dev_pw_id - NFC Device Password ID for password token
1128            */
1129           int wps_nfc_dev_pw_id;
1130 
1131           /**
1132            * wps_nfc_dh_pubkey - NFC DH Public Key for password token
1133            */
1134           struct wpabuf *wps_nfc_dh_pubkey;
1135 
1136           /**
1137            * wps_nfc_dh_privkey - NFC DH Private Key for password token
1138            */
1139           struct wpabuf *wps_nfc_dh_privkey;
1140 
1141           /**
1142            * wps_nfc_dev_pw - NFC Device Password for password token
1143            */
1144           struct wpabuf *wps_nfc_dev_pw;
1145 
1146           /**
1147            * ext_password_backend - External password backend or %NULL if none
1148            *
1149            * format: <backend name>[:<optional backend parameters>]
1150            */
1151           char *ext_password_backend;
1152 
1153           /*
1154            * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
1155            *
1156            * This timeout value is used in P2P GO mode to clean up
1157            * inactive stations.
1158            * By default: 300 seconds.
1159            */
1160           int p2p_go_max_inactivity;
1161 
1162           struct hostapd_wmm_ac_params wmm_ac_params[4];
1163           struct hostapd_tx_queue_params tx_queue[4];
1164 
1165           /**
1166            * auto_interworking - Whether to use network selection automatically
1167            *
1168            * 0 = do not automatically go through Interworking network selection
1169            *     (i.e., require explicit interworking_select command for this)
1170            * 1 = perform Interworking network selection if one or more
1171            *     credentials have been configured and scan did not find a
1172            *     matching network block
1173            */
1174           int auto_interworking;
1175 
1176           /**
1177            * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
1178            *
1179            * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1180            * Note that regulatory constraints and driver capabilities are
1181            * consulted anyway, so setting it to 1 can't do real harm.
1182            * By default: 0 (disabled)
1183            */
1184           int p2p_go_ht40;
1185 
1186           /**
1187            * p2p_go_vht - Default mode for VHT enable when operating as GO
1188            *
1189            * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1190            * Note that regulatory constraints and driver capabilities are
1191            * consulted anyway, so setting it to 1 can't do real harm.
1192            * By default: 0 (disabled)
1193            */
1194           int p2p_go_vht;
1195 
1196           /**
1197            * p2p_go_edmg - Default mode for EDMG enable when operating as GO
1198            *
1199            * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1200            * Note that regulatory constraints and driver capabilities are
1201            * consulted anyway, so setting it to 1 can't do real harm.
1202            * By default: 0 (disabled)
1203            */
1204           int p2p_go_edmg;
1205 
1206           /**
1207            * p2p_go_he - Default mode for 11ax HE enable when operating as GO
1208            *
1209            * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1210            * Note that regulatory constraints and driver capabilities are
1211            * consulted anyway, so setting it to 1 can't do real harm.
1212            * By default: 0 (disabled)
1213            */
1214           int p2p_go_he;
1215 
1216           /**
1217            * p2p_go_ctwindow - CTWindow to use when operating as GO
1218            *
1219            * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
1220            * the length of the CTWindow in TUs.
1221            */
1222           int p2p_go_ctwindow;
1223 
1224           /**
1225            * p2p_disabled - Whether P2P operations are disabled for this interface
1226            */
1227           int p2p_disabled;
1228 
1229           /**
1230            * p2p_no_group_iface - Whether group interfaces can be used
1231            *
1232            * By default, wpa_supplicant will create a separate interface for P2P
1233            * group operations if the driver supports this. This functionality can
1234            * be disabled by setting this parameter to 1. In that case, the same
1235            * interface that was used for the P2P management operations is used
1236            * also for the group operation.
1237            */
1238           int p2p_no_group_iface;
1239 
1240           /**
1241            * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1242            *
1243            * If this parameter is set to 1, a connected P2P Client will receive
1244            * and handle Probe Request frames. Setting this parameter to 0
1245            * disables this option. Default value: 0.
1246            *
1247            * Note: Setting this property at run time takes effect on the following
1248            * interface state transition to/from the WPA_COMPLETED state.
1249            */
1250           int p2p_cli_probe;
1251 
1252           /**
1253            * okc - Whether to enable opportunistic key caching by default
1254            *
1255            * By default, OKC is disabled unless enabled by the per-network
1256            * proactive_key_caching=1 parameter. okc=1 can be used to change this
1257            * default behavior.
1258            */
1259           int okc;
1260 
1261           /**
1262            * pmf - Whether to enable/require PMF by default
1263            *
1264            * By default, PMF is disabled unless enabled by the per-network
1265            * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
1266            * this default behavior for RSN network (this is not applicable for
1267            * non-RSN cases).
1268            */
1269           enum mfp_options pmf;
1270 
1271           /**
1272            * sae_check_mfp - Whether to limit SAE based on PMF capabilities
1273            *
1274            * With this check SAE key_mgmt will not be selected if PMF is
1275            * not enabled.
1276            * Scenarios where enabling this check will limit SAE:
1277            *  1) ieee8011w=0 is set for the network.
1278            *  2) The AP does not have PMF enabled.
1279            *  3) ieee8011w for the network is the default(3), pmf=1 is enabled
1280            *     globally and the device does not support the BIP cipher.
1281            *
1282            * Useful to allow the BIP cipher check that occurs for ieee80211w=3
1283            * and pmf=1 to also avoid using SAE key_mgmt.
1284            * Useful when hardware does not support BIP to still to allow
1285            * connecting to sae_require_mfp=1 WPA2+WPA3-Personal transition mode
1286            *access points by automatically selecting PSK instead of SAE.
1287            */
1288           int sae_check_mfp;
1289 
1290           /**
1291            * sae_groups - Preference list of enabled groups for SAE
1292            *
1293            * By default (if this parameter is not set), the mandatory group 19
1294            * (ECC group defined over a 256-bit prime order field) is preferred,
1295            * but other groups are also enabled. If this parameter is set, the
1296            * groups will be tried in the indicated order.
1297            */
1298           int *sae_groups;
1299 
1300           /**
1301            * sae_pwe - SAE mechanism for PWE derivation
1302            * 0 = hunting-and-pecking loop only
1303            * 1 = hash-to-element only
1304            * 2 = both hunting-and-pecking loop and hash-to-element enabled
1305            */
1306           enum sae_pwe sae_pwe;
1307 
1308           /**
1309            * sae_pmkid_in_assoc - Whether to include PMKID in SAE Assoc Req
1310            */
1311           int sae_pmkid_in_assoc;
1312 
1313           /**
1314            * dtim_period - Default DTIM period in Beacon intervals
1315            *
1316            * This parameter can be used to set the default value for network
1317            * blocks that do not specify dtim_period.
1318            */
1319           int dtim_period;
1320 
1321           /**
1322            * beacon_int - Default Beacon interval in TU
1323            *
1324            * This parameter can be used to set the default value for network
1325            * blocks that do not specify beacon_int.
1326            */
1327           int beacon_int;
1328 
1329           /**
1330            * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1331            *
1332            * This parameter can be used to define additional vendor specific
1333            * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1334            * format for these element(s) is a hexdump of the raw information
1335            * elements (id+len+payload for one or more elements).
1336            */
1337           struct wpabuf *ap_vendor_elements;
1338 
1339           /**
1340            * ap_assocresp_elements: Vendor specific elements for (Re)Association
1341            * Response frames
1342            *
1343            * This parameter can be used to define additional vendor specific
1344            * elements for (Re)Association Response frames in AP/P2P GO mode. The
1345            * format for these element(s) is a hexdump of the raw information
1346            * elements (id+len+payload for one or more elements).
1347            */
1348           struct wpabuf *ap_assocresp_elements;
1349 
1350           /**
1351            * ignore_old_scan_res - Ignore scan results older than request
1352            *
1353            * The driver may have a cache of scan results that makes it return
1354            * information that is older than our scan trigger. This parameter can
1355            * be used to configure such old information to be ignored instead of
1356            * allowing it to update the internal BSS table.
1357            */
1358           int ignore_old_scan_res;
1359 
1360           /**
1361            * sched_scan_interval -  schedule scan interval
1362            */
1363           unsigned int sched_scan_interval;
1364 
1365           /**
1366            * sched_scan_start_delay - Schedule scan start delay before first scan
1367            *
1368            * Delay (in seconds) before scheduling first scan plan cycle. The
1369            * driver may ignore this parameter and start immediately (or at any
1370            * other time), if this feature is not supported.
1371            */
1372           unsigned int sched_scan_start_delay;
1373 
1374           /**
1375            * tdls_external_control - External control for TDLS setup requests
1376            *
1377            * Enable TDLS mode where external programs are given the control
1378            * to specify the TDLS link to get established to the driver. The
1379            * driver requests the TDLS setup to the supplicant only for the
1380            * specified TDLS peers.
1381            */
1382           int tdls_external_control;
1383 
1384           u8 ip_addr_go[4];
1385           u8 ip_addr_mask[4];
1386           u8 ip_addr_start[4];
1387           u8 ip_addr_end[4];
1388 
1389           /**
1390            * osu_dir - OSU provider information directory
1391            *
1392            * If set, allow FETCH_OSU control interface command to be used to fetch
1393            * OSU provider information into all APs and store the results in this
1394            * directory.
1395            */
1396           char *osu_dir;
1397 
1398           /**
1399            * wowlan_triggers - Wake-on-WLAN triggers
1400            *
1401            * If set, these wowlan triggers will be configured.
1402            */
1403           char *wowlan_triggers;
1404 
1405           /**
1406            * p2p_search_delay - Extra delay between concurrent search iterations
1407            *
1408            * Add extra delay (in milliseconds) between search iterations when
1409            * there is a concurrent operation to make p2p_find friendlier to
1410            * concurrent operations by avoiding it from taking 100% of radio
1411            * resources.
1412            */
1413           unsigned int p2p_search_delay;
1414 
1415           /**
1416            * mac_addr - MAC address policy default
1417            *
1418            * 0 = use permanent MAC address
1419            * 1 = use random MAC address for each ESS connection
1420            * 2 = like 1, but maintain OUI (with local admin bit set)
1421            *
1422            * By default, permanent MAC address is used unless policy is changed by
1423            * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1424            * change this default behavior.
1425            */
1426           enum wpas_mac_addr_style mac_addr;
1427 
1428           /**
1429            * rand_addr_lifetime - Lifetime of random MAC address in seconds
1430            */
1431           unsigned int rand_addr_lifetime;
1432 
1433           /**
1434            * preassoc_mac_addr - Pre-association MAC address policy
1435            *
1436            * 0 = use permanent MAC address
1437            * 1 = use random MAC address
1438            * 2 = like 1, but maintain OUI (with local admin bit set)
1439            */
1440           enum wpas_mac_addr_style preassoc_mac_addr;
1441 
1442           /**
1443            * key_mgmt_offload - Use key management offload
1444            *
1445            * Key management offload should be used if the device supports it.
1446            * Key management offload is the capability of a device operating as
1447            * a station to do the exchange necessary to establish temporal keys
1448            * during initial RSN connection, after roaming, or during a PTK
1449            * rekeying operation.
1450            */
1451           int key_mgmt_offload;
1452 
1453           /**
1454            * user_mpm - MPM residency
1455            *
1456            * 0: MPM lives in driver.
1457            * 1: wpa_supplicant handles peering and station allocation.
1458            *
1459            * If AMPE or SAE is enabled, the MPM is always in userspace.
1460            */
1461           int user_mpm;
1462 
1463           /**
1464            * max_peer_links - Maximum number of peer links
1465            *
1466            * Maximum number of mesh peering currently maintained by the STA.
1467            */
1468           int max_peer_links;
1469 
1470           /**
1471            * cert_in_cb - Whether to include a peer certificate dump in events
1472            *
1473            * This controls whether peer certificates for authentication server and
1474            * its certificate chain are included in EAP peer certificate events.
1475            */
1476           int cert_in_cb;
1477 
1478           /**
1479            * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1480            *
1481            * This timeout value is used in mesh STA to clean up inactive stations.
1482            * By default: 300 seconds.
1483            */
1484           int mesh_max_inactivity;
1485 
1486           /**
1487            * mesh_fwding - Mesh network layer-2 forwarding (dot11MeshForwarding)
1488            *
1489            * This controls whether to enable layer-2 forwarding.
1490            * By default: 1: enabled
1491            */
1492           int mesh_fwding;
1493 
1494           /**
1495            * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1496            *
1497            * This timeout value is used in mesh STA to retransmit
1498            * SAE Authentication frame.
1499            * By default: 1000 milliseconds.
1500            */
1501           int dot11RSNASAERetransPeriod;
1502 
1503           /**
1504            * passive_scan - Whether to force passive scan for network connection
1505            *
1506            * This parameter can be used to force only passive scanning to be used
1507            * for network connection cases. It should be noted that this will slow
1508            * down scan operations and reduce likelihood of finding the AP. In
1509            * addition, some use cases will override this due to functional
1510            * requirements, e.g., for finding an AP that uses hidden SSID
1511            * (scan_ssid=1) or P2P device discovery.
1512            */
1513           int passive_scan;
1514 
1515           /**
1516            * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1517            */
1518           int reassoc_same_bss_optim;
1519 
1520           /**
1521            * wps_priority - Priority for the networks added through WPS
1522            *
1523            * This priority value will be set to each network profile that is added
1524            * by executing the WPS protocol.
1525            */
1526           int wps_priority;
1527 
1528           /**
1529            * fst_group_id - FST group ID
1530            */
1531           char *fst_group_id;
1532 
1533           /**
1534            * fst_priority - priority of the interface within the FST group
1535            */
1536           int fst_priority;
1537 
1538           /**
1539            * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1540            * interface.
1541            */
1542           int fst_llt;
1543 
1544            /**
1545             * wpa_rsc_relaxation - RSC relaxation on GTK installation
1546             *
1547             * Values:
1548             * 0 - use the EAPOL-Key RSC value on GTK installation
1549             * 1 - use the null RSC if a bogus RSC value is detected in message 3
1550             * of 4-Way Handshake or message 1 of Group Key Handshake.
1551             */
1552            int wpa_rsc_relaxation;
1553 
1554           /**
1555            * sched_scan_plans - Scan plans for scheduled scan
1556            *
1557            * Each scan plan specifies the interval between scans and the number of
1558            * iterations. The last scan plan only specifies the scan interval and
1559            * will be run infinitely.
1560            *
1561            * format: <interval:iterations> <interval2:iterations2> ... <interval>
1562            */
1563            char *sched_scan_plans;
1564 
1565 #ifdef CONFIG_MBO
1566           /**
1567            * non_pref_chan - Non-preferred channels list, separated by spaces.
1568            *
1569            * format: op_class:chan:preference:reason<:detail>
1570            * Detail is optional.
1571            */
1572           char *non_pref_chan;
1573 
1574           /**
1575            * mbo_cell_capa - Cellular capabilities for MBO
1576            */
1577           enum mbo_cellular_capa mbo_cell_capa;
1578 
1579           /**
1580            * disassoc_imminent_rssi_threshold - RSSI threshold of candidate AP
1581            * when disassociation imminent is set.
1582            */
1583           int disassoc_imminent_rssi_threshold;
1584 
1585           /**
1586            * oce - Enable OCE in STA and/or STA-CFON mode
1587            *  - Set BIT(0) to enable OCE in non-AP STA mode
1588            *  - Set BIT(1) to enable OCE in STA-CFON mode
1589            */
1590           unsigned int oce;
1591 #endif /* CONFIG_MBO */
1592 
1593           /**
1594            * gas_address3 - GAS Address3 field behavior
1595            *
1596            * Values:
1597            * 0 - P2P specification (Address3 = AP BSSID)
1598            * 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
1599            *        sent to not-associated AP; if associated, AP BSSID)
1600            */
1601           int gas_address3;
1602 
1603           /**
1604            * ftm_responder - Publish FTM (fine timing measurement)
1605            * responder functionality
1606            *
1607            * Values:
1608            * 0 - do not publish FTM responder functionality (Default)
1609            * 1 - publish FTM responder functionality in
1610            *        bit 70 of Extended Capabilities element
1611            * Note, actual FTM responder operation is managed outside
1612            * wpa_supplicant.
1613            */
1614           int ftm_responder;
1615 
1616           /**
1617            * ftm_initiator - Publish FTM (fine timing measurement)
1618            * initiator functionality
1619            *
1620            * Values:
1621            * 0 - do not publish FTM initiator functionality (Default)
1622            * 1 - publish FTM initiator functionality in
1623            *        bit 71 of Extended Capabilities element
1624            * Note, actual FTM initiator operation is managed outside
1625            * wpa_supplicant.
1626            */
1627           int ftm_initiator;
1628 
1629           /**
1630            * gas_rand_addr_lifetime - Lifetime of random MAC address for ANQP in
1631            *        seconds
1632            */
1633           unsigned int gas_rand_addr_lifetime;
1634 
1635           /**
1636            * gas_rand_mac_addr - GAS MAC address policy
1637            *
1638            * 0 = use permanent MAC address
1639            * 1 = use random MAC address
1640            * 2 = like 1, but maintain OUI (with local admin bit set)
1641            */
1642           enum wpas_mac_addr_style gas_rand_mac_addr;
1643 
1644           /**
1645            * dpp_config_processing - How to process DPP configuration
1646            *
1647            * 0 = report received configuration to an external program for
1648            *        processing; do not generate any network profile internally
1649            * 1 = report received configuration to an external program and generate
1650            *        a network profile internally, but do not automatically connect
1651            *        to the created (disabled) profile; the network profile id is
1652            *        reported to external programs
1653            * 2 = report received configuration to an external program, generate
1654            *        a network profile internally, try to connect to the created
1655            *        profile automatically
1656            */
1657           int dpp_config_processing;
1658 
1659           /**
1660            * dpp_name - Name for Enrollee's DPP Configuration Request
1661            */
1662           char *dpp_name;
1663 
1664           /**
1665            * dpp_mud_url - MUD URL for Enrollee's DPP Configuration Request
1666            */
1667           char *dpp_mud_url;
1668 
1669           /**
1670            * dpp_extra_conf_req_name - JSON node name of additional data for
1671            * Enrollee's DPP Configuration Request
1672            */
1673           char *dpp_extra_conf_req_name;
1674 
1675           /**
1676            * dpp_extra_conf_req_value - JSON node data of additional data for
1677            * Enrollee's DPP Configuration Request
1678            */
1679           char *dpp_extra_conf_req_value;
1680 
1681           /* dpp_connector_privacy_default - Default valur for Connector privacy
1682            *
1683            * This value is used as the default for the dpp_connector_privacy
1684            * network parameter for all new networks provisioned using DPP.
1685            */
1686           int dpp_connector_privacy_default;
1687 
1688           /**
1689            * coloc_intf_reporting - Colocated interference reporting
1690            *
1691            * dot11CoLocIntfReportingActivated
1692            * 0 = disabled (false)
1693            * 1 = enabled (true)
1694            */
1695           int coloc_intf_reporting;
1696 
1697           /**
1698            * p2p_device_random_mac_addr - P2P Device MAC address policy default
1699            *
1700            * 0 = use permanent MAC address (the one set by default by the device
1701            *     driver). Notice that, if the device driver is configured to
1702            *     always use random MAC addresses, this flag breaks reinvoking a
1703            *     persistent group, so flags 1 or 2 should be used instead with
1704            *     such drivers if persistent groups are used.
1705            * 1 = use random MAC address on creating the interface if there is no
1706            *     persistent group. Besides, if a persistent group is created,
1707            *     p2p_device_persistent_mac_addr is set to the MAC address of the
1708            *     P2P Device interface, so that this address will be subsequently
1709            *     used to change the MAC address of the P2P Device interface. With
1710            *     no persistent group, the random MAC address is created by
1711            *     wpa_supplicant, changing the one set by the device driver.
1712            *     The device driver shall support SIOCGIFFLAGS/SIOCSIFFLAGS ioctl
1713            *     interface control operations.
1714            * 2 = this flag should be used when the device driver uses random MAC
1715            *     addresses by default when a P2P Device interface is created.
1716            *     If p2p_device_persistent_mac_addr is set, use this MAC address
1717            *     on creating the P2P Device interface. If not set, use the
1718            *     default method adopted by the device driver (e.g., random MAC
1719            *     address). Besides, if a persistent group is created,
1720            *     p2p_device_persistent_mac_addr is set to the MAC address of the
1721            *     P2P Device interface, so that this address will be subsequently
1722            *     used in place of the default address set by the device driver.
1723            *     (This option does not need support of SIOCGIFFLAGS/SIOCSIFFLAGS
1724            *     ioctl interface control operations and uses NL80211_ATTR_MAC).
1725            *
1726            * By default, permanent MAC address is used.
1727            */
1728           int p2p_device_random_mac_addr;
1729 
1730           /**
1731            * p2p_device_persistent_mac_addr - Record last used MAC address
1732            *
1733            * If there are saved persistent groups, P2P cannot generate another
1734            * random MAC address, and need to restore to last used MAC address.
1735            */
1736           u8 p2p_device_persistent_mac_addr[ETH_ALEN];
1737 
1738           /**
1739            * p2p_interface_random_mac_addr - P2P Interface MAC address policy default
1740            *
1741            * 0 = use permanent MAC address
1742            * 1 = use random MAC address on creating the interface.
1743            *
1744            * By default, permanent MAC address is used.
1745            */
1746           int p2p_interface_random_mac_addr;
1747 
1748           /**
1749            * disable_btm - Disable BSS transition management in STA
1750            * - Set to 0 to enable BSS transition management
1751            * - Set to 1 to disable BSS transition management
1752            *
1753            * By default BSS transition management is enabled
1754            */
1755           int disable_btm;
1756 
1757           /**
1758            * extended_key_id - Extended Key ID support
1759            *
1760            * IEEE Std 802.11-2016 optionally allows to use Key ID 0 and 1 for PTK
1761            * keys with Extended Key ID.
1762            *
1763            * 0 = don't use Extended Key ID
1764            * 1 = use Extended Key ID when possible
1765            */
1766           int extended_key_id;
1767 
1768           /**
1769            * wowlan_disconnect_on_deinit - Trigger disconnect on wpa_supplicant
1770            * interface deinit even if the driver has enabled WoWLAN.
1771            *
1772            * 0 = Do not disconnect
1773            * 1 = Trigger disconnection
1774            */
1775           int wowlan_disconnect_on_deinit;
1776 
1777 #ifdef CONFIG_PASN
1778 #ifdef CONFIG_TESTING_OPTIONS
1779           /*
1780            * Normally, KDK should be derived if and only if both sides support
1781            * secure LTF. Allow forcing KDK derivation for testing purposes.
1782            */
1783           int force_kdk_derivation;
1784 
1785           /* If set, corrupt the MIC in the 3rd Authentication frame of PASN */
1786           int pasn_corrupt_mic;
1787 
1788 #endif /* CONFIG_TESTING_OPTIONS */
1789 #endif /* CONFIG_PASN*/
1790 
1791 #ifdef CONFIG_TESTING_OPTIONS
1792           enum {
1793                     MLD_CONNECT_BAND_PREF_AUTO = 0,
1794                     MLD_CONNECT_BAND_PREF_2GHZ = 1,
1795                     MLD_CONNECT_BAND_PREF_5GHZ = 2,
1796                     MLD_CONNECT_BAND_PREF_6GHZ = 3,
1797                     MLD_CONNECT_BAND_PREF_MAX = 4,
1798           }  mld_connect_band_pref;
1799 
1800           u8 mld_connect_bssid_pref[ETH_ALEN];
1801 
1802           int mld_force_single_link;
1803 #endif /* CONFIG_TESTING_OPTIONS */
1804 };
1805 
1806 
1807 /* Prototypes for common functions from config.c */
1808 
1809 void wpa_config_free(struct wpa_config *ssid);
1810 void wpa_config_free_ssid(struct wpa_ssid *ssid);
1811 void wpa_config_foreach_network(struct wpa_config *config,
1812                                         void (*func)(void *, struct wpa_ssid *),
1813                                         void *arg);
1814 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1815 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1816 int wpa_config_remove_network(struct wpa_config *config, int id);
1817 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1818 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1819                        int line);
1820 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1821                                 const char *value);
1822 int wpa_config_dump_values(struct wpa_config *config, char *buf,
1823                                  size_t buflen);
1824 int wpa_config_get_value(const char *name, struct wpa_config *config,
1825                                char *buf, size_t buflen);
1826 
1827 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1828 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1829 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1830 void wpa_config_update_psk(struct wpa_ssid *ssid);
1831 int wpa_config_add_prio_network(struct wpa_config *config,
1832                                         struct wpa_ssid *ssid);
1833 int wpa_config_update_prio_list(struct wpa_config *config);
1834 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1835                                                                const char *name);
1836 void wpa_config_set_blob(struct wpa_config *config,
1837                                struct wpa_config_blob *blob);
1838 void wpa_config_free_blob(struct wpa_config_blob *blob);
1839 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
1840 void wpa_config_flush_blobs(struct wpa_config *config);
1841 
1842 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1843 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1844 int wpa_config_remove_cred(struct wpa_config *config, int id);
1845 void wpa_config_free_cred(struct wpa_cred *cred);
1846 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1847                               const char *value, int line);
1848 char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
1849 
1850 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1851                                                      const char *driver_param);
1852 #ifndef CONFIG_NO_STDOUT_DEBUG
1853 void wpa_config_debug_dump_networks(struct wpa_config *config);
1854 #else /* CONFIG_NO_STDOUT_DEBUG */
1855 #define wpa_config_debug_dump_networks(c) do { } while (0)
1856 #endif /* CONFIG_NO_STDOUT_DEBUG */
1857 
1858 
1859 /* Prototypes for common functions from config.c */
1860 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1861 
1862 int wpa_config_get_num_global_field_names(void);
1863 
1864 const char * wpa_config_get_global_field_name(unsigned int i, int *no_var);
1865 
1866 /* Prototypes for backend specific functions from the selected config_*.c */
1867 
1868 /**
1869  * wpa_config_read - Read and parse configuration database
1870  * @name: Name of the configuration (e.g., path and file name for the
1871  * configuration file)
1872  * @cfgp: Pointer to previously allocated configuration data or %NULL if none
1873  * @ro: Whether to mark networks from this configuration as read-only
1874  * Returns: Pointer to allocated configuration data or %NULL on failure
1875  *
1876  * This function reads configuration data, parses its contents, and allocates
1877  * data structures needed for storing configuration information. The allocated
1878  * data can be freed with wpa_config_free().
1879  *
1880  * Each configuration backend needs to implement this function.
1881  */
1882 struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp,
1883                                             bool ro);
1884 
1885 /**
1886  * wpa_config_write - Write or update configuration data
1887  * @name: Name of the configuration (e.g., path and file name for the
1888  * configuration file)
1889  * @config: Configuration data from wpa_config_read()
1890  * Returns: 0 on success, -1 on failure
1891  *
1892  * This function write all configuration data into an external database (e.g.,
1893  * a text file) in a format that can be read with wpa_config_read(). This can
1894  * be used to allow wpa_supplicant to update its configuration, e.g., when a
1895  * new network is added or a password is changed.
1896  *
1897  * Each configuration backend needs to implement this function.
1898  */
1899 int wpa_config_write(const char *name, struct wpa_config *config);
1900 
1901 #endif /* CONFIG_H */
1902