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