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