blob: 7ea43a66db2fc8d48a0491a5776e4a45fd446d01 [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
433
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700434#define CFG_CHANGED_DEVICE_NAME BIT(0)
435#define CFG_CHANGED_CONFIG_METHODS BIT(1)
436#define CFG_CHANGED_DEVICE_TYPE BIT(2)
437#define CFG_CHANGED_OS_VERSION BIT(3)
438#define CFG_CHANGED_UUID BIT(4)
439#define CFG_CHANGED_COUNTRY BIT(5)
440#define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
441#define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
442#define CFG_CHANGED_WPS_STRING BIT(8)
443#define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
444#define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
Jouni Malinen75ecf522011-06-27 15:19:46 -0700445#define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
446#define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700447#define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700448#define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800449#define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700450#define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800451#define CFG_CHANGED_SCHED_SCAN_PLANS BIT(17)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700452#define CFG_CHANGED_WOWLAN_TRIGGERS BIT(18)
Hai Shalom81f62d82019-07-22 12:10:00 -0700453#define CFG_CHANGED_DISABLE_BTM BIT(19)
Hai Shalom899fcc72020-10-19 14:38:18 -0700454#define CFG_CHANGED_BGSCAN BIT(20)
Sunil Ravib0ac25f2024-07-12 01:42:03 +0000455#define CFG_CHANGED_FT_PREPEND_PMKID BIT(21)
456#define CFG_CHANGED_DISABLE_BTM_NOTIFY BIT(22)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700457
458/**
459 * struct wpa_config - wpa_supplicant configuration data
460 *
461 * This data structure is presents the per-interface (radio) configuration
462 * data. In many cases, there is only one struct wpa_config instance, but if
463 * more than one network interface is being controlled, one instance is used
464 * for each.
465 */
466struct wpa_config {
467 /**
468 * ssid - Head of the global network list
469 *
470 * This is the head for the list of all the configured networks.
471 */
472 struct wpa_ssid *ssid;
473
474 /**
475 * pssid - Per-priority network lists (in priority order)
476 */
477 struct wpa_ssid **pssid;
478
479 /**
480 * num_prio - Number of different priorities used in the pssid lists
481 *
482 * This indicates how many per-priority network lists are included in
483 * pssid.
484 */
Hai Shalomfdcde762020-04-02 11:19:20 -0700485 size_t num_prio;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700486
487 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700488 * cred - Head of the credential list
489 *
490 * This is the head for the list of all the configured credentials.
491 */
492 struct wpa_cred *cred;
493
494 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700495 * eapol_version - IEEE 802.1X/EAPOL version number
496 *
497 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
498 * defines EAPOL version 2. However, there are many APs that do not
499 * handle the new version number correctly (they seem to drop the
500 * frames completely). In order to make wpa_supplicant interoperate
501 * with these APs, the version number is set to 1 by default. This
502 * configuration value can be used to set it to the new version (2).
503 */
504 int eapol_version;
505
506 /**
507 * ap_scan - AP scanning/selection
508 *
509 * By default, wpa_supplicant requests driver to perform AP
510 * scanning and then uses the scan results to select a
511 * suitable AP. Another alternative is to allow the driver to
512 * take care of AP scanning and selection and use
513 * wpa_supplicant just to process EAPOL frames based on IEEE
514 * 802.11 association information from the driver.
515 *
516 * 1: wpa_supplicant initiates scanning and AP selection (default).
517 *
518 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
519 * association parameters (e.g., WPA IE generation); this mode can
520 * also be used with non-WPA drivers when using IEEE 802.1X mode;
521 * do not try to associate with APs (i.e., external program needs
522 * to control association). This mode must also be used when using
523 * wired Ethernet drivers.
524 *
525 * 2: like 0, but associate with APs using security policy and SSID
526 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
527 * drivers to enable operation with hidden SSIDs and optimized roaming;
528 * in this mode, the network blocks in the configuration are tried
529 * one by one until the driver reports successful association; each
530 * network block should have explicit security policy (i.e., only one
531 * option in the lists) for key_mgmt, pairwise, group, proto variables.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800532 *
533 * Note: ap_scan=2 should not be used with the nl80211 driver interface
534 * (the current Linux interface). ap_scan=1 is optimized work working
535 * with nl80211. For finding networks using hidden SSID, scan_ssid=1 in
536 * the network block can be used with nl80211.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700537 */
538 int ap_scan;
539
540 /**
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800541 * bgscan - Background scan and roaming parameters or %NULL if none
542 *
543 * This is an optional set of parameters for background scanning and
544 * roaming within a network (ESS). For more detailed information see
545 * ssid block documentation.
546 *
547 * The variable defines default bgscan behavior for all BSS station
548 * networks except for those which have their own bgscan configuration.
549 */
550 char *bgscan;
551
552 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700553 * disable_scan_offload - Disable automatic offloading of scan requests
554 *
555 * By default, %wpa_supplicant tries to offload scanning if the driver
556 * indicates support for this (sched_scan). This configuration
557 * parameter can be used to disable this offloading mechanism.
558 */
559 int disable_scan_offload;
560
561 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700562 * ctrl_interface - Parameters for the control interface
563 *
564 * If this is specified, %wpa_supplicant will open a control interface
565 * that is available for external programs to manage %wpa_supplicant.
566 * The meaning of this string depends on which control interface
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800567 * mechanism is used. For all cases, the existence of this parameter
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700568 * in configuration is used to determine whether the control interface
569 * is enabled.
570 *
571 * For UNIX domain sockets (default on Linux and BSD): This is a
572 * directory that will be created for UNIX domain sockets for listening
573 * to requests from external programs (CLI/GUI, etc.) for status
574 * information and configuration. The socket file will be named based
575 * on the interface name, so multiple %wpa_supplicant processes can be
576 * run at the same time if more than one interface is used.
577 * /var/run/wpa_supplicant is the recommended directory for sockets and
578 * by default, wpa_cli will use it when trying to connect with
579 * %wpa_supplicant.
580 *
581 * Access control for the control interface can be configured
582 * by setting the directory to allow only members of a group
583 * to use sockets. This way, it is possible to run
584 * %wpa_supplicant as root (since it needs to change network
585 * configuration and open raw sockets) and still allow GUI/CLI
586 * components to be run as non-root users. However, since the
587 * control interface can be used to change the network
588 * configuration, this access needs to be protected in many
589 * cases. By default, %wpa_supplicant is configured to use gid
590 * 0 (root). If you want to allow non-root users to use the
591 * control interface, add a new group and change this value to
592 * match with that group. Add users that should have control
593 * interface access to this group.
594 *
595 * When configuring both the directory and group, use following format:
596 * DIR=/var/run/wpa_supplicant GROUP=wheel
597 * DIR=/var/run/wpa_supplicant GROUP=0
598 * (group can be either group name or gid)
599 *
600 * For UDP connections (default on Windows): The value will be ignored.
601 * This variable is just used to select that the control interface is
602 * to be created. The value can be set to, e.g., udp
603 * (ctrl_interface=udp).
604 *
605 * For Windows Named Pipe: This value can be used to set the security
606 * descriptor for controlling access to the control interface. Security
607 * descriptor can be set using Security Descriptor String Format (see
608 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
609 * The descriptor string needs to be prefixed with SDDL=. For example,
610 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
611 * all connections).
612 */
613 char *ctrl_interface;
614
615 /**
616 * ctrl_interface_group - Control interface group (DEPRECATED)
617 *
618 * This variable is only used for backwards compatibility. Group for
619 * UNIX domain sockets should now be specified using GROUP=group in
620 * ctrl_interface variable.
621 */
622 char *ctrl_interface_group;
623
624 /**
625 * fast_reauth - EAP fast re-authentication (session resumption)
626 *
627 * By default, fast re-authentication is enabled for all EAP methods
628 * that support it. This variable can be used to disable fast
629 * re-authentication (by setting fast_reauth=0). Normally, there is no
630 * need to disable fast re-authentication.
631 */
632 int fast_reauth;
633
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000634#ifndef CONFIG_OPENSC_ENGINE_PATH
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700635 /**
636 * opensc_engine_path - Path to the OpenSSL engine for opensc
637 *
638 * This is an OpenSSL specific configuration option for loading OpenSC
639 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
640 */
641 char *opensc_engine_path;
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000642#endif /* CONFIG_OPENSC_ENGINE_PATH */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700643
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000644#ifndef CONFIG_PKCS11_ENGINE_PATH
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700645 /**
646 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
647 *
648 * This is an OpenSSL specific configuration option for loading PKCS#11
649 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
650 */
651 char *pkcs11_engine_path;
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000652#endif /* CONFIG_PKCS11_ENGINE_PATH */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700653
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000654#ifndef CONFIG_PKCS11_MODULE_PATH
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700655 /**
656 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
657 *
658 * This is an OpenSSL specific configuration option for configuring
659 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
660 * module is not loaded.
661 */
662 char *pkcs11_module_path;
Sunil Ravi2a14cf12023-11-21 00:54:38 +0000663#endif /* CONFIG_PKCS11_MODULE_PATH */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700664
665 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800666 * openssl_ciphers - OpenSSL cipher string
667 *
668 * This is an OpenSSL specific configuration option for configuring the
669 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
670 * default.
671 */
672 char *openssl_ciphers;
673
674 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700675 * pcsc_reader - PC/SC reader name prefix
676 *
677 * If not %NULL, PC/SC reader with a name that matches this prefix is
678 * initialized for SIM/USIM access. Empty string can be used to match
679 * the first available reader.
680 */
681 char *pcsc_reader;
682
683 /**
684 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
685 *
686 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
687 * EAP-AKA. If left out, this will be asked through control interface.
688 */
689 char *pcsc_pin;
690
691 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -0700692 * external_sim - Use external processing for SIM/USIM operations
693 */
694 int external_sim;
695
696 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700697 * driver_param - Driver interface parameters
698 *
699 * This text string is passed to the selected driver interface with the
700 * optional struct wpa_driver_ops::set_param() handler. This can be
701 * used to configure driver specific options without having to add new
702 * driver interface functionality.
703 */
704 char *driver_param;
705
706 /**
707 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
708 *
709 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
710 * cache (unit: seconds).
711 */
712 unsigned int dot11RSNAConfigPMKLifetime;
713
714 /**
715 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
716 *
717 * dot11 MIB variable for the percentage of the PMK lifetime
718 * that should expire before an IEEE 802.1X reauthentication occurs.
719 */
720 unsigned int dot11RSNAConfigPMKReauthThreshold;
721
722 /**
723 * dot11RSNAConfigSATimeout - Security association timeout
724 *
725 * dot11 MIB variable for the maximum time a security association
726 * shall take to set up (unit: seconds).
727 */
728 unsigned int dot11RSNAConfigSATimeout;
729
730 /**
Sunil Ravib0ac25f2024-07-12 01:42:03 +0000731 * ft_prepend_pmkid - Whether to prepend PMKR1Name with PMKIDs
732 *
733 * This control whether PMKR1Name is prepended to the PMKID list
734 * insread of replacing the full list when constructing RSNE for
735 * EAPOL-Key msg 2/4 for FT cases. */
736 bool ft_prepend_pmkid;
737
738 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700739 * update_config - Is wpa_supplicant allowed to update configuration
740 *
741 * This variable control whether wpa_supplicant is allow to re-write
742 * its configuration with wpa_config_write(). If this is zero,
743 * configuration data is only changed in memory and the external data
Hai Shalom60840252021-02-19 19:02:11 -0800744 * is not overridden. If this is non-zero, wpa_supplicant will update
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700745 * the configuration data (e.g., a file) whenever configuration is
746 * changed. This update may replace the old configuration which can
747 * remove comments from it in case of a text file configuration.
748 */
749 int update_config;
750
751 /**
752 * blobs - Configuration blobs
753 */
754 struct wpa_config_blob *blobs;
755
756 /**
757 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
758 */
759 u8 uuid[16];
760
761 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700762 * auto_uuid - Automatic UUID behavior
763 * 0 = generate static value based on the local MAC address (default)
764 * 1 = generate a random UUID every time wpa_supplicant starts
765 */
766 int auto_uuid;
767
768 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700769 * device_name - Device Name (WPS)
770 * User-friendly description of device; up to 32 octets encoded in
771 * UTF-8
772 */
773 char *device_name;
774
775 /**
776 * manufacturer - Manufacturer (WPS)
777 * The manufacturer of the device (up to 64 ASCII characters)
778 */
779 char *manufacturer;
780
781 /**
782 * model_name - Model Name (WPS)
783 * Model of the device (up to 32 ASCII characters)
784 */
785 char *model_name;
786
787 /**
788 * model_number - Model Number (WPS)
789 * Additional device description (up to 32 ASCII characters)
790 */
791 char *model_number;
792
793 /**
794 * serial_number - Serial Number (WPS)
795 * Serial number of the device (up to 32 characters)
796 */
797 char *serial_number;
798
799 /**
800 * device_type - Primary Device Type (WPS)
801 */
802 u8 device_type[WPS_DEV_TYPE_LEN];
803
804 /**
805 * config_methods - Config Methods
806 *
807 * This is a space-separated list of supported WPS configuration
808 * methods. For example, "label virtual_display virtual_push_button
809 * keypad".
810 * Available methods: usba ethernet label display ext_nfc_token
811 * int_nfc_token nfc_interface push_button keypad
812 * virtual_display physical_display
813 * virtual_push_button physical_push_button.
814 */
815 char *config_methods;
816
817 /**
818 * os_version - OS Version (WPS)
819 * 4-octet operating system version number
820 */
821 u8 os_version[4];
822
823 /**
824 * country - Country code
825 *
826 * This is the ISO/IEC alpha2 country code for which we are operating
827 * in
828 */
829 char country[2];
830
831 /**
832 * wps_cred_processing - Credential processing
833 *
834 * 0 = process received credentials internally
835 * 1 = do not process received credentials; just pass them over
836 * ctrl_iface to external program(s)
837 * 2 = process received credentials internally and pass them over
838 * ctrl_iface to external program(s)
839 */
840 int wps_cred_processing;
841
Hai Shalom021b0b52019-04-10 11:17:58 -0700842 /**
843 * wps_cred_add_sae - Whether to enable SAE automatically for WPS
844 *
845 * 0 = only add the explicitly listed WPA2-PSK configuration
846 * 1 = add both the WPA2-PSK and SAE configuration and enable PMF so
847 * that the station gets configured in WPA3-Personal transition mode
848 * (supports both WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
849 */
850 int wps_cred_add_sae;
851
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700852#define MAX_SEC_DEVICE_TYPES 5
853 /**
854 * sec_device_types - Secondary Device Types (P2P)
855 */
856 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
857 int num_sec_device_types;
858
859 int p2p_listen_reg_class;
860 int p2p_listen_channel;
861 int p2p_oper_reg_class;
862 int p2p_oper_channel;
863 int p2p_go_intent;
864 char *p2p_ssid_postfix;
865 int persistent_reconnect;
866 int p2p_intra_bss;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700867 unsigned int num_p2p_pref_chan;
868 struct p2p_channel *p2p_pref_chan;
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700869 struct wpa_freq_range_list p2p_no_go_freq;
870 int p2p_add_cli_chan;
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700871 int p2p_ignore_shared_freq;
Dmitry Shmidt43cb5782014-06-16 16:23:22 -0700872 int p2p_optimize_listen_chan;
Hai Shalom899fcc72020-10-19 14:38:18 -0700873 int p2p_6ghz_disable;
Shuibing Dai64a8a892023-03-08 10:26:22 -0800874 int p2p_dfs_chan_enable;
Hai Shalom899fcc72020-10-19 14:38:18 -0700875
Dmitry Shmidt04949592012-07-19 12:16:46 -0700876 struct wpabuf *wps_vendor_ext_m1;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700877
878#define MAX_WPS_VENDOR_EXT 10
879 /**
880 * wps_vendor_ext - Vendor extension attributes in WPS
881 */
882 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
883
884 /**
885 * p2p_group_idle - Maximum idle time in seconds for P2P group
886 *
887 * This value controls how long a P2P group is maintained after there
888 * is no other members in the group. As a GO, this means no associated
889 * stations in the group. As a P2P client, this means no GO seen in
890 * scan results. The maximum idle time is specified in seconds with 0
891 * indicating no time limit, i.e., the P2P group remains in active
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800892 * state indefinitely until explicitly removed. As a P2P client, the
893 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
894 * this parameter is mainly meant for GO use and for P2P client, it can
Dmitry Shmidt04949592012-07-19 12:16:46 -0700895 * only be used to reduce the default timeout to smaller value. A
896 * special value -1 can be used to configure immediate removal of the
897 * group for P2P client role on any disconnection after the data
898 * connection has been established.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700899 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700900 int p2p_group_idle;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700901
902 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800903 * p2p_go_freq_change_policy - The GO frequency change policy
904 *
905 * This controls the behavior of the GO when there is a change in the
906 * map of the currently used frequencies in case more than one channel
907 * is supported.
908 *
909 * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
910 * possible. In case the GO is the only interface using its frequency
911 * and there are other station interfaces on other frequencies, the GO
912 * will migrate to one of these frequencies.
913 *
914 * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
915 * but a transition is possible only in case one of the other used
916 * frequencies is one of the frequencies in the intersection of the
917 * frequency list of the local device and the peer device.
918 *
919 * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
920 *
921 * @P2P_GO_FREQ_MOVE_SCM_ECSA: Same as
922 * P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS but a transition is possible only
923 * if all the group members advertise eCSA support.
924 */
925 enum {
926 P2P_GO_FREQ_MOVE_SCM = 0,
927 P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS = 1,
928 P2P_GO_FREQ_MOVE_STAY = 2,
929 P2P_GO_FREQ_MOVE_SCM_ECSA = 3,
930 P2P_GO_FREQ_MOVE_MAX = P2P_GO_FREQ_MOVE_SCM_ECSA,
931 } p2p_go_freq_change_policy;
932
933#define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
934
935 /**
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700936 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
937 *
938 * This parameter controls the length of the random passphrase that is
939 * generated at the GO.
940 */
941 unsigned int p2p_passphrase_len;
942
943 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700944 * bss_max_count - Maximum number of BSS entries to keep in memory
945 */
946 unsigned int bss_max_count;
947
948 /**
949 * bss_expiration_age - BSS entry age after which it can be expired
950 *
951 * This value controls the time in seconds after which a BSS entry
952 * gets removed if it has not been updated or is not in use.
953 */
954 unsigned int bss_expiration_age;
955
956 /**
957 * bss_expiration_scan_count - Expire BSS after number of scans
958 *
959 * If the BSS entry has not been seen in this many scans, it will be
960 * removed. A value of 1 means that entry is removed after the first
961 * scan in which the BSSID is not seen. Larger values can be used
962 * to avoid BSS entries disappearing if they are not visible in
963 * every scan (e.g., low signal quality or interference).
964 */
965 unsigned int bss_expiration_scan_count;
966
967 /**
968 * filter_ssids - SSID-based scan result filtering
969 *
970 * 0 = do not filter scan results
971 * 1 = only include configured SSIDs in scan results/BSS table
972 */
973 int filter_ssids;
974
975 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700976 * filter_rssi - RSSI-based scan result filtering
977 *
978 * 0 = do not filter scan results
979 * -n = filter scan results below -n dBm
980 */
981 int filter_rssi;
982
983 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700984 * max_num_sta - Maximum number of STAs in an AP/P2P GO
985 */
986 unsigned int max_num_sta;
987
988 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -0700989 * ap_isolate - Whether to use client isolation feature
990 *
991 * Client isolation can be used to prevent low-level bridging of
992 * frames between associated stations in the BSS. By default,
993 * this bridging is allowed (ap_isolate=0); except in P2P GO case,
994 * where p2p_intra_bss parameter is used to determine whether to allow
995 * intra-BSS forwarding (ap_isolate = !p2p_intra_bss).
996 *
997 * 0 = do not enable AP isolation
998 * 1 = enable AP isolation
999 */
1000 int ap_isolate;
1001
1002 /**
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001003 * freq_list - Array of allowed scan frequencies or %NULL for all
1004 *
1005 * This is an optional zero-terminated array of frequencies in
1006 * megahertz (MHz) to allow for narrowing scanning range.
1007 */
1008 int *freq_list;
1009
1010 /**
Hai Shalom60840252021-02-19 19:02:11 -08001011 * initial_freq_list - like freq_list but for initial scan
1012 *
1013 * This is an optional zero-terminated array of frequencies in
1014 * megahertz (MHz) to allow for narrowing scanning range when
1015 * the application is started.
1016 *
1017 * This can be used to speed up initial connection time if the
1018 * channel is known ahead of time, without limiting the scanned
1019 * frequencies during normal use.
1020 */
1021 int *initial_freq_list;
1022
1023 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001024 * scan_cur_freq - Whether to scan only the current channel
1025 *
1026 * If true, attempt to scan only the current channel if any other
1027 * VIFs on this radio are already associated on a particular channel.
1028 */
1029 int scan_cur_freq;
1030
1031 /**
Hai Shalom60840252021-02-19 19:02:11 -08001032 * scan_res_valid_for_connect - Seconds scans are valid for association
1033 *
1034 * This configures the number of seconds old scan results are considered
1035 * valid for association. When scan results are older than this value
1036 * a new scan is triggered prior to the association.
1037 */
1038 int scan_res_valid_for_connect;
1039
1040 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001041 * changed_parameters - Bitmap of changed parameters since last update
1042 */
1043 unsigned int changed_parameters;
1044
1045 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07001046 * disassoc_low_ack - Disassociate stations with massive packet loss
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001047 */
1048 int disassoc_low_ack;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001049
1050 /**
1051 * interworking - Whether Interworking (IEEE 802.11u) is enabled
1052 */
1053 int interworking;
1054
1055 /**
1056 * access_network_type - Access Network Type
1057 *
1058 * When Interworking is enabled, scans will be limited to APs that
1059 * advertise the specified Access Network Type (0..15; with 15
1060 * indicating wildcard match).
1061 */
1062 int access_network_type;
1063
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001064 /**
1065 * go_interworking - Whether Interworking for P2P GO is enabled
1066 */
1067 int go_interworking;
1068
1069 /**
1070 * go_access_network_type - P2P GO Access Network Type
1071 *
1072 * This indicates which access network type to advertise if Interworking
1073 * is enabled for P2P GO.
1074 */
1075 int go_access_network_type;
1076
1077 /**
1078 * go_internet - Interworking: Internet connectivity (0 or 1)
1079 */
1080 int go_internet;
1081
1082 /**
1083 * go_venue_group - Interworking: Venue group
1084 */
1085 int go_venue_group;
1086
1087 /**
1088 * go_venue_type: Interworking: Venue type
1089 */
1090 int go_venue_type;
1091
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001092 /**
Hai Shalom899fcc72020-10-19 14:38:18 -07001093 * hessid - Homogeneous ESS identifier
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001094 *
1095 * If this is set (any octet is non-zero), scans will be used to
1096 * request response only from BSSes belonging to the specified
1097 * Homogeneous ESS. This is used only if interworking is enabled.
1098 */
1099 u8 hessid[ETH_ALEN];
1100
1101 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001102 * hs20 - Hotspot 2.0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001103 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001104 int hs20;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001105
1106 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001107 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
1108 *
1109 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
1110 * by acting as a Registrar and using M1 from the AP. The config
1111 * methods attribute in that message is supposed to indicate only the
1112 * configuration method supported by the AP in Enrollee role, i.e., to
1113 * add an external Registrar. For that case, PBC shall not be used and
1114 * as such, the PushButton config method is removed from M1 by default.
1115 * If pbc_in_m1=1 is included in the configuration file, the PushButton
1116 * config method is left in M1 (if included in config_methods
1117 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
1118 * a label in the AP).
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001119 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001120 int pbc_in_m1;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001121
1122 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001123 * autoscan - Automatic scan parameters or %NULL if none
1124 *
1125 * This is an optional set of parameters for automatic scanning
1126 * within an interface in following format:
1127 * <autoscan module name>:<module parameters>
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001128 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001129 char *autoscan;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001130
1131 /**
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001132 * wps_nfc_pw_from_config - NFC Device Password was read from config
1133 *
1134 * This parameter can be determined whether the NFC Device Password was
1135 * included in the configuration (1) or generated dynamically (0). Only
1136 * the former case is re-written back to the configuration file.
1137 */
1138 int wps_nfc_pw_from_config;
1139
1140 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001141 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001142 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001143 int wps_nfc_dev_pw_id;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001144
1145 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001146 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001147 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001148 struct wpabuf *wps_nfc_dh_pubkey;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001149
1150 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001151 * wps_nfc_dh_privkey - NFC DH Private Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001152 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001153 struct wpabuf *wps_nfc_dh_privkey;
1154
1155 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001156 * wps_nfc_dev_pw - NFC Device Password for password token
Dmitry Shmidt04949592012-07-19 12:16:46 -07001157 */
1158 struct wpabuf *wps_nfc_dev_pw;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001159
1160 /**
1161 * ext_password_backend - External password backend or %NULL if none
1162 *
1163 * format: <backend name>[:<optional backend parameters>]
1164 */
1165 char *ext_password_backend;
1166
1167 /*
1168 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
1169 *
1170 * This timeout value is used in P2P GO mode to clean up
1171 * inactive stations.
1172 * By default: 300 seconds.
1173 */
1174 int p2p_go_max_inactivity;
1175
1176 struct hostapd_wmm_ac_params wmm_ac_params[4];
Hai Shalom899fcc72020-10-19 14:38:18 -07001177 struct hostapd_tx_queue_params tx_queue[4];
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001178
1179 /**
1180 * auto_interworking - Whether to use network selection automatically
1181 *
1182 * 0 = do not automatically go through Interworking network selection
1183 * (i.e., require explicit interworking_select command for this)
1184 * 1 = perform Interworking network selection if one or more
1185 * credentials have been configured and scan did not find a
1186 * matching network block
1187 */
1188 int auto_interworking;
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001189
1190 /**
1191 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
1192 *
1193 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1194 * Note that regulatory constraints and driver capabilities are
1195 * consulted anyway, so setting it to 1 can't do real harm.
1196 * By default: 0 (disabled)
1197 */
1198 int p2p_go_ht40;
1199
1200 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001201 * p2p_go_vht - Default mode for VHT enable when operating as GO
1202 *
1203 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1204 * Note that regulatory constraints and driver capabilities are
1205 * consulted anyway, so setting it to 1 can't do real harm.
1206 * By default: 0 (disabled)
1207 */
1208 int p2p_go_vht;
1209
1210 /**
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08001211 * p2p_go_edmg - Default mode for EDMG enable when operating as GO
1212 *
1213 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1214 * Note that regulatory constraints and driver capabilities are
1215 * consulted anyway, so setting it to 1 can't do real harm.
1216 * By default: 0 (disabled)
1217 */
1218 int p2p_go_edmg;
1219
1220 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08001221 * p2p_go_he - Default mode for 11ax HE enable when operating as GO
1222 *
1223 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1224 * Note that regulatory constraints and driver capabilities are
1225 * consulted anyway, so setting it to 1 can't do real harm.
1226 * By default: 0 (disabled)
1227 */
1228 int p2p_go_he;
1229
1230 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001231 * p2p_go_ctwindow - CTWindow to use when operating as GO
1232 *
1233 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
1234 * the length of the CTWindow in TUs.
1235 */
1236 int p2p_go_ctwindow;
1237
1238 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001239 * p2p_disabled - Whether P2P operations are disabled for this interface
1240 */
1241 int p2p_disabled;
1242
1243 /**
1244 * p2p_no_group_iface - Whether group interfaces can be used
1245 *
1246 * By default, wpa_supplicant will create a separate interface for P2P
1247 * group operations if the driver supports this. This functionality can
1248 * be disabled by setting this parameter to 1. In that case, the same
1249 * interface that was used for the P2P management operations is used
1250 * also for the group operation.
1251 */
1252 int p2p_no_group_iface;
1253
1254 /**
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07001255 * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1256 *
1257 * If this parameter is set to 1, a connected P2P Client will receive
1258 * and handle Probe Request frames. Setting this parameter to 0
1259 * disables this option. Default value: 0.
1260 *
1261 * Note: Setting this property at run time takes effect on the following
1262 * interface state transition to/from the WPA_COMPLETED state.
1263 */
1264 int p2p_cli_probe;
1265
1266 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001267 * okc - Whether to enable opportunistic key caching by default
1268 *
1269 * By default, OKC is disabled unless enabled by the per-network
1270 * proactive_key_caching=1 parameter. okc=1 can be used to change this
1271 * default behavior.
1272 */
1273 int okc;
1274
1275 /**
1276 * pmf - Whether to enable/require PMF by default
1277 *
1278 * By default, PMF is disabled unless enabled by the per-network
1279 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001280 * this default behavior for RSN network (this is not applicable for
1281 * non-RSN cases).
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001282 */
1283 enum mfp_options pmf;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001284
1285 /**
Sunil Ravi77d572f2023-01-17 23:58:31 +00001286 * sae_check_mfp - Whether to limit SAE based on PMF capabilities
1287 *
1288 * With this check SAE key_mgmt will not be selected if PMF is
1289 * not enabled.
1290 * Scenarios where enabling this check will limit SAE:
1291 * 1) ieee8011w=0 is set for the network.
1292 * 2) The AP does not have PMF enabled.
1293 * 3) ieee8011w for the network is the default(3), pmf=1 is enabled
1294 * globally and the device does not support the BIP cipher.
1295 *
1296 * Useful to allow the BIP cipher check that occurs for ieee80211w=3
1297 * and pmf=1 to also avoid using SAE key_mgmt.
1298 * Useful when hardware does not support BIP to still to allow
1299 * connecting to sae_require_mfp=1 WPA2+WPA3-Personal transition mode
1300 *access points by automatically selecting PSK instead of SAE.
1301 */
1302 int sae_check_mfp;
1303
1304 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001305 * sae_groups - Preference list of enabled groups for SAE
1306 *
1307 * By default (if this parameter is not set), the mandatory group 19
1308 * (ECC group defined over a 256-bit prime order field) is preferred,
1309 * but other groups are also enabled. If this parameter is set, the
1310 * groups will be tried in the indicated order.
1311 */
1312 int *sae_groups;
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001313
1314 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001315 * sae_pwe - SAE mechanism for PWE derivation
1316 * 0 = hunting-and-pecking loop only
1317 * 1 = hash-to-element only
1318 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1319 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001320 enum sae_pwe sae_pwe;
Hai Shalomc3565922019-10-28 11:58:20 -07001321
1322 /**
1323 * sae_pmkid_in_assoc - Whether to include PMKID in SAE Assoc Req
1324 */
1325 int sae_pmkid_in_assoc;
1326
1327 /**
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001328 * dtim_period - Default DTIM period in Beacon intervals
1329 *
1330 * This parameter can be used to set the default value for network
1331 * blocks that do not specify dtim_period.
1332 */
1333 int dtim_period;
1334
1335 /**
1336 * beacon_int - Default Beacon interval in TU
1337 *
1338 * This parameter can be used to set the default value for network
1339 * blocks that do not specify beacon_int.
1340 */
1341 int beacon_int;
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -07001342
1343 /**
1344 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1345 *
1346 * This parameter can be used to define additional vendor specific
1347 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1348 * format for these element(s) is a hexdump of the raw information
1349 * elements (id+len+payload for one or more elements).
1350 */
1351 struct wpabuf *ap_vendor_elements;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001352
1353 /**
Hai Shaloma20dcd72022-02-04 13:43:00 -08001354 * ap_assocresp_elements: Vendor specific elements for (Re)Association
1355 * Response frames
1356 *
1357 * This parameter can be used to define additional vendor specific
1358 * elements for (Re)Association Response frames in AP/P2P GO mode. The
1359 * format for these element(s) is a hexdump of the raw information
1360 * elements (id+len+payload for one or more elements).
1361 */
1362 struct wpabuf *ap_assocresp_elements;
1363
1364 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001365 * ignore_old_scan_res - Ignore scan results older than request
1366 *
1367 * The driver may have a cache of scan results that makes it return
1368 * information that is older than our scan trigger. This parameter can
1369 * be used to configure such old information to be ignored instead of
1370 * allowing it to update the internal BSS table.
1371 */
1372 int ignore_old_scan_res;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001373
1374 /**
1375 * sched_scan_interval - schedule scan interval
1376 */
1377 unsigned int sched_scan_interval;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001378
1379 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001380 * sched_scan_start_delay - Schedule scan start delay before first scan
1381 *
1382 * Delay (in seconds) before scheduling first scan plan cycle. The
1383 * driver may ignore this parameter and start immediately (or at any
1384 * other time), if this feature is not supported.
1385 */
1386 unsigned int sched_scan_start_delay;
1387
1388 /**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001389 * tdls_external_control - External control for TDLS setup requests
1390 *
1391 * Enable TDLS mode where external programs are given the control
1392 * to specify the TDLS link to get established to the driver. The
1393 * driver requests the TDLS setup to the supplicant only for the
1394 * specified TDLS peers.
1395 */
1396 int tdls_external_control;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001397
1398 u8 ip_addr_go[4];
1399 u8 ip_addr_mask[4];
1400 u8 ip_addr_start[4];
1401 u8 ip_addr_end[4];
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001402
1403 /**
1404 * osu_dir - OSU provider information directory
1405 *
1406 * If set, allow FETCH_OSU control interface command to be used to fetch
1407 * OSU provider information into all APs and store the results in this
1408 * directory.
1409 */
1410 char *osu_dir;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001411
1412 /**
1413 * wowlan_triggers - Wake-on-WLAN triggers
1414 *
1415 * If set, these wowlan triggers will be configured.
1416 */
1417 char *wowlan_triggers;
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -07001418
1419 /**
1420 * p2p_search_delay - Extra delay between concurrent search iterations
1421 *
1422 * Add extra delay (in milliseconds) between search iterations when
1423 * there is a concurrent operation to make p2p_find friendlier to
1424 * concurrent operations by avoiding it from taking 100% of radio
1425 * resources.
1426 */
1427 unsigned int p2p_search_delay;
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001428
1429 /**
1430 * mac_addr - MAC address policy default
1431 *
1432 * 0 = use permanent MAC address
1433 * 1 = use random MAC address for each ESS connection
1434 * 2 = like 1, but maintain OUI (with local admin bit set)
1435 *
1436 * By default, permanent MAC address is used unless policy is changed by
1437 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1438 * change this default behavior.
1439 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001440 enum wpas_mac_addr_style mac_addr;
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001441
1442 /**
1443 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1444 */
1445 unsigned int rand_addr_lifetime;
1446
1447 /**
1448 * preassoc_mac_addr - Pre-association MAC address policy
1449 *
1450 * 0 = use permanent MAC address
1451 * 1 = use random MAC address
1452 * 2 = like 1, but maintain OUI (with local admin bit set)
1453 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001454 enum wpas_mac_addr_style preassoc_mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001455
1456 /**
1457 * key_mgmt_offload - Use key management offload
1458 *
1459 * Key management offload should be used if the device supports it.
1460 * Key management offload is the capability of a device operating as
1461 * a station to do the exchange necessary to establish temporal keys
1462 * during initial RSN connection, after roaming, or during a PTK
1463 * rekeying operation.
1464 */
1465 int key_mgmt_offload;
1466
1467 /**
1468 * user_mpm - MPM residency
1469 *
1470 * 0: MPM lives in driver.
1471 * 1: wpa_supplicant handles peering and station allocation.
1472 *
1473 * If AMPE or SAE is enabled, the MPM is always in userspace.
1474 */
1475 int user_mpm;
1476
1477 /**
1478 * max_peer_links - Maximum number of peer links
1479 *
1480 * Maximum number of mesh peering currently maintained by the STA.
1481 */
1482 int max_peer_links;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001483
1484 /**
1485 * cert_in_cb - Whether to include a peer certificate dump in events
1486 *
1487 * This controls whether peer certificates for authentication server and
1488 * its certificate chain are included in EAP peer certificate events.
1489 */
1490 int cert_in_cb;
1491
1492 /**
1493 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1494 *
1495 * This timeout value is used in mesh STA to clean up inactive stations.
1496 * By default: 300 seconds.
1497 */
1498 int mesh_max_inactivity;
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001499
1500 /**
Hai Shaloma20dcd72022-02-04 13:43:00 -08001501 * mesh_fwding - Mesh network layer-2 forwarding (dot11MeshForwarding)
1502 *
1503 * This controls whether to enable layer-2 forwarding.
1504 * By default: 1: enabled
1505 */
1506 int mesh_fwding;
1507
1508 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001509 * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1510 *
1511 * This timeout value is used in mesh STA to retransmit
1512 * SAE Authentication frame.
1513 * By default: 1000 milliseconds.
1514 */
1515 int dot11RSNASAERetransPeriod;
1516
1517 /**
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001518 * passive_scan - Whether to force passive scan for network connection
1519 *
1520 * This parameter can be used to force only passive scanning to be used
1521 * for network connection cases. It should be noted that this will slow
1522 * down scan operations and reduce likelihood of finding the AP. In
1523 * addition, some use cases will override this due to functional
1524 * requirements, e.g., for finding an AP that uses hidden SSID
1525 * (scan_ssid=1) or P2P device discovery.
1526 */
1527 int passive_scan;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001528
1529 /**
1530 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1531 */
1532 int reassoc_same_bss_optim;
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -07001533
1534 /**
1535 * wps_priority - Priority for the networks added through WPS
1536 *
1537 * This priority value will be set to each network profile that is added
1538 * by executing the WPS protocol.
1539 */
1540 int wps_priority;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001541
1542 /**
1543 * fst_group_id - FST group ID
1544 */
1545 char *fst_group_id;
1546
1547 /**
1548 * fst_priority - priority of the interface within the FST group
1549 */
1550 int fst_priority;
1551
1552 /**
1553 * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1554 * interface.
1555 */
1556 int fst_llt;
1557
1558 /**
1559 * wpa_rsc_relaxation - RSC relaxation on GTK installation
1560 *
1561 * Values:
1562 * 0 - use the EAPOL-Key RSC value on GTK installation
1563 * 1 - use the null RSC if a bogus RSC value is detected in message 3
1564 * of 4-Way Handshake or message 1 of Group Key Handshake.
1565 */
1566 int wpa_rsc_relaxation;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001567
1568 /**
1569 * sched_scan_plans - Scan plans for scheduled scan
1570 *
1571 * Each scan plan specifies the interval between scans and the number of
1572 * iterations. The last scan plan only specifies the scan interval and
1573 * will be run infinitely.
1574 *
1575 * format: <interval:iterations> <interval2:iterations2> ... <interval>
1576 */
1577 char *sched_scan_plans;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001578
1579#ifdef CONFIG_MBO
1580 /**
1581 * non_pref_chan - Non-preferred channels list, separated by spaces.
1582 *
1583 * format: op_class:chan:preference:reason<:detail>
1584 * Detail is optional.
1585 */
1586 char *non_pref_chan;
1587
1588 /**
1589 * mbo_cell_capa - Cellular capabilities for MBO
1590 */
1591 enum mbo_cellular_capa mbo_cell_capa;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001592
1593 /**
1594 * disassoc_imminent_rssi_threshold - RSSI threshold of candidate AP
1595 * when disassociation imminent is set.
1596 */
1597 int disassoc_imminent_rssi_threshold;
1598
1599 /**
1600 * oce - Enable OCE in STA and/or STA-CFON mode
1601 * - Set BIT(0) to enable OCE in non-AP STA mode
1602 * - Set BIT(1) to enable OCE in STA-CFON mode
1603 */
1604 unsigned int oce;
Sunil Ravi84bb3e12021-06-10 09:52:05 -07001605#endif /* CONFIG_MBO */
Dennis Jeone2cb56b2020-10-23 21:23:01 +09001606 /**
1607 * btm_offload - Set where to perform roaming logic
1608 * - Set to 0 to handle fully roaming logic in supplicant
1609 * - Set to 1 to skip roaming logic in supplicant for firmware roaming
1610 * just parse BTM frame and notify framework
1611 */
Sunil Ravi84bb3e12021-06-10 09:52:05 -07001612 int btm_offload;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001613
1614 /**
1615 * gas_address3 - GAS Address3 field behavior
1616 *
1617 * Values:
1618 * 0 - P2P specification (Address3 = AP BSSID)
1619 * 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
1620 * sent to not-associated AP; if associated, AP BSSID)
1621 */
1622 int gas_address3;
Dmitry Shmidt7d175302016-09-06 13:11:34 -07001623
1624 /**
1625 * ftm_responder - Publish FTM (fine timing measurement)
1626 * responder functionality
1627 *
1628 * Values:
1629 * 0 - do not publish FTM responder functionality (Default)
1630 * 1 - publish FTM responder functionality in
1631 * bit 70 of Extended Capabilities element
1632 * Note, actual FTM responder operation is managed outside
1633 * wpa_supplicant.
1634 */
1635 int ftm_responder;
1636
1637 /**
1638 * ftm_initiator - Publish FTM (fine timing measurement)
1639 * initiator functionality
1640 *
1641 * Values:
1642 * 0 - do not publish FTM initiator functionality (Default)
1643 * 1 - publish FTM initiator functionality in
1644 * bit 71 of Extended Capabilities element
1645 * Note, actual FTM initiator operation is managed outside
1646 * wpa_supplicant.
1647 */
1648 int ftm_initiator;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001649
1650 /**
1651 * gas_rand_addr_lifetime - Lifetime of random MAC address for ANQP in
1652 * seconds
1653 */
1654 unsigned int gas_rand_addr_lifetime;
1655
1656 /**
1657 * gas_rand_mac_addr - GAS MAC address policy
1658 *
1659 * 0 = use permanent MAC address
1660 * 1 = use random MAC address
1661 * 2 = like 1, but maintain OUI (with local admin bit set)
1662 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001663 enum wpas_mac_addr_style gas_rand_mac_addr;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001664
1665 /**
1666 * dpp_config_processing - How to process DPP configuration
1667 *
1668 * 0 = report received configuration to an external program for
1669 * processing; do not generate any network profile internally
1670 * 1 = report received configuration to an external program and generate
1671 * a network profile internally, but do not automatically connect
1672 * to the created (disabled) profile; the network profile id is
1673 * reported to external programs
1674 * 2 = report received configuration to an external program, generate
1675 * a network profile internally, try to connect to the created
1676 * profile automatically
1677 */
1678 int dpp_config_processing;
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001679
1680 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001681 * dpp_name - Name for Enrollee's DPP Configuration Request
1682 */
1683 char *dpp_name;
1684
1685 /**
1686 * dpp_mud_url - MUD URL for Enrollee's DPP Configuration Request
1687 */
1688 char *dpp_mud_url;
1689
1690 /**
Sunil Ravi89eba102022-09-13 21:04:37 -07001691 * dpp_extra_conf_req_name - JSON node name of additional data for
1692 * Enrollee's DPP Configuration Request
1693 */
1694 char *dpp_extra_conf_req_name;
1695
1696 /**
1697 * dpp_extra_conf_req_value - JSON node data of additional data for
1698 * Enrollee's DPP Configuration Request
1699 */
1700 char *dpp_extra_conf_req_value;
1701
1702 /* dpp_connector_privacy_default - Default valur for Connector privacy
1703 *
1704 * This value is used as the default for the dpp_connector_privacy
1705 * network parameter for all new networks provisioned using DPP.
1706 */
1707 int dpp_connector_privacy_default;
1708
1709 /**
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001710 * coloc_intf_reporting - Colocated interference reporting
1711 *
1712 * dot11CoLocIntfReportingActivated
1713 * 0 = disabled (false)
1714 * 1 = enabled (true)
1715 */
1716 int coloc_intf_reporting;
1717
1718 /**
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001719 * p2p_device_random_mac_addr - P2P Device MAC address policy default
1720 *
Hai Shalom60840252021-02-19 19:02:11 -08001721 * 0 = use permanent MAC address (the one set by default by the device
1722 * driver). Notice that, if the device driver is configured to
1723 * always use random MAC addresses, this flag breaks reinvoking a
1724 * persistent group, so flags 1 or 2 should be used instead with
1725 * such drivers if persistent groups are used.
Hai Shalom74f70d42019-02-11 14:42:39 -08001726 * 1 = use random MAC address on creating the interface if there is no
Hai Shalom60840252021-02-19 19:02:11 -08001727 * persistent group. Besides, if a persistent group is created,
1728 * p2p_device_persistent_mac_addr is set to the MAC address of the
1729 * P2P Device interface, so that this address will be subsequently
1730 * used to change the MAC address of the P2P Device interface. With
1731 * no persistent group, the random MAC address is created by
1732 * wpa_supplicant, changing the one set by the device driver.
1733 * The device driver shall support SIOCGIFFLAGS/SIOCSIFFLAGS ioctl
1734 * interface control operations.
1735 * 2 = this flag should be used when the device driver uses random MAC
1736 * addresses by default when a P2P Device interface is created.
1737 * If p2p_device_persistent_mac_addr is set, use this MAC address
1738 * on creating the P2P Device interface. If not set, use the
1739 * default method adopted by the device driver (e.g., random MAC
1740 * address). Besides, if a persistent group is created,
1741 * p2p_device_persistent_mac_addr is set to the MAC address of the
1742 * P2P Device interface, so that this address will be subsequently
1743 * used in place of the default address set by the device driver.
1744 * (This option does not need support of SIOCGIFFLAGS/SIOCSIFFLAGS
1745 * ioctl interface control operations and uses NL80211_ATTR_MAC).
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001746 *
1747 * By default, permanent MAC address is used.
1748 */
1749 int p2p_device_random_mac_addr;
1750
1751 /**
1752 * p2p_device_persistent_mac_addr - Record last used MAC address
1753 *
Hai Shalom74f70d42019-02-11 14:42:39 -08001754 * If there are saved persistent groups, P2P cannot generate another
1755 * random MAC address, and need to restore to last used MAC address.
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001756 */
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001757 u8 p2p_device_persistent_mac_addr[ETH_ALEN];
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001758
Jimmy Chen36c21992018-11-29 16:46:43 +08001759 /**
1760 * p2p_interface_random_mac_addr - P2P Interface MAC address policy default
1761 *
1762 * 0 = use permanent MAC address
1763 * 1 = use random MAC address on creating the interface.
1764 *
1765 * By default, permanent MAC address is used.
1766 */
1767 int p2p_interface_random_mac_addr;
1768
xshud0ee72f2018-11-08 14:37:01 -08001769 /**
1770 * bss_no_flush_when_down - Whether to flush BSS entries when the interface is disabled
1771 *
1772 * 0 = Flush BSS entries when the interface becomes disabled (Default)
1773 * 1 = Do not flush BSS entries when the interface becomes disabled
1774 */
1775 int bss_no_flush_when_down;
Hai Shalom81f62d82019-07-22 12:10:00 -07001776
1777 /**
1778 * disable_btm - Disable BSS transition management in STA
1779 * - Set to 0 to enable BSS transition management
1780 * - Set to 1 to disable BSS transition management
1781 *
1782 * By default BSS transition management is enabled
1783 */
1784 int disable_btm;
Hai Shalomfdcde762020-04-02 11:19:20 -07001785
1786 /**
1787 * extended_key_id - Extended Key ID support
1788 *
1789 * IEEE Std 802.11-2016 optionally allows to use Key ID 0 and 1 for PTK
1790 * keys with Extended Key ID.
1791 *
1792 * 0 = don't use Extended Key ID
1793 * 1 = use Extended Key ID when possible
1794 */
1795 int extended_key_id;
Hai Shalom60840252021-02-19 19:02:11 -08001796
1797 /**
1798 * wowlan_disconnect_on_deinit - Trigger disconnect on wpa_supplicant
1799 * interface deinit even if the driver has enabled WoWLAN.
1800 *
1801 * 0 = Do not disconnect
1802 * 1 = Trigger disconnection
1803 */
1804 int wowlan_disconnect_on_deinit;
1805
Sunil Ravi7f769292024-07-23 22:21:32 +00001806 /**
1807 * rsn_overriding - RSN overriding
1808 *
1809 * 0 = Disabled
1810 * 1 = Enabled automatically if the driver indicates support
1811 * 2 = Forced to be enabled even without driver capability indication
1812 */
1813 enum rsn_overriding {
1814 RSN_OVERRIDING_DISABLED = 0,
1815 RSN_OVERRIDING_AUTO = 1,
1816 RSN_OVERRIDING_ENABLED = 2,
1817 } rsn_overriding;
1818
Hai Shalom60840252021-02-19 19:02:11 -08001819#ifdef CONFIG_PASN
1820#ifdef CONFIG_TESTING_OPTIONS
1821 /*
1822 * Normally, KDK should be derived if and only if both sides support
1823 * secure LTF. Allow forcing KDK derivation for testing purposes.
1824 */
1825 int force_kdk_derivation;
Hai Shaloma20dcd72022-02-04 13:43:00 -08001826
1827 /* If set, corrupt the MIC in the 3rd Authentication frame of PASN */
1828 int pasn_corrupt_mic;
1829
Hai Shalom60840252021-02-19 19:02:11 -08001830#endif /* CONFIG_TESTING_OPTIONS */
1831#endif /* CONFIG_PASN*/
Sunil Ravib0ac25f2024-07-12 01:42:03 +00001832
1833#ifdef CONFIG_TESTING_OPTIONS
1834 enum {
1835 MLD_CONNECT_BAND_PREF_AUTO = 0,
1836 MLD_CONNECT_BAND_PREF_2GHZ = 1,
1837 MLD_CONNECT_BAND_PREF_5GHZ = 2,
1838 MLD_CONNECT_BAND_PREF_6GHZ = 3,
1839 MLD_CONNECT_BAND_PREF_MAX = 4,
1840 } mld_connect_band_pref;
1841
1842 u8 mld_connect_bssid_pref[ETH_ALEN];
1843
1844 int mld_force_single_link;
1845#endif /* CONFIG_TESTING_OPTIONS */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001846};
1847
1848
1849/* Prototypes for common functions from config.c */
1850
1851void wpa_config_free(struct wpa_config *ssid);
1852void wpa_config_free_ssid(struct wpa_ssid *ssid);
1853void wpa_config_foreach_network(struct wpa_config *config,
1854 void (*func)(void *, struct wpa_ssid *),
1855 void *arg);
1856struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1857struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1858int wpa_config_remove_network(struct wpa_config *config, int id);
1859void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1860int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1861 int line);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001862int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1863 const char *value);
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001864int wpa_config_dump_values(struct wpa_config *config, char *buf,
1865 size_t buflen);
1866int wpa_config_get_value(const char *name, struct wpa_config *config,
1867 char *buf, size_t buflen);
1868
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001869char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1870char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1871char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1872void wpa_config_update_psk(struct wpa_ssid *ssid);
1873int wpa_config_add_prio_network(struct wpa_config *config,
1874 struct wpa_ssid *ssid);
1875int wpa_config_update_prio_list(struct wpa_config *config);
1876const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1877 const char *name);
1878void wpa_config_set_blob(struct wpa_config *config,
1879 struct wpa_config_blob *blob);
1880void wpa_config_free_blob(struct wpa_config_blob *blob);
1881int wpa_config_remove_blob(struct wpa_config *config, const char *name);
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001882void wpa_config_flush_blobs(struct wpa_config *config);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001883
Dmitry Shmidt04949592012-07-19 12:16:46 -07001884struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1885struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1886int wpa_config_remove_cred(struct wpa_config *config, int id);
1887void wpa_config_free_cred(struct wpa_cred *cred);
1888int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1889 const char *value, int line);
Dmitry Shmidt0cfd5f72014-04-04 14:48:05 -07001890char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
Dmitry Shmidt04949592012-07-19 12:16:46 -07001891
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001892struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1893 const char *driver_param);
1894#ifndef CONFIG_NO_STDOUT_DEBUG
1895void wpa_config_debug_dump_networks(struct wpa_config *config);
1896#else /* CONFIG_NO_STDOUT_DEBUG */
1897#define wpa_config_debug_dump_networks(c) do { } while (0)
1898#endif /* CONFIG_NO_STDOUT_DEBUG */
1899
1900
1901/* Prototypes for common functions from config.c */
1902int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1903
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001904int wpa_config_get_num_global_field_names(void);
1905
1906const char * wpa_config_get_global_field_name(unsigned int i, int *no_var);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001907
1908/* Prototypes for backend specific functions from the selected config_*.c */
1909
1910/**
1911 * wpa_config_read - Read and parse configuration database
1912 * @name: Name of the configuration (e.g., path and file name for the
1913 * configuration file)
Jouni Malinen5d1c8ad2013-04-23 12:34:56 -07001914 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
Sunil Ravi77d572f2023-01-17 23:58:31 +00001915 * @ro: Whether to mark networks from this configuration as read-only
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001916 * Returns: Pointer to allocated configuration data or %NULL on failure
1917 *
1918 * This function reads configuration data, parses its contents, and allocates
1919 * data structures needed for storing configuration information. The allocated
1920 * data can be freed with wpa_config_free().
1921 *
1922 * Each configuration backend needs to implement this function.
1923 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001924struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp,
1925 bool ro);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001926
1927/**
1928 * wpa_config_write - Write or update configuration data
1929 * @name: Name of the configuration (e.g., path and file name for the
1930 * configuration file)
1931 * @config: Configuration data from wpa_config_read()
1932 * Returns: 0 on success, -1 on failure
1933 *
1934 * This function write all configuration data into an external database (e.g.,
1935 * a text file) in a format that can be read with wpa_config_read(). This can
1936 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1937 * new network is added or a password is changed.
1938 *
1939 * Each configuration backend needs to implement this function.
1940 */
1941int wpa_config_write(const char *name, struct wpa_config *config);
1942
1943#endif /* CONFIG_H */