2 * WPA Supplicant - Common definitions
3 * Copyright (c) 2004-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.
18 typedef enum { FALSE = 0, TRUE = 1 } Boolean;
21 #define WPA_CIPHER_NONE BIT(0)
22 #define WPA_CIPHER_WEP40 BIT(1)
23 #define WPA_CIPHER_WEP104 BIT(2)
24 #define WPA_CIPHER_TKIP BIT(3)
25 #define WPA_CIPHER_CCMP BIT(4)
26 #define WPA_CIPHER_AES_128_CMAC BIT(5)
27 #define WPA_CIPHER_GCMP BIT(6)
28 #define WPA_CIPHER_SMS4 BIT(7)
29 #define WPA_CIPHER_GCMP_256 BIT(8)
30 #define WPA_CIPHER_CCMP_256 BIT(9)
31 #define WPA_CIPHER_BIP_GMAC_128 BIT(11)
32 #define WPA_CIPHER_BIP_GMAC_256 BIT(12)
33 #define WPA_CIPHER_BIP_CMAC_256 BIT(13)
34 #define WPA_CIPHER_GTK_NOT_USED BIT(14)
36 #define WPA_KEY_MGMT_IEEE8021X BIT(0)
37 #define WPA_KEY_MGMT_PSK BIT(1)
38 #define WPA_KEY_MGMT_NONE BIT(2)
39 #define WPA_KEY_MGMT_IEEE8021X_NO_WPA BIT(3)
40 #define WPA_KEY_MGMT_WPA_NONE BIT(4)
41 #define WPA_KEY_MGMT_FT_IEEE8021X BIT(5)
42 #define WPA_KEY_MGMT_FT_PSK BIT(6)
43 #define WPA_KEY_MGMT_IEEE8021X_SHA256 BIT(7)
44 #define WPA_KEY_MGMT_PSK_SHA256 BIT(8)
45 #define WPA_KEY_MGMT_WPS BIT(9)
46 #define WPA_KEY_MGMT_SAE BIT(10)
47 #define WPA_KEY_MGMT_FT_SAE BIT(11)
48 #define WPA_KEY_MGMT_WAPI_PSK BIT(12)
49 #define WPA_KEY_MGMT_WAPI_CERT BIT(13)
50 #define WPA_KEY_MGMT_CCKM BIT(14)
52 static inline int wpa_key_mgmt_wpa_ieee8021x(int akm)
54 return !!(akm & (WPA_KEY_MGMT_IEEE8021X |
55 WPA_KEY_MGMT_FT_IEEE8021X |
57 WPA_KEY_MGMT_IEEE8021X_SHA256));
60 static inline int wpa_key_mgmt_wpa_psk(int akm)
62 return !!(akm & (WPA_KEY_MGMT_PSK |
64 WPA_KEY_MGMT_PSK_SHA256 |
66 WPA_KEY_MGMT_FT_SAE));
69 static inline int wpa_key_mgmt_ft(int akm)
71 return !!(akm & (WPA_KEY_MGMT_FT_PSK |
72 WPA_KEY_MGMT_FT_IEEE8021X |
73 WPA_KEY_MGMT_FT_SAE));
76 static inline int wpa_key_mgmt_sae(int akm)
78 return !!(akm & (WPA_KEY_MGMT_SAE |
79 WPA_KEY_MGMT_FT_SAE));
82 static inline int wpa_key_mgmt_sha256(int akm)
84 return !!(akm & (WPA_KEY_MGMT_PSK_SHA256 |
85 WPA_KEY_MGMT_IEEE8021X_SHA256));
88 static inline int wpa_key_mgmt_wpa(int akm)
90 return wpa_key_mgmt_wpa_ieee8021x(akm) ||
91 wpa_key_mgmt_wpa_psk(akm) ||
92 wpa_key_mgmt_sae(akm);
95 static inline int wpa_key_mgmt_wpa_any(int akm)
97 return wpa_key_mgmt_wpa(akm) || (akm & WPA_KEY_MGMT_WPA_NONE);
100 static inline int wpa_key_mgmt_cckm(int akm)
102 return akm == WPA_KEY_MGMT_CCKM;
106 #define WPA_PROTO_WPA BIT(0)
107 #define WPA_PROTO_RSN BIT(1)
108 #define WPA_PROTO_WAPI BIT(2)
110 #define WPA_AUTH_ALG_OPEN BIT(0)
111 #define WPA_AUTH_ALG_SHARED BIT(1)
112 #define WPA_AUTH_ALG_LEAP BIT(2)
113 #define WPA_AUTH_ALG_FT BIT(3)
114 #define WPA_AUTH_ALG_SAE BIT(4)
129 WPA_ALG_BIP_GMAC_128,
130 WPA_ALG_BIP_GMAC_256,
135 * enum wpa_states - wpa_supplicant state
137 * These enumeration values are used to indicate the current wpa_supplicant
138 * state (wpa_s->wpa_state). The current state can be retrieved with
139 * wpa_supplicant_get_state() function and the state can be changed by calling
140 * wpa_supplicant_set_state(). In WPA state machine (wpa.c and preauth.c), the
141 * wrapper functions wpa_sm_get_state() and wpa_sm_set_state() should be used
142 * to access the state variable.
146 * WPA_DISCONNECTED - Disconnected state
148 * This state indicates that client is not associated, but is likely to
149 * start looking for an access point. This state is entered when a
150 * connection is lost.
155 * WPA_INTERFACE_DISABLED - Interface disabled
157 * This stat eis entered if the network interface is disabled, e.g.,
158 * due to rfkill. wpa_supplicant refuses any new operations that would
159 * use the radio until the interface has been enabled.
161 WPA_INTERFACE_DISABLED,
164 * WPA_INACTIVE - Inactive state (wpa_supplicant disabled)
166 * This state is entered if there are no enabled networks in the
167 * configuration. wpa_supplicant is not trying to associate with a new
168 * network and external interaction (e.g., ctrl_iface call to add or
169 * enable a network) is needed to start association.
174 * WPA_SCANNING - Scanning for a network
176 * This state is entered when wpa_supplicant starts scanning for a
182 * WPA_AUTHENTICATING - Trying to authenticate with a BSS/SSID
184 * This state is entered when wpa_supplicant has found a suitable BSS
185 * to authenticate with and the driver is configured to try to
186 * authenticate with this BSS. This state is used only with drivers
187 * that use wpa_supplicant as the SME.
192 * WPA_ASSOCIATING - Trying to associate with a BSS/SSID
194 * This state is entered when wpa_supplicant has found a suitable BSS
195 * to associate with and the driver is configured to try to associate
196 * with this BSS in ap_scan=1 mode. When using ap_scan=2 mode, this
197 * state is entered when the driver is configured to try to associate
198 * with a network using the configured SSID and security policy.
203 * WPA_ASSOCIATED - Association completed
205 * This state is entered when the driver reports that association has
206 * been successfully completed with an AP. If IEEE 802.1X is used
207 * (with or without WPA/WPA2), wpa_supplicant remains in this state
208 * until the IEEE 802.1X/EAPOL authentication has been completed.
213 * WPA_4WAY_HANDSHAKE - WPA 4-Way Key Handshake in progress
215 * This state is entered when WPA/WPA2 4-Way Handshake is started. In
216 * case of WPA-PSK, this happens when receiving the first EAPOL-Key
217 * frame after association. In case of WPA-EAP, this state is entered
218 * when the IEEE 802.1X/EAPOL authentication has been completed.
223 * WPA_GROUP_HANDSHAKE - WPA Group Key Handshake in progress
225 * This state is entered when 4-Way Key Handshake has been completed
226 * (i.e., when the supplicant sends out message 4/4) and when Group
227 * Key rekeying is started by the AP (i.e., when supplicant receives
233 * WPA_COMPLETED - All authentication completed
235 * This state is entered when the full authentication process is
236 * completed. In case of WPA2, this happens when the 4-Way Handshake is
237 * successfully completed. With WPA, this state is entered after the
238 * Group Key Handshake; with IEEE 802.1X (non-WPA) connection is
239 * completed after dynamic keys are received (or if not used, after
240 * the EAP authentication has been completed). With static WEP keys and
241 * plaintext connections, this state is entered when an association
242 * has been completed.
244 * This state indicates that the supplicant has completed its
245 * processing for the association phase and that data connection is
251 #define MLME_SETPROTECTION_PROTECT_TYPE_NONE 0
252 #define MLME_SETPROTECTION_PROTECT_TYPE_RX 1
253 #define MLME_SETPROTECTION_PROTECT_TYPE_TX 2
254 #define MLME_SETPROTECTION_PROTECT_TYPE_RX_TX 3
256 #define MLME_SETPROTECTION_KEY_TYPE_GROUP 0
257 #define MLME_SETPROTECTION_KEY_TYPE_PAIRWISE 1
261 * enum mfp_options - Management frame protection (IEEE 802.11w) options
264 NO_MGMT_FRAME_PROTECTION = 0,
265 MGMT_FRAME_PROTECTION_OPTIONAL = 1,
266 MGMT_FRAME_PROTECTION_REQUIRED = 2,
268 #define MGMT_FRAME_PROTECTION_DEFAULT 3
271 * enum hostapd_hw_mode - Hardware mode
273 enum hostapd_hw_mode {
274 HOSTAPD_MODE_IEEE80211B,
275 HOSTAPD_MODE_IEEE80211G,
276 HOSTAPD_MODE_IEEE80211A,
277 HOSTAPD_MODE_IEEE80211AD,
282 * enum wpa_ctrl_req_type - Control interface request types
284 enum wpa_ctrl_req_type {
285 WPA_CTRL_REQ_UNKNOWN,
286 WPA_CTRL_REQ_EAP_IDENTITY,
287 WPA_CTRL_REQ_EAP_PASSWORD,
288 WPA_CTRL_REQ_EAP_NEW_PASSWORD,
289 WPA_CTRL_REQ_EAP_PIN,
290 WPA_CTRL_REQ_EAP_OTP,
291 WPA_CTRL_REQ_EAP_PASSPHRASE,
296 /* Maximum number of EAP methods to store for EAP server user information */
297 #define EAP_MAX_METHODS 8