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_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
26#define DEFAULT_ACCESS_NETWORK_TYPE 15
27
28#include "config_ssid.h"
29#include "wps/wps.h"
30#include "common/ieee802_11_common.h"
31
32
33struct wpa_cred {
34	/**
35	 * next - Next credential in the list
36	 *
37	 * This pointer can be used to iterate over all credentials. The head
38	 * of this list is stored in the cred field of struct wpa_config.
39	 */
40	struct wpa_cred *next;
41
42	/**
43	 * id - Unique id for the credential
44	 *
45	 * This identifier is used as a unique identifier for each credential
46	 * block when using the control interface. Each credential is allocated
47	 * an id when it is being created, either when reading the
48	 * configuration file or when a new credential is added through the
49	 * control interface.
50	 */
51	int id;
52
53	/**
54	 * priority - Priority group
55	 *
56	 * By default, all networks and credentials get the same priority group
57	 * (0). This field can be used to give higher priority for credentials
58	 * (and similarly in struct wpa_ssid for network blocks) to change the
59	 * Interworking automatic networking selection behavior. The matching
60	 * network (based on either an enabled network block or a credential)
61	 * with the highest priority value will be selected.
62	 */
63	int priority;
64
65	/**
66	 * pcsc - Use PC/SC and SIM/USIM card
67	 */
68	int pcsc;
69
70	/**
71	 * realm - Home Realm for Interworking
72	 */
73	char *realm;
74
75	/**
76	 * username - Username for Interworking network selection
77	 */
78	char *username;
79
80	/**
81	 * password - Password for Interworking network selection
82	 */
83	char *password;
84
85	/**
86	 * ext_password - Whether password is a name for external storage
87	 */
88	int ext_password;
89
90	/**
91	 * ca_cert - CA certificate for Interworking network selection
92	 */
93	char *ca_cert;
94
95	/**
96	 * client_cert - File path to client certificate file (PEM/DER)
97	 *
98	 * This field is used with Interworking networking selection for a case
99	 * where client certificate/private key is used for authentication
100	 * (EAP-TLS). Full path to the file should be used since working
101	 * directory may change when wpa_supplicant is run in the background.
102	 *
103	 * Alternatively, a named configuration blob can be used by setting
104	 * this to blob://blob_name.
105	 */
106	char *client_cert;
107
108	/**
109	 * private_key - File path to client private key file (PEM/DER/PFX)
110	 *
111	 * When PKCS#12/PFX file (.p12/.pfx) is used, client_cert should be
112	 * commented out. Both the private key and certificate will be read
113	 * from the PKCS#12 file in this case. Full path to the file should be
114	 * used since working directory may change when wpa_supplicant is run
115	 * in the background.
116	 *
117	 * Windows certificate store can be used by leaving client_cert out and
118	 * configuring private_key in one of the following formats:
119	 *
120	 * cert://substring_to_match
121	 *
122	 * hash://certificate_thumbprint_in_hex
123	 *
124	 * For example: private_key="hash://63093aa9c47f56ae88334c7b65a4"
125	 *
126	 * Note that when running wpa_supplicant as an application, the user
127	 * certificate store (My user account) is used, whereas computer store
128	 * (Computer account) is used when running wpasvc as a service.
129	 *
130	 * Alternatively, a named configuration blob can be used by setting
131	 * this to blob://blob_name.
132	 */
133	char *private_key;
134
135	/**
136	 * private_key_passwd - Password for private key file
137	 */
138	char *private_key_passwd;
139
140	/**
141	 * imsi - IMSI in <MCC> | <MNC> | '-' | <MSIN> format
142	 */
143	char *imsi;
144
145	/**
146	 * milenage - Milenage parameters for SIM/USIM simulator in
147	 *	<Ki>:<OPc>:<SQN> format
148	 */
149	char *milenage;
150
151	/**
152	 * domain - Home service provider FQDN
153	 *
154	 * This is used to compare against the Domain Name List to figure out
155	 * whether the AP is operated by the Home SP.
156	 */
157	char *domain;
158
159	/**
160	 * roaming_consortium - Roaming Consortium OI
161	 *
162	 * If roaming_consortium_len is non-zero, this field contains the
163	 * Roaming Consortium OI that can be used to determine which access
164	 * points support authentication with this credential. This is an
165	 * alternative to the use of the realm parameter. When using Roaming
166	 * Consortium to match the network, the EAP parameters need to be
167	 * pre-configured with the credential since the NAI Realm information
168	 * may not be available or fetched.
169	 */
170	u8 roaming_consortium[15];
171
172	/**
173	 * roaming_consortium_len - Length of roaming_consortium
174	 */
175	size_t roaming_consortium_len;
176
177	/**
178	 * eap_method - EAP method to use
179	 *
180	 * Pre-configured EAP method to use with this credential or %NULL to
181	 * indicate no EAP method is selected, i.e., the method will be
182	 * selected automatically based on ANQP information.
183	 */
184	struct eap_method_type *eap_method;
185
186	/**
187	 * phase1 - Phase 1 (outer authentication) parameters
188	 *
189	 * Pre-configured EAP parameters or %NULL.
190	 */
191	char *phase1;
192
193	/**
194	 * phase2 - Phase 2 (inner authentication) parameters
195	 *
196	 * Pre-configured EAP parameters or %NULL.
197	 */
198	char *phase2;
199
200	struct excluded_ssid {
201		u8 ssid[MAX_SSID_LEN];
202		size_t ssid_len;
203	} *excluded_ssid;
204	size_t num_excluded_ssid;
205};
206
207
208#define CFG_CHANGED_DEVICE_NAME BIT(0)
209#define CFG_CHANGED_CONFIG_METHODS BIT(1)
210#define CFG_CHANGED_DEVICE_TYPE BIT(2)
211#define CFG_CHANGED_OS_VERSION BIT(3)
212#define CFG_CHANGED_UUID BIT(4)
213#define CFG_CHANGED_COUNTRY BIT(5)
214#define CFG_CHANGED_SEC_DEVICE_TYPE BIT(6)
215#define CFG_CHANGED_P2P_SSID_POSTFIX BIT(7)
216#define CFG_CHANGED_WPS_STRING BIT(8)
217#define CFG_CHANGED_P2P_INTRA_BSS BIT(9)
218#define CFG_CHANGED_VENDOR_EXTENSION BIT(10)
219#define CFG_CHANGED_P2P_LISTEN_CHANNEL BIT(11)
220#define CFG_CHANGED_P2P_OPER_CHANNEL BIT(12)
221#define CFG_CHANGED_P2P_PREF_CHAN BIT(13)
222#define CFG_CHANGED_EXT_PW_BACKEND BIT(14)
223
224/**
225 * struct wpa_config - wpa_supplicant configuration data
226 *
227 * This data structure is presents the per-interface (radio) configuration
228 * data. In many cases, there is only one struct wpa_config instance, but if
229 * more than one network interface is being controlled, one instance is used
230 * for each.
231 */
232struct wpa_config {
233	/**
234	 * ssid - Head of the global network list
235	 *
236	 * This is the head for the list of all the configured networks.
237	 */
238	struct wpa_ssid *ssid;
239
240	/**
241	 * pssid - Per-priority network lists (in priority order)
242	 */
243	struct wpa_ssid **pssid;
244
245	/**
246	 * num_prio - Number of different priorities used in the pssid lists
247	 *
248	 * This indicates how many per-priority network lists are included in
249	 * pssid.
250	 */
251	int num_prio;
252
253	/**
254	 * cred - Head of the credential list
255	 *
256	 * This is the head for the list of all the configured credentials.
257	 */
258	struct wpa_cred *cred;
259
260	/**
261	 * eapol_version - IEEE 802.1X/EAPOL version number
262	 *
263	 * wpa_supplicant is implemented based on IEEE Std 802.1X-2004 which
264	 * defines EAPOL version 2. However, there are many APs that do not
265	 * handle the new version number correctly (they seem to drop the
266	 * frames completely). In order to make wpa_supplicant interoperate
267	 * with these APs, the version number is set to 1 by default. This
268	 * configuration value can be used to set it to the new version (2).
269	 */
270	int eapol_version;
271
272	/**
273	 * ap_scan - AP scanning/selection
274	 *
275	 * By default, wpa_supplicant requests driver to perform AP
276	 * scanning and then uses the scan results to select a
277	 * suitable AP. Another alternative is to allow the driver to
278	 * take care of AP scanning and selection and use
279	 * wpa_supplicant just to process EAPOL frames based on IEEE
280	 * 802.11 association information from the driver.
281	 *
282	 * 1: wpa_supplicant initiates scanning and AP selection (default).
283	 *
284	 * 0: Driver takes care of scanning, AP selection, and IEEE 802.11
285	 * association parameters (e.g., WPA IE generation); this mode can
286	 * also be used with non-WPA drivers when using IEEE 802.1X mode;
287	 * do not try to associate with APs (i.e., external program needs
288	 * to control association). This mode must also be used when using
289	 * wired Ethernet drivers.
290	 *
291	 * 2: like 0, but associate with APs using security policy and SSID
292	 * (but not BSSID); this can be used, e.g., with ndiswrapper and NDIS
293	 * drivers to enable operation with hidden SSIDs and optimized roaming;
294	 * in this mode, the network blocks in the configuration are tried
295	 * one by one until the driver reports successful association; each
296	 * network block should have explicit security policy (i.e., only one
297	 * option in the lists) for key_mgmt, pairwise, group, proto variables.
298	 */
299	int ap_scan;
300
301	/**
302	 * disable_scan_offload - Disable automatic offloading of scan requests
303	 *
304	 * By default, %wpa_supplicant tries to offload scanning if the driver
305	 * indicates support for this (sched_scan). This configuration
306	 * parameter can be used to disable this offloading mechanism.
307	 */
308	int disable_scan_offload;
309
310	/**
311	 * ctrl_interface - Parameters for the control interface
312	 *
313	 * If this is specified, %wpa_supplicant will open a control interface
314	 * that is available for external programs to manage %wpa_supplicant.
315	 * The meaning of this string depends on which control interface
316	 * mechanism is used. For all cases, the existence of this parameter
317	 * in configuration is used to determine whether the control interface
318	 * is enabled.
319	 *
320	 * For UNIX domain sockets (default on Linux and BSD): This is a
321	 * directory that will be created for UNIX domain sockets for listening
322	 * to requests from external programs (CLI/GUI, etc.) for status
323	 * information and configuration. The socket file will be named based
324	 * on the interface name, so multiple %wpa_supplicant processes can be
325	 * run at the same time if more than one interface is used.
326	 * /var/run/wpa_supplicant is the recommended directory for sockets and
327	 * by default, wpa_cli will use it when trying to connect with
328	 * %wpa_supplicant.
329	 *
330	 * Access control for the control interface can be configured
331	 * by setting the directory to allow only members of a group
332	 * to use sockets. This way, it is possible to run
333	 * %wpa_supplicant as root (since it needs to change network
334	 * configuration and open raw sockets) and still allow GUI/CLI
335	 * components to be run as non-root users. However, since the
336	 * control interface can be used to change the network
337	 * configuration, this access needs to be protected in many
338	 * cases. By default, %wpa_supplicant is configured to use gid
339	 * 0 (root). If you want to allow non-root users to use the
340	 * control interface, add a new group and change this value to
341	 * match with that group. Add users that should have control
342	 * interface access to this group.
343	 *
344	 * When configuring both the directory and group, use following format:
345	 * DIR=/var/run/wpa_supplicant GROUP=wheel
346	 * DIR=/var/run/wpa_supplicant GROUP=0
347	 * (group can be either group name or gid)
348	 *
349	 * For UDP connections (default on Windows): The value will be ignored.
350	 * This variable is just used to select that the control interface is
351	 * to be created. The value can be set to, e.g., udp
352	 * (ctrl_interface=udp).
353	 *
354	 * For Windows Named Pipe: This value can be used to set the security
355	 * descriptor for controlling access to the control interface. Security
356	 * descriptor can be set using Security Descriptor String Format (see
357	 * http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/security_descriptor_string_format.asp).
358	 * The descriptor string needs to be prefixed with SDDL=. For example,
359	 * ctrl_interface=SDDL=D: would set an empty DACL (which will reject
360	 * all connections).
361	 */
362	char *ctrl_interface;
363
364	/**
365	 * ctrl_interface_group - Control interface group (DEPRECATED)
366	 *
367	 * This variable is only used for backwards compatibility. Group for
368	 * UNIX domain sockets should now be specified using GROUP=group in
369	 * ctrl_interface variable.
370	 */
371	char *ctrl_interface_group;
372
373	/**
374	 * fast_reauth - EAP fast re-authentication (session resumption)
375	 *
376	 * By default, fast re-authentication is enabled for all EAP methods
377	 * that support it. This variable can be used to disable fast
378	 * re-authentication (by setting fast_reauth=0). Normally, there is no
379	 * need to disable fast re-authentication.
380	 */
381	int fast_reauth;
382
383	/**
384	 * opensc_engine_path - Path to the OpenSSL engine for opensc
385	 *
386	 * This is an OpenSSL specific configuration option for loading OpenSC
387	 * engine (engine_opensc.so); if %NULL, this engine is not loaded.
388	 */
389	char *opensc_engine_path;
390
391	/**
392	 * pkcs11_engine_path - Path to the OpenSSL engine for PKCS#11
393	 *
394	 * This is an OpenSSL specific configuration option for loading PKCS#11
395	 * engine (engine_pkcs11.so); if %NULL, this engine is not loaded.
396	 */
397	char *pkcs11_engine_path;
398
399	/**
400	 * pkcs11_module_path - Path to the OpenSSL OpenSC/PKCS#11 module
401	 *
402	 * This is an OpenSSL specific configuration option for configuring
403	 * path to OpenSC/PKCS#11 engine (opensc-pkcs11.so); if %NULL, this
404	 * module is not loaded.
405	 */
406	char *pkcs11_module_path;
407
408	/**
409	 * pcsc_reader - PC/SC reader name prefix
410	 *
411	 * If not %NULL, PC/SC reader with a name that matches this prefix is
412	 * initialized for SIM/USIM access. Empty string can be used to match
413	 * the first available reader.
414	 */
415	char *pcsc_reader;
416
417	/**
418	 * pcsc_pin - PIN for USIM, GSM SIM, and smartcards
419	 *
420	 * This field is used to configure PIN for SIM/USIM for EAP-SIM and
421	 * EAP-AKA. If left out, this will be asked through control interface.
422	 */
423	char *pcsc_pin;
424
425	/**
426	 * driver_param - Driver interface parameters
427	 *
428	 * This text string is passed to the selected driver interface with the
429	 * optional struct wpa_driver_ops::set_param() handler. This can be
430	 * used to configure driver specific options without having to add new
431	 * driver interface functionality.
432	 */
433	char *driver_param;
434
435	/**
436	 * dot11RSNAConfigPMKLifetime - Maximum lifetime of a PMK
437	 *
438	 * dot11 MIB variable for the maximum lifetime of a PMK in the PMK
439	 * cache (unit: seconds).
440	 */
441	unsigned int dot11RSNAConfigPMKLifetime;
442
443	/**
444	 * dot11RSNAConfigPMKReauthThreshold - PMK re-authentication threshold
445	 *
446	 * dot11 MIB variable for the percentage of the PMK lifetime
447	 * that should expire before an IEEE 802.1X reauthentication occurs.
448	 */
449	unsigned int dot11RSNAConfigPMKReauthThreshold;
450
451	/**
452	 * dot11RSNAConfigSATimeout - Security association timeout
453	 *
454	 * dot11 MIB variable for the maximum time a security association
455	 * shall take to set up (unit: seconds).
456	 */
457	unsigned int dot11RSNAConfigSATimeout;
458
459	/**
460	 * update_config - Is wpa_supplicant allowed to update configuration
461	 *
462	 * This variable control whether wpa_supplicant is allow to re-write
463	 * its configuration with wpa_config_write(). If this is zero,
464	 * configuration data is only changed in memory and the external data
465	 * is not overriden. If this is non-zero, wpa_supplicant will update
466	 * the configuration data (e.g., a file) whenever configuration is
467	 * changed. This update may replace the old configuration which can
468	 * remove comments from it in case of a text file configuration.
469	 */
470	int update_config;
471
472	/**
473	 * blobs - Configuration blobs
474	 */
475	struct wpa_config_blob *blobs;
476
477	/**
478	 * uuid - Universally Unique IDentifier (UUID; see RFC 4122) for WPS
479	 */
480	u8 uuid[16];
481
482	/**
483	 * device_name - Device Name (WPS)
484	 * User-friendly description of device; up to 32 octets encoded in
485	 * UTF-8
486	 */
487	char *device_name;
488
489	/**
490	 * manufacturer - Manufacturer (WPS)
491	 * The manufacturer of the device (up to 64 ASCII characters)
492	 */
493	char *manufacturer;
494
495	/**
496	 * model_name - Model Name (WPS)
497	 * Model of the device (up to 32 ASCII characters)
498	 */
499	char *model_name;
500
501	/**
502	 * model_number - Model Number (WPS)
503	 * Additional device description (up to 32 ASCII characters)
504	 */
505	char *model_number;
506
507	/**
508	 * serial_number - Serial Number (WPS)
509	 * Serial number of the device (up to 32 characters)
510	 */
511	char *serial_number;
512
513	/**
514	 * device_type - Primary Device Type (WPS)
515	 */
516	u8 device_type[WPS_DEV_TYPE_LEN];
517
518	/**
519	 * config_methods - Config Methods
520	 *
521	 * This is a space-separated list of supported WPS configuration
522	 * methods. For example, "label virtual_display virtual_push_button
523	 * keypad".
524	 * Available methods: usba ethernet label display ext_nfc_token
525	 * int_nfc_token nfc_interface push_button keypad
526	 * virtual_display physical_display
527	 * virtual_push_button physical_push_button.
528	 */
529	char *config_methods;
530
531	/**
532	 * os_version - OS Version (WPS)
533	 * 4-octet operating system version number
534	 */
535	u8 os_version[4];
536
537	/**
538	 * country - Country code
539	 *
540	 * This is the ISO/IEC alpha2 country code for which we are operating
541	 * in
542	 */
543	char country[2];
544
545	/**
546	 * wps_cred_processing - Credential processing
547	 *
548	 *   0 = process received credentials internally
549	 *   1 = do not process received credentials; just pass them over
550	 *	ctrl_iface to external program(s)
551	 *   2 = process received credentials internally and pass them over
552	 *	ctrl_iface to external program(s)
553	 */
554	int wps_cred_processing;
555
556#define MAX_SEC_DEVICE_TYPES 5
557	/**
558	 * sec_device_types - Secondary Device Types (P2P)
559	 */
560	u8 sec_device_type[MAX_SEC_DEVICE_TYPES][WPS_DEV_TYPE_LEN];
561	int num_sec_device_types;
562
563	int p2p_listen_reg_class;
564	int p2p_listen_channel;
565	int p2p_oper_reg_class;
566	int p2p_oper_channel;
567	int p2p_go_intent;
568	char *p2p_ssid_postfix;
569	int persistent_reconnect;
570	int p2p_intra_bss;
571	unsigned int num_p2p_pref_chan;
572	struct p2p_channel *p2p_pref_chan;
573
574	struct wpabuf *wps_vendor_ext_m1;
575
576#define MAX_WPS_VENDOR_EXT 10
577	/**
578	 * wps_vendor_ext - Vendor extension attributes in WPS
579	 */
580	struct wpabuf *wps_vendor_ext[MAX_WPS_VENDOR_EXT];
581
582	/**
583	 * p2p_group_idle - Maximum idle time in seconds for P2P group
584	 *
585	 * This value controls how long a P2P group is maintained after there
586	 * is no other members in the group. As a GO, this means no associated
587	 * stations in the group. As a P2P client, this means no GO seen in
588	 * scan results. The maximum idle time is specified in seconds with 0
589	 * indicating no time limit, i.e., the P2P group remains in active
590	 * state indefinitely until explicitly removed. As a P2P client, the
591	 * maximum idle time of P2P_MAX_CLIENT_IDLE seconds is enforced, i.e.,
592	 * this parameter is mainly meant for GO use and for P2P client, it can
593	 * only be used to reduce the default timeout to smaller value. A
594	 * special value -1 can be used to configure immediate removal of the
595	 * group for P2P client role on any disconnection after the data
596	 * connection has been established.
597	 */
598	int p2p_group_idle;
599
600	/**
601	 * bss_max_count - Maximum number of BSS entries to keep in memory
602	 */
603	unsigned int bss_max_count;
604
605	/**
606	 * bss_expiration_age - BSS entry age after which it can be expired
607	 *
608	 * This value controls the time in seconds after which a BSS entry
609	 * gets removed if it has not been updated or is not in use.
610	 */
611	unsigned int bss_expiration_age;
612
613	/**
614	 * bss_expiration_scan_count - Expire BSS after number of scans
615	 *
616	 * If the BSS entry has not been seen in this many scans, it will be
617	 * removed. A value of 1 means that entry is removed after the first
618	 * scan in which the BSSID is not seen. Larger values can be used
619	 * to avoid BSS entries disappearing if they are not visible in
620	 * every scan (e.g., low signal quality or interference).
621	 */
622	unsigned int bss_expiration_scan_count;
623
624	/**
625	 * filter_ssids - SSID-based scan result filtering
626	 *
627	 *   0 = do not filter scan results
628	 *   1 = only include configured SSIDs in scan results/BSS table
629	 */
630	int filter_ssids;
631
632	/**
633	 * filter_rssi - RSSI-based scan result filtering
634	 *
635	 * 0 = do not filter scan results
636	 * -n = filter scan results below -n dBm
637	 */
638	int filter_rssi;
639
640	/**
641	 * max_num_sta - Maximum number of STAs in an AP/P2P GO
642	 */
643	unsigned int max_num_sta;
644
645	/**
646	 * changed_parameters - Bitmap of changed parameters since last update
647	 */
648	unsigned int changed_parameters;
649
650	/**
651	 * disassoc_low_ack - Disassocicate stations with massive packet loss
652	 */
653	int disassoc_low_ack;
654
655	/**
656	 * interworking - Whether Interworking (IEEE 802.11u) is enabled
657	 */
658	int interworking;
659
660	/**
661	 * access_network_type - Access Network Type
662	 *
663	 * When Interworking is enabled, scans will be limited to APs that
664	 * advertise the specified Access Network Type (0..15; with 15
665	 * indicating wildcard match).
666	 */
667	int access_network_type;
668
669	/**
670	 * hessid - Homogenous ESS identifier
671	 *
672	 * If this is set (any octet is non-zero), scans will be used to
673	 * request response only from BSSes belonging to the specified
674	 * Homogeneous ESS. This is used only if interworking is enabled.
675	 */
676	u8 hessid[ETH_ALEN];
677
678	/**
679	 * hs20 - Hotspot 2.0
680	 */
681	int hs20;
682
683	/**
684	 * pbc_in_m1 - AP mode WPS probing workaround for PBC with Windows 7
685	 *
686	 * Windows 7 uses incorrect way of figuring out AP's WPS capabilities
687	 * by acting as a Registrar and using M1 from the AP. The config
688	 * methods attribute in that message is supposed to indicate only the
689	 * configuration method supported by the AP in Enrollee role, i.e., to
690	 * add an external Registrar. For that case, PBC shall not be used and
691	 * as such, the PushButton config method is removed from M1 by default.
692	 * If pbc_in_m1=1 is included in the configuration file, the PushButton
693	 * config method is left in M1 (if included in config_methods
694	 * parameter) to allow Windows 7 to use PBC instead of PIN (e.g., from
695	 * a label in the AP).
696	 */
697	int pbc_in_m1;
698
699	/**
700	 * autoscan - Automatic scan parameters or %NULL if none
701	 *
702	 * This is an optional set of parameters for automatic scanning
703	 * within an interface in following format:
704	 * <autoscan module name>:<module parameters>
705	 */
706	char *autoscan;
707
708	/**
709	 * wps_nfc_dev_pw_id - NFC Device Password ID for password token
710	 */
711	int wps_nfc_dev_pw_id;
712
713	/**
714	 * wps_nfc_dh_pubkey - NFC DH Public Key for password token
715	 */
716	struct wpabuf *wps_nfc_dh_pubkey;
717
718	/**
719	 * wps_nfc_dh_privkey - NFC DH Private Key for password token
720	 */
721	struct wpabuf *wps_nfc_dh_privkey;
722
723	/**
724	 * wps_nfc_dev_pw - NFC Device Password for password token
725	 */
726	struct wpabuf *wps_nfc_dev_pw;
727
728	/**
729	 * ext_password_backend - External password backend or %NULL if none
730	 *
731	 * format: <backend name>[:<optional backend parameters>]
732	 */
733	char *ext_password_backend;
734
735	/*
736	 * p2p_go_max_inactivity - Timeout in seconds to detect STA inactivity
737	 *
738	 * This timeout value is used in P2P GO mode to clean up
739	 * inactive stations.
740	 * By default: 300 seconds.
741	 */
742	int p2p_go_max_inactivity;
743
744	struct hostapd_wmm_ac_params wmm_ac_params[4];
745
746	/**
747	 * auto_interworking - Whether to use network selection automatically
748	 *
749	 * 0 = do not automatically go through Interworking network selection
750	 *     (i.e., require explicit interworking_select command for this)
751	 * 1 = perform Interworking network selection if one or more
752	 *     credentials have been configured and scan did not find a
753	 *     matching network block
754	 */
755	int auto_interworking;
756
757	/**
758	 * p2p_go_ht40 - Default mode for HT40 enable when operating as GO.
759	 *
760	 * This will take effect for p2p_group_add, p2p_connect, and p2p_invite.
761	 * Note that regulatory constraints and driver capabilities are
762	 * consulted anyway, so setting it to 1 can't do real harm.
763	 * By default: 0 (disabled)
764	 */
765	int p2p_go_ht40;
766
767	/**
768	 * p2p_disabled - Whether P2P operations are disabled for this interface
769	 */
770	int p2p_disabled;
771
772	/**
773	 * p2p_no_group_iface - Whether group interfaces can be used
774	 *
775	 * By default, wpa_supplicant will create a separate interface for P2P
776	 * group operations if the driver supports this. This functionality can
777	 * be disabled by setting this parameter to 1. In that case, the same
778	 * interface that was used for the P2P management operations is used
779	 * also for the group operation.
780	 */
781	int p2p_no_group_iface;
782
783	/**
784	 * okc - Whether to enable opportunistic key caching by default
785	 *
786	 * By default, OKC is disabled unless enabled by the per-network
787	 * proactive_key_caching=1 parameter. okc=1 can be used to change this
788	 * default behavior.
789	 */
790	int okc;
791
792	/**
793	 * pmf - Whether to enable/require PMF by default
794	 *
795	 * By default, PMF is disabled unless enabled by the per-network
796	 * ieee80211w=1 or ieee80211w=2 parameter. pmf=1/2 can be used to change
797	 * this default behavior.
798	 */
799	enum mfp_options pmf;
800};
801
802
803/* Prototypes for common functions from config.c */
804
805void wpa_config_free(struct wpa_config *ssid);
806void wpa_config_free_ssid(struct wpa_ssid *ssid);
807void wpa_config_foreach_network(struct wpa_config *config,
808				void (*func)(void *, struct wpa_ssid *),
809				void *arg);
810struct wpa_ssid * wpa_config_get_network(struct wpa_config *config, int id);
811struct wpa_ssid * wpa_config_add_network(struct wpa_config *config);
812int wpa_config_remove_network(struct wpa_config *config, int id);
813void wpa_config_set_network_defaults(struct wpa_ssid *ssid);
814int wpa_config_set(struct wpa_ssid *ssid, const char *var, const char *value,
815		   int line);
816int wpa_config_set_quoted(struct wpa_ssid *ssid, const char *var,
817			  const char *value);
818char ** wpa_config_get_all(struct wpa_ssid *ssid, int get_keys);
819char * wpa_config_get(struct wpa_ssid *ssid, const char *var);
820char * wpa_config_get_no_key(struct wpa_ssid *ssid, const char *var);
821void wpa_config_update_psk(struct wpa_ssid *ssid);
822int wpa_config_add_prio_network(struct wpa_config *config,
823				struct wpa_ssid *ssid);
824int wpa_config_update_prio_list(struct wpa_config *config);
825const struct wpa_config_blob * wpa_config_get_blob(struct wpa_config *config,
826						   const char *name);
827void wpa_config_set_blob(struct wpa_config *config,
828			 struct wpa_config_blob *blob);
829void wpa_config_free_blob(struct wpa_config_blob *blob);
830int wpa_config_remove_blob(struct wpa_config *config, const char *name);
831
832struct wpa_cred * wpa_config_get_cred(struct wpa_config *config, int id);
833struct wpa_cred * wpa_config_add_cred(struct wpa_config *config);
834int wpa_config_remove_cred(struct wpa_config *config, int id);
835void wpa_config_free_cred(struct wpa_cred *cred);
836int wpa_config_set_cred(struct wpa_cred *cred, const char *var,
837			const char *value, int line);
838
839struct wpa_config * wpa_config_alloc_empty(const char *ctrl_interface,
840					   const char *driver_param);
841#ifndef CONFIG_NO_STDOUT_DEBUG
842void wpa_config_debug_dump_networks(struct wpa_config *config);
843#else /* CONFIG_NO_STDOUT_DEBUG */
844#define wpa_config_debug_dump_networks(c) do { } while (0)
845#endif /* CONFIG_NO_STDOUT_DEBUG */
846
847
848/* Prototypes for common functions from config.c */
849int wpa_config_process_global(struct wpa_config *config, char *pos, int line);
850
851
852/* Prototypes for backend specific functions from the selected config_*.c */
853
854/**
855 * wpa_config_read - Read and parse configuration database
856 * @name: Name of the configuration (e.g., path and file name for the
857 * configuration file)
858 * Returns: Pointer to allocated configuration data or %NULL on failure
859 *
860 * This function reads configuration data, parses its contents, and allocates
861 * data structures needed for storing configuration information. The allocated
862 * data can be freed with wpa_config_free().
863 *
864 * Each configuration backend needs to implement this function.
865 */
866struct wpa_config * wpa_config_read(const char *name);
867
868/**
869 * wpa_config_write - Write or update configuration data
870 * @name: Name of the configuration (e.g., path and file name for the
871 * configuration file)
872 * @config: Configuration data from wpa_config_read()
873 * Returns: 0 on success, -1 on failure
874 *
875 * This function write all configuration data into an external database (e.g.,
876 * a text file) in a format that can be read with wpa_config_read(). This can
877 * be used to allow wpa_supplicant to update its configuration, e.g., when a
878 * new network is added or a password is changed.
879 *
880 * Each configuration backend needs to implement this function.
881 */
882int wpa_config_write(const char *name, struct wpa_config *config);
883
884#endif /* CONFIG_H */
885