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