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