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