D-Bus: Move NetworkRequest signal to correct registration array
[mech_eap.git] / wpa_supplicant / config_ssid.h
1 /*
2  * WPA Supplicant / Network configuration structures
3  * Copyright (c) 2003-2013, 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_SSID_H
10 #define CONFIG_SSID_H
11
12 #include "common/defs.h"
13 #include "utils/list.h"
14 #include "eap_peer/eap_config.h"
15
16 #define MAX_SSID_LEN 32
17
18
19 #define DEFAULT_EAP_WORKAROUND ((unsigned int) -1)
20 #define DEFAULT_EAPOL_FLAGS (EAPOL_FLAG_REQUIRE_KEY_UNICAST | \
21                              EAPOL_FLAG_REQUIRE_KEY_BROADCAST)
22 #define DEFAULT_PROTO (WPA_PROTO_WPA | WPA_PROTO_RSN)
23 #define DEFAULT_KEY_MGMT (WPA_KEY_MGMT_PSK | WPA_KEY_MGMT_IEEE8021X)
24 #define DEFAULT_PAIRWISE (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP)
25 #define DEFAULT_GROUP (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP | \
26                        WPA_CIPHER_WEP104 | WPA_CIPHER_WEP40)
27 #define DEFAULT_FRAGMENT_SIZE 1398
28
29 #define DEFAULT_BG_SCAN_PERIOD -1
30 #define DEFAULT_MESH_HT_MODE CHAN_UNDEFINED /* undefined */
31 #define DEFAULT_MESH_MAX_RETRIES 2
32 #define DEFAULT_MESH_RETRY_TIMEOUT 40
33 #define DEFAULT_MESH_CONFIRM_TIMEOUT 40
34 #define DEFAULT_MESH_HOLDING_TIMEOUT 40
35 #define DEFAULT_DISABLE_HT 0
36 #define DEFAULT_DISABLE_HT40 0
37 #define DEFAULT_DISABLE_SGI 0
38 #define DEFAULT_DISABLE_LDPC 0
39 #define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */
40 #define DEFAULT_AMPDU_FACTOR -1 /* no change */
41 #define DEFAULT_AMPDU_DENSITY -1 /* no change */
42 #define DEFAULT_USER_SELECTED_SIM 1
43
44 struct psk_list_entry {
45         struct dl_list list;
46         u8 addr[ETH_ALEN];
47         u8 psk[32];
48         u8 p2p;
49 };
50
51 /**
52  * struct wpa_ssid - Network configuration data
53  *
54  * This structure includes all the configuration variables for a network. This
55  * data is included in the per-interface configuration data as an element of
56  * the network list, struct wpa_config::ssid. Each network block in the
57  * configuration is mapped to a struct wpa_ssid instance.
58  */
59 struct wpa_ssid {
60         /**
61          * next - Next network in global list
62          *
63          * This pointer can be used to iterate over all networks. The head of
64          * this list is stored in the ssid field of struct wpa_config.
65          */
66         struct wpa_ssid *next;
67
68         /**
69          * pnext - Next network in per-priority list
70          *
71          * This pointer can be used to iterate over all networks in the same
72          * priority class. The heads of these list are stored in the pssid
73          * fields of struct wpa_config.
74          */
75         struct wpa_ssid *pnext;
76
77         /**
78          * id - Unique id for the network
79          *
80          * This identifier is used as a unique identifier for each network
81          * block when using the control interface. Each network is allocated an
82          * id when it is being created, either when reading the configuration
83          * file or when a new network is added through the control interface.
84          */
85         int id;
86
87         /**
88          * priority - Priority group
89          *
90          * By default, all networks will get same priority group (0). If some
91          * of the networks are more desirable, this field can be used to change
92          * the order in which wpa_supplicant goes through the networks when
93          * selecting a BSS. The priority groups will be iterated in decreasing
94          * priority (i.e., the larger the priority value, the sooner the
95          * network is matched against the scan results). Within each priority
96          * group, networks will be selected based on security policy, signal
97          * strength, etc.
98          *
99          * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are
100          * not using this priority to select the order for scanning. Instead,
101          * they try the networks in the order that used in the configuration
102          * file.
103          */
104         int priority;
105
106         /**
107          * ssid - Service set identifier (network name)
108          *
109          * This is the SSID for the network. For wireless interfaces, this is
110          * used to select which network will be used. If set to %NULL (or
111          * ssid_len=0), any SSID can be used. For wired interfaces, this must
112          * be set to %NULL. Note: SSID may contain any characters, even nul
113          * (ASCII 0) and as such, this should not be assumed to be a nul
114          * terminated string. ssid_len defines how many characters are valid
115          * and the ssid field is not guaranteed to be nul terminated.
116          */
117         u8 *ssid;
118
119         /**
120          * ssid_len - Length of the SSID
121          */
122         size_t ssid_len;
123
124         /**
125          * bssid - BSSID
126          *
127          * If set, this network block is used only when associating with the AP
128          * using the configured BSSID
129          *
130          * If this is a persistent P2P group (disabled == 2), this is the GO
131          * Device Address.
132          */
133         u8 bssid[ETH_ALEN];
134
135         /**
136          * bssid_set - Whether BSSID is configured for this network
137          */
138         int bssid_set;
139
140         /**
141          * go_p2p_dev_addr - GO's P2P Device Address or all zeros if not set
142          */
143         u8 go_p2p_dev_addr[ETH_ALEN];
144
145         /**
146          * psk - WPA pre-shared key (256 bits)
147          */
148         u8 psk[32];
149
150         /**
151          * psk_set - Whether PSK field is configured
152          */
153         int psk_set;
154
155         /**
156          * passphrase - WPA ASCII passphrase
157          *
158          * If this is set, psk will be generated using the SSID and passphrase
159          * configured for the network. ASCII passphrase must be between 8 and
160          * 63 characters (inclusive).
161          */
162         char *passphrase;
163
164         /**
165          * ext_psk - PSK/passphrase name in external storage
166          *
167          * If this is set, PSK/passphrase will be fetched from external storage
168          * when requesting association with the network.
169          */
170         char *ext_psk;
171
172         /**
173          * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
174          */
175         int pairwise_cipher;
176
177         /**
178          * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*
179          */
180         int group_cipher;
181
182         /**
183          * key_mgmt - Bitfield of allowed key management protocols
184          *
185          * WPA_KEY_MGMT_*
186          */
187         int key_mgmt;
188
189         /**
190          * bg_scan_period - Background scan period in seconds, 0 to disable, or
191          * -1 to indicate no change to default driver configuration
192          */
193         int bg_scan_period;
194
195         /**
196          * proto - Bitfield of allowed protocols, WPA_PROTO_*
197          */
198         int proto;
199
200         /**
201          * auth_alg -  Bitfield of allowed authentication algorithms
202          *
203          * WPA_AUTH_ALG_*
204          */
205         int auth_alg;
206
207         /**
208          * scan_ssid - Scan this SSID with Probe Requests
209          *
210          * scan_ssid can be used to scan for APs using hidden SSIDs.
211          * Note: Many drivers do not support this. ap_mode=2 can be used with
212          * such drivers to use hidden SSIDs.
213          */
214         int scan_ssid;
215
216 #ifdef IEEE8021X_EAPOL
217 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0)
218 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1)
219         /**
220          * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*)
221          */
222         int eapol_flags;
223
224         /**
225          * eap - EAP peer configuration for this network
226          */
227         struct eap_peer_config eap;
228 #endif /* IEEE8021X_EAPOL */
229
230 #define NUM_WEP_KEYS 4
231 #define MAX_WEP_KEY_LEN 16
232         /**
233          * wep_key - WEP keys
234          */
235         u8 wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN];
236
237         /**
238          * wep_key_len - WEP key lengths
239          */
240         size_t wep_key_len[NUM_WEP_KEYS];
241
242         /**
243          * wep_tx_keyidx - Default key index for TX frames using WEP
244          */
245         int wep_tx_keyidx;
246
247         /**
248          * proactive_key_caching - Enable proactive key caching
249          *
250          * This field can be used to enable proactive key caching which is also
251          * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
252          * by default unless default value is changed with the global okc=1
253          * parameter. Enable by setting this to 1.
254          *
255          * Proactive key caching is used to make supplicant assume that the APs
256          * are using the same PMK and generate PMKSA cache entries without
257          * doing RSN pre-authentication. This requires support from the AP side
258          * and is normally used with wireless switches that co-locate the
259          * authenticator.
260          *
261          * Internally, special value -1 is used to indicate that the parameter
262          * was not specified in the configuration (i.e., default behavior is
263          * followed).
264          */
265         int proactive_key_caching;
266
267         /**
268          * mixed_cell - Whether mixed cells are allowed
269          *
270          * This option can be used to configure whether so called mixed cells,
271          * i.e., networks that use both plaintext and encryption in the same
272          * SSID, are allowed. This is disabled (0) by default. Enable by
273          * setting this to 1.
274          */
275         int mixed_cell;
276
277 #ifdef IEEE8021X_EAPOL
278
279         /**
280          * leap - Number of EAP methods using LEAP
281          *
282          * This field should be set to 1 if LEAP is enabled. This is used to
283          * select IEEE 802.11 authentication algorithm.
284          */
285         int leap;
286
287         /**
288          * non_leap - Number of EAP methods not using LEAP
289          *
290          * This field should be set to >0 if any EAP method other than LEAP is
291          * enabled. This is used to select IEEE 802.11 authentication
292          * algorithm.
293          */
294         int non_leap;
295
296         /**
297          * eap_workaround - EAP workarounds enabled
298          *
299          * wpa_supplicant supports number of "EAP workarounds" to work around
300          * interoperability issues with incorrectly behaving authentication
301          * servers. This is recommended to be enabled by default because some
302          * of the issues are present in large number of authentication servers.
303          *
304          * Strict EAP conformance mode can be configured by disabling
305          * workarounds with eap_workaround = 0.
306          */
307         unsigned int eap_workaround;
308
309 #endif /* IEEE8021X_EAPOL */
310
311         /**
312          * mode - IEEE 802.11 operation mode (Infrastucture/IBSS)
313          *
314          * 0 = infrastructure (Managed) mode, i.e., associate with an AP.
315          *
316          * 1 = IBSS (ad-hoc, peer-to-peer)
317          *
318          * 2 = AP (access point)
319          *
320          * 3 = P2P Group Owner (can be set in the configuration file)
321          *
322          * 4 = P2P Group Formation (used internally; not in configuration
323          * files)
324          *
325          * 5 = Mesh
326          *
327          * Note: IBSS can only be used with key_mgmt NONE (plaintext and static
328          * WEP) and WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE
329          * (fixed group key TKIP/CCMP) is available for backwards compatibility,
330          * but its use is deprecated. WPA-None requires following network block
331          * options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or
332          * CCMP, but not both), and psk must also be set (either directly or
333          * using ASCII passphrase).
334          */
335         enum wpas_mode {
336                 WPAS_MODE_INFRA = 0,
337                 WPAS_MODE_IBSS = 1,
338                 WPAS_MODE_AP = 2,
339                 WPAS_MODE_P2P_GO = 3,
340                 WPAS_MODE_P2P_GROUP_FORMATION = 4,
341                 WPAS_MODE_MESH = 5,
342         } mode;
343
344         /**
345          * disabled - Whether this network is currently disabled
346          *
347          * 0 = this network can be used (default).
348          * 1 = this network block is disabled (can be enabled through
349          * ctrl_iface, e.g., with wpa_cli or wpa_gui).
350          * 2 = this network block includes parameters for a persistent P2P
351          * group (can be used with P2P ctrl_iface commands)
352          */
353         int disabled;
354
355         /**
356          * disabled_for_connect - Whether this network was temporarily disabled
357          *
358          * This flag is used to reenable all the temporarily disabled networks
359          * after either the success or failure of a WPS connection.
360          */
361         int disabled_for_connect;
362
363         /**
364          * peerkey -  Whether PeerKey handshake for direct links is allowed
365          *
366          * This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are
367          * enabled.
368          *
369          * 0 = disabled (default)
370          * 1 = enabled
371          */
372         int peerkey;
373
374         /**
375          * id_str - Network identifier string for external scripts
376          *
377          * This value is passed to external ctrl_iface monitors in
378          * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR
379          * environment variable for action scripts.
380          */
381         char *id_str;
382
383 #ifdef CONFIG_IEEE80211W
384         /**
385          * ieee80211w - Whether management frame protection is enabled
386          *
387          * This value is used to configure policy for management frame
388          * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
389          * This is disabled by default unless the default value has been changed
390          * with the global pmf=1/2 parameter.
391          *
392          * Internally, special value 3 is used to indicate that the parameter
393          * was not specified in the configuration (i.e., default behavior is
394          * followed).
395          */
396         enum mfp_options ieee80211w;
397 #endif /* CONFIG_IEEE80211W */
398
399         /**
400          * frequency - Channel frequency in megahertz (MHz) for IBSS
401          *
402          * This value is used to configure the initial channel for IBSS (adhoc)
403          * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in
404          * the infrastructure mode. In addition, this value is only used by the
405          * station that creates the IBSS. If an IBSS network with the
406          * configured SSID is already present, the frequency of the network
407          * will be used instead of this configured value.
408          */
409         int frequency;
410
411         /**
412          * mesh_ht_mode - definition of HT mode in mesh mode
413          *
414          * Use the given HT mode for mesh networks. The driver will
415          * adapt to other stations if neccesary, but advertise the
416          * configured HT mode (HT20/HT40-/HT40+/NOHT).
417          */
418         int mesh_ht_mode;
419
420         /**
421          * mesh_basic_rates - BSS Basic rate set for mesh network
422          *
423          */
424         int *mesh_basic_rates;
425
426         /**
427          * Mesh network plink parameters
428          */
429         int dot11MeshMaxRetries;
430         int dot11MeshRetryTimeout; /* msec */
431         int dot11MeshConfirmTimeout; /* msec */
432         int dot11MeshHoldingTimeout; /* msec */
433
434         int ht40;
435
436         int vht;
437
438         /**
439          * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
440          *
441          * This value can be used to enforce rekeying of PTK to mitigate some
442          * attacks against TKIP deficiencies.
443          */
444         int wpa_ptk_rekey;
445
446         /**
447          * scan_freq - Array of frequencies to scan or %NULL for all
448          *
449          * This is an optional zero-terminated array of frequencies in
450          * megahertz (MHz) to include in scan requests when searching for this
451          * network. This can be used to speed up scanning when the network is
452          * known to not use all possible channels.
453          */
454         int *scan_freq;
455
456         /**
457          * bgscan - Background scan and roaming parameters or %NULL if none
458          *
459          * This is an optional set of parameters for background scanning and
460          * roaming within a network (ESS) in following format:
461          * <bgscan module name>:<module parameters>
462          */
463         char *bgscan;
464
465         /**
466          * ignore_broadcast_ssid - Hide SSID in AP mode
467          *
468          * Send empty SSID in beacons and ignore probe request frames that do
469          * not specify full SSID, i.e., require stations to know SSID.
470          * default: disabled (0)
471          * 1 = send empty (length=0) SSID in beacon and ignore probe request
472          * for broadcast SSID
473          * 2 = clear SSID (ASCII 0), but keep the original length (this may be
474          * required with some clients that do not support empty SSID) and
475          * ignore probe requests for broadcast SSID
476          */
477         int ignore_broadcast_ssid;
478
479         /**
480          * freq_list - Array of allowed frequencies or %NULL for all
481          *
482          * This is an optional zero-terminated array of frequencies in
483          * megahertz (MHz) to allow for selecting the BSS. If set, scan results
484          * that do not match any of the specified frequencies are not
485          * considered when selecting a BSS.
486          */
487         int *freq_list;
488
489         /**
490          * p2p_client_list - List of P2P Clients in a persistent group (GO)
491          *
492          * This is a list of P2P Clients (P2P Device Address) that have joined
493          * the persistent group. This is maintained on the GO for persistent
494          * group entries (disabled == 2).
495          */
496         u8 *p2p_client_list;
497
498         /**
499          * num_p2p_clients - Number of entries in p2p_client_list
500          */
501         size_t num_p2p_clients;
502
503 #ifndef P2P_MAX_STORED_CLIENTS
504 #define P2P_MAX_STORED_CLIENTS 100
505 #endif /* P2P_MAX_STORED_CLIENTS */
506
507         /**
508          * psk_list - Per-client PSKs (struct psk_list_entry)
509          */
510         struct dl_list psk_list;
511
512         /**
513          * p2p_group - Network generated as a P2P group (used internally)
514          */
515         int p2p_group;
516
517         /**
518          * p2p_persistent_group - Whether this is a persistent group
519          */
520         int p2p_persistent_group;
521
522         /**
523          * temporary - Whether this network is temporary and not to be saved
524          */
525         int temporary;
526
527         /**
528          * export_keys - Whether keys may be exported
529          *
530          * This attribute will be set when keys are determined through
531          * WPS or similar so that they may be exported.
532          */
533         int export_keys;
534
535 #ifdef CONFIG_HT_OVERRIDES
536         /**
537          * disable_ht - Disable HT (IEEE 802.11n) for this network
538          *
539          * By default, use it if it is available, but this can be configured
540          * to 1 to have it disabled.
541          */
542         int disable_ht;
543
544         /**
545          * disable_ht40 - Disable HT40 for this network
546          *
547          * By default, use it if it is available, but this can be configured
548          * to 1 to have it disabled.
549          */
550         int disable_ht40;
551
552         /**
553          * disable_sgi - Disable SGI (Short Guard Interval) for this network
554          *
555          * By default, use it if it is available, but this can be configured
556          * to 1 to have it disabled.
557          */
558         int disable_sgi;
559
560         /**
561          * disable_ldpc - Disable LDPC for this network
562          *
563          * By default, use it if it is available, but this can be configured
564          * to 1 to have it disabled.
565          */
566         int disable_ldpc;
567
568         /**
569          * ht40_intolerant - Indicate 40 MHz intolerant for this network
570          */
571         int ht40_intolerant;
572
573         /**
574          * disable_max_amsdu - Disable MAX A-MSDU
575          *
576          * A-MDSU will be 3839 bytes when disabled, or 7935
577          * when enabled (assuming it is otherwise supported)
578          * -1 (default) means do not apply any settings to the kernel.
579          */
580         int disable_max_amsdu;
581
582         /**
583          * ampdu_factor - Maximum A-MPDU Length Exponent
584          *
585          * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
586          */
587         int ampdu_factor;
588
589         /**
590          * ampdu_density - Minimum A-MPDU Start Spacing
591          *
592          * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
593          */
594         int ampdu_density;
595
596         /**
597          * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
598          *
599          * By default (empty string): Use whatever the OS has configured.
600          */
601         char *ht_mcs;
602 #endif /* CONFIG_HT_OVERRIDES */
603
604 #ifdef CONFIG_VHT_OVERRIDES
605         /**
606          * disable_vht - Disable VHT (IEEE 802.11ac) for this network
607          *
608          * By default, use it if it is available, but this can be configured
609          * to 1 to have it disabled.
610          */
611         int disable_vht;
612
613         /**
614          * vht_capa - VHT capabilities to use
615          */
616         unsigned int vht_capa;
617
618         /**
619          * vht_capa_mask - mask for VHT capabilities
620          */
621         unsigned int vht_capa_mask;
622
623         int vht_rx_mcs_nss_1, vht_rx_mcs_nss_2,
624             vht_rx_mcs_nss_3, vht_rx_mcs_nss_4,
625             vht_rx_mcs_nss_5, vht_rx_mcs_nss_6,
626             vht_rx_mcs_nss_7, vht_rx_mcs_nss_8;
627         int vht_tx_mcs_nss_1, vht_tx_mcs_nss_2,
628             vht_tx_mcs_nss_3, vht_tx_mcs_nss_4,
629             vht_tx_mcs_nss_5, vht_tx_mcs_nss_6,
630             vht_tx_mcs_nss_7, vht_tx_mcs_nss_8;
631 #endif /* CONFIG_VHT_OVERRIDES */
632
633         /**
634          * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
635          *
636          * This timeout value is used in AP mode to clean up inactive stations.
637          * By default: 300 seconds.
638          */
639         int ap_max_inactivity;
640
641         /**
642          * dtim_period - DTIM period in Beacon intervals
643          * By default: 2
644          */
645         int dtim_period;
646
647         /**
648          * beacon_int - Beacon interval (default: 100 TU)
649          */
650         int beacon_int;
651
652         /**
653          * auth_failures - Number of consecutive authentication failures
654          */
655         unsigned int auth_failures;
656
657         /**
658          * disabled_until - Network block disabled until this time if non-zero
659          */
660         struct os_reltime disabled_until;
661
662         /**
663          * parent_cred - Pointer to parent wpa_cred entry
664          *
665          * This pointer can be used to delete temporary networks when a wpa_cred
666          * that was used to create them is removed. This pointer should not be
667          * dereferences since it may not be updated in all cases.
668          */
669         void *parent_cred;
670
671 #ifdef CONFIG_MACSEC
672         /**
673          * macsec_policy - Determines the policy for MACsec secure session
674          *
675          * 0: MACsec not in use (default)
676          * 1: MACsec enabled - Should secure, accept key server's advice to
677          *    determine whether to use a secure session or not.
678          */
679         int macsec_policy;
680 #endif /* CONFIG_MACSEC */
681
682 #ifdef CONFIG_HS20
683         int update_identifier;
684 #endif /* CONFIG_HS20 */
685
686         unsigned int wps_run;
687
688         /**
689          * mac_addr - MAC address policy
690          *
691          * 0 = use permanent MAC address
692          * 1 = use random MAC address for each ESS connection
693          * 2 = like 1, but maintain OUI (with local admin bit set)
694          *
695          * Internally, special value -1 is used to indicate that the parameter
696          * was not specified in the configuration (i.e., default behavior is
697          * followed).
698          */
699         int mac_addr;
700
701         /**
702          * no_auto_peer - Do not automatically peer with compatible mesh peers
703          *
704          * When unset, the reception of a beacon from a another mesh peer in
705          * this MBSS will trigger a peering attempt.
706          */
707         int no_auto_peer;
708 };
709
710 #endif /* CONFIG_SSID_H */