Branch data Line data Source code
1 : : /*
2 : : * WPA Supplicant - Common definitions
3 : : * Copyright (c) 2004-2008, 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 : : #ifdef CONFIG_IEEE80211W
27 : : #define WPA_CIPHER_AES_128_CMAC BIT(5)
28 : : #endif /* CONFIG_IEEE80211W */
29 : : #define WPA_CIPHER_GCMP BIT(6)
30 : : #define WPA_CIPHER_SMS4 BIT(7)
31 : : #define WPA_CIPHER_GCMP_256 BIT(8)
32 : : #define WPA_CIPHER_CCMP_256 BIT(9)
33 : : #define WPA_CIPHER_BIP_GMAC_128 BIT(11)
34 : : #define WPA_CIPHER_BIP_GMAC_256 BIT(12)
35 : : #define WPA_CIPHER_BIP_CMAC_256 BIT(13)
36 : : #define WPA_CIPHER_GTK_NOT_USED BIT(14)
37 : :
38 : : #define WPA_KEY_MGMT_IEEE8021X BIT(0)
39 : : #define WPA_KEY_MGMT_PSK BIT(1)
40 : : #define WPA_KEY_MGMT_NONE BIT(2)
41 : : #define WPA_KEY_MGMT_IEEE8021X_NO_WPA BIT(3)
42 : : #define WPA_KEY_MGMT_WPA_NONE BIT(4)
43 : : #define WPA_KEY_MGMT_FT_IEEE8021X BIT(5)
44 : : #define WPA_KEY_MGMT_FT_PSK BIT(6)
45 : : #define WPA_KEY_MGMT_IEEE8021X_SHA256 BIT(7)
46 : : #define WPA_KEY_MGMT_PSK_SHA256 BIT(8)
47 : : #define WPA_KEY_MGMT_WPS BIT(9)
48 : : #define WPA_KEY_MGMT_SAE BIT(10)
49 : : #define WPA_KEY_MGMT_FT_SAE BIT(11)
50 : : #define WPA_KEY_MGMT_WAPI_PSK BIT(12)
51 : : #define WPA_KEY_MGMT_WAPI_CERT BIT(13)
52 : : #define WPA_KEY_MGMT_CCKM BIT(14)
53 : :
54 : 0 : static inline int wpa_key_mgmt_wpa_ieee8021x(int akm)
55 : : {
56 : 0 : return !!(akm & (WPA_KEY_MGMT_IEEE8021X |
57 : : WPA_KEY_MGMT_FT_IEEE8021X |
58 : : WPA_KEY_MGMT_CCKM |
59 : : WPA_KEY_MGMT_IEEE8021X_SHA256));
60 : : }
61 : :
62 : 0 : static inline int wpa_key_mgmt_wpa_psk(int akm)
63 : : {
64 : 0 : return !!(akm & (WPA_KEY_MGMT_PSK |
65 : : WPA_KEY_MGMT_FT_PSK |
66 : : WPA_KEY_MGMT_PSK_SHA256 |
67 : : WPA_KEY_MGMT_SAE));
68 : : }
69 : :
70 : 1 : static inline int wpa_key_mgmt_ft(int akm)
71 : : {
72 : 1 : return !!(akm & (WPA_KEY_MGMT_FT_PSK |
73 : : WPA_KEY_MGMT_FT_IEEE8021X |
74 : : WPA_KEY_MGMT_FT_SAE));
75 : : }
76 : :
77 : 0 : static inline int wpa_key_mgmt_sae(int akm)
78 : : {
79 : 0 : return !!(akm & (WPA_KEY_MGMT_SAE |
80 : : WPA_KEY_MGMT_FT_SAE));
81 : : }
82 : :
83 : 0 : static inline int wpa_key_mgmt_sha256(int akm)
84 : : {
85 : 0 : return !!(akm & (WPA_KEY_MGMT_PSK_SHA256 |
86 : : WPA_KEY_MGMT_IEEE8021X_SHA256));
87 : : }
88 : :
89 : : static inline int wpa_key_mgmt_wpa(int akm)
90 : : {
91 : : return wpa_key_mgmt_wpa_ieee8021x(akm) ||
92 : : wpa_key_mgmt_wpa_psk(akm);
93 : : }
94 : :
95 : : static inline int wpa_key_mgmt_wpa_any(int akm)
96 : : {
97 : : return wpa_key_mgmt_wpa(akm) || (akm & WPA_KEY_MGMT_WPA_NONE);
98 : : }
99 : :
100 : : static inline int wpa_key_mgmt_cckm(int akm)
101 : : {
102 : : return akm == WPA_KEY_MGMT_CCKM;
103 : : }
104 : :
105 : :
106 : : #define WPA_PROTO_WPA BIT(0)
107 : : #define WPA_PROTO_RSN BIT(1)
108 : : #define WPA_PROTO_WAPI BIT(2)
109 : :
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)
115 : :
116 : :
117 : : enum wpa_alg {
118 : : WPA_ALG_NONE,
119 : : WPA_ALG_WEP,
120 : : WPA_ALG_TKIP,
121 : : WPA_ALG_CCMP,
122 : : WPA_ALG_IGTK,
123 : : WPA_ALG_PMK,
124 : : WPA_ALG_GCMP,
125 : : WPA_ALG_SMS4,
126 : : WPA_ALG_KRK,
127 : : WPA_ALG_GCMP_256,
128 : : WPA_ALG_CCMP_256,
129 : : WPA_ALG_BIP_GMAC_128,
130 : : WPA_ALG_BIP_GMAC_256,
131 : : WPA_ALG_BIP_CMAC_256
132 : : };
133 : :
134 : : /**
135 : : * enum wpa_cipher - Cipher suites
136 : : */
137 : : enum wpa_cipher {
138 : : CIPHER_NONE,
139 : : CIPHER_WEP40,
140 : : CIPHER_TKIP,
141 : : CIPHER_CCMP,
142 : : CIPHER_WEP104,
143 : : CIPHER_GCMP,
144 : : CIPHER_SMS4,
145 : : CIPHER_GCMP_256,
146 : : CIPHER_CCMP_256
147 : : };
148 : :
149 : : /**
150 : : * enum wpa_key_mgmt - Key management suites
151 : : */
152 : : enum wpa_key_mgmt {
153 : : KEY_MGMT_802_1X,
154 : : KEY_MGMT_PSK,
155 : : KEY_MGMT_NONE,
156 : : KEY_MGMT_802_1X_NO_WPA,
157 : : KEY_MGMT_WPA_NONE,
158 : : KEY_MGMT_FT_802_1X,
159 : : KEY_MGMT_FT_PSK,
160 : : KEY_MGMT_802_1X_SHA256,
161 : : KEY_MGMT_PSK_SHA256,
162 : : KEY_MGMT_WPS,
163 : : KEY_MGMT_SAE,
164 : : KEY_MGMT_FT_SAE,
165 : : KEY_MGMT_WAPI_PSK,
166 : : KEY_MGMT_WAPI_CERT,
167 : : KEY_MGMT_CCKM
168 : : };
169 : :
170 : : /**
171 : : * enum wpa_states - wpa_supplicant state
172 : : *
173 : : * These enumeration values are used to indicate the current wpa_supplicant
174 : : * state (wpa_s->wpa_state). The current state can be retrieved with
175 : : * wpa_supplicant_get_state() function and the state can be changed by calling
176 : : * wpa_supplicant_set_state(). In WPA state machine (wpa.c and preauth.c), the
177 : : * wrapper functions wpa_sm_get_state() and wpa_sm_set_state() should be used
178 : : * to access the state variable.
179 : : */
180 : : enum wpa_states {
181 : : /**
182 : : * WPA_DISCONNECTED - Disconnected state
183 : : *
184 : : * This state indicates that client is not associated, but is likely to
185 : : * start looking for an access point. This state is entered when a
186 : : * connection is lost.
187 : : */
188 : : WPA_DISCONNECTED,
189 : :
190 : : /**
191 : : * WPA_INTERFACE_DISABLED - Interface disabled
192 : : *
193 : : * This stat eis entered if the network interface is disabled, e.g.,
194 : : * due to rfkill. wpa_supplicant refuses any new operations that would
195 : : * use the radio until the interface has been enabled.
196 : : */
197 : : WPA_INTERFACE_DISABLED,
198 : :
199 : : /**
200 : : * WPA_INACTIVE - Inactive state (wpa_supplicant disabled)
201 : : *
202 : : * This state is entered if there are no enabled networks in the
203 : : * configuration. wpa_supplicant is not trying to associate with a new
204 : : * network and external interaction (e.g., ctrl_iface call to add or
205 : : * enable a network) is needed to start association.
206 : : */
207 : : WPA_INACTIVE,
208 : :
209 : : /**
210 : : * WPA_SCANNING - Scanning for a network
211 : : *
212 : : * This state is entered when wpa_supplicant starts scanning for a
213 : : * network.
214 : : */
215 : : WPA_SCANNING,
216 : :
217 : : /**
218 : : * WPA_AUTHENTICATING - Trying to authenticate with a BSS/SSID
219 : : *
220 : : * This state is entered when wpa_supplicant has found a suitable BSS
221 : : * to authenticate with and the driver is configured to try to
222 : : * authenticate with this BSS. This state is used only with drivers
223 : : * that use wpa_supplicant as the SME.
224 : : */
225 : : WPA_AUTHENTICATING,
226 : :
227 : : /**
228 : : * WPA_ASSOCIATING - Trying to associate with a BSS/SSID
229 : : *
230 : : * This state is entered when wpa_supplicant has found a suitable BSS
231 : : * to associate with and the driver is configured to try to associate
232 : : * with this BSS in ap_scan=1 mode. When using ap_scan=2 mode, this
233 : : * state is entered when the driver is configured to try to associate
234 : : * with a network using the configured SSID and security policy.
235 : : */
236 : : WPA_ASSOCIATING,
237 : :
238 : : /**
239 : : * WPA_ASSOCIATED - Association completed
240 : : *
241 : : * This state is entered when the driver reports that association has
242 : : * been successfully completed with an AP. If IEEE 802.1X is used
243 : : * (with or without WPA/WPA2), wpa_supplicant remains in this state
244 : : * until the IEEE 802.1X/EAPOL authentication has been completed.
245 : : */
246 : : WPA_ASSOCIATED,
247 : :
248 : : /**
249 : : * WPA_4WAY_HANDSHAKE - WPA 4-Way Key Handshake in progress
250 : : *
251 : : * This state is entered when WPA/WPA2 4-Way Handshake is started. In
252 : : * case of WPA-PSK, this happens when receiving the first EAPOL-Key
253 : : * frame after association. In case of WPA-EAP, this state is entered
254 : : * when the IEEE 802.1X/EAPOL authentication has been completed.
255 : : */
256 : : WPA_4WAY_HANDSHAKE,
257 : :
258 : : /**
259 : : * WPA_GROUP_HANDSHAKE - WPA Group Key Handshake in progress
260 : : *
261 : : * This state is entered when 4-Way Key Handshake has been completed
262 : : * (i.e., when the supplicant sends out message 4/4) and when Group
263 : : * Key rekeying is started by the AP (i.e., when supplicant receives
264 : : * message 1/2).
265 : : */
266 : : WPA_GROUP_HANDSHAKE,
267 : :
268 : : /**
269 : : * WPA_COMPLETED - All authentication completed
270 : : *
271 : : * This state is entered when the full authentication process is
272 : : * completed. In case of WPA2, this happens when the 4-Way Handshake is
273 : : * successfully completed. With WPA, this state is entered after the
274 : : * Group Key Handshake; with IEEE 802.1X (non-WPA) connection is
275 : : * completed after dynamic keys are received (or if not used, after
276 : : * the EAP authentication has been completed). With static WEP keys and
277 : : * plaintext connections, this state is entered when an association
278 : : * has been completed.
279 : : *
280 : : * This state indicates that the supplicant has completed its
281 : : * processing for the association phase and that data connection is
282 : : * fully configured.
283 : : */
284 : : WPA_COMPLETED
285 : : };
286 : :
287 : : #define MLME_SETPROTECTION_PROTECT_TYPE_NONE 0
288 : : #define MLME_SETPROTECTION_PROTECT_TYPE_RX 1
289 : : #define MLME_SETPROTECTION_PROTECT_TYPE_TX 2
290 : : #define MLME_SETPROTECTION_PROTECT_TYPE_RX_TX 3
291 : :
292 : : #define MLME_SETPROTECTION_KEY_TYPE_GROUP 0
293 : : #define MLME_SETPROTECTION_KEY_TYPE_PAIRWISE 1
294 : :
295 : :
296 : : /**
297 : : * enum mfp_options - Management frame protection (IEEE 802.11w) options
298 : : */
299 : : enum mfp_options {
300 : : NO_MGMT_FRAME_PROTECTION = 0,
301 : : MGMT_FRAME_PROTECTION_OPTIONAL = 1,
302 : : MGMT_FRAME_PROTECTION_REQUIRED = 2,
303 : : };
304 : : #define MGMT_FRAME_PROTECTION_DEFAULT 3
305 : :
306 : : /**
307 : : * enum hostapd_hw_mode - Hardware mode
308 : : */
309 : : enum hostapd_hw_mode {
310 : : HOSTAPD_MODE_IEEE80211B,
311 : : HOSTAPD_MODE_IEEE80211G,
312 : : HOSTAPD_MODE_IEEE80211A,
313 : : HOSTAPD_MODE_IEEE80211AD,
314 : : NUM_HOSTAPD_MODES
315 : : };
316 : :
317 : : /**
318 : : * enum wpa_ctrl_req_type - Control interface request types
319 : : */
320 : : enum wpa_ctrl_req_type {
321 : : WPA_CTRL_REQ_UNKNOWN,
322 : : WPA_CTRL_REQ_EAP_IDENTITY,
323 : : WPA_CTRL_REQ_EAP_PASSWORD,
324 : : WPA_CTRL_REQ_EAP_NEW_PASSWORD,
325 : : WPA_CTRL_REQ_EAP_PIN,
326 : : WPA_CTRL_REQ_EAP_OTP,
327 : : WPA_CTRL_REQ_EAP_PASSPHRASE,
328 : : WPA_CTRL_REQ_SIM,
329 : : NUM_WPA_CTRL_REQS
330 : : };
331 : :
332 : : /* Maximum number of EAP methods to store for EAP server user information */
333 : : #define EAP_MAX_METHODS 8
334 : :
335 : : #endif /* DEFS_H */
|
