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