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"
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 #define DEFAULT_FRAGMENT_SIZE 1398
26 #define DEFAULT_BG_SCAN_PERIOD -1
27 #define DEFAULT_MESH_MAX_RETRIES 2
28 #define DEFAULT_MESH_RETRY_TIMEOUT 40
29 #define DEFAULT_MESH_CONFIRM_TIMEOUT 40
30 #define DEFAULT_MESH_HOLDING_TIMEOUT 40
31 #define DEFAULT_DISABLE_HT 0
32 #define DEFAULT_DISABLE_HT40 0
33 #define DEFAULT_DISABLE_SGI 0
34 #define DEFAULT_DISABLE_LDPC 0
35 #define DEFAULT_DISABLE_MAX_AMSDU -1 /* no change */
36 #define DEFAULT_AMPDU_FACTOR -1 /* no change */
37 #define DEFAULT_AMPDU_DENSITY -1 /* no change */
38 #define DEFAULT_USER_SELECTED_SIM 1
40 struct psk_list_entry {
48 * struct wpa_ssid - Network configuration data
50 * This structure includes all the configuration variables for a network. This
51 * data is included in the per-interface configuration data as an element of
52 * the network list, struct wpa_config::ssid. Each network block in the
53 * configuration is mapped to a struct wpa_ssid instance.
57 * next - Next network in global list
59 * This pointer can be used to iterate over all networks. The head of
60 * this list is stored in the ssid field of struct wpa_config.
62 struct wpa_ssid *next;
65 * pnext - Next network in per-priority list
67 * This pointer can be used to iterate over all networks in the same
68 * priority class. The heads of these list are stored in the pssid
69 * fields of struct wpa_config.
71 struct wpa_ssid *pnext;
74 * id - Unique id for the network
76 * This identifier is used as a unique identifier for each network
77 * block when using the control interface. Each network is allocated an
78 * id when it is being created, either when reading the configuration
79 * file or when a new network is added through the control interface.
84 * priority - Priority group
86 * By default, all networks will get same priority group (0). If some
87 * of the networks are more desirable, this field can be used to change
88 * the order in which wpa_supplicant goes through the networks when
89 * selecting a BSS. The priority groups will be iterated in decreasing
90 * priority (i.e., the larger the priority value, the sooner the
91 * network is matched against the scan results). Within each priority
92 * group, networks will be selected based on security policy, signal
95 * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are
96 * not using this priority to select the order for scanning. Instead,
97 * they try the networks in the order that used in the configuration
103 * ssid - Service set identifier (network name)
105 * This is the SSID for the network. For wireless interfaces, this is
106 * used to select which network will be used. If set to %NULL (or
107 * ssid_len=0), any SSID can be used. For wired interfaces, this must
108 * be set to %NULL. Note: SSID may contain any characters, even nul
109 * (ASCII 0) and as such, this should not be assumed to be a nul
110 * terminated string. ssid_len defines how many characters are valid
111 * and the ssid field is not guaranteed to be nul terminated.
116 * ssid_len - Length of the SSID
123 * If set, this network block is used only when associating with the AP
124 * using the configured BSSID
126 * If this is a persistent P2P group (disabled == 2), this is the GO
132 * bssid_blacklist - List of inacceptable BSSIDs
135 size_t num_bssid_blacklist;
138 * bssid_blacklist - List of acceptable BSSIDs
141 size_t num_bssid_whitelist;
144 * bssid_set - Whether BSSID is configured for this network
149 * go_p2p_dev_addr - GO's P2P Device Address or all zeros if not set
151 u8 go_p2p_dev_addr[ETH_ALEN];
154 * psk - WPA pre-shared key (256 bits)
159 * psk_set - Whether PSK field is configured
164 * passphrase - WPA ASCII passphrase
166 * If this is set, psk will be generated using the SSID and passphrase
167 * configured for the network. ASCII passphrase must be between 8 and
168 * 63 characters (inclusive).
173 * ext_psk - PSK/passphrase name in external storage
175 * If this is set, PSK/passphrase will be fetched from external storage
176 * when requesting association with the network.
181 * mem_only_psk - Whether to keep PSK/passphrase only in memory
183 * 0 = allow psk/passphrase to be stored to the configuration file
184 * 1 = do not store psk/passphrase to the configuration file
189 * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
194 * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*
199 * key_mgmt - Bitfield of allowed key management protocols
206 * bg_scan_period - Background scan period in seconds, 0 to disable, or
207 * -1 to indicate no change to default driver configuration
212 * proto - Bitfield of allowed protocols, WPA_PROTO_*
217 * auth_alg - Bitfield of allowed authentication algorithms
224 * scan_ssid - Scan this SSID with Probe Requests
226 * scan_ssid can be used to scan for APs using hidden SSIDs.
227 * Note: Many drivers do not support this. ap_mode=2 can be used with
228 * such drivers to use hidden SSIDs. Note2: Most nl80211-based drivers
229 * do support scan_ssid=1 and that should be used with them instead of
234 #ifdef IEEE8021X_EAPOL
235 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0)
236 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1)
238 * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*)
243 * eap - EAP peer configuration for this network
245 struct eap_peer_config eap;
246 #endif /* IEEE8021X_EAPOL */
248 #define NUM_WEP_KEYS 4
249 #define MAX_WEP_KEY_LEN 16
253 u8 wep_key[NUM_WEP_KEYS][MAX_WEP_KEY_LEN];
256 * wep_key_len - WEP key lengths
258 size_t wep_key_len[NUM_WEP_KEYS];
261 * wep_tx_keyidx - Default key index for TX frames using WEP
266 * proactive_key_caching - Enable proactive key caching
268 * This field can be used to enable proactive key caching which is also
269 * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
270 * by default unless default value is changed with the global okc=1
271 * parameter. Enable by setting this to 1.
273 * Proactive key caching is used to make supplicant assume that the APs
274 * are using the same PMK and generate PMKSA cache entries without
275 * doing RSN pre-authentication. This requires support from the AP side
276 * and is normally used with wireless switches that co-locate the
279 * Internally, special value -1 is used to indicate that the parameter
280 * was not specified in the configuration (i.e., default behavior is
283 int proactive_key_caching;
286 * mixed_cell - Whether mixed cells are allowed
288 * This option can be used to configure whether so called mixed cells,
289 * i.e., networks that use both plaintext and encryption in the same
290 * SSID, are allowed. This is disabled (0) by default. Enable by
295 #ifdef IEEE8021X_EAPOL
298 * leap - Number of EAP methods using LEAP
300 * This field should be set to 1 if LEAP is enabled. This is used to
301 * select IEEE 802.11 authentication algorithm.
306 * non_leap - Number of EAP methods not using LEAP
308 * This field should be set to >0 if any EAP method other than LEAP is
309 * enabled. This is used to select IEEE 802.11 authentication
315 * eap_workaround - EAP workarounds enabled
317 * wpa_supplicant supports number of "EAP workarounds" to work around
318 * interoperability issues with incorrectly behaving authentication
319 * servers. This is recommended to be enabled by default because some
320 * of the issues are present in large number of authentication servers.
322 * Strict EAP conformance mode can be configured by disabling
323 * workarounds with eap_workaround = 0.
325 unsigned int eap_workaround;
327 #endif /* IEEE8021X_EAPOL */
330 * mode - IEEE 802.11 operation mode (Infrastucture/IBSS)
332 * 0 = infrastructure (Managed) mode, i.e., associate with an AP.
334 * 1 = IBSS (ad-hoc, peer-to-peer)
336 * 2 = AP (access point)
338 * 3 = P2P Group Owner (can be set in the configuration file)
340 * 4 = P2P Group Formation (used internally; not in configuration
345 * Note: IBSS can only be used with key_mgmt NONE (plaintext and static
346 * WEP) and WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE
347 * (fixed group key TKIP/CCMP) is available for backwards compatibility,
348 * but its use is deprecated. WPA-None requires following network block
349 * options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or
350 * CCMP, but not both), and psk must also be set (either directly or
351 * using ASCII passphrase).
357 WPAS_MODE_P2P_GO = 3,
358 WPAS_MODE_P2P_GROUP_FORMATION = 4,
363 * disabled - Whether this network is currently disabled
365 * 0 = this network can be used (default).
366 * 1 = this network block is disabled (can be enabled through
367 * ctrl_iface, e.g., with wpa_cli or wpa_gui).
368 * 2 = this network block includes parameters for a persistent P2P
369 * group (can be used with P2P ctrl_iface commands)
374 * disabled_for_connect - Whether this network was temporarily disabled
376 * This flag is used to reenable all the temporarily disabled networks
377 * after either the success or failure of a WPS connection.
379 int disabled_for_connect;
382 * peerkey - Whether PeerKey handshake for direct links is allowed
384 * This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are
387 * 0 = disabled (default)
393 * id_str - Network identifier string for external scripts
395 * This value is passed to external ctrl_iface monitors in
396 * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR
397 * environment variable for action scripts.
401 #ifdef CONFIG_IEEE80211W
403 * ieee80211w - Whether management frame protection is enabled
405 * This value is used to configure policy for management frame
406 * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
407 * This is disabled by default unless the default value has been changed
408 * with the global pmf=1/2 parameter.
410 * Internally, special value 3 is used to indicate that the parameter
411 * was not specified in the configuration (i.e., default behavior is
414 enum mfp_options ieee80211w;
415 #endif /* CONFIG_IEEE80211W */
418 * frequency - Channel frequency in megahertz (MHz) for IBSS
420 * This value is used to configure the initial channel for IBSS (adhoc)
421 * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in
422 * the infrastructure mode. In addition, this value is only used by the
423 * station that creates the IBSS. If an IBSS network with the
424 * configured SSID is already present, the frequency of the network
425 * will be used instead of this configured value.
430 * fixed_freq - Use fixed frequency for IBSS
435 * mesh_basic_rates - BSS Basic rate set for mesh network
438 int *mesh_basic_rates;
441 * Mesh network plink parameters
443 int dot11MeshMaxRetries;
444 int dot11MeshRetryTimeout; /* msec */
445 int dot11MeshConfirmTimeout; /* msec */
446 int dot11MeshHoldingTimeout; /* msec */
453 * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
455 * This value can be used to enforce rekeying of PTK to mitigate some
456 * attacks against TKIP deficiencies.
461 * scan_freq - Array of frequencies to scan or %NULL for all
463 * This is an optional zero-terminated array of frequencies in
464 * megahertz (MHz) to include in scan requests when searching for this
465 * network. This can be used to speed up scanning when the network is
466 * known to not use all possible channels.
471 * bgscan - Background scan and roaming parameters or %NULL if none
473 * This is an optional set of parameters for background scanning and
474 * roaming within a network (ESS) in following format:
475 * <bgscan module name>:<module parameters>
480 * ignore_broadcast_ssid - Hide SSID in AP mode
482 * Send empty SSID in beacons and ignore probe request frames that do
483 * not specify full SSID, i.e., require stations to know SSID.
484 * default: disabled (0)
485 * 1 = send empty (length=0) SSID in beacon and ignore probe request
487 * 2 = clear SSID (ASCII 0), but keep the original length (this may be
488 * required with some clients that do not support empty SSID) and
489 * ignore probe requests for broadcast SSID
491 int ignore_broadcast_ssid;
494 * freq_list - Array of allowed frequencies or %NULL for all
496 * This is an optional zero-terminated array of frequencies in
497 * megahertz (MHz) to allow for selecting the BSS. If set, scan results
498 * that do not match any of the specified frequencies are not
499 * considered when selecting a BSS.
504 * p2p_client_list - List of P2P Clients in a persistent group (GO)
506 * This is a list of P2P Clients (P2P Device Address) that have joined
507 * the persistent group. This is maintained on the GO for persistent
508 * group entries (disabled == 2).
513 * num_p2p_clients - Number of entries in p2p_client_list
515 size_t num_p2p_clients;
517 #ifndef P2P_MAX_STORED_CLIENTS
518 #define P2P_MAX_STORED_CLIENTS 100
519 #endif /* P2P_MAX_STORED_CLIENTS */
522 * psk_list - Per-client PSKs (struct psk_list_entry)
524 struct dl_list psk_list;
527 * p2p_group - Network generated as a P2P group (used internally)
532 * p2p_persistent_group - Whether this is a persistent group
534 int p2p_persistent_group;
537 * temporary - Whether this network is temporary and not to be saved
542 * export_keys - Whether keys may be exported
544 * This attribute will be set when keys are determined through
545 * WPS or similar so that they may be exported.
549 #ifdef CONFIG_HT_OVERRIDES
551 * disable_ht - Disable HT (IEEE 802.11n) for this network
553 * By default, use it if it is available, but this can be configured
554 * to 1 to have it disabled.
559 * disable_ht40 - Disable HT40 for this network
561 * By default, use it if it is available, but this can be configured
562 * to 1 to have it disabled.
567 * disable_sgi - Disable SGI (Short Guard Interval) for this network
569 * By default, use it if it is available, but this can be configured
570 * to 1 to have it disabled.
575 * disable_ldpc - Disable LDPC 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 * ht40_intolerant - Indicate 40 MHz intolerant for this network
588 * disable_max_amsdu - Disable MAX A-MSDU
590 * A-MDSU will be 3839 bytes when disabled, or 7935
591 * when enabled (assuming it is otherwise supported)
592 * -1 (default) means do not apply any settings to the kernel.
594 int disable_max_amsdu;
597 * ampdu_factor - Maximum A-MPDU Length Exponent
599 * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
604 * ampdu_density - Minimum A-MPDU Start Spacing
606 * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
611 * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
613 * By default (empty string): Use whatever the OS has configured.
616 #endif /* CONFIG_HT_OVERRIDES */
618 #ifdef CONFIG_VHT_OVERRIDES
620 * disable_vht - Disable VHT (IEEE 802.11ac) for this network
622 * By default, use it if it is available, but this can be configured
623 * to 1 to have it disabled.
628 * vht_capa - VHT capabilities to use
630 unsigned int vht_capa;
633 * vht_capa_mask - mask for VHT capabilities
635 unsigned int vht_capa_mask;
637 int vht_rx_mcs_nss_1, vht_rx_mcs_nss_2,
638 vht_rx_mcs_nss_3, vht_rx_mcs_nss_4,
639 vht_rx_mcs_nss_5, vht_rx_mcs_nss_6,
640 vht_rx_mcs_nss_7, vht_rx_mcs_nss_8;
641 int vht_tx_mcs_nss_1, vht_tx_mcs_nss_2,
642 vht_tx_mcs_nss_3, vht_tx_mcs_nss_4,
643 vht_tx_mcs_nss_5, vht_tx_mcs_nss_6,
644 vht_tx_mcs_nss_7, vht_tx_mcs_nss_8;
645 #endif /* CONFIG_VHT_OVERRIDES */
648 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
650 * This timeout value is used in AP mode to clean up inactive stations.
651 * By default: 300 seconds.
653 int ap_max_inactivity;
656 * dtim_period - DTIM period in Beacon intervals
662 * beacon_int - Beacon interval (default: 100 TU)
667 * auth_failures - Number of consecutive authentication failures
669 unsigned int auth_failures;
672 * disabled_until - Network block disabled until this time if non-zero
674 struct os_reltime disabled_until;
677 * parent_cred - Pointer to parent wpa_cred entry
679 * This pointer can be used to delete temporary networks when a wpa_cred
680 * that was used to create them is removed. This pointer should not be
681 * dereferences since it may not be updated in all cases.
687 * macsec_policy - Determines the policy for MACsec secure session
689 * 0: MACsec not in use (default)
690 * 1: MACsec enabled - Should secure, accept key server's advice to
691 * determine whether to use a secure session or not.
694 #endif /* CONFIG_MACSEC */
697 int update_identifier;
698 #endif /* CONFIG_HS20 */
700 unsigned int wps_run;
703 * mac_addr - MAC address policy
705 * 0 = use permanent MAC address
706 * 1 = use random MAC address for each ESS connection
707 * 2 = like 1, but maintain OUI (with local admin bit set)
709 * Internally, special value -1 is used to indicate that the parameter
710 * was not specified in the configuration (i.e., default behavior is
716 * no_auto_peer - Do not automatically peer with compatible mesh peers
718 * When unset, the reception of a beacon from a another mesh peer in
719 * this MBSS will trigger a peering attempt.
724 #endif /* CONFIG_SSID_H */