blob: a39804949b621f81023a0690d8c1da340ef77fe2 [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 */
18#define DEFAULT_FAST_REAUTH 1
19#define DEFAULT_P2P_GO_INTENT 7
20#define DEFAULT_P2P_INTRA_BSS 1
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070021#define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070022#define DEFAULT_BSS_MAX_COUNT 200
23#define DEFAULT_BSS_EXPIRATION_AGE 180
24#define DEFAULT_BSS_EXPIRATION_SCAN_COUNT 2
25#define DEFAULT_MAX_NUM_STA 128
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -080026#define DEFAULT_ACCESS_NETWORK_TYPE 15
Dmitry Shmidtea69e842013-05-13 14:52:28 -070027#define DEFAULT_SCAN_CUR_FREQ 0
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070028
29#include "config_ssid.h"
30#include "wps/wps.h"
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070031#include "common/ieee802_11_common.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070032
33
Dmitry Shmidt04949592012-07-19 12:16:46 -070034struct wpa_cred {
35 /**
36 * next - Next credential in the list
37 *
38 * This pointer can be used to iterate over all credentials. The head
39 * of this list is stored in the cred field of struct wpa_config.
40 */
41 struct wpa_cred *next;
42
43 /**
44 * id - Unique id for the credential
45 *
46 * This identifier is used as a unique identifier for each credential
47 * block when using the control interface. Each credential is allocated
48 * an id when it is being created, either when reading the
49 * configuration file or when a new credential is added through the
50 * control interface.
51 */
52 int id;
53
54 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080055 * temporary - Whether this credential is temporary and not to be saved
56 */
57 int temporary;
58
59 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -070060 * priority - Priority group
61 *
62 * By default, all networks and credentials get the same priority group
63 * (0). This field can be used to give higher priority for credentials
64 * (and similarly in struct wpa_ssid for network blocks) to change the
65 * Interworking automatic networking selection behavior. The matching
66 * network (based on either an enabled network block or a credential)
67 * with the highest priority value will be selected.
68 */
69 int priority;
70
71 /**
72 * pcsc - Use PC/SC and SIM/USIM card
73 */
74 int pcsc;
75
76 /**
77 * realm - Home Realm for Interworking
78 */
79 char *realm;
80
81 /**
82 * username - Username for Interworking network selection
83 */
84 char *username;
85
86 /**
87 * password - Password for Interworking network selection
88 */
89 char *password;
90
91 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070092 * ext_password - Whether password is a name for external storage
93 */
94 int ext_password;
95
96 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -070097 * ca_cert - CA certificate for Interworking network selection
98 */
99 char *ca_cert;
100
101 /**
102 * client_cert - File path to client certificate file (PEM/DER)
103 *
104 * This field is used with Interworking networking selection for a case
105 * where client certificate/private key is used for authentication
106 * (EAP-TLS). Full path to the file should be used since working
107 * directory may change when wpa_supplicant is run in the background.
108 *
109 * Alternatively, a named configuration blob can be used by setting
110 * this to blob://blob_name.
111 */
112 char *client_cert;
113
114 /**
115 * private_key - File path to client private key file (PEM/DER/PFX)
116 *
117 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
118 * commented out. Both the private key and certificate will be read
119 * from the PKCS#12 file in this case. Full path to the file should be
120 * used since working directory may change when wpa_supplicant is run
121 * in the background.
122 *
123 * Windows certificate store can be used by leaving client_cert out and
124 * configuring private_key in one of the following formats:
125 *
126 * cert://substring_to_match
127 *
128 * hash://certificate_thumbprint_in_hex
129 *
130 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
131 *
132 * Note that when running wpa_supplicant as an application, the user
133 * certificate store (My user account) is used, whereas computer store
134 * (Computer account) is used when running wpasvc as a service.
135 *
136 * Alternatively, a named configuration blob can be used by setting
137 * this to blob://blob_name.
138 */
139 char *private_key;
140
141 /**
142 * private_key_passwd - Password for private key file
143 */
144 char *private_key_passwd;
145
146 /**
147 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
148 */
149 char *imsi;
150
151 /**
152 * milenage - Milenage parameters for SIM/USIM simulator in
153 * <Ki>:<OPc>:<SQN> format
154 */
155 char *milenage;
156
157 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -0700158 * domain_suffix_match - Constraint for server domain name
159 *
160 * If set, this FQDN is used as a suffix match requirement for the AAA
161 * server certificate in SubjectAltName dNSName element(s). If a
162 * matching dNSName is found, this constraint is met. If no dNSName
163 * values are present, this constraint is matched against SubjetName CN
164 * using same suffix match comparison. Suffix match here means that the
165 * host/domain name is compared one label at a time starting from the
166 * top-level domain and all the labels in @domain_suffix_match shall be
167 * included in the certificate. The certificate may include additional
168 * sub-level labels in addition to the required labels.
169 *
170 * For example, domain_suffix_match=example.com would match
171 * test.example.com but would not match test-example.com.
172 */
173 char *domain_suffix_match;
174
175 /**
176 * domain - Home service provider FQDN(s)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700177 *
178 * This is used to compare against the Domain Name List to figure out
Dmitry Shmidt051af732013-10-22 13:52:46 -0700179 * whether the AP is operated by the Home SP. Multiple domain entries
180 * can be used to configure alternative FQDNs that will be considered
181 * home networks.
Dmitry Shmidt04949592012-07-19 12:16:46 -0700182 */
Dmitry Shmidt051af732013-10-22 13:52:46 -0700183 char **domain;
184
185 /**
186 * num_domain - Number of FQDNs in the domain array
187 */
188 size_t num_domain;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700189
190 /**
191 * roaming_consortium - Roaming Consortium OI
192 *
193 * If roaming_consortium_len is non-zero, this field contains the
194 * Roaming Consortium OI that can be used to determine which access
195 * points support authentication with this credential. This is an
196 * alternative to the use of the realm parameter. When using Roaming
197 * Consortium to match the network, the EAP parameters need to be
198 * pre-configured with the credential since the NAI Realm information
199 * may not be available or fetched.
200 */
201 u8 roaming_consortium[15];
202
203 /**
204 * roaming_consortium_len - Length of roaming_consortium
205 */
206 size_t roaming_consortium_len;
207
Dmitry Shmidt051af732013-10-22 13:52:46 -0700208 u8 required_roaming_consortium[15];
209 size_t required_roaming_consortium_len;
210
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700211 /**
212 * eap_method - EAP method to use
213 *
214 * Pre-configured EAP method to use with this credential or %NULL to
215 * indicate no EAP method is selected, i.e., the method will be
216 * selected automatically based on ANQP information.
217 */
218 struct eap_method_type *eap_method;
219
220 /**
221 * phase1 - Phase 1 (outer authentication) parameters
222 *
223 * Pre-configured EAP parameters or %NULL.
224 */
225 char *phase1;
226
227 /**
228 * phase2 - Phase 2 (inner authentication) parameters
229 *
230 * Pre-configured EAP parameters or %NULL.
231 */
232 char *phase2;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800233
234 struct excluded_ssid {
235 u8 ssid[MAX_SSID_LEN];
236 size_t ssid_len;
237 } *excluded_ssid;
238 size_t num_excluded_ssid;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800239
240 struct roaming_partner {
241 char fqdn[128];
242 int exact_match;
243 u8 priority;
244 char country[3];
245 } *roaming_partner;
246 size_t num_roaming_partner;
247
248 int update_identifier;
249
250 /**
251 * provisioning_sp - FQDN of the SP that provisioned the credential
252 */
253 char *provisioning_sp;
254
255 /**
256 * sp_priority - Credential priority within a provisioning SP
257 *
258 * This is the priority of the credential among all credentials
259 * provisionined by the same SP (i.e., for entries that have identical
260 * provisioning_sp value). The range of this priority is 0-255 with 0
261 * being the highest and 255 the lower priority.
262 */
263 int sp_priority;
264
265 unsigned int min_dl_bandwidth_home;
266 unsigned int min_ul_bandwidth_home;
267 unsigned int min_dl_bandwidth_roaming;
268 unsigned int min_ul_bandwidth_roaming;
269
270 /**
271 * max_bss_load - Maximum BSS Load Channel Utilization (1..255)
272 * This value is used as the maximum channel utilization for network
273 * selection purposes for home networks. If the AP does not advertise
274 * BSS Load or if the limit would prevent any connection, this
275 * constraint will be ignored.
276 */
277 unsigned int max_bss_load;
278
279 unsigned int num_req_conn_capab;
280 u8 *req_conn_capab_proto;
281 int **req_conn_capab_port;
282
283 /**
284 * ocsp - Whether to use/require OCSP to check server certificate
285 *
286 * 0 = do not use OCSP stapling (TLS certificate status extension)
287 * 1 = try to use OCSP stapling, but not require response
288 * 2 = require valid OCSP stapling response
289 */
290 int ocsp;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700291};
292
293
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700294#define CFG_CHANGED_DEVICE_NAME BIT(0)
295#define CFG_CHANGED_CONFIG_METHODS BIT(1)
296#define CFG_CHANGED_DEVICE_TYPE BIT(2)
297#define CFG_CHANGED_OS_VERSION BIT(3)
298#define CFG_CHANGED_UUID BIT(4)
299#define CFG_CHANGED_COUNTRY BIT(5)
300#define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
301#define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
302#define CFG_CHANGED_WPS_STRING BIT(8)
303#define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
304#define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
Jouni Malinen75ecf522011-06-27 15:19:46 -0700305#define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
306#define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
Dmitry Shmidt04949592012-07-19 12:16:46 -0700307#define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700308#define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800309#define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700310
311/**
312 * struct wpa_config - wpa_supplicant configuration data
313 *
314 * This data structure is presents the per-interface (radio) configuration
315 * data. In many cases, there is only one struct wpa_config instance, but if
316 * more than one network interface is being controlled, one instance is used
317 * for each.
318 */
319struct wpa_config {
320 /**
321 * ssid - Head of the global network list
322 *
323 * This is the head for the list of all the configured networks.
324 */
325 struct wpa_ssid *ssid;
326
327 /**
328 * pssid - Per-priority network lists (in priority order)
329 */
330 struct wpa_ssid **pssid;
331
332 /**
333 * num_prio - Number of different priorities used in the pssid lists
334 *
335 * This indicates how many per-priority network lists are included in
336 * pssid.
337 */
338 int num_prio;
339
340 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700341 * cred - Head of the credential list
342 *
343 * This is the head for the list of all the configured credentials.
344 */
345 struct wpa_cred *cred;
346
347 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700348 * eapol_version - IEEE 802.1X/EAPOL version number
349 *
350 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
351 * defines EAPOL version 2. However, there are many APs that do not
352 * handle the new version number correctly (they seem to drop the
353 * frames completely). In order to make wpa_supplicant interoperate
354 * with these APs, the version number is set to 1 by default. This
355 * configuration value can be used to set it to the new version (2).
356 */
357 int eapol_version;
358
359 /**
360 * ap_scan - AP scanning/selection
361 *
362 * By default, wpa_supplicant requests driver to perform AP
363 * scanning and then uses the scan results to select a
364 * suitable AP. Another alternative is to allow the driver to
365 * take care of AP scanning and selection and use
366 * wpa_supplicant just to process EAPOL frames based on IEEE
367 * 802.11 association information from the driver.
368 *
369 * 1: wpa_supplicant initiates scanning and AP selection (default).
370 *
371 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
372 * association parameters (e.g., WPA IE generation); this mode can
373 * also be used with non-WPA drivers when using IEEE 802.1X mode;
374 * do not try to associate with APs (i.e., external program needs
375 * to control association). This mode must also be used when using
376 * wired Ethernet drivers.
377 *
378 * 2: like 0, but associate with APs using security policy and SSID
379 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
380 * drivers to enable operation with hidden SSIDs and optimized roaming;
381 * in this mode, the network blocks in the configuration are tried
382 * one by one until the driver reports successful association; each
383 * network block should have explicit security policy (i.e., only one
384 * option in the lists) for key_mgmt, pairwise, group, proto variables.
385 */
386 int ap_scan;
387
388 /**
Dmitry Shmidtb96dad42013-11-05 10:07:29 -0800389 * bgscan - Background scan and roaming parameters or %NULL if none
390 *
391 * This is an optional set of parameters for background scanning and
392 * roaming within a network (ESS). For more detailed information see
393 * ssid block documentation.
394 *
395 * The variable defines default bgscan behavior for all BSS station
396 * networks except for those which have their own bgscan configuration.
397 */
398 char *bgscan;
399
400 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700401 * disable_scan_offload - Disable automatic offloading of scan requests
402 *
403 * By default, %wpa_supplicant tries to offload scanning if the driver
404 * indicates support for this (sched_scan). This configuration
405 * parameter can be used to disable this offloading mechanism.
406 */
407 int disable_scan_offload;
408
409 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700410 * ctrl_interface - Parameters for the control interface
411 *
412 * If this is specified, %wpa_supplicant will open a control interface
413 * that is available for external programs to manage %wpa_supplicant.
414 * The meaning of this string depends on which control interface
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800415 * mechanism is used. For all cases, the existence of this parameter
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700416 * in configuration is used to determine whether the control interface
417 * is enabled.
418 *
419 * For UNIX domain sockets (default on Linux and BSD): This is a
420 * directory that will be created for UNIX domain sockets for listening
421 * to requests from external programs (CLI/GUI, etc.) for status
422 * information and configuration. The socket file will be named based
423 * on the interface name, so multiple %wpa_supplicant processes can be
424 * run at the same time if more than one interface is used.
425 * /var/run/wpa_supplicant is the recommended directory for sockets and
426 * by default, wpa_cli will use it when trying to connect with
427 * %wpa_supplicant.
428 *
429 * Access control for the control interface can be configured
430 * by setting the directory to allow only members of a group
431 * to use sockets. This way, it is possible to run
432 * %wpa_supplicant as root (since it needs to change network
433 * configuration and open raw sockets) and still allow GUI/CLI
434 * components to be run as non-root users. However, since the
435 * control interface can be used to change the network
436 * configuration, this access needs to be protected in many
437 * cases. By default, %wpa_supplicant is configured to use gid
438 * 0 (root). If you want to allow non-root users to use the
439 * control interface, add a new group and change this value to
440 * match with that group. Add users that should have control
441 * interface access to this group.
442 *
443 * When configuring both the directory and group, use following format:
444 * DIR=/var/run/wpa_supplicant GROUP=wheel
445 * DIR=/var/run/wpa_supplicant GROUP=0
446 * (group can be either group name or gid)
447 *
448 * For UDP connections (default on Windows): The value will be ignored.
449 * This variable is just used to select that the control interface is
450 * to be created. The value can be set to, e.g., udp
451 * (ctrl_interface=udp).
452 *
453 * For Windows Named Pipe: This value can be used to set the security
454 * descriptor for controlling access to the control interface. Security
455 * descriptor can be set using Security Descriptor String Format (see
456 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
457 * The descriptor string needs to be prefixed with SDDL=. For example,
458 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
459 * all connections).
460 */
461 char *ctrl_interface;
462
463 /**
464 * ctrl_interface_group - Control interface group (DEPRECATED)
465 *
466 * This variable is only used for backwards compatibility. Group for
467 * UNIX domain sockets should now be specified using GROUP=group in
468 * ctrl_interface variable.
469 */
470 char *ctrl_interface_group;
471
472 /**
473 * fast_reauth - EAP fast re-authentication (session resumption)
474 *
475 * By default, fast re-authentication is enabled for all EAP methods
476 * that support it. This variable can be used to disable fast
477 * re-authentication (by setting fast_reauth=0). Normally, there is no
478 * need to disable fast re-authentication.
479 */
480 int fast_reauth;
481
482 /**
483 * opensc_engine_path - Path to the OpenSSL engine for opensc
484 *
485 * This is an OpenSSL specific configuration option for loading OpenSC
486 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
487 */
488 char *opensc_engine_path;
489
490 /**
491 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
492 *
493 * This is an OpenSSL specific configuration option for loading PKCS#11
494 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
495 */
496 char *pkcs11_engine_path;
497
498 /**
499 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
500 *
501 * This is an OpenSSL specific configuration option for configuring
502 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
503 * module is not loaded.
504 */
505 char *pkcs11_module_path;
506
507 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700508 * pcsc_reader - PC/SC reader name prefix
509 *
510 * If not %NULL, PC/SC reader with a name that matches this prefix is
511 * initialized for SIM/USIM access. Empty string can be used to match
512 * the first available reader.
513 */
514 char *pcsc_reader;
515
516 /**
517 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
518 *
519 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
520 * EAP-AKA. If left out, this will be asked through control interface.
521 */
522 char *pcsc_pin;
523
524 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -0700525 * external_sim - Use external processing for SIM/USIM operations
526 */
527 int external_sim;
528
529 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700530 * driver_param - Driver interface parameters
531 *
532 * This text string is passed to the selected driver interface with the
533 * optional struct wpa_driver_ops::set_param() handler. This can be
534 * used to configure driver specific options without having to add new
535 * driver interface functionality.
536 */
537 char *driver_param;
538
539 /**
540 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
541 *
542 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
543 * cache (unit: seconds).
544 */
545 unsigned int dot11RSNAConfigPMKLifetime;
546
547 /**
548 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
549 *
550 * dot11 MIB variable for the percentage of the PMK lifetime
551 * that should expire before an IEEE 802.1X reauthentication occurs.
552 */
553 unsigned int dot11RSNAConfigPMKReauthThreshold;
554
555 /**
556 * dot11RSNAConfigSATimeout - Security association timeout
557 *
558 * dot11 MIB variable for the maximum time a security association
559 * shall take to set up (unit: seconds).
560 */
561 unsigned int dot11RSNAConfigSATimeout;
562
563 /**
564 * update_config - Is wpa_supplicant allowed to update configuration
565 *
566 * This variable control whether wpa_supplicant is allow to re-write
567 * its configuration with wpa_config_write(). If this is zero,
568 * configuration data is only changed in memory and the external data
569 * is not overriden. If this is non-zero, wpa_supplicant will update
570 * the configuration data (e.g., a file) whenever configuration is
571 * changed. This update may replace the old configuration which can
572 * remove comments from it in case of a text file configuration.
573 */
574 int update_config;
575
576 /**
577 * blobs - Configuration blobs
578 */
579 struct wpa_config_blob *blobs;
580
581 /**
582 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
583 */
584 u8 uuid[16];
585
586 /**
587 * device_name - Device Name (WPS)
588 * User-friendly description of device; up to 32 octets encoded in
589 * UTF-8
590 */
591 char *device_name;
592
593 /**
594 * manufacturer - Manufacturer (WPS)
595 * The manufacturer of the device (up to 64 ASCII characters)
596 */
597 char *manufacturer;
598
599 /**
600 * model_name - Model Name (WPS)
601 * Model of the device (up to 32 ASCII characters)
602 */
603 char *model_name;
604
605 /**
606 * model_number - Model Number (WPS)
607 * Additional device description (up to 32 ASCII characters)
608 */
609 char *model_number;
610
611 /**
612 * serial_number - Serial Number (WPS)
613 * Serial number of the device (up to 32 characters)
614 */
615 char *serial_number;
616
617 /**
618 * device_type - Primary Device Type (WPS)
619 */
620 u8 device_type[WPS_DEV_TYPE_LEN];
621
622 /**
623 * config_methods - Config Methods
624 *
625 * This is a space-separated list of supported WPS configuration
626 * methods. For example, "label virtual_display virtual_push_button
627 * keypad".
628 * Available methods: usba ethernet label display ext_nfc_token
629 * int_nfc_token nfc_interface push_button keypad
630 * virtual_display physical_display
631 * virtual_push_button physical_push_button.
632 */
633 char *config_methods;
634
635 /**
636 * os_version - OS Version (WPS)
637 * 4-octet operating system version number
638 */
639 u8 os_version[4];
640
641 /**
642 * country - Country code
643 *
644 * This is the ISO/IEC alpha2 country code for which we are operating
645 * in
646 */
647 char country[2];
648
649 /**
650 * wps_cred_processing - Credential processing
651 *
652 * 0 = process received credentials internally
653 * 1 = do not process received credentials; just pass them over
654 * ctrl_iface to external program(s)
655 * 2 = process received credentials internally and pass them over
656 * ctrl_iface to external program(s)
657 */
658 int wps_cred_processing;
659
660#define MAX_SEC_DEVICE_TYPES 5
661 /**
662 * sec_device_types - Secondary Device Types (P2P)
663 */
664 u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
665 int num_sec_device_types;
666
667 int p2p_listen_reg_class;
668 int p2p_listen_channel;
669 int p2p_oper_reg_class;
670 int p2p_oper_channel;
671 int p2p_go_intent;
672 char *p2p_ssid_postfix;
673 int persistent_reconnect;
674 int p2p_intra_bss;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700675 unsigned int num_p2p_pref_chan;
676 struct p2p_channel *p2p_pref_chan;
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700677 struct wpa_freq_range_list p2p_no_go_freq;
678 int p2p_add_cli_chan;
Dmitry Shmidt700a1372013-03-15 14:14:44 -0700679 int p2p_ignore_shared_freq;
Dmitry Shmidt04949592012-07-19 12:16:46 -0700680
681 struct wpabuf *wps_vendor_ext_m1;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700682
683#define MAX_WPS_VENDOR_EXT 10
684 /**
685 * wps_vendor_ext - Vendor extension attributes in WPS
686 */
687 struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
688
689 /**
690 * p2p_group_idle - Maximum idle time in seconds for P2P group
691 *
692 * This value controls how long a P2P group is maintained after there
693 * is no other members in the group. As a GO, this means no associated
694 * stations in the group. As a P2P client, this means no GO seen in
695 * scan results. The maximum idle time is specified in seconds with 0
696 * indicating no time limit, i.e., the P2P group remains in active
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800697 * state indefinitely until explicitly removed. As a P2P client, the
698 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
699 * this parameter is mainly meant for GO use and for P2P client, it can
Dmitry Shmidt04949592012-07-19 12:16:46 -0700700 * only be used to reduce the default timeout to smaller value. A
701 * special value -1 can be used to configure immediate removal of the
702 * group for P2P client role on any disconnection after the data
703 * connection has been established.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700704 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700705 int p2p_group_idle;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700706
707 /**
708 * bss_max_count - Maximum number of BSS entries to keep in memory
709 */
710 unsigned int bss_max_count;
711
712 /**
713 * bss_expiration_age - BSS entry age after which it can be expired
714 *
715 * This value controls the time in seconds after which a BSS entry
716 * gets removed if it has not been updated or is not in use.
717 */
718 unsigned int bss_expiration_age;
719
720 /**
721 * bss_expiration_scan_count - Expire BSS after number of scans
722 *
723 * If the BSS entry has not been seen in this many scans, it will be
724 * removed. A value of 1 means that entry is removed after the first
725 * scan in which the BSSID is not seen. Larger values can be used
726 * to avoid BSS entries disappearing if they are not visible in
727 * every scan (e.g., low signal quality or interference).
728 */
729 unsigned int bss_expiration_scan_count;
730
731 /**
732 * filter_ssids - SSID-based scan result filtering
733 *
734 * 0 = do not filter scan results
735 * 1 = only include configured SSIDs in scan results/BSS table
736 */
737 int filter_ssids;
738
739 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700740 * filter_rssi - RSSI-based scan result filtering
741 *
742 * 0 = do not filter scan results
743 * -n = filter scan results below -n dBm
744 */
745 int filter_rssi;
746
747 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700748 * max_num_sta - Maximum number of STAs in an AP/P2P GO
749 */
750 unsigned int max_num_sta;
751
752 /**
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700753 * freq_list - Array of allowed scan frequencies or %NULL for all
754 *
755 * This is an optional zero-terminated array of frequencies in
756 * megahertz (MHz) to allow for narrowing scanning range.
757 */
758 int *freq_list;
759
760 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -0700761 * scan_cur_freq - Whether to scan only the current channel
762 *
763 * If true, attempt to scan only the current channel if any other
764 * VIFs on this radio are already associated on a particular channel.
765 */
766 int scan_cur_freq;
767
768 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700769 * changed_parameters - Bitmap of changed parameters since last update
770 */
771 unsigned int changed_parameters;
772
773 /**
774 * disassoc_low_ack - Disassocicate stations with massive packet loss
775 */
776 int disassoc_low_ack;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800777
778 /**
779 * interworking - Whether Interworking (IEEE 802.11u) is enabled
780 */
781 int interworking;
782
783 /**
784 * access_network_type - Access Network Type
785 *
786 * When Interworking is enabled, scans will be limited to APs that
787 * advertise the specified Access Network Type (0..15; with 15
788 * indicating wildcard match).
789 */
790 int access_network_type;
791
792 /**
793 * hessid - Homogenous ESS identifier
794 *
795 * If this is set (any octet is non-zero), scans will be used to
796 * request response only from BSSes belonging to the specified
797 * Homogeneous ESS. This is used only if interworking is enabled.
798 */
799 u8 hessid[ETH_ALEN];
800
801 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700802 * hs20 - Hotspot 2.0
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800803 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700804 int hs20;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800805
806 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700807 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
808 *
809 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
810 * by acting as a Registrar and using M1 from the AP. The config
811 * methods attribute in that message is supposed to indicate only the
812 * configuration method supported by the AP in Enrollee role, i.e., to
813 * add an external Registrar. For that case, PBC shall not be used and
814 * as such, the PushButton config method is removed from M1 by default.
815 * If pbc_in_m1=1 is included in the configuration file, the PushButton
816 * config method is left in M1 (if included in config_methods
817 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
818 * a label in the AP).
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800819 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700820 int pbc_in_m1;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800821
822 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700823 * autoscan - Automatic scan parameters or %NULL if none
824 *
825 * This is an optional set of parameters for automatic scanning
826 * within an interface in following format:
827 * <autoscan module name>:<module parameters>
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800828 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700829 char *autoscan;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800830
831 /**
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800832 * wps_nfc_pw_from_config - NFC Device Password was read from config
833 *
834 * This parameter can be determined whether the NFC Device Password was
835 * included in the configuration (1) or generated dynamically (0). Only
836 * the former case is re-written back to the configuration file.
837 */
838 int wps_nfc_pw_from_config;
839
840 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700841 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800842 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700843 int wps_nfc_dev_pw_id;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800844
845 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700846 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800847 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700848 struct wpabuf *wps_nfc_dh_pubkey;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800849
850 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800851 * wps_nfc_dh_privkey - NFC DH Private Key for password token
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800852 */
Dmitry Shmidt04949592012-07-19 12:16:46 -0700853 struct wpabuf *wps_nfc_dh_privkey;
854
855 /**
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800856 * wps_nfc_dev_pw - NFC Device Password for password token
Dmitry Shmidt04949592012-07-19 12:16:46 -0700857 */
858 struct wpabuf *wps_nfc_dev_pw;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700859
860 /**
861 * ext_password_backend - External password backend or %NULL if none
862 *
863 * format: <backend name>[:<optional backend parameters>]
864 */
865 char *ext_password_backend;
866
867 /*
868 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
869 *
870 * This timeout value is used in P2P GO mode to clean up
871 * inactive stations.
872 * By default: 300 seconds.
873 */
874 int p2p_go_max_inactivity;
875
876 struct hostapd_wmm_ac_params wmm_ac_params[4];
877
878 /**
879 * auto_interworking - Whether to use network selection automatically
880 *
881 * 0 = do not automatically go through Interworking network selection
882 * (i.e., require explicit interworking_select command for this)
883 * 1 = perform Interworking network selection if one or more
884 * credentials have been configured and scan did not find a
885 * matching network block
886 */
887 int auto_interworking;
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800888
889 /**
890 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
891 *
892 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
893 * Note that regulatory constraints and driver capabilities are
894 * consulted anyway, so setting it to 1 can't do real harm.
895 * By default: 0 (disabled)
896 */
897 int p2p_go_ht40;
898
899 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700900 * p2p_go_vht - Default mode for VHT enable when operating as GO
901 *
902 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
903 * Note that regulatory constraints and driver capabilities are
904 * consulted anyway, so setting it to 1 can't do real harm.
905 * By default: 0 (disabled)
906 */
907 int p2p_go_vht;
908
909 /**
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800910 * p2p_disabled - Whether P2P operations are disabled for this interface
911 */
912 int p2p_disabled;
913
914 /**
915 * p2p_no_group_iface - Whether group interfaces can be used
916 *
917 * By default, wpa_supplicant will create a separate interface for P2P
918 * group operations if the driver supports this. This functionality can
919 * be disabled by setting this parameter to 1. In that case, the same
920 * interface that was used for the P2P management operations is used
921 * also for the group operation.
922 */
923 int p2p_no_group_iface;
924
925 /**
926 * okc - Whether to enable opportunistic key caching by default
927 *
928 * By default, OKC is disabled unless enabled by the per-network
929 * proactive_key_caching=1 parameter. okc=1 can be used to change this
930 * default behavior.
931 */
932 int okc;
933
934 /**
935 * pmf - Whether to enable/require PMF by default
936 *
937 * By default, PMF is disabled unless enabled by the per-network
938 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
939 * this default behavior.
940 */
941 enum mfp_options pmf;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800942
943 /**
944 * sae_groups - Preference list of enabled groups for SAE
945 *
946 * By default (if this parameter is not set), the mandatory group 19
947 * (ECC group defined over a 256-bit prime order field) is preferred,
948 * but other groups are also enabled. If this parameter is set, the
949 * groups will be tried in the indicated order.
950 */
951 int *sae_groups;
Dmitry Shmidt7a5e50a2013-03-05 12:37:16 -0800952
953 /**
954 * dtim_period - Default DTIM period in Beacon intervals
955 *
956 * This parameter can be used to set the default value for network
957 * blocks that do not specify dtim_period.
958 */
959 int dtim_period;
960
961 /**
962 * beacon_int - Default Beacon interval in TU
963 *
964 * This parameter can be used to set the default value for network
965 * blocks that do not specify beacon_int.
966 */
967 int beacon_int;
Dmitry Shmidt0ccb66e2013-03-29 16:41:28 -0700968
969 /**
970 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
971 *
972 * This parameter can be used to define additional vendor specific
973 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
974 * format for these element(s) is a hexdump of the raw information
975 * elements (id+len+payload for one or more elements).
976 */
977 struct wpabuf *ap_vendor_elements;
Dmitry Shmidt444d5672013-04-01 13:08:44 -0700978
979 /**
980 * ignore_old_scan_res - Ignore scan results older than request
981 *
982 * The driver may have a cache of scan results that makes it return
983 * information that is older than our scan trigger. This parameter can
984 * be used to configure such old information to be ignored instead of
985 * allowing it to update the internal BSS table.
986 */
987 int ignore_old_scan_res;
Dmitry Shmidt51b6ea82013-05-08 10:42:09 -0700988
989 /**
990 * sched_scan_interval - schedule scan interval
991 */
992 unsigned int sched_scan_interval;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800993
994 /**
995 * tdls_external_control - External control for TDLS setup requests
996 *
997 * Enable TDLS mode where external programs are given the control
998 * to specify the TDLS link to get established to the driver. The
999 * driver requests the TDLS setup to the supplicant only for the
1000 * specified TDLS peers.
1001 */
1002 int tdls_external_control;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08001003
1004 u8 ip_addr_go[4];
1005 u8 ip_addr_mask[4];
1006 u8 ip_addr_start[4];
1007 u8 ip_addr_end[4];
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001008
1009 /**
1010 * osu_dir - OSU provider information directory
1011 *
1012 * If set, allow FETCH_OSU control interface command to be used to fetch
1013 * OSU provider information into all APs and store the results in this
1014 * directory.
1015 */
1016 char *osu_dir;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001017};
1018
1019
1020/* Prototypes for common functions from config.c */
1021
1022void wpa_config_free(struct wpa_config *ssid);
1023void wpa_config_free_ssid(struct wpa_ssid *ssid);
1024void wpa_config_foreach_network(struct wpa_config *config,
1025 void (*func)(void *, struct wpa_ssid *),
1026 void *arg);
1027struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1028struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1029int wpa_config_remove_network(struct wpa_config *config, int id);
1030void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1031int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1032 int line);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001033int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1034 const char *value);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001035char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1036char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1037char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1038void wpa_config_update_psk(struct wpa_ssid *ssid);
1039int wpa_config_add_prio_network(struct wpa_config *config,
1040 struct wpa_ssid *ssid);
1041int wpa_config_update_prio_list(struct wpa_config *config);
1042const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1043 const char *name);
1044void wpa_config_set_blob(struct wpa_config *config,
1045 struct wpa_config_blob *blob);
1046void wpa_config_free_blob(struct wpa_config_blob *blob);
1047int wpa_config_remove_blob(struct wpa_config *config, const char *name);
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001048void wpa_config_flush_blobs(struct wpa_config *config);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001049
Dmitry Shmidt04949592012-07-19 12:16:46 -07001050struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1051struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1052int wpa_config_remove_cred(struct wpa_config *config, int id);
1053void wpa_config_free_cred(struct wpa_cred *cred);
1054int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1055 const char *value, int line);
Dmitry Shmidt0cfd5f72014-04-04 14:48:05 -07001056char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
Dmitry Shmidt04949592012-07-19 12:16:46 -07001057
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001058struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1059 const char *driver_param);
1060#ifndef CONFIG_NO_STDOUT_DEBUG
1061void wpa_config_debug_dump_networks(struct wpa_config *config);
1062#else /* CONFIG_NO_STDOUT_DEBUG */
1063#define wpa_config_debug_dump_networks(c) do { } while (0)
1064#endif /* CONFIG_NO_STDOUT_DEBUG */
1065
1066
1067/* Prototypes for common functions from config.c */
1068int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1069
1070
1071/* Prototypes for backend specific functions from the selected config_*.c */
1072
1073/**
1074 * wpa_config_read - Read and parse configuration database
1075 * @name: Name of the configuration (e.g., path and file name for the
1076 * configuration file)
Jouni Malinen5d1c8ad2013-04-23 12:34:56 -07001077 * @cfgp: Pointer to previously allocated configuration data or %NULL if none
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001078 * Returns: Pointer to allocated configuration data or %NULL on failure
1079 *
1080 * This function reads configuration data, parses its contents, and allocates
1081 * data structures needed for storing configuration information. The allocated
1082 * data can be freed with wpa_config_free().
1083 *
1084 * Each configuration backend needs to implement this function.
1085 */
Dmitry Shmidt64f47c52013-04-16 10:41:54 -07001086struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001087
1088/**
1089 * wpa_config_write - Write or update configuration data
1090 * @name: Name of the configuration (e.g., path and file name for the
1091 * configuration file)
1092 * @config: Configuration data from wpa_config_read()
1093 * Returns: 0 on success, -1 on failure
1094 *
1095 * This function write all configuration data into an external database (e.g.,
1096 * a text file) in a format that can be read with wpa_config_read(). This can
1097 * be used to allow wpa_supplicant to update its configuration, e.g., when a
1098 * new network is added or a password is changed.
1099 *
1100 * Each configuration backend needs to implement this function.
1101 */
1102int wpa_config_write(const char *name, struct wpa_config *config);
1103
1104#endif /* CONFIG_H */