2 * WPA Supplicant / Network configuration structures
3 * Copyright (c) 2003-2008, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 #include "common/defs.h"
13 #include "eap_peer/eap_config.h"
15 #define MAX_SSID_LEN 32
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
28 #define DEFAULT_BG_SCAN_PERIOD -1
29 #define DEFAULT_DISABLE_HT 0
30 #define DEFAULT_DISABLE_HT40 0
31 #define DEFAULT_DISABLE_SGI 0
32 #define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */
33 #define DEFAULT_AMPDU_FACTOR -1 /* no change */
34 #define DEFAULT_AMPDU_DENSITY -1 /* no change */
37 * struct wpa_ssid - Network configuration data
39 * This structure includes all the configuration variables for a network. This
40 * data is included in the per-interface configuration data as an element of
41 * the network list, struct wpa_config::ssid. Each network block in the
42 * configuration is mapped to a struct wpa_ssid instance.
46 * next - Next network in global list
48 * This pointer can be used to iterate over all networks. The head of
49 * this list is stored in the ssid field of struct wpa_config.
51 struct wpa_ssid
*next
;
54 * pnext - Next network in per-priority list
56 * This pointer can be used to iterate over all networks in the same
57 * priority class. The heads of these list are stored in the pssid
58 * fields of struct wpa_config.
60 struct wpa_ssid
*pnext
;
63 * id - Unique id for the network
65 * This identifier is used as a unique identifier for each network
66 * block when using the control interface. Each network is allocated an
67 * id when it is being created, either when reading the configuration
68 * file or when a new network is added through the control interface.
73 * priority - Priority group
75 * By default, all networks will get same priority group (0). If some
76 * of the networks are more desirable, this field can be used to change
77 * the order in which wpa_supplicant goes through the networks when
78 * selecting a BSS. The priority groups will be iterated in decreasing
79 * priority (i.e., the larger the priority value, the sooner the
80 * network is matched against the scan results). Within each priority
81 * group, networks will be selected based on security policy, signal
84 * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are
85 * not using this priority to select the order for scanning. Instead,
86 * they try the networks in the order that used in the configuration
92 * ssid - Service set identifier (network name)
94 * This is the SSID for the network. For wireless interfaces, this is
95 * used to select which network will be used. If set to %NULL (or
96 * ssid_len=0), any SSID can be used. For wired interfaces, this must
97 * be set to %NULL. Note: SSID may contain any characters, even nul
98 * (ASCII 0) and as such, this should not be assumed to be a nul
99 * terminated string. ssid_len defines how many characters are valid
100 * and the ssid field is not guaranteed to be nul terminated.
105 * ssid_len - Length of the SSID
112 * If set, this network block is used only when associating with the AP
113 * using the configured BSSID
115 * If this is a persistent P2P group (disabled == 2), this is the GO
121 * bssid_set - Whether BSSID is configured for this network
126 * psk - WPA pre-shared key (256 bits)
131 * psk_set - Whether PSK field is configured
136 * passphrase - WPA ASCII passphrase
138 * If this is set, psk will be generated using the SSID and passphrase
139 * configured for the network. ASCII passphrase must be between 8 and
140 * 63 characters (inclusive).
145 * ext_psk - PSK/passphrase name in external storage
147 * If this is set, PSK/passphrase will be fetched from external storage
148 * when requesting association with the network.
153 * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
158 * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*
163 * key_mgmt - Bitfield of allowed key management protocols
170 * bg_scan_period - Background scan period in seconds, 0 to disable, or
171 * -1 to indicate no change to default driver configuration
176 * proto - Bitfield of allowed protocols, WPA_PROTO_*
181 * auth_alg - Bitfield of allowed authentication algorithms
188 * scan_ssid - Scan this SSID with Probe Requests
190 * scan_ssid can be used to scan for APs using hidden SSIDs.
191 * Note: Many drivers do not support this. ap_mode=2 can be used with
192 * such drivers to use hidden SSIDs.
196 #ifdef IEEE8021X_EAPOL
197 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0)
198 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1)
200 * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*)
205 * eap - EAP peer configuration for this network
207 struct eap_peer_config eap
;
208 #endif /* IEEE8021X_EAPOL */
210 #define NUM_WEP_KEYS 4
211 #define MAX_WEP_KEY_LEN 16
215 u8 wep_key
[NUM_WEP_KEYS
][MAX_WEP_KEY_LEN
];
218 * wep_key_len - WEP key lengths
220 size_t wep_key_len
[NUM_WEP_KEYS
];
223 * wep_tx_keyidx - Default key index for TX frames using WEP
228 * proactive_key_caching - Enable proactive key caching
230 * This field can be used to enable proactive key caching which is also
231 * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
232 * by default unless default value is changed with the global okc=1
233 * parameter. Enable by setting this to 1.
235 * Proactive key caching is used to make supplicant assume that the APs
236 * are using the same PMK and generate PMKSA cache entries without
237 * doing RSN pre-authentication. This requires support from the AP side
238 * and is normally used with wireless switches that co-locate the
241 * Internally, special value -1 is used to indicate that the parameter
242 * was not specified in the configuration (i.e., default behavior is
245 int proactive_key_caching
;
248 * mixed_cell - Whether mixed cells are allowed
250 * This option can be used to configure whether so called mixed cells,
251 * i.e., networks that use both plaintext and encryption in the same
252 * SSID, are allowed. This is disabled (0) by default. Enable by
257 #ifdef IEEE8021X_EAPOL
260 * leap - Number of EAP methods using LEAP
262 * This field should be set to 1 if LEAP is enabled. This is used to
263 * select IEEE 802.11 authentication algorithm.
268 * non_leap - Number of EAP methods not using LEAP
270 * This field should be set to >0 if any EAP method other than LEAP is
271 * enabled. This is used to select IEEE 802.11 authentication
277 * eap_workaround - EAP workarounds enabled
279 * wpa_supplicant supports number of "EAP workarounds" to work around
280 * interoperability issues with incorrectly behaving authentication
281 * servers. This is recommended to be enabled by default because some
282 * of the issues are present in large number of authentication servers.
284 * Strict EAP conformance mode can be configured by disabling
285 * workarounds with eap_workaround = 0.
287 unsigned int eap_workaround
;
289 #endif /* IEEE8021X_EAPOL */
292 * mode - IEEE 802.11 operation mode (Infrastucture/IBSS)
294 * 0 = infrastructure (Managed) mode, i.e., associate with an AP.
296 * 1 = IBSS (ad-hoc, peer-to-peer)
298 * 2 = AP (access point)
300 * 3 = P2P Group Owner (can be set in the configuration file)
302 * 4 = P2P Group Formation (used internally; not in configuration
305 * Note: IBSS can only be used with key_mgmt NONE (plaintext and
306 * static WEP) and key_mgmt=WPA-NONE (fixed group key TKIP/CCMP). In
307 * addition, ap_scan has to be set to 2 for IBSS. WPA-None requires
308 * following network block options: proto=WPA, key_mgmt=WPA-NONE,
309 * pairwise=NONE, group=TKIP (or CCMP, but not both), and psk must also
310 * be set (either directly or using ASCII passphrase).
316 WPAS_MODE_P2P_GO
= 3,
317 WPAS_MODE_P2P_GROUP_FORMATION
= 4,
321 * disabled - Whether this network is currently disabled
323 * 0 = this network can be used (default).
324 * 1 = this network block is disabled (can be enabled through
325 * ctrl_iface, e.g., with wpa_cli or wpa_gui).
326 * 2 = this network block includes parameters for a persistent P2P
327 * group (can be used with P2P ctrl_iface commands)
332 * disabled_for_connect - Whether this network was temporarily disabled
334 * This flag is used to reenable all the temporarily disabled networks
335 * after either the success or failure of a WPS connection.
337 int disabled_for_connect
;
340 * peerkey - Whether PeerKey handshake for direct links is allowed
342 * This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are
345 * 0 = disabled (default)
351 * id_str - Network identifier string for external scripts
353 * This value is passed to external ctrl_iface monitors in
354 * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR
355 * environment variable for action scripts.
359 #ifdef CONFIG_IEEE80211W
361 * ieee80211w - Whether management frame protection is enabled
363 * This value is used to configure policy for management frame
364 * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
365 * This is disabled by default unless the default value has been changed
366 * with the global pmf=1/2 parameter.
368 * Internally, special value 3 is used to indicate that the parameter
369 * was not specified in the configuration (i.e., default behavior is
372 enum mfp_options ieee80211w
;
373 #endif /* CONFIG_IEEE80211W */
376 * frequency - Channel frequency in megahertz (MHz) for IBSS
378 * This value is used to configure the initial channel for IBSS (adhoc)
379 * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in
380 * the infrastructure mode. In addition, this value is only used by the
381 * station that creates the IBSS. If an IBSS network with the
382 * configured SSID is already present, the frequency of the network
383 * will be used instead of this configured value.
390 * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
392 * This value can be used to enforce rekeying of PTK to mitigate some
393 * attacks against TKIP deficiencies.
398 * scan_freq - Array of frequencies to scan or %NULL for all
400 * This is an optional zero-terminated array of frequencies in
401 * megahertz (MHz) to include in scan requests when searching for this
402 * network. This can be used to speed up scanning when the network is
403 * known to not use all possible channels.
408 * bgscan - Background scan and roaming parameters or %NULL if none
410 * This is an optional set of parameters for background scanning and
411 * roaming within a network (ESS) in following format:
412 * <bgscan module name>:<module parameters>
417 * ignore_broadcast_ssid - Hide SSID in AP mode
419 * Send empty SSID in beacons and ignore probe request frames that do
420 * not specify full SSID, i.e., require stations to know SSID.
421 * default: disabled (0)
422 * 1 = send empty (length=0) SSID in beacon and ignore probe request
424 * 2 = clear SSID (ASCII 0), but keep the original length (this may be
425 * required with some clients that do not support empty SSID) and
426 * ignore probe requests for broadcast SSID
428 int ignore_broadcast_ssid
;
431 * freq_list - Array of allowed frequencies or %NULL for all
433 * This is an optional zero-terminated array of frequencies in
434 * megahertz (MHz) to allow for selecting the BSS. If set, scan results
435 * that do not match any of the specified frequencies are not
436 * considered when selecting a BSS.
441 * p2p_client_list - List of P2P Clients in a persistent group (GO)
443 * This is a list of P2P Clients (P2P Device Address) that have joined
444 * the persistent group. This is maintained on the GO for persistent
445 * group entries (disabled == 2).
450 * num_p2p_clients - Number of entries in p2p_client_list
452 size_t num_p2p_clients
;
454 #ifndef P2P_MAX_STORED_CLIENTS
455 #define P2P_MAX_STORED_CLIENTS 100
456 #endif /* P2P_MAX_STORED_CLIENTS */
459 * p2p_group - Network generated as a P2P group (used internally)
464 * p2p_persistent_group - Whether this is a persistent group
466 int p2p_persistent_group
;
469 * temporary - Whether this network is temporary and not to be saved
474 * export_keys - Whether keys may be exported
476 * This attribute will be set when keys are determined through
477 * WPS or similar so that they may be exported.
481 #ifdef CONFIG_HT_OVERRIDES
483 * disable_ht - Disable HT (IEEE 802.11n) for this network
485 * By default, use it if it is available, but this can be configured
486 * to 1 to have it disabled.
491 * disable_ht40 - Disable HT40 for this network
493 * By default, use it if it is available, but this can be configured
494 * to 1 to have it disabled.
499 * disable_sgi - Disable SGI (Short Guard Interval) for this network
501 * By default, use it if it is available, but this can be configured
502 * to 1 to have it disabled.
507 * disable_max_amsdu - Disable MAX A-MSDU
509 * A-MDSU will be 3839 bytes when disabled, or 7935
510 * when enabled (assuming it is otherwise supported)
511 * -1 (default) means do not apply any settings to the kernel.
513 int disable_max_amsdu
;
516 * ampdu_factor - Maximum A-MPDU Length Exponent
518 * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
523 * ampdu_density - Minimum A-MPDU Start Spacing
525 * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
530 * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
532 * By default (empty string): Use whatever the OS has configured.
535 #endif /* CONFIG_HT_OVERRIDES */
538 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
540 * This timeout value is used in AP mode to clean up inactive stations.
541 * By default: 300 seconds.
543 int ap_max_inactivity
;
546 * dtim_period - DTIM period in Beacon intervals
552 * beacon_int - Beacon interval (default: 100 TU)
557 * auth_failures - Number of consecutive authentication failures
559 unsigned int auth_failures
;
562 * disabled_until - Network block disabled until this time if non-zero
564 struct os_time disabled_until
;
567 * parent_cred - Pointer to parent wpa_cred entry
569 * This pointer can be used to delete temporary networks when a wpa_cred
570 * that was used to create them is removed. This pointer should not be
571 * dereferences since it may not be updated in all cases.
576 #endif /* CONFIG_SSID_H */