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