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