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