blob: 0643114cd3c48046414a4a453c9be702c0ae2c44 [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * WPA Supplicant / Configuration file structures
Dmitry Shmidt04949592012-07-19 12:16:46 -07003 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 */
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 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080018#define DEFAULT_USER_MPM 1
19#define DEFAULT_MAX_PEER_LINKS 99
Dmitry Shmidt2f74e362015-01-21 13:19:05 -080020#define DEFAULT_MESH_MAX_INACTIVITY 300
Hai Shaloma20dcd72022-02-04 13:43:00 -080021#define DEFAULT_MESH_FWDING 1
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080022/*
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
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070027#define DEFAULT_FAST_REAUTH 1
28#define DEFAULT_P2P_GO_INTENT 7
29#define DEFAULT_P2P_INTRA_BSS 1
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070030#define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
Dmitry Shmidt43cb5782014-06-16 16:23:22 -070031#define DEFAULT_P2P_OPTIMIZE_LISTEN_CHAN 0
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070032#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
Roshan Pius3a1667e2018-07-03 15:17:14 -070036#define DEFAULT_AP_ISOLATE 0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -080037#define DEFAULT_ACCESS_NETWORK_TYPE 15
Dmitry Shmidtea69e842013-05-13 14:52:28 -070038#define DEFAULT_SCAN_CUR_FREQ 0
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -070039#define DEFAULT_P2P_SEARCH_DELAY 500
Dmitry Shmidt661b4f72014-09-29 14:58:27 -070040#define DEFAULT_RAND_ADDR_LIFETIME 60
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080041#define DEFAULT_KEY_MGMT_OFFLOAD 1
Dmitry Shmidt2f74e362015-01-21 13:19:05 -080042#define DEFAULT_CERT_IN_CB 1
Dmitry Shmidt7f656022015-02-25 14:36:37 -080043#define DEFAULT_P2P_GO_CTWINDOW 0
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080044#define DEFAULT_WPA_RSC_RELAXATION 1
Dmitry Shmidt57c2d392016-02-23 13:40:19 -080045#define DEFAULT_MBO_CELL_CAPA MBO_CELL_CAPA_NOT_SUPPORTED
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070046#define DEFAULT_DISASSOC_IMMINENT_RSSI_THRESHOLD -75
47#define DEFAULT_OCE_SUPPORT OCE_STA
Hai Shalomfdcde762020-04-02 11:19:20 -070048#define DEFAULT_EXTENDED_KEY_ID 0
Dennis Jeone2cb56b2020-10-23 21:23:01 +090049#define DEFAULT_BTM_OFFLOAD 0
Hai Shalom60840252021-02-19 19:02:11 -080050#define DEFAULT_SCAN_RES_VALID_FOR_CONNECT 5
Sunil Ravib0ac25f2024-07-12 01:42:03 +000051#define DEFAULT_MLD_CONNECT_BAND_PREF MLD_CONNECT_BAND_PREF_AUTO
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070052
53#include "config_ssid.h"
54#include "wps/wps.h"
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -070055#include "common/ieee802_11_defs.h"
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070056#include "common/ieee802_11_common.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070057
58
Roshan Pius3a1667e2018-07-03 15:17:14 -070059#define MAX_ROAMING_CONS 36
60#define MAX_ROAMING_CONS_OI_LEN 15
61
Dmitry Shmidt04949592012-07-19 12:16:46 -070062struct wpa_cred {
63 /**
64 * next - Next credential in the list
65 *
66 * This pointer can be used to iterate over all credentials. The head
67 * of this list is stored in the cred field of struct wpa_config.
68 */
69 struct wpa_cred *next;
70
71 /**
72 * id - Unique id for the credential
73 *
74 * This identifier is used as a unique identifier for each credential
75 * block when using the control interface. Each credential is allocated
76 * an id when it is being created, either when reading the
77 * configuration file or when a new credential is added through the
78 * control interface.
79 */
80 int id;
81
82 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080083 * temporary - Whether this credential is temporary and not to be saved
84 */
85 int temporary;
86
87 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -070088 * priority - Priority group
89 *
90 * By default, all networks and credentials get the same priority group
91 * (0). This field can be used to give higher priority for credentials
92 * (and similarly in struct wpa_ssid for network blocks) to change the
93 * Interworking automatic networking selection behavior. The matching
94 * network (based on either an enabled network block or a credential)
95 * with the highest priority value will be selected.
96 */
97 int priority;
98
99 /**
100 * pcsc - Use PC/SC and SIM/USIM card
101 */
102 int pcsc;
103
104 /**
105 * realm - Home Realm for Interworking
106 */
107 char *realm;
108
109 /**
110 * username - Username for Interworking network selection
111 */
112 char *username;
113
114 /**
115 * password - Password for Interworking network selection
116 */
117 char *password;
118
119 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700120 * ext_password - Whether password is a name for external storage
121 */
122 int ext_password;
123
124 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700125 * ca_cert - CA certificate for Interworking network selection
126 */
127 char *ca_cert;
128
129 /**
130 * client_cert - File path to client certificate file (PEM/DER)
131 *
132 * This field is used with Interworking networking selection for a case
133 * where client certificate/private key is used for authentication
134 * (EAP-TLS). Full path to the file should be used since working
135 * directory may change when wpa_supplicant is run in the background.
136 *
137 * Alternatively, a named configuration blob can be used by setting
138 * this to blob://blob_name.
139 */
140 char *client_cert;
141
142 /**
143 * private_key - File path to client private key file (PEM/DER/PFX)
144 *
145 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
146 * commented out. Both the private key and certificate will be read
147 * from the PKCS#12 file in this case. Full path to the file should be
148 * used since working directory may change when wpa_supplicant is run
149 * in the background.
150 *
151 * Windows certificate store can be used by leaving client_cert out and
152 * configuring private_key in one of the following formats:
153 *
154 * cert://substring_to_match
155 *
156 * hash://certificate_thumbprint_in_hex
157 *
158 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
159 *
160 * Note that when running wpa_supplicant as an application, the user
161 * certificate store (My user account) is used, whereas computer store
162 * (Computer account) is used when running wpasvc as a service.
163 *
164 * Alternatively, a named configuration blob can be used by setting
165 * this to blob://blob_name.
166 */
167 char *private_key;
168
169 /**
170 * private_key_passwd - Password for private key file
171 */
172 char *private_key_passwd;
173
174 /**
175 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
176 */
177 char *imsi;
178
179 /**
180 * milenage - Milenage parameters for SIM/USIM simulator in
181 * <Ki>:<OPc>:<SQN> format
182 */
183 char *milenage;
184
185 /**
Sunil8cd6f4d2022-06-28 18:40:46 +0000186 * imsi_privacy_cert - IMSI privacy certificate
Sunil Ravia04bd252022-05-02 22:54:18 -0700187 *
188 * This field is used with EAP-SIM/AKA/AKA' to encrypt the permanent
Sunil8cd6f4d2022-06-28 18:40:46 +0000189 * identity (IMSI) to improve privacy. The referenced PEM-encoded
190 * X.509v3 certificate needs to include a 2048-bit RSA public key and
191 * this is from the operator who authenticates the SIM/USIM.
Sunil Ravia04bd252022-05-02 22:54:18 -0700192 */
Sunil8cd6f4d2022-06-28 18:40:46 +0000193 char *imsi_privacy_cert;
194
195 /**
196 * imsi_privacy_attr - IMSI privacy attribute
197 *
198 * This field is used to help the EAP-SIM/AKA/AKA' server to identify
199 * the used certificate (and as such, the matching private key). This
200 * is set to an attribute in name=value format if the operator needs
201 * this information.
202 */
203 char *imsi_privacy_attr;
Sunil Ravia04bd252022-05-02 22:54:18 -0700204
205 /**
Steven Liu9138d432022-11-23 22:29:05 +0000206 * strict_conservative_peer_mode - Whether the strict conservative peer
207 * mode is enabled or not
208 *
209 * This field is used to handle the reponse of AT_PERMANENT_ID_REQ
210 * for EAP-SIM/AKA/AKA', in convervative peer mode, a client error would
211 * be sent to the server, but it allows to send the permanent identity
212 * in some special cases according to 4.6.2 of RFC 4187; With the strict
213 * mode, it never send the permanent identity to server for privacy concern.
214 */
215 int strict_conservative_peer_mode;
216
217 /**
Hai Shaloma20dcd72022-02-04 13:43:00 -0800218 * engine - Use an engine for private key operations
219 */
220 int engine;
221
222 /**
223 * engine_id - String identifying the engine to use
224 */
225 char *engine_id;
226
227 /**
228 * ca_cert_id - The CA certificate identifier when using an engine
229 */
230 char *ca_cert_id;
231
232 /**
233 * cert_id - The certificate identifier when using an engine
234 */
235 char *cert_id;
236
237 /**
238 * key_id - The private key identifier when using an engine
239 */
240 char *key_id;
241
242 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -0700243 * domain_suffix_match - Constraint for server domain name
244 *
245 * If set, this FQDN is used as a suffix match requirement for the AAA
246 * server certificate in SubjectAltName dNSName element(s). If a
247 * matching dNSName is found, this constraint is met. If no dNSName
Dmitry Shmidtff787d52015-01-12 13:01:47 -0800248 * values are present, this constraint is matched against SubjectName CN
Dmitry Shmidt051af732013-10-22 13:52:46 -0700249 * using same suffix match comparison. Suffix match here means that the
250 * host/domain name is compared one label at a time starting from the
251 * top-level domain and all the labels in @domain_suffix_match shall be
252 * included in the certificate. The certificate may include additional
253 * sub-level labels in addition to the required labels.
254 *
255 * For example, domain_suffix_match=example.com would match
256 * test.example.com but would not match test-example.com.
257 */
258 char *domain_suffix_match;
259
260 /**
261 * domain - Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700262 *
263 * This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700264 * whether the AP is operated by the Home SP. Multiple domain entries
265 * can be used to configure alternative FQDNs that will be considered
266 * home networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700267 */
Dmitry Shmidt051af732013-10-22 13:52:46 -0700268 char **domain;
269
270 /**
271 * num_domain - Number of FQDNs in the domain array
272 */
273 size_t num_domain;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700274
275 /**
Sunil Ravi77d572f2023-01-17 23:58:31 +0000276 * home_ois - Home OIs
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700277 *
Sunil Ravi77d572f2023-01-17 23:58:31 +0000278 * If num_home_ois is non-zero, this field contains the set of Home OIs
279 * that can be use to determine which access points support
280 * authentication with this credential. These are an alternative to the
281 * use of the realm parameter. When using Home OIs to match the network,
282 * the EAP parameters need to be pre-configured with the credentials
283 * since the NAI Realm information may not be available or fetched.
284 * A successful authentication with the access point is possible as soon
285 * as at least one Home OI from the list matches an OI in the Roaming
286 * Consortium list advertised by the access point.
287 * (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOI)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700288 */
Sunil Ravi77d572f2023-01-17 23:58:31 +0000289 u8 home_ois[MAX_ROAMING_CONS][MAX_ROAMING_CONS_OI_LEN];
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700290
291 /**
Sunil Ravi77d572f2023-01-17 23:58:31 +0000292 * home_ois_len - Length of home_ois[i]
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700293 */
Sunil Ravi77d572f2023-01-17 23:58:31 +0000294 size_t home_ois_len[MAX_ROAMING_CONS];
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700295
Roshan Pius3a1667e2018-07-03 15:17:14 -0700296 /**
Sunil Ravi77d572f2023-01-17 23:58:31 +0000297 * num_home_ois - Number of entries in home_ois
298 */
299 unsigned int num_home_ois;
300
301 /**
302 * required_home_ois - Required Home OI(s)
Roshan Pius3a1667e2018-07-03 15:17:14 -0700303 *
Sunil Ravi77d572f2023-01-17 23:58:31 +0000304 * If required_home_ois_len is non-zero, this field contains the set of
305 * Home OI(s) that are required to be advertised by the AP for the
306 * credential to be considered matching.
307 * (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/HomeOIList/<X+>/HomeOIRequired)
Roshan Pius3a1667e2018-07-03 15:17:14 -0700308 */
Sunil Ravi77d572f2023-01-17 23:58:31 +0000309 u8 required_home_ois[MAX_ROAMING_CONS][MAX_ROAMING_CONS_OI_LEN];
Roshan Pius3a1667e2018-07-03 15:17:14 -0700310
311 /**
Sunil Ravi77d572f2023-01-17 23:58:31 +0000312 * required_home_ois_len - Length of required_home_ois
Roshan Pius3a1667e2018-07-03 15:17:14 -0700313 */
Sunil Ravi77d572f2023-01-17 23:58:31 +0000314 size_t required_home_ois_len[MAX_ROAMING_CONS];
315
316 /**
317 * num_required_home_ois - Number of entries in required_home_ois
318 */
319 unsigned int num_required_home_ois;
Dmitry Shmidt051af732013-10-22 13:52:46 -0700320
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700321 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -0700322 * roaming_consortiums - Roaming Consortium OI(s) memberships
323 *
324 * This field contains one or more OIs identifying the roaming
325 * consortiums of which the provider is a member. The list is sorted
326 * from the most preferred one to the least preferred one. A match
327 * between the Roaming Consortium OIs advertised by an AP and the OIs
328 * in this list indicates that successful authentication is possible.
329 * (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
330 */
331 u8 roaming_consortiums[MAX_ROAMING_CONS][MAX_ROAMING_CONS_OI_LEN];
332
333 /**
334 * roaming_consortiums_len - Length on roaming_consortiums[i]
335 */
336 size_t roaming_consortiums_len[MAX_ROAMING_CONS];
337
338 /**
339 * num_roaming_consortiums - Number of entries in roaming_consortiums
340 */
341 unsigned int num_roaming_consortiums;
342
343 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700344 * eap_method - EAP method to use
345 *
346 * Pre-configured EAP method to use with this credential or %NULL to
347 * indicate no EAP method is selected, i.e., the method will be
348 * selected automatically based on ANQP information.
349 */
350 struct eap_method_type *eap_method;
351
352 /**
353 * phase1 - Phase 1 (outer authentication) parameters
354 *
355 * Pre-configured EAP parameters or %NULL.
356 */
357 char *phase1;
358
359 /**
360 * phase2 - Phase 2 (inner authentication) parameters
361 *
362 * Pre-configured EAP parameters or %NULL.
363 */
364 char *phase2;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800365
366 struct excluded_ssid {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700367 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800368 size_t ssid_len;
369 } *excluded_ssid;
370 size_t num_excluded_ssid;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800371
372 struct roaming_partner {
373 char fqdn[128];
374 int exact_match;
375 u8 priority;
376 char country[3];
377 } *roaming_partner;
378 size_t num_roaming_partner;
379
380 int update_identifier;
381
382 /**
383 * provisioning_sp - FQDN of the SP that provisioned the credential
384 */
385 char *provisioning_sp;
386
387 /**
388 * sp_priority - Credential priority within a provisioning SP
389 *
390 * This is the priority of the credential among all credentials
391 * provisionined by the same SP (i.e., for entries that have identical
392 * provisioning_sp value). The range of this priority is 0-255 with 0
393 * being the highest and 255 the lower priority.
394 */
395 int sp_priority;
396
397 unsigned int min_dl_bandwidth_home;
398 unsigned int min_ul_bandwidth_home;
399 unsigned int min_dl_bandwidth_roaming;
400 unsigned int min_ul_bandwidth_roaming;
401
402 /**
403 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
404 * This value is used as the maximum channel utilization for network
405 * selection purposes for home networks. If the AP does not advertise
406 * BSS Load or if the limit would prevent any connection, this
407 * constraint will be ignored.
408 */
409 unsigned int max_bss_load;
410
Hai Shalomfdcde762020-04-02 11:19:20 -0700411 size_t num_req_conn_capab;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800412 u8 *req_conn_capab_proto;
413 int **req_conn_capab_port;
414
415 /**
416 * ocsp - Whether to use/require OCSP to check server certificate
417 *
418 * 0 = do not use OCSP stapling (TLS certificate status extension)
419 * 1 = try to use OCSP stapling, but not require response
420 * 2 = require valid OCSP stapling response
421 */
422 int ocsp;
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700423
424 /**
425 * sim_num - User selected SIM identifier
426 *
427 * This variable is used for identifying which SIM is used if the system
428 * has more than one.
429 */
430 int sim_num;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700431};
432
Sunil Ravi79e6c4f2025-01-04 00:47:06 +0000433struct wpa_dev_ik {
434 /**
435 * next - Next device identity in the list
436 *
437 * This pointer can be used to iterate over all device identity keys.
438 * The head of this list is stored in the dev_ik field of struct
439 * wpa_config.
440 */
441 struct wpa_dev_ik *next;
442
443 /**
444 * id - Unique id for the identity
445 *
446 * This identifier is used as a unique identifier for each identity
447 * block when using the control interface. Each identity is allocated
448 * an id when it is being created, either when reading the
449 * configuration file or when a new identity is added.
450 */
451 int id;
452
453 /**
454 * dik_cipher - Device identity key cipher version
455 */
456 int dik_cipher;
457
458 /**
459 * dik - Device identity key which is unique for the device
460 */
461 struct wpabuf *dik;
462
463 /**
464 * pmk - PMK associated with the previous connection with the device
465 */
466 struct wpabuf *pmk;
467
468 /**
469 * pmkid - PMKID used in the previous connection with the device
470 */
471 struct wpabuf *pmkid;
472};
473
Dmitry Shmidt04949592012-07-19 12:16:46 -0700474
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700475#define CFG_CHANGED_DEVICE_NAME BIT(0)
476#define CFG_CHANGED_CONFIG_METHODS BIT(1)
477#define CFG_CHANGED_DEVICE_TYPE BIT(2)
478#define CFG_CHANGED_OS_VERSION BIT(3)
479#define CFG_CHANGED_UUID BIT(4)
480#define CFG_CHANGED_COUNTRY BIT(5)
481#define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
482#define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
483#define CFG_CHANGED_WPS_STRING BIT(8)
484#define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
485#define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
Jouni Malinen75ecf522011-06-27 15:19:46 -0700486#define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
487#define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700488#define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700489#define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800490#define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700491#define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800492#define CFG_CHANGED_SCHED_SCAN_PLANS BIT(17)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700493#define CFG_CHANGED_WOWLAN_TRIGGERS BIT(18)
Hai Shalom81f62d82019-07-22 12:10:00 -0700494#define CFG_CHANGED_DISABLE_BTM BIT(19)
Hai Shalom899fcc72020-10-19 14:38:18 -0700495#define CFG_CHANGED_BGSCAN BIT(20)
Sunil Ravib0ac25f2024-07-12 01:42:03 +0000496#define CFG_CHANGED_FT_PREPEND_PMKID BIT(21)
497#define CFG_CHANGED_DISABLE_BTM_NOTIFY BIT(22)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700498
499/**
500 * struct wpa_config - wpa_supplicant configuration data
501 *
502 * This data structure is presents the per-interface (radio) configuration
503 * data. In many cases, there is only one struct wpa_config instance, but if
504 * more than one network interface is being controlled, one instance is used
505 * for each.
506 */
507struct wpa_config {
508 /**
509 * ssid - Head of the global network list
510 *
511 * This is the head for the list of all the configured networks.
512 */
513 struct wpa_ssid *ssid;
514
515 /**
516 * pssid - Per-priority network lists (in priority order)
517 */
518 struct wpa_ssid **pssid;
519
520 /**
521 * num_prio - Number of different priorities used in the pssid lists
522 *
523 * This indicates how many per-priority network lists are included in
524 * pssid.
525 */
Hai Shalomfdcde762020-04-02 11:19:20 -0700526 size_t num_prio;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700527
528 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700529 * cred - Head of the credential list
530 *
531 * This is the head for the list of all the configured credentials.
532 */
533 struct wpa_cred *cred;
534
535 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700536 * eapol_version - IEEE 802.1X/EAPOL version number
537 *
538 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
539 * defines EAPOL version 2. However, there are many APs that do not
540 * handle the new version number correctly (they seem to drop the
541 * frames completely). In order to make wpa_supplicant interoperate
542 * with these APs, the version number is set to 1 by default. This
543 * configuration value can be used to set it to the new version (2).
544 */
545 int eapol_version;
546
547 /**
548 * ap_scan - AP scanning/selection
549 *
550 * By default, wpa_supplicant requests driver to perform AP
551 * scanning and then uses the scan results to select a
552 * suitable AP. Another alternative is to allow the driver to
553 * take care of AP scanning and selection and use
554 * wpa_supplicant just to process EAPOL frames based on IEEE
555 * 802.11 association information from the driver.
556 *
557 * 1: wpa_supplicant initiates scanning and AP selection (default).
558 *
559 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
560 * association parameters (e.g., WPA IE generation); this mode can
561 * also be used with non-WPA drivers when using IEEE 802.1X mode;
562 * do not try to associate with APs (i.e., external program needs
563 * to control association). This mode must also be used when using
564 * wired Ethernet drivers.
565 *
566 * 2: like 0, but associate with APs using security policy and SSID
567 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
568 * drivers to enable operation with hidden SSIDs and optimized roaming;
569 * in this mode, the network blocks in the configuration are tried
570 * one by one until the driver reports successful association; each
571 * network block should have explicit security policy (i.e., only one
572 * option in the lists) for key_mgmt, pairwise, group, proto variables.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800573 *
574 * Note: ap_scan=2 should not be used with the nl80211 driver interface
575 * (the current Linux interface). ap_scan=1 is optimized work working
576 * with nl80211. For finding networks using hidden SSID, scan_ssid=1 in
577 * the network block can be used with nl80211.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700578 */
579 int ap_scan;
580
581 /**
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800582 * bgscan - Background scan and roaming parameters or %NULL if none
583 *
584 * This is an optional set of parameters for background scanning and
585 * roaming within a network (ESS). For more detailed information see
586 * ssid block documentation.
587 *
588 * The variable defines default bgscan behavior for all BSS station
589 * networks except for those which have their own bgscan configuration.
590 */
591 char *bgscan;
592
593 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700594 * disable_scan_offload - Disable automatic offloading of scan requests
595 *
596 * By default, %wpa_supplicant tries to offload scanning if the driver
597 * indicates support for this (sched_scan). This configuration
598 * parameter can be used to disable this offloading mechanism.
599 */
600 int disable_scan_offload;
601
602 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700603 * ctrl_interface - Parameters for the control interface
604 *
605 * If this is specified, %wpa_supplicant will open a control interface
606 * that is available for external programs to manage %wpa_supplicant.
607 * The meaning of this string depends on which control interface
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800608 * mechanism is used. For all cases, the existence of this parameter
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700609 * in configuration is used to determine whether the control interface
610 * is enabled.
611 *
612 * For UNIX domain sockets (default on Linux and BSD): This is a
613 * directory that will be created for UNIX domain sockets for listening
614 * to requests from external programs (CLI/GUI, etc.) for status
615 * information and configuration. The socket file will be named based
616 * on the interface name, so multiple %wpa_supplicant processes can be
617 * run at the same time if more than one interface is used.
618 * /var/run/wpa_supplicant is the recommended directory for sockets and
619 * by default, wpa_cli will use it when trying to connect with
620 * %wpa_supplicant.
621 *
622 * Access control for the control interface can be configured
623 * by setting the directory to allow only members of a group
624 * to use sockets. This way, it is possible to run
625 * %wpa_supplicant as root (since it needs to change network
626 * configuration and open raw sockets) and still allow GUI/CLI
627 * components to be run as non-root users. However, since the
628 * control interface can be used to change the network
629 * configuration, this access needs to be protected in many
630 * cases. By default, %wpa_supplicant is configured to use gid
631 * 0 (root). If you want to allow non-root users to use the
632 * control interface, add a new group and change this value to
633 * match with that group. Add users that should have control
634 * interface access to this group.
635 *
636 * When configuring both the directory and group, use following format:
637 * DIR=/var/run/wpa_supplicant GROUP=wheel
638 * DIR=/var/run/wpa_supplicant GROUP=0
639 * (group can be either group name or gid)
640 *
641 * For UDP connections (default on Windows): The value will be ignored.
642 * This variable is just used to select that the control interface is
643 * to be created. The value can be set to, e.g., udp
644 * (ctrl_interface=udp).
645 *
646 * For Windows Named Pipe: This value can be used to set the security
647 * descriptor for controlling access to the control interface. Security
648 * descriptor can be set using Security Descriptor String Format (see
649 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
650 * The descriptor string needs to be prefixed with SDDL=. For example,
651 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
652 * all connections).
653 */
654 char *ctrl_interface;
655
656 /**
657 * ctrl_interface_group - Control interface group (DEPRECATED)
658 *
659 * This variable is only used for backwards compatibility. Group for
660 * UNIX domain sockets should now be specified using GROUP=group in
661 * ctrl_interface variable.
662 */
663 char *ctrl_interface_group;
664
665 /**
666 * fast_reauth - EAP fast re-authentication (session resumption)
667 *
668 * By default, fast re-authentication is enabled for all EAP methods
669 * that support it. This variable can be used to disable fast
670 * re-authentication (by setting fast_reauth=0). Normally, there is no
671 * need to disable fast re-authentication.
672 */
673 int fast_reauth;
674
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000675#ifndef CONFIG_OPENSC_ENGINE_PATH
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700676 /**
677 * opensc_engine_path - Path to the OpenSSL engine for opensc
678 *
679 * This is an OpenSSL specific configuration option for loading OpenSC
680 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
681 */
682 char *opensc_engine_path;
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000683#endif /* CONFIG_OPENSC_ENGINE_PATH */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700684
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000685#ifndef CONFIG_PKCS11_ENGINE_PATH
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700686 /**
687 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
688 *
689 * This is an OpenSSL specific configuration option for loading PKCS#11
690 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
691 */
692 char *pkcs11_engine_path;
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000693#endif /* CONFIG_PKCS11_ENGINE_PATH */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700694
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000695#ifndef CONFIG_PKCS11_MODULE_PATH
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700696 /**
697 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
698 *
699 * This is an OpenSSL specific configuration option for configuring
700 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
701 * module is not loaded.
702 */
703 char *pkcs11_module_path;
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000704#endif /* CONFIG_PKCS11_MODULE_PATH */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700705
706 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800707 * openssl_ciphers - OpenSSL cipher string
708 *
709 * This is an OpenSSL specific configuration option for configuring the
710 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
711 * default.
712 */
713 char *openssl_ciphers;
714
715 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700716 * pcsc_reader - PC/SC reader name prefix
717 *
718 * If not %NULL, PC/SC reader with a name that matches this prefix is
719 * initialized for SIM/USIM access. Empty string can be used to match
720 * the first available reader.
721 */
722 char *pcsc_reader;
723
724 /**
725 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
726 *
727 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
728 * EAP-AKA. If left out, this will be asked through control interface.
729 */
730 char *pcsc_pin;
731
732 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -0700733 * external_sim - Use external processing for SIM/USIM operations
734 */
735 int external_sim;
736
737 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700738 * driver_param - Driver interface parameters
739 *
740 * This text string is passed to the selected driver interface with the
741 * optional struct wpa_driver_ops::set_param() handler. This can be
742 * used to configure driver specific options without having to add new
743 * driver interface functionality.
744 */
745 char *driver_param;
746
747 /**
748 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
749 *
750 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
751 * cache (unit: seconds).
752 */
753 unsigned int dot11RSNAConfigPMKLifetime;
754
755 /**
756 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
757 *
758 * dot11 MIB variable for the percentage of the PMK lifetime
759 * that should expire before an IEEE 802.1X reauthentication occurs.
760 */
761 unsigned int dot11RSNAConfigPMKReauthThreshold;
762
763 /**
764 * dot11RSNAConfigSATimeout - Security association timeout
765 *
766 * dot11 MIB variable for the maximum time a security association
767 * shall take to set up (unit: seconds).
768 */
769 unsigned int dot11RSNAConfigSATimeout;
770
771 /**
Sunil Ravib0ac25f2024-07-12 01:42:03 +0000772 * ft_prepend_pmkid - Whether to prepend PMKR1Name with PMKIDs
773 *
774 * This control whether PMKR1Name is prepended to the PMKID list
775 * insread of replacing the full list when constructing RSNE for
776 * EAPOL-Key msg 2/4 for FT cases. */
777 bool ft_prepend_pmkid;
778
779 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700780 * update_config - Is wpa_supplicant allowed to update configuration
781 *
782 * This variable control whether wpa_supplicant is allow to re-write
783 * its configuration with wpa_config_write(). If this is zero,
784 * configuration data is only changed in memory and the external data
Hai Shalom60840252021-02-19 19:02:11 -0800785 * is not overridden. If this is non-zero, wpa_supplicant will update
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700786 * the configuration data (e.g., a file) whenever configuration is
787 * changed. This update may replace the old configuration which can
788 * remove comments from it in case of a text file configuration.
789 */
790 int update_config;
791
792 /**
793 * blobs - Configuration blobs
794 */
795 struct wpa_config_blob *blobs;
796
797 /**
798 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
799 */
800 u8 uuid[16];
801
802 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700803 * auto_uuid - Automatic UUID behavior
804 * 0 = generate static value based on the local MAC address (default)
805 * 1 = generate a random UUID every time wpa_supplicant starts
806 */
807 int auto_uuid;
808
809 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700810 * device_name - Device Name (WPS)
811 * User-friendly description of device; up to 32 octets encoded in
812 * UTF-8
813 */
814 char *device_name;
815
816 /**
817 * manufacturer - Manufacturer (WPS)
818 * The manufacturer of the device (up to 64 ASCII characters)
819 */
820 char *manufacturer;
821
822 /**
823 * model_name - Model Name (WPS)
824 * Model of the device (up to 32 ASCII characters)
825 */
826 char *model_name;
827
828 /**
829 * model_number - Model Number (WPS)
830 * Additional device description (up to 32 ASCII characters)
831 */
832 char *model_number;
833
834 /**
835 * serial_number - Serial Number (WPS)
836 * Serial number of the device (up to 32 characters)
837 */
838 char *serial_number;
839
840 /**
841 * device_type - Primary Device Type (WPS)
842 */
843 u8 device_type[WPS_DEV_TYPE_LEN];
844
845 /**
846 * config_methods - Config Methods
847 *
848 * This is a space-separated list of supported WPS configuration
849 * methods. For example, "label virtual_display virtual_push_button
850 * keypad".
851 * Available methods: usba ethernet label display ext_nfc_token
852 * int_nfc_token nfc_interface push_button keypad
853 * virtual_display physical_display
854 * virtual_push_button physical_push_button.
855 */
856 char *config_methods;
857
858 /**
859 * os_version - OS Version (WPS)
860 * 4-octet operating system version number
861 */
862 u8 os_version[4];
863
864 /**
865 * country - Country code
866 *
867 * This is the ISO/IEC alpha2 country code for which we are operating
868 * in
869 */
870 char country[2];
871
872 /**
873 * wps_cred_processing - Credential processing
874 *
875 * 0 = process received credentials internally
876 * 1 = do not process received credentials; just pass them over
877 * ctrl_iface to external program(s)
878 * 2 = process received credentials internally and pass them over
879 * ctrl_iface to external program(s)
880 */
881 int wps_cred_processing;
882
Hai Shalom021b0b52019-04-10 11:17:58 -0700883 /**
884 * wps_cred_add_sae - Whether to enable SAE automatically for WPS
885 *
886 * 0 = only add the explicitly listed WPA2-PSK configuration
887 * 1 = add both the WPA2-PSK and SAE configuration and enable PMF so
888 * that the station gets configured in WPA3-Personal transition mode
889 * (supports both WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
890 */
891 int wps_cred_add_sae;
892
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700893#define MAX_SEC_DEVICE_TYPES 5
894 /**
895 * sec_device_types - Secondary Device Types (P2P)
896 */
897 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
898 int num_sec_device_types;
899
900 int p2p_listen_reg_class;
901 int p2p_listen_channel;
902 int p2p_oper_reg_class;
903 int p2p_oper_channel;
904 int p2p_go_intent;
905 char *p2p_ssid_postfix;
906 int persistent_reconnect;
907 int p2p_intra_bss;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700908 unsigned int num_p2p_pref_chan;
909 struct p2p_channel *p2p_pref_chan;
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700910 struct wpa_freq_range_list p2p_no_go_freq;
911 int p2p_add_cli_chan;
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700912 int p2p_ignore_shared_freq;
Dmitry Shmidt43cb5782014-06-16 16:23:22 -0700913 int p2p_optimize_listen_chan;
Hai Shalom899fcc72020-10-19 14:38:18 -0700914 int p2p_6ghz_disable;
Shuibing Dai64a8a892023-03-08 10:26:22 -0800915 int p2p_dfs_chan_enable;
Sunil Ravi79e6c4f2025-01-04 00:47:06 +0000916 bool p2p_pairing_setup;
917 bool p2p_pairing_cache;
918 int p2p_bootstrap_methods;
919 int p2p_pasn_type;
920 int p2p_comeback_after;
921 bool p2p_twt_power_mgmt;
922 bool p2p_chan_switch_req_enable;
923 int p2p_reg_info;
Hai Shalom899fcc72020-10-19 14:38:18 -0700924
Dmitry Shmidt04949592012-07-19 12:16:46 -0700925 struct wpabuf *wps_vendor_ext_m1;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700926
927#define MAX_WPS_VENDOR_EXT 10
928 /**
929 * wps_vendor_ext - Vendor extension attributes in WPS
930 */
931 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
932
933 /**
934 * p2p_group_idle - Maximum idle time in seconds for P2P group
935 *
936 * This value controls how long a P2P group is maintained after there
937 * is no other members in the group. As a GO, this means no associated
938 * stations in the group. As a P2P client, this means no GO seen in
939 * scan results. The maximum idle time is specified in seconds with 0
940 * indicating no time limit, i.e., the P2P group remains in active
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800941 * state indefinitely until explicitly removed. As a P2P client, the
942 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
943 * this parameter is mainly meant for GO use and for P2P client, it can
Dmitry Shmidt04949592012-07-19 12:16:46 -0700944 * only be used to reduce the default timeout to smaller value. A
945 * special value -1 can be used to configure immediate removal of the
946 * group for P2P client role on any disconnection after the data
947 * connection has been established.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700948 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700949 int p2p_group_idle;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700950
951 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800952 * p2p_go_freq_change_policy - The GO frequency change policy
953 *
954 * This controls the behavior of the GO when there is a change in the
955 * map of the currently used frequencies in case more than one channel
956 * is supported.
957 *
958 * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
959 * possible. In case the GO is the only interface using its frequency
960 * and there are other station interfaces on other frequencies, the GO
961 * will migrate to one of these frequencies.
962 *
963 * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
964 * but a transition is possible only in case one of the other used
965 * frequencies is one of the frequencies in the intersection of the
966 * frequency list of the local device and the peer device.
967 *
968 * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
969 *
970 * @P2P_GO_FREQ_MOVE_SCM_ECSA: Same as
971 * P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS but a transition is possible only
972 * if all the group members advertise eCSA support.
973 */
974 enum {
975 P2P_GO_FREQ_MOVE_SCM = 0,
976 P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS = 1,
977 P2P_GO_FREQ_MOVE_STAY = 2,
978 P2P_GO_FREQ_MOVE_SCM_ECSA = 3,
979 P2P_GO_FREQ_MOVE_MAX = P2P_GO_FREQ_MOVE_SCM_ECSA,
980 } p2p_go_freq_change_policy;
981
982#define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
983
984 /**
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700985 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
986 *
987 * This parameter controls the length of the random passphrase that is
988 * generated at the GO.
989 */
990 unsigned int p2p_passphrase_len;
991
992 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700993 * bss_max_count - Maximum number of BSS entries to keep in memory
994 */
995 unsigned int bss_max_count;
996
997 /**
998 * bss_expiration_age - BSS entry age after which it can be expired
999 *
1000 * This value controls the time in seconds after which a BSS entry
1001 * gets removed if it has not been updated or is not in use.
1002 */
1003 unsigned int bss_expiration_age;
1004
1005 /**
1006 * bss_expiration_scan_count - Expire BSS after number of scans
1007 *
1008 * If the BSS entry has not been seen in this many scans, it will be
1009 * removed. A value of 1 means that entry is removed after the first
1010 * scan in which the BSSID is not seen. Larger values can be used
1011 * to avoid BSS entries disappearing if they are not visible in
1012 * every scan (e.g., low signal quality or interference).
1013 */
1014 unsigned int bss_expiration_scan_count;
1015
1016 /**
1017 * filter_ssids - SSID-based scan result filtering
1018 *
1019 * 0 = do not filter scan results
1020 * 1 = only include configured SSIDs in scan results/BSS table
1021 */
1022 int filter_ssids;
1023
1024 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001025 * filter_rssi - RSSI-based scan result filtering
1026 *
1027 * 0 = do not filter scan results
1028 * -n = filter scan results below -n dBm
1029 */
1030 int filter_rssi;
1031
1032 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001033 * max_num_sta - Maximum number of STAs in an AP/P2P GO
1034 */
1035 unsigned int max_num_sta;
1036
1037 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07001038 * ap_isolate - Whether to use client isolation feature
1039 *
1040 * Client isolation can be used to prevent low-level bridging of
1041 * frames between associated stations in the BSS. By default,
1042 * this bridging is allowed (ap_isolate=0); except in P2P GO case,
1043 * where p2p_intra_bss parameter is used to determine whether to allow
1044 * intra-BSS forwarding (ap_isolate = !p2p_intra_bss).
1045 *
1046 * 0 = do not enable AP isolation
1047 * 1 = enable AP isolation
1048 */
1049 int ap_isolate;
1050
1051 /**
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001052 * freq_list - Array of allowed scan frequencies or %NULL for all
1053 *
1054 * This is an optional zero-terminated array of frequencies in
1055 * megahertz (MHz) to allow for narrowing scanning range.
1056 */
1057 int *freq_list;
1058
1059 /**
Hai Shalom60840252021-02-19 19:02:11 -08001060 * initial_freq_list - like freq_list but for initial scan
1061 *
1062 * This is an optional zero-terminated array of frequencies in
1063 * megahertz (MHz) to allow for narrowing scanning range when
1064 * the application is started.
1065 *
1066 * This can be used to speed up initial connection time if the
1067 * channel is known ahead of time, without limiting the scanned
1068 * frequencies during normal use.
1069 */
1070 int *initial_freq_list;
1071
1072 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001073 * scan_cur_freq - Whether to scan only the current channel
1074 *
1075 * If true, attempt to scan only the current channel if any other
1076 * VIFs on this radio are already associated on a particular channel.
1077 */
1078 int scan_cur_freq;
1079
1080 /**
Hai Shalom60840252021-02-19 19:02:11 -08001081 * scan_res_valid_for_connect - Seconds scans are valid for association
1082 *
1083 * This configures the number of seconds old scan results are considered
1084 * valid for association. When scan results are older than this value
1085 * a new scan is triggered prior to the association.
1086 */
1087 int scan_res_valid_for_connect;
1088
1089 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001090 * changed_parameters - Bitmap of changed parameters since last update
1091 */
1092 unsigned int changed_parameters;
1093
1094 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07001095 * disassoc_low_ack - Disassociate stations with massive packet loss
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001096 */
1097 int disassoc_low_ack;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001098
1099 /**
1100 * interworking - Whether Interworking (IEEE 802.11u) is enabled
1101 */
1102 int interworking;
1103
1104 /**
1105 * access_network_type - Access Network Type
1106 *
1107 * When Interworking is enabled, scans will be limited to APs that
1108 * advertise the specified Access Network Type (0..15; with 15
1109 * indicating wildcard match).
1110 */
1111 int access_network_type;
1112
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001113 /**
1114 * go_interworking - Whether Interworking for P2P GO is enabled
1115 */
1116 int go_interworking;
1117
1118 /**
1119 * go_access_network_type - P2P GO Access Network Type
1120 *
1121 * This indicates which access network type to advertise if Interworking
1122 * is enabled for P2P GO.
1123 */
1124 int go_access_network_type;
1125
1126 /**
1127 * go_internet - Interworking: Internet connectivity (0 or 1)
1128 */
1129 int go_internet;
1130
1131 /**
1132 * go_venue_group - Interworking: Venue group
1133 */
1134 int go_venue_group;
1135
1136 /**
1137 * go_venue_type: Interworking: Venue type
1138 */
1139 int go_venue_type;
1140
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001141 /**
Hai Shalom899fcc72020-10-19 14:38:18 -07001142 * hessid - Homogeneous ESS identifier
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001143 *
1144 * If this is set (any octet is non-zero), scans will be used to
1145 * request response only from BSSes belonging to the specified
1146 * Homogeneous ESS. This is used only if interworking is enabled.
1147 */
1148 u8 hessid[ETH_ALEN];
1149
1150 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001151 * hs20 - Hotspot 2.0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001152 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001153 int hs20;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001154
1155 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001156 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
1157 *
1158 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
1159 * by acting as a Registrar and using M1 from the AP. The config
1160 * methods attribute in that message is supposed to indicate only the
1161 * configuration method supported by the AP in Enrollee role, i.e., to
1162 * add an external Registrar. For that case, PBC shall not be used and
1163 * as such, the PushButton config method is removed from M1 by default.
1164 * If pbc_in_m1=1 is included in the configuration file, the PushButton
1165 * config method is left in M1 (if included in config_methods
1166 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
1167 * a label in the AP).
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001168 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001169 int pbc_in_m1;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001170
1171 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001172 * autoscan - Automatic scan parameters or %NULL if none
1173 *
1174 * This is an optional set of parameters for automatic scanning
1175 * within an interface in following format:
1176 * <autoscan module name>:<module parameters>
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001177 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001178 char *autoscan;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001179
1180 /**
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001181 * wps_nfc_pw_from_config - NFC Device Password was read from config
1182 *
1183 * This parameter can be determined whether the NFC Device Password was
1184 * included in the configuration (1) or generated dynamically (0). Only
1185 * the former case is re-written back to the configuration file.
1186 */
1187 int wps_nfc_pw_from_config;
1188
1189 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001190 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001191 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001192 int wps_nfc_dev_pw_id;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001193
1194 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001195 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001196 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001197 struct wpabuf *wps_nfc_dh_pubkey;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001198
1199 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001200 * wps_nfc_dh_privkey - NFC DH Private Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001201 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001202 struct wpabuf *wps_nfc_dh_privkey;
1203
1204 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001205 * wps_nfc_dev_pw - NFC Device Password for password token
Dmitry Shmidt04949592012-07-19 12:16:46 -07001206 */
1207 struct wpabuf *wps_nfc_dev_pw;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001208
1209 /**
1210 * ext_password_backend - External password backend or %NULL if none
1211 *
1212 * format: <backend name>[:<optional backend parameters>]
1213 */
1214 char *ext_password_backend;
1215
1216 /*
1217 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
1218 *
1219 * This timeout value is used in P2P GO mode to clean up
1220 * inactive stations.
1221 * By default: 300 seconds.
1222 */
1223 int p2p_go_max_inactivity;
1224
1225 struct hostapd_wmm_ac_params wmm_ac_params[4];
Hai Shalom899fcc72020-10-19 14:38:18 -07001226 struct hostapd_tx_queue_params tx_queue[4];
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001227
1228 /**
1229 * auto_interworking - Whether to use network selection automatically
1230 *
1231 * 0 = do not automatically go through Interworking network selection
1232 * (i.e., require explicit interworking_select command for this)
1233 * 1 = perform Interworking network selection if one or more
1234 * credentials have been configured and scan did not find a
1235 * matching network block
1236 */
1237 int auto_interworking;
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001238
1239 /**
1240 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
1241 *
1242 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1243 * Note that regulatory constraints and driver capabilities are
1244 * consulted anyway, so setting it to 1 can't do real harm.
1245 * By default: 0 (disabled)
1246 */
1247 int p2p_go_ht40;
1248
1249 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001250 * p2p_go_vht - Default mode for VHT enable when operating as GO
1251 *
1252 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1253 * Note that regulatory constraints and driver capabilities are
1254 * consulted anyway, so setting it to 1 can't do real harm.
1255 * By default: 0 (disabled)
1256 */
1257 int p2p_go_vht;
1258
1259 /**
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08001260 * p2p_go_edmg - Default mode for EDMG enable when operating as GO
1261 *
1262 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1263 * Note that regulatory constraints and driver capabilities are
1264 * consulted anyway, so setting it to 1 can't do real harm.
1265 * By default: 0 (disabled)
1266 */
1267 int p2p_go_edmg;
1268
1269 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08001270 * p2p_go_he - Default mode for 11ax HE enable when operating as GO
1271 *
1272 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1273 * Note that regulatory constraints and driver capabilities are
1274 * consulted anyway, so setting it to 1 can't do real harm.
1275 * By default: 0 (disabled)
1276 */
1277 int p2p_go_he;
1278
1279 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001280 * p2p_go_ctwindow - CTWindow to use when operating as GO
1281 *
1282 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
1283 * the length of the CTWindow in TUs.
1284 */
1285 int p2p_go_ctwindow;
1286
1287 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001288 * p2p_disabled - Whether P2P operations are disabled for this interface
1289 */
1290 int p2p_disabled;
1291
1292 /**
1293 * p2p_no_group_iface - Whether group interfaces can be used
1294 *
1295 * By default, wpa_supplicant will create a separate interface for P2P
1296 * group operations if the driver supports this. This functionality can
1297 * be disabled by setting this parameter to 1. In that case, the same
1298 * interface that was used for the P2P management operations is used
1299 * also for the group operation.
1300 */
1301 int p2p_no_group_iface;
1302
1303 /**
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07001304 * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1305 *
1306 * If this parameter is set to 1, a connected P2P Client will receive
1307 * and handle Probe Request frames. Setting this parameter to 0
1308 * disables this option. Default value: 0.
1309 *
1310 * Note: Setting this property at run time takes effect on the following
1311 * interface state transition to/from the WPA_COMPLETED state.
1312 */
1313 int p2p_cli_probe;
1314
1315 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001316 * okc - Whether to enable opportunistic key caching by default
1317 *
1318 * By default, OKC is disabled unless enabled by the per-network
1319 * proactive_key_caching=1 parameter. okc=1 can be used to change this
1320 * default behavior.
1321 */
1322 int okc;
1323
1324 /**
1325 * pmf - Whether to enable/require PMF by default
1326 *
1327 * By default, PMF is disabled unless enabled by the per-network
1328 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001329 * this default behavior for RSN network (this is not applicable for
1330 * non-RSN cases).
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001331 */
1332 enum mfp_options pmf;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001333
1334 /**
Sunil Ravi77d572f2023-01-17 23:58:31 +00001335 * sae_check_mfp - Whether to limit SAE based on PMF capabilities
1336 *
1337 * With this check SAE key_mgmt will not be selected if PMF is
1338 * not enabled.
1339 * Scenarios where enabling this check will limit SAE:
1340 * 1) ieee8011w=0 is set for the network.
1341 * 2) The AP does not have PMF enabled.
1342 * 3) ieee8011w for the network is the default(3), pmf=1 is enabled
1343 * globally and the device does not support the BIP cipher.
1344 *
1345 * Useful to allow the BIP cipher check that occurs for ieee80211w=3
1346 * and pmf=1 to also avoid using SAE key_mgmt.
1347 * Useful when hardware does not support BIP to still to allow
1348 * connecting to sae_require_mfp=1 WPA2+WPA3-Personal transition mode
1349 *access points by automatically selecting PSK instead of SAE.
1350 */
1351 int sae_check_mfp;
1352
1353 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001354 * sae_groups - Preference list of enabled groups for SAE
1355 *
1356 * By default (if this parameter is not set), the mandatory group 19
1357 * (ECC group defined over a 256-bit prime order field) is preferred,
1358 * but other groups are also enabled. If this parameter is set, the
1359 * groups will be tried in the indicated order.
1360 */
1361 int *sae_groups;
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001362
1363 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001364 * sae_pwe - SAE mechanism for PWE derivation
1365 * 0 = hunting-and-pecking loop only
1366 * 1 = hash-to-element only
1367 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1368 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001369 enum sae_pwe sae_pwe;
Hai Shalomc3565922019-10-28 11:58:20 -07001370
1371 /**
1372 * sae_pmkid_in_assoc - Whether to include PMKID in SAE Assoc Req
1373 */
1374 int sae_pmkid_in_assoc;
1375
1376 /**
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001377 * dtim_period - Default DTIM period in Beacon intervals
1378 *
1379 * This parameter can be used to set the default value for network
1380 * blocks that do not specify dtim_period.
1381 */
1382 int dtim_period;
1383
1384 /**
1385 * beacon_int - Default Beacon interval in TU
1386 *
1387 * This parameter can be used to set the default value for network
1388 * blocks that do not specify beacon_int.
1389 */
1390 int beacon_int;
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -07001391
1392 /**
1393 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1394 *
1395 * This parameter can be used to define additional vendor specific
1396 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1397 * format for these element(s) is a hexdump of the raw information
1398 * elements (id+len+payload for one or more elements).
1399 */
1400 struct wpabuf *ap_vendor_elements;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001401
1402 /**
Hai Shaloma20dcd72022-02-04 13:43:00 -08001403 * ap_assocresp_elements: Vendor specific elements for (Re)Association
1404 * Response frames
1405 *
1406 * This parameter can be used to define additional vendor specific
1407 * elements for (Re)Association Response frames in AP/P2P GO mode. The
1408 * format for these element(s) is a hexdump of the raw information
1409 * elements (id+len+payload for one or more elements).
1410 */
1411 struct wpabuf *ap_assocresp_elements;
1412
1413 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001414 * ignore_old_scan_res - Ignore scan results older than request
1415 *
1416 * The driver may have a cache of scan results that makes it return
1417 * information that is older than our scan trigger. This parameter can
1418 * be used to configure such old information to be ignored instead of
1419 * allowing it to update the internal BSS table.
1420 */
1421 int ignore_old_scan_res;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001422
1423 /**
1424 * sched_scan_interval - schedule scan interval
1425 */
1426 unsigned int sched_scan_interval;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001427
1428 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001429 * sched_scan_start_delay - Schedule scan start delay before first scan
1430 *
1431 * Delay (in seconds) before scheduling first scan plan cycle. The
1432 * driver may ignore this parameter and start immediately (or at any
1433 * other time), if this feature is not supported.
1434 */
1435 unsigned int sched_scan_start_delay;
1436
1437 /**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001438 * tdls_external_control - External control for TDLS setup requests
1439 *
1440 * Enable TDLS mode where external programs are given the control
1441 * to specify the TDLS link to get established to the driver. The
1442 * driver requests the TDLS setup to the supplicant only for the
1443 * specified TDLS peers.
1444 */
1445 int tdls_external_control;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001446
1447 u8 ip_addr_go[4];
1448 u8 ip_addr_mask[4];
1449 u8 ip_addr_start[4];
1450 u8 ip_addr_end[4];
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001451
1452 /**
1453 * osu_dir - OSU provider information directory
1454 *
1455 * If set, allow FETCH_OSU control interface command to be used to fetch
1456 * OSU provider information into all APs and store the results in this
1457 * directory.
1458 */
1459 char *osu_dir;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001460
1461 /**
1462 * wowlan_triggers - Wake-on-WLAN triggers
1463 *
1464 * If set, these wowlan triggers will be configured.
1465 */
1466 char *wowlan_triggers;
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -07001467
1468 /**
1469 * p2p_search_delay - Extra delay between concurrent search iterations
1470 *
1471 * Add extra delay (in milliseconds) between search iterations when
1472 * there is a concurrent operation to make p2p_find friendlier to
1473 * concurrent operations by avoiding it from taking 100% of radio
1474 * resources.
1475 */
1476 unsigned int p2p_search_delay;
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001477
1478 /**
1479 * mac_addr - MAC address policy default
1480 *
1481 * 0 = use permanent MAC address
1482 * 1 = use random MAC address for each ESS connection
1483 * 2 = like 1, but maintain OUI (with local admin bit set)
1484 *
1485 * By default, permanent MAC address is used unless policy is changed by
1486 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1487 * change this default behavior.
1488 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001489 enum wpas_mac_addr_style mac_addr;
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001490
1491 /**
1492 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1493 */
1494 unsigned int rand_addr_lifetime;
1495
1496 /**
1497 * preassoc_mac_addr - Pre-association MAC address policy
1498 *
1499 * 0 = use permanent MAC address
1500 * 1 = use random MAC address
1501 * 2 = like 1, but maintain OUI (with local admin bit set)
1502 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001503 enum wpas_mac_addr_style preassoc_mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001504
1505 /**
1506 * key_mgmt_offload - Use key management offload
1507 *
1508 * Key management offload should be used if the device supports it.
1509 * Key management offload is the capability of a device operating as
1510 * a station to do the exchange necessary to establish temporal keys
1511 * during initial RSN connection, after roaming, or during a PTK
1512 * rekeying operation.
1513 */
1514 int key_mgmt_offload;
1515
1516 /**
1517 * user_mpm - MPM residency
1518 *
1519 * 0: MPM lives in driver.
1520 * 1: wpa_supplicant handles peering and station allocation.
1521 *
1522 * If AMPE or SAE is enabled, the MPM is always in userspace.
1523 */
1524 int user_mpm;
1525
1526 /**
1527 * max_peer_links - Maximum number of peer links
1528 *
1529 * Maximum number of mesh peering currently maintained by the STA.
1530 */
1531 int max_peer_links;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001532
1533 /**
1534 * cert_in_cb - Whether to include a peer certificate dump in events
1535 *
1536 * This controls whether peer certificates for authentication server and
1537 * its certificate chain are included in EAP peer certificate events.
1538 */
1539 int cert_in_cb;
1540
1541 /**
1542 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1543 *
1544 * This timeout value is used in mesh STA to clean up inactive stations.
1545 * By default: 300 seconds.
1546 */
1547 int mesh_max_inactivity;
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001548
1549 /**
Hai Shaloma20dcd72022-02-04 13:43:00 -08001550 * mesh_fwding - Mesh network layer-2 forwarding (dot11MeshForwarding)
1551 *
1552 * This controls whether to enable layer-2 forwarding.
1553 * By default: 1: enabled
1554 */
1555 int mesh_fwding;
1556
1557 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001558 * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1559 *
1560 * This timeout value is used in mesh STA to retransmit
1561 * SAE Authentication frame.
1562 * By default: 1000 milliseconds.
1563 */
1564 int dot11RSNASAERetransPeriod;
1565
1566 /**
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001567 * passive_scan - Whether to force passive scan for network connection
1568 *
1569 * This parameter can be used to force only passive scanning to be used
1570 * for network connection cases. It should be noted that this will slow
1571 * down scan operations and reduce likelihood of finding the AP. In
1572 * addition, some use cases will override this due to functional
1573 * requirements, e.g., for finding an AP that uses hidden SSID
1574 * (scan_ssid=1) or P2P device discovery.
1575 */
1576 int passive_scan;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001577
1578 /**
1579 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1580 */
1581 int reassoc_same_bss_optim;
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -07001582
1583 /**
1584 * wps_priority - Priority for the networks added through WPS
1585 *
1586 * This priority value will be set to each network profile that is added
1587 * by executing the WPS protocol.
1588 */
1589 int wps_priority;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001590
1591 /**
1592 * fst_group_id - FST group ID
1593 */
1594 char *fst_group_id;
1595
1596 /**
1597 * fst_priority - priority of the interface within the FST group
1598 */
1599 int fst_priority;
1600
1601 /**
1602 * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1603 * interface.
1604 */
1605 int fst_llt;
1606
1607 /**
1608 * wpa_rsc_relaxation - RSC relaxation on GTK installation
1609 *
1610 * Values:
1611 * 0 - use the EAPOL-Key RSC value on GTK installation
1612 * 1 - use the null RSC if a bogus RSC value is detected in message 3
1613 * of 4-Way Handshake or message 1 of Group Key Handshake.
1614 */
1615 int wpa_rsc_relaxation;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001616
1617 /**
1618 * sched_scan_plans - Scan plans for scheduled scan
1619 *
1620 * Each scan plan specifies the interval between scans and the number of
1621 * iterations. The last scan plan only specifies the scan interval and
1622 * will be run infinitely.
1623 *
1624 * format: <interval:iterations> <interval2:iterations2> ... <interval>
1625 */
1626 char *sched_scan_plans;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001627
1628#ifdef CONFIG_MBO
1629 /**
1630 * non_pref_chan - Non-preferred channels list, separated by spaces.
1631 *
1632 * format: op_class:chan:preference:reason<:detail>
1633 * Detail is optional.
1634 */
1635 char *non_pref_chan;
1636
1637 /**
1638 * mbo_cell_capa - Cellular capabilities for MBO
1639 */
1640 enum mbo_cellular_capa mbo_cell_capa;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001641
1642 /**
1643 * disassoc_imminent_rssi_threshold - RSSI threshold of candidate AP
1644 * when disassociation imminent is set.
1645 */
1646 int disassoc_imminent_rssi_threshold;
1647
1648 /**
1649 * oce - Enable OCE in STA and/or STA-CFON mode
1650 * - Set BIT(0) to enable OCE in non-AP STA mode
1651 * - Set BIT(1) to enable OCE in STA-CFON mode
1652 */
1653 unsigned int oce;
Sunil Ravi84bb3e12021-06-10 09:52:05 -07001654#endif /* CONFIG_MBO */
Dennis Jeone2cb56b2020-10-23 21:23:01 +09001655 /**
1656 * btm_offload - Set where to perform roaming logic
1657 * - Set to 0 to handle fully roaming logic in supplicant
1658 * - Set to 1 to skip roaming logic in supplicant for firmware roaming
1659 * just parse BTM frame and notify framework
1660 */
Sunil Ravi84bb3e12021-06-10 09:52:05 -07001661 int btm_offload;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001662
1663 /**
1664 * gas_address3 - GAS Address3 field behavior
1665 *
1666 * Values:
1667 * 0 - P2P specification (Address3 = AP BSSID)
1668 * 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
1669 * sent to not-associated AP; if associated, AP BSSID)
1670 */
1671 int gas_address3;
Dmitry Shmidt7d175302016-09-06 13:11:34 -07001672
1673 /**
1674 * ftm_responder - Publish FTM (fine timing measurement)
1675 * responder functionality
1676 *
1677 * Values:
1678 * 0 - do not publish FTM responder functionality (Default)
1679 * 1 - publish FTM responder functionality in
1680 * bit 70 of Extended Capabilities element
1681 * Note, actual FTM responder operation is managed outside
1682 * wpa_supplicant.
1683 */
1684 int ftm_responder;
1685
1686 /**
1687 * ftm_initiator - Publish FTM (fine timing measurement)
1688 * initiator functionality
1689 *
1690 * Values:
1691 * 0 - do not publish FTM initiator functionality (Default)
1692 * 1 - publish FTM initiator functionality in
1693 * bit 71 of Extended Capabilities element
1694 * Note, actual FTM initiator operation is managed outside
1695 * wpa_supplicant.
1696 */
1697 int ftm_initiator;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001698
1699 /**
1700 * gas_rand_addr_lifetime - Lifetime of random MAC address for ANQP in
1701 * seconds
1702 */
1703 unsigned int gas_rand_addr_lifetime;
1704
1705 /**
1706 * gas_rand_mac_addr - GAS MAC address policy
1707 *
1708 * 0 = use permanent MAC address
1709 * 1 = use random MAC address
1710 * 2 = like 1, but maintain OUI (with local admin bit set)
1711 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001712 enum wpas_mac_addr_style gas_rand_mac_addr;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001713
1714 /**
1715 * dpp_config_processing - How to process DPP configuration
1716 *
1717 * 0 = report received configuration to an external program for
1718 * processing; do not generate any network profile internally
1719 * 1 = report received configuration to an external program and generate
1720 * a network profile internally, but do not automatically connect
1721 * to the created (disabled) profile; the network profile id is
1722 * reported to external programs
1723 * 2 = report received configuration to an external program, generate
1724 * a network profile internally, try to connect to the created
1725 * profile automatically
1726 */
1727 int dpp_config_processing;
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001728
1729 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001730 * dpp_name - Name for Enrollee's DPP Configuration Request
1731 */
1732 char *dpp_name;
1733
1734 /**
1735 * dpp_mud_url - MUD URL for Enrollee's DPP Configuration Request
1736 */
1737 char *dpp_mud_url;
1738
1739 /**
Sunil Ravi89eba102022-09-13 21:04:37 -07001740 * dpp_extra_conf_req_name - JSON node name of additional data for
1741 * Enrollee's DPP Configuration Request
1742 */
1743 char *dpp_extra_conf_req_name;
1744
1745 /**
1746 * dpp_extra_conf_req_value - JSON node data of additional data for
1747 * Enrollee's DPP Configuration Request
1748 */
1749 char *dpp_extra_conf_req_value;
1750
1751 /* dpp_connector_privacy_default - Default valur for Connector privacy
1752 *
1753 * This value is used as the default for the dpp_connector_privacy
1754 * network parameter for all new networks provisioned using DPP.
1755 */
1756 int dpp_connector_privacy_default;
1757
1758 /**
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001759 * coloc_intf_reporting - Colocated interference reporting
1760 *
1761 * dot11CoLocIntfReportingActivated
1762 * 0 = disabled (false)
1763 * 1 = enabled (true)
1764 */
1765 int coloc_intf_reporting;
1766
1767 /**
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001768 * p2p_device_random_mac_addr - P2P Device MAC address policy default
1769 *
Hai Shalom60840252021-02-19 19:02:11 -08001770 * 0 = use permanent MAC address (the one set by default by the device
1771 * driver). Notice that, if the device driver is configured to
1772 * always use random MAC addresses, this flag breaks reinvoking a
1773 * persistent group, so flags 1 or 2 should be used instead with
1774 * such drivers if persistent groups are used.
Hai Shalom74f70d42019-02-11 14:42:39 -08001775 * 1 = use random MAC address on creating the interface if there is no
Hai Shalom60840252021-02-19 19:02:11 -08001776 * persistent group. Besides, if a persistent group is created,
1777 * p2p_device_persistent_mac_addr is set to the MAC address of the
1778 * P2P Device interface, so that this address will be subsequently
1779 * used to change the MAC address of the P2P Device interface. With
1780 * no persistent group, the random MAC address is created by
1781 * wpa_supplicant, changing the one set by the device driver.
1782 * The device driver shall support SIOCGIFFLAGS/SIOCSIFFLAGS ioctl
1783 * interface control operations.
1784 * 2 = this flag should be used when the device driver uses random MAC
1785 * addresses by default when a P2P Device interface is created.
1786 * If p2p_device_persistent_mac_addr is set, use this MAC address
1787 * on creating the P2P Device interface. If not set, use the
1788 * default method adopted by the device driver (e.g., random MAC
1789 * address). Besides, if a persistent group is created,
1790 * p2p_device_persistent_mac_addr is set to the MAC address of the
1791 * P2P Device interface, so that this address will be subsequently
1792 * used in place of the default address set by the device driver.
1793 * (This option does not need support of SIOCGIFFLAGS/SIOCSIFFLAGS
1794 * ioctl interface control operations and uses NL80211_ATTR_MAC).
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001795 *
1796 * By default, permanent MAC address is used.
1797 */
1798 int p2p_device_random_mac_addr;
1799
1800 /**
1801 * p2p_device_persistent_mac_addr - Record last used MAC address
1802 *
Hai Shalom74f70d42019-02-11 14:42:39 -08001803 * If there are saved persistent groups, P2P cannot generate another
1804 * random MAC address, and need to restore to last used MAC address.
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001805 */
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001806 u8 p2p_device_persistent_mac_addr[ETH_ALEN];
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001807
Jimmy Chen36c21992018-11-29 16:46:43 +08001808 /**
1809 * p2p_interface_random_mac_addr - P2P Interface MAC address policy default
1810 *
1811 * 0 = use permanent MAC address
1812 * 1 = use random MAC address on creating the interface.
1813 *
1814 * By default, permanent MAC address is used.
1815 */
1816 int p2p_interface_random_mac_addr;
1817
xshud0ee72f2018-11-08 14:37:01 -08001818 /**
1819 * bss_no_flush_when_down - Whether to flush BSS entries when the interface is disabled
1820 *
1821 * 0 = Flush BSS entries when the interface becomes disabled (Default)
1822 * 1 = Do not flush BSS entries when the interface becomes disabled
1823 */
1824 int bss_no_flush_when_down;
Hai Shalom81f62d82019-07-22 12:10:00 -07001825
1826 /**
1827 * disable_btm - Disable BSS transition management in STA
1828 * - Set to 0 to enable BSS transition management
1829 * - Set to 1 to disable BSS transition management
1830 *
1831 * By default BSS transition management is enabled
1832 */
1833 int disable_btm;
Hai Shalomfdcde762020-04-02 11:19:20 -07001834
1835 /**
1836 * extended_key_id - Extended Key ID support
1837 *
1838 * IEEE Std 802.11-2016 optionally allows to use Key ID 0 and 1 for PTK
1839 * keys with Extended Key ID.
1840 *
1841 * 0 = don't use Extended Key ID
1842 * 1 = use Extended Key ID when possible
1843 */
1844 int extended_key_id;
Hai Shalom60840252021-02-19 19:02:11 -08001845
1846 /**
1847 * wowlan_disconnect_on_deinit - Trigger disconnect on wpa_supplicant
1848 * interface deinit even if the driver has enabled WoWLAN.
1849 *
1850 * 0 = Do not disconnect
1851 * 1 = Trigger disconnection
1852 */
1853 int wowlan_disconnect_on_deinit;
1854
Sunil Ravi7f769292024-07-23 22:21:32 +00001855 /**
Sunil Ravi79e6c4f2025-01-04 00:47:06 +00001856 * rsn_overriding - RSN overriding (default behavior)
Sunil Ravi7f769292024-07-23 22:21:32 +00001857 */
Sunil Ravi79e6c4f2025-01-04 00:47:06 +00001858 enum wpas_rsn_overriding rsn_overriding;
Sunil Ravi7f769292024-07-23 22:21:32 +00001859
Hai Shalom60840252021-02-19 19:02:11 -08001860#ifdef CONFIG_PASN
1861#ifdef CONFIG_TESTING_OPTIONS
1862 /*
1863 * Normally, KDK should be derived if and only if both sides support
1864 * secure LTF. Allow forcing KDK derivation for testing purposes.
1865 */
1866 int force_kdk_derivation;
Hai Shaloma20dcd72022-02-04 13:43:00 -08001867
1868 /* If set, corrupt the MIC in the 3rd Authentication frame of PASN */
1869 int pasn_corrupt_mic;
1870
Hai Shalom60840252021-02-19 19:02:11 -08001871#endif /* CONFIG_TESTING_OPTIONS */
1872#endif /* CONFIG_PASN*/
Sunil Ravib0ac25f2024-07-12 01:42:03 +00001873
1874#ifdef CONFIG_TESTING_OPTIONS
1875 enum {
1876 MLD_CONNECT_BAND_PREF_AUTO = 0,
1877 MLD_CONNECT_BAND_PREF_2GHZ = 1,
1878 MLD_CONNECT_BAND_PREF_5GHZ = 2,
1879 MLD_CONNECT_BAND_PREF_6GHZ = 3,
1880 MLD_CONNECT_BAND_PREF_MAX = 4,
1881 } mld_connect_band_pref;
1882
1883 u8 mld_connect_bssid_pref[ETH_ALEN];
1884
1885 int mld_force_single_link;
1886#endif /* CONFIG_TESTING_OPTIONS */
Sunil Ravic0f5d412024-09-11 22:12:49 +00001887
1888 /* Cipher version type */
1889 int dik_cipher;
1890
1891 /* DevIK */
1892 struct wpabuf *dik;
Sunil Ravi79e6c4f2025-01-04 00:47:06 +00001893
1894 /**
1895 * identity - P2P2 peer device identities
1896 *
1897 * This is the head for the list of all the paired devices.
1898 */
1899 struct wpa_dev_ik *identity;
1900
1901 /**
1902 * twt_requester - Whether TWT Requester Support is enabled
1903 *
1904 * This is for setting the bit 77 of the Extended Capabilities element.
1905 */
1906 bool twt_requester;
1907
1908 /**
1909 * wfa_gen_capa: Whether to indicate Wi-Fi generational capability to
1910 * the AP
1911 *
1912 * 0 = do not indicate (default)
1913 * 1 = indicate in protected Action frame
1914 * 2 = indicate in unprotected (Re)Association Request frame
1915 */
1916 enum {
1917 WFA_GEN_CAPA_DISABLED = 0,
1918 WFA_GEN_CAPA_PROTECTED = 1,
1919 WFA_GEN_CAPA_UNPROTECTED = 2,
1920 } wfa_gen_capa;
1921
1922 /**
1923 * wfa_gen_capa_supp: Supported Generations (hexdump of a bit field)
1924 *
1925 * A bit field of supported Wi-Fi generations. This is encoded as an
1926 * little endian octt string.
1927 * bit 0: Wi-Fi 4
1928 * bit 1: Wi-Fi 5
1929 * bit 2: Wi-Fi 6
1930 * bit 3: Wi-Fi 7
1931 */
1932 struct wpabuf *wfa_gen_capa_supp;
1933
1934 /**
1935 * wfa_gen_capa_cert: Certified Generations (hexdump of a bit field)
1936 *
1937 * This has the same format as wfa_gen_capa_supp. This is an optional
1938 * field, but if included, shall have the same length as
1939 * wfa_gen_capa_supp.
1940 */
1941 struct wpabuf *wfa_gen_capa_cert;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001942};
1943
1944
1945/* Prototypes for common functions from config.c */
1946
1947void wpa_config_free(struct wpa_config *ssid);
1948void wpa_config_free_ssid(struct wpa_ssid *ssid);
1949void wpa_config_foreach_network(struct wpa_config *config,
1950 void (*func)(void *, struct wpa_ssid *),
1951 void *arg);
1952struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1953struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1954int wpa_config_remove_network(struct wpa_config *config, int id);
1955void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1956int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1957 int line);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001958int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1959 const char *value);
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001960int wpa_config_dump_values(struct wpa_config *config, char *buf,
1961 size_t buflen);
1962int wpa_config_get_value(const char *name, struct wpa_config *config,
1963 char *buf, size_t buflen);
1964
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001965char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1966char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1967char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1968void wpa_config_update_psk(struct wpa_ssid *ssid);
1969int wpa_config_add_prio_network(struct wpa_config *config,
1970 struct wpa_ssid *ssid);
1971int wpa_config_update_prio_list(struct wpa_config *config);
1972const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1973 const char *name);
1974void wpa_config_set_blob(struct wpa_config *config,
1975 struct wpa_config_blob *blob);
1976void wpa_config_free_blob(struct wpa_config_blob *blob);
1977int wpa_config_remove_blob(struct wpa_config *config, const char *name);
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001978void wpa_config_flush_blobs(struct wpa_config *config);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001979
Dmitry Shmidt04949592012-07-19 12:16:46 -07001980struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1981struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1982int wpa_config_remove_cred(struct wpa_config *config, int id);
1983void wpa_config_free_cred(struct wpa_cred *cred);
1984int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1985 const char *value, int line);
Dmitry Shmidt0cfd5f72014-04-04 14:48:05 -07001986char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
Dmitry Shmidt04949592012-07-19 12:16:46 -07001987
Sunil Ravi79e6c4f2025-01-04 00:47:06 +00001988int wpa_config_set_identity(struct wpa_dev_ik *identity, const char *var,
1989 const char *value, int line);
1990void wpa_config_free_identity(struct wpa_dev_ik *identity);
1991struct wpa_dev_ik * wpa_config_add_identity(struct wpa_config *config);
1992int wpa_config_remove_identity(struct wpa_config *config, int id);
1993
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001994struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1995 const char *driver_param);
1996#ifndef CONFIG_NO_STDOUT_DEBUG
1997void wpa_config_debug_dump_networks(struct wpa_config *config);
1998#else /* CONFIG_NO_STDOUT_DEBUG */
1999#define wpa_config_debug_dump_networks(c) do { } while (0)
2000#endif /* CONFIG_NO_STDOUT_DEBUG */
2001
2002
2003/* Prototypes for common functions from config.c */
2004int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
2005
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002006int wpa_config_get_num_global_field_names(void);
2007
2008const char * wpa_config_get_global_field_name(unsigned int i, int *no_var);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002009
2010/* Prototypes for backend specific functions from the selected config_*.c */
2011
2012/**
2013 * wpa_config_read - Read and parse configuration database
2014 * @name: Name of the configuration (e.g., path and file name for the
2015 * configuration file)
Jouni Malinen5d1c8ad2013-04-23 12:34:56 -07002016 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
Sunil Ravi77d572f2023-01-17 23:58:31 +00002017 * @ro: Whether to mark networks from this configuration as read-only
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002018 * Returns: Pointer to allocated configuration data or %NULL on failure
2019 *
2020 * This function reads configuration data, parses its contents, and allocates
2021 * data structures needed for storing configuration information. The allocated
2022 * data can be freed with wpa_config_free().
2023 *
2024 * Each configuration backend needs to implement this function.
2025 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00002026struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp,
2027 bool ro);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002028
2029/**
2030 * wpa_config_write - Write or update configuration data
2031 * @name: Name of the configuration (e.g., path and file name for the
2032 * configuration file)
2033 * @config: Configuration data from wpa_config_read()
2034 * Returns: 0 on success, -1 on failure
2035 *
2036 * This function write all configuration data into an external database (e.g.,
2037 * a text file) in a format that can be read with wpa_config_read(). This can
2038 * be used to allow wpa_supplicant to update its configuration, e.g., when a
2039 * new network is added or a password is changed.
2040 *
2041 * Each configuration backend needs to implement this function.
2042 */
2043int wpa_config_write(const char *name, struct wpa_config *config);
2044
2045#endif /* CONFIG_H */