1 /*
2 * WPA Supplicant - Common definitions
3 * Copyright (c) 2004-2015, Jouni Malinen <j@w1.fi>
4 *
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
7 */
8
9 #ifndef DEFS_H
10 #define DEFS_H
11
12 #ifdef FALSE
13 #undef FALSE
14 #endif
15 #ifdef TRUE
16 #undef TRUE
17 #endif
18 typedef enum { FALSE = 0, TRUE = 1 } Boolean;
19
20
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)
35
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)
51 #define WPA_KEY_MGMT_OSEN BIT(15)
52 #define WPA_KEY_MGMT_IEEE8021X_SUITE_B BIT(16)
53 #define WPA_KEY_MGMT_IEEE8021X_SUITE_B_192 BIT(17)
54 #define WPA_KEY_MGMT_FILS_SHA256 BIT(18)
55 #define WPA_KEY_MGMT_FILS_SHA384 BIT(19)
56 #define WPA_KEY_MGMT_FT_FILS_SHA256 BIT(20)
57 #define WPA_KEY_MGMT_FT_FILS_SHA384 BIT(21)
58
wpa_key_mgmt_wpa_ieee8021x(int akm)59 static inline int wpa_key_mgmt_wpa_ieee8021x(int akm)
60 {
61 return !!(akm & (WPA_KEY_MGMT_IEEE8021X |
62 WPA_KEY_MGMT_FT_IEEE8021X |
63 WPA_KEY_MGMT_CCKM |
64 WPA_KEY_MGMT_OSEN |
65 WPA_KEY_MGMT_IEEE8021X_SHA256 |
66 WPA_KEY_MGMT_IEEE8021X_SUITE_B |
67 WPA_KEY_MGMT_IEEE8021X_SUITE_B_192 |
68 WPA_KEY_MGMT_FILS_SHA256 |
69 WPA_KEY_MGMT_FILS_SHA384 |
70 WPA_KEY_MGMT_FT_FILS_SHA256 |
71 WPA_KEY_MGMT_FT_FILS_SHA384));
72 }
73
wpa_key_mgmt_wpa_psk(int akm)74 static inline int wpa_key_mgmt_wpa_psk(int akm)
75 {
76 return !!(akm & (WPA_KEY_MGMT_PSK |
77 WPA_KEY_MGMT_FT_PSK |
78 WPA_KEY_MGMT_PSK_SHA256 |
79 WPA_KEY_MGMT_SAE |
80 WPA_KEY_MGMT_FT_SAE));
81 }
82
wpa_key_mgmt_ft(int akm)83 static inline int wpa_key_mgmt_ft(int akm)
84 {
85 return !!(akm & (WPA_KEY_MGMT_FT_PSK |
86 WPA_KEY_MGMT_FT_IEEE8021X |
87 WPA_KEY_MGMT_FT_SAE |
88 WPA_KEY_MGMT_FT_FILS_SHA256 |
89 WPA_KEY_MGMT_FT_FILS_SHA384));
90 }
91
wpa_key_mgmt_ft_psk(int akm)92 static inline int wpa_key_mgmt_ft_psk(int akm)
93 {
94 return !!(akm & WPA_KEY_MGMT_FT_PSK);
95 }
96
wpa_key_mgmt_sae(int akm)97 static inline int wpa_key_mgmt_sae(int akm)
98 {
99 return !!(akm & (WPA_KEY_MGMT_SAE |
100 WPA_KEY_MGMT_FT_SAE));
101 }
102
wpa_key_mgmt_fils(int akm)103 static inline int wpa_key_mgmt_fils(int akm)
104 {
105 return !!(akm & (WPA_KEY_MGMT_FILS_SHA256 |
106 WPA_KEY_MGMT_FILS_SHA384 |
107 WPA_KEY_MGMT_FT_FILS_SHA256 |
108 WPA_KEY_MGMT_FT_FILS_SHA384));
109 }
110
wpa_key_mgmt_sha256(int akm)111 static inline int wpa_key_mgmt_sha256(int akm)
112 {
113 return !!(akm & (WPA_KEY_MGMT_PSK_SHA256 |
114 WPA_KEY_MGMT_IEEE8021X_SHA256 |
115 WPA_KEY_MGMT_OSEN |
116 WPA_KEY_MGMT_IEEE8021X_SUITE_B |
117 WPA_KEY_MGMT_FILS_SHA256 |
118 WPA_KEY_MGMT_FT_FILS_SHA256));
119 }
120
wpa_key_mgmt_sha384(int akm)121 static inline int wpa_key_mgmt_sha384(int akm)
122 {
123 return !!(akm & (WPA_KEY_MGMT_IEEE8021X_SUITE_B_192 |
124 WPA_KEY_MGMT_FILS_SHA384 |
125 WPA_KEY_MGMT_FT_FILS_SHA384));
126 }
127
wpa_key_mgmt_suite_b(int akm)128 static inline int wpa_key_mgmt_suite_b(int akm)
129 {
130 return !!(akm & (WPA_KEY_MGMT_IEEE8021X_SUITE_B |
131 WPA_KEY_MGMT_IEEE8021X_SUITE_B_192));
132 }
133
wpa_key_mgmt_wpa(int akm)134 static inline int wpa_key_mgmt_wpa(int akm)
135 {
136 return wpa_key_mgmt_wpa_ieee8021x(akm) ||
137 wpa_key_mgmt_wpa_psk(akm) ||
138 wpa_key_mgmt_fils(akm) ||
139 wpa_key_mgmt_sae(akm);
140 }
141
wpa_key_mgmt_wpa_any(int akm)142 static inline int wpa_key_mgmt_wpa_any(int akm)
143 {
144 return wpa_key_mgmt_wpa(akm) || (akm & WPA_KEY_MGMT_WPA_NONE);
145 }
146
wpa_key_mgmt_cckm(int akm)147 static inline int wpa_key_mgmt_cckm(int akm)
148 {
149 return akm == WPA_KEY_MGMT_CCKM;
150 }
151
152
153 #define WPA_PROTO_WPA BIT(0)
154 #define WPA_PROTO_RSN BIT(1)
155 #define WPA_PROTO_WAPI BIT(2)
156 #define WPA_PROTO_OSEN BIT(3)
157
158 #define WPA_AUTH_ALG_OPEN BIT(0)
159 #define WPA_AUTH_ALG_SHARED BIT(1)
160 #define WPA_AUTH_ALG_LEAP BIT(2)
161 #define WPA_AUTH_ALG_FT BIT(3)
162 #define WPA_AUTH_ALG_SAE BIT(4)
163 #define WPA_AUTH_ALG_FILS BIT(5)
164
165
166 enum wpa_alg {
167 WPA_ALG_NONE,
168 WPA_ALG_WEP,
169 WPA_ALG_TKIP,
170 WPA_ALG_CCMP,
171 WPA_ALG_IGTK,
172 WPA_ALG_PMK,
173 WPA_ALG_GCMP,
174 WPA_ALG_SMS4,
175 WPA_ALG_KRK,
176 WPA_ALG_GCMP_256,
177 WPA_ALG_CCMP_256,
178 WPA_ALG_BIP_GMAC_128,
179 WPA_ALG_BIP_GMAC_256,
180 WPA_ALG_BIP_CMAC_256
181 };
182
183 /**
184 * enum wpa_states - wpa_supplicant state
185 *
186 * These enumeration values are used to indicate the current wpa_supplicant
187 * state (wpa_s->wpa_state). The current state can be retrieved with
188 * wpa_supplicant_get_state() function and the state can be changed by calling
189 * wpa_supplicant_set_state(). In WPA state machine (wpa.c and preauth.c), the
190 * wrapper functions wpa_sm_get_state() and wpa_sm_set_state() should be used
191 * to access the state variable.
192 */
193 enum wpa_states {
194 /**
195 * WPA_DISCONNECTED - Disconnected state
196 *
197 * This state indicates that client is not associated, but is likely to
198 * start looking for an access point. This state is entered when a
199 * connection is lost.
200 */
201 WPA_DISCONNECTED,
202
203 /**
204 * WPA_INTERFACE_DISABLED - Interface disabled
205 *
206 * This state is entered if the network interface is disabled, e.g.,
207 * due to rfkill. wpa_supplicant refuses any new operations that would
208 * use the radio until the interface has been enabled.
209 */
210 WPA_INTERFACE_DISABLED,
211
212 /**
213 * WPA_INACTIVE - Inactive state (wpa_supplicant disabled)
214 *
215 * This state is entered if there are no enabled networks in the
216 * configuration. wpa_supplicant is not trying to associate with a new
217 * network and external interaction (e.g., ctrl_iface call to add or
218 * enable a network) is needed to start association.
219 */
220 WPA_INACTIVE,
221
222 /**
223 * WPA_SCANNING - Scanning for a network
224 *
225 * This state is entered when wpa_supplicant starts scanning for a
226 * network.
227 */
228 WPA_SCANNING,
229
230 /**
231 * WPA_AUTHENTICATING - Trying to authenticate with a BSS/SSID
232 *
233 * This state is entered when wpa_supplicant has found a suitable BSS
234 * to authenticate with and the driver is configured to try to
235 * authenticate with this BSS. This state is used only with drivers
236 * that use wpa_supplicant as the SME.
237 */
238 WPA_AUTHENTICATING,
239
240 /**
241 * WPA_ASSOCIATING - Trying to associate with a BSS/SSID
242 *
243 * This state is entered when wpa_supplicant has found a suitable BSS
244 * to associate with and the driver is configured to try to associate
245 * with this BSS in ap_scan=1 mode. When using ap_scan=2 mode, this
246 * state is entered when the driver is configured to try to associate
247 * with a network using the configured SSID and security policy.
248 */
249 WPA_ASSOCIATING,
250
251 /**
252 * WPA_ASSOCIATED - Association completed
253 *
254 * This state is entered when the driver reports that association has
255 * been successfully completed with an AP. If IEEE 802.1X is used
256 * (with or without WPA/WPA2), wpa_supplicant remains in this state
257 * until the IEEE 802.1X/EAPOL authentication has been completed.
258 */
259 WPA_ASSOCIATED,
260
261 /**
262 * WPA_4WAY_HANDSHAKE - WPA 4-Way Key Handshake in progress
263 *
264 * This state is entered when WPA/WPA2 4-Way Handshake is started. In
265 * case of WPA-PSK, this happens when receiving the first EAPOL-Key
266 * frame after association. In case of WPA-EAP, this state is entered
267 * when the IEEE 802.1X/EAPOL authentication has been completed.
268 */
269 WPA_4WAY_HANDSHAKE,
270
271 /**
272 * WPA_GROUP_HANDSHAKE - WPA Group Key Handshake in progress
273 *
274 * This state is entered when 4-Way Key Handshake has been completed
275 * (i.e., when the supplicant sends out message 4/4) and when Group
276 * Key rekeying is started by the AP (i.e., when supplicant receives
277 * message 1/2).
278 */
279 WPA_GROUP_HANDSHAKE,
280
281 /**
282 * WPA_COMPLETED - All authentication completed
283 *
284 * This state is entered when the full authentication process is
285 * completed. In case of WPA2, this happens when the 4-Way Handshake is
286 * successfully completed. With WPA, this state is entered after the
287 * Group Key Handshake; with IEEE 802.1X (non-WPA) connection is
288 * completed after dynamic keys are received (or if not used, after
289 * the EAP authentication has been completed). With static WEP keys and
290 * plaintext connections, this state is entered when an association
291 * has been completed.
292 *
293 * This state indicates that the supplicant has completed its
294 * processing for the association phase and that data connection is
295 * fully configured.
296 */
297 WPA_COMPLETED
298 };
299
300 #define MLME_SETPROTECTION_PROTECT_TYPE_NONE 0
301 #define MLME_SETPROTECTION_PROTECT_TYPE_RX 1
302 #define MLME_SETPROTECTION_PROTECT_TYPE_TX 2
303 #define MLME_SETPROTECTION_PROTECT_TYPE_RX_TX 3
304
305 #define MLME_SETPROTECTION_KEY_TYPE_GROUP 0
306 #define MLME_SETPROTECTION_KEY_TYPE_PAIRWISE 1
307
308
309 /**
310 * enum mfp_options - Management frame protection (IEEE 802.11w) options
311 */
312 enum mfp_options {
313 NO_MGMT_FRAME_PROTECTION = 0,
314 MGMT_FRAME_PROTECTION_OPTIONAL = 1,
315 MGMT_FRAME_PROTECTION_REQUIRED = 2,
316 };
317 #define MGMT_FRAME_PROTECTION_DEFAULT 3
318
319 /**
320 * enum hostapd_hw_mode - Hardware mode
321 */
322 enum hostapd_hw_mode {
323 HOSTAPD_MODE_IEEE80211B,
324 HOSTAPD_MODE_IEEE80211G,
325 HOSTAPD_MODE_IEEE80211A,
326 HOSTAPD_MODE_IEEE80211AD,
327 HOSTAPD_MODE_IEEE80211ANY,
328 NUM_HOSTAPD_MODES
329 };
330
331 /**
332 * enum wpa_ctrl_req_type - Control interface request types
333 */
334 enum wpa_ctrl_req_type {
335 WPA_CTRL_REQ_UNKNOWN,
336 WPA_CTRL_REQ_EAP_IDENTITY,
337 WPA_CTRL_REQ_EAP_PASSWORD,
338 WPA_CTRL_REQ_EAP_NEW_PASSWORD,
339 WPA_CTRL_REQ_EAP_PIN,
340 WPA_CTRL_REQ_EAP_OTP,
341 WPA_CTRL_REQ_EAP_PASSPHRASE,
342 WPA_CTRL_REQ_SIM,
343 WPA_CTRL_REQ_PSK_PASSPHRASE,
344 WPA_CTRL_REQ_EXT_CERT_CHECK,
345 NUM_WPA_CTRL_REQS
346 };
347
348 /* Maximum number of EAP methods to store for EAP server user information */
349 #define EAP_MAX_METHODS 8
350
351 enum mesh_plink_state {
352 PLINK_IDLE = 1,
353 PLINK_OPN_SNT,
354 PLINK_OPN_RCVD,
355 PLINK_CNF_RCVD,
356 PLINK_ESTAB,
357 PLINK_HOLDING,
358 PLINK_BLOCKED, /* not defined in the IEEE 802.11 standard */
359 };
360
361 enum set_band {
362 WPA_SETBAND_AUTO,
363 WPA_SETBAND_5G,
364 WPA_SETBAND_2G
365 };
366
367 enum wpa_radio_work_band {
368 BAND_2_4_GHZ = BIT(0),
369 BAND_5_GHZ = BIT(1),
370 BAND_60_GHZ = BIT(2),
371 };
372
373 enum beacon_rate_type {
374 BEACON_RATE_LEGACY,
375 BEACON_RATE_HT,
376 BEACON_RATE_VHT
377 };
378
379 enum eap_proxy_sim_state {
380 SIM_STATE_ERROR,
381 };
382
383 #endif /* DEFS_H */
384