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