blob: dbb79dd0aa8a3705b57d4d96fe9e4449aeb55551 [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)
Dennis Jeone2cb56b2020-10-23 21:23:01 +0900454#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
632 /**
633 * opensc_engine_path - Path to the OpenSSL engine for opensc
634 *
635 * This is an OpenSSL specific configuration option for loading OpenSC
636 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
637 */
638 char *opensc_engine_path;
639
640 /**
641 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
642 *
643 * This is an OpenSSL specific configuration option for loading PKCS#11
644 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
645 */
646 char *pkcs11_engine_path;
647
648 /**
649 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
650 *
651 * This is an OpenSSL specific configuration option for configuring
652 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
653 * module is not loaded.
654 */
655 char *pkcs11_module_path;
656
657 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800658 * openssl_ciphers - OpenSSL cipher string
659 *
660 * This is an OpenSSL specific configuration option for configuring the
661 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
662 * default.
663 */
664 char *openssl_ciphers;
665
666 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700667 * pcsc_reader - PC/SC reader name prefix
668 *
669 * If not %NULL, PC/SC reader with a name that matches this prefix is
670 * initialized for SIM/USIM access. Empty string can be used to match
671 * the first available reader.
672 */
673 char *pcsc_reader;
674
675 /**
676 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
677 *
678 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
679 * EAP-AKA. If left out, this will be asked through control interface.
680 */
681 char *pcsc_pin;
682
683 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -0700684 * external_sim - Use external processing for SIM/USIM operations
685 */
686 int external_sim;
687
688 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700689 * driver_param - Driver interface parameters
690 *
691 * This text string is passed to the selected driver interface with the
692 * optional struct wpa_driver_ops::set_param() handler. This can be
693 * used to configure driver specific options without having to add new
694 * driver interface functionality.
695 */
696 char *driver_param;
697
698 /**
699 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
700 *
701 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
702 * cache (unit: seconds).
703 */
704 unsigned int dot11RSNAConfigPMKLifetime;
705
706 /**
707 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
708 *
709 * dot11 MIB variable for the percentage of the PMK lifetime
710 * that should expire before an IEEE 802.1X reauthentication occurs.
711 */
712 unsigned int dot11RSNAConfigPMKReauthThreshold;
713
714 /**
715 * dot11RSNAConfigSATimeout - Security association timeout
716 *
717 * dot11 MIB variable for the maximum time a security association
718 * shall take to set up (unit: seconds).
719 */
720 unsigned int dot11RSNAConfigSATimeout;
721
722 /**
723 * update_config - Is wpa_supplicant allowed to update configuration
724 *
725 * This variable control whether wpa_supplicant is allow to re-write
726 * its configuration with wpa_config_write(). If this is zero,
727 * configuration data is only changed in memory and the external data
Hai Shalom60840252021-02-19 19:02:11 -0800728 * is not overridden. If this is non-zero, wpa_supplicant will update
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700729 * the configuration data (e.g., a file) whenever configuration is
730 * changed. This update may replace the old configuration which can
731 * remove comments from it in case of a text file configuration.
732 */
733 int update_config;
734
735 /**
736 * blobs - Configuration blobs
737 */
738 struct wpa_config_blob *blobs;
739
740 /**
741 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
742 */
743 u8 uuid[16];
744
745 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700746 * auto_uuid - Automatic UUID behavior
747 * 0 = generate static value based on the local MAC address (default)
748 * 1 = generate a random UUID every time wpa_supplicant starts
749 */
750 int auto_uuid;
751
752 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700753 * device_name - Device Name (WPS)
754 * User-friendly description of device; up to 32 octets encoded in
755 * UTF-8
756 */
757 char *device_name;
758
759 /**
760 * manufacturer - Manufacturer (WPS)
761 * The manufacturer of the device (up to 64 ASCII characters)
762 */
763 char *manufacturer;
764
765 /**
766 * model_name - Model Name (WPS)
767 * Model of the device (up to 32 ASCII characters)
768 */
769 char *model_name;
770
771 /**
772 * model_number - Model Number (WPS)
773 * Additional device description (up to 32 ASCII characters)
774 */
775 char *model_number;
776
777 /**
778 * serial_number - Serial Number (WPS)
779 * Serial number of the device (up to 32 characters)
780 */
781 char *serial_number;
782
783 /**
784 * device_type - Primary Device Type (WPS)
785 */
786 u8 device_type[WPS_DEV_TYPE_LEN];
787
788 /**
789 * config_methods - Config Methods
790 *
791 * This is a space-separated list of supported WPS configuration
792 * methods. For example, "label virtual_display virtual_push_button
793 * keypad".
794 * Available methods: usba ethernet label display ext_nfc_token
795 * int_nfc_token nfc_interface push_button keypad
796 * virtual_display physical_display
797 * virtual_push_button physical_push_button.
798 */
799 char *config_methods;
800
801 /**
802 * os_version - OS Version (WPS)
803 * 4-octet operating system version number
804 */
805 u8 os_version[4];
806
807 /**
808 * country - Country code
809 *
810 * This is the ISO/IEC alpha2 country code for which we are operating
811 * in
812 */
813 char country[2];
814
815 /**
816 * wps_cred_processing - Credential processing
817 *
818 * 0 = process received credentials internally
819 * 1 = do not process received credentials; just pass them over
820 * ctrl_iface to external program(s)
821 * 2 = process received credentials internally and pass them over
822 * ctrl_iface to external program(s)
823 */
824 int wps_cred_processing;
825
Hai Shalom021b0b52019-04-10 11:17:58 -0700826 /**
827 * wps_cred_add_sae - Whether to enable SAE automatically for WPS
828 *
829 * 0 = only add the explicitly listed WPA2-PSK configuration
830 * 1 = add both the WPA2-PSK and SAE configuration and enable PMF so
831 * that the station gets configured in WPA3-Personal transition mode
832 * (supports both WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
833 */
834 int wps_cred_add_sae;
835
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700836#define MAX_SEC_DEVICE_TYPES 5
837 /**
838 * sec_device_types - Secondary Device Types (P2P)
839 */
840 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
841 int num_sec_device_types;
842
843 int p2p_listen_reg_class;
844 int p2p_listen_channel;
845 int p2p_oper_reg_class;
846 int p2p_oper_channel;
847 int p2p_go_intent;
848 char *p2p_ssid_postfix;
849 int persistent_reconnect;
850 int p2p_intra_bss;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700851 unsigned int num_p2p_pref_chan;
852 struct p2p_channel *p2p_pref_chan;
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700853 struct wpa_freq_range_list p2p_no_go_freq;
854 int p2p_add_cli_chan;
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700855 int p2p_ignore_shared_freq;
Dmitry Shmidt43cb5782014-06-16 16:23:22 -0700856 int p2p_optimize_listen_chan;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700857
Hai Shalom899fcc72020-10-19 14:38:18 -0700858 int p2p_6ghz_disable;
859
Dmitry Shmidt04949592012-07-19 12:16:46 -0700860 struct wpabuf *wps_vendor_ext_m1;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700861
862#define MAX_WPS_VENDOR_EXT 10
863 /**
864 * wps_vendor_ext - Vendor extension attributes in WPS
865 */
866 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
867
868 /**
869 * p2p_group_idle - Maximum idle time in seconds for P2P group
870 *
871 * This value controls how long a P2P group is maintained after there
872 * is no other members in the group. As a GO, this means no associated
873 * stations in the group. As a P2P client, this means no GO seen in
874 * scan results. The maximum idle time is specified in seconds with 0
875 * indicating no time limit, i.e., the P2P group remains in active
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800876 * state indefinitely until explicitly removed. As a P2P client, the
877 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
878 * this parameter is mainly meant for GO use and for P2P client, it can
Dmitry Shmidt04949592012-07-19 12:16:46 -0700879 * only be used to reduce the default timeout to smaller value. A
880 * special value -1 can be used to configure immediate removal of the
881 * group for P2P client role on any disconnection after the data
882 * connection has been established.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700883 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700884 int p2p_group_idle;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700885
886 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800887 * p2p_go_freq_change_policy - The GO frequency change policy
888 *
889 * This controls the behavior of the GO when there is a change in the
890 * map of the currently used frequencies in case more than one channel
891 * is supported.
892 *
893 * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
894 * possible. In case the GO is the only interface using its frequency
895 * and there are other station interfaces on other frequencies, the GO
896 * will migrate to one of these frequencies.
897 *
898 * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
899 * but a transition is possible only in case one of the other used
900 * frequencies is one of the frequencies in the intersection of the
901 * frequency list of the local device and the peer device.
902 *
903 * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
904 *
905 * @P2P_GO_FREQ_MOVE_SCM_ECSA: Same as
906 * P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS but a transition is possible only
907 * if all the group members advertise eCSA support.
908 */
909 enum {
910 P2P_GO_FREQ_MOVE_SCM = 0,
911 P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS = 1,
912 P2P_GO_FREQ_MOVE_STAY = 2,
913 P2P_GO_FREQ_MOVE_SCM_ECSA = 3,
914 P2P_GO_FREQ_MOVE_MAX = P2P_GO_FREQ_MOVE_SCM_ECSA,
915 } p2p_go_freq_change_policy;
916
917#define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
918
919 /**
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700920 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
921 *
922 * This parameter controls the length of the random passphrase that is
923 * generated at the GO.
924 */
925 unsigned int p2p_passphrase_len;
926
927 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700928 * bss_max_count - Maximum number of BSS entries to keep in memory
929 */
930 unsigned int bss_max_count;
931
932 /**
933 * bss_expiration_age - BSS entry age after which it can be expired
934 *
935 * This value controls the time in seconds after which a BSS entry
936 * gets removed if it has not been updated or is not in use.
937 */
938 unsigned int bss_expiration_age;
939
940 /**
941 * bss_expiration_scan_count - Expire BSS after number of scans
942 *
943 * If the BSS entry has not been seen in this many scans, it will be
944 * removed. A value of 1 means that entry is removed after the first
945 * scan in which the BSSID is not seen. Larger values can be used
946 * to avoid BSS entries disappearing if they are not visible in
947 * every scan (e.g., low signal quality or interference).
948 */
949 unsigned int bss_expiration_scan_count;
950
951 /**
952 * filter_ssids - SSID-based scan result filtering
953 *
954 * 0 = do not filter scan results
955 * 1 = only include configured SSIDs in scan results/BSS table
956 */
957 int filter_ssids;
958
959 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700960 * filter_rssi - RSSI-based scan result filtering
961 *
962 * 0 = do not filter scan results
963 * -n = filter scan results below -n dBm
964 */
965 int filter_rssi;
966
967 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700968 * max_num_sta - Maximum number of STAs in an AP/P2P GO
969 */
970 unsigned int max_num_sta;
971
972 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -0700973 * ap_isolate - Whether to use client isolation feature
974 *
975 * Client isolation can be used to prevent low-level bridging of
976 * frames between associated stations in the BSS. By default,
977 * this bridging is allowed (ap_isolate=0); except in P2P GO case,
978 * where p2p_intra_bss parameter is used to determine whether to allow
979 * intra-BSS forwarding (ap_isolate = !p2p_intra_bss).
980 *
981 * 0 = do not enable AP isolation
982 * 1 = enable AP isolation
983 */
984 int ap_isolate;
985
986 /**
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700987 * freq_list - Array of allowed scan frequencies or %NULL for all
988 *
989 * This is an optional zero-terminated array of frequencies in
990 * megahertz (MHz) to allow for narrowing scanning range.
991 */
992 int *freq_list;
993
994 /**
Hai Shalom60840252021-02-19 19:02:11 -0800995 * initial_freq_list - like freq_list but for initial scan
996 *
997 * This is an optional zero-terminated array of frequencies in
998 * megahertz (MHz) to allow for narrowing scanning range when
999 * the application is started.
1000 *
1001 * This can be used to speed up initial connection time if the
1002 * channel is known ahead of time, without limiting the scanned
1003 * frequencies during normal use.
1004 */
1005 int *initial_freq_list;
1006
1007 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001008 * scan_cur_freq - Whether to scan only the current channel
1009 *
1010 * If true, attempt to scan only the current channel if any other
1011 * VIFs on this radio are already associated on a particular channel.
1012 */
1013 int scan_cur_freq;
1014
1015 /**
Hai Shalom60840252021-02-19 19:02:11 -08001016 * scan_res_valid_for_connect - Seconds scans are valid for association
1017 *
1018 * This configures the number of seconds old scan results are considered
1019 * valid for association. When scan results are older than this value
1020 * a new scan is triggered prior to the association.
1021 */
1022 int scan_res_valid_for_connect;
1023
1024 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001025 * changed_parameters - Bitmap of changed parameters since last update
1026 */
1027 unsigned int changed_parameters;
1028
1029 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07001030 * disassoc_low_ack - Disassociate stations with massive packet loss
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001031 */
1032 int disassoc_low_ack;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001033
1034 /**
1035 * interworking - Whether Interworking (IEEE 802.11u) is enabled
1036 */
1037 int interworking;
1038
1039 /**
1040 * access_network_type - Access Network Type
1041 *
1042 * When Interworking is enabled, scans will be limited to APs that
1043 * advertise the specified Access Network Type (0..15; with 15
1044 * indicating wildcard match).
1045 */
1046 int access_network_type;
1047
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001048 /**
1049 * go_interworking - Whether Interworking for P2P GO is enabled
1050 */
1051 int go_interworking;
1052
1053 /**
1054 * go_access_network_type - P2P GO Access Network Type
1055 *
1056 * This indicates which access network type to advertise if Interworking
1057 * is enabled for P2P GO.
1058 */
1059 int go_access_network_type;
1060
1061 /**
1062 * go_internet - Interworking: Internet connectivity (0 or 1)
1063 */
1064 int go_internet;
1065
1066 /**
1067 * go_venue_group - Interworking: Venue group
1068 */
1069 int go_venue_group;
1070
1071 /**
1072 * go_venue_type: Interworking: Venue type
1073 */
1074 int go_venue_type;
1075
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001076 /**
Hai Shalom899fcc72020-10-19 14:38:18 -07001077 * hessid - Homogeneous ESS identifier
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001078 *
1079 * If this is set (any octet is non-zero), scans will be used to
1080 * request response only from BSSes belonging to the specified
1081 * Homogeneous ESS. This is used only if interworking is enabled.
1082 */
1083 u8 hessid[ETH_ALEN];
1084
1085 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001086 * hs20 - Hotspot 2.0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001087 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001088 int hs20;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001089
1090 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001091 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
1092 *
1093 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
1094 * by acting as a Registrar and using M1 from the AP. The config
1095 * methods attribute in that message is supposed to indicate only the
1096 * configuration method supported by the AP in Enrollee role, i.e., to
1097 * add an external Registrar. For that case, PBC shall not be used and
1098 * as such, the PushButton config method is removed from M1 by default.
1099 * If pbc_in_m1=1 is included in the configuration file, the PushButton
1100 * config method is left in M1 (if included in config_methods
1101 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
1102 * a label in the AP).
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001103 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001104 int pbc_in_m1;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001105
1106 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001107 * autoscan - Automatic scan parameters or %NULL if none
1108 *
1109 * This is an optional set of parameters for automatic scanning
1110 * within an interface in following format:
1111 * <autoscan module name>:<module parameters>
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001112 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001113 char *autoscan;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001114
1115 /**
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001116 * wps_nfc_pw_from_config - NFC Device Password was read from config
1117 *
1118 * This parameter can be determined whether the NFC Device Password was
1119 * included in the configuration (1) or generated dynamically (0). Only
1120 * the former case is re-written back to the configuration file.
1121 */
1122 int wps_nfc_pw_from_config;
1123
1124 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001125 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001126 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001127 int wps_nfc_dev_pw_id;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001128
1129 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001130 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001131 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001132 struct wpabuf *wps_nfc_dh_pubkey;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001133
1134 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001135 * wps_nfc_dh_privkey - NFC DH Private Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001136 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001137 struct wpabuf *wps_nfc_dh_privkey;
1138
1139 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001140 * wps_nfc_dev_pw - NFC Device Password for password token
Dmitry Shmidt04949592012-07-19 12:16:46 -07001141 */
1142 struct wpabuf *wps_nfc_dev_pw;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001143
1144 /**
1145 * ext_password_backend - External password backend or %NULL if none
1146 *
1147 * format: <backend name>[:<optional backend parameters>]
1148 */
1149 char *ext_password_backend;
1150
1151 /*
1152 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
1153 *
1154 * This timeout value is used in P2P GO mode to clean up
1155 * inactive stations.
1156 * By default: 300 seconds.
1157 */
1158 int p2p_go_max_inactivity;
1159
1160 struct hostapd_wmm_ac_params wmm_ac_params[4];
Hai Shalom899fcc72020-10-19 14:38:18 -07001161 struct hostapd_tx_queue_params tx_queue[4];
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001162
1163 /**
1164 * auto_interworking - Whether to use network selection automatically
1165 *
1166 * 0 = do not automatically go through Interworking network selection
1167 * (i.e., require explicit interworking_select command for this)
1168 * 1 = perform Interworking network selection if one or more
1169 * credentials have been configured and scan did not find a
1170 * matching network block
1171 */
1172 int auto_interworking;
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001173
1174 /**
1175 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
1176 *
1177 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1178 * Note that regulatory constraints and driver capabilities are
1179 * consulted anyway, so setting it to 1 can't do real harm.
1180 * By default: 0 (disabled)
1181 */
1182 int p2p_go_ht40;
1183
1184 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001185 * p2p_go_vht - Default mode for VHT enable when operating as GO
1186 *
1187 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1188 * Note that regulatory constraints and driver capabilities are
1189 * consulted anyway, so setting it to 1 can't do real harm.
1190 * By default: 0 (disabled)
1191 */
1192 int p2p_go_vht;
1193
1194 /**
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08001195 * p2p_go_edmg - Default mode for EDMG enable when operating as GO
1196 *
1197 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1198 * Note that regulatory constraints and driver capabilities are
1199 * consulted anyway, so setting it to 1 can't do real harm.
1200 * By default: 0 (disabled)
1201 */
1202 int p2p_go_edmg;
1203
1204 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08001205 * p2p_go_he - Default mode for 11ax HE enable when operating as GO
1206 *
1207 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1208 * Note that regulatory constraints and driver capabilities are
1209 * consulted anyway, so setting it to 1 can't do real harm.
1210 * By default: 0 (disabled)
1211 */
1212 int p2p_go_he;
1213
1214 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001215 * p2p_go_ctwindow - CTWindow to use when operating as GO
1216 *
1217 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
1218 * the length of the CTWindow in TUs.
1219 */
1220 int p2p_go_ctwindow;
1221
1222 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001223 * p2p_disabled - Whether P2P operations are disabled for this interface
1224 */
1225 int p2p_disabled;
1226
1227 /**
1228 * p2p_no_group_iface - Whether group interfaces can be used
1229 *
1230 * By default, wpa_supplicant will create a separate interface for P2P
1231 * group operations if the driver supports this. This functionality can
1232 * be disabled by setting this parameter to 1. In that case, the same
1233 * interface that was used for the P2P management operations is used
1234 * also for the group operation.
1235 */
1236 int p2p_no_group_iface;
1237
1238 /**
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07001239 * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1240 *
1241 * If this parameter is set to 1, a connected P2P Client will receive
1242 * and handle Probe Request frames. Setting this parameter to 0
1243 * disables this option. Default value: 0.
1244 *
1245 * Note: Setting this property at run time takes effect on the following
1246 * interface state transition to/from the WPA_COMPLETED state.
1247 */
1248 int p2p_cli_probe;
1249
1250 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001251 * okc - Whether to enable opportunistic key caching by default
1252 *
1253 * By default, OKC is disabled unless enabled by the per-network
1254 * proactive_key_caching=1 parameter. okc=1 can be used to change this
1255 * default behavior.
1256 */
1257 int okc;
1258
1259 /**
1260 * pmf - Whether to enable/require PMF by default
1261 *
1262 * By default, PMF is disabled unless enabled by the per-network
1263 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001264 * this default behavior for RSN network (this is not applicable for
1265 * non-RSN cases).
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001266 */
1267 enum mfp_options pmf;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001268
1269 /**
Sunil Ravi77d572f2023-01-17 23:58:31 +00001270 * sae_check_mfp - Whether to limit SAE based on PMF capabilities
1271 *
1272 * With this check SAE key_mgmt will not be selected if PMF is
1273 * not enabled.
1274 * Scenarios where enabling this check will limit SAE:
1275 * 1) ieee8011w=0 is set for the network.
1276 * 2) The AP does not have PMF enabled.
1277 * 3) ieee8011w for the network is the default(3), pmf=1 is enabled
1278 * globally and the device does not support the BIP cipher.
1279 *
1280 * Useful to allow the BIP cipher check that occurs for ieee80211w=3
1281 * and pmf=1 to also avoid using SAE key_mgmt.
1282 * Useful when hardware does not support BIP to still to allow
1283 * connecting to sae_require_mfp=1 WPA2+WPA3-Personal transition mode
1284 *access points by automatically selecting PSK instead of SAE.
1285 */
1286 int sae_check_mfp;
1287
1288 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001289 * sae_groups - Preference list of enabled groups for SAE
1290 *
1291 * By default (if this parameter is not set), the mandatory group 19
1292 * (ECC group defined over a 256-bit prime order field) is preferred,
1293 * but other groups are also enabled. If this parameter is set, the
1294 * groups will be tried in the indicated order.
1295 */
1296 int *sae_groups;
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001297
1298 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001299 * sae_pwe - SAE mechanism for PWE derivation
1300 * 0 = hunting-and-pecking loop only
1301 * 1 = hash-to-element only
1302 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1303 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001304 enum sae_pwe sae_pwe;
Hai Shalomc3565922019-10-28 11:58:20 -07001305
1306 /**
1307 * sae_pmkid_in_assoc - Whether to include PMKID in SAE Assoc Req
1308 */
1309 int sae_pmkid_in_assoc;
1310
1311 /**
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001312 * dtim_period - Default DTIM period in Beacon intervals
1313 *
1314 * This parameter can be used to set the default value for network
1315 * blocks that do not specify dtim_period.
1316 */
1317 int dtim_period;
1318
1319 /**
1320 * beacon_int - Default Beacon interval in TU
1321 *
1322 * This parameter can be used to set the default value for network
1323 * blocks that do not specify beacon_int.
1324 */
1325 int beacon_int;
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -07001326
1327 /**
1328 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1329 *
1330 * This parameter can be used to define additional vendor specific
1331 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1332 * format for these element(s) is a hexdump of the raw information
1333 * elements (id+len+payload for one or more elements).
1334 */
1335 struct wpabuf *ap_vendor_elements;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001336
1337 /**
Hai Shaloma20dcd72022-02-04 13:43:00 -08001338 * ap_assocresp_elements: Vendor specific elements for (Re)Association
1339 * Response frames
1340 *
1341 * This parameter can be used to define additional vendor specific
1342 * elements for (Re)Association Response frames in AP/P2P GO mode. The
1343 * format for these element(s) is a hexdump of the raw information
1344 * elements (id+len+payload for one or more elements).
1345 */
1346 struct wpabuf *ap_assocresp_elements;
1347
1348 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001349 * ignore_old_scan_res - Ignore scan results older than request
1350 *
1351 * The driver may have a cache of scan results that makes it return
1352 * information that is older than our scan trigger. This parameter can
1353 * be used to configure such old information to be ignored instead of
1354 * allowing it to update the internal BSS table.
1355 */
1356 int ignore_old_scan_res;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001357
1358 /**
1359 * sched_scan_interval - schedule scan interval
1360 */
1361 unsigned int sched_scan_interval;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001362
1363 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001364 * sched_scan_start_delay - Schedule scan start delay before first scan
1365 *
1366 * Delay (in seconds) before scheduling first scan plan cycle. The
1367 * driver may ignore this parameter and start immediately (or at any
1368 * other time), if this feature is not supported.
1369 */
1370 unsigned int sched_scan_start_delay;
1371
1372 /**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001373 * tdls_external_control - External control for TDLS setup requests
1374 *
1375 * Enable TDLS mode where external programs are given the control
1376 * to specify the TDLS link to get established to the driver. The
1377 * driver requests the TDLS setup to the supplicant only for the
1378 * specified TDLS peers.
1379 */
1380 int tdls_external_control;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001381
1382 u8 ip_addr_go[4];
1383 u8 ip_addr_mask[4];
1384 u8 ip_addr_start[4];
1385 u8 ip_addr_end[4];
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001386
1387 /**
1388 * osu_dir - OSU provider information directory
1389 *
1390 * If set, allow FETCH_OSU control interface command to be used to fetch
1391 * OSU provider information into all APs and store the results in this
1392 * directory.
1393 */
1394 char *osu_dir;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001395
1396 /**
1397 * wowlan_triggers - Wake-on-WLAN triggers
1398 *
1399 * If set, these wowlan triggers will be configured.
1400 */
1401 char *wowlan_triggers;
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -07001402
1403 /**
1404 * p2p_search_delay - Extra delay between concurrent search iterations
1405 *
1406 * Add extra delay (in milliseconds) between search iterations when
1407 * there is a concurrent operation to make p2p_find friendlier to
1408 * concurrent operations by avoiding it from taking 100% of radio
1409 * resources.
1410 */
1411 unsigned int p2p_search_delay;
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001412
1413 /**
1414 * mac_addr - MAC address policy default
1415 *
1416 * 0 = use permanent MAC address
1417 * 1 = use random MAC address for each ESS connection
1418 * 2 = like 1, but maintain OUI (with local admin bit set)
1419 *
1420 * By default, permanent MAC address is used unless policy is changed by
1421 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1422 * change this default behavior.
1423 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001424 enum wpas_mac_addr_style mac_addr;
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001425
1426 /**
1427 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1428 */
1429 unsigned int rand_addr_lifetime;
1430
1431 /**
1432 * preassoc_mac_addr - Pre-association MAC address policy
1433 *
1434 * 0 = use permanent MAC address
1435 * 1 = use random MAC address
1436 * 2 = like 1, but maintain OUI (with local admin bit set)
1437 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001438 enum wpas_mac_addr_style preassoc_mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001439
1440 /**
1441 * key_mgmt_offload - Use key management offload
1442 *
1443 * Key management offload should be used if the device supports it.
1444 * Key management offload is the capability of a device operating as
1445 * a station to do the exchange necessary to establish temporal keys
1446 * during initial RSN connection, after roaming, or during a PTK
1447 * rekeying operation.
1448 */
1449 int key_mgmt_offload;
1450
1451 /**
1452 * user_mpm - MPM residency
1453 *
1454 * 0: MPM lives in driver.
1455 * 1: wpa_supplicant handles peering and station allocation.
1456 *
1457 * If AMPE or SAE is enabled, the MPM is always in userspace.
1458 */
1459 int user_mpm;
1460
1461 /**
1462 * max_peer_links - Maximum number of peer links
1463 *
1464 * Maximum number of mesh peering currently maintained by the STA.
1465 */
1466 int max_peer_links;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001467
1468 /**
1469 * cert_in_cb - Whether to include a peer certificate dump in events
1470 *
1471 * This controls whether peer certificates for authentication server and
1472 * its certificate chain are included in EAP peer certificate events.
1473 */
1474 int cert_in_cb;
1475
1476 /**
1477 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1478 *
1479 * This timeout value is used in mesh STA to clean up inactive stations.
1480 * By default: 300 seconds.
1481 */
1482 int mesh_max_inactivity;
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001483
1484 /**
Hai Shaloma20dcd72022-02-04 13:43:00 -08001485 * mesh_fwding - Mesh network layer-2 forwarding (dot11MeshForwarding)
1486 *
1487 * This controls whether to enable layer-2 forwarding.
1488 * By default: 1: enabled
1489 */
1490 int mesh_fwding;
1491
1492 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001493 * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1494 *
1495 * This timeout value is used in mesh STA to retransmit
1496 * SAE Authentication frame.
1497 * By default: 1000 milliseconds.
1498 */
1499 int dot11RSNASAERetransPeriod;
1500
1501 /**
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001502 * passive_scan - Whether to force passive scan for network connection
1503 *
1504 * This parameter can be used to force only passive scanning to be used
1505 * for network connection cases. It should be noted that this will slow
1506 * down scan operations and reduce likelihood of finding the AP. In
1507 * addition, some use cases will override this due to functional
1508 * requirements, e.g., for finding an AP that uses hidden SSID
1509 * (scan_ssid=1) or P2P device discovery.
1510 */
1511 int passive_scan;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001512
1513 /**
1514 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1515 */
1516 int reassoc_same_bss_optim;
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -07001517
1518 /**
1519 * wps_priority - Priority for the networks added through WPS
1520 *
1521 * This priority value will be set to each network profile that is added
1522 * by executing the WPS protocol.
1523 */
1524 int wps_priority;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001525
1526 /**
1527 * fst_group_id - FST group ID
1528 */
1529 char *fst_group_id;
1530
1531 /**
1532 * fst_priority - priority of the interface within the FST group
1533 */
1534 int fst_priority;
1535
1536 /**
1537 * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1538 * interface.
1539 */
1540 int fst_llt;
1541
1542 /**
1543 * wpa_rsc_relaxation - RSC relaxation on GTK installation
1544 *
1545 * Values:
1546 * 0 - use the EAPOL-Key RSC value on GTK installation
1547 * 1 - use the null RSC if a bogus RSC value is detected in message 3
1548 * of 4-Way Handshake or message 1 of Group Key Handshake.
1549 */
1550 int wpa_rsc_relaxation;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001551
1552 /**
1553 * sched_scan_plans - Scan plans for scheduled scan
1554 *
1555 * Each scan plan specifies the interval between scans and the number of
1556 * iterations. The last scan plan only specifies the scan interval and
1557 * will be run infinitely.
1558 *
1559 * format: <interval:iterations> <interval2:iterations2> ... <interval>
1560 */
1561 char *sched_scan_plans;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001562
1563#ifdef CONFIG_MBO
1564 /**
1565 * non_pref_chan - Non-preferred channels list, separated by spaces.
1566 *
1567 * format: op_class:chan:preference:reason<:detail>
1568 * Detail is optional.
1569 */
1570 char *non_pref_chan;
1571
1572 /**
1573 * mbo_cell_capa - Cellular capabilities for MBO
1574 */
1575 enum mbo_cellular_capa mbo_cell_capa;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001576
1577 /**
1578 * disassoc_imminent_rssi_threshold - RSSI threshold of candidate AP
1579 * when disassociation imminent is set.
1580 */
1581 int disassoc_imminent_rssi_threshold;
1582
1583 /**
1584 * oce - Enable OCE in STA and/or STA-CFON mode
1585 * - Set BIT(0) to enable OCE in non-AP STA mode
1586 * - Set BIT(1) to enable OCE in STA-CFON mode
1587 */
1588 unsigned int oce;
Sunil Ravi84bb3e12021-06-10 09:52:05 -07001589#endif /* CONFIG_MBO */
Dennis Jeone2cb56b2020-10-23 21:23:01 +09001590 /**
1591 * btm_offload - Set where to perform roaming logic
1592 * - Set to 0 to handle fully roaming logic in supplicant
1593 * - Set to 1 to skip roaming logic in supplicant for firmware roaming
1594 * just parse BTM frame and notify framework
1595 */
Sunil Ravi84bb3e12021-06-10 09:52:05 -07001596 int btm_offload;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001597
1598 /**
1599 * gas_address3 - GAS Address3 field behavior
1600 *
1601 * Values:
1602 * 0 - P2P specification (Address3 = AP BSSID)
1603 * 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
1604 * sent to not-associated AP; if associated, AP BSSID)
1605 */
1606 int gas_address3;
Dmitry Shmidt7d175302016-09-06 13:11:34 -07001607
1608 /**
1609 * ftm_responder - Publish FTM (fine timing measurement)
1610 * responder functionality
1611 *
1612 * Values:
1613 * 0 - do not publish FTM responder functionality (Default)
1614 * 1 - publish FTM responder functionality in
1615 * bit 70 of Extended Capabilities element
1616 * Note, actual FTM responder operation is managed outside
1617 * wpa_supplicant.
1618 */
1619 int ftm_responder;
1620
1621 /**
1622 * ftm_initiator - Publish FTM (fine timing measurement)
1623 * initiator functionality
1624 *
1625 * Values:
1626 * 0 - do not publish FTM initiator functionality (Default)
1627 * 1 - publish FTM initiator functionality in
1628 * bit 71 of Extended Capabilities element
1629 * Note, actual FTM initiator operation is managed outside
1630 * wpa_supplicant.
1631 */
1632 int ftm_initiator;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001633
1634 /**
1635 * gas_rand_addr_lifetime - Lifetime of random MAC address for ANQP in
1636 * seconds
1637 */
1638 unsigned int gas_rand_addr_lifetime;
1639
1640 /**
1641 * gas_rand_mac_addr - GAS MAC address policy
1642 *
1643 * 0 = use permanent MAC address
1644 * 1 = use random MAC address
1645 * 2 = like 1, but maintain OUI (with local admin bit set)
1646 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001647 enum wpas_mac_addr_style gas_rand_mac_addr;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001648
1649 /**
1650 * dpp_config_processing - How to process DPP configuration
1651 *
1652 * 0 = report received configuration to an external program for
1653 * processing; do not generate any network profile internally
1654 * 1 = report received configuration to an external program and generate
1655 * a network profile internally, but do not automatically connect
1656 * to the created (disabled) profile; the network profile id is
1657 * reported to external programs
1658 * 2 = report received configuration to an external program, generate
1659 * a network profile internally, try to connect to the created
1660 * profile automatically
1661 */
1662 int dpp_config_processing;
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001663
1664 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001665 * dpp_name - Name for Enrollee's DPP Configuration Request
1666 */
1667 char *dpp_name;
1668
1669 /**
1670 * dpp_mud_url - MUD URL for Enrollee's DPP Configuration Request
1671 */
1672 char *dpp_mud_url;
1673
1674 /**
Sunil Ravi89eba102022-09-13 21:04:37 -07001675 * dpp_extra_conf_req_name - JSON node name of additional data for
1676 * Enrollee's DPP Configuration Request
1677 */
1678 char *dpp_extra_conf_req_name;
1679
1680 /**
1681 * dpp_extra_conf_req_value - JSON node data of additional data for
1682 * Enrollee's DPP Configuration Request
1683 */
1684 char *dpp_extra_conf_req_value;
1685
1686 /* dpp_connector_privacy_default - Default valur for Connector privacy
1687 *
1688 * This value is used as the default for the dpp_connector_privacy
1689 * network parameter for all new networks provisioned using DPP.
1690 */
1691 int dpp_connector_privacy_default;
1692
1693 /**
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001694 * coloc_intf_reporting - Colocated interference reporting
1695 *
1696 * dot11CoLocIntfReportingActivated
1697 * 0 = disabled (false)
1698 * 1 = enabled (true)
1699 */
1700 int coloc_intf_reporting;
1701
1702 /**
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001703 * p2p_device_random_mac_addr - P2P Device MAC address policy default
1704 *
Hai Shalom60840252021-02-19 19:02:11 -08001705 * 0 = use permanent MAC address (the one set by default by the device
1706 * driver). Notice that, if the device driver is configured to
1707 * always use random MAC addresses, this flag breaks reinvoking a
1708 * persistent group, so flags 1 or 2 should be used instead with
1709 * such drivers if persistent groups are used.
Hai Shalom74f70d42019-02-11 14:42:39 -08001710 * 1 = use random MAC address on creating the interface if there is no
Hai Shalom60840252021-02-19 19:02:11 -08001711 * persistent group. Besides, if a persistent group is created,
1712 * p2p_device_persistent_mac_addr is set to the MAC address of the
1713 * P2P Device interface, so that this address will be subsequently
1714 * used to change the MAC address of the P2P Device interface. With
1715 * no persistent group, the random MAC address is created by
1716 * wpa_supplicant, changing the one set by the device driver.
1717 * The device driver shall support SIOCGIFFLAGS/SIOCSIFFLAGS ioctl
1718 * interface control operations.
1719 * 2 = this flag should be used when the device driver uses random MAC
1720 * addresses by default when a P2P Device interface is created.
1721 * If p2p_device_persistent_mac_addr is set, use this MAC address
1722 * on creating the P2P Device interface. If not set, use the
1723 * default method adopted by the device driver (e.g., random MAC
1724 * address). Besides, if a persistent group is created,
1725 * p2p_device_persistent_mac_addr is set to the MAC address of the
1726 * P2P Device interface, so that this address will be subsequently
1727 * used in place of the default address set by the device driver.
1728 * (This option does not need support of SIOCGIFFLAGS/SIOCSIFFLAGS
1729 * ioctl interface control operations and uses NL80211_ATTR_MAC).
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001730 *
1731 * By default, permanent MAC address is used.
1732 */
1733 int p2p_device_random_mac_addr;
1734
1735 /**
1736 * p2p_device_persistent_mac_addr - Record last used MAC address
1737 *
Hai Shalom74f70d42019-02-11 14:42:39 -08001738 * If there are saved persistent groups, P2P cannot generate another
1739 * random MAC address, and need to restore to last used MAC address.
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001740 */
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001741 u8 p2p_device_persistent_mac_addr[ETH_ALEN];
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001742
Jimmy Chen36c21992018-11-29 16:46:43 +08001743 /**
1744 * p2p_interface_random_mac_addr - P2P Interface MAC address policy default
1745 *
1746 * 0 = use permanent MAC address
1747 * 1 = use random MAC address on creating the interface.
1748 *
1749 * By default, permanent MAC address is used.
1750 */
1751 int p2p_interface_random_mac_addr;
1752
xshud0ee72f2018-11-08 14:37:01 -08001753 /**
1754 * bss_no_flush_when_down - Whether to flush BSS entries when the interface is disabled
1755 *
1756 * 0 = Flush BSS entries when the interface becomes disabled (Default)
1757 * 1 = Do not flush BSS entries when the interface becomes disabled
1758 */
1759 int bss_no_flush_when_down;
Hai Shalom81f62d82019-07-22 12:10:00 -07001760
1761 /**
1762 * disable_btm - Disable BSS transition management in STA
1763 * - Set to 0 to enable BSS transition management
1764 * - Set to 1 to disable BSS transition management
1765 *
1766 * By default BSS transition management is enabled
1767 */
1768 int disable_btm;
Hai Shalomfdcde762020-04-02 11:19:20 -07001769
1770 /**
1771 * extended_key_id - Extended Key ID support
1772 *
1773 * IEEE Std 802.11-2016 optionally allows to use Key ID 0 and 1 for PTK
1774 * keys with Extended Key ID.
1775 *
1776 * 0 = don't use Extended Key ID
1777 * 1 = use Extended Key ID when possible
1778 */
1779 int extended_key_id;
Hai Shalom60840252021-02-19 19:02:11 -08001780
1781 /**
1782 * wowlan_disconnect_on_deinit - Trigger disconnect on wpa_supplicant
1783 * interface deinit even if the driver has enabled WoWLAN.
1784 *
1785 * 0 = Do not disconnect
1786 * 1 = Trigger disconnection
1787 */
1788 int wowlan_disconnect_on_deinit;
1789
1790#ifdef CONFIG_PASN
1791#ifdef CONFIG_TESTING_OPTIONS
1792 /*
1793 * Normally, KDK should be derived if and only if both sides support
1794 * secure LTF. Allow forcing KDK derivation for testing purposes.
1795 */
1796 int force_kdk_derivation;
Hai Shaloma20dcd72022-02-04 13:43:00 -08001797
1798 /* If set, corrupt the MIC in the 3rd Authentication frame of PASN */
1799 int pasn_corrupt_mic;
1800
Hai Shalom60840252021-02-19 19:02:11 -08001801#endif /* CONFIG_TESTING_OPTIONS */
1802#endif /* CONFIG_PASN*/
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001803};
1804
1805
1806/* Prototypes for common functions from config.c */
1807
1808void wpa_config_free(struct wpa_config *ssid);
1809void wpa_config_free_ssid(struct wpa_ssid *ssid);
1810void wpa_config_foreach_network(struct wpa_config *config,
1811 void (*func)(void *, struct wpa_ssid *),
1812 void *arg);
1813struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1814struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1815int wpa_config_remove_network(struct wpa_config *config, int id);
1816void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1817int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1818 int line);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001819int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1820 const char *value);
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001821int wpa_config_dump_values(struct wpa_config *config, char *buf,
1822 size_t buflen);
1823int wpa_config_get_value(const char *name, struct wpa_config *config,
1824 char *buf, size_t buflen);
1825
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001826char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1827char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1828char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1829void wpa_config_update_psk(struct wpa_ssid *ssid);
1830int wpa_config_add_prio_network(struct wpa_config *config,
1831 struct wpa_ssid *ssid);
1832int wpa_config_update_prio_list(struct wpa_config *config);
1833const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1834 const char *name);
1835void wpa_config_set_blob(struct wpa_config *config,
1836 struct wpa_config_blob *blob);
1837void wpa_config_free_blob(struct wpa_config_blob *blob);
1838int wpa_config_remove_blob(struct wpa_config *config, const char *name);
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001839void wpa_config_flush_blobs(struct wpa_config *config);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001840
Dmitry Shmidt04949592012-07-19 12:16:46 -07001841struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1842struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1843int wpa_config_remove_cred(struct wpa_config *config, int id);
1844void wpa_config_free_cred(struct wpa_cred *cred);
1845int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1846 const char *value, int line);
Dmitry Shmidt0cfd5f72014-04-04 14:48:05 -07001847char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
Dmitry Shmidt04949592012-07-19 12:16:46 -07001848
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001849struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1850 const char *driver_param);
1851#ifndef CONFIG_NO_STDOUT_DEBUG
1852void wpa_config_debug_dump_networks(struct wpa_config *config);
1853#else /* CONFIG_NO_STDOUT_DEBUG */
1854#define wpa_config_debug_dump_networks(c) do { } while (0)
1855#endif /* CONFIG_NO_STDOUT_DEBUG */
1856
1857
1858/* Prototypes for common functions from config.c */
1859int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1860
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001861int wpa_config_get_num_global_field_names(void);
1862
1863const char * wpa_config_get_global_field_name(unsigned int i, int *no_var);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001864
1865/* Prototypes for backend specific functions from the selected config_*.c */
1866
1867/**
1868 * wpa_config_read - Read and parse configuration database
1869 * @name: Name of the configuration (e.g., path and file name for the
1870 * configuration file)
Jouni Malinen5d1c8ad2013-04-23 12:34:56 -07001871 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
Sunil Ravi77d572f2023-01-17 23:58:31 +00001872 * @ro: Whether to mark networks from this configuration as read-only
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001873 * Returns: Pointer to allocated configuration data or %NULL on failure
1874 *
1875 * This function reads configuration data, parses its contents, and allocates
1876 * data structures needed for storing configuration information. The allocated
1877 * data can be freed with wpa_config_free().
1878 *
1879 * Each configuration backend needs to implement this function.
1880 */
Sunil Ravi77d572f2023-01-17 23:58:31 +00001881struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp,
1882 bool ro);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001883
1884/**
1885 * wpa_config_write - Write or update configuration data
1886 * @name: Name of the configuration (e.g., path and file name for the
1887 * configuration file)
1888 * @config: Configuration data from wpa_config_read()
1889 * Returns: 0 on success, -1 on failure
1890 *
1891 * This function write all configuration data into an external database (e.g.,
1892 * a text file) in a format that can be read with wpa_config_read(). This can
1893 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1894 * new network is added or a password is changed.
1895 *
1896 * Each configuration backend needs to implement this function.
1897 */
1898int wpa_config_write(const char *name, struct wpa_config *config);
1899
1900#endif /* CONFIG_H */