2 * WPA Supplicant / Network configuration structures
3 * Copyright (c) 2003-2013, 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 "utils/list.h"
14 #include "eap_peer/eap_config.h"
16 #define MAX_SSID_LEN 32
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
29 #define DEFAULT_BG_SCAN_PERIOD -1
30 #define DEFAULT_DISABLE_HT 0
31 #define DEFAULT_DISABLE_HT40 0
32 #define DEFAULT_DISABLE_SGI 0
33 #define DEFAULT_DISABLE_LDPC 0
34 #define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */
35 #define DEFAULT_AMPDU_FACTOR -1 /* no change */
36 #define DEFAULT_AMPDU_DENSITY -1 /* no change */
37 #define DEFAULT_USER_SELECTED_SIM 1
39 struct psk_list_entry {
47 * struct wpa_ssid - Network configuration data
49 * This structure includes all the configuration variables for a network. This
50 * data is included in the per-interface configuration data as an element of
51 * the network list, struct wpa_config::ssid. Each network block in the
52 * configuration is mapped to a struct wpa_ssid instance.
56 * next - Next network in global list
58 * This pointer can be used to iterate over all networks. The head of
59 * this list is stored in the ssid field of struct wpa_config.
61 struct wpa_ssid *next;
64 * pnext - Next network in per-priority list
66 * This pointer can be used to iterate over all networks in the same
67 * priority class. The heads of these list are stored in the pssid
68 * fields of struct wpa_config.
70 struct wpa_ssid *pnext;
73 * id - Unique id for the network
75 * This identifier is used as a unique identifier for each network
76 * block when using the control interface. Each network is allocated an
77 * id when it is being created, either when reading the configuration
78 * file or when a new network is added through the control interface.
83 * priority - Priority group
85 * By default, all networks will get same priority group (0). If some
86 * of the networks are more desirable, this field can be used to change
87 * the order in which wpa_supplicant goes through the networks when
88 * selecting a BSS. The priority groups will be iterated in decreasing
89 * priority (i.e., the larger the priority value, the sooner the
90 * network is matched against the scan results). Within each priority
91 * group, networks will be selected based on security policy, signal
94 * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are
95 * not using this priority to select the order for scanning. Instead,
96 * they try the networks in the order that used in the configuration
102 * ssid - Service set identifier (network name)
104 * This is the SSID for the network. For wireless interfaces, this is
105 * used to select which network will be used. If set to %NULL (or
106 * ssid_len=0), any SSID can be used. For wired interfaces, this must
107 * be set to %NULL. Note: SSID may contain any characters, even nul
108 * (ASCII 0) and as such, this should not be assumed to be a nul
109 * terminated string. ssid_len defines how many characters are valid
110 * and the ssid field is not guaranteed to be nul terminated.
115 * ssid_len - Length of the SSID
122 * If set, this network block is used only when associating with the AP
123 * using the configured BSSID
125 * If this is a persistent P2P group (disabled == 2), this is the GO
131 * bssid_set - Whether BSSID is configured for this network
136 * go_p2p_dev_addr - GO's P2P Device Address or all zeros if not set
138 u8 go_p2p_dev_addr[ETH_ALEN];
141 * psk - WPA pre-shared key (256 bits)
146 * psk_set - Whether PSK field is configured
151 * passphrase - WPA ASCII passphrase
153 * If this is set, psk will be generated using the SSID and passphrase
154 * configured for the network. ASCII passphrase must be between 8 and
155 * 63 characters (inclusive).
160 * ext_psk - PSK/passphrase name in external storage
162 * If this is set, PSK/passphrase will be fetched from external storage
163 * when requesting association with the network.
168 * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
173 * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*
178 * key_mgmt - Bitfield of allowed key management protocols
185 * bg_scan_period - Background scan period in seconds, 0 to disable, or
186 * -1 to indicate no change to default driver configuration
191 * proto - Bitfield of allowed protocols, WPA_PROTO_*
196 * auth_alg - Bitfield of allowed authentication algorithms
203 * scan_ssid - Scan this SSID with Probe Requests
205 * scan_ssid can be used to scan for APs using hidden SSIDs.
206 * Note: Many drivers do not support this. ap_mode=2 can be used with
207 * such drivers to use hidden SSIDs.
211 #ifdef IEEE8021X_EAPOL
212 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0)
213 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1)
215 * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*)
220 * eap - EAP peer configuration for this network
222 struct eap_peer_config eap;
223 #endif /* IEEE8021X_EAPOL */
225 #define NUM_WEP_KEYS 4
226 #define MAX_WEP_KEY_LEN 16
230 u8 wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN];
233 * wep_key_len - WEP key lengths
235 size_t wep_key_len[NUM_WEP_KEYS];
238 * wep_tx_keyidx - Default key index for TX frames using WEP
243 * proactive_key_caching - Enable proactive key caching
245 * This field can be used to enable proactive key caching which is also
246 * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
247 * by default unless default value is changed with the global okc=1
248 * parameter. Enable by setting this to 1.
250 * Proactive key caching is used to make supplicant assume that the APs
251 * are using the same PMK and generate PMKSA cache entries without
252 * doing RSN pre-authentication. This requires support from the AP side
253 * and is normally used with wireless switches that co-locate the
256 * Internally, special value -1 is used to indicate that the parameter
257 * was not specified in the configuration (i.e., default behavior is
260 int proactive_key_caching;
263 * mixed_cell - Whether mixed cells are allowed
265 * This option can be used to configure whether so called mixed cells,
266 * i.e., networks that use both plaintext and encryption in the same
267 * SSID, are allowed. This is disabled (0) by default. Enable by
272 #ifdef IEEE8021X_EAPOL
275 * leap - Number of EAP methods using LEAP
277 * This field should be set to 1 if LEAP is enabled. This is used to
278 * select IEEE 802.11 authentication algorithm.
283 * non_leap - Number of EAP methods not using LEAP
285 * This field should be set to >0 if any EAP method other than LEAP is
286 * enabled. This is used to select IEEE 802.11 authentication
292 * eap_workaround - EAP workarounds enabled
294 * wpa_supplicant supports number of "EAP workarounds" to work around
295 * interoperability issues with incorrectly behaving authentication
296 * servers. This is recommended to be enabled by default because some
297 * of the issues are present in large number of authentication servers.
299 * Strict EAP conformance mode can be configured by disabling
300 * workarounds with eap_workaround = 0.
302 unsigned int eap_workaround;
304 #endif /* IEEE8021X_EAPOL */
307 * mode - IEEE 802.11 operation mode (Infrastucture/IBSS)
309 * 0 = infrastructure (Managed) mode, i.e., associate with an AP.
311 * 1 = IBSS (ad-hoc, peer-to-peer)
313 * 2 = AP (access point)
315 * 3 = P2P Group Owner (can be set in the configuration file)
317 * 4 = P2P Group Formation (used internally; not in configuration
320 * Note: IBSS can only be used with key_mgmt NONE (plaintext and static
321 * WEP) and WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE
322 * (fixed group key TKIP/CCMP) is available for backwards compatibility,
323 * but its use is deprecated. WPA-None requires following network block
324 * options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or
325 * CCMP, but not both), and psk must also be set (either directly or
326 * using ASCII passphrase).
332 WPAS_MODE_P2P_GO = 3,
333 WPAS_MODE_P2P_GROUP_FORMATION = 4,
337 * disabled - Whether this network is currently disabled
339 * 0 = this network can be used (default).
340 * 1 = this network block is disabled (can be enabled through
341 * ctrl_iface, e.g., with wpa_cli or wpa_gui).
342 * 2 = this network block includes parameters for a persistent P2P
343 * group (can be used with P2P ctrl_iface commands)
348 * disabled_for_connect - Whether this network was temporarily disabled
350 * This flag is used to reenable all the temporarily disabled networks
351 * after either the success or failure of a WPS connection.
353 int disabled_for_connect;
356 * peerkey - Whether PeerKey handshake for direct links is allowed
358 * This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are
361 * 0 = disabled (default)
367 * id_str - Network identifier string for external scripts
369 * This value is passed to external ctrl_iface monitors in
370 * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR
371 * environment variable for action scripts.
375 #ifdef CONFIG_IEEE80211W
377 * ieee80211w - Whether management frame protection is enabled
379 * This value is used to configure policy for management frame
380 * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
381 * This is disabled by default unless the default value has been changed
382 * with the global pmf=1/2 parameter.
384 * Internally, special value 3 is used to indicate that the parameter
385 * was not specified in the configuration (i.e., default behavior is
388 enum mfp_options ieee80211w;
389 #endif /* CONFIG_IEEE80211W */
392 * frequency - Channel frequency in megahertz (MHz) for IBSS
394 * This value is used to configure the initial channel for IBSS (adhoc)
395 * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in
396 * the infrastructure mode. In addition, this value is only used by the
397 * station that creates the IBSS. If an IBSS network with the
398 * configured SSID is already present, the frequency of the network
399 * will be used instead of this configured value.
408 * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
410 * This value can be used to enforce rekeying of PTK to mitigate some
411 * attacks against TKIP deficiencies.
416 * scan_freq - Array of frequencies to scan or %NULL for all
418 * This is an optional zero-terminated array of frequencies in
419 * megahertz (MHz) to include in scan requests when searching for this
420 * network. This can be used to speed up scanning when the network is
421 * known to not use all possible channels.
426 * bgscan - Background scan and roaming parameters or %NULL if none
428 * This is an optional set of parameters for background scanning and
429 * roaming within a network (ESS) in following format:
430 * <bgscan module name>:<module parameters>
435 * ignore_broadcast_ssid - Hide SSID in AP mode
437 * Send empty SSID in beacons and ignore probe request frames that do
438 * not specify full SSID, i.e., require stations to know SSID.
439 * default: disabled (0)
440 * 1 = send empty (length=0) SSID in beacon and ignore probe request
442 * 2 = clear SSID (ASCII 0), but keep the original length (this may be
443 * required with some clients that do not support empty SSID) and
444 * ignore probe requests for broadcast SSID
446 int ignore_broadcast_ssid;
449 * freq_list - Array of allowed frequencies or %NULL for all
451 * This is an optional zero-terminated array of frequencies in
452 * megahertz (MHz) to allow for selecting the BSS. If set, scan results
453 * that do not match any of the specified frequencies are not
454 * considered when selecting a BSS.
459 * p2p_client_list - List of P2P Clients in a persistent group (GO)
461 * This is a list of P2P Clients (P2P Device Address) that have joined
462 * the persistent group. This is maintained on the GO for persistent
463 * group entries (disabled == 2).
468 * num_p2p_clients - Number of entries in p2p_client_list
470 size_t num_p2p_clients;
472 #ifndef P2P_MAX_STORED_CLIENTS
473 #define P2P_MAX_STORED_CLIENTS 100
474 #endif /* P2P_MAX_STORED_CLIENTS */
477 * psk_list - Per-client PSKs (struct psk_list_entry)
479 struct dl_list psk_list;
482 * p2p_group - Network generated as a P2P group (used internally)
487 * p2p_persistent_group - Whether this is a persistent group
489 int p2p_persistent_group;
492 * temporary - Whether this network is temporary and not to be saved
497 * export_keys - Whether keys may be exported
499 * This attribute will be set when keys are determined through
500 * WPS or similar so that they may be exported.
504 #ifdef CONFIG_HT_OVERRIDES
506 * disable_ht - Disable HT (IEEE 802.11n) for this network
508 * By default, use it if it is available, but this can be configured
509 * to 1 to have it disabled.
514 * disable_ht40 - Disable HT40 for this network
516 * By default, use it if it is available, but this can be configured
517 * to 1 to have it disabled.
522 * disable_sgi - Disable SGI (Short Guard Interval) for this network
524 * By default, use it if it is available, but this can be configured
525 * to 1 to have it disabled.
530 * disable_ldpc - Disable LDPC for this network
532 * By default, use it if it is available, but this can be configured
533 * to 1 to have it disabled.
538 * ht40_intolerant - Indicate 40 MHz intolerant for this network
543 * disable_max_amsdu - Disable MAX A-MSDU
545 * A-MDSU will be 3839 bytes when disabled, or 7935
546 * when enabled (assuming it is otherwise supported)
547 * -1 (default) means do not apply any settings to the kernel.
549 int disable_max_amsdu;
552 * ampdu_factor - Maximum A-MPDU Length Exponent
554 * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
559 * ampdu_density - Minimum A-MPDU Start Spacing
561 * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
566 * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
568 * By default (empty string): Use whatever the OS has configured.
571 #endif /* CONFIG_HT_OVERRIDES */
573 #ifdef CONFIG_VHT_OVERRIDES
575 * disable_vht - Disable VHT (IEEE 802.11ac) for this network
577 * By default, use it if it is available, but this can be configured
578 * to 1 to have it disabled.
583 * vht_capa - VHT capabilities to use
585 unsigned int vht_capa;
588 * vht_capa_mask - mask for VHT capabilities
590 unsigned int vht_capa_mask;
592 int vht_rx_mcs_nss_1, vht_rx_mcs_nss_2,
593 vht_rx_mcs_nss_3, vht_rx_mcs_nss_4,
594 vht_rx_mcs_nss_5, vht_rx_mcs_nss_6,
595 vht_rx_mcs_nss_7, vht_rx_mcs_nss_8;
596 int vht_tx_mcs_nss_1, vht_tx_mcs_nss_2,
597 vht_tx_mcs_nss_3, vht_tx_mcs_nss_4,
598 vht_tx_mcs_nss_5, vht_tx_mcs_nss_6,
599 vht_tx_mcs_nss_7, vht_tx_mcs_nss_8;
600 #endif /* CONFIG_VHT_OVERRIDES */
603 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
605 * This timeout value is used in AP mode to clean up inactive stations.
606 * By default: 300 seconds.
608 int ap_max_inactivity;
611 * dtim_period - DTIM period in Beacon intervals
617 * beacon_int - Beacon interval (default: 100 TU)
622 * auth_failures - Number of consecutive authentication failures
624 unsigned int auth_failures;
627 * disabled_until - Network block disabled until this time if non-zero
629 struct os_reltime disabled_until;
632 * parent_cred - Pointer to parent wpa_cred entry
634 * This pointer can be used to delete temporary networks when a wpa_cred
635 * that was used to create them is removed. This pointer should not be
636 * dereferences since it may not be updated in all cases.
642 * macsec_policy - Determines the policy for MACsec secure session
644 * 0: MACsec not in use (default)
645 * 1: MACsec enabled - Should secure, accept key server's advice to
646 * determine whether to use a secure session or not.
649 #endif /* CONFIG_MACSEC */
652 int update_identifier;
653 #endif /* CONFIG_HS20 */
656 #endif /* CONFIG_SSID_H */