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_MESH_RSSI_THRESHOLD 1 /* no change */
32 #define DEFAULT_DISABLE_HT 0
33 #define DEFAULT_DISABLE_HT40 0
34 #define DEFAULT_DISABLE_SGI 0
35 #define DEFAULT_DISABLE_LDPC 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 #define DEFAULT_USER_SELECTED_SIM 1
41 struct psk_list_entry
{
49 * struct wpa_ssid - Network configuration data
51 * This structure includes all the configuration variables for a network. This
52 * data is included in the per-interface configuration data as an element of
53 * the network list, struct wpa_config::ssid. Each network block in the
54 * configuration is mapped to a struct wpa_ssid instance.
58 * next - Next network in global list
60 * This pointer can be used to iterate over all networks. The head of
61 * this list is stored in the ssid field of struct wpa_config.
63 struct wpa_ssid
*next
;
66 * pnext - Next network in per-priority list
68 * This pointer can be used to iterate over all networks in the same
69 * priority class. The heads of these list are stored in the pssid
70 * fields of struct wpa_config.
72 struct wpa_ssid
*pnext
;
75 * id - Unique id for the network
77 * This identifier is used as a unique identifier for each network
78 * block when using the control interface. Each network is allocated an
79 * id when it is being created, either when reading the configuration
80 * file or when a new network is added through the control interface.
85 * priority - Priority group
87 * By default, all networks will get same priority group (0). If some
88 * of the networks are more desirable, this field can be used to change
89 * the order in which wpa_supplicant goes through the networks when
90 * selecting a BSS. The priority groups will be iterated in decreasing
91 * priority (i.e., the larger the priority value, the sooner the
92 * network is matched against the scan results). Within each priority
93 * group, networks will be selected based on security policy, signal
96 * Please note that AP scanning with scan_ssid=1 and ap_scan=2 mode are
97 * not using this priority to select the order for scanning. Instead,
98 * they try the networks in the order that used in the configuration
104 * ssid - Service set identifier (network name)
106 * This is the SSID for the network. For wireless interfaces, this is
107 * used to select which network will be used. If set to %NULL (or
108 * ssid_len=0), any SSID can be used. For wired interfaces, this must
109 * be set to %NULL. Note: SSID may contain any characters, even nul
110 * (ASCII 0) and as such, this should not be assumed to be a nul
111 * terminated string. ssid_len defines how many characters are valid
112 * and the ssid field is not guaranteed to be nul terminated.
117 * ssid_len - Length of the SSID
124 * If set, this network block is used only when associating with the AP
125 * using the configured BSSID
127 * If this is a persistent P2P group (disabled == 2), this is the GO
133 * bssid_blacklist - List of inacceptable BSSIDs
136 size_t num_bssid_blacklist
;
139 * bssid_blacklist - List of acceptable BSSIDs
142 size_t num_bssid_whitelist
;
145 * bssid_set - Whether BSSID is configured for this network
150 * bssid_hint - BSSID hint
152 * If set, this is configured to the driver as a preferred initial BSSID
153 * while connecting to this network.
155 u8 bssid_hint
[ETH_ALEN
];
158 * bssid_hint_set - Whether BSSID hint is configured for this network
163 * go_p2p_dev_addr - GO's P2P Device Address or all zeros if not set
165 u8 go_p2p_dev_addr
[ETH_ALEN
];
168 * psk - WPA pre-shared key (256 bits)
173 * psk_set - Whether PSK field is configured
178 * passphrase - WPA ASCII passphrase
180 * If this is set, psk will be generated using the SSID and passphrase
181 * configured for the network. ASCII passphrase must be between 8 and
182 * 63 characters (inclusive).
187 * ext_psk - PSK/passphrase name in external storage
189 * If this is set, PSK/passphrase will be fetched from external storage
190 * when requesting association with the network.
195 * mem_only_psk - Whether to keep PSK/passphrase only in memory
197 * 0 = allow psk/passphrase to be stored to the configuration file
198 * 1 = do not store psk/passphrase to the configuration file
203 * pairwise_cipher - Bitfield of allowed pairwise ciphers, WPA_CIPHER_*
208 * group_cipher - Bitfield of allowed group ciphers, WPA_CIPHER_*
213 * group_mgmt_cipher - Bitfield of allowed group management ciphers
215 * This is a bitfield of WPA_CIPHER_AES_128_CMAC and WPA_CIPHER_BIP_*
216 * values. If 0, no constraint is used for the cipher, i.e., whatever
217 * the AP uses is accepted.
219 int group_mgmt_cipher
;
222 * key_mgmt - Bitfield of allowed key management protocols
229 * bg_scan_period - Background scan period in seconds, 0 to disable, or
230 * -1 to indicate no change to default driver configuration
235 * proto - Bitfield of allowed protocols, WPA_PROTO_*
240 * auth_alg - Bitfield of allowed authentication algorithms
247 * scan_ssid - Scan this SSID with Probe Requests
249 * scan_ssid can be used to scan for APs using hidden SSIDs.
250 * Note: Many drivers do not support this. ap_mode=2 can be used with
251 * such drivers to use hidden SSIDs. Note2: Most nl80211-based drivers
252 * do support scan_ssid=1 and that should be used with them instead of
257 #ifdef IEEE8021X_EAPOL
258 #define EAPOL_FLAG_REQUIRE_KEY_UNICAST BIT(0)
259 #define EAPOL_FLAG_REQUIRE_KEY_BROADCAST BIT(1)
261 * eapol_flags - Bit field of IEEE 802.1X/EAPOL options (EAPOL_FLAG_*)
266 * eap - EAP peer configuration for this network
268 struct eap_peer_config eap
;
269 #endif /* IEEE8021X_EAPOL */
271 #define NUM_WEP_KEYS 4
272 #define MAX_WEP_KEY_LEN 16
276 u8 wep_key
[NUM_WEP_KEYS
][MAX_WEP_KEY_LEN
];
279 * wep_key_len - WEP key lengths
281 size_t wep_key_len
[NUM_WEP_KEYS
];
284 * wep_tx_keyidx - Default key index for TX frames using WEP
289 * proactive_key_caching - Enable proactive key caching
291 * This field can be used to enable proactive key caching which is also
292 * known as opportunistic PMKSA caching for WPA2. This is disabled (0)
293 * by default unless default value is changed with the global okc=1
294 * parameter. Enable by setting this to 1.
296 * Proactive key caching is used to make supplicant assume that the APs
297 * are using the same PMK and generate PMKSA cache entries without
298 * doing RSN pre-authentication. This requires support from the AP side
299 * and is normally used with wireless switches that co-locate the
302 * Internally, special value -1 is used to indicate that the parameter
303 * was not specified in the configuration (i.e., default behavior is
306 int proactive_key_caching
;
309 * mixed_cell - Whether mixed cells are allowed
311 * This option can be used to configure whether so called mixed cells,
312 * i.e., networks that use both plaintext and encryption in the same
313 * SSID, are allowed. This is disabled (0) by default. Enable by
318 #ifdef IEEE8021X_EAPOL
321 * leap - Number of EAP methods using LEAP
323 * This field should be set to 1 if LEAP is enabled. This is used to
324 * select IEEE 802.11 authentication algorithm.
329 * non_leap - Number of EAP methods not using LEAP
331 * This field should be set to >0 if any EAP method other than LEAP is
332 * enabled. This is used to select IEEE 802.11 authentication
338 * eap_workaround - EAP workarounds enabled
340 * wpa_supplicant supports number of "EAP workarounds" to work around
341 * interoperability issues with incorrectly behaving authentication
342 * servers. This is recommended to be enabled by default because some
343 * of the issues are present in large number of authentication servers.
345 * Strict EAP conformance mode can be configured by disabling
346 * workarounds with eap_workaround = 0.
348 unsigned int eap_workaround
;
350 #endif /* IEEE8021X_EAPOL */
353 * mode - IEEE 802.11 operation mode (Infrastucture/IBSS)
355 * 0 = infrastructure (Managed) mode, i.e., associate with an AP.
357 * 1 = IBSS (ad-hoc, peer-to-peer)
359 * 2 = AP (access point)
361 * 3 = P2P Group Owner (can be set in the configuration file)
363 * 4 = P2P Group Formation (used internally; not in configuration
368 * Note: IBSS can only be used with key_mgmt NONE (plaintext and static
369 * WEP) and WPA-PSK (with proto=RSN). In addition, key_mgmt=WPA-NONE
370 * (fixed group key TKIP/CCMP) is available for backwards compatibility,
371 * but its use is deprecated. WPA-None requires following network block
372 * options: proto=WPA, key_mgmt=WPA-NONE, pairwise=NONE, group=TKIP (or
373 * CCMP, but not both), and psk must also be set (either directly or
374 * using ASCII passphrase).
380 WPAS_MODE_P2P_GO
= 3,
381 WPAS_MODE_P2P_GROUP_FORMATION
= 4,
386 * pbss - Whether to use PBSS. Relevant to DMG networks only.
387 * 0 = do not use PBSS
389 * 2 = don't care (not allowed in AP mode)
390 * Used together with mode configuration. When mode is AP, it
391 * means to start a PCP instead of a regular AP. When mode is INFRA it
392 * means connect to a PCP instead of AP. In this mode you can also
393 * specify 2 (don't care) meaning connect to either AP or PCP.
394 * P2P_GO and P2P_GROUP_FORMATION modes must use PBSS in DMG network.
399 * disabled - Whether this network is currently disabled
401 * 0 = this network can be used (default).
402 * 1 = this network block is disabled (can be enabled through
403 * ctrl_iface, e.g., with wpa_cli or wpa_gui).
404 * 2 = this network block includes parameters for a persistent P2P
405 * group (can be used with P2P ctrl_iface commands)
410 * disabled_for_connect - Whether this network was temporarily disabled
412 * This flag is used to reenable all the temporarily disabled networks
413 * after either the success or failure of a WPS connection.
415 int disabled_for_connect
;
418 * peerkey - Whether PeerKey handshake for direct links is allowed
420 * This is only used when both RSN/WPA2 and IEEE 802.11e (QoS) are
423 * 0 = disabled (default)
429 * id_str - Network identifier string for external scripts
431 * This value is passed to external ctrl_iface monitors in
432 * WPA_EVENT_CONNECTED event and wpa_cli sets this as WPA_ID_STR
433 * environment variable for action scripts.
437 #ifdef CONFIG_IEEE80211W
439 * ieee80211w - Whether management frame protection is enabled
441 * This value is used to configure policy for management frame
442 * protection (IEEE 802.11w). 0 = disabled, 1 = optional, 2 = required.
443 * This is disabled by default unless the default value has been changed
444 * with the global pmf=1/2 parameter.
446 * Internally, special value 3 is used to indicate that the parameter
447 * was not specified in the configuration (i.e., default behavior is
450 enum mfp_options ieee80211w
;
451 #endif /* CONFIG_IEEE80211W */
454 * frequency - Channel frequency in megahertz (MHz) for IBSS
456 * This value is used to configure the initial channel for IBSS (adhoc)
457 * networks, e.g., 2412 = IEEE 802.11b/g channel 1. It is ignored in
458 * the infrastructure mode. In addition, this value is only used by the
459 * station that creates the IBSS. If an IBSS network with the
460 * configured SSID is already present, the frequency of the network
461 * will be used instead of this configured value.
466 * fixed_freq - Use fixed frequency for IBSS
472 * ACS - Automatic Channel Selection for AP mode
474 * If present, it will be handled together with frequency.
475 * frequency will be used to determine hardware mode only, when it is
476 * used for both hardware mode and channel when used alone. This will
477 * force the channel to be set to 0, thus enabling ACS.
480 #endif /* CONFIG_ACS */
483 * mesh_basic_rates - BSS Basic rate set for mesh network
486 int *mesh_basic_rates
;
489 * Mesh network plink parameters
491 int dot11MeshMaxRetries
;
492 int dot11MeshRetryTimeout
; /* msec */
493 int dot11MeshConfirmTimeout
; /* msec */
494 int dot11MeshHoldingTimeout
; /* msec */
503 unsigned int vht_center_freq1
;
504 unsigned int vht_center_freq2
;
507 * wpa_ptk_rekey - Maximum lifetime for PTK in seconds
509 * This value can be used to enforce rekeying of PTK to mitigate some
510 * attacks against TKIP deficiencies.
515 * group_rekey - Group rekeying time in seconds
517 * This value, if non-zero, is used as the dot11RSNAConfigGroupRekeyTime
518 * parameter when operating in Authenticator role in IBSS.
523 * scan_freq - Array of frequencies to scan or %NULL for all
525 * This is an optional zero-terminated array of frequencies in
526 * megahertz (MHz) to include in scan requests when searching for this
527 * network. This can be used to speed up scanning when the network is
528 * known to not use all possible channels.
533 * bgscan - Background scan and roaming parameters or %NULL if none
535 * This is an optional set of parameters for background scanning and
536 * roaming within a network (ESS) in following format:
537 * <bgscan module name>:<module parameters>
542 * ignore_broadcast_ssid - Hide SSID in AP mode
544 * Send empty SSID in beacons and ignore probe request frames that do
545 * not specify full SSID, i.e., require stations to know SSID.
546 * default: disabled (0)
547 * 1 = send empty (length=0) SSID in beacon and ignore probe request
549 * 2 = clear SSID (ASCII 0), but keep the original length (this may be
550 * required with some clients that do not support empty SSID) and
551 * ignore probe requests for broadcast SSID
553 int ignore_broadcast_ssid
;
556 * freq_list - Array of allowed frequencies or %NULL for all
558 * This is an optional zero-terminated array of frequencies in
559 * megahertz (MHz) to allow for selecting the BSS. If set, scan results
560 * that do not match any of the specified frequencies are not
561 * considered when selecting a BSS.
566 * p2p_client_list - List of P2P Clients in a persistent group (GO)
568 * This is a list of P2P Clients (P2P Device Address) that have joined
569 * the persistent group. This is maintained on the GO for persistent
570 * group entries (disabled == 2).
575 * num_p2p_clients - Number of entries in p2p_client_list
577 size_t num_p2p_clients
;
579 #ifndef P2P_MAX_STORED_CLIENTS
580 #define P2P_MAX_STORED_CLIENTS 100
581 #endif /* P2P_MAX_STORED_CLIENTS */
584 * psk_list - Per-client PSKs (struct psk_list_entry)
586 struct dl_list psk_list
;
589 * p2p_group - Network generated as a P2P group (used internally)
594 * p2p_persistent_group - Whether this is a persistent group
596 int p2p_persistent_group
;
599 * temporary - Whether this network is temporary and not to be saved
604 * export_keys - Whether keys may be exported
606 * This attribute will be set when keys are determined through
607 * WPS or similar so that they may be exported.
611 #ifdef CONFIG_HT_OVERRIDES
613 * disable_ht - Disable HT (IEEE 802.11n) for this network
615 * By default, use it if it is available, but this can be configured
616 * to 1 to have it disabled.
621 * disable_ht40 - Disable HT40 for this network
623 * By default, use it if it is available, but this can be configured
624 * to 1 to have it disabled.
629 * disable_sgi - Disable SGI (Short Guard Interval) for this network
631 * By default, use it if it is available, but this can be configured
632 * to 1 to have it disabled.
637 * disable_ldpc - Disable LDPC for this network
639 * By default, use it if it is available, but this can be configured
640 * to 1 to have it disabled.
645 * ht40_intolerant - Indicate 40 MHz intolerant for this network
650 * disable_max_amsdu - Disable MAX A-MSDU
652 * A-MDSU will be 3839 bytes when disabled, or 7935
653 * when enabled (assuming it is otherwise supported)
654 * -1 (default) means do not apply any settings to the kernel.
656 int disable_max_amsdu
;
659 * ampdu_factor - Maximum A-MPDU Length Exponent
661 * Value: 0-3, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
666 * ampdu_density - Minimum A-MPDU Start Spacing
668 * Value: 0-7, see 7.3.2.56.3 in IEEE Std 802.11n-2009.
673 * ht_mcs - Allowed HT-MCS rates, in ASCII hex: ffff0000...
675 * By default (empty string): Use whatever the OS has configured.
678 #endif /* CONFIG_HT_OVERRIDES */
680 #ifdef CONFIG_VHT_OVERRIDES
682 * disable_vht - Disable VHT (IEEE 802.11ac) for this network
684 * By default, use it if it is available, but this can be configured
685 * to 1 to have it disabled.
690 * vht_capa - VHT capabilities to use
692 unsigned int vht_capa
;
695 * vht_capa_mask - mask for VHT capabilities
697 unsigned int vht_capa_mask
;
699 int vht_rx_mcs_nss_1
, vht_rx_mcs_nss_2
,
700 vht_rx_mcs_nss_3
, vht_rx_mcs_nss_4
,
701 vht_rx_mcs_nss_5
, vht_rx_mcs_nss_6
,
702 vht_rx_mcs_nss_7
, vht_rx_mcs_nss_8
;
703 int vht_tx_mcs_nss_1
, vht_tx_mcs_nss_2
,
704 vht_tx_mcs_nss_3
, vht_tx_mcs_nss_4
,
705 vht_tx_mcs_nss_5
, vht_tx_mcs_nss_6
,
706 vht_tx_mcs_nss_7
, vht_tx_mcs_nss_8
;
707 #endif /* CONFIG_VHT_OVERRIDES */
710 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
712 * This timeout value is used in AP mode to clean up inactive stations.
713 * By default: 300 seconds.
715 int ap_max_inactivity
;
718 * dtim_period - DTIM period in Beacon intervals
724 * beacon_int - Beacon interval (default: 100 TU)
729 * auth_failures - Number of consecutive authentication failures
731 unsigned int auth_failures
;
734 * disabled_until - Network block disabled until this time if non-zero
736 struct os_reltime disabled_until
;
739 * parent_cred - Pointer to parent wpa_cred entry
741 * This pointer can be used to delete temporary networks when a wpa_cred
742 * that was used to create them is removed. This pointer should not be
743 * dereferences since it may not be updated in all cases.
749 * macsec_policy - Determines the policy for MACsec secure session
751 * 0: MACsec not in use (default)
752 * 1: MACsec enabled - Should secure, accept key server's advice to
753 * determine whether to use a secure session or not.
758 * macsec_integ_only - Determines how MACsec are transmitted
760 * This setting applies only when MACsec is in use, i.e.,
761 * - macsec_policy is enabled
762 * - the key server has decided to enable MACsec
764 * 0: Encrypt traffic (default)
767 int macsec_integ_only
;
770 * macsec_port - MACsec port (in SCI)
772 * Port component of the SCI.
774 * Range: 1-65534 (default: 1)
779 * mka_priority - Priority of MKA Actor
781 * Range: 0-255 (default: 255)
786 * mka_ckn - MKA pre-shared CKN
788 #define MACSEC_CKN_LEN 32
789 u8 mka_ckn
[MACSEC_CKN_LEN
];
792 * mka_cak - MKA pre-shared CAK
794 #define MACSEC_CAK_LEN 16
795 u8 mka_cak
[MACSEC_CAK_LEN
];
797 #define MKA_PSK_SET_CKN BIT(0)
798 #define MKA_PSK_SET_CAK BIT(1)
799 #define MKA_PSK_SET (MKA_PSK_SET_CKN | MKA_PSK_SET_CAK)
801 * mka_psk_set - Whether mka_ckn and mka_cak are set
804 #endif /* CONFIG_MACSEC */
807 int update_identifier
;
808 #endif /* CONFIG_HS20 */
810 unsigned int wps_run
;
813 * mac_addr - MAC address policy
815 * 0 = use permanent MAC address
816 * 1 = use random MAC address for each ESS connection
817 * 2 = like 1, but maintain OUI (with local admin bit set)
819 * Internally, special value -1 is used to indicate that the parameter
820 * was not specified in the configuration (i.e., default behavior is
826 * no_auto_peer - Do not automatically peer with compatible mesh peers
828 * When unset, the reception of a beacon from a another mesh peer in
829 * this MBSS will trigger a peering attempt.
834 * mesh_rssi_threshold - Set mesh parameter mesh_rssi_threshold (dBm)
836 * -255..-1 = threshold value in dBm
837 * 0 = not using RSSI threshold
838 * 1 = do not change driver default
840 int mesh_rssi_threshold
;
843 * wps_disabled - WPS disabled in AP mode
845 * 0 = WPS enabled and configured (default)
851 * fils_dh_group - FILS DH Group
853 * 0 = PFS disabled with FILS shared key authentication
854 * 1-65535 DH Group to use for FILS PFS
859 * dpp_connector - DPP Connector (signedConnector as string)
864 * dpp_netaccesskey - DPP netAccessKey (own private key)
866 u8
*dpp_netaccesskey
;
869 * dpp_netaccesskey_len - DPP netAccessKey length in octets
871 size_t dpp_netaccesskey_len
;
874 * net_access_key_expiry - DPP netAccessKey expiry in UNIX time stamp
876 * 0 indicates no expiration.
878 unsigned int dpp_netaccesskey_expiry
;
881 * dpp_csign - C-sign-key (Configurator public key)
886 * dpp_csign_len - C-sign-key length in octets
888 size_t dpp_csign_len
;
891 * owe_group - OWE DH Group
893 * 0 = use default (19)
894 * 1-65535 DH Group to use for OWE
896 * Groups 19 (NIST P-256), 20 (NIST P-384), and 21 (NIST P-521) are
897 * currently supported.
902 #endif /* CONFIG_SSID_H */