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