• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * WPA Supplicant / Configuration file structures
3  * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
4  *
5  * This software may be distributed under the terms of the BSD license.
6  * See README for more details.
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 */
18 #define DEFAULT_FAST_REAUTH 1
19 #define DEFAULT_P2P_GO_INTENT 7
20 #define DEFAULT_P2P_INTRA_BSS 1
21 #define DEFAULT_P2P_GO_MAX_INACTIVITY (5 * 60)
22 #define DEFAULT_P2P_OPTIMIZE_LISTEN_CHAN 0
23 #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
27 #define DEFAULT_ACCESS_NETWORK_TYPE 15
28 #define DEFAULT_SCAN_CUR_FREQ 0
29 #define DEFAULT_P2P_SEARCH_DELAY 500
30 
31 #include "config_ssid.h"
32 #include "wps/wps.h"
33 #include "common/ieee802_11_common.h"
34 
35 
36 struct 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 	/**
57 	 * temporary - Whether this credential is temporary and not to be saved
58 	 */
59 	int temporary;
60 
61 	/**
62 	 * 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 	/**
94 	 * ext_password - Whether password is a name for external storage
95 	 */
96 	int ext_password;
97 
98 	/**
99 	 * 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 	/**
160 	 * 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)
179 	 *
180 	 * This is used to compare against the Domain Name List to figure out
181 	 * 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.
184 	 */
185 	char **domain;
186 
187 	/**
188 	 * num_domain - Number of FQDNs in the domain array
189 	 */
190 	size_t num_domain;
191 
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 
210 	u8 required_roaming_consortium[15];
211 	size_t required_roaming_consortium_len;
212 
213 	/**
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;
235 
236 	struct excluded_ssid {
237 		u8 ssid[MAX_SSID_LEN];
238 		size_t ssid_len;
239 	} *excluded_ssid;
240 	size_t num_excluded_ssid;
241 
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;
293 
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;
301 };
302 
303 
304 #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)
315 #define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
316 #define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
317 #define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
318 #define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
319 #define CFG_CHANGED_NFC_PASSWORD_TOKEN BIT(15)
320 #define CFG_CHANGED_P2P_PASSPHRASE_LEN BIT(16)
321 
322 /**
323  * struct wpa_config - wpa_supplicant configuration data
324  *
325  * This data structure is presents the per-interface (radio) configuration
326  * data. In many cases, there is only one struct wpa_config instance, but if
327  * more than one network interface is being controlled, one instance is used
328  * for each.
329  */
330 struct wpa_config {
331 	/**
332 	 * ssid - Head of the global network list
333 	 *
334 	 * This is the head for the list of all the configured networks.
335 	 */
336 	struct wpa_ssid *ssid;
337 
338 	/**
339 	 * pssid - Per-priority network lists (in priority order)
340 	 */
341 	struct wpa_ssid **pssid;
342 
343 	/**
344 	 * num_prio - Number of different priorities used in the pssid lists
345 	 *
346 	 * This indicates how many per-priority network lists are included in
347 	 * pssid.
348 	 */
349 	int num_prio;
350 
351 	/**
352 	 * cred - Head of the credential list
353 	 *
354 	 * This is the head for the list of all the configured credentials.
355 	 */
356 	struct wpa_cred *cred;
357 
358 	/**
359 	 * eapol_version - IEEE 802.1X/EAPOL version number
360 	 *
361 	 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
362 	 * defines EAPOL version 2. However, there are many APs that do not
363 	 * handle the new version number correctly (they seem to drop the
364 	 * frames completely). In order to make wpa_supplicant interoperate
365 	 * with these APs, the version number is set to 1 by default. This
366 	 * configuration value can be used to set it to the new version (2).
367 	 */
368 	int eapol_version;
369 
370 	/**
371 	 * ap_scan - AP scanning/selection
372 	 *
373 	 * By default, wpa_supplicant requests driver to perform AP
374 	 * scanning and then uses the scan results to select a
375 	 * suitable AP. Another alternative is to allow the driver to
376 	 * take care of AP scanning and selection and use
377 	 * wpa_supplicant just to process EAPOL frames based on IEEE
378 	 * 802.11 association information from the driver.
379 	 *
380 	 * 1: wpa_supplicant initiates scanning and AP selection (default).
381 	 *
382 	 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
383 	 * association parameters (e.g., WPA IE generation); this mode can
384 	 * also be used with non-WPA drivers when using IEEE 802.1X mode;
385 	 * do not try to associate with APs (i.e., external program needs
386 	 * to control association). This mode must also be used when using
387 	 * wired Ethernet drivers.
388 	 *
389 	 * 2: like 0, but associate with APs using security policy and SSID
390 	 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
391 	 * drivers to enable operation with hidden SSIDs and optimized roaming;
392 	 * in this mode, the network blocks in the configuration are tried
393 	 * one by one until the driver reports successful association; each
394 	 * network block should have explicit security policy (i.e., only one
395 	 * option in the lists) for key_mgmt, pairwise, group, proto variables.
396 	 */
397 	int ap_scan;
398 
399 	/**
400 	 * bgscan - Background scan and roaming parameters or %NULL if none
401 	 *
402 	 * This is an optional set of parameters for background scanning and
403 	 * roaming within a network (ESS). For more detailed information see
404 	 * ssid block documentation.
405 	 *
406 	 * The variable defines default bgscan behavior for all BSS station
407 	 * networks except for those which have their own bgscan configuration.
408 	 */
409 	 char *bgscan;
410 
411 	/**
412 	 * disable_scan_offload - Disable automatic offloading of scan requests
413 	 *
414 	 * By default, %wpa_supplicant tries to offload scanning if the driver
415 	 * indicates support for this (sched_scan). This configuration
416 	 * parameter can be used to disable this offloading mechanism.
417 	 */
418 	int disable_scan_offload;
419 
420 	/**
421 	 * ctrl_interface - Parameters for the control interface
422 	 *
423 	 * If this is specified, %wpa_supplicant will open a control interface
424 	 * that is available for external programs to manage %wpa_supplicant.
425 	 * The meaning of this string depends on which control interface
426 	 * mechanism is used. For all cases, the existence of this parameter
427 	 * in configuration is used to determine whether the control interface
428 	 * is enabled.
429 	 *
430 	 * For UNIX domain sockets (default on Linux and BSD): This is a
431 	 * directory that will be created for UNIX domain sockets for listening
432 	 * to requests from external programs (CLI/GUI, etc.) for status
433 	 * information and configuration. The socket file will be named based
434 	 * on the interface name, so multiple %wpa_supplicant processes can be
435 	 * run at the same time if more than one interface is used.
436 	 * /var/run/wpa_supplicant is the recommended directory for sockets and
437 	 * by default, wpa_cli will use it when trying to connect with
438 	 * %wpa_supplicant.
439 	 *
440 	 * Access control for the control interface can be configured
441 	 * by setting the directory to allow only members of a group
442 	 * to use sockets. This way, it is possible to run
443 	 * %wpa_supplicant as root (since it needs to change network
444 	 * configuration and open raw sockets) and still allow GUI/CLI
445 	 * components to be run as non-root users. However, since the
446 	 * control interface can be used to change the network
447 	 * configuration, this access needs to be protected in many
448 	 * cases. By default, %wpa_supplicant is configured to use gid
449 	 * 0 (root). If you want to allow non-root users to use the
450 	 * control interface, add a new group and change this value to
451 	 * match with that group. Add users that should have control
452 	 * interface access to this group.
453 	 *
454 	 * When configuring both the directory and group, use following format:
455 	 * DIR=/var/run/wpa_supplicant GROUP=wheel
456 	 * DIR=/var/run/wpa_supplicant GROUP=0
457 	 * (group can be either group name or gid)
458 	 *
459 	 * For UDP connections (default on Windows): The value will be ignored.
460 	 * This variable is just used to select that the control interface is
461 	 * to be created. The value can be set to, e.g., udp
462 	 * (ctrl_interface=udp).
463 	 *
464 	 * For Windows Named Pipe: This value can be used to set the security
465 	 * descriptor for controlling access to the control interface. Security
466 	 * descriptor can be set using Security Descriptor String Format (see
467 	 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
468 	 * The descriptor string needs to be prefixed with SDDL=. For example,
469 	 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
470 	 * all connections).
471 	 */
472 	char *ctrl_interface;
473 
474 	/**
475 	 * ctrl_interface_group - Control interface group (DEPRECATED)
476 	 *
477 	 * This variable is only used for backwards compatibility. Group for
478 	 * UNIX domain sockets should now be specified using GROUP=group in
479 	 * ctrl_interface variable.
480 	 */
481 	char *ctrl_interface_group;
482 
483 	/**
484 	 * fast_reauth - EAP fast re-authentication (session resumption)
485 	 *
486 	 * By default, fast re-authentication is enabled for all EAP methods
487 	 * that support it. This variable can be used to disable fast
488 	 * re-authentication (by setting fast_reauth=0). Normally, there is no
489 	 * need to disable fast re-authentication.
490 	 */
491 	int fast_reauth;
492 
493 	/**
494 	 * opensc_engine_path - Path to the OpenSSL engine for opensc
495 	 *
496 	 * This is an OpenSSL specific configuration option for loading OpenSC
497 	 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
498 	 */
499 	char *opensc_engine_path;
500 
501 	/**
502 	 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
503 	 *
504 	 * This is an OpenSSL specific configuration option for loading PKCS#11
505 	 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
506 	 */
507 	char *pkcs11_engine_path;
508 
509 	/**
510 	 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
511 	 *
512 	 * This is an OpenSSL specific configuration option for configuring
513 	 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
514 	 * module is not loaded.
515 	 */
516 	char *pkcs11_module_path;
517 
518 	/**
519 	 * pcsc_reader - PC/SC reader name prefix
520 	 *
521 	 * If not %NULL, PC/SC reader with a name that matches this prefix is
522 	 * initialized for SIM/USIM access. Empty string can be used to match
523 	 * the first available reader.
524 	 */
525 	char *pcsc_reader;
526 
527 	/**
528 	 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
529 	 *
530 	 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
531 	 * EAP-AKA. If left out, this will be asked through control interface.
532 	 */
533 	char *pcsc_pin;
534 
535 	/**
536 	 * external_sim - Use external processing for SIM/USIM operations
537 	 */
538 	int external_sim;
539 
540 	/**
541 	 * driver_param - Driver interface parameters
542 	 *
543 	 * This text string is passed to the selected driver interface with the
544 	 * optional struct wpa_driver_ops::set_param() handler. This can be
545 	 * used to configure driver specific options without having to add new
546 	 * driver interface functionality.
547 	 */
548 	char *driver_param;
549 
550 	/**
551 	 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
552 	 *
553 	 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
554 	 * cache (unit: seconds).
555 	 */
556 	unsigned int dot11RSNAConfigPMKLifetime;
557 
558 	/**
559 	 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
560 	 *
561 	 * dot11 MIB variable for the percentage of the PMK lifetime
562 	 * that should expire before an IEEE 802.1X reauthentication occurs.
563 	 */
564 	unsigned int dot11RSNAConfigPMKReauthThreshold;
565 
566 	/**
567 	 * dot11RSNAConfigSATimeout - Security association timeout
568 	 *
569 	 * dot11 MIB variable for the maximum time a security association
570 	 * shall take to set up (unit: seconds).
571 	 */
572 	unsigned int dot11RSNAConfigSATimeout;
573 
574 	/**
575 	 * update_config - Is wpa_supplicant allowed to update configuration
576 	 *
577 	 * This variable control whether wpa_supplicant is allow to re-write
578 	 * its configuration with wpa_config_write(). If this is zero,
579 	 * configuration data is only changed in memory and the external data
580 	 * is not overriden. If this is non-zero, wpa_supplicant will update
581 	 * the configuration data (e.g., a file) whenever configuration is
582 	 * changed. This update may replace the old configuration which can
583 	 * remove comments from it in case of a text file configuration.
584 	 */
585 	int update_config;
586 
587 	/**
588 	 * blobs - Configuration blobs
589 	 */
590 	struct wpa_config_blob *blobs;
591 
592 	/**
593 	 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
594 	 */
595 	u8 uuid[16];
596 
597 	/**
598 	 * device_name - Device Name (WPS)
599 	 * User-friendly description of device; up to 32 octets encoded in
600 	 * UTF-8
601 	 */
602 	char *device_name;
603 
604 	/**
605 	 * manufacturer - Manufacturer (WPS)
606 	 * The manufacturer of the device (up to 64 ASCII characters)
607 	 */
608 	char *manufacturer;
609 
610 	/**
611 	 * model_name - Model Name (WPS)
612 	 * Model of the device (up to 32 ASCII characters)
613 	 */
614 	char *model_name;
615 
616 	/**
617 	 * model_number - Model Number (WPS)
618 	 * Additional device description (up to 32 ASCII characters)
619 	 */
620 	char *model_number;
621 
622 	/**
623 	 * serial_number - Serial Number (WPS)
624 	 * Serial number of the device (up to 32 characters)
625 	 */
626 	char *serial_number;
627 
628 	/**
629 	 * device_type - Primary Device Type (WPS)
630 	 */
631 	u8 device_type[WPS_DEV_TYPE_LEN];
632 
633 	/**
634 	 * config_methods - Config Methods
635 	 *
636 	 * This is a space-separated list of supported WPS configuration
637 	 * methods. For example, "label virtual_display virtual_push_button
638 	 * keypad".
639 	 * Available methods: usba ethernet label display ext_nfc_token
640 	 * int_nfc_token nfc_interface push_button keypad
641 	 * virtual_display physical_display
642 	 * virtual_push_button physical_push_button.
643 	 */
644 	char *config_methods;
645 
646 	/**
647 	 * os_version - OS Version (WPS)
648 	 * 4-octet operating system version number
649 	 */
650 	u8 os_version[4];
651 
652 	/**
653 	 * country - Country code
654 	 *
655 	 * This is the ISO/IEC alpha2 country code for which we are operating
656 	 * in
657 	 */
658 	char country[2];
659 
660 	/**
661 	 * wps_cred_processing - Credential processing
662 	 *
663 	 *   0 = process received credentials internally
664 	 *   1 = do not process received credentials; just pass them over
665 	 *	ctrl_iface to external program(s)
666 	 *   2 = process received credentials internally and pass them over
667 	 *	ctrl_iface to external program(s)
668 	 */
669 	int wps_cred_processing;
670 
671 #define MAX_SEC_DEVICE_TYPES 5
672 	/**
673 	 * sec_device_types - Secondary Device Types (P2P)
674 	 */
675 	u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
676 	int num_sec_device_types;
677 
678 	int p2p_listen_reg_class;
679 	int p2p_listen_channel;
680 	int p2p_oper_reg_class;
681 	int p2p_oper_channel;
682 	int p2p_go_intent;
683 	char *p2p_ssid_postfix;
684 	int persistent_reconnect;
685 	int p2p_intra_bss;
686 	unsigned int num_p2p_pref_chan;
687 	struct p2p_channel *p2p_pref_chan;
688 	struct wpa_freq_range_list p2p_no_go_freq;
689 	int p2p_add_cli_chan;
690 	int p2p_ignore_shared_freq;
691 	int p2p_optimize_listen_chan;
692 
693 	struct wpabuf *wps_vendor_ext_m1;
694 
695 #define MAX_WPS_VENDOR_EXT 10
696 	/**
697 	 * wps_vendor_ext - Vendor extension attributes in WPS
698 	 */
699 	struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
700 
701 	/**
702 	 * p2p_group_idle - Maximum idle time in seconds for P2P group
703 	 *
704 	 * This value controls how long a P2P group is maintained after there
705 	 * is no other members in the group. As a GO, this means no associated
706 	 * stations in the group. As a P2P client, this means no GO seen in
707 	 * scan results. The maximum idle time is specified in seconds with 0
708 	 * indicating no time limit, i.e., the P2P group remains in active
709 	 * state indefinitely until explicitly removed. As a P2P client, the
710 	 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
711 	 * this parameter is mainly meant for GO use and for P2P client, it can
712 	 * only be used to reduce the default timeout to smaller value. A
713 	 * special value -1 can be used to configure immediate removal of the
714 	 * group for P2P client role on any disconnection after the data
715 	 * connection has been established.
716 	 */
717 	int p2p_group_idle;
718 
719 	/**
720 	 * p2p_passphrase_len - Passphrase length (8..63) for P2P GO
721 	 *
722 	 * This parameter controls the length of the random passphrase that is
723 	 * generated at the GO.
724 	 */
725 	unsigned int p2p_passphrase_len;
726 
727 	/**
728 	 * bss_max_count - Maximum number of BSS entries to keep in memory
729 	 */
730 	unsigned int bss_max_count;
731 
732 	/**
733 	 * bss_expiration_age - BSS entry age after which it can be expired
734 	 *
735 	 * This value controls the time in seconds after which a BSS entry
736 	 * gets removed if it has not been updated or is not in use.
737 	 */
738 	unsigned int bss_expiration_age;
739 
740 	/**
741 	 * bss_expiration_scan_count - Expire BSS after number of scans
742 	 *
743 	 * If the BSS entry has not been seen in this many scans, it will be
744 	 * removed. A value of 1 means that entry is removed after the first
745 	 * scan in which the BSSID is not seen. Larger values can be used
746 	 * to avoid BSS entries disappearing if they are not visible in
747 	 * every scan (e.g., low signal quality or interference).
748 	 */
749 	unsigned int bss_expiration_scan_count;
750 
751 	/**
752 	 * filter_ssids - SSID-based scan result filtering
753 	 *
754 	 *   0 = do not filter scan results
755 	 *   1 = only include configured SSIDs in scan results/BSS table
756 	 */
757 	int filter_ssids;
758 
759 	/**
760 	 * filter_rssi - RSSI-based scan result filtering
761 	 *
762 	 * 0 = do not filter scan results
763 	 * -n = filter scan results below -n dBm
764 	 */
765 	int filter_rssi;
766 
767 	/**
768 	 * max_num_sta - Maximum number of STAs in an AP/P2P GO
769 	 */
770 	unsigned int max_num_sta;
771 
772 	/**
773 	 * freq_list - Array of allowed scan frequencies or %NULL for all
774 	 *
775 	 * This is an optional zero-terminated array of frequencies in
776 	 * megahertz (MHz) to allow for narrowing scanning range.
777 	 */
778 	int *freq_list;
779 
780 	/**
781 	 * scan_cur_freq - Whether to scan only the current channel
782 	 *
783 	 * If true, attempt to scan only the current channel if any other
784 	 * VIFs on this radio are already associated on a particular channel.
785 	 */
786 	int scan_cur_freq;
787 
788 	/**
789 	 * changed_parameters - Bitmap of changed parameters since last update
790 	 */
791 	unsigned int changed_parameters;
792 
793 	/**
794 	 * disassoc_low_ack - Disassocicate stations with massive packet loss
795 	 */
796 	int disassoc_low_ack;
797 
798 	/**
799 	 * interworking - Whether Interworking (IEEE 802.11u) is enabled
800 	 */
801 	int interworking;
802 
803 	/**
804 	 * access_network_type - Access Network Type
805 	 *
806 	 * When Interworking is enabled, scans will be limited to APs that
807 	 * advertise the specified Access Network Type (0..15; with 15
808 	 * indicating wildcard match).
809 	 */
810 	int access_network_type;
811 
812 	/**
813 	 * hessid - Homogenous ESS identifier
814 	 *
815 	 * If this is set (any octet is non-zero), scans will be used to
816 	 * request response only from BSSes belonging to the specified
817 	 * Homogeneous ESS. This is used only if interworking is enabled.
818 	 */
819 	u8 hessid[ETH_ALEN];
820 
821 	/**
822 	 * hs20 - Hotspot 2.0
823 	 */
824 	int hs20;
825 
826 	/**
827 	 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
828 	 *
829 	 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
830 	 * by acting as a Registrar and using M1 from the AP. The config
831 	 * methods attribute in that message is supposed to indicate only the
832 	 * configuration method supported by the AP in Enrollee role, i.e., to
833 	 * add an external Registrar. For that case, PBC shall not be used and
834 	 * as such, the PushButton config method is removed from M1 by default.
835 	 * If pbc_in_m1=1 is included in the configuration file, the PushButton
836 	 * config method is left in M1 (if included in config_methods
837 	 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
838 	 * a label in the AP).
839 	 */
840 	int pbc_in_m1;
841 
842 	/**
843 	 * autoscan - Automatic scan parameters or %NULL if none
844 	 *
845 	 * This is an optional set of parameters for automatic scanning
846 	 * within an interface in following format:
847 	 * <autoscan module name>:<module parameters>
848 	 */
849 	char *autoscan;
850 
851 	/**
852 	 * wps_nfc_pw_from_config - NFC Device Password was read from config
853 	 *
854 	 * This parameter can be determined whether the NFC Device Password was
855 	 * included in the configuration (1) or generated dynamically (0). Only
856 	 * the former case is re-written back to the configuration file.
857 	 */
858 	int wps_nfc_pw_from_config;
859 
860 	/**
861 	 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
862 	 */
863 	int wps_nfc_dev_pw_id;
864 
865 	/**
866 	 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
867 	 */
868 	struct wpabuf *wps_nfc_dh_pubkey;
869 
870 	/**
871 	 * wps_nfc_dh_privkey - NFC DH Private Key for password token
872 	 */
873 	struct wpabuf *wps_nfc_dh_privkey;
874 
875 	/**
876 	 * wps_nfc_dev_pw - NFC Device Password for password token
877 	 */
878 	struct wpabuf *wps_nfc_dev_pw;
879 
880 	/**
881 	 * ext_password_backend - External password backend or %NULL if none
882 	 *
883 	 * format: <backend name>[:<optional backend parameters>]
884 	 */
885 	char *ext_password_backend;
886 
887 	/*
888 	 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
889 	 *
890 	 * This timeout value is used in P2P GO mode to clean up
891 	 * inactive stations.
892 	 * By default: 300 seconds.
893 	 */
894 	int p2p_go_max_inactivity;
895 
896 	struct hostapd_wmm_ac_params wmm_ac_params[4];
897 
898 	/**
899 	 * auto_interworking - Whether to use network selection automatically
900 	 *
901 	 * 0 = do not automatically go through Interworking network selection
902 	 *     (i.e., require explicit interworking_select command for this)
903 	 * 1 = perform Interworking network selection if one or more
904 	 *     credentials have been configured and scan did not find a
905 	 *     matching network block
906 	 */
907 	int auto_interworking;
908 
909 	/**
910 	 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
911 	 *
912 	 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
913 	 * Note that regulatory constraints and driver capabilities are
914 	 * consulted anyway, so setting it to 1 can't do real harm.
915 	 * By default: 0 (disabled)
916 	 */
917 	int p2p_go_ht40;
918 
919 	/**
920 	 * p2p_go_vht - Default mode for VHT enable when operating as GO
921 	 *
922 	 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
923 	 * Note that regulatory constraints and driver capabilities are
924 	 * consulted anyway, so setting it to 1 can't do real harm.
925 	 * By default: 0 (disabled)
926 	 */
927 	int p2p_go_vht;
928 
929 	/**
930 	 * p2p_disabled - Whether P2P operations are disabled for this interface
931 	 */
932 	int p2p_disabled;
933 
934 	/**
935 	 * p2p_no_group_iface - Whether group interfaces can be used
936 	 *
937 	 * By default, wpa_supplicant will create a separate interface for P2P
938 	 * group operations if the driver supports this. This functionality can
939 	 * be disabled by setting this parameter to 1. In that case, the same
940 	 * interface that was used for the P2P management operations is used
941 	 * also for the group operation.
942 	 */
943 	int p2p_no_group_iface;
944 
945 	/**
946 	 * okc - Whether to enable opportunistic key caching by default
947 	 *
948 	 * By default, OKC is disabled unless enabled by the per-network
949 	 * proactive_key_caching=1 parameter. okc=1 can be used to change this
950 	 * default behavior.
951 	 */
952 	int okc;
953 
954 	/**
955 	 * pmf - Whether to enable/require PMF by default
956 	 *
957 	 * By default, PMF is disabled unless enabled by the per-network
958 	 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
959 	 * this default behavior.
960 	 */
961 	enum mfp_options pmf;
962 
963 	/**
964 	 * sae_groups - Preference list of enabled groups for SAE
965 	 *
966 	 * By default (if this parameter is not set), the mandatory group 19
967 	 * (ECC group defined over a 256-bit prime order field) is preferred,
968 	 * but other groups are also enabled. If this parameter is set, the
969 	 * groups will be tried in the indicated order.
970 	 */
971 	int *sae_groups;
972 
973 	/**
974 	 * dtim_period - Default DTIM period in Beacon intervals
975 	 *
976 	 * This parameter can be used to set the default value for network
977 	 * blocks that do not specify dtim_period.
978 	 */
979 	int dtim_period;
980 
981 	/**
982 	 * beacon_int - Default Beacon interval in TU
983 	 *
984 	 * This parameter can be used to set the default value for network
985 	 * blocks that do not specify beacon_int.
986 	 */
987 	int beacon_int;
988 
989 	/**
990 	 * ap_vendor_elements: Vendor specific elements for Beacon/ProbeResp
991 	 *
992 	 * This parameter can be used to define additional vendor specific
993 	 * elements for Beacon and Probe Response frames in AP/P2P GO mode. The
994 	 * format for these element(s) is a hexdump of the raw information
995 	 * elements (id+len+payload for one or more elements).
996 	 */
997 	struct wpabuf *ap_vendor_elements;
998 
999 	/**
1000 	 * ignore_old_scan_res - Ignore scan results older than request
1001 	 *
1002 	 * The driver may have a cache of scan results that makes it return
1003 	 * information that is older than our scan trigger. This parameter can
1004 	 * be used to configure such old information to be ignored instead of
1005 	 * allowing it to update the internal BSS table.
1006 	 */
1007 	int ignore_old_scan_res;
1008 
1009 	/**
1010 	 * sched_scan_interval -  schedule scan interval
1011 	 */
1012 	unsigned int sched_scan_interval;
1013 
1014 	/**
1015 	 * tdls_external_control - External control for TDLS setup requests
1016 	 *
1017 	 * Enable TDLS mode where external programs are given the control
1018 	 * to specify the TDLS link to get established to the driver. The
1019 	 * driver requests the TDLS setup to the supplicant only for the
1020 	 * specified TDLS peers.
1021 	 */
1022 	int tdls_external_control;
1023 
1024 	u8 ip_addr_go[4];
1025 	u8 ip_addr_mask[4];
1026 	u8 ip_addr_start[4];
1027 	u8 ip_addr_end[4];
1028 
1029 	/**
1030 	 * osu_dir - OSU provider information directory
1031 	 *
1032 	 * If set, allow FETCH_OSU control interface command to be used to fetch
1033 	 * OSU provider information into all APs and store the results in this
1034 	 * directory.
1035 	 */
1036 	char *osu_dir;
1037 
1038 	/**
1039 	 * wowlan_triggers - Wake-on-WLAN triggers
1040 	 *
1041 	 * If set, these wowlan triggers will be configured.
1042 	 */
1043 	char *wowlan_triggers;
1044 
1045 	/**
1046 	 * p2p_search_delay - Extra delay between concurrent search iterations
1047 	 *
1048 	 * Add extra delay (in milliseconds) between search iterations when
1049 	 * there is a concurrent operation to make p2p_find friendlier to
1050 	 * concurrent operations by avoiding it from taking 100% of radio
1051 	 * resources.
1052 	 */
1053 	unsigned int p2p_search_delay;
1054 };
1055 
1056 
1057 /* Prototypes for common functions from config.c */
1058 
1059 void wpa_config_free(struct wpa_config *ssid);
1060 void wpa_config_free_ssid(struct wpa_ssid *ssid);
1061 void wpa_config_foreach_network(struct wpa_config *config,
1062 				void (*func)(void *, struct wpa_ssid *),
1063 				void *arg);
1064 struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
1065 struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
1066 int wpa_config_remove_network(struct wpa_config *config, int id);
1067 void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
1068 int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
1069 		   int line);
1070 int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
1071 			  const char *value);
1072 char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
1073 char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
1074 char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
1075 void wpa_config_update_psk(struct wpa_ssid *ssid);
1076 int wpa_config_add_prio_network(struct wpa_config *config,
1077 				struct wpa_ssid *ssid);
1078 int wpa_config_update_prio_list(struct wpa_config *config);
1079 const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
1080 						   const char *name);
1081 void wpa_config_set_blob(struct wpa_config *config,
1082 			 struct wpa_config_blob *blob);
1083 void wpa_config_free_blob(struct wpa_config_blob *blob);
1084 int wpa_config_remove_blob(struct wpa_config *config, const char *name);
1085 void wpa_config_flush_blobs(struct wpa_config *config);
1086 
1087 struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
1088 struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
1089 int wpa_config_remove_cred(struct wpa_config *config, int id);
1090 void wpa_config_free_cred(struct wpa_cred *cred);
1091 int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
1092 			const char *value, int line);
1093 char * wpa_config_get_cred_no_key(struct wpa_cred *cred, const char *var);
1094 
1095 struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
1096 					   const char *driver_param);
1097 #ifndef CONFIG_NO_STDOUT_DEBUG
1098 void wpa_config_debug_dump_networks(struct wpa_config *config);
1099 #else /* CONFIG_NO_STDOUT_DEBUG */
1100 #define wpa_config_debug_dump_networks(c) do { } while (0)
1101 #endif /* CONFIG_NO_STDOUT_DEBUG */
1102 
1103 
1104 /* Prototypes for common functions from config.c */
1105 int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
1106 
1107 
1108 /* Prototypes for backend specific functions from the selected config_*.c */
1109 
1110 /**
1111  * wpa_config_read - Read and parse configuration database
1112  * @name: Name of the configuration (e.g., path and file name for the
1113  * configuration file)
1114  * @cfgp: Pointer to previously allocated configuration data or %NULL if none
1115  * Returns: Pointer to allocated configuration data or %NULL on failure
1116  *
1117  * This function reads configuration data, parses its contents, and allocates
1118  * data structures needed for storing configuration information. The allocated
1119  * data can be freed with wpa_config_free().
1120  *
1121  * Each configuration backend needs to implement this function.
1122  */
1123 struct wpa_config * wpa_config_read(const char *name, struct wpa_config *cfgp);
1124 
1125 /**
1126  * wpa_config_write - Write or update configuration data
1127  * @name: Name of the configuration (e.g., path and file name for the
1128  * configuration file)
1129  * @config: Configuration data from wpa_config_read()
1130  * Returns: 0 on success, -1 on failure
1131  *
1132  * This function write all configuration data into an external database (e.g.,
1133  * a text file) in a format that can be read with wpa_config_read(). This can
1134  * be used to allow wpa_supplicant to update its configuration, e.g., when a
1135  * new network is added or a password is changed.
1136  *
1137  * Each configuration backend needs to implement this function.
1138  */
1139 int wpa_config_write(const char *name, struct wpa_config *config);
1140 
1141 #endif /* CONFIG_H */
1142