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