1 /*
2 * WPA definitions shared between hostapd and wpa_supplicant
3 * Copyright (c) 2002-2018, 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 WPA_COMMON_H
10 #define WPA_COMMON_H
11
12 #include "common/defs.h"
13
14 /* IEEE 802.11i */
15 #define PMKID_LEN 16
16 #define PMK_LEN 32
17 #define PMK_LEN_SUITE_B_192 48
18 #define PMK_LEN_MAX 64
19 #define WPA_REPLAY_COUNTER_LEN 8
20 #define RSN_PN_LEN 6
21 #define WPA_NONCE_LEN 32
22 #define WPA_KEY_RSC_LEN 8
23 #define WPA_GMK_LEN 32
24 #define WPA_GTK_MAX_LEN 32
25 #define WPA_PASN_PMK_LEN 32
26 #define WPA_PASN_MAX_MIC_LEN 24
27 #define WPA_MAX_RSNXE_LEN 4
28
29 #define OWE_DH_GROUP 19
30
31 #ifdef CONFIG_NO_TKIP
32 #define WPA_ALLOWED_PAIRWISE_CIPHERS \
33 (WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_NONE | \
34 WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256)
35 #define WPA_ALLOWED_GROUP_CIPHERS \
36 (WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | \
37 WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256 | \
38 WPA_CIPHER_GTK_NOT_USED)
39 #else /* CONFIG_NO_TKIP */
40 #define WPA_ALLOWED_PAIRWISE_CIPHERS \
41 (WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | WPA_CIPHER_NONE | \
42 WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256)
43 #define WPA_ALLOWED_GROUP_CIPHERS \
44 (WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | \
45 WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256 | \
46 WPA_CIPHER_GTK_NOT_USED)
47 #endif /* CONFIG_NO_TKIP */
48 #define WPA_ALLOWED_GROUP_MGMT_CIPHERS \
49 (WPA_CIPHER_AES_128_CMAC | WPA_CIPHER_BIP_GMAC_128 | WPA_CIPHER_BIP_GMAC_256 | \
50 WPA_CIPHER_BIP_CMAC_256)
51
52 #define WPA_SELECTOR_LEN 4
53 #define WPA_VERSION 1
54 #define RSN_SELECTOR_LEN 4
55 #define RSN_VERSION 1
56
57 #define RSN_SELECTOR(a, b, c, d) \
58 ((((u32) (a)) << 24) | (((u32) (b)) << 16) | (((u32) (c)) << 8) | \
59 (u32) (d))
60
61 #define WPA_AUTH_KEY_MGMT_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
62 #define WPA_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
63 #define WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
64 #define WPA_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0)
65 #define WPA_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
66 #define WPA_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
67 #define WPA_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x50, 0xf2, 4)
68
69
70 #define RSN_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
71 #define RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
72 #define RSN_AUTH_KEY_MGMT_FT_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
73 #define RSN_AUTH_KEY_MGMT_FT_PSK RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
74 #define RSN_AUTH_KEY_MGMT_802_1X_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
75 #define RSN_AUTH_KEY_MGMT_PSK_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
76 #define RSN_AUTH_KEY_MGMT_TPK_HANDSHAKE RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
77 #define RSN_AUTH_KEY_MGMT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
78 #define RSN_AUTH_KEY_MGMT_FT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
79 #define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
80 #define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B_192 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
81 #define RSN_AUTH_KEY_MGMT_FT_802_1X_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
82 #define RSN_AUTH_KEY_MGMT_FILS_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 14)
83 #define RSN_AUTH_KEY_MGMT_FILS_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 15)
84 #define RSN_AUTH_KEY_MGMT_FT_FILS_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 16)
85 #define RSN_AUTH_KEY_MGMT_FT_FILS_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 17)
86 #define RSN_AUTH_KEY_MGMT_OWE RSN_SELECTOR(0x00, 0x0f, 0xac, 18)
87 #define RSN_AUTH_KEY_MGMT_FT_PSK_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 19)
88 #define RSN_AUTH_KEY_MGMT_PSK_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 20)
89 #define RSN_AUTH_KEY_MGMT_PASN RSN_SELECTOR(0x00, 0x0f, 0xac, 21)
90 #define RSN_AUTH_KEY_MGMT_FT_802_1X_SHA384_UNRESTRICTED \
91 RSN_SELECTOR(0x00, 0x0f, 0xac, 22)
92 #define RSN_AUTH_KEY_MGMT_802_1X_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 23)
93 #define RSN_AUTH_KEY_MGMT_SAE_EXT_KEY RSN_SELECTOR(0x00, 0x0f, 0xac, 24)
94 #define RSN_AUTH_KEY_MGMT_FT_SAE_EXT_KEY RSN_SELECTOR(0x00, 0x0f, 0xac, 25)
95
96 #define RSN_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0x00)
97 #define RSN_AUTH_KEY_MGMT_DPP RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x02)
98
99 #define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0)
100 #define RSN_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
101 #define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
102 #if 0
103 #define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
104 #endif
105 #define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
106 #define RSN_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
107 #define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
108 #define RSN_CIPHER_SUITE_NO_GROUP_ADDRESSED RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
109 #define RSN_CIPHER_SUITE_GCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
110 #define RSN_CIPHER_SUITE_GCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
111 #define RSN_CIPHER_SUITE_CCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
112 #define RSN_CIPHER_SUITE_BIP_GMAC_128 RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
113 #define RSN_CIPHER_SUITE_BIP_GMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
114 #define RSN_CIPHER_SUITE_BIP_CMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
115 #define RSN_CIPHER_SUITE_SMS4 RSN_SELECTOR(0x00, 0x14, 0x72, 1)
116 #define RSN_CIPHER_SUITE_CKIP RSN_SELECTOR(0x00, 0x40, 0x96, 0)
117 #define RSN_CIPHER_SUITE_CKIP_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 1)
118 #define RSN_CIPHER_SUITE_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 2)
119 /* KRK is defined for nl80211 use only */
120 #define RSN_CIPHER_SUITE_KRK RSN_SELECTOR(0x00, 0x40, 0x96, 255)
121
122 /* EAPOL-Key Key Data Encapsulation
123 * GroupKey and PeerKey require encryption, otherwise, encryption is optional.
124 */
125 #define RSN_KEY_DATA_GROUPKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
126 #if 0
127 #define RSN_KEY_DATA_STAKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
128 #endif
129 #define RSN_KEY_DATA_MAC_ADDR RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
130 #define RSN_KEY_DATA_PMKID RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
131 #define RSN_KEY_DATA_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
132 #define RSN_KEY_DATA_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
133 #define RSN_KEY_DATA_MULTIBAND_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
134 #define RSN_KEY_DATA_MULTIBAND_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
135 #define RSN_KEY_DATA_OCI RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
136 #define RSN_KEY_DATA_BIGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 14)
137 #define RSN_KEY_DATA_MLO_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 16)
138 #define RSN_KEY_DATA_MLO_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 17)
139 #define RSN_KEY_DATA_MLO_BIGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 18)
140 #define RSN_KEY_DATA_MLO_LINK RSN_SELECTOR(0x00, 0x0f, 0xac, 19)
141
142 #define WFA_KEY_DATA_IP_ADDR_REQ RSN_SELECTOR(0x50, 0x6f, 0x9a, 4)
143 #define WFA_KEY_DATA_IP_ADDR_ALLOC RSN_SELECTOR(0x50, 0x6f, 0x9a, 5)
144 #define WFA_KEY_DATA_TRANSITION_DISABLE RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x20)
145 #define WFA_KEY_DATA_DPP RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x21)
146 #define WFA_KEY_DATA_RSN_OVERRIDE_LINK RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x2d)
147
148 #define WPA_OUI_TYPE RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
149
150 #define RSN_SELECTOR_PUT(a, val) WPA_PUT_BE32((u8 *) (a), (val))
151 #define RSN_SELECTOR_GET(a) WPA_GET_BE32((const u8 *) (a))
152
153 #define RSN_NUM_REPLAY_COUNTERS_1 0
154 #define RSN_NUM_REPLAY_COUNTERS_2 1
155 #define RSN_NUM_REPLAY_COUNTERS_4 2
156 #define RSN_NUM_REPLAY_COUNTERS_16 3
157
158
159 #ifdef _MSC_VER
160 #pragma pack(push, 1)
161 #endif /* _MSC_VER */
162
163 #define WPA_IGTK_LEN 16
164 #define WPA_IGTK_MAX_LEN 32
165 #define WPA_BIGTK_LEN 16
166 #define WPA_BIGTK_MAX_LEN 32
167
168
169 /* IEEE 802.11, 7.3.2.25.3 RSN Capabilities */
170 #define WPA_CAPABILITY_PREAUTH BIT(0)
171 #define WPA_CAPABILITY_NO_PAIRWISE BIT(1)
172 /* B2-B3: PTKSA Replay Counter */
173 /* B4-B5: GTKSA Replay Counter */
174 #define WPA_CAPABILITY_MFPR BIT(6)
175 #define WPA_CAPABILITY_MFPC BIT(7)
176 /* B8: Reserved */
177 #define WPA_CAPABILITY_PEERKEY_ENABLED BIT(9)
178 #define WPA_CAPABILITY_SPP_A_MSDU_CAPABLE BIT(10)
179 #define WPA_CAPABILITY_SPP_A_MSDU_REQUIRED BIT(11)
180 #define WPA_CAPABILITY_PBAC BIT(12)
181 #define WPA_CAPABILITY_EXT_KEY_ID_FOR_UNICAST BIT(13)
182 #define WPA_CAPABILITY_OCVC BIT(14)
183 /* B15: Reserved */
184
185
186 /* IEEE 802.11r */
187 #define MOBILITY_DOMAIN_ID_LEN 2
188 #define FT_R0KH_ID_MAX_LEN 48
189 #define FT_R1KH_ID_LEN 6
190 #define WPA_PMK_NAME_LEN 16
191
192 /* FTE - MIC Control - RSNXE Used */
193 #define FTE_MIC_CTRL_RSNXE_USED BIT(0)
194 #define FTE_MIC_CTRL_MIC_LEN_MASK (BIT(1) | BIT(2) | BIT(3))
195 #define FTE_MIC_CTRL_MIC_LEN_SHIFT 1
196
197 /* FTE - MIC Length subfield values */
198 enum ft_mic_len_subfield {
199 FTE_MIC_LEN_16 = 0,
200 FTE_MIC_LEN_24 = 1,
201 FTE_MIC_LEN_32 = 2,
202 };
203
204
205 /* IEEE 802.11, 8.5.2 EAPOL-Key frames */
206 #define WPA_KEY_INFO_TYPE_MASK ((u16) (BIT(0) | BIT(1) | BIT(2)))
207 #define WPA_KEY_INFO_TYPE_AKM_DEFINED 0
208 #define WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 BIT(0)
209 #define WPA_KEY_INFO_TYPE_HMAC_SHA1_AES BIT(1)
210 #define WPA_KEY_INFO_TYPE_AES_128_CMAC 3
211 #define WPA_KEY_INFO_KEY_TYPE BIT(3) /* 1 = Pairwise, 0 = Group key */
212 /* bit4..5 is used in WPA, but is reserved in IEEE 802.11i/RSN */
213 #define WPA_KEY_INFO_KEY_INDEX_MASK (BIT(4) | BIT(5))
214 #define WPA_KEY_INFO_KEY_INDEX_SHIFT 4
215 #define WPA_KEY_INFO_INSTALL BIT(6) /* pairwise */
216 #define WPA_KEY_INFO_TXRX BIT(6) /* group */
217 #define WPA_KEY_INFO_ACK BIT(7)
218 #define WPA_KEY_INFO_MIC BIT(8)
219 #define WPA_KEY_INFO_SECURE BIT(9)
220 #define WPA_KEY_INFO_ERROR BIT(10)
221 #define WPA_KEY_INFO_REQUEST BIT(11)
222 #define WPA_KEY_INFO_ENCR_KEY_DATA BIT(12) /* IEEE 802.11i/RSN only */
223 #define WPA_KEY_INFO_SMK_MESSAGE BIT(13)
224
225
226 struct wpa_eapol_key {
227 u8 type;
228 /* Note: key_info, key_length, and key_data_length are unaligned */
229 u8 key_info[2]; /* big endian */
230 u8 key_length[2]; /* big endian */
231 u8 replay_counter[WPA_REPLAY_COUNTER_LEN];
232 u8 key_nonce[WPA_NONCE_LEN];
233 u8 key_iv[16];
234 u8 key_rsc[WPA_KEY_RSC_LEN];
235 u8 key_id[8]; /* Reserved in IEEE 802.11i/RSN */
236 /* variable length Key MIC field */
237 /* big endian 2-octet Key Data Length field */
238 /* followed by Key Data Length bytes of Key Data */
239 } STRUCT_PACKED;
240
241 #define WPA_EAPOL_KEY_MIC_MAX_LEN 32
242 #define WPA_KCK_MAX_LEN 32
243 #define WPA_KEK_MAX_LEN 64
244 #define WPA_TK_MAX_LEN 32
245 #define WPA_KDK_MAX_LEN 32
246 #define FILS_ICK_MAX_LEN 48
247 #define FILS_FT_MAX_LEN 48
248 #define WPA_PASN_KCK_LEN 32
249 #define WPA_PASN_MIC_MAX_LEN 24
250 #define WPA_LTF_KEYSEED_MAX_LEN 48
251
252 /**
253 * struct wpa_ptk - WPA Pairwise Transient Key
254 * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy
255 */
256 struct wpa_ptk {
257 u8 kck[WPA_KCK_MAX_LEN]; /* EAPOL-Key Key Confirmation Key (KCK) */
258 u8 kek[WPA_KEK_MAX_LEN]; /* EAPOL-Key Key Encryption Key (KEK) */
259 u8 tk[WPA_TK_MAX_LEN]; /* Temporal Key (TK) */
260 u8 kck2[WPA_KCK_MAX_LEN]; /* FT reasoc Key Confirmation Key (KCK2) */
261 u8 kek2[WPA_KEK_MAX_LEN]; /* FT reassoc Key Encryption Key (KEK2) */
262 u8 kdk[WPA_KDK_MAX_LEN]; /* Key Derivation Key */
263 u8 ltf_keyseed[WPA_LTF_KEYSEED_MAX_LEN]; /* LTF Key seed */
264 size_t kck_len;
265 size_t kek_len;
266 size_t tk_len;
267 size_t kck2_len;
268 size_t kek2_len;
269 size_t kdk_len;
270 size_t ptk_len;
271 size_t ltf_keyseed_len;
272 int installed; /* 1 if key has already been installed to driver */
273 bool installed_rx; /* whether TK has been installed as the next TK
274 * for temporary RX-only use in the driver */
275 };
276
277 struct wpa_gtk {
278 u8 gtk[WPA_GTK_MAX_LEN];
279 size_t gtk_len;
280 };
281
282 struct wpa_igtk {
283 u8 igtk[WPA_IGTK_MAX_LEN];
284 size_t igtk_len;
285 };
286
287 struct wpa_bigtk {
288 u8 bigtk[WPA_BIGTK_MAX_LEN];
289 size_t bigtk_len;
290 };
291
292 /* WPA IE version 1
293 * 00-50-f2:1 (OUI:OUI type)
294 * 0x01 0x00 (version; little endian)
295 * (all following fields are optional:)
296 * Group Suite Selector (4 octets) (default: TKIP)
297 * Pairwise Suite Count (2 octets, little endian) (default: 1)
298 * Pairwise Suite List (4 * n octets) (default: TKIP)
299 * Authenticated Key Management Suite Count (2 octets, little endian)
300 * (default: 1)
301 * Authenticated Key Management Suite List (4 * n octets)
302 * (default: unspec 802.1X)
303 * WPA Capabilities (2 octets, little endian) (default: 0)
304 */
305
306 struct wpa_ie_hdr {
307 u8 elem_id;
308 u8 len;
309 u8 oui[4]; /* 24-bit OUI followed by 8-bit OUI type */
310 u8 version[2]; /* little endian */
311 } STRUCT_PACKED;
312
313
314 /* 1/4: PMKID
315 * 2/4: RSN IE
316 * 3/4: one or two RSN IEs + GTK IE (encrypted)
317 * 4/4: empty
318 * 1/2: GTK IE (encrypted)
319 * 2/2: empty
320 */
321
322 /* RSN IE version 1
323 * 0x01 0x00 (version; little endian)
324 * (all following fields are optional:)
325 * Group Suite Selector (4 octets) (default: CCMP)
326 * Pairwise Suite Count (2 octets, little endian) (default: 1)
327 * Pairwise Suite List (4 * n octets) (default: CCMP)
328 * Authenticated Key Management Suite Count (2 octets, little endian)
329 * (default: 1)
330 * Authenticated Key Management Suite List (4 * n octets)
331 * (default: unspec 802.1X)
332 * RSN Capabilities (2 octets, little endian) (default: 0)
333 * PMKID Count (2 octets) (default: 0)
334 * PMKID List (16 * n octets)
335 * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
336 */
337
338 struct rsn_ie_hdr {
339 u8 elem_id; /* WLAN_EID_RSN */
340 u8 len;
341 u8 version[2]; /* little endian */
342 } STRUCT_PACKED;
343
344
345 #define KDE_HDR_LEN (1 + 1 + RSN_SELECTOR_LEN)
346
347 struct rsn_error_kde {
348 be16 mui;
349 be16 error_type;
350 } STRUCT_PACKED;
351
352 #define WPA_IGTK_KDE_PREFIX_LEN (2 + RSN_PN_LEN)
353 struct wpa_igtk_kde {
354 u8 keyid[2];
355 u8 pn[RSN_PN_LEN];
356 u8 igtk[WPA_IGTK_MAX_LEN];
357 } STRUCT_PACKED;
358
359 #define WPA_BIGTK_KDE_PREFIX_LEN (2 + RSN_PN_LEN)
360 struct wpa_bigtk_kde {
361 u8 keyid[2];
362 u8 pn[RSN_PN_LEN];
363 u8 bigtk[WPA_BIGTK_MAX_LEN];
364 } STRUCT_PACKED;
365
366 #define RSN_MLO_GTK_KDE_PREFIX_LENGTH (1 + RSN_PN_LEN)
367 #define RSN_MLO_GTK_KDE_PREFIX0_KEY_ID_MASK 0x03
368 #define RSN_MLO_GTK_KDE_PREFIX0_TX 0x04
369 #define RSN_MLO_GTK_KDE_PREFIX0_LINK_ID_SHIFT 4
370 #define RSN_MLO_GTK_KDE_PREFIX0_LINK_ID_MASK 0xF0
371
372 #define RSN_MLO_IGTK_KDE_PREFIX_LENGTH (2 + RSN_PN_LEN + 1)
373 #define RSN_MLO_IGTK_KDE_PREFIX8_LINK_ID_SHIFT 4
374 #define RSN_MLO_IGTK_KDE_PREFIX8_LINK_ID_MASK 0xF0
375 struct rsn_mlo_igtk_kde {
376 u8 keyid[2];
377 u8 pn[RSN_PN_LEN];
378 u8 prefix8;
379 u8 igtk[WPA_IGTK_MAX_LEN];
380 } STRUCT_PACKED;
381
382 #define RSN_MLO_BIGTK_KDE_PREFIX_LENGTH (2 + RSN_PN_LEN + 1)
383 #define RSN_MLO_BIGTK_KDE_PREFIX8_LINK_ID_SHIFT 4
384 #define RSN_MLO_BIGTK_KDE_PREFIX8_LINK_ID_MASK 0xF0
385 struct rsn_mlo_bigtk_kde {
386 u8 keyid[2];
387 u8 pn[RSN_PN_LEN];
388 u8 prefix8;
389 u8 bigtk[WPA_BIGTK_MAX_LEN];
390 } STRUCT_PACKED;
391
392 #define RSN_MLO_LINK_KDE_FIXED_LENGTH (1 + ETH_ALEN)
393 #define RSN_MLO_LINK_KDE_LINK_INFO_INDEX 0
394 #define RSN_MLO_LINK_KDE_LI_LINK_ID_SHIFT 0
395 #define RSN_MLO_LINK_KDE_LI_LINK_ID_MASK 0x0F
396 #define RSN_MLO_LINK_KDE_LI_RSNE_INFO 0x10
397 #define RSN_MLO_LINK_KDE_LI_RSNXE_INFO 0x20
398 #define RSN_MLO_LINK_KDE_LINK_MAC_INDEX 1
399
400 struct rsn_mdie {
401 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
402 u8 ft_capab;
403 } STRUCT_PACKED;
404
405 #define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
406 #define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
407
408 struct rsn_ftie {
409 u8 mic_control[2];
410 u8 mic[16];
411 u8 anonce[WPA_NONCE_LEN];
412 u8 snonce[WPA_NONCE_LEN];
413 /* followed by optional parameters */
414 } STRUCT_PACKED;
415
416 struct rsn_ftie_sha384 {
417 u8 mic_control[2];
418 u8 mic[24];
419 u8 anonce[WPA_NONCE_LEN];
420 u8 snonce[WPA_NONCE_LEN];
421 /* followed by optional parameters */
422 } STRUCT_PACKED;
423
424 struct rsn_ftie_sha512 {
425 u8 mic_control[2];
426 u8 mic[32];
427 u8 anonce[WPA_NONCE_LEN];
428 u8 snonce[WPA_NONCE_LEN];
429 /* followed by optional parameters */
430 } STRUCT_PACKED;
431
432 #define FTIE_SUBELEM_R1KH_ID 1
433 #define FTIE_SUBELEM_GTK 2
434 #define FTIE_SUBELEM_R0KH_ID 3
435 #define FTIE_SUBELEM_IGTK 4
436 #define FTIE_SUBELEM_OCI 5
437 #define FTIE_SUBELEM_BIGTK 6
438 #define FTIE_SUBELEM_MLO_GTK 8
439 #define FTIE_SUBELEM_MLO_IGTK 9
440 #define FTIE_SUBELEM_MLO_BIGTK 10
441
442 struct rsn_rdie {
443 u8 id;
444 u8 descr_count;
445 le16 status_code;
446 } STRUCT_PACKED;
447
448 /* WFA Transition Disable KDE (using OUI_WFA) */
449 /* Transition Disable Bitmap bits */
450 #define TRANSITION_DISABLE_WPA3_PERSONAL BIT(0)
451 #define TRANSITION_DISABLE_SAE_PK BIT(1)
452 #define TRANSITION_DISABLE_WPA3_ENTERPRISE BIT(2)
453 #define TRANSITION_DISABLE_ENHANCED_OPEN BIT(3)
454
455 /* DPP KDE Flags */
456 #define DPP_KDE_PFS_ALLOWED BIT(0)
457 #define DPP_KDE_PFS_REQUIRED BIT(1)
458
459 #ifdef _MSC_VER
460 #pragma pack(pop)
461 #endif /* _MSC_VER */
462
463
464 int wpa_eapol_key_mic(const u8 *key, size_t key_len, int akmp, int ver,
465 const u8 *buf, size_t len, u8 *mic);
466 int wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label,
467 const u8 *addr1, const u8 *addr2,
468 const u8 *nonce1, const u8 *nonce2,
469 struct wpa_ptk *ptk, int akmp, int cipher,
470 const u8 *z, size_t z_len, size_t kdk_len);
471 int fils_rmsk_to_pmk(int akmp, const u8 *rmsk, size_t rmsk_len,
472 const u8 *snonce, const u8 *anonce, const u8 *dh_ss,
473 size_t dh_ss_len, u8 *pmk, size_t *pmk_len);
474 int fils_pmkid_erp(int akmp, const u8 *reauth, size_t reauth_len,
475 u8 *pmkid);
476 int fils_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const u8 *spa, const u8 *aa,
477 const u8 *snonce, const u8 *anonce, const u8 *dhss,
478 size_t dhss_len, struct wpa_ptk *ptk,
479 u8 *ick, size_t *ick_len, int akmp, int cipher,
480 u8 *fils_ft, size_t *fils_ft_len, size_t kdk_len);
481 int fils_key_auth_sk(const u8 *ick, size_t ick_len, const u8 *snonce,
482 const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
483 const u8 *g_sta, size_t g_sta_len,
484 const u8 *g_ap, size_t g_ap_len,
485 int akmp, u8 *key_auth_sta, u8 *key_auth_ap,
486 size_t *key_auth_len);
487
488 #ifdef CONFIG_IEEE80211R
489 int wpa_ft_mic(int key_mgmt, const u8 *kck, size_t kck_len, const u8 *sta_addr,
490 const u8 *ap_addr, u8 transaction_seqnum,
491 const u8 *mdie, size_t mdie_len,
492 const u8 *ftie, size_t ftie_len,
493 const u8 *rsnie, size_t rsnie_len,
494 const u8 *ric, size_t ric_len,
495 const u8 *rsnxe, size_t rsnxe_len,
496 const struct wpabuf *extra,
497 u8 *mic);
498 int wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len,
499 const u8 *ssid, size_t ssid_len,
500 const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len,
501 const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name,
502 int key_mgmt);
503 int wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id,
504 const u8 *s1kh_id, u8 *pmk_r1_name,
505 size_t pmk_r1_len);
506 int wpa_derive_pmk_r1(const u8 *pmk_r0, size_t pmk_r0_len,
507 const u8 *pmk_r0_name,
508 const u8 *r1kh_id, const u8 *s1kh_id,
509 u8 *pmk_r1, u8 *pmk_r1_name);
510 int wpa_pmk_r1_to_ptk(const u8 *pmk_r1, size_t pmk_r1_len, const u8 *snonce,
511 const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
512 const u8 *pmk_r1_name,
513 struct wpa_ptk *ptk, u8 *ptk_name, int akmp, int cipher,
514 size_t kdk_len);
515 #endif /* CONFIG_IEEE80211R */
516
517 struct wpa_ie_data {
518 int proto;
519 int pairwise_cipher;
520 int has_pairwise;
521 int group_cipher;
522 int has_group;
523 int key_mgmt;
524 int capabilities;
525 size_t num_pmkid;
526 const u8 *pmkid;
527 int mgmt_group_cipher;
528 };
529
530
531 int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len,
532 struct wpa_ie_data *data);
533 int wpa_parse_wpa_ie_wpa(const u8 *wpa_ie, size_t wpa_ie_len,
534 struct wpa_ie_data *data);
535 int wpa_default_rsn_cipher(int freq);
536
537 void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa,
538 u8 *pmkid, int akmp);
539 #ifdef CONFIG_SUITEB
540 int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
541 const u8 *spa, u8 *pmkid);
542 #else /* CONFIG_SUITEB */
rsn_pmkid_suite_b(const u8 * kck,size_t kck_len,const u8 * aa,const u8 * spa,u8 * pmkid)543 static inline int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
544 const u8 *spa, u8 *pmkid)
545 {
546 return -1;
547 }
548 #endif /* CONFIG_SUITEB */
549 #ifdef CONFIG_SUITEB192
550 int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len, const u8 *aa,
551 const u8 *spa, u8 *pmkid);
552 #else /* CONFIG_SUITEB192 */
rsn_pmkid_suite_b_192(const u8 * kck,size_t kck_len,const u8 * aa,const u8 * spa,u8 * pmkid)553 static inline int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len,
554 const u8 *aa, const u8 *spa, u8 *pmkid)
555 {
556 return -1;
557 }
558 #endif /* CONFIG_SUITEB192 */
559
560 const char * wpa_cipher_txt(int cipher);
561 const char * wpa_key_mgmt_txt(int key_mgmt, int proto);
562 u32 wpa_akm_to_suite(int akm);
563 int wpa_compare_rsn_ie(int ft_initial_assoc,
564 const u8 *ie1, size_t ie1len,
565 const u8 *ie2, size_t ie2len);
566 int wpa_insert_pmkid(u8 *ies, size_t *ies_len, const u8 *pmkid, bool replace);
567
568 struct wpa_ft_ies {
569 const u8 *mdie;
570 size_t mdie_len;
571 const u8 *ftie;
572 size_t ftie_len;
573 const u8 *r1kh_id;
574 const u8 *gtk;
575 size_t gtk_len;
576 const u8 *r0kh_id;
577 size_t r0kh_id_len;
578 const u8 *fte_anonce;
579 const u8 *fte_snonce;
580 bool fte_rsnxe_used;
581 unsigned int fte_elem_count;
582 const u8 *fte_mic;
583 size_t fte_mic_len;
584 const u8 *rsn;
585 size_t rsn_len;
586 u16 rsn_capab;
587 const u8 *rsn_pmkid;
588 const u8 *tie;
589 size_t tie_len;
590 const u8 *igtk;
591 size_t igtk_len;
592 const u8 *bigtk;
593 size_t bigtk_len;
594 #ifdef CONFIG_OCV
595 const u8 *oci;
596 size_t oci_len;
597 #endif /* CONFIG_OCV */
598 const u8 *ric;
599 size_t ric_len;
600 int key_mgmt;
601 int pairwise_cipher;
602 const u8 *rsnxe;
603 size_t rsnxe_len;
604 u16 valid_mlo_gtks; /* bitmap of valid link GTK subelements */
605 const u8 *mlo_gtk[MAX_NUM_MLD_LINKS];
606 size_t mlo_gtk_len[MAX_NUM_MLD_LINKS];
607 u16 valid_mlo_igtks; /* bitmap of valid link IGTK subelements */
608 const u8 *mlo_igtk[MAX_NUM_MLD_LINKS];
609 size_t mlo_igtk_len[MAX_NUM_MLD_LINKS];
610 u16 valid_mlo_bigtks; /* bitmap of valid link BIGTK subelements */
611 const u8 *mlo_bigtk[MAX_NUM_MLD_LINKS];
612 size_t mlo_bigtk_len[MAX_NUM_MLD_LINKS];
613
614 struct wpabuf *fte_buf;
615 };
616
617 /* IEEE P802.11az/D2.6 - 9.4.2.303 PASN Parameters element */
618 #define WPA_PASN_CTRL_COMEBACK_INFO_PRESENT BIT(0)
619 #define WPA_PASN_CTRL_GROUP_AND_KEY_PRESENT BIT(1)
620
621 #define WPA_PASN_WRAPPED_DATA_NO 0
622 #define WPA_PASN_WRAPPED_DATA_FT 1
623 #define WPA_PASN_WRAPPED_DATA_FILS_SK 2
624 #define WPA_PASN_WRAPPED_DATA_SAE 3
625
626 struct pasn_parameter_ie {
627 u8 id;
628 u8 len;
629 u8 id_ext;
630 u8 control; /* WPA_PASN_CTRL_* */
631 u8 wrapped_data_format; /* WPA_PASN_WRAPPED_DATA_* */
632 } STRUCT_PACKED;
633
634 struct wpa_pasn_params_data {
635 u8 wrapped_data_format;
636 u16 after;
637 u8 comeback_len;
638 const u8 *comeback;
639 u16 group;
640 u8 pubkey_len;
641 const u8 *pubkey;
642 };
643
644 /* See RFC 5480 section 2.2 */
645 #define WPA_PASN_PUBKEY_COMPRESSED_0 0x02
646 #define WPA_PASN_PUBKEY_COMPRESSED_1 0x03
647 #define WPA_PASN_PUBKEY_UNCOMPRESSED 0x04
648
649 /* WPA3 specification - RSN Selection element */
650 enum rsn_selection_variant {
651 RSN_SELECTION_RSNE = 0,
652 RSN_SELECTION_RSNE_OVERRIDE = 1,
653 RSN_SELECTION_RSNE_OVERRIDE_2 = 2,
654 };
655
656
657 int wpa_ft_parse_ies(const u8 *ies, size_t ies_len, struct wpa_ft_ies *parse,
658 int key_mgmt, bool reassoc_resp);
659 void wpa_ft_parse_ies_free(struct wpa_ft_ies *parse);
660
661 struct wpa_eapol_ie_parse {
662 const u8 *wpa_ie;
663 size_t wpa_ie_len;
664 const u8 *rsn_ie;
665 size_t rsn_ie_len;
666 const u8 *pmkid;
667 const u8 *key_id;
668 const u8 *gtk;
669 size_t gtk_len;
670 const u8 *mac_addr;
671 const u8 *igtk;
672 size_t igtk_len;
673 const u8 *bigtk;
674 size_t bigtk_len;
675 const u8 *mdie;
676 size_t mdie_len;
677 const u8 *ftie;
678 size_t ftie_len;
679 const u8 *ip_addr_req;
680 const u8 *ip_addr_alloc;
681 const u8 *transition_disable;
682 size_t transition_disable_len;
683 const u8 *dpp_kde;
684 size_t dpp_kde_len;
685 const u8 *oci;
686 size_t oci_len;
687 const u8 *osen;
688 size_t osen_len;
689 const u8 *rsnxe;
690 size_t rsnxe_len;
691 const u8 *reassoc_deadline;
692 const u8 *key_lifetime;
693 const u8 *lnkid;
694 size_t lnkid_len;
695 const u8 *ext_capab;
696 size_t ext_capab_len;
697 const u8 *supp_rates;
698 size_t supp_rates_len;
699 const u8 *ext_supp_rates;
700 size_t ext_supp_rates_len;
701 const u8 *ht_capabilities;
702 const u8 *vht_capabilities;
703 const u8 *he_capabilities;
704 size_t he_capab_len;
705 const u8 *he_6ghz_capabilities;
706 const u8 *eht_capabilities;
707 size_t eht_capab_len;
708 const u8 *supp_channels;
709 size_t supp_channels_len;
710 const u8 *supp_oper_classes;
711 size_t supp_oper_classes_len;
712 const u8 *ssid;
713 size_t ssid_len;
714 u8 qosinfo;
715 u16 aid;
716 const u8 *wmm;
717 size_t wmm_len;
718 const u8 *rsn_selection;
719 size_t rsn_selection_len;
720 const u8 *rsne_override;
721 size_t rsne_override_len;
722 const u8 *rsne_override_2;
723 size_t rsne_override_2_len;
724 const u8 *rsnxe_override;
725 size_t rsnxe_override_len;
726 u16 valid_mlo_gtks; /* bitmap of valid link GTK KDEs */
727 const u8 *mlo_gtk[MAX_NUM_MLD_LINKS];
728 size_t mlo_gtk_len[MAX_NUM_MLD_LINKS];
729 u16 valid_mlo_igtks; /* bitmap of valid link IGTK KDEs */
730 const u8 *mlo_igtk[MAX_NUM_MLD_LINKS];
731 size_t mlo_igtk_len[MAX_NUM_MLD_LINKS];
732 u16 valid_mlo_bigtks; /* bitmap of valid link BIGTK KDEs */
733 const u8 *mlo_bigtk[MAX_NUM_MLD_LINKS];
734 size_t mlo_bigtk_len[MAX_NUM_MLD_LINKS];
735 u16 valid_mlo_links; /* bitmap of valid MLO link KDEs */
736 const u8 *mlo_link[MAX_NUM_MLD_LINKS];
737 size_t mlo_link_len[MAX_NUM_MLD_LINKS];
738 const u8 *rsn_override_link[MAX_NUM_MLD_LINKS];
739 size_t rsn_override_link_len[MAX_NUM_MLD_LINKS];
740 };
741
742 int wpa_parse_kde_ies(const u8 *buf, size_t len, struct wpa_eapol_ie_parse *ie);
wpa_supplicant_parse_ies(const u8 * buf,size_t len,struct wpa_eapol_ie_parse * ie)743 static inline int wpa_supplicant_parse_ies(const u8 *buf, size_t len,
744 struct wpa_eapol_ie_parse *ie)
745 {
746 return wpa_parse_kde_ies(buf, len, ie);
747 }
748
749
750 int wpa_cipher_key_len(int cipher);
751 int wpa_cipher_rsc_len(int cipher);
752 enum wpa_alg wpa_cipher_to_alg(int cipher);
753 int wpa_cipher_valid_group(int cipher);
754 int wpa_cipher_valid_pairwise(int cipher);
755 int wpa_cipher_valid_mgmt_group(int cipher);
756 u32 wpa_cipher_to_suite(int proto, int cipher);
757 int rsn_cipher_put_suites(u8 *pos, int ciphers);
758 int wpa_cipher_put_suites(u8 *pos, int ciphers);
759 int wpa_pick_pairwise_cipher(int ciphers, int none_allowed);
760 int wpa_pick_group_cipher(int ciphers);
761 int wpa_parse_cipher(const char *value);
762 int wpa_write_ciphers(char *start, char *end, int ciphers, const char *delim);
763 int wpa_select_ap_group_cipher(int wpa, int wpa_pairwise, int rsn_pairwise);
764 unsigned int wpa_mic_len(int akmp, size_t pmk_len);
765 int wpa_use_akm_defined(int akmp);
766 int wpa_use_cmac(int akmp);
767 int wpa_use_aes_key_wrap(int akmp);
768 int fils_domain_name_hash(const char *domain, u8 *hash);
769
770 bool pasn_use_sha384(int akmp, int cipher);
771 int pasn_pmk_to_ptk(const u8 *pmk, size_t pmk_len,
772 const u8 *spa, const u8 *bssid,
773 const u8 *dhss, size_t dhss_len,
774 struct wpa_ptk *ptk, int akmp, int cipher,
775 size_t kdk_len, size_t kek_len);
776
777 u8 pasn_mic_len(int akmp, int cipher);
778
779 int pasn_mic(const u8 *kck, int akmp, int cipher,
780 const u8 *addr1, const u8 *addr2,
781 const u8 *data, size_t data_len,
782 const u8 *frame, size_t frame_len, u8 *mic);
783
784 int wpa_ltf_keyseed(struct wpa_ptk *ptk, int akmp, int cipher);
785
786 int pasn_auth_frame_hash(int akmp, int cipher, const u8 *data, size_t len,
787 u8 *hash);
788
789 void wpa_pasn_build_auth_header(struct wpabuf *buf, const u8 *bssid,
790 const u8 *src, const u8 *dst,
791 u8 trans_seq, u16 status);
792
793 int wpa_pasn_add_rsne(struct wpabuf *buf, const u8 *pmkid,
794 int akmp, int cipher);
795
796 void wpa_pasn_add_parameter_ie(struct wpabuf *buf, u16 pasn_group,
797 u8 wrapped_data_format,
798 const struct wpabuf *pubkey, bool compressed,
799 const struct wpabuf *comeback, int after);
800
801 int wpa_pasn_add_wrapped_data(struct wpabuf *buf,
802 struct wpabuf *wrapped_data_buf);
803
804 int wpa_pasn_validate_rsne(const struct wpa_ie_data *data);
805 int wpa_pasn_parse_parameter_ie(const u8 *data, u8 len, bool from_ap,
806 struct wpa_pasn_params_data *pasn_params);
807
808 void wpa_pasn_add_rsnxe(struct wpabuf *buf, u16 capab);
809 int wpa_pasn_add_extra_ies(struct wpabuf *buf, const u8 *extra_ies, size_t len);
810
811 void rsn_set_snonce_cookie(u8 *snonce);
812 bool rsn_is_snonce_cookie(const u8 *snonce);
813
814 #endif /* WPA_COMMON_H */
815