blob: 0316e9b0be2d6fa783393452fd715e3e01c72562 [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 /**
275 * roaming_consortium - Roaming Consortium OI
276 *
277 * If roaming_consortium_len is non-zero, this field contains the
278 * Roaming Consortium OI that can be used to determine which access
279 * points support authentication with this credential. This is an
280 * alternative to the use of the realm parameter. When using Roaming
281 * Consortium to match the network, the EAP parameters need to be
282 * pre-configured with the credential since the NAI Realm information
283 * may not be available or fetched.
284 */
285 u8 roaming_consortium[15];
286
287 /**
288 * roaming_consortium_len - Length of roaming_consortium
289 */
290 size_t roaming_consortium_len;
291
Roshan Pius3a1667e2018-07-03 15:17:14 -0700292 /**
293 * required_roaming_consortium - Required Roaming Consortium OI
294 *
295 * If required_roaming_consortium_len is non-zero, this field contains
296 * the Roaming Consortium OI that is required to be advertised by the AP
297 * for the credential to be considered matching.
298 */
Dmitry Shmidt051af732013-10-22 13:52:46 -0700299 u8 required_roaming_consortium[15];
Roshan Pius3a1667e2018-07-03 15:17:14 -0700300
301 /**
302 * required_roaming_consortium_len - Length of required_roaming_consortium
303 */
Dmitry Shmidt051af732013-10-22 13:52:46 -0700304 size_t required_roaming_consortium_len;
305
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700306 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -0700307 * roaming_consortiums - Roaming Consortium OI(s) memberships
308 *
309 * This field contains one or more OIs identifying the roaming
310 * consortiums of which the provider is a member. The list is sorted
311 * from the most preferred one to the least preferred one. A match
312 * between the Roaming Consortium OIs advertised by an AP and the OIs
313 * in this list indicates that successful authentication is possible.
314 * (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
315 */
316 u8 roaming_consortiums[MAX_ROAMING_CONS][MAX_ROAMING_CONS_OI_LEN];
317
318 /**
319 * roaming_consortiums_len - Length on roaming_consortiums[i]
320 */
321 size_t roaming_consortiums_len[MAX_ROAMING_CONS];
322
323 /**
324 * num_roaming_consortiums - Number of entries in roaming_consortiums
325 */
326 unsigned int num_roaming_consortiums;
327
328 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700329 * eap_method - EAP method to use
330 *
331 * Pre-configured EAP method to use with this credential or %NULL to
332 * indicate no EAP method is selected, i.e., the method will be
333 * selected automatically based on ANQP information.
334 */
335 struct eap_method_type *eap_method;
336
337 /**
338 * phase1 - Phase 1 (outer authentication) parameters
339 *
340 * Pre-configured EAP parameters or %NULL.
341 */
342 char *phase1;
343
344 /**
345 * phase2 - Phase 2 (inner authentication) parameters
346 *
347 * Pre-configured EAP parameters or %NULL.
348 */
349 char *phase2;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800350
351 struct excluded_ssid {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700352 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800353 size_t ssid_len;
354 } *excluded_ssid;
355 size_t num_excluded_ssid;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800356
357 struct roaming_partner {
358 char fqdn[128];
359 int exact_match;
360 u8 priority;
361 char country[3];
362 } *roaming_partner;
363 size_t num_roaming_partner;
364
365 int update_identifier;
366
367 /**
368 * provisioning_sp - FQDN of the SP that provisioned the credential
369 */
370 char *provisioning_sp;
371
372 /**
373 * sp_priority - Credential priority within a provisioning SP
374 *
375 * This is the priority of the credential among all credentials
376 * provisionined by the same SP (i.e., for entries that have identical
377 * provisioning_sp value). The range of this priority is 0-255 with 0
378 * being the highest and 255 the lower priority.
379 */
380 int sp_priority;
381
382 unsigned int min_dl_bandwidth_home;
383 unsigned int min_ul_bandwidth_home;
384 unsigned int min_dl_bandwidth_roaming;
385 unsigned int min_ul_bandwidth_roaming;
386
387 /**
388 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
389 * This value is used as the maximum channel utilization for network
390 * selection purposes for home networks. If the AP does not advertise
391 * BSS Load or if the limit would prevent any connection, this
392 * constraint will be ignored.
393 */
394 unsigned int max_bss_load;
395
Hai Shalomfdcde762020-04-02 11:19:20 -0700396 size_t num_req_conn_capab;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800397 u8 *req_conn_capab_proto;
398 int **req_conn_capab_port;
399
400 /**
401 * ocsp - Whether to use/require OCSP to check server certificate
402 *
403 * 0 = do not use OCSP stapling (TLS certificate status extension)
404 * 1 = try to use OCSP stapling, but not require response
405 * 2 = require valid OCSP stapling response
406 */
407 int ocsp;
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700408
409 /**
410 * sim_num - User selected SIM identifier
411 *
412 * This variable is used for identifying which SIM is used if the system
413 * has more than one.
414 */
415 int sim_num;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700416};
417
418
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700419#define CFG_CHANGED_DEVICE_NAME BIT(0)
420#define CFG_CHANGED_CONFIG_METHODS BIT(1)
421#define CFG_CHANGED_DEVICE_TYPE BIT(2)
422#define CFG_CHANGED_OS_VERSION BIT(3)
423#define CFG_CHANGED_UUID BIT(4)
424#define CFG_CHANGED_COUNTRY BIT(5)
425#define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
426#define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
427#define CFG_CHANGED_WPS_STRING BIT(8)
428#define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
429#define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
Jouni Malinen75ecf522011-06-27 15:19:46 -0700430#define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
431#define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700432#define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700433#define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800434#define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700435#define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800436#define CFG_CHANGED_SCHED_SCAN_PLANS BIT(17)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700437#define CFG_CHANGED_WOWLAN_TRIGGERS BIT(18)
Hai Shalom81f62d82019-07-22 12:10:00 -0700438#define CFG_CHANGED_DISABLE_BTM BIT(19)
Hai Shalom899fcc72020-10-19 14:38:18 -0700439#define CFG_CHANGED_BGSCAN BIT(20)
Dennis Jeone2cb56b2020-10-23 21:23:01 +0900440#define CFG_CHANGED_DISABLE_BTM_NOTIFY BIT(21)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700441
442/**
443 * struct wpa_config - wpa_supplicant configuration data
444 *
445 * This data structure is presents the per-interface (radio) configuration
446 * data. In many cases, there is only one struct wpa_config instance, but if
447 * more than one network interface is being controlled, one instance is used
448 * for each.
449 */
450struct wpa_config {
451 /**
452 * ssid - Head of the global network list
453 *
454 * This is the head for the list of all the configured networks.
455 */
456 struct wpa_ssid *ssid;
457
458 /**
459 * pssid - Per-priority network lists (in priority order)
460 */
461 struct wpa_ssid **pssid;
462
463 /**
464 * num_prio - Number of different priorities used in the pssid lists
465 *
466 * This indicates how many per-priority network lists are included in
467 * pssid.
468 */
Hai Shalomfdcde762020-04-02 11:19:20 -0700469 size_t num_prio;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700470
471 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700472 * cred - Head of the credential list
473 *
474 * This is the head for the list of all the configured credentials.
475 */
476 struct wpa_cred *cred;
477
478 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700479 * eapol_version - IEEE 802.1X/EAPOL version number
480 *
481 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
482 * defines EAPOL version 2. However, there are many APs that do not
483 * handle the new version number correctly (they seem to drop the
484 * frames completely). In order to make wpa_supplicant interoperate
485 * with these APs, the version number is set to 1 by default. This
486 * configuration value can be used to set it to the new version (2).
487 */
488 int eapol_version;
489
490 /**
491 * ap_scan - AP scanning/selection
492 *
493 * By default, wpa_supplicant requests driver to perform AP
494 * scanning and then uses the scan results to select a
495 * suitable AP. Another alternative is to allow the driver to
496 * take care of AP scanning and selection and use
497 * wpa_supplicant just to process EAPOL frames based on IEEE
498 * 802.11 association information from the driver.
499 *
500 * 1: wpa_supplicant initiates scanning and AP selection (default).
501 *
502 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
503 * association parameters (e.g., WPA IE generation); this mode can
504 * also be used with non-WPA drivers when using IEEE 802.1X mode;
505 * do not try to associate with APs (i.e., external program needs
506 * to control association). This mode must also be used when using
507 * wired Ethernet drivers.
508 *
509 * 2: like 0, but associate with APs using security policy and SSID
510 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
511 * drivers to enable operation with hidden SSIDs and optimized roaming;
512 * in this mode, the network blocks in the configuration are tried
513 * one by one until the driver reports successful association; each
514 * network block should have explicit security policy (i.e., only one
515 * option in the lists) for key_mgmt, pairwise, group, proto variables.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800516 *
517 * Note: ap_scan=2 should not be used with the nl80211 driver interface
518 * (the current Linux interface). ap_scan=1 is optimized work working
519 * with nl80211. For finding networks using hidden SSID, scan_ssid=1 in
520 * the network block can be used with nl80211.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700521 */
522 int ap_scan;
523
524 /**
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800525 * bgscan - Background scan and roaming parameters or %NULL if none
526 *
527 * This is an optional set of parameters for background scanning and
528 * roaming within a network (ESS). For more detailed information see
529 * ssid block documentation.
530 *
531 * The variable defines default bgscan behavior for all BSS station
532 * networks except for those which have their own bgscan configuration.
533 */
534 char *bgscan;
535
536 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700537 * disable_scan_offload - Disable automatic offloading of scan requests
538 *
539 * By default, %wpa_supplicant tries to offload scanning if the driver
540 * indicates support for this (sched_scan). This configuration
541 * parameter can be used to disable this offloading mechanism.
542 */
543 int disable_scan_offload;
544
545 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700546 * ctrl_interface - Parameters for the control interface
547 *
548 * If this is specified, %wpa_supplicant will open a control interface
549 * that is available for external programs to manage %wpa_supplicant.
550 * The meaning of this string depends on which control interface
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800551 * mechanism is used. For all cases, the existence of this parameter
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700552 * in configuration is used to determine whether the control interface
553 * is enabled.
554 *
555 * For UNIX domain sockets (default on Linux and BSD): This is a
556 * directory that will be created for UNIX domain sockets for listening
557 * to requests from external programs (CLI/GUI, etc.) for status
558 * information and configuration. The socket file will be named based
559 * on the interface name, so multiple %wpa_supplicant processes can be
560 * run at the same time if more than one interface is used.
561 * /var/run/wpa_supplicant is the recommended directory for sockets and
562 * by default, wpa_cli will use it when trying to connect with
563 * %wpa_supplicant.
564 *
565 * Access control for the control interface can be configured
566 * by setting the directory to allow only members of a group
567 * to use sockets. This way, it is possible to run
568 * %wpa_supplicant as root (since it needs to change network
569 * configuration and open raw sockets) and still allow GUI/CLI
570 * components to be run as non-root users. However, since the
571 * control interface can be used to change the network
572 * configuration, this access needs to be protected in many
573 * cases. By default, %wpa_supplicant is configured to use gid
574 * 0 (root). If you want to allow non-root users to use the
575 * control interface, add a new group and change this value to
576 * match with that group. Add users that should have control
577 * interface access to this group.
578 *
579 * When configuring both the directory and group, use following format:
580 * DIR=/var/run/wpa_supplicant GROUP=wheel
581 * DIR=/var/run/wpa_supplicant GROUP=0
582 * (group can be either group name or gid)
583 *
584 * For UDP connections (default on Windows): The value will be ignored.
585 * This variable is just used to select that the control interface is
586 * to be created. The value can be set to, e.g., udp
587 * (ctrl_interface=udp).
588 *
589 * For Windows Named Pipe: This value can be used to set the security
590 * descriptor for controlling access to the control interface. Security
591 * descriptor can be set using Security Descriptor String Format (see
592 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
593 * The descriptor string needs to be prefixed with SDDL=. For example,
594 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
595 * all connections).
596 */
597 char *ctrl_interface;
598
599 /**
600 * ctrl_interface_group - Control interface group (DEPRECATED)
601 *
602 * This variable is only used for backwards compatibility. Group for
603 * UNIX domain sockets should now be specified using GROUP=group in
604 * ctrl_interface variable.
605 */
606 char *ctrl_interface_group;
607
608 /**
609 * fast_reauth - EAP fast re-authentication (session resumption)
610 *
611 * By default, fast re-authentication is enabled for all EAP methods
612 * that support it. This variable can be used to disable fast
613 * re-authentication (by setting fast_reauth=0). Normally, there is no
614 * need to disable fast re-authentication.
615 */
616 int fast_reauth;
617
618 /**
619 * opensc_engine_path - Path to the OpenSSL engine for opensc
620 *
621 * This is an OpenSSL specific configuration option for loading OpenSC
622 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
623 */
624 char *opensc_engine_path;
625
626 /**
627 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
628 *
629 * This is an OpenSSL specific configuration option for loading PKCS#11
630 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
631 */
632 char *pkcs11_engine_path;
633
634 /**
635 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
636 *
637 * This is an OpenSSL specific configuration option for configuring
638 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
639 * module is not loaded.
640 */
641 char *pkcs11_module_path;
642
643 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800644 * openssl_ciphers - OpenSSL cipher string
645 *
646 * This is an OpenSSL specific configuration option for configuring the
647 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
648 * default.
649 */
650 char *openssl_ciphers;
651
652 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700653 * pcsc_reader - PC/SC reader name prefix
654 *
655 * If not %NULL, PC/SC reader with a name that matches this prefix is
656 * initialized for SIM/USIM access. Empty string can be used to match
657 * the first available reader.
658 */
659 char *pcsc_reader;
660
661 /**
662 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
663 *
664 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
665 * EAP-AKA. If left out, this will be asked through control interface.
666 */
667 char *pcsc_pin;
668
669 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -0700670 * external_sim - Use external processing for SIM/USIM operations
671 */
672 int external_sim;
673
674 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700675 * driver_param - Driver interface parameters
676 *
677 * This text string is passed to the selected driver interface with the
678 * optional struct wpa_driver_ops::set_param() handler. This can be
679 * used to configure driver specific options without having to add new
680 * driver interface functionality.
681 */
682 char *driver_param;
683
684 /**
685 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
686 *
687 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
688 * cache (unit: seconds).
689 */
690 unsigned int dot11RSNAConfigPMKLifetime;
691
692 /**
693 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
694 *
695 * dot11 MIB variable for the percentage of the PMK lifetime
696 * that should expire before an IEEE 802.1X reauthentication occurs.
697 */
698 unsigned int dot11RSNAConfigPMKReauthThreshold;
699
700 /**
701 * dot11RSNAConfigSATimeout - Security association timeout
702 *
703 * dot11 MIB variable for the maximum time a security association
704 * shall take to set up (unit: seconds).
705 */
706 unsigned int dot11RSNAConfigSATimeout;
707
708 /**
709 * update_config - Is wpa_supplicant allowed to update configuration
710 *
711 * This variable control whether wpa_supplicant is allow to re-write
712 * its configuration with wpa_config_write(). If this is zero,
713 * configuration data is only changed in memory and the external data
Hai Shalom60840252021-02-19 19:02:11 -0800714 * is not overridden. If this is non-zero, wpa_supplicant will update
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700715 * the configuration data (e.g., a file) whenever configuration is
716 * changed. This update may replace the old configuration which can
717 * remove comments from it in case of a text file configuration.
718 */
719 int update_config;
720
721 /**
722 * blobs - Configuration blobs
723 */
724 struct wpa_config_blob *blobs;
725
726 /**
727 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
728 */
729 u8 uuid[16];
730
731 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700732 * auto_uuid - Automatic UUID behavior
733 * 0 = generate static value based on the local MAC address (default)
734 * 1 = generate a random UUID every time wpa_supplicant starts
735 */
736 int auto_uuid;
737
738 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700739 * device_name - Device Name (WPS)
740 * User-friendly description of device; up to 32 octets encoded in
741 * UTF-8
742 */
743 char *device_name;
744
745 /**
746 * manufacturer - Manufacturer (WPS)
747 * The manufacturer of the device (up to 64 ASCII characters)
748 */
749 char *manufacturer;
750
751 /**
752 * model_name - Model Name (WPS)
753 * Model of the device (up to 32 ASCII characters)
754 */
755 char *model_name;
756
757 /**
758 * model_number - Model Number (WPS)
759 * Additional device description (up to 32 ASCII characters)
760 */
761 char *model_number;
762
763 /**
764 * serial_number - Serial Number (WPS)
765 * Serial number of the device (up to 32 characters)
766 */
767 char *serial_number;
768
769 /**
770 * device_type - Primary Device Type (WPS)
771 */
772 u8 device_type[WPS_DEV_TYPE_LEN];
773
774 /**
775 * config_methods - Config Methods
776 *
777 * This is a space-separated list of supported WPS configuration
778 * methods. For example, "label virtual_display virtual_push_button
779 * keypad".
780 * Available methods: usba ethernet label display ext_nfc_token
781 * int_nfc_token nfc_interface push_button keypad
782 * virtual_display physical_display
783 * virtual_push_button physical_push_button.
784 */
785 char *config_methods;
786
787 /**
788 * os_version - OS Version (WPS)
789 * 4-octet operating system version number
790 */
791 u8 os_version[4];
792
793 /**
794 * country - Country code
795 *
796 * This is the ISO/IEC alpha2 country code for which we are operating
797 * in
798 */
799 char country[2];
800
801 /**
802 * wps_cred_processing - Credential processing
803 *
804 * 0 = process received credentials internally
805 * 1 = do not process received credentials; just pass them over
806 * ctrl_iface to external program(s)
807 * 2 = process received credentials internally and pass them over
808 * ctrl_iface to external program(s)
809 */
810 int wps_cred_processing;
811
Hai Shalom021b0b52019-04-10 11:17:58 -0700812 /**
813 * wps_cred_add_sae - Whether to enable SAE automatically for WPS
814 *
815 * 0 = only add the explicitly listed WPA2-PSK configuration
816 * 1 = add both the WPA2-PSK and SAE configuration and enable PMF so
817 * that the station gets configured in WPA3-Personal transition mode
818 * (supports both WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
819 */
820 int wps_cred_add_sae;
821
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700822#define MAX_SEC_DEVICE_TYPES 5
823 /**
824 * sec_device_types - Secondary Device Types (P2P)
825 */
826 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
827 int num_sec_device_types;
828
829 int p2p_listen_reg_class;
830 int p2p_listen_channel;
831 int p2p_oper_reg_class;
832 int p2p_oper_channel;
833 int p2p_go_intent;
834 char *p2p_ssid_postfix;
835 int persistent_reconnect;
836 int p2p_intra_bss;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700837 unsigned int num_p2p_pref_chan;
838 struct p2p_channel *p2p_pref_chan;
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700839 struct wpa_freq_range_list p2p_no_go_freq;
840 int p2p_add_cli_chan;
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700841 int p2p_ignore_shared_freq;
Dmitry Shmidt43cb5782014-06-16 16:23:22 -0700842 int p2p_optimize_listen_chan;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700843
Hai Shalom899fcc72020-10-19 14:38:18 -0700844 int p2p_6ghz_disable;
845
Dmitry Shmidt04949592012-07-19 12:16:46 -0700846 struct wpabuf *wps_vendor_ext_m1;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700847
848#define MAX_WPS_VENDOR_EXT 10
849 /**
850 * wps_vendor_ext - Vendor extension attributes in WPS
851 */
852 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
853
854 /**
855 * p2p_group_idle - Maximum idle time in seconds for P2P group
856 *
857 * This value controls how long a P2P group is maintained after there
858 * is no other members in the group. As a GO, this means no associated
859 * stations in the group. As a P2P client, this means no GO seen in
860 * scan results. The maximum idle time is specified in seconds with 0
861 * indicating no time limit, i.e., the P2P group remains in active
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800862 * state indefinitely until explicitly removed. As a P2P client, the
863 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
864 * this parameter is mainly meant for GO use and for P2P client, it can
Dmitry Shmidt04949592012-07-19 12:16:46 -0700865 * only be used to reduce the default timeout to smaller value. A
866 * special value -1 can be used to configure immediate removal of the
867 * group for P2P client role on any disconnection after the data
868 * connection has been established.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700869 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700870 int p2p_group_idle;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700871
872 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800873 * p2p_go_freq_change_policy - The GO frequency change policy
874 *
875 * This controls the behavior of the GO when there is a change in the
876 * map of the currently used frequencies in case more than one channel
877 * is supported.
878 *
879 * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
880 * possible. In case the GO is the only interface using its frequency
881 * and there are other station interfaces on other frequencies, the GO
882 * will migrate to one of these frequencies.
883 *
884 * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
885 * but a transition is possible only in case one of the other used
886 * frequencies is one of the frequencies in the intersection of the
887 * frequency list of the local device and the peer device.
888 *
889 * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
890 *
891 * @P2P_GO_FREQ_MOVE_SCM_ECSA: Same as
892 * P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS but a transition is possible only
893 * if all the group members advertise eCSA support.
894 */
895 enum {
896 P2P_GO_FREQ_MOVE_SCM = 0,
897 P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS = 1,
898 P2P_GO_FREQ_MOVE_STAY = 2,
899 P2P_GO_FREQ_MOVE_SCM_ECSA = 3,
900 P2P_GO_FREQ_MOVE_MAX = P2P_GO_FREQ_MOVE_SCM_ECSA,
901 } p2p_go_freq_change_policy;
902
903#define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
904
905 /**
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700906 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
907 *
908 * This parameter controls the length of the random passphrase that is
909 * generated at the GO.
910 */
911 unsigned int p2p_passphrase_len;
912
913 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700914 * bss_max_count - Maximum number of BSS entries to keep in memory
915 */
916 unsigned int bss_max_count;
917
918 /**
919 * bss_expiration_age - BSS entry age after which it can be expired
920 *
921 * This value controls the time in seconds after which a BSS entry
922 * gets removed if it has not been updated or is not in use.
923 */
924 unsigned int bss_expiration_age;
925
926 /**
927 * bss_expiration_scan_count - Expire BSS after number of scans
928 *
929 * If the BSS entry has not been seen in this many scans, it will be
930 * removed. A value of 1 means that entry is removed after the first
931 * scan in which the BSSID is not seen. Larger values can be used
932 * to avoid BSS entries disappearing if they are not visible in
933 * every scan (e.g., low signal quality or interference).
934 */
935 unsigned int bss_expiration_scan_count;
936
937 /**
938 * filter_ssids - SSID-based scan result filtering
939 *
940 * 0 = do not filter scan results
941 * 1 = only include configured SSIDs in scan results/BSS table
942 */
943 int filter_ssids;
944
945 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700946 * filter_rssi - RSSI-based scan result filtering
947 *
948 * 0 = do not filter scan results
949 * -n = filter scan results below -n dBm
950 */
951 int filter_rssi;
952
953 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700954 * max_num_sta - Maximum number of STAs in an AP/P2P GO
955 */
956 unsigned int max_num_sta;
957
958 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -0700959 * ap_isolate - Whether to use client isolation feature
960 *
961 * Client isolation can be used to prevent low-level bridging of
962 * frames between associated stations in the BSS. By default,
963 * this bridging is allowed (ap_isolate=0); except in P2P GO case,
964 * where p2p_intra_bss parameter is used to determine whether to allow
965 * intra-BSS forwarding (ap_isolate = !p2p_intra_bss).
966 *
967 * 0 = do not enable AP isolation
968 * 1 = enable AP isolation
969 */
970 int ap_isolate;
971
972 /**
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700973 * freq_list - Array of allowed scan frequencies or %NULL for all
974 *
975 * This is an optional zero-terminated array of frequencies in
976 * megahertz (MHz) to allow for narrowing scanning range.
977 */
978 int *freq_list;
979
980 /**
Hai Shalom60840252021-02-19 19:02:11 -0800981 * initial_freq_list - like freq_list but for initial scan
982 *
983 * This is an optional zero-terminated array of frequencies in
984 * megahertz (MHz) to allow for narrowing scanning range when
985 * the application is started.
986 *
987 * This can be used to speed up initial connection time if the
988 * channel is known ahead of time, without limiting the scanned
989 * frequencies during normal use.
990 */
991 int *initial_freq_list;
992
993 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700994 * scan_cur_freq - Whether to scan only the current channel
995 *
996 * If true, attempt to scan only the current channel if any other
997 * VIFs on this radio are already associated on a particular channel.
998 */
999 int scan_cur_freq;
1000
1001 /**
Hai Shalom60840252021-02-19 19:02:11 -08001002 * scan_res_valid_for_connect - Seconds scans are valid for association
1003 *
1004 * This configures the number of seconds old scan results are considered
1005 * valid for association. When scan results are older than this value
1006 * a new scan is triggered prior to the association.
1007 */
1008 int scan_res_valid_for_connect;
1009
1010 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001011 * changed_parameters - Bitmap of changed parameters since last update
1012 */
1013 unsigned int changed_parameters;
1014
1015 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07001016 * disassoc_low_ack - Disassociate stations with massive packet loss
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001017 */
1018 int disassoc_low_ack;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001019
1020 /**
1021 * interworking - Whether Interworking (IEEE 802.11u) is enabled
1022 */
1023 int interworking;
1024
1025 /**
1026 * access_network_type - Access Network Type
1027 *
1028 * When Interworking is enabled, scans will be limited to APs that
1029 * advertise the specified Access Network Type (0..15; with 15
1030 * indicating wildcard match).
1031 */
1032 int access_network_type;
1033
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001034 /**
1035 * go_interworking - Whether Interworking for P2P GO is enabled
1036 */
1037 int go_interworking;
1038
1039 /**
1040 * go_access_network_type - P2P GO Access Network Type
1041 *
1042 * This indicates which access network type to advertise if Interworking
1043 * is enabled for P2P GO.
1044 */
1045 int go_access_network_type;
1046
1047 /**
1048 * go_internet - Interworking: Internet connectivity (0 or 1)
1049 */
1050 int go_internet;
1051
1052 /**
1053 * go_venue_group - Interworking: Venue group
1054 */
1055 int go_venue_group;
1056
1057 /**
1058 * go_venue_type: Interworking: Venue type
1059 */
1060 int go_venue_type;
1061
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001062 /**
Hai Shalom899fcc72020-10-19 14:38:18 -07001063 * hessid - Homogeneous ESS identifier
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001064 *
1065 * If this is set (any octet is non-zero), scans will be used to
1066 * request response only from BSSes belonging to the specified
1067 * Homogeneous ESS. This is used only if interworking is enabled.
1068 */
1069 u8 hessid[ETH_ALEN];
1070
1071 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001072 * hs20 - Hotspot 2.0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001073 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001074 int hs20;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001075
1076 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001077 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
1078 *
1079 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
1080 * by acting as a Registrar and using M1 from the AP. The config
1081 * methods attribute in that message is supposed to indicate only the
1082 * configuration method supported by the AP in Enrollee role, i.e., to
1083 * add an external Registrar. For that case, PBC shall not be used and
1084 * as such, the PushButton config method is removed from M1 by default.
1085 * If pbc_in_m1=1 is included in the configuration file, the PushButton
1086 * config method is left in M1 (if included in config_methods
1087 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
1088 * a label in the AP).
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001089 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001090 int pbc_in_m1;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001091
1092 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001093 * autoscan - Automatic scan parameters or %NULL if none
1094 *
1095 * This is an optional set of parameters for automatic scanning
1096 * within an interface in following format:
1097 * <autoscan module name>:<module parameters>
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001098 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001099 char *autoscan;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001100
1101 /**
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001102 * wps_nfc_pw_from_config - NFC Device Password was read from config
1103 *
1104 * This parameter can be determined whether the NFC Device Password was
1105 * included in the configuration (1) or generated dynamically (0). Only
1106 * the former case is re-written back to the configuration file.
1107 */
1108 int wps_nfc_pw_from_config;
1109
1110 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001111 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001112 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001113 int wps_nfc_dev_pw_id;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001114
1115 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001116 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001117 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001118 struct wpabuf *wps_nfc_dh_pubkey;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001119
1120 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001121 * wps_nfc_dh_privkey - NFC DH Private Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001122 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001123 struct wpabuf *wps_nfc_dh_privkey;
1124
1125 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001126 * wps_nfc_dev_pw - NFC Device Password for password token
Dmitry Shmidt04949592012-07-19 12:16:46 -07001127 */
1128 struct wpabuf *wps_nfc_dev_pw;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001129
1130 /**
1131 * ext_password_backend - External password backend or %NULL if none
1132 *
1133 * format: <backend name>[:<optional backend parameters>]
1134 */
1135 char *ext_password_backend;
1136
1137 /*
1138 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
1139 *
1140 * This timeout value is used in P2P GO mode to clean up
1141 * inactive stations.
1142 * By default: 300 seconds.
1143 */
1144 int p2p_go_max_inactivity;
1145
1146 struct hostapd_wmm_ac_params wmm_ac_params[4];
Hai Shalom899fcc72020-10-19 14:38:18 -07001147 struct hostapd_tx_queue_params tx_queue[4];
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001148
1149 /**
1150 * auto_interworking - Whether to use network selection automatically
1151 *
1152 * 0 = do not automatically go through Interworking network selection
1153 * (i.e., require explicit interworking_select command for this)
1154 * 1 = perform Interworking network selection if one or more
1155 * credentials have been configured and scan did not find a
1156 * matching network block
1157 */
1158 int auto_interworking;
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001159
1160 /**
1161 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
1162 *
1163 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1164 * Note that regulatory constraints and driver capabilities are
1165 * consulted anyway, so setting it to 1 can't do real harm.
1166 * By default: 0 (disabled)
1167 */
1168 int p2p_go_ht40;
1169
1170 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001171 * p2p_go_vht - Default mode for VHT enable when operating as GO
1172 *
1173 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1174 * Note that regulatory constraints and driver capabilities are
1175 * consulted anyway, so setting it to 1 can't do real harm.
1176 * By default: 0 (disabled)
1177 */
1178 int p2p_go_vht;
1179
1180 /**
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08001181 * p2p_go_edmg - Default mode for EDMG 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_edmg;
1189
1190 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08001191 * p2p_go_he - Default mode for 11ax HE 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_he;
1199
1200 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001201 * p2p_go_ctwindow - CTWindow to use when operating as GO
1202 *
1203 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
1204 * the length of the CTWindow in TUs.
1205 */
1206 int p2p_go_ctwindow;
1207
1208 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001209 * p2p_disabled - Whether P2P operations are disabled for this interface
1210 */
1211 int p2p_disabled;
1212
1213 /**
1214 * p2p_no_group_iface - Whether group interfaces can be used
1215 *
1216 * By default, wpa_supplicant will create a separate interface for P2P
1217 * group operations if the driver supports this. This functionality can
1218 * be disabled by setting this parameter to 1. In that case, the same
1219 * interface that was used for the P2P management operations is used
1220 * also for the group operation.
1221 */
1222 int p2p_no_group_iface;
1223
1224 /**
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07001225 * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1226 *
1227 * If this parameter is set to 1, a connected P2P Client will receive
1228 * and handle Probe Request frames. Setting this parameter to 0
1229 * disables this option. Default value: 0.
1230 *
1231 * Note: Setting this property at run time takes effect on the following
1232 * interface state transition to/from the WPA_COMPLETED state.
1233 */
1234 int p2p_cli_probe;
1235
1236 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001237 * okc - Whether to enable opportunistic key caching by default
1238 *
1239 * By default, OKC is disabled unless enabled by the per-network
1240 * proactive_key_caching=1 parameter. okc=1 can be used to change this
1241 * default behavior.
1242 */
1243 int okc;
1244
1245 /**
1246 * pmf - Whether to enable/require PMF by default
1247 *
1248 * By default, PMF is disabled unless enabled by the per-network
1249 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001250 * this default behavior for RSN network (this is not applicable for
1251 * non-RSN cases).
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001252 */
1253 enum mfp_options pmf;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001254
1255 /**
1256 * sae_groups - Preference list of enabled groups for SAE
1257 *
1258 * By default (if this parameter is not set), the mandatory group 19
1259 * (ECC group defined over a 256-bit prime order field) is preferred,
1260 * but other groups are also enabled. If this parameter is set, the
1261 * groups will be tried in the indicated order.
1262 */
1263 int *sae_groups;
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001264
1265 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001266 * sae_pwe - SAE mechanism for PWE derivation
1267 * 0 = hunting-and-pecking loop only
1268 * 1 = hash-to-element only
1269 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1270 */
1271 int sae_pwe;
1272
1273 /**
1274 * sae_pmkid_in_assoc - Whether to include PMKID in SAE Assoc Req
1275 */
1276 int sae_pmkid_in_assoc;
1277
1278 /**
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001279 * dtim_period - Default DTIM period in Beacon intervals
1280 *
1281 * This parameter can be used to set the default value for network
1282 * blocks that do not specify dtim_period.
1283 */
1284 int dtim_period;
1285
1286 /**
1287 * beacon_int - Default Beacon interval in TU
1288 *
1289 * This parameter can be used to set the default value for network
1290 * blocks that do not specify beacon_int.
1291 */
1292 int beacon_int;
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -07001293
1294 /**
1295 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1296 *
1297 * This parameter can be used to define additional vendor specific
1298 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1299 * format for these element(s) is a hexdump of the raw information
1300 * elements (id+len+payload for one or more elements).
1301 */
1302 struct wpabuf *ap_vendor_elements;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001303
1304 /**
Hai Shaloma20dcd72022-02-04 13:43:00 -08001305 * ap_assocresp_elements: Vendor specific elements for (Re)Association
1306 * Response frames
1307 *
1308 * This parameter can be used to define additional vendor specific
1309 * elements for (Re)Association Response frames in AP/P2P GO mode. The
1310 * format for these element(s) is a hexdump of the raw information
1311 * elements (id+len+payload for one or more elements).
1312 */
1313 struct wpabuf *ap_assocresp_elements;
1314
1315 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001316 * ignore_old_scan_res - Ignore scan results older than request
1317 *
1318 * The driver may have a cache of scan results that makes it return
1319 * information that is older than our scan trigger. This parameter can
1320 * be used to configure such old information to be ignored instead of
1321 * allowing it to update the internal BSS table.
1322 */
1323 int ignore_old_scan_res;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001324
1325 /**
1326 * sched_scan_interval - schedule scan interval
1327 */
1328 unsigned int sched_scan_interval;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001329
1330 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001331 * sched_scan_start_delay - Schedule scan start delay before first scan
1332 *
1333 * Delay (in seconds) before scheduling first scan plan cycle. The
1334 * driver may ignore this parameter and start immediately (or at any
1335 * other time), if this feature is not supported.
1336 */
1337 unsigned int sched_scan_start_delay;
1338
1339 /**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001340 * tdls_external_control - External control for TDLS setup requests
1341 *
1342 * Enable TDLS mode where external programs are given the control
1343 * to specify the TDLS link to get established to the driver. The
1344 * driver requests the TDLS setup to the supplicant only for the
1345 * specified TDLS peers.
1346 */
1347 int tdls_external_control;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001348
1349 u8 ip_addr_go[4];
1350 u8 ip_addr_mask[4];
1351 u8 ip_addr_start[4];
1352 u8 ip_addr_end[4];
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001353
1354 /**
1355 * osu_dir - OSU provider information directory
1356 *
1357 * If set, allow FETCH_OSU control interface command to be used to fetch
1358 * OSU provider information into all APs and store the results in this
1359 * directory.
1360 */
1361 char *osu_dir;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001362
1363 /**
1364 * wowlan_triggers - Wake-on-WLAN triggers
1365 *
1366 * If set, these wowlan triggers will be configured.
1367 */
1368 char *wowlan_triggers;
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -07001369
1370 /**
1371 * p2p_search_delay - Extra delay between concurrent search iterations
1372 *
1373 * Add extra delay (in milliseconds) between search iterations when
1374 * there is a concurrent operation to make p2p_find friendlier to
1375 * concurrent operations by avoiding it from taking 100% of radio
1376 * resources.
1377 */
1378 unsigned int p2p_search_delay;
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001379
1380 /**
1381 * mac_addr - MAC address policy default
1382 *
1383 * 0 = use permanent MAC address
1384 * 1 = use random MAC address for each ESS connection
1385 * 2 = like 1, but maintain OUI (with local admin bit set)
1386 *
1387 * By default, permanent MAC address is used unless policy is changed by
1388 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1389 * change this default behavior.
1390 */
1391 int mac_addr;
1392
1393 /**
1394 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1395 */
1396 unsigned int rand_addr_lifetime;
1397
1398 /**
1399 * preassoc_mac_addr - Pre-association MAC address policy
1400 *
1401 * 0 = use permanent MAC address
1402 * 1 = use random MAC address
1403 * 2 = like 1, but maintain OUI (with local admin bit set)
1404 */
1405 int preassoc_mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001406
1407 /**
1408 * key_mgmt_offload - Use key management offload
1409 *
1410 * Key management offload should be used if the device supports it.
1411 * Key management offload is the capability of a device operating as
1412 * a station to do the exchange necessary to establish temporal keys
1413 * during initial RSN connection, after roaming, or during a PTK
1414 * rekeying operation.
1415 */
1416 int key_mgmt_offload;
1417
1418 /**
1419 * user_mpm - MPM residency
1420 *
1421 * 0: MPM lives in driver.
1422 * 1: wpa_supplicant handles peering and station allocation.
1423 *
1424 * If AMPE or SAE is enabled, the MPM is always in userspace.
1425 */
1426 int user_mpm;
1427
1428 /**
1429 * max_peer_links - Maximum number of peer links
1430 *
1431 * Maximum number of mesh peering currently maintained by the STA.
1432 */
1433 int max_peer_links;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001434
1435 /**
1436 * cert_in_cb - Whether to include a peer certificate dump in events
1437 *
1438 * This controls whether peer certificates for authentication server and
1439 * its certificate chain are included in EAP peer certificate events.
1440 */
1441 int cert_in_cb;
1442
1443 /**
1444 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1445 *
1446 * This timeout value is used in mesh STA to clean up inactive stations.
1447 * By default: 300 seconds.
1448 */
1449 int mesh_max_inactivity;
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001450
1451 /**
Hai Shaloma20dcd72022-02-04 13:43:00 -08001452 * mesh_fwding - Mesh network layer-2 forwarding (dot11MeshForwarding)
1453 *
1454 * This controls whether to enable layer-2 forwarding.
1455 * By default: 1: enabled
1456 */
1457 int mesh_fwding;
1458
1459 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001460 * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1461 *
1462 * This timeout value is used in mesh STA to retransmit
1463 * SAE Authentication frame.
1464 * By default: 1000 milliseconds.
1465 */
1466 int dot11RSNASAERetransPeriod;
1467
1468 /**
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001469 * passive_scan - Whether to force passive scan for network connection
1470 *
1471 * This parameter can be used to force only passive scanning to be used
1472 * for network connection cases. It should be noted that this will slow
1473 * down scan operations and reduce likelihood of finding the AP. In
1474 * addition, some use cases will override this due to functional
1475 * requirements, e.g., for finding an AP that uses hidden SSID
1476 * (scan_ssid=1) or P2P device discovery.
1477 */
1478 int passive_scan;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001479
1480 /**
1481 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1482 */
1483 int reassoc_same_bss_optim;
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -07001484
1485 /**
1486 * wps_priority - Priority for the networks added through WPS
1487 *
1488 * This priority value will be set to each network profile that is added
1489 * by executing the WPS protocol.
1490 */
1491 int wps_priority;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001492
1493 /**
1494 * fst_group_id - FST group ID
1495 */
1496 char *fst_group_id;
1497
1498 /**
1499 * fst_priority - priority of the interface within the FST group
1500 */
1501 int fst_priority;
1502
1503 /**
1504 * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1505 * interface.
1506 */
1507 int fst_llt;
1508
1509 /**
1510 * wpa_rsc_relaxation - RSC relaxation on GTK installation
1511 *
1512 * Values:
1513 * 0 - use the EAPOL-Key RSC value on GTK installation
1514 * 1 - use the null RSC if a bogus RSC value is detected in message 3
1515 * of 4-Way Handshake or message 1 of Group Key Handshake.
1516 */
1517 int wpa_rsc_relaxation;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001518
1519 /**
1520 * sched_scan_plans - Scan plans for scheduled scan
1521 *
1522 * Each scan plan specifies the interval between scans and the number of
1523 * iterations. The last scan plan only specifies the scan interval and
1524 * will be run infinitely.
1525 *
1526 * format: <interval:iterations> <interval2:iterations2> ... <interval>
1527 */
1528 char *sched_scan_plans;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001529
1530#ifdef CONFIG_MBO
1531 /**
1532 * non_pref_chan - Non-preferred channels list, separated by spaces.
1533 *
1534 * format: op_class:chan:preference:reason<:detail>
1535 * Detail is optional.
1536 */
1537 char *non_pref_chan;
1538
1539 /**
1540 * mbo_cell_capa - Cellular capabilities for MBO
1541 */
1542 enum mbo_cellular_capa mbo_cell_capa;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001543
1544 /**
1545 * disassoc_imminent_rssi_threshold - RSSI threshold of candidate AP
1546 * when disassociation imminent is set.
1547 */
1548 int disassoc_imminent_rssi_threshold;
1549
1550 /**
1551 * oce - Enable OCE in STA and/or STA-CFON mode
1552 * - Set BIT(0) to enable OCE in non-AP STA mode
1553 * - Set BIT(1) to enable OCE in STA-CFON mode
1554 */
1555 unsigned int oce;
Sunil Ravi84bb3e12021-06-10 09:52:05 -07001556#endif /* CONFIG_MBO */
Dennis Jeone2cb56b2020-10-23 21:23:01 +09001557 /**
1558 * btm_offload - Set where to perform roaming logic
1559 * - Set to 0 to handle fully roaming logic in supplicant
1560 * - Set to 1 to skip roaming logic in supplicant for firmware roaming
1561 * just parse BTM frame and notify framework
1562 */
Sunil Ravi84bb3e12021-06-10 09:52:05 -07001563 int btm_offload;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001564
1565 /**
1566 * gas_address3 - GAS Address3 field behavior
1567 *
1568 * Values:
1569 * 0 - P2P specification (Address3 = AP BSSID)
1570 * 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
1571 * sent to not-associated AP; if associated, AP BSSID)
1572 */
1573 int gas_address3;
Dmitry Shmidt7d175302016-09-06 13:11:34 -07001574
1575 /**
1576 * ftm_responder - Publish FTM (fine timing measurement)
1577 * responder functionality
1578 *
1579 * Values:
1580 * 0 - do not publish FTM responder functionality (Default)
1581 * 1 - publish FTM responder functionality in
1582 * bit 70 of Extended Capabilities element
1583 * Note, actual FTM responder operation is managed outside
1584 * wpa_supplicant.
1585 */
1586 int ftm_responder;
1587
1588 /**
1589 * ftm_initiator - Publish FTM (fine timing measurement)
1590 * initiator functionality
1591 *
1592 * Values:
1593 * 0 - do not publish FTM initiator functionality (Default)
1594 * 1 - publish FTM initiator functionality in
1595 * bit 71 of Extended Capabilities element
1596 * Note, actual FTM initiator operation is managed outside
1597 * wpa_supplicant.
1598 */
1599 int ftm_initiator;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001600
1601 /**
1602 * gas_rand_addr_lifetime - Lifetime of random MAC address for ANQP in
1603 * seconds
1604 */
1605 unsigned int gas_rand_addr_lifetime;
1606
1607 /**
1608 * gas_rand_mac_addr - GAS MAC address policy
1609 *
1610 * 0 = use permanent MAC address
1611 * 1 = use random MAC address
1612 * 2 = like 1, but maintain OUI (with local admin bit set)
1613 */
1614 int gas_rand_mac_addr;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001615
1616 /**
1617 * dpp_config_processing - How to process DPP configuration
1618 *
1619 * 0 = report received configuration to an external program for
1620 * processing; do not generate any network profile internally
1621 * 1 = report received configuration to an external program and generate
1622 * a network profile internally, but do not automatically connect
1623 * to the created (disabled) profile; the network profile id is
1624 * reported to external programs
1625 * 2 = report received configuration to an external program, generate
1626 * a network profile internally, try to connect to the created
1627 * profile automatically
1628 */
1629 int dpp_config_processing;
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001630
1631 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001632 * dpp_name - Name for Enrollee's DPP Configuration Request
1633 */
1634 char *dpp_name;
1635
1636 /**
1637 * dpp_mud_url - MUD URL for Enrollee's DPP Configuration Request
1638 */
1639 char *dpp_mud_url;
1640
1641 /**
Sunil Ravi89eba102022-09-13 21:04:37 -07001642 * dpp_extra_conf_req_name - JSON node name of additional data for
1643 * Enrollee's DPP Configuration Request
1644 */
1645 char *dpp_extra_conf_req_name;
1646
1647 /**
1648 * dpp_extra_conf_req_value - JSON node data of additional data for
1649 * Enrollee's DPP Configuration Request
1650 */
1651 char *dpp_extra_conf_req_value;
1652
1653 /* dpp_connector_privacy_default - Default valur for Connector privacy
1654 *
1655 * This value is used as the default for the dpp_connector_privacy
1656 * network parameter for all new networks provisioned using DPP.
1657 */
1658 int dpp_connector_privacy_default;
1659
1660 /**
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001661 * coloc_intf_reporting - Colocated interference reporting
1662 *
1663 * dot11CoLocIntfReportingActivated
1664 * 0 = disabled (false)
1665 * 1 = enabled (true)
1666 */
1667 int coloc_intf_reporting;
1668
1669 /**
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001670 * p2p_device_random_mac_addr - P2P Device MAC address policy default
1671 *
Hai Shalom60840252021-02-19 19:02:11 -08001672 * 0 = use permanent MAC address (the one set by default by the device
1673 * driver). Notice that, if the device driver is configured to
1674 * always use random MAC addresses, this flag breaks reinvoking a
1675 * persistent group, so flags 1 or 2 should be used instead with
1676 * such drivers if persistent groups are used.
Hai Shalom74f70d42019-02-11 14:42:39 -08001677 * 1 = use random MAC address on creating the interface if there is no
Hai Shalom60840252021-02-19 19:02:11 -08001678 * persistent group. Besides, if a persistent group is created,
1679 * p2p_device_persistent_mac_addr is set to the MAC address of the
1680 * P2P Device interface, so that this address will be subsequently
1681 * used to change the MAC address of the P2P Device interface. With
1682 * no persistent group, the random MAC address is created by
1683 * wpa_supplicant, changing the one set by the device driver.
1684 * The device driver shall support SIOCGIFFLAGS/SIOCSIFFLAGS ioctl
1685 * interface control operations.
1686 * 2 = this flag should be used when the device driver uses random MAC
1687 * addresses by default when a P2P Device interface is created.
1688 * If p2p_device_persistent_mac_addr is set, use this MAC address
1689 * on creating the P2P Device interface. If not set, use the
1690 * default method adopted by the device driver (e.g., random MAC
1691 * address). Besides, if a persistent group is created,
1692 * p2p_device_persistent_mac_addr is set to the MAC address of the
1693 * P2P Device interface, so that this address will be subsequently
1694 * used in place of the default address set by the device driver.
1695 * (This option does not need support of SIOCGIFFLAGS/SIOCSIFFLAGS
1696 * ioctl interface control operations and uses NL80211_ATTR_MAC).
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001697 *
1698 * By default, permanent MAC address is used.
1699 */
1700 int p2p_device_random_mac_addr;
1701
1702 /**
1703 * p2p_device_persistent_mac_addr - Record last used MAC address
1704 *
Hai Shalom74f70d42019-02-11 14:42:39 -08001705 * If there are saved persistent groups, P2P cannot generate another
1706 * random MAC address, and need to restore to last used MAC address.
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001707 */
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001708 u8 p2p_device_persistent_mac_addr[ETH_ALEN];
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001709
Jimmy Chen36c21992018-11-29 16:46:43 +08001710 /**
1711 * p2p_interface_random_mac_addr - P2P Interface MAC address policy default
1712 *
1713 * 0 = use permanent MAC address
1714 * 1 = use random MAC address on creating the interface.
1715 *
1716 * By default, permanent MAC address is used.
1717 */
1718 int p2p_interface_random_mac_addr;
1719
xshud0ee72f2018-11-08 14:37:01 -08001720 /**
1721 * bss_no_flush_when_down - Whether to flush BSS entries when the interface is disabled
1722 *
1723 * 0 = Flush BSS entries when the interface becomes disabled (Default)
1724 * 1 = Do not flush BSS entries when the interface becomes disabled
1725 */
1726 int bss_no_flush_when_down;
Hai Shalom81f62d82019-07-22 12:10:00 -07001727
1728 /**
1729 * disable_btm - Disable BSS transition management in STA
1730 * - Set to 0 to enable BSS transition management
1731 * - Set to 1 to disable BSS transition management
1732 *
1733 * By default BSS transition management is enabled
1734 */
1735 int disable_btm;
Hai Shalomfdcde762020-04-02 11:19:20 -07001736
1737 /**
1738 * extended_key_id - Extended Key ID support
1739 *
1740 * IEEE Std 802.11-2016 optionally allows to use Key ID 0 and 1 for PTK
1741 * keys with Extended Key ID.
1742 *
1743 * 0 = don't use Extended Key ID
1744 * 1 = use Extended Key ID when possible
1745 */
1746 int extended_key_id;
Hai Shalom60840252021-02-19 19:02:11 -08001747
1748 /**
1749 * wowlan_disconnect_on_deinit - Trigger disconnect on wpa_supplicant
1750 * interface deinit even if the driver has enabled WoWLAN.
1751 *
1752 * 0 = Do not disconnect
1753 * 1 = Trigger disconnection
1754 */
1755 int wowlan_disconnect_on_deinit;
1756
1757#ifdef CONFIG_PASN
1758#ifdef CONFIG_TESTING_OPTIONS
1759 /*
1760 * Normally, KDK should be derived if and only if both sides support
1761 * secure LTF. Allow forcing KDK derivation for testing purposes.
1762 */
1763 int force_kdk_derivation;
Hai Shaloma20dcd72022-02-04 13:43:00 -08001764
1765 /* If set, corrupt the MIC in the 3rd Authentication frame of PASN */
1766 int pasn_corrupt_mic;
1767
Hai Shalom60840252021-02-19 19:02:11 -08001768#endif /* CONFIG_TESTING_OPTIONS */
1769#endif /* CONFIG_PASN*/
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001770};
1771
1772
1773/* Prototypes for common functions from config.c */
1774
1775void wpa_config_free(struct wpa_config *ssid);
1776void wpa_config_free_ssid(struct wpa_ssid *ssid);
1777void wpa_config_foreach_network(struct wpa_config *config,
1778 void (*func)(void *, struct wpa_ssid *),
1779 void *arg);
1780struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1781struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1782int wpa_config_remove_network(struct wpa_config *config, int id);
1783void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1784int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1785 int line);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001786int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1787 const char *value);
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001788int wpa_config_dump_values(struct wpa_config *config, char *buf,
1789 size_t buflen);
1790int wpa_config_get_value(const char *name, struct wpa_config *config,
1791 char *buf, size_t buflen);
1792
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001793char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1794char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1795char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1796void wpa_config_update_psk(struct wpa_ssid *ssid);
1797int wpa_config_add_prio_network(struct wpa_config *config,
1798 struct wpa_ssid *ssid);
1799int wpa_config_update_prio_list(struct wpa_config *config);
1800const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1801 const char *name);
1802void wpa_config_set_blob(struct wpa_config *config,
1803 struct wpa_config_blob *blob);
1804void wpa_config_free_blob(struct wpa_config_blob *blob);
1805int wpa_config_remove_blob(struct wpa_config *config, const char *name);
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001806void wpa_config_flush_blobs(struct wpa_config *config);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001807
Dmitry Shmidt04949592012-07-19 12:16:46 -07001808struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1809struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1810int wpa_config_remove_cred(struct wpa_config *config, int id);
1811void wpa_config_free_cred(struct wpa_cred *cred);
1812int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1813 const char *value, int line);
Dmitry Shmidt0cfd5f72014-04-04 14:48:05 -07001814char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
Dmitry Shmidt04949592012-07-19 12:16:46 -07001815
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001816struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1817 const char *driver_param);
1818#ifndef CONFIG_NO_STDOUT_DEBUG
1819void wpa_config_debug_dump_networks(struct wpa_config *config);
1820#else /* CONFIG_NO_STDOUT_DEBUG */
1821#define wpa_config_debug_dump_networks(c) do { } while (0)
1822#endif /* CONFIG_NO_STDOUT_DEBUG */
1823
1824
1825/* Prototypes for common functions from config.c */
1826int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1827
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001828int wpa_config_get_num_global_field_names(void);
1829
1830const char * wpa_config_get_global_field_name(unsigned int i, int *no_var);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001831
1832/* Prototypes for backend specific functions from the selected config_*.c */
1833
1834/**
1835 * wpa_config_read - Read and parse configuration database
1836 * @name: Name of the configuration (e.g., path and file name for the
1837 * configuration file)
Jouni Malinen5d1c8ad2013-04-23 12:34:56 -07001838 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001839 * Returns: Pointer to allocated configuration data or %NULL on failure
1840 *
1841 * This function reads configuration data, parses its contents, and allocates
1842 * data structures needed for storing configuration information. The allocated
1843 * data can be freed with wpa_config_free().
1844 *
1845 * Each configuration backend needs to implement this function.
1846 */
Dmitry Shmidt64f47c52013-04-16 10:41:54 -07001847struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001848
1849/**
1850 * wpa_config_write - Write or update configuration data
1851 * @name: Name of the configuration (e.g., path and file name for the
1852 * configuration file)
1853 * @config: Configuration data from wpa_config_read()
1854 * Returns: 0 on success, -1 on failure
1855 *
1856 * This function write all configuration data into an external database (e.g.,
1857 * a text file) in a format that can be read with wpa_config_read(). This can
1858 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1859 * new network is added or a password is changed.
1860 *
1861 * Each configuration backend needs to implement this function.
1862 */
1863int wpa_config_write(const char *name, struct wpa_config *config);
1864
1865#endif /* CONFIG_H */