blob: 46ab9ca72892ed50a9fa1c0bf382f58e959bbacb [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
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080021/*
22 * The default dot11RSNASAERetransPeriod is defined as 40 ms in the standard,
23 * but use 1000 ms in practice to avoid issues on low power CPUs.
24 */
25#define DEFAULT_DOT11_RSNA_SAE_RETRANS_PERIOD 1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070026#define DEFAULT_FAST_REAUTH 1
27#define DEFAULT_P2P_GO_INTENT 7
28#define DEFAULT_P2P_INTRA_BSS 1
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070029#define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
Dmitry Shmidt43cb5782014-06-16 16:23:22 -070030#define DEFAULT_P2P_OPTIMIZE_LISTEN_CHAN 0
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070031#define DEFAULT_BSS_MAX_COUNT 200
32#define DEFAULT_BSS_EXPIRATION_AGE 180
33#define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
34#define DEFAULT_MAX_NUM_STA 128
Roshan Pius3a1667e2018-07-03 15:17:14 -070035#define DEFAULT_AP_ISOLATE 0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -080036#define DEFAULT_ACCESS_NETWORK_TYPE 15
Dmitry Shmidtea69e842013-05-13 14:52:28 -070037#define DEFAULT_SCAN_CUR_FREQ 0
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -070038#define DEFAULT_P2P_SEARCH_DELAY 500
Dmitry Shmidt661b4f72014-09-29 14:58:27 -070039#define DEFAULT_RAND_ADDR_LIFETIME 60
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080040#define DEFAULT_KEY_MGMT_OFFLOAD 1
Dmitry Shmidt2f74e362015-01-21 13:19:05 -080041#define DEFAULT_CERT_IN_CB 1
Dmitry Shmidt7f656022015-02-25 14:36:37 -080042#define DEFAULT_P2P_GO_CTWINDOW 0
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080043#define DEFAULT_WPA_RSC_RELAXATION 1
Dmitry Shmidt57c2d392016-02-23 13:40:19 -080044#define DEFAULT_MBO_CELL_CAPA MBO_CELL_CAPA_NOT_SUPPORTED
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070045#define DEFAULT_DISASSOC_IMMINENT_RSSI_THRESHOLD -75
46#define DEFAULT_OCE_SUPPORT OCE_STA
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070047
48#include "config_ssid.h"
49#include "wps/wps.h"
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -070050#include "common/ieee802_11_defs.h"
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070051#include "common/ieee802_11_common.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070052
53
Roshan Pius3a1667e2018-07-03 15:17:14 -070054#define MAX_ROAMING_CONS 36
55#define MAX_ROAMING_CONS_OI_LEN 15
56
Dmitry Shmidt04949592012-07-19 12:16:46 -070057struct wpa_cred {
58 /**
59 * next - Next credential in the list
60 *
61 * This pointer can be used to iterate over all credentials. The head
62 * of this list is stored in the cred field of struct wpa_config.
63 */
64 struct wpa_cred *next;
65
66 /**
67 * id - Unique id for the credential
68 *
69 * This identifier is used as a unique identifier for each credential
70 * block when using the control interface. Each credential is allocated
71 * an id when it is being created, either when reading the
72 * configuration file or when a new credential is added through the
73 * control interface.
74 */
75 int id;
76
77 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080078 * temporary - Whether this credential is temporary and not to be saved
79 */
80 int temporary;
81
82 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -070083 * priority - Priority group
84 *
85 * By default, all networks and credentials get the same priority group
86 * (0). This field can be used to give higher priority for credentials
87 * (and similarly in struct wpa_ssid for network blocks) to change the
88 * Interworking automatic networking selection behavior. The matching
89 * network (based on either an enabled network block or a credential)
90 * with the highest priority value will be selected.
91 */
92 int priority;
93
94 /**
95 * pcsc - Use PC/SC and SIM/USIM card
96 */
97 int pcsc;
98
99 /**
100 * realm - Home Realm for Interworking
101 */
102 char *realm;
103
104 /**
105 * username - Username for Interworking network selection
106 */
107 char *username;
108
109 /**
110 * password - Password for Interworking network selection
111 */
112 char *password;
113
114 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700115 * ext_password - Whether password is a name for external storage
116 */
117 int ext_password;
118
119 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700120 * ca_cert - CA certificate for Interworking network selection
121 */
122 char *ca_cert;
123
124 /**
125 * client_cert - File path to client certificate file (PEM/DER)
126 *
127 * This field is used with Interworking networking selection for a case
128 * where client certificate/private key is used for authentication
129 * (EAP-TLS). Full path to the file should be used since working
130 * directory may change when wpa_supplicant is run in the background.
131 *
132 * Alternatively, a named configuration blob can be used by setting
133 * this to blob://blob_name.
134 */
135 char *client_cert;
136
137 /**
138 * private_key - File path to client private key file (PEM/DER/PFX)
139 *
140 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
141 * commented out. Both the private key and certificate will be read
142 * from the PKCS#12 file in this case. Full path to the file should be
143 * used since working directory may change when wpa_supplicant is run
144 * in the background.
145 *
146 * Windows certificate store can be used by leaving client_cert out and
147 * configuring private_key in one of the following formats:
148 *
149 * cert://substring_to_match
150 *
151 * hash://certificate_thumbprint_in_hex
152 *
153 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
154 *
155 * Note that when running wpa_supplicant as an application, the user
156 * certificate store (My user account) is used, whereas computer store
157 * (Computer account) is used when running wpasvc as a service.
158 *
159 * Alternatively, a named configuration blob can be used by setting
160 * this to blob://blob_name.
161 */
162 char *private_key;
163
164 /**
165 * private_key_passwd - Password for private key file
166 */
167 char *private_key_passwd;
168
169 /**
170 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
171 */
172 char *imsi;
173
174 /**
175 * milenage - Milenage parameters for SIM/USIM simulator in
176 * <Ki>:<OPc>:<SQN> format
177 */
178 char *milenage;
179
180 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -0700181 * domain_suffix_match - Constraint for server domain name
182 *
183 * If set, this FQDN is used as a suffix match requirement for the AAA
184 * server certificate in SubjectAltName dNSName element(s). If a
185 * matching dNSName is found, this constraint is met. If no dNSName
Dmitry Shmidtff787d52015-01-12 13:01:47 -0800186 * values are present, this constraint is matched against SubjectName CN
Dmitry Shmidt051af732013-10-22 13:52:46 -0700187 * using same suffix match comparison. Suffix match here means that the
188 * host/domain name is compared one label at a time starting from the
189 * top-level domain and all the labels in @domain_suffix_match shall be
190 * included in the certificate. The certificate may include additional
191 * sub-level labels in addition to the required labels.
192 *
193 * For example, domain_suffix_match=example.com would match
194 * test.example.com but would not match test-example.com.
195 */
196 char *domain_suffix_match;
197
198 /**
199 * domain - Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700200 *
201 * This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700202 * whether the AP is operated by the Home SP. Multiple domain entries
203 * can be used to configure alternative FQDNs that will be considered
204 * home networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700205 */
Dmitry Shmidt051af732013-10-22 13:52:46 -0700206 char **domain;
207
208 /**
209 * num_domain - Number of FQDNs in the domain array
210 */
211 size_t num_domain;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700212
213 /**
214 * roaming_consortium - Roaming Consortium OI
215 *
216 * If roaming_consortium_len is non-zero, this field contains the
217 * Roaming Consortium OI that can be used to determine which access
218 * points support authentication with this credential. This is an
219 * alternative to the use of the realm parameter. When using Roaming
220 * Consortium to match the network, the EAP parameters need to be
221 * pre-configured with the credential since the NAI Realm information
222 * may not be available or fetched.
223 */
224 u8 roaming_consortium[15];
225
226 /**
227 * roaming_consortium_len - Length of roaming_consortium
228 */
229 size_t roaming_consortium_len;
230
Roshan Pius3a1667e2018-07-03 15:17:14 -0700231 /**
232 * required_roaming_consortium - Required Roaming Consortium OI
233 *
234 * If required_roaming_consortium_len is non-zero, this field contains
235 * the Roaming Consortium OI that is required to be advertised by the AP
236 * for the credential to be considered matching.
237 */
Dmitry Shmidt051af732013-10-22 13:52:46 -0700238 u8 required_roaming_consortium[15];
Roshan Pius3a1667e2018-07-03 15:17:14 -0700239
240 /**
241 * required_roaming_consortium_len - Length of required_roaming_consortium
242 */
Dmitry Shmidt051af732013-10-22 13:52:46 -0700243 size_t required_roaming_consortium_len;
244
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700245 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -0700246 * roaming_consortiums - Roaming Consortium OI(s) memberships
247 *
248 * This field contains one or more OIs identifying the roaming
249 * consortiums of which the provider is a member. The list is sorted
250 * from the most preferred one to the least preferred one. A match
251 * between the Roaming Consortium OIs advertised by an AP and the OIs
252 * in this list indicates that successful authentication is possible.
253 * (Hotspot 2.0 PerProviderSubscription/<X+>/HomeSP/RoamingConsortiumOI)
254 */
255 u8 roaming_consortiums[MAX_ROAMING_CONS][MAX_ROAMING_CONS_OI_LEN];
256
257 /**
258 * roaming_consortiums_len - Length on roaming_consortiums[i]
259 */
260 size_t roaming_consortiums_len[MAX_ROAMING_CONS];
261
262 /**
263 * num_roaming_consortiums - Number of entries in roaming_consortiums
264 */
265 unsigned int num_roaming_consortiums;
266
267 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700268 * eap_method - EAP method to use
269 *
270 * Pre-configured EAP method to use with this credential or %NULL to
271 * indicate no EAP method is selected, i.e., the method will be
272 * selected automatically based on ANQP information.
273 */
274 struct eap_method_type *eap_method;
275
276 /**
277 * phase1 - Phase 1 (outer authentication) parameters
278 *
279 * Pre-configured EAP parameters or %NULL.
280 */
281 char *phase1;
282
283 /**
284 * phase2 - Phase 2 (inner authentication) parameters
285 *
286 * Pre-configured EAP parameters or %NULL.
287 */
288 char *phase2;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800289
290 struct excluded_ssid {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700291 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800292 size_t ssid_len;
293 } *excluded_ssid;
294 size_t num_excluded_ssid;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800295
296 struct roaming_partner {
297 char fqdn[128];
298 int exact_match;
299 u8 priority;
300 char country[3];
301 } *roaming_partner;
302 size_t num_roaming_partner;
303
304 int update_identifier;
305
306 /**
307 * provisioning_sp - FQDN of the SP that provisioned the credential
308 */
309 char *provisioning_sp;
310
311 /**
312 * sp_priority - Credential priority within a provisioning SP
313 *
314 * This is the priority of the credential among all credentials
315 * provisionined by the same SP (i.e., for entries that have identical
316 * provisioning_sp value). The range of this priority is 0-255 with 0
317 * being the highest and 255 the lower priority.
318 */
319 int sp_priority;
320
321 unsigned int min_dl_bandwidth_home;
322 unsigned int min_ul_bandwidth_home;
323 unsigned int min_dl_bandwidth_roaming;
324 unsigned int min_ul_bandwidth_roaming;
325
326 /**
327 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
328 * This value is used as the maximum channel utilization for network
329 * selection purposes for home networks. If the AP does not advertise
330 * BSS Load or if the limit would prevent any connection, this
331 * constraint will be ignored.
332 */
333 unsigned int max_bss_load;
334
335 unsigned int num_req_conn_capab;
336 u8 *req_conn_capab_proto;
337 int **req_conn_capab_port;
338
339 /**
340 * ocsp - Whether to use/require OCSP to check server certificate
341 *
342 * 0 = do not use OCSP stapling (TLS certificate status extension)
343 * 1 = try to use OCSP stapling, but not require response
344 * 2 = require valid OCSP stapling response
345 */
346 int ocsp;
Dmitry Shmidtf9bdef92014-04-25 10:46:36 -0700347
348 /**
349 * sim_num - User selected SIM identifier
350 *
351 * This variable is used for identifying which SIM is used if the system
352 * has more than one.
353 */
354 int sim_num;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700355};
356
357
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700358#define CFG_CHANGED_DEVICE_NAME BIT(0)
359#define CFG_CHANGED_CONFIG_METHODS BIT(1)
360#define CFG_CHANGED_DEVICE_TYPE BIT(2)
361#define CFG_CHANGED_OS_VERSION BIT(3)
362#define CFG_CHANGED_UUID BIT(4)
363#define CFG_CHANGED_COUNTRY BIT(5)
364#define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
365#define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
366#define CFG_CHANGED_WPS_STRING BIT(8)
367#define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
368#define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
Jouni Malinen75ecf522011-06-27 15:19:46 -0700369#define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
370#define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700371#define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700372#define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800373#define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700374#define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800375#define CFG_CHANGED_SCHED_SCAN_PLANS BIT(17)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700376#define CFG_CHANGED_WOWLAN_TRIGGERS BIT(18)
Hai Shalom81f62d82019-07-22 12:10:00 -0700377#define CFG_CHANGED_DISABLE_BTM BIT(19)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700378
379/**
380 * struct wpa_config - wpa_supplicant configuration data
381 *
382 * This data structure is presents the per-interface (radio) configuration
383 * data. In many cases, there is only one struct wpa_config instance, but if
384 * more than one network interface is being controlled, one instance is used
385 * for each.
386 */
387struct wpa_config {
388 /**
389 * ssid - Head of the global network list
390 *
391 * This is the head for the list of all the configured networks.
392 */
393 struct wpa_ssid *ssid;
394
395 /**
396 * pssid - Per-priority network lists (in priority order)
397 */
398 struct wpa_ssid **pssid;
399
400 /**
401 * num_prio - Number of different priorities used in the pssid lists
402 *
403 * This indicates how many per-priority network lists are included in
404 * pssid.
405 */
406 int num_prio;
407
408 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700409 * cred - Head of the credential list
410 *
411 * This is the head for the list of all the configured credentials.
412 */
413 struct wpa_cred *cred;
414
415 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700416 * eapol_version - IEEE 802.1X/EAPOL version number
417 *
418 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
419 * defines EAPOL version 2. However, there are many APs that do not
420 * handle the new version number correctly (they seem to drop the
421 * frames completely). In order to make wpa_supplicant interoperate
422 * with these APs, the version number is set to 1 by default. This
423 * configuration value can be used to set it to the new version (2).
424 */
425 int eapol_version;
426
427 /**
428 * ap_scan - AP scanning/selection
429 *
430 * By default, wpa_supplicant requests driver to perform AP
431 * scanning and then uses the scan results to select a
432 * suitable AP. Another alternative is to allow the driver to
433 * take care of AP scanning and selection and use
434 * wpa_supplicant just to process EAPOL frames based on IEEE
435 * 802.11 association information from the driver.
436 *
437 * 1: wpa_supplicant initiates scanning and AP selection (default).
438 *
439 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
440 * association parameters (e.g., WPA IE generation); this mode can
441 * also be used with non-WPA drivers when using IEEE 802.1X mode;
442 * do not try to associate with APs (i.e., external program needs
443 * to control association). This mode must also be used when using
444 * wired Ethernet drivers.
445 *
446 * 2: like 0, but associate with APs using security policy and SSID
447 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
448 * drivers to enable operation with hidden SSIDs and optimized roaming;
449 * in this mode, the network blocks in the configuration are tried
450 * one by one until the driver reports successful association; each
451 * network block should have explicit security policy (i.e., only one
452 * option in the lists) for key_mgmt, pairwise, group, proto variables.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800453 *
454 * Note: ap_scan=2 should not be used with the nl80211 driver interface
455 * (the current Linux interface). ap_scan=1 is optimized work working
456 * with nl80211. For finding networks using hidden SSID, scan_ssid=1 in
457 * the network block can be used with nl80211.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700458 */
459 int ap_scan;
460
461 /**
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800462 * bgscan - Background scan and roaming parameters or %NULL if none
463 *
464 * This is an optional set of parameters for background scanning and
465 * roaming within a network (ESS). For more detailed information see
466 * ssid block documentation.
467 *
468 * The variable defines default bgscan behavior for all BSS station
469 * networks except for those which have their own bgscan configuration.
470 */
471 char *bgscan;
472
473 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700474 * disable_scan_offload - Disable automatic offloading of scan requests
475 *
476 * By default, %wpa_supplicant tries to offload scanning if the driver
477 * indicates support for this (sched_scan). This configuration
478 * parameter can be used to disable this offloading mechanism.
479 */
480 int disable_scan_offload;
481
482 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700483 * ctrl_interface - Parameters for the control interface
484 *
485 * If this is specified, %wpa_supplicant will open a control interface
486 * that is available for external programs to manage %wpa_supplicant.
487 * The meaning of this string depends on which control interface
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800488 * mechanism is used. For all cases, the existence of this parameter
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700489 * in configuration is used to determine whether the control interface
490 * is enabled.
491 *
492 * For UNIX domain sockets (default on Linux and BSD): This is a
493 * directory that will be created for UNIX domain sockets for listening
494 * to requests from external programs (CLI/GUI, etc.) for status
495 * information and configuration. The socket file will be named based
496 * on the interface name, so multiple %wpa_supplicant processes can be
497 * run at the same time if more than one interface is used.
498 * /var/run/wpa_supplicant is the recommended directory for sockets and
499 * by default, wpa_cli will use it when trying to connect with
500 * %wpa_supplicant.
501 *
502 * Access control for the control interface can be configured
503 * by setting the directory to allow only members of a group
504 * to use sockets. This way, it is possible to run
505 * %wpa_supplicant as root (since it needs to change network
506 * configuration and open raw sockets) and still allow GUI/CLI
507 * components to be run as non-root users. However, since the
508 * control interface can be used to change the network
509 * configuration, this access needs to be protected in many
510 * cases. By default, %wpa_supplicant is configured to use gid
511 * 0 (root). If you want to allow non-root users to use the
512 * control interface, add a new group and change this value to
513 * match with that group. Add users that should have control
514 * interface access to this group.
515 *
516 * When configuring both the directory and group, use following format:
517 * DIR=/var/run/wpa_supplicant GROUP=wheel
518 * DIR=/var/run/wpa_supplicant GROUP=0
519 * (group can be either group name or gid)
520 *
521 * For UDP connections (default on Windows): The value will be ignored.
522 * This variable is just used to select that the control interface is
523 * to be created. The value can be set to, e.g., udp
524 * (ctrl_interface=udp).
525 *
526 * For Windows Named Pipe: This value can be used to set the security
527 * descriptor for controlling access to the control interface. Security
528 * descriptor can be set using Security Descriptor String Format (see
529 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
530 * The descriptor string needs to be prefixed with SDDL=. For example,
531 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
532 * all connections).
533 */
534 char *ctrl_interface;
535
536 /**
537 * ctrl_interface_group - Control interface group (DEPRECATED)
538 *
539 * This variable is only used for backwards compatibility. Group for
540 * UNIX domain sockets should now be specified using GROUP=group in
541 * ctrl_interface variable.
542 */
543 char *ctrl_interface_group;
544
545 /**
546 * fast_reauth - EAP fast re-authentication (session resumption)
547 *
548 * By default, fast re-authentication is enabled for all EAP methods
549 * that support it. This variable can be used to disable fast
550 * re-authentication (by setting fast_reauth=0). Normally, there is no
551 * need to disable fast re-authentication.
552 */
553 int fast_reauth;
554
555 /**
556 * opensc_engine_path - Path to the OpenSSL engine for opensc
557 *
558 * This is an OpenSSL specific configuration option for loading OpenSC
559 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
560 */
561 char *opensc_engine_path;
562
563 /**
564 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
565 *
566 * This is an OpenSSL specific configuration option for loading PKCS#11
567 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
568 */
569 char *pkcs11_engine_path;
570
571 /**
572 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
573 *
574 * This is an OpenSSL specific configuration option for configuring
575 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
576 * module is not loaded.
577 */
578 char *pkcs11_module_path;
579
580 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800581 * openssl_ciphers - OpenSSL cipher string
582 *
583 * This is an OpenSSL specific configuration option for configuring the
584 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
585 * default.
586 */
587 char *openssl_ciphers;
588
589 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700590 * pcsc_reader - PC/SC reader name prefix
591 *
592 * If not %NULL, PC/SC reader with a name that matches this prefix is
593 * initialized for SIM/USIM access. Empty string can be used to match
594 * the first available reader.
595 */
596 char *pcsc_reader;
597
598 /**
599 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
600 *
601 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
602 * EAP-AKA. If left out, this will be asked through control interface.
603 */
604 char *pcsc_pin;
605
606 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -0700607 * external_sim - Use external processing for SIM/USIM operations
608 */
609 int external_sim;
610
611 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700612 * driver_param - Driver interface parameters
613 *
614 * This text string is passed to the selected driver interface with the
615 * optional struct wpa_driver_ops::set_param() handler. This can be
616 * used to configure driver specific options without having to add new
617 * driver interface functionality.
618 */
619 char *driver_param;
620
621 /**
622 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
623 *
624 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
625 * cache (unit: seconds).
626 */
627 unsigned int dot11RSNAConfigPMKLifetime;
628
629 /**
630 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
631 *
632 * dot11 MIB variable for the percentage of the PMK lifetime
633 * that should expire before an IEEE 802.1X reauthentication occurs.
634 */
635 unsigned int dot11RSNAConfigPMKReauthThreshold;
636
637 /**
638 * dot11RSNAConfigSATimeout - Security association timeout
639 *
640 * dot11 MIB variable for the maximum time a security association
641 * shall take to set up (unit: seconds).
642 */
643 unsigned int dot11RSNAConfigSATimeout;
644
645 /**
646 * update_config - Is wpa_supplicant allowed to update configuration
647 *
648 * This variable control whether wpa_supplicant is allow to re-write
649 * its configuration with wpa_config_write(). If this is zero,
650 * configuration data is only changed in memory and the external data
651 * is not overriden. If this is non-zero, wpa_supplicant will update
652 * the configuration data (e.g., a file) whenever configuration is
653 * changed. This update may replace the old configuration which can
654 * remove comments from it in case of a text file configuration.
655 */
656 int update_config;
657
658 /**
659 * blobs - Configuration blobs
660 */
661 struct wpa_config_blob *blobs;
662
663 /**
664 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
665 */
666 u8 uuid[16];
667
668 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700669 * auto_uuid - Automatic UUID behavior
670 * 0 = generate static value based on the local MAC address (default)
671 * 1 = generate a random UUID every time wpa_supplicant starts
672 */
673 int auto_uuid;
674
675 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700676 * device_name - Device Name (WPS)
677 * User-friendly description of device; up to 32 octets encoded in
678 * UTF-8
679 */
680 char *device_name;
681
682 /**
683 * manufacturer - Manufacturer (WPS)
684 * The manufacturer of the device (up to 64 ASCII characters)
685 */
686 char *manufacturer;
687
688 /**
689 * model_name - Model Name (WPS)
690 * Model of the device (up to 32 ASCII characters)
691 */
692 char *model_name;
693
694 /**
695 * model_number - Model Number (WPS)
696 * Additional device description (up to 32 ASCII characters)
697 */
698 char *model_number;
699
700 /**
701 * serial_number - Serial Number (WPS)
702 * Serial number of the device (up to 32 characters)
703 */
704 char *serial_number;
705
706 /**
707 * device_type - Primary Device Type (WPS)
708 */
709 u8 device_type[WPS_DEV_TYPE_LEN];
710
711 /**
712 * config_methods - Config Methods
713 *
714 * This is a space-separated list of supported WPS configuration
715 * methods. For example, "label virtual_display virtual_push_button
716 * keypad".
717 * Available methods: usba ethernet label display ext_nfc_token
718 * int_nfc_token nfc_interface push_button keypad
719 * virtual_display physical_display
720 * virtual_push_button physical_push_button.
721 */
722 char *config_methods;
723
724 /**
725 * os_version - OS Version (WPS)
726 * 4-octet operating system version number
727 */
728 u8 os_version[4];
729
730 /**
731 * country - Country code
732 *
733 * This is the ISO/IEC alpha2 country code for which we are operating
734 * in
735 */
736 char country[2];
737
738 /**
739 * wps_cred_processing - Credential processing
740 *
741 * 0 = process received credentials internally
742 * 1 = do not process received credentials; just pass them over
743 * ctrl_iface to external program(s)
744 * 2 = process received credentials internally and pass them over
745 * ctrl_iface to external program(s)
746 */
747 int wps_cred_processing;
748
Hai Shalom021b0b52019-04-10 11:17:58 -0700749 /**
750 * wps_cred_add_sae - Whether to enable SAE automatically for WPS
751 *
752 * 0 = only add the explicitly listed WPA2-PSK configuration
753 * 1 = add both the WPA2-PSK and SAE configuration and enable PMF so
754 * that the station gets configured in WPA3-Personal transition mode
755 * (supports both WPA2-Personal (PSK) and WPA3-Personal (SAE) APs).
756 */
757 int wps_cred_add_sae;
758
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700759#define MAX_SEC_DEVICE_TYPES 5
760 /**
761 * sec_device_types - Secondary Device Types (P2P)
762 */
763 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
764 int num_sec_device_types;
765
766 int p2p_listen_reg_class;
767 int p2p_listen_channel;
768 int p2p_oper_reg_class;
769 int p2p_oper_channel;
770 int p2p_go_intent;
771 char *p2p_ssid_postfix;
772 int persistent_reconnect;
773 int p2p_intra_bss;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700774 unsigned int num_p2p_pref_chan;
775 struct p2p_channel *p2p_pref_chan;
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700776 struct wpa_freq_range_list p2p_no_go_freq;
777 int p2p_add_cli_chan;
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700778 int p2p_ignore_shared_freq;
Dmitry Shmidt43cb5782014-06-16 16:23:22 -0700779 int p2p_optimize_listen_chan;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700780
781 struct wpabuf *wps_vendor_ext_m1;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700782
783#define MAX_WPS_VENDOR_EXT 10
784 /**
785 * wps_vendor_ext - Vendor extension attributes in WPS
786 */
787 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
788
789 /**
790 * p2p_group_idle - Maximum idle time in seconds for P2P group
791 *
792 * This value controls how long a P2P group is maintained after there
793 * is no other members in the group. As a GO, this means no associated
794 * stations in the group. As a P2P client, this means no GO seen in
795 * scan results. The maximum idle time is specified in seconds with 0
796 * indicating no time limit, i.e., the P2P group remains in active
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800797 * state indefinitely until explicitly removed. As a P2P client, the
798 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
799 * this parameter is mainly meant for GO use and for P2P client, it can
Dmitry Shmidt04949592012-07-19 12:16:46 -0700800 * only be used to reduce the default timeout to smaller value. A
801 * special value -1 can be used to configure immediate removal of the
802 * group for P2P client role on any disconnection after the data
803 * connection has been established.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700804 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700805 int p2p_group_idle;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700806
807 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800808 * p2p_go_freq_change_policy - The GO frequency change policy
809 *
810 * This controls the behavior of the GO when there is a change in the
811 * map of the currently used frequencies in case more than one channel
812 * is supported.
813 *
814 * @P2P_GO_FREQ_MOVE_SCM: Prefer working in a single channel mode if
815 * possible. In case the GO is the only interface using its frequency
816 * and there are other station interfaces on other frequencies, the GO
817 * will migrate to one of these frequencies.
818 *
819 * @P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS: Same as P2P_GO_FREQ_MOVE_SCM,
820 * but a transition is possible only in case one of the other used
821 * frequencies is one of the frequencies in the intersection of the
822 * frequency list of the local device and the peer device.
823 *
824 * @P2P_GO_FREQ_MOVE_STAY: Prefer to stay on the current frequency.
825 *
826 * @P2P_GO_FREQ_MOVE_SCM_ECSA: Same as
827 * P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS but a transition is possible only
828 * if all the group members advertise eCSA support.
829 */
830 enum {
831 P2P_GO_FREQ_MOVE_SCM = 0,
832 P2P_GO_FREQ_MOVE_SCM_PEER_SUPPORTS = 1,
833 P2P_GO_FREQ_MOVE_STAY = 2,
834 P2P_GO_FREQ_MOVE_SCM_ECSA = 3,
835 P2P_GO_FREQ_MOVE_MAX = P2P_GO_FREQ_MOVE_SCM_ECSA,
836 } p2p_go_freq_change_policy;
837
838#define DEFAULT_P2P_GO_FREQ_MOVE P2P_GO_FREQ_MOVE_STAY
839
840 /**
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700841 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
842 *
843 * This parameter controls the length of the random passphrase that is
844 * generated at the GO.
845 */
846 unsigned int p2p_passphrase_len;
847
848 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700849 * bss_max_count - Maximum number of BSS entries to keep in memory
850 */
851 unsigned int bss_max_count;
852
853 /**
854 * bss_expiration_age - BSS entry age after which it can be expired
855 *
856 * This value controls the time in seconds after which a BSS entry
857 * gets removed if it has not been updated or is not in use.
858 */
859 unsigned int bss_expiration_age;
860
861 /**
862 * bss_expiration_scan_count - Expire BSS after number of scans
863 *
864 * If the BSS entry has not been seen in this many scans, it will be
865 * removed. A value of 1 means that entry is removed after the first
866 * scan in which the BSSID is not seen. Larger values can be used
867 * to avoid BSS entries disappearing if they are not visible in
868 * every scan (e.g., low signal quality or interference).
869 */
870 unsigned int bss_expiration_scan_count;
871
872 /**
873 * filter_ssids - SSID-based scan result filtering
874 *
875 * 0 = do not filter scan results
876 * 1 = only include configured SSIDs in scan results/BSS table
877 */
878 int filter_ssids;
879
880 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700881 * filter_rssi - RSSI-based scan result filtering
882 *
883 * 0 = do not filter scan results
884 * -n = filter scan results below -n dBm
885 */
886 int filter_rssi;
887
888 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700889 * max_num_sta - Maximum number of STAs in an AP/P2P GO
890 */
891 unsigned int max_num_sta;
892
893 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -0700894 * ap_isolate - Whether to use client isolation feature
895 *
896 * Client isolation can be used to prevent low-level bridging of
897 * frames between associated stations in the BSS. By default,
898 * this bridging is allowed (ap_isolate=0); except in P2P GO case,
899 * where p2p_intra_bss parameter is used to determine whether to allow
900 * intra-BSS forwarding (ap_isolate = !p2p_intra_bss).
901 *
902 * 0 = do not enable AP isolation
903 * 1 = enable AP isolation
904 */
905 int ap_isolate;
906
907 /**
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700908 * freq_list - Array of allowed scan frequencies or %NULL for all
909 *
910 * This is an optional zero-terminated array of frequencies in
911 * megahertz (MHz) to allow for narrowing scanning range.
912 */
913 int *freq_list;
914
915 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700916 * scan_cur_freq - Whether to scan only the current channel
917 *
918 * If true, attempt to scan only the current channel if any other
919 * VIFs on this radio are already associated on a particular channel.
920 */
921 int scan_cur_freq;
922
923 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700924 * changed_parameters - Bitmap of changed parameters since last update
925 */
926 unsigned int changed_parameters;
927
928 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -0700929 * disassoc_low_ack - Disassociate stations with massive packet loss
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700930 */
931 int disassoc_low_ack;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800932
933 /**
934 * interworking - Whether Interworking (IEEE 802.11u) is enabled
935 */
936 int interworking;
937
938 /**
939 * access_network_type - Access Network Type
940 *
941 * When Interworking is enabled, scans will be limited to APs that
942 * advertise the specified Access Network Type (0..15; with 15
943 * indicating wildcard match).
944 */
945 int access_network_type;
946
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700947 /**
948 * go_interworking - Whether Interworking for P2P GO is enabled
949 */
950 int go_interworking;
951
952 /**
953 * go_access_network_type - P2P GO Access Network Type
954 *
955 * This indicates which access network type to advertise if Interworking
956 * is enabled for P2P GO.
957 */
958 int go_access_network_type;
959
960 /**
961 * go_internet - Interworking: Internet connectivity (0 or 1)
962 */
963 int go_internet;
964
965 /**
966 * go_venue_group - Interworking: Venue group
967 */
968 int go_venue_group;
969
970 /**
971 * go_venue_type: Interworking: Venue type
972 */
973 int go_venue_type;
974
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800975 /**
976 * hessid - Homogenous ESS identifier
977 *
978 * If this is set (any octet is non-zero), scans will be used to
979 * request response only from BSSes belonging to the specified
980 * Homogeneous ESS. This is used only if interworking is enabled.
981 */
982 u8 hessid[ETH_ALEN];
983
984 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700985 * hs20 - Hotspot 2.0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800986 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700987 int hs20;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800988
989 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700990 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
991 *
992 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
993 * by acting as a Registrar and using M1 from the AP. The config
994 * methods attribute in that message is supposed to indicate only the
995 * configuration method supported by the AP in Enrollee role, i.e., to
996 * add an external Registrar. For that case, PBC shall not be used and
997 * as such, the PushButton config method is removed from M1 by default.
998 * If pbc_in_m1=1 is included in the configuration file, the PushButton
999 * config method is left in M1 (if included in config_methods
1000 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
1001 * a label in the AP).
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001002 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001003 int pbc_in_m1;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001004
1005 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001006 * autoscan - Automatic scan parameters or %NULL if none
1007 *
1008 * This is an optional set of parameters for automatic scanning
1009 * within an interface in following format:
1010 * <autoscan module name>:<module parameters>
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001011 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001012 char *autoscan;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001013
1014 /**
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001015 * wps_nfc_pw_from_config - NFC Device Password was read from config
1016 *
1017 * This parameter can be determined whether the NFC Device Password was
1018 * included in the configuration (1) or generated dynamically (0). Only
1019 * the former case is re-written back to the configuration file.
1020 */
1021 int wps_nfc_pw_from_config;
1022
1023 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001024 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001025 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001026 int wps_nfc_dev_pw_id;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001027
1028 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07001029 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001030 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001031 struct wpabuf *wps_nfc_dh_pubkey;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001032
1033 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001034 * wps_nfc_dh_privkey - NFC DH Private Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001035 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001036 struct wpabuf *wps_nfc_dh_privkey;
1037
1038 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001039 * wps_nfc_dev_pw - NFC Device Password for password token
Dmitry Shmidt04949592012-07-19 12:16:46 -07001040 */
1041 struct wpabuf *wps_nfc_dev_pw;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001042
1043 /**
1044 * ext_password_backend - External password backend or %NULL if none
1045 *
1046 * format: <backend name>[:<optional backend parameters>]
1047 */
1048 char *ext_password_backend;
1049
1050 /*
1051 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
1052 *
1053 * This timeout value is used in P2P GO mode to clean up
1054 * inactive stations.
1055 * By default: 300 seconds.
1056 */
1057 int p2p_go_max_inactivity;
1058
1059 struct hostapd_wmm_ac_params wmm_ac_params[4];
1060
1061 /**
1062 * auto_interworking - Whether to use network selection automatically
1063 *
1064 * 0 = do not automatically go through Interworking network selection
1065 * (i.e., require explicit interworking_select command for this)
1066 * 1 = perform Interworking network selection if one or more
1067 * credentials have been configured and scan did not find a
1068 * matching network block
1069 */
1070 int auto_interworking;
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001071
1072 /**
1073 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
1074 *
1075 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1076 * Note that regulatory constraints and driver capabilities are
1077 * consulted anyway, so setting it to 1 can't do real harm.
1078 * By default: 0 (disabled)
1079 */
1080 int p2p_go_ht40;
1081
1082 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -07001083 * p2p_go_vht - Default mode for VHT enable when operating as GO
1084 *
1085 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1086 * Note that regulatory constraints and driver capabilities are
1087 * consulted anyway, so setting it to 1 can't do real harm.
1088 * By default: 0 (disabled)
1089 */
1090 int p2p_go_vht;
1091
1092 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08001093 * p2p_go_he - Default mode for 11ax HE enable when operating as GO
1094 *
1095 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
1096 * Note that regulatory constraints and driver capabilities are
1097 * consulted anyway, so setting it to 1 can't do real harm.
1098 * By default: 0 (disabled)
1099 */
1100 int p2p_go_he;
1101
1102 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001103 * p2p_go_ctwindow - CTWindow to use when operating as GO
1104 *
1105 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
1106 * the length of the CTWindow in TUs.
1107 */
1108 int p2p_go_ctwindow;
1109
1110 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001111 * p2p_disabled - Whether P2P operations are disabled for this interface
1112 */
1113 int p2p_disabled;
1114
1115 /**
1116 * p2p_no_group_iface - Whether group interfaces can be used
1117 *
1118 * By default, wpa_supplicant will create a separate interface for P2P
1119 * group operations if the driver supports this. This functionality can
1120 * be disabled by setting this parameter to 1. In that case, the same
1121 * interface that was used for the P2P management operations is used
1122 * also for the group operation.
1123 */
1124 int p2p_no_group_iface;
1125
1126 /**
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07001127 * p2p_cli_probe - Enable/disable P2P CLI probe request handling
1128 *
1129 * If this parameter is set to 1, a connected P2P Client will receive
1130 * and handle Probe Request frames. Setting this parameter to 0
1131 * disables this option. Default value: 0.
1132 *
1133 * Note: Setting this property at run time takes effect on the following
1134 * interface state transition to/from the WPA_COMPLETED state.
1135 */
1136 int p2p_cli_probe;
1137
1138 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001139 * okc - Whether to enable opportunistic key caching by default
1140 *
1141 * By default, OKC is disabled unless enabled by the per-network
1142 * proactive_key_caching=1 parameter. okc=1 can be used to change this
1143 * default behavior.
1144 */
1145 int okc;
1146
1147 /**
1148 * pmf - Whether to enable/require PMF by default
1149 *
1150 * By default, PMF is disabled unless enabled by the per-network
1151 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001152 * this default behavior for RSN network (this is not applicable for
1153 * non-RSN cases).
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001154 */
1155 enum mfp_options pmf;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001156
1157 /**
1158 * sae_groups - Preference list of enabled groups for SAE
1159 *
1160 * By default (if this parameter is not set), the mandatory group 19
1161 * (ECC group defined over a 256-bit prime order field) is preferred,
1162 * but other groups are also enabled. If this parameter is set, the
1163 * groups will be tried in the indicated order.
1164 */
1165 int *sae_groups;
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -08001166
1167 /**
1168 * dtim_period - Default DTIM period in Beacon intervals
1169 *
1170 * This parameter can be used to set the default value for network
1171 * blocks that do not specify dtim_period.
1172 */
1173 int dtim_period;
1174
1175 /**
1176 * beacon_int - Default Beacon interval in TU
1177 *
1178 * This parameter can be used to set the default value for network
1179 * blocks that do not specify beacon_int.
1180 */
1181 int beacon_int;
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -07001182
1183 /**
1184 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1185 *
1186 * This parameter can be used to define additional vendor specific
1187 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1188 * format for these element(s) is a hexdump of the raw information
1189 * elements (id+len+payload for one or more elements).
1190 */
1191 struct wpabuf *ap_vendor_elements;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001192
1193 /**
1194 * ignore_old_scan_res - Ignore scan results older than request
1195 *
1196 * The driver may have a cache of scan results that makes it return
1197 * information that is older than our scan trigger. This parameter can
1198 * be used to configure such old information to be ignored instead of
1199 * allowing it to update the internal BSS table.
1200 */
1201 int ignore_old_scan_res;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -07001202
1203 /**
1204 * sched_scan_interval - schedule scan interval
1205 */
1206 unsigned int sched_scan_interval;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001207
1208 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001209 * sched_scan_start_delay - Schedule scan start delay before first scan
1210 *
1211 * Delay (in seconds) before scheduling first scan plan cycle. The
1212 * driver may ignore this parameter and start immediately (or at any
1213 * other time), if this feature is not supported.
1214 */
1215 unsigned int sched_scan_start_delay;
1216
1217 /**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001218 * tdls_external_control - External control for TDLS setup requests
1219 *
1220 * Enable TDLS mode where external programs are given the control
1221 * to specify the TDLS link to get established to the driver. The
1222 * driver requests the TDLS setup to the supplicant only for the
1223 * specified TDLS peers.
1224 */
1225 int tdls_external_control;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001226
1227 u8 ip_addr_go[4];
1228 u8 ip_addr_mask[4];
1229 u8 ip_addr_start[4];
1230 u8 ip_addr_end[4];
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001231
1232 /**
1233 * osu_dir - OSU provider information directory
1234 *
1235 * If set, allow FETCH_OSU control interface command to be used to fetch
1236 * OSU provider information into all APs and store the results in this
1237 * directory.
1238 */
1239 char *osu_dir;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001240
1241 /**
1242 * wowlan_triggers - Wake-on-WLAN triggers
1243 *
1244 * If set, these wowlan triggers will be configured.
1245 */
1246 char *wowlan_triggers;
Dmitry Shmidt09f57ba2014-06-10 16:07:13 -07001247
1248 /**
1249 * p2p_search_delay - Extra delay between concurrent search iterations
1250 *
1251 * Add extra delay (in milliseconds) between search iterations when
1252 * there is a concurrent operation to make p2p_find friendlier to
1253 * concurrent operations by avoiding it from taking 100% of radio
1254 * resources.
1255 */
1256 unsigned int p2p_search_delay;
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07001257
1258 /**
1259 * mac_addr - MAC address policy default
1260 *
1261 * 0 = use permanent MAC address
1262 * 1 = use random MAC address for each ESS connection
1263 * 2 = like 1, but maintain OUI (with local admin bit set)
1264 *
1265 * By default, permanent MAC address is used unless policy is changed by
1266 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1267 * change this default behavior.
1268 */
1269 int mac_addr;
1270
1271 /**
1272 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1273 */
1274 unsigned int rand_addr_lifetime;
1275
1276 /**
1277 * preassoc_mac_addr - Pre-association MAC address policy
1278 *
1279 * 0 = use permanent MAC address
1280 * 1 = use random MAC address
1281 * 2 = like 1, but maintain OUI (with local admin bit set)
1282 */
1283 int preassoc_mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001284
1285 /**
1286 * key_mgmt_offload - Use key management offload
1287 *
1288 * Key management offload should be used if the device supports it.
1289 * Key management offload is the capability of a device operating as
1290 * a station to do the exchange necessary to establish temporal keys
1291 * during initial RSN connection, after roaming, or during a PTK
1292 * rekeying operation.
1293 */
1294 int key_mgmt_offload;
1295
1296 /**
1297 * user_mpm - MPM residency
1298 *
1299 * 0: MPM lives in driver.
1300 * 1: wpa_supplicant handles peering and station allocation.
1301 *
1302 * If AMPE or SAE is enabled, the MPM is always in userspace.
1303 */
1304 int user_mpm;
1305
1306 /**
1307 * max_peer_links - Maximum number of peer links
1308 *
1309 * Maximum number of mesh peering currently maintained by the STA.
1310 */
1311 int max_peer_links;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001312
1313 /**
1314 * cert_in_cb - Whether to include a peer certificate dump in events
1315 *
1316 * This controls whether peer certificates for authentication server and
1317 * its certificate chain are included in EAP peer certificate events.
1318 */
1319 int cert_in_cb;
1320
1321 /**
1322 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1323 *
1324 * This timeout value is used in mesh STA to clean up inactive stations.
1325 * By default: 300 seconds.
1326 */
1327 int mesh_max_inactivity;
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001328
1329 /**
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001330 * dot11RSNASAERetransPeriod - Timeout to retransmit SAE Auth frame
1331 *
1332 * This timeout value is used in mesh STA to retransmit
1333 * SAE Authentication frame.
1334 * By default: 1000 milliseconds.
1335 */
1336 int dot11RSNASAERetransPeriod;
1337
1338 /**
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001339 * passive_scan - Whether to force passive scan for network connection
1340 *
1341 * This parameter can be used to force only passive scanning to be used
1342 * for network connection cases. It should be noted that this will slow
1343 * down scan operations and reduce likelihood of finding the AP. In
1344 * addition, some use cases will override this due to functional
1345 * requirements, e.g., for finding an AP that uses hidden SSID
1346 * (scan_ssid=1) or P2P device discovery.
1347 */
1348 int passive_scan;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001349
1350 /**
1351 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1352 */
1353 int reassoc_same_bss_optim;
Dmitry Shmidt7a53dbb2015-06-11 13:13:53 -07001354
1355 /**
1356 * wps_priority - Priority for the networks added through WPS
1357 *
1358 * This priority value will be set to each network profile that is added
1359 * by executing the WPS protocol.
1360 */
1361 int wps_priority;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001362
1363 /**
1364 * fst_group_id - FST group ID
1365 */
1366 char *fst_group_id;
1367
1368 /**
1369 * fst_priority - priority of the interface within the FST group
1370 */
1371 int fst_priority;
1372
1373 /**
1374 * fst_llt - default FST LLT (Link-Lost Timeout) to be used for the
1375 * interface.
1376 */
1377 int fst_llt;
1378
1379 /**
1380 * wpa_rsc_relaxation - RSC relaxation on GTK installation
1381 *
1382 * Values:
1383 * 0 - use the EAPOL-Key RSC value on GTK installation
1384 * 1 - use the null RSC if a bogus RSC value is detected in message 3
1385 * of 4-Way Handshake or message 1 of Group Key Handshake.
1386 */
1387 int wpa_rsc_relaxation;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001388
1389 /**
1390 * sched_scan_plans - Scan plans for scheduled scan
1391 *
1392 * Each scan plan specifies the interval between scans and the number of
1393 * iterations. The last scan plan only specifies the scan interval and
1394 * will be run infinitely.
1395 *
1396 * format: <interval:iterations> <interval2:iterations2> ... <interval>
1397 */
1398 char *sched_scan_plans;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001399
1400#ifdef CONFIG_MBO
1401 /**
1402 * non_pref_chan - Non-preferred channels list, separated by spaces.
1403 *
1404 * format: op_class:chan:preference:reason<:detail>
1405 * Detail is optional.
1406 */
1407 char *non_pref_chan;
1408
1409 /**
1410 * mbo_cell_capa - Cellular capabilities for MBO
1411 */
1412 enum mbo_cellular_capa mbo_cell_capa;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001413
1414 /**
1415 * disassoc_imminent_rssi_threshold - RSSI threshold of candidate AP
1416 * when disassociation imminent is set.
1417 */
1418 int disassoc_imminent_rssi_threshold;
1419
1420 /**
1421 * oce - Enable OCE in STA and/or STA-CFON mode
1422 * - Set BIT(0) to enable OCE in non-AP STA mode
1423 * - Set BIT(1) to enable OCE in STA-CFON mode
1424 */
1425 unsigned int oce;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001426#endif /* CONFIG_MBO */
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07001427
1428 /**
1429 * gas_address3 - GAS Address3 field behavior
1430 *
1431 * Values:
1432 * 0 - P2P specification (Address3 = AP BSSID)
1433 * 1 = IEEE 802.11 standard compliant (Address3 = Wildcard BSSID when
1434 * sent to not-associated AP; if associated, AP BSSID)
1435 */
1436 int gas_address3;
Dmitry Shmidt7d175302016-09-06 13:11:34 -07001437
1438 /**
1439 * ftm_responder - Publish FTM (fine timing measurement)
1440 * responder functionality
1441 *
1442 * Values:
1443 * 0 - do not publish FTM responder functionality (Default)
1444 * 1 - publish FTM responder functionality in
1445 * bit 70 of Extended Capabilities element
1446 * Note, actual FTM responder operation is managed outside
1447 * wpa_supplicant.
1448 */
1449 int ftm_responder;
1450
1451 /**
1452 * ftm_initiator - Publish FTM (fine timing measurement)
1453 * initiator functionality
1454 *
1455 * Values:
1456 * 0 - do not publish FTM initiator functionality (Default)
1457 * 1 - publish FTM initiator functionality in
1458 * bit 71 of Extended Capabilities element
1459 * Note, actual FTM initiator operation is managed outside
1460 * wpa_supplicant.
1461 */
1462 int ftm_initiator;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001463
1464 /**
1465 * gas_rand_addr_lifetime - Lifetime of random MAC address for ANQP in
1466 * seconds
1467 */
1468 unsigned int gas_rand_addr_lifetime;
1469
1470 /**
1471 * gas_rand_mac_addr - GAS MAC address policy
1472 *
1473 * 0 = use permanent MAC address
1474 * 1 = use random MAC address
1475 * 2 = like 1, but maintain OUI (with local admin bit set)
1476 */
1477 int gas_rand_mac_addr;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001478
1479 /**
1480 * dpp_config_processing - How to process DPP configuration
1481 *
1482 * 0 = report received configuration to an external program for
1483 * processing; do not generate any network profile internally
1484 * 1 = report received configuration to an external program and generate
1485 * a network profile internally, but do not automatically connect
1486 * to the created (disabled) profile; the network profile id is
1487 * reported to external programs
1488 * 2 = report received configuration to an external program, generate
1489 * a network profile internally, try to connect to the created
1490 * profile automatically
1491 */
1492 int dpp_config_processing;
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001493
1494 /**
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001495 * coloc_intf_reporting - Colocated interference reporting
1496 *
1497 * dot11CoLocIntfReportingActivated
1498 * 0 = disabled (false)
1499 * 1 = enabled (true)
1500 */
1501 int coloc_intf_reporting;
1502
1503 /**
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001504 * p2p_device_random_mac_addr - P2P Device MAC address policy default
1505 *
1506 * 0 = use permanent MAC address
Hai Shalom74f70d42019-02-11 14:42:39 -08001507 * 1 = use random MAC address on creating the interface if there is no
1508 * persistent groups.
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001509 *
1510 * By default, permanent MAC address is used.
1511 */
1512 int p2p_device_random_mac_addr;
1513
1514 /**
1515 * p2p_device_persistent_mac_addr - Record last used MAC address
1516 *
Hai Shalom74f70d42019-02-11 14:42:39 -08001517 * If there are saved persistent groups, P2P cannot generate another
1518 * random MAC address, and need to restore to last used MAC address.
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001519 */
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001520 u8 p2p_device_persistent_mac_addr[ETH_ALEN];
Jimmy Chenf887c7b2018-11-13 15:19:57 +08001521
Jimmy Chen36c21992018-11-29 16:46:43 +08001522 /**
1523 * p2p_interface_random_mac_addr - P2P Interface MAC address policy default
1524 *
1525 * 0 = use permanent MAC address
1526 * 1 = use random MAC address on creating the interface.
1527 *
1528 * By default, permanent MAC address is used.
1529 */
1530 int p2p_interface_random_mac_addr;
1531
xshud0ee72f2018-11-08 14:37:01 -08001532 /**
1533 * bss_no_flush_when_down - Whether to flush BSS entries when the interface is disabled
1534 *
1535 * 0 = Flush BSS entries when the interface becomes disabled (Default)
1536 * 1 = Do not flush BSS entries when the interface becomes disabled
1537 */
1538 int bss_no_flush_when_down;
Hai Shalom81f62d82019-07-22 12:10:00 -07001539
1540 /**
1541 * disable_btm - Disable BSS transition management in STA
1542 * - Set to 0 to enable BSS transition management
1543 * - Set to 1 to disable BSS transition management
1544 *
1545 * By default BSS transition management is enabled
1546 */
1547 int disable_btm;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001548};
1549
1550
1551/* Prototypes for common functions from config.c */
1552
1553void wpa_config_free(struct wpa_config *ssid);
1554void wpa_config_free_ssid(struct wpa_ssid *ssid);
1555void wpa_config_foreach_network(struct wpa_config *config,
1556 void (*func)(void *, struct wpa_ssid *),
1557 void *arg);
1558struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1559struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1560int wpa_config_remove_network(struct wpa_config *config, int id);
1561void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1562int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1563 int line);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001564int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1565 const char *value);
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001566int wpa_config_dump_values(struct wpa_config *config, char *buf,
1567 size_t buflen);
1568int wpa_config_get_value(const char *name, struct wpa_config *config,
1569 char *buf, size_t buflen);
1570
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001571char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1572char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1573char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1574void wpa_config_update_psk(struct wpa_ssid *ssid);
1575int wpa_config_add_prio_network(struct wpa_config *config,
1576 struct wpa_ssid *ssid);
1577int wpa_config_update_prio_list(struct wpa_config *config);
1578const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1579 const char *name);
1580void wpa_config_set_blob(struct wpa_config *config,
1581 struct wpa_config_blob *blob);
1582void wpa_config_free_blob(struct wpa_config_blob *blob);
1583int wpa_config_remove_blob(struct wpa_config *config, const char *name);
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001584void wpa_config_flush_blobs(struct wpa_config *config);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001585
Dmitry Shmidt04949592012-07-19 12:16:46 -07001586struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1587struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1588int wpa_config_remove_cred(struct wpa_config *config, int id);
1589void wpa_config_free_cred(struct wpa_cred *cred);
1590int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1591 const char *value, int line);
Dmitry Shmidt0cfd5f72014-04-04 14:48:05 -07001592char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
Dmitry Shmidt04949592012-07-19 12:16:46 -07001593
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001594struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1595 const char *driver_param);
1596#ifndef CONFIG_NO_STDOUT_DEBUG
1597void wpa_config_debug_dump_networks(struct wpa_config *config);
1598#else /* CONFIG_NO_STDOUT_DEBUG */
1599#define wpa_config_debug_dump_networks(c) do { } while (0)
1600#endif /* CONFIG_NO_STDOUT_DEBUG */
1601
1602
1603/* Prototypes for common functions from config.c */
1604int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1605
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001606int wpa_config_get_num_global_field_names(void);
1607
1608const char * wpa_config_get_global_field_name(unsigned int i, int *no_var);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001609
1610/* Prototypes for backend specific functions from the selected config_*.c */
1611
1612/**
1613 * wpa_config_read - Read and parse configuration database
1614 * @name: Name of the configuration (e.g., path and file name for the
1615 * configuration file)
Jouni Malinen5d1c8ad2013-04-23 12:34:56 -07001616 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001617 * Returns: Pointer to allocated configuration data or %NULL on failure
1618 *
1619 * This function reads configuration data, parses its contents, and allocates
1620 * data structures needed for storing configuration information. The allocated
1621 * data can be freed with wpa_config_free().
1622 *
1623 * Each configuration backend needs to implement this function.
1624 */
Dmitry Shmidt64f47c52013-04-16 10:41:54 -07001625struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001626
1627/**
1628 * wpa_config_write - Write or update configuration data
1629 * @name: Name of the configuration (e.g., path and file name for the
1630 * configuration file)
1631 * @config: Configuration data from wpa_config_read()
1632 * Returns: 0 on success, -1 on failure
1633 *
1634 * This function write all configuration data into an external database (e.g.,
1635 * a text file) in a format that can be read with wpa_config_read(). This can
1636 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1637 * new network is added or a password is changed.
1638 *
1639 * Each configuration backend needs to implement this function.
1640 */
1641int wpa_config_write(const char *name, struct wpa_config *config);
1642
1643#endif /* CONFIG_H */