]> git.ipfire.org Git - thirdparty/hostap.git/blame - wpa_supplicant/config.h
P2P: Add rx_freq parameter to Probe Request frame handler
[thirdparty/hostap.git] / wpa_supplicant / config.h
CommitLineData
6fc6879b
JM
1/*
2 * WPA Supplicant / Configuration file structures
f64adcd7 3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
6fc6879b 4 *
0f3d578e
JM
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
6fc6879b
JM
7 */
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 */
e45e8989 18#define DEFAULT_USER_MPM 1
4b409368 19#define DEFAULT_MAX_PEER_LINKS 99
5a2a6de6 20#define DEFAULT_MESH_MAX_INACTIVITY 300
6fc6879b 21#define DEFAULT_FAST_REAUTH 1
e3768e7c 22#define DEFAULT_P2P_GO_INTENT 7
0f66abd2 23#define DEFAULT_P2P_INTRA_BSS 1
462a7439 24#define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
e3bd6e9d 25#define DEFAULT_P2P_OPTIMIZE_LISTEN_CHAN 0
c9c38b09 26#define DEFAULT_BSS_MAX_COUNT 200
78633c37
SL
27#define DEFAULT_BSS_EXPIRATION_AGE 180
28#define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
dae608d5 29#define DEFAULT_MAX_NUM_STA 128
11540c0b 30#define DEFAULT_ACCESS_NETWORK_TYPE 15
6124e858 31#define DEFAULT_SCAN_CUR_FREQ 0
d3b20469 32#define DEFAULT_P2P_SEARCH_DELAY 500
c267753b 33#define DEFAULT_RAND_ADDR_LIFETIME 60
b41f2684 34#define DEFAULT_KEY_MGMT_OFFLOAD 1
483dd6a5 35#define DEFAULT_CERT_IN_CB 1
0b8bcaa5 36#define DEFAULT_P2P_GO_CTWINDOW 0
6fc6879b
JM
37
38#include "config_ssid.h"
2f646b6e 39#include "wps/wps.h"
eaa8eefe 40#include "common/ieee802_11_defs.h"
c26effe1 41#include "common/ieee802_11_common.h"
6fc6879b
JM
42
43
1bb7b8e8
JM
44struct wpa_cred {
45 /**
46 * next - Next credential in the list
47 *
48 * This pointer can be used to iterate over all credentials. The head
49 * of this list is stored in the cred field of struct wpa_config.
50 */
51 struct wpa_cred *next;
52
53 /**
54 * id - Unique id for the credential
55 *
56 * This identifier is used as a unique identifier for each credential
57 * block when using the control interface. Each credential is allocated
58 * an id when it is being created, either when reading the
59 * configuration file or when a new credential is added through the
60 * control interface.
61 */
62 int id;
63
03ed3324
JM
64 /**
65 * temporary - Whether this credential is temporary and not to be saved
66 */
67 int temporary;
68
1a712d2f
JM
69 /**
70 * priority - Priority group
71 *
72 * By default, all networks and credentials get the same priority group
73 * (0). This field can be used to give higher priority for credentials
74 * (and similarly in struct wpa_ssid for network blocks) to change the
75 * Interworking automatic networking selection behavior. The matching
76 * network (based on either an enabled network block or a credential)
77 * with the highest priority value will be selected.
78 */
79 int priority;
80
d7b01abd
JM
81 /**
82 * pcsc - Use PC/SC and SIM/USIM card
83 */
84 int pcsc;
85
1bb7b8e8
JM
86 /**
87 * realm - Home Realm for Interworking
88 */
89 char *realm;
90
91 /**
92 * username - Username for Interworking network selection
93 */
94 char *username;
95
96 /**
97 * password - Password for Interworking network selection
98 */
99 char *password;
100
02af9c90
JM
101 /**
102 * ext_password - Whether password is a name for external storage
103 */
104 int ext_password;
105
1bb7b8e8
JM
106 /**
107 * ca_cert - CA certificate for Interworking network selection
108 */
109 char *ca_cert;
110
11e4f46a
JM
111 /**
112 * client_cert - File path to client certificate file (PEM/DER)
113 *
114 * This field is used with Interworking networking selection for a case
115 * where client certificate/private key is used for authentication
116 * (EAP-TLS). Full path to the file should be used since working
117 * directory may change when wpa_supplicant is run in the background.
118 *
119 * Alternatively, a named configuration blob can be used by setting
120 * this to blob://blob_name.
121 */
122 char *client_cert;
123
124 /**
125 * private_key - File path to client private key file (PEM/DER/PFX)
126 *
127 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
128 * commented out. Both the private key and certificate will be read
129 * from the PKCS#12 file in this case. Full path to the file should be
130 * used since working directory may change when wpa_supplicant is run
131 * in the background.
132 *
133 * Windows certificate store can be used by leaving client_cert out and
134 * configuring private_key in one of the following formats:
135 *
136 * cert://substring_to_match
137 *
138 * hash://certificate_thumbprint_in_hex
139 *
140 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
141 *
142 * Note that when running wpa_supplicant as an application, the user
143 * certificate store (My user account) is used, whereas computer store
144 * (Computer account) is used when running wpasvc as a service.
145 *
146 * Alternatively, a named configuration blob can be used by setting
147 * this to blob://blob_name.
148 */
149 char *private_key;
150
151 /**
152 * private_key_passwd - Password for private key file
153 */
154 char *private_key_passwd;
155
1bb7b8e8
JM
156 /**
157 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
158 */
159 char *imsi;
160
161 /**
162 * milenage - Milenage parameters for SIM/USIM simulator in
163 * <Ki>:<OPc>:<SQN> format
164 */
165 char *milenage;
166
ac1bc549
JM
167 /**
168 * domain_suffix_match - Constraint for server domain name
169 *
170 * If set, this FQDN is used as a suffix match requirement for the AAA
171 * server certificate in SubjectAltName dNSName element(s). If a
172 * matching dNSName is found, this constraint is met. If no dNSName
e24aef10 173 * values are present, this constraint is matched against SubjectName CN
ac1bc549
JM
174 * using same suffix match comparison. Suffix match here means that the
175 * host/domain name is compared one label at a time starting from the
176 * top-level domain and all the labels in @domain_suffix_match shall be
177 * included in the certificate. The certificate may include additional
178 * sub-level labels in addition to the required labels.
179 *
180 * For example, domain_suffix_match=example.com would match
181 * test.example.com but would not match test-example.com.
182 */
183 char *domain_suffix_match;
184
1bb7b8e8 185 /**
463c8ffb 186 * domain - Home service provider FQDN(s)
1bb7b8e8
JM
187 *
188 * This is used to compare against the Domain Name List to figure out
463c8ffb
JM
189 * whether the AP is operated by the Home SP. Multiple domain entries
190 * can be used to configure alternative FQDNs that will be considered
191 * home networks.
1bb7b8e8 192 */
463c8ffb
JM
193 char **domain;
194
195 /**
196 * num_domain - Number of FQDNs in the domain array
197 */
198 size_t num_domain;
8ca93c59 199
955567bc
JM
200 /**
201 * roaming_consortium - Roaming Consortium OI
202 *
203 * If roaming_consortium_len is non-zero, this field contains the
204 * Roaming Consortium OI that can be used to determine which access
205 * points support authentication with this credential. This is an
206 * alternative to the use of the realm parameter. When using Roaming
207 * Consortium to match the network, the EAP parameters need to be
208 * pre-configured with the credential since the NAI Realm information
209 * may not be available or fetched.
210 */
211 u8 roaming_consortium[15];
212
213 /**
214 * roaming_consortium_len - Length of roaming_consortium
215 */
216 size_t roaming_consortium_len;
217
f47c1452
JM
218 u8 required_roaming_consortium[15];
219 size_t required_roaming_consortium_len;
220
8ca93c59
JM
221 /**
222 * eap_method - EAP method to use
223 *
224 * Pre-configured EAP method to use with this credential or %NULL to
225 * indicate no EAP method is selected, i.e., the method will be
226 * selected automatically based on ANQP information.
227 */
228 struct eap_method_type *eap_method;
229
230 /**
231 * phase1 - Phase 1 (outer authentication) parameters
232 *
233 * Pre-configured EAP parameters or %NULL.
234 */
235 char *phase1;
236
237 /**
238 * phase2 - Phase 2 (inner authentication) parameters
239 *
240 * Pre-configured EAP parameters or %NULL.
241 */
242 char *phase2;
dbea8ac7
JM
243
244 struct excluded_ssid {
eaa8eefe 245 u8 ssid[SSID_MAX_LEN];
dbea8ac7
JM
246 size_t ssid_len;
247 } *excluded_ssid;
248 size_t num_excluded_ssid;
bc00053c
JM
249
250 struct roaming_partner {
251 char fqdn[128];
252 int exact_match;
253 u8 priority;
254 char country[3];
255 } *roaming_partner;
256 size_t num_roaming_partner;
f9cd147d
JM
257
258 int update_identifier;
aa26ba68
JM
259
260 /**
261 * provisioning_sp - FQDN of the SP that provisioned the credential
262 */
263 char *provisioning_sp;
4cad9df1 264
74794891
JM
265 /**
266 * sp_priority - Credential priority within a provisioning SP
267 *
268 * This is the priority of the credential among all credentials
269 * provisionined by the same SP (i.e., for entries that have identical
270 * provisioning_sp value). The range of this priority is 0-255 with 0
271 * being the highest and 255 the lower priority.
272 */
273 int sp_priority;
274
4cad9df1
JM
275 unsigned int min_dl_bandwidth_home;
276 unsigned int min_ul_bandwidth_home;
277 unsigned int min_dl_bandwidth_roaming;
278 unsigned int min_ul_bandwidth_roaming;
a45b2dc5
JM
279
280 /**
281 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
282 * This value is used as the maximum channel utilization for network
283 * selection purposes for home networks. If the AP does not advertise
284 * BSS Load or if the limit would prevent any connection, this
285 * constraint will be ignored.
286 */
287 unsigned int max_bss_load;
33fb8c52
JM
288
289 unsigned int num_req_conn_capab;
290 u8 *req_conn_capab_proto;
291 int **req_conn_capab_port;
cf6d08a6
JM
292
293 /**
294 * ocsp - Whether to use/require OCSP to check server certificate
295 *
296 * 0 = do not use OCSP stapling (TLS certificate status extension)
297 * 1 = try to use OCSP stapling, but not require response
298 * 2 = require valid OCSP stapling response
299 */
300 int ocsp;
13f6a07e
NJ
301
302 /**
303 * sim_num - User selected SIM identifier
304 *
305 * This variable is used for identifying which SIM is used if the system
306 * has more than one.
307 */
308 int sim_num;
1bb7b8e8
JM
309};
310
311
1d47214a
JM
312#define CFG_CHANGED_DEVICE_NAME BIT(0)
313#define CFG_CHANGED_CONFIG_METHODS BIT(1)
314#define CFG_CHANGED_DEVICE_TYPE BIT(2)
315#define CFG_CHANGED_OS_VERSION BIT(3)
316#define CFG_CHANGED_UUID BIT(4)
317#define CFG_CHANGED_COUNTRY BIT(5)
e3768e7c
JM
318#define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
319#define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
1c9cb49f 320#define CFG_CHANGED_WPS_STRING BIT(8)
0f66abd2 321#define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
f95cac27 322#define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
2463ba70
JS
323#define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
324#define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
21d996f7 325#define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
306ae225 326#define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
042ec551 327#define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
1b928f96 328#define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
1d47214a 329
6fc6879b
JM
330/**
331 * struct wpa_config - wpa_supplicant configuration data
332 *
333 * This data structure is presents the per-interface (radio) configuration
334 * data. In many cases, there is only one struct wpa_config instance, but if
335 * more than one network interface is being controlled, one instance is used
336 * for each.
337 */
338struct wpa_config {
339 /**
340 * ssid - Head of the global network list
341 *
342 * This is the head for the list of all the configured networks.
343 */
344 struct wpa_ssid *ssid;
345
346 /**
347 * pssid - Per-priority network lists (in priority order)
348 */
349 struct wpa_ssid **pssid;
350
351 /**
352 * num_prio - Number of different priorities used in the pssid lists
353 *
354 * This indicates how many per-priority network lists are included in
355 * pssid.
356 */
357 int num_prio;
358
1bb7b8e8
JM
359 /**
360 * cred - Head of the credential list
361 *
362 * This is the head for the list of all the configured credentials.
363 */
364 struct wpa_cred *cred;
365
6fc6879b
JM
366 /**
367 * eapol_version - IEEE 802.1X/EAPOL version number
368 *
369 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
370 * defines EAPOL version 2. However, there are many APs that do not
371 * handle the new version number correctly (they seem to drop the
372 * frames completely). In order to make wpa_supplicant interoperate
373 * with these APs, the version number is set to 1 by default. This
374 * configuration value can be used to set it to the new version (2).
375 */
376 int eapol_version;
377
378 /**
379 * ap_scan - AP scanning/selection
380 *
381 * By default, wpa_supplicant requests driver to perform AP
382 * scanning and then uses the scan results to select a
383 * suitable AP. Another alternative is to allow the driver to
384 * take care of AP scanning and selection and use
385 * wpa_supplicant just to process EAPOL frames based on IEEE
386 * 802.11 association information from the driver.
387 *
388 * 1: wpa_supplicant initiates scanning and AP selection (default).
389 *
390 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
391 * association parameters (e.g., WPA IE generation); this mode can
392 * also be used with non-WPA drivers when using IEEE 802.1X mode;
393 * do not try to associate with APs (i.e., external program needs
394 * to control association). This mode must also be used when using
395 * wired Ethernet drivers.
396 *
397 * 2: like 0, but associate with APs using security policy and SSID
398 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
399 * drivers to enable operation with hidden SSIDs and optimized roaming;
400 * in this mode, the network blocks in the configuration are tried
401 * one by one until the driver reports successful association; each
402 * network block should have explicit security policy (i.e., only one
403 * option in the lists) for key_mgmt, pairwise, group, proto variables.
404 */
405 int ap_scan;
406
31392709
HD
407 /**
408 * bgscan - Background scan and roaming parameters or %NULL if none
409 *
410 * This is an optional set of parameters for background scanning and
411 * roaming within a network (ESS). For more detailed information see
412 * ssid block documentation.
413 *
414 * The variable defines default bgscan behavior for all BSS station
415 * networks except for those which have their own bgscan configuration.
416 */
417 char *bgscan;
418
54ddd743
JM
419 /**
420 * disable_scan_offload - Disable automatic offloading of scan requests
421 *
422 * By default, %wpa_supplicant tries to offload scanning if the driver
423 * indicates support for this (sched_scan). This configuration
424 * parameter can be used to disable this offloading mechanism.
425 */
426 int disable_scan_offload;
427
6fc6879b
JM
428 /**
429 * ctrl_interface - Parameters for the control interface
430 *
431 * If this is specified, %wpa_supplicant will open a control interface
432 * that is available for external programs to manage %wpa_supplicant.
433 * The meaning of this string depends on which control interface
ffbf1eaa 434 * mechanism is used. For all cases, the existence of this parameter
6fc6879b
JM
435 * in configuration is used to determine whether the control interface
436 * is enabled.
437 *
438 * For UNIX domain sockets (default on Linux and BSD): This is a
439 * directory that will be created for UNIX domain sockets for listening
440 * to requests from external programs (CLI/GUI, etc.) for status
441 * information and configuration. The socket file will be named based
442 * on the interface name, so multiple %wpa_supplicant processes can be
443 * run at the same time if more than one interface is used.
444 * /var/run/wpa_supplicant is the recommended directory for sockets and
445 * by default, wpa_cli will use it when trying to connect with
446 * %wpa_supplicant.
447 *
448 * Access control for the control interface can be configured
449 * by setting the directory to allow only members of a group
450 * to use sockets. This way, it is possible to run
451 * %wpa_supplicant as root (since it needs to change network
452 * configuration and open raw sockets) and still allow GUI/CLI
453 * components to be run as non-root users. However, since the
454 * control interface can be used to change the network
455 * configuration, this access needs to be protected in many
456 * cases. By default, %wpa_supplicant is configured to use gid
457 * 0 (root). If you want to allow non-root users to use the
458 * control interface, add a new group and change this value to
459 * match with that group. Add users that should have control
460 * interface access to this group.
461 *
462 * When configuring both the directory and group, use following format:
463 * DIR=/var/run/wpa_supplicant GROUP=wheel
464 * DIR=/var/run/wpa_supplicant GROUP=0
465 * (group can be either group name or gid)
466 *
467 * For UDP connections (default on Windows): The value will be ignored.
468 * This variable is just used to select that the control interface is
469 * to be created. The value can be set to, e.g., udp
470 * (ctrl_interface=udp).
471 *
472 * For Windows Named Pipe: This value can be used to set the security
473 * descriptor for controlling access to the control interface. Security
474 * descriptor can be set using Security Descriptor String Format (see
475 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
476 * The descriptor string needs to be prefixed with SDDL=. For example,
477 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
478 * all connections).
479 */
480 char *ctrl_interface;
481
482 /**
483 * ctrl_interface_group - Control interface group (DEPRECATED)
484 *
485 * This variable is only used for backwards compatibility. Group for
b39d1280 486 * UNIX domain sockets should now be specified using GROUP=group in
6fc6879b
JM
487 * ctrl_interface variable.
488 */
489 char *ctrl_interface_group;
490
491 /**
492 * fast_reauth - EAP fast re-authentication (session resumption)
493 *
494 * By default, fast re-authentication is enabled for all EAP methods
495 * that support it. This variable can be used to disable fast
496 * re-authentication (by setting fast_reauth=0). Normally, there is no
497 * need to disable fast re-authentication.
498 */
499 int fast_reauth;
500
6fc6879b
JM
501 /**
502 * opensc_engine_path - Path to the OpenSSL engine for opensc
503 *
504 * This is an OpenSSL specific configuration option for loading OpenSC
505 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
506 */
507 char *opensc_engine_path;
508
509 /**
510 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
511 *
512 * This is an OpenSSL specific configuration option for loading PKCS#11
513 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
514 */
515 char *pkcs11_engine_path;
516
517 /**
518 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
519 *
520 * This is an OpenSSL specific configuration option for configuring
521 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
522 * module is not loaded.
523 */
524 char *pkcs11_module_path;
6fc6879b 525
07e2de31
JM
526 /**
527 * openssl_ciphers - OpenSSL cipher string
528 *
529 * This is an OpenSSL specific configuration option for configuring the
530 * default ciphers. If not set, "DEFAULT:!EXP:!LOW" is used as the
531 * default.
532 */
533 char *openssl_ciphers;
534
f64adcd7
JM
535 /**
536 * pcsc_reader - PC/SC reader name prefix
537 *
538 * If not %NULL, PC/SC reader with a name that matches this prefix is
539 * initialized for SIM/USIM access. Empty string can be used to match
540 * the first available reader.
541 */
542 char *pcsc_reader;
543
544 /**
545 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
546 *
547 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
548 * EAP-AKA. If left out, this will be asked through control interface.
549 */
550 char *pcsc_pin;
551
a5d44ac0
JM
552 /**
553 * external_sim - Use external processing for SIM/USIM operations
554 */
555 int external_sim;
556
6fc6879b
JM
557 /**
558 * driver_param - Driver interface parameters
559 *
560 * This text string is passed to the selected driver interface with the
561 * optional struct wpa_driver_ops::set_param() handler. This can be
562 * used to configure driver specific options without having to add new
563 * driver interface functionality.
564 */
565 char *driver_param;
566
567 /**
568 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
569 *
570 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
571 * cache (unit: seconds).
572 */
573 unsigned int dot11RSNAConfigPMKLifetime;
574
575 /**
576 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
577 *
578 * dot11 MIB variable for the percentage of the PMK lifetime
579 * that should expire before an IEEE 802.1X reauthentication occurs.
580 */
581 unsigned int dot11RSNAConfigPMKReauthThreshold;
582
583 /**
584 * dot11RSNAConfigSATimeout - Security association timeout
585 *
586 * dot11 MIB variable for the maximum time a security association
587 * shall take to set up (unit: seconds).
588 */
589 unsigned int dot11RSNAConfigSATimeout;
590
591 /**
592 * update_config - Is wpa_supplicant allowed to update configuration
593 *
594 * This variable control whether wpa_supplicant is allow to re-write
595 * its configuration with wpa_config_write(). If this is zero,
596 * configuration data is only changed in memory and the external data
597 * is not overriden. If this is non-zero, wpa_supplicant will update
598 * the configuration data (e.g., a file) whenever configuration is
599 * changed. This update may replace the old configuration which can
600 * remove comments from it in case of a text file configuration.
601 */
602 int update_config;
603
604 /**
605 * blobs - Configuration blobs
606 */
607 struct wpa_config_blob *blobs;
f855f923
JM
608
609 /**
610 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
611 */
612 u8 uuid[16];
6d158490 613
3c0b7aa4
JM
614 /**
615 * device_name - Device Name (WPS)
616 * User-friendly description of device; up to 32 octets encoded in
617 * UTF-8
618 */
619 char *device_name;
620
621 /**
622 * manufacturer - Manufacturer (WPS)
623 * The manufacturer of the device (up to 64 ASCII characters)
624 */
625 char *manufacturer;
626
627 /**
628 * model_name - Model Name (WPS)
629 * Model of the device (up to 32 ASCII characters)
630 */
631 char *model_name;
632
633 /**
634 * model_number - Model Number (WPS)
635 * Additional device description (up to 32 ASCII characters)
636 */
637 char *model_number;
638
639 /**
640 * serial_number - Serial Number (WPS)
641 * Serial number of the device (up to 32 characters)
642 */
643 char *serial_number;
644
645 /**
646 * device_type - Primary Device Type (WPS)
3c0b7aa4 647 */
2f646b6e 648 u8 device_type[WPS_DEV_TYPE_LEN];
3c0b7aa4 649
c0e4dd9e
JM
650 /**
651 * config_methods - Config Methods
652 *
653 * This is a space-separated list of supported WPS configuration
6a857074
JM
654 * methods. For example, "label virtual_display virtual_push_button
655 * keypad".
c0e4dd9e 656 * Available methods: usba ethernet label display ext_nfc_token
6a857074
JM
657 * int_nfc_token nfc_interface push_button keypad
658 * virtual_display physical_display
659 * virtual_push_button physical_push_button.
c0e4dd9e
JM
660 */
661 char *config_methods;
662
3c0b7aa4
JM
663 /**
664 * os_version - OS Version (WPS)
665 * 4-octet operating system version number
666 */
667 u8 os_version[4];
668
6d158490 669 /**
315ce40a 670 * country - Country code
6d158490
LR
671 *
672 * This is the ISO/IEC alpha2 country code for which we are operating
673 * in
674 */
315ce40a 675 char country[2];
47662164
JM
676
677 /**
678 * wps_cred_processing - Credential processing
679 *
680 * 0 = process received credentials internally
681 * 1 = do not process received credentials; just pass them over
682 * ctrl_iface to external program(s)
683 * 2 = process received credentials internally and pass them over
684 * ctrl_iface to external program(s)
685 */
686 int wps_cred_processing;
c9c38b09 687
e3768e7c
JM
688#define MAX_SEC_DEVICE_TYPES 5
689 /**
2f646b6e 690 * sec_device_types - Secondary Device Types (P2P)
e3768e7c 691 */
2f646b6e
JB
692 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
693 int num_sec_device_types;
e3768e7c
JM
694
695 int p2p_listen_reg_class;
696 int p2p_listen_channel;
697 int p2p_oper_reg_class;
698 int p2p_oper_channel;
699 int p2p_go_intent;
700 char *p2p_ssid_postfix;
701 int persistent_reconnect;
0f66abd2 702 int p2p_intra_bss;
21d996f7
JM
703 unsigned int num_p2p_pref_chan;
704 struct p2p_channel *p2p_pref_chan;
556b30da 705 struct wpa_freq_range_list p2p_no_go_freq;
51e9f228 706 int p2p_add_cli_chan;
b277a2be 707 int p2p_ignore_shared_freq;
e3bd6e9d 708 int p2p_optimize_listen_chan;
e3768e7c 709
71dd3b78
AS
710 struct wpabuf *wps_vendor_ext_m1;
711
f95cac27
JMB
712#define MAX_WPS_VENDOR_EXT 10
713 /**
714 * wps_vendor_ext - Vendor extension attributes in WPS
715 */
716 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
717
3071e181
JM
718 /**
719 * p2p_group_idle - Maximum idle time in seconds for P2P group
720 *
721 * This value controls how long a P2P group is maintained after there
722 * is no other members in the group. As a GO, this means no associated
723 * stations in the group. As a P2P client, this means no GO seen in
724 * scan results. The maximum idle time is specified in seconds with 0
725 * indicating no time limit, i.e., the P2P group remains in active
c8106615
JM
726 * state indefinitely until explicitly removed. As a P2P client, the
727 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
728 * this parameter is mainly meant for GO use and for P2P client, it can
5f482d55
JM
729 * only be used to reduce the default timeout to smaller value. A
730 * special value -1 can be used to configure immediate removal of the
731 * group for P2P client role on any disconnection after the data
732 * connection has been established.
3071e181 733 */
5f482d55 734 int p2p_group_idle;
3071e181 735
1b928f96
JM
736 /**
737 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
738 *
739 * This parameter controls the length of the random passphrase that is
740 * generated at the GO.
741 */
742 unsigned int p2p_passphrase_len;
743
c9c38b09
JM
744 /**
745 * bss_max_count - Maximum number of BSS entries to keep in memory
746 */
747 unsigned int bss_max_count;
3812464c 748
78633c37
SL
749 /**
750 * bss_expiration_age - BSS entry age after which it can be expired
751 *
752 * This value controls the time in seconds after which a BSS entry
753 * gets removed if it has not been updated or is not in use.
754 */
755 unsigned int bss_expiration_age;
756
757 /**
758 * bss_expiration_scan_count - Expire BSS after number of scans
759 *
760 * If the BSS entry has not been seen in this many scans, it will be
761 * removed. A value of 1 means that entry is removed after the first
762 * scan in which the BSSID is not seen. Larger values can be used
763 * to avoid BSS entries disappearing if they are not visible in
764 * every scan (e.g., low signal quality or interference).
765 */
766 unsigned int bss_expiration_scan_count;
767
3812464c
JM
768 /**
769 * filter_ssids - SSID-based scan result filtering
770 *
771 * 0 = do not filter scan results
772 * 1 = only include configured SSIDs in scan results/BSS table
773 */
774 int filter_ssids;
1d47214a 775
bf8d6d24
TP
776 /**
777 * filter_rssi - RSSI-based scan result filtering
778 *
779 * 0 = do not filter scan results
780 * -n = filter scan results below -n dBm
781 */
782 int filter_rssi;
783
dae608d5
JM
784 /**
785 * max_num_sta - Maximum number of STAs in an AP/P2P GO
786 */
787 unsigned int max_num_sta;
788
f5ffc348
BG
789 /**
790 * freq_list - Array of allowed scan frequencies or %NULL for all
791 *
792 * This is an optional zero-terminated array of frequencies in
793 * megahertz (MHz) to allow for narrowing scanning range.
794 */
795 int *freq_list;
796
6124e858
BG
797 /**
798 * scan_cur_freq - Whether to scan only the current channel
799 *
800 * If true, attempt to scan only the current channel if any other
801 * VIFs on this radio are already associated on a particular channel.
802 */
803 int scan_cur_freq;
804
1d47214a
JM
805 /**
806 * changed_parameters - Bitmap of changed parameters since last update
807 */
808 unsigned int changed_parameters;
0d7e5a3a
JB
809
810 /**
87880919 811 * disassoc_low_ack - Disassocicate stations with massive packet loss
0d7e5a3a
JB
812 */
813 int disassoc_low_ack;
46ee0427
JM
814
815 /**
816 * interworking - Whether Interworking (IEEE 802.11u) is enabled
817 */
818 int interworking;
819
11540c0b
JM
820 /**
821 * access_network_type - Access Network Type
822 *
823 * When Interworking is enabled, scans will be limited to APs that
824 * advertise the specified Access Network Type (0..15; with 15
825 * indicating wildcard match).
826 */
827 int access_network_type;
828
46ee0427
JM
829 /**
830 * hessid - Homogenous ESS identifier
831 *
832 * If this is set (any octet is non-zero), scans will be used to
833 * request response only from BSSes belonging to the specified
834 * Homogeneous ESS. This is used only if interworking is enabled.
835 */
836 u8 hessid[ETH_ALEN];
1298c145 837
66aadbd7
JK
838 /**
839 * hs20 - Hotspot 2.0
840 */
841 int hs20;
842
1298c145
WJL
843 /**
844 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
845 *
846 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
847 * by acting as a Registrar and using M1 from the AP. The config
848 * methods attribute in that message is supposed to indicate only the
849 * configuration method supported by the AP in Enrollee role, i.e., to
850 * add an external Registrar. For that case, PBC shall not be used and
851 * as such, the PushButton config method is removed from M1 by default.
852 * If pbc_in_m1=1 is included in the configuration file, the PushButton
853 * config method is left in M1 (if included in config_methods
854 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
855 * a label in the AP).
856 */
857 int pbc_in_m1;
b0786fba
TB
858
859 /**
860 * autoscan - Automatic scan parameters or %NULL if none
861 *
862 * This is an optional set of parameters for automatic scanning
863 * within an interface in following format:
864 * <autoscan module name>:<module parameters>
865 */
866 char *autoscan;
3f2c8ba6 867
042ec551
JM
868 /**
869 * wps_nfc_pw_from_config - NFC Device Password was read from config
870 *
871 * This parameter can be determined whether the NFC Device Password was
872 * included in the configuration (1) or generated dynamically (0). Only
873 * the former case is re-written back to the configuration file.
874 */
875 int wps_nfc_pw_from_config;
876
3f2c8ba6
JM
877 /**
878 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
879 */
880 int wps_nfc_dev_pw_id;
881
882 /**
883 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
884 */
885 struct wpabuf *wps_nfc_dh_pubkey;
886
887 /**
ed2e61fe 888 * wps_nfc_dh_privkey - NFC DH Private Key for password token
3f2c8ba6
JM
889 */
890 struct wpabuf *wps_nfc_dh_privkey;
891
892 /**
ed2e61fe 893 * wps_nfc_dev_pw - NFC Device Password for password token
3f2c8ba6
JM
894 */
895 struct wpabuf *wps_nfc_dev_pw;
306ae225
JM
896
897 /**
898 * ext_password_backend - External password backend or %NULL if none
899 *
900 * format: <backend name>[:<optional backend parameters>]
901 */
902 char *ext_password_backend;
462a7439
ES
903
904 /*
905 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
906 *
907 * This timeout value is used in P2P GO mode to clean up
908 * inactive stations.
909 * By default: 300 seconds.
910 */
911 int p2p_go_max_inactivity;
c26effe1
YD
912
913 struct hostapd_wmm_ac_params wmm_ac_params[4];
4d5bda5f
JM
914
915 /**
916 * auto_interworking - Whether to use network selection automatically
917 *
918 * 0 = do not automatically go through Interworking network selection
919 * (i.e., require explicit interworking_select command for this)
920 * 1 = perform Interworking network selection if one or more
921 * credentials have been configured and scan did not find a
922 * matching network block
923 */
924 int auto_interworking;
a93a15bb
AN
925
926 /**
927 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
928 *
929 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
930 * Note that regulatory constraints and driver capabilities are
931 * consulted anyway, so setting it to 1 can't do real harm.
932 * By default: 0 (disabled)
933 */
934 int p2p_go_ht40;
7a808c7e 935
20ea1ca4
EP
936 /**
937 * p2p_go_vht - Default mode for VHT enable when operating as GO
938 *
939 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
940 * Note that regulatory constraints and driver capabilities are
941 * consulted anyway, so setting it to 1 can't do real harm.
942 * By default: 0 (disabled)
943 */
944 int p2p_go_vht;
945
0b8bcaa5
EP
946 /**
947 * p2p_go_ctwindow - CTWindow to use when operating as GO
948 *
949 * By default: 0 (no CTWindow). Values 0-127 can be used to indicate
950 * the length of the CTWindow in TUs.
951 */
952 int p2p_go_ctwindow;
953
7a808c7e
JM
954 /**
955 * p2p_disabled - Whether P2P operations are disabled for this interface
956 */
957 int p2p_disabled;
d76cd41a
JM
958
959 /**
960 * p2p_no_group_iface - Whether group interfaces can be used
961 *
962 * By default, wpa_supplicant will create a separate interface for P2P
963 * group operations if the driver supports this. This functionality can
964 * be disabled by setting this parameter to 1. In that case, the same
965 * interface that was used for the P2P management operations is used
966 * also for the group operation.
967 */
968 int p2p_no_group_iface;
6e202021
JM
969
970 /**
971 * okc - Whether to enable opportunistic key caching by default
972 *
973 * By default, OKC is disabled unless enabled by the per-network
974 * proactive_key_caching=1 parameter. okc=1 can be used to change this
975 * default behavior.
976 */
977 int okc;
62d49803
JM
978
979 /**
980 * pmf - Whether to enable/require PMF by default
981 *
982 * By default, PMF is disabled unless enabled by the per-network
983 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
984 * this default behavior.
985 */
986 enum mfp_options pmf;
625f202a
JM
987
988 /**
989 * sae_groups - Preference list of enabled groups for SAE
990 *
991 * By default (if this parameter is not set), the mandatory group 19
992 * (ECC group defined over a 256-bit prime order field) is preferred,
993 * but other groups are also enabled. If this parameter is set, the
994 * groups will be tried in the indicated order.
995 */
996 int *sae_groups;
18206e02
JM
997
998 /**
999 * dtim_period - Default DTIM period in Beacon intervals
1000 *
1001 * This parameter can be used to set the default value for network
1002 * blocks that do not specify dtim_period.
1003 */
1004 int dtim_period;
1005
1006 /**
1007 * beacon_int - Default Beacon interval in TU
1008 *
1009 * This parameter can be used to set the default value for network
1010 * blocks that do not specify beacon_int.
1011 */
1012 int beacon_int;
18a2eaab
JM
1013
1014 /**
1015 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
1016 *
1017 * This parameter can be used to define additional vendor specific
1018 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
1019 * format for these element(s) is a hexdump of the raw information
1020 * elements (id+len+payload for one or more elements).
1021 */
1022 struct wpabuf *ap_vendor_elements;
4342326f
JM
1023
1024 /**
1025 * ignore_old_scan_res - Ignore scan results older than request
1026 *
1027 * The driver may have a cache of scan results that makes it return
1028 * information that is older than our scan trigger. This parameter can
1029 * be used to configure such old information to be ignored instead of
1030 * allowing it to update the internal BSS table.
1031 */
1032 int ignore_old_scan_res;
4aa81868
SF
1033
1034 /**
1035 * sched_scan_interval - schedule scan interval
1036 */
1037 unsigned int sched_scan_interval;
800d5872
SD
1038
1039 /**
1040 * tdls_external_control - External control for TDLS setup requests
1041 *
1042 * Enable TDLS mode where external programs are given the control
1043 * to specify the TDLS link to get established to the driver. The
1044 * driver requests the TDLS setup to the supplicant only for the
1045 * specified TDLS peers.
1046 */
1047 int tdls_external_control;
25ef8529
JM
1048
1049 u8 ip_addr_go[4];
1050 u8 ip_addr_mask[4];
1051 u8 ip_addr_start[4];
1052 u8 ip_addr_end[4];
b572df86
JM
1053
1054 /**
1055 * osu_dir - OSU provider information directory
1056 *
1057 * If set, allow FETCH_OSU control interface command to be used to fetch
1058 * OSU provider information into all APs and store the results in this
1059 * directory.
1060 */
1061 char *osu_dir;
e4fa8b12
EP
1062
1063 /**
1064 * wowlan_triggers - Wake-on-WLAN triggers
1065 *
1066 * If set, these wowlan triggers will be configured.
1067 */
1068 char *wowlan_triggers;
d3b20469
NS
1069
1070 /**
1071 * p2p_search_delay - Extra delay between concurrent search iterations
1072 *
1073 * Add extra delay (in milliseconds) between search iterations when
1074 * there is a concurrent operation to make p2p_find friendlier to
1075 * concurrent operations by avoiding it from taking 100% of radio
1076 * resources.
1077 */
1078 unsigned int p2p_search_delay;
c267753b
JM
1079
1080 /**
1081 * mac_addr - MAC address policy default
1082 *
1083 * 0 = use permanent MAC address
1084 * 1 = use random MAC address for each ESS connection
a313d17d 1085 * 2 = like 1, but maintain OUI (with local admin bit set)
c267753b
JM
1086 *
1087 * By default, permanent MAC address is used unless policy is changed by
1088 * the per-network mac_addr parameter. Global mac_addr=1 can be used to
1089 * change this default behavior.
1090 */
1091 int mac_addr;
1092
1093 /**
1094 * rand_addr_lifetime - Lifetime of random MAC address in seconds
1095 */
1096 unsigned int rand_addr_lifetime;
1097
1098 /**
1099 * preassoc_mac_addr - Pre-association MAC address policy
1100 *
1101 * 0 = use permanent MAC address
1102 * 1 = use random MAC address
a313d17d 1103 * 2 = like 1, but maintain OUI (with local admin bit set)
c267753b
JM
1104 */
1105 int preassoc_mac_addr;
b41f2684
CL
1106
1107 /**
1108 * key_mgmt_offload - Use key management offload
1109 *
1110 * Key management offload should be used if the device supports it.
1111 * Key management offload is the capability of a device operating as
1112 * a station to do the exchange necessary to establish temporal keys
1113 * during initial RSN connection, after roaming, or during a PTK
1114 * rekeying operation.
1115 */
1116 int key_mgmt_offload;
e45e8989
TP
1117
1118 /**
1119 * user_mpm - MPM residency
1120 *
1121 * 0: MPM lives in driver.
1122 * 1: wpa_supplicant handles peering and station allocation.
1123 *
1124 * If AMPE or SAE is enabled, the MPM is always in userspace.
1125 */
1126 int user_mpm;
4b409368
MH
1127
1128 /**
1129 * max_peer_links - Maximum number of peer links
1130 *
1131 * Maximum number of mesh peering currently maintained by the STA.
1132 */
1133 int max_peer_links;
483dd6a5
JM
1134
1135 /**
1136 * cert_in_cb - Whether to include a peer certificate dump in events
1137 *
1138 * This controls whether peer certificates for authentication server and
1139 * its certificate chain are included in EAP peer certificate events.
1140 */
1141 int cert_in_cb;
5a2a6de6
MH
1142
1143 /**
1144 * mesh_max_inactivity - Timeout in seconds to detect STA inactivity
1145 *
1146 * This timeout value is used in mesh STA to clean up inactive stations.
1147 * By default: 300 seconds.
1148 */
1149 int mesh_max_inactivity;
c35e35ed
JM
1150
1151 /**
1152 * passive_scan - Whether to force passive scan for network connection
1153 *
1154 * This parameter can be used to force only passive scanning to be used
1155 * for network connection cases. It should be noted that this will slow
1156 * down scan operations and reduce likelihood of finding the AP. In
1157 * addition, some use cases will override this due to functional
1158 * requirements, e.g., for finding an AP that uses hidden SSID
1159 * (scan_ssid=1) or P2P device discovery.
1160 */
1161 int passive_scan;
59b416c7
JM
1162
1163 /**
1164 * reassoc_same_bss_optim - Whether to optimize reassoc-to-same-BSS
1165 */
1166 int reassoc_same_bss_optim;
94687a0a
SD
1167
1168 /**
1169 * wps_priority - Priority for the networks added through WPS
1170 *
1171 * This priority value will be set to each network profile that is added
1172 * by executing the WPS protocol.
1173 */
1174 int wps_priority;
6fc6879b
JM
1175};
1176
1177
1178/* Prototypes for common functions from config.c */
1179
1180void wpa_config_free(struct wpa_config *ssid);
1181void wpa_config_free_ssid(struct wpa_ssid *ssid);
7c49fdd0
SL
1182void wpa_config_foreach_network(struct wpa_config *config,
1183 void (*func)(void *, struct wpa_ssid *),
1184 void *arg);
6fc6879b
JM
1185struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1186struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1187int wpa_config_remove_network(struct wpa_config *config, int id);
1188void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1189int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1190 int line);
67e1b984
JM
1191int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1192 const char *value);
10263dc2
OO
1193int wpa_config_dump_values(struct wpa_config *config, char *buf,
1194 size_t buflen);
1195int wpa_config_get_value(const char *name, struct wpa_config *config,
1196 char *buf, size_t buflen);
1197
3d3d3056 1198char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
6fc6879b
JM
1199char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1200char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1201void wpa_config_update_psk(struct wpa_ssid *ssid);
1202int wpa_config_add_prio_network(struct wpa_config *config,
1203 struct wpa_ssid *ssid);
aa53509f 1204int wpa_config_update_prio_list(struct wpa_config *config);
6fc6879b
JM
1205const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1206 const char *name);
1207void wpa_config_set_blob(struct wpa_config *config,
1208 struct wpa_config_blob *blob);
1209void wpa_config_free_blob(struct wpa_config_blob *blob);
1210int wpa_config_remove_blob(struct wpa_config *config, const char *name);
d9bb2821 1211void wpa_config_flush_blobs(struct wpa_config *config);
6fc6879b 1212
d94c9ee6
JM
1213struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1214struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1215int wpa_config_remove_cred(struct wpa_config *config, int id);
1bb7b8e8
JM
1216void wpa_config_free_cred(struct wpa_cred *cred);
1217int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1218 const char *value, int line);
c880ab87 1219char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
1bb7b8e8 1220
6fc6879b
JM
1221struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1222 const char *driver_param);
1223#ifndef CONFIG_NO_STDOUT_DEBUG
1224void wpa_config_debug_dump_networks(struct wpa_config *config);
1225#else /* CONFIG_NO_STDOUT_DEBUG */
1226#define wpa_config_debug_dump_networks(c) do { } while (0)
1227#endif /* CONFIG_NO_STDOUT_DEBUG */
1228
1229
121adf9c
JM
1230/* Prototypes for common functions from config.c */
1231int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1232
1233
6fc6879b
JM
1234/* Prototypes for backend specific functions from the selected config_*.c */
1235
1236/**
1237 * wpa_config_read - Read and parse configuration database
1238 * @name: Name of the configuration (e.g., path and file name for the
1239 * configuration file)
e6304cad 1240 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
6fc6879b
JM
1241 * Returns: Pointer to allocated configuration data or %NULL on failure
1242 *
1243 * This function reads configuration data, parses its contents, and allocates
1244 * data structures needed for storing configuration information. The allocated
1245 * data can be freed with wpa_config_free().
1246 *
1247 * Each configuration backend needs to implement this function.
1248 */
e6304cad 1249struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
6fc6879b
JM
1250
1251/**
1252 * wpa_config_write - Write or update configuration data
1253 * @name: Name of the configuration (e.g., path and file name for the
1254 * configuration file)
1255 * @config: Configuration data from wpa_config_read()
1256 * Returns: 0 on success, -1 on failure
1257 *
1258 * This function write all configuration data into an external database (e.g.,
1259 * a text file) in a format that can be read with wpa_config_read(). This can
1260 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1261 * new network is added or a password is changed.
1262 *
1263 * Each configuration backend needs to implement this function.
1264 */
1265int wpa_config_write(const char *name, struct wpa_config *config);
1266
1267#endif /* CONFIG_H */