config_ssid.h revision 04949598a23f501be6eec21697465fd46a28840a 
1/*
2 * WPA Supplicant / Network configuration structures
3 * Copyright (c) 2003-2008, 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 "eap_peer/eap_config.h"
14
15#define MAX_SSID_LEN 32
16
17
18#define DEFAULT_EAP_WORKAROUND ((unsigned int) -1)
19#define DEFAULT_EAPOL_FLAGS (EAPOL_FLAG_REQUIRE_KEY_UNICAST | \
20			     EAPOL_FLAG_REQUIRE_KEY_BROADCAST)
21#define DEFAULT_PROTO (WPA_PROTO_WPA | WPA_PROTO_RSN)
22#define DEFAULT_KEY_MGMT (WPA_KEY_MGMT_PSK | WPA_KEY_MGMT_IEEE8021X)
23#define DEFAULT_PAIRWISE (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP)
24#define DEFAULT_GROUP (WPA_CIPHER_CCMP | WPA_CIPHER_TKIP | \
25		       WPA_CIPHER_WEP104 | WPA_CIPHER_WEP40)
26#define DEFAULT_FRAGMENT_SIZE 1398
27
28#define DEFAULT_BG_SCAN_PERIOD -1
29#define DEFAULT_DISABLE_HT 0
30#define DEFAULT_DISABLE_HT40 0
31#define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */
32#define DEFAULT_AMPDU_FACTOR -1 /* no change */
33#define DEFAULT_AMPDU_DENSITY -1 /* no change */
34
35/**
36 * struct wpa_ssid - Network configuration data
37 *
38 * This structure includes all the configuration variables for a network. This
39 * data is included in the per-interface configuration data as an element of
40 * the network list, struct wpa_config::ssid. Each network block in the
41 * configuration is mapped to a struct wpa_ssid instance.
42 */
43struct wpa_ssid {
44	/**
45	 * next - Next network in global list
46	 *
47	 * This pointer can be used to iterate over all networks. The head of
48	 * this list is stored in the ssid field of struct wpa_config.
49	 */
50	struct wpa_ssid *next;
51
52	/**
53	 * pnext - Next network in per-priority list
54	 *
55	 * This pointer can be used to iterate over all networks in the same
56	 * priority class. The heads of these list are stored in the pssid
57	 * fields of struct wpa_config.
58	 */
59	struct wpa_ssid *pnext;
60
61	/**
62	 * id - Unique id for the network
63	 *
64	 * This identifier is used as a unique identifier for each network
65	 * block when using the control interface. Each network is allocated an
66	 * id when it is being created, either when reading the configuration
67	 * file or when a new network is added through the control interface.
68	 */
69	int id;
70
71	/**
72	 * priority - Priority group
73	 *
74	 * By default, all networks will get same priority group (0). If some
75	 * of the networks are more desirable, this field can be used to change
76	 * the order in which wpa_supplicant goes through the networks when
77	 * selecting a BSS. The priority groups will be iterated in decreasing
78	 * priority (i.e., the larger the priority value, the sooner the
79	 * network is matched against the scan results). Within each priority
80	 * group, networks will be selected based on security policy, signal
81	 * strength, etc.
82	 *
83	 * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are
84	 * not using this priority to select the order for scanning. Instead,
85	 * they try the networks in the order that used in the configuration
86	 * file.
87	 */
88	int priority;
89
90	/**
91	 * ssid - Service set identifier (network name)
92	 *
93	 * This is the SSID for the network. For wireless interfaces, this is
94	 * used to select which network will be used. If set to %NULL (or
95	 * ssid_len=0), any SSID can be used. For wired interfaces, this must
96	 * be set to %NULL. Note: SSID may contain any characters, even nul
97	 * (ASCII 0) and as such, this should not be assumed to be a nul
98	 * terminated string. ssid_len defines how many characters are valid
99	 * and the ssid field is not guaranteed to be nul terminated.
100	 */
101	u8 *ssid;
102
103	/**
104	 * ssid_len - Length of the SSID
105	 */
106	size_t ssid_len;
107
108	/**
109	 * bssid - BSSID
110	 *
111	 * If set, this network block is used only when associating with the AP
112	 * using the configured BSSID
113	 *
114	 * If this is a persistent P2P group (disabled == 2), this is the GO
115	 * Device Address.
116	 */
117	u8 bssid[ETH_ALEN];
118
119	/**
120	 * bssid_set - Whether BSSID is configured for this network
121	 */
122	int bssid_set;
123
124	/**
125	 * psk - WPA pre-shared key (256 bits)
126	 */
127	u8 psk[32];
128
129	/**
130	 * psk_set - Whether PSK field is configured
131	 */
132	int psk_set;
133
134	/**
135	 * passphrase - WPA ASCII passphrase
136	 *
137	 * If this is set, psk will be generated using the SSID and passphrase
138	 * configured for the network. ASCII passphrase must be between 8 and
139	 * 63 characters (inclusive).
140	 */
141	char *passphrase;
142
143	/**
144	 * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
145	 */
146	int pairwise_cipher;
147
148	/**
149	 * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*
150	 */
151	int group_cipher;
152
153	/**
154	 * key_mgmt - Bitfield of allowed key management protocols
155	 *
156	 * WPA_KEY_MGMT_*
157	 */
158	int key_mgmt;
159
160	/**
161	 * bg_scan_period - Background scan period in seconds, 0 to disable, or
162	 * -1 to indicate no change to default driver configuration
163	 */
164	int bg_scan_period;
165
166	/**
167	 * proto - Bitfield of allowed protocols, WPA_PROTO_*
168	 */
169	int proto;
170
171	/**
172	 * auth_alg -  Bitfield of allowed authentication algorithms
173	 *
174	 * WPA_AUTH_ALG_*
175	 */
176	int auth_alg;
177
178	/**
179	 * scan_ssid - Scan this SSID with Probe Requests
180	 *
181	 * scan_ssid can be used to scan for APs using hidden SSIDs.
182	 * Note: Many drivers do not support this. ap_mode=2 can be used with
183	 * such drivers to use hidden SSIDs.
184	 */
185	int scan_ssid;
186
187#ifdef IEEE8021X_EAPOL
188#define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0)
189#define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1)
190	/**
191	 * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*)
192	 */
193	int eapol_flags;
194
195	/**
196	 * eap - EAP peer configuration for this network
197	 */
198	struct eap_peer_config eap;
199#endif /* IEEE8021X_EAPOL */
200
201#define NUM_WEP_KEYS 4
202#define MAX_WEP_KEY_LEN 16
203	/**
204	 * wep_key - WEP keys
205	 */
206	u8 wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN];
207
208	/**
209	 * wep_key_len - WEP key lengths
210	 */
211	size_t wep_key_len[NUM_WEP_KEYS];
212
213	/**
214	 * wep_tx_keyidx - Default key index for TX frames using WEP
215	 */
216	int wep_tx_keyidx;
217
218	/**
219	 * proactive_key_caching - Enable proactive key caching
220	 *
221	 * This field can be used to enable proactive key caching which is also
222	 * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
223	 * by default. Enable by setting this to 1.
224	 *
225	 * Proactive key caching is used to make supplicant assume that the APs
226	 * are using the same PMK and generate PMKSA cache entries without
227	 * doing RSN pre-authentication. This requires support from the AP side
228	 * and is normally used with wireless switches that co-locate the
229	 * authenticator.
230	 */
231	int proactive_key_caching;
232
233	/**
234	 * mixed_cell - Whether mixed cells are allowed
235	 *
236	 * This option can be used to configure whether so called mixed cells,
237	 * i.e., networks that use both plaintext and encryption in the same
238	 * SSID, are allowed. This is disabled (0) by default. Enable by
239	 * setting this to 1.
240	 */
241	int mixed_cell;
242
243#ifdef IEEE8021X_EAPOL
244
245	/**
246	 * leap - Number of EAP methods using LEAP
247	 *
248	 * This field should be set to 1 if LEAP is enabled. This is used to
249	 * select IEEE 802.11 authentication algorithm.
250	 */
251	int leap;
252
253	/**
254	 * non_leap - Number of EAP methods not using LEAP
255	 *
256	 * This field should be set to >0 if any EAP method other than LEAP is
257	 * enabled. This is used to select IEEE 802.11 authentication
258	 * algorithm.
259	 */
260	int non_leap;
261
262	/**
263	 * eap_workaround - EAP workarounds enabled
264	 *
265	 * wpa_supplicant supports number of "EAP workarounds" to work around
266	 * interoperability issues with incorrectly behaving authentication
267	 * servers. This is recommended to be enabled by default because some
268	 * of the issues are present in large number of authentication servers.
269	 *
270	 * Strict EAP conformance mode can be configured by disabling
271	 * workarounds with eap_workaround = 0.
272	 */
273	unsigned int eap_workaround;
274
275#endif /* IEEE8021X_EAPOL */
276
277	/**
278	 * mode - IEEE 802.11 operation mode (Infrastucture/IBSS)
279	 *
280	 * 0 = infrastructure (Managed) mode, i.e., associate with an AP.
281	 *
282	 * 1 = IBSS (ad-hoc, peer-to-peer)
283	 *
284	 * 2 = AP (access point)
285	 *
286	 * 3 = P2P Group Owner (can be set in the configuration file)
287	 *
288	 * 4 = P2P Group Formation (used internally; not in configuration
289	 * files)
290	 *
291	 * Note: IBSS can only be used with key_mgmt NONE (plaintext and
292	 * static WEP) and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). In
293	 * addition, ap_scan has to be set to 2 for IBSS. WPA-None requires
294	 * following network block options: proto=WPA, key_mgmt=WPA-NONE,
295	 * pairwise=NONE, group=TKIP (or CCMP, but not both), and psk must also
296	 * be set (either directly or using ASCII passphrase).
297	 */
298	enum wpas_mode {
299		WPAS_MODE_INFRA = 0,
300		WPAS_MODE_IBSS = 1,
301		WPAS_MODE_AP = 2,
302		WPAS_MODE_P2P_GO = 3,
303		WPAS_MODE_P2P_GROUP_FORMATION = 4,
304	} mode;
305
306	/**
307	 * disabled - Whether this network is currently disabled
308	 *
309	 * 0 = this network can be used (default).
310	 * 1 = this network block is disabled (can be enabled through
311	 * ctrl_iface, e.g., with wpa_cli or wpa_gui).
312	 * 2 = this network block includes parameters for a persistent P2P
313	 * group (can be used with P2P ctrl_iface commands)
314	 */
315	int disabled;
316
317	/**
318	 * peerkey -  Whether PeerKey handshake for direct links is allowed
319	 *
320	 * This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are
321	 * enabled.
322	 *
323	 * 0 = disabled (default)
324	 * 1 = enabled
325	 */
326	int peerkey;
327
328	/**
329	 * id_str - Network identifier string for external scripts
330	 *
331	 * This value is passed to external ctrl_iface monitors in
332	 * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR
333	 * environment variable for action scripts.
334	 */
335	char *id_str;
336
337#ifdef CONFIG_IEEE80211W
338	/**
339	 * ieee80211w - Whether management frame protection is enabled
340	 *
341	 * This value is used to configure policy for management frame
342	 * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
343	 */
344	enum mfp_options ieee80211w;
345#endif /* CONFIG_IEEE80211W */
346
347	/**
348	 * frequency - Channel frequency in megahertz (MHz) for IBSS
349	 *
350	 * This value is used to configure the initial channel for IBSS (adhoc)
351	 * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in
352	 * the infrastructure mode. In addition, this value is only used by the
353	 * station that creates the IBSS. If an IBSS network with the
354	 * configured SSID is already present, the frequency of the network
355	 * will be used instead of this configured value.
356	 */
357	int frequency;
358
359	/**
360	 * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
361	 *
362	 * This value can be used to enforce rekeying of PTK to mitigate some
363	 * attacks against TKIP deficiencies.
364	 */
365	int wpa_ptk_rekey;
366
367	/**
368	 * scan_freq - Array of frequencies to scan or %NULL for all
369	 *
370	 * This is an optional zero-terminated array of frequencies in
371	 * megahertz (MHz) to include in scan requests when searching for this
372	 * network. This can be used to speed up scanning when the network is
373	 * known to not use all possible channels.
374	 */
375	int *scan_freq;
376
377	/**
378	 * bgscan - Background scan and roaming parameters or %NULL if none
379	 *
380	 * This is an optional set of parameters for background scanning and
381	 * roaming within a network (ESS) in following format:
382	 * <bgscan module name>:<module parameters>
383	 */
384	char *bgscan;
385
386	/**
387	 * ignore_broadcast_ssid - Hide SSID in AP mode
388	 *
389	 * Send empty SSID in beacons and ignore probe request frames that do
390	 * not specify full SSID, i.e., require stations to know SSID.
391	 * default: disabled (0)
392	 * 1 = send empty (length=0) SSID in beacon and ignore probe request
393	 * for broadcast SSID
394	 * 2 = clear SSID (ASCII 0), but keep the original length (this may be
395	 * required with some clients that do not support empty SSID) and
396	 * ignore probe requests for broadcast SSID
397	 */
398	int ignore_broadcast_ssid;
399
400	/**
401	 * freq_list - Array of allowed frequencies or %NULL for all
402	 *
403	 * This is an optional zero-terminated array of frequencies in
404	 * megahertz (MHz) to allow for selecting the BSS. If set, scan results
405	 * that do not match any of the specified frequencies are not
406	 * considered when selecting a BSS.
407	 */
408	int *freq_list;
409
410	/**
411	 * p2p_client_list - List of P2P Clients in a persistent group (GO)
412	 *
413	 * This is a list of P2P Clients (P2P Device Address) that have joined
414	 * the persistent group. This is maintained on the GO for persistent
415	 * group entries (disabled == 2).
416	 */
417	u8 *p2p_client_list;
418
419	/**
420	 * num_p2p_clients - Number of entries in p2p_client_list
421	 */
422	size_t num_p2p_clients;
423
424	/**
425	 * p2p_group - Network generated as a P2P group (used internally)
426	 */
427	int p2p_group;
428
429	/**
430	 * p2p_persistent_group - Whether this is a persistent group
431	 */
432	int p2p_persistent_group;
433
434	/**
435	 * temporary - Whether this network is temporary and not to be saved
436	 */
437	int temporary;
438
439	/**
440	 * export_keys - Whether keys may be exported
441	 *
442	 * This attribute will be set when keys are determined through
443	 * WPS or similar so that they may be exported.
444	 */
445	int export_keys;
446#ifdef ANDROID_P2P
447	/**
448	 * assoc_retry - Number of times association should be retried.
449	 */
450	int assoc_retry;
451#endif
452
453#ifdef CONFIG_HT_OVERRIDES
454	/**
455	 * disable_ht - Disable HT (IEEE 802.11n) for this network
456	 *
457	 * By default, use it if it is available, but this can be configured
458	 * to 1 to have it disabled.
459	 */
460	int disable_ht;
461
462	/**
463	 * disable_ht40 - Disable HT40 for this network
464	 *
465	 * By default, use it if it is available, but this can be configured
466	 * to 1 to have it disabled.
467	 */
468	int disable_ht40;
469
470	/**
471	 * disable_max_amsdu - Disable MAX A-MSDU
472	 *
473	 * A-MDSU will be 3839 bytes when disabled, or 7935
474	 * when enabled (assuming it is otherwise supported)
475	 * -1 (default) means do not apply any settings to the kernel.
476	 */
477	int disable_max_amsdu;
478
479	/**
480	 * ampdu_factor - Maximum A-MPDU Length Exponent
481	 *
482	 * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
483	 */
484	int ampdu_factor;
485
486	/**
487	 * ampdu_density - Minimum A-MPDU Start Spacing
488	 *
489	 * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
490	 */
491	int ampdu_density;
492
493	/**
494	 * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
495	 *
496	 * By default (empty string): Use whatever the OS has configured.
497	 */
498	char *ht_mcs;
499#endif /* CONFIG_HT_OVERRIDES */
500
501	/**
502	 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
503	 *
504	 * This timeout value is used in AP mode to clean up inactive stations.
505	 * By default: 300 seconds.
506	 */
507	int ap_max_inactivity;
508
509	/**
510	 * dtim_period - DTIM period in Beacon intervals
511	 * By default: 2
512	 */
513	int dtim_period;
514};
515
516#endif /* CONFIG_SSID_H */
517