xref: /freebsd/contrib/wpa/src/common/wpa_common.h (revision 87b759f0fa1f7554d50ce640c40138512bbded44)
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_OSEN RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x01)
98 #define RSN_AUTH_KEY_MGMT_DPP RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x02)
99 
100 #define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0)
101 #define RSN_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
102 #define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
103 #if 0
104 #define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
105 #endif
106 #define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
107 #define RSN_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
108 #define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
109 #define RSN_CIPHER_SUITE_NO_GROUP_ADDRESSED RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
110 #define RSN_CIPHER_SUITE_GCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
111 #define RSN_CIPHER_SUITE_GCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
112 #define RSN_CIPHER_SUITE_CCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
113 #define RSN_CIPHER_SUITE_BIP_GMAC_128 RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
114 #define RSN_CIPHER_SUITE_BIP_GMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
115 #define RSN_CIPHER_SUITE_BIP_CMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
116 #define RSN_CIPHER_SUITE_SMS4 RSN_SELECTOR(0x00, 0x14, 0x72, 1)
117 #define RSN_CIPHER_SUITE_CKIP RSN_SELECTOR(0x00, 0x40, 0x96, 0)
118 #define RSN_CIPHER_SUITE_CKIP_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 1)
119 #define RSN_CIPHER_SUITE_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 2)
120 /* KRK is defined for nl80211 use only */
121 #define RSN_CIPHER_SUITE_KRK RSN_SELECTOR(0x00, 0x40, 0x96, 255)
122 
123 /* EAPOL-Key Key Data Encapsulation
124  * GroupKey and PeerKey require encryption, otherwise, encryption is optional.
125  */
126 #define RSN_KEY_DATA_GROUPKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
127 #if 0
128 #define RSN_KEY_DATA_STAKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
129 #endif
130 #define RSN_KEY_DATA_MAC_ADDR RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
131 #define RSN_KEY_DATA_PMKID RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
132 #define RSN_KEY_DATA_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
133 #define RSN_KEY_DATA_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
134 #define RSN_KEY_DATA_MULTIBAND_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
135 #define RSN_KEY_DATA_MULTIBAND_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
136 #define RSN_KEY_DATA_OCI RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
137 #define RSN_KEY_DATA_BIGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 14)
138 #define RSN_KEY_DATA_MLO_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 16)
139 #define RSN_KEY_DATA_MLO_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 17)
140 #define RSN_KEY_DATA_MLO_BIGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 18)
141 #define RSN_KEY_DATA_MLO_LINK RSN_SELECTOR(0x00, 0x0f, 0xac, 19)
142 
143 #define WFA_KEY_DATA_IP_ADDR_REQ RSN_SELECTOR(0x50, 0x6f, 0x9a, 4)
144 #define WFA_KEY_DATA_IP_ADDR_ALLOC RSN_SELECTOR(0x50, 0x6f, 0x9a, 5)
145 #define WFA_KEY_DATA_TRANSITION_DISABLE RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x20)
146 #define WFA_KEY_DATA_DPP RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x21)
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 ltf_keyseed_len;
271 	int installed; /* 1 if key has already been installed to driver */
272 };
273 
274 struct wpa_gtk {
275 	u8 gtk[WPA_GTK_MAX_LEN];
276 	size_t gtk_len;
277 };
278 
279 struct wpa_igtk {
280 	u8 igtk[WPA_IGTK_MAX_LEN];
281 	size_t igtk_len;
282 };
283 
284 struct wpa_bigtk {
285 	u8 bigtk[WPA_BIGTK_MAX_LEN];
286 	size_t bigtk_len;
287 };
288 
289 /* WPA IE version 1
290  * 00-50-f2:1 (OUI:OUI type)
291  * 0x01 0x00 (version; little endian)
292  * (all following fields are optional:)
293  * Group Suite Selector (4 octets) (default: TKIP)
294  * Pairwise Suite Count (2 octets, little endian) (default: 1)
295  * Pairwise Suite List (4 * n octets) (default: TKIP)
296  * Authenticated Key Management Suite Count (2 octets, little endian)
297  *    (default: 1)
298  * Authenticated Key Management Suite List (4 * n octets)
299  *    (default: unspec 802.1X)
300  * WPA Capabilities (2 octets, little endian) (default: 0)
301  */
302 
303 struct wpa_ie_hdr {
304 	u8 elem_id;
305 	u8 len;
306 	u8 oui[4]; /* 24-bit OUI followed by 8-bit OUI type */
307 	u8 version[2]; /* little endian */
308 } STRUCT_PACKED;
309 
310 
311 /* 1/4: PMKID
312  * 2/4: RSN IE
313  * 3/4: one or two RSN IEs + GTK IE (encrypted)
314  * 4/4: empty
315  * 1/2: GTK IE (encrypted)
316  * 2/2: empty
317  */
318 
319 /* RSN IE version 1
320  * 0x01 0x00 (version; little endian)
321  * (all following fields are optional:)
322  * Group Suite Selector (4 octets) (default: CCMP)
323  * Pairwise Suite Count (2 octets, little endian) (default: 1)
324  * Pairwise Suite List (4 * n octets) (default: CCMP)
325  * Authenticated Key Management Suite Count (2 octets, little endian)
326  *    (default: 1)
327  * Authenticated Key Management Suite List (4 * n octets)
328  *    (default: unspec 802.1X)
329  * RSN Capabilities (2 octets, little endian) (default: 0)
330  * PMKID Count (2 octets) (default: 0)
331  * PMKID List (16 * n octets)
332  * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
333  */
334 
335 struct rsn_ie_hdr {
336 	u8 elem_id; /* WLAN_EID_RSN */
337 	u8 len;
338 	u8 version[2]; /* little endian */
339 } STRUCT_PACKED;
340 
341 
342 #define KDE_HDR_LEN (1 + 1 + RSN_SELECTOR_LEN)
343 
344 struct rsn_error_kde {
345 	be16 mui;
346 	be16 error_type;
347 } STRUCT_PACKED;
348 
349 #define WPA_IGTK_KDE_PREFIX_LEN (2 + RSN_PN_LEN)
350 struct wpa_igtk_kde {
351 	u8 keyid[2];
352 	u8 pn[RSN_PN_LEN];
353 	u8 igtk[WPA_IGTK_MAX_LEN];
354 } STRUCT_PACKED;
355 
356 #define WPA_BIGTK_KDE_PREFIX_LEN (2 + RSN_PN_LEN)
357 struct wpa_bigtk_kde {
358 	u8 keyid[2];
359 	u8 pn[RSN_PN_LEN];
360 	u8 bigtk[WPA_BIGTK_MAX_LEN];
361 } STRUCT_PACKED;
362 
363 #define RSN_MLO_GTK_KDE_PREFIX_LENGTH		(1 + RSN_PN_LEN)
364 #define RSN_MLO_GTK_KDE_PREFIX0_KEY_ID_MASK	0x03
365 #define RSN_MLO_GTK_KDE_PREFIX0_TX		0x04
366 #define RSN_MLO_GTK_KDE_PREFIX0_LINK_ID_SHIFT	4
367 #define RSN_MLO_GTK_KDE_PREFIX0_LINK_ID_MASK	0xF0
368 
369 #define RSN_MLO_IGTK_KDE_PREFIX_LENGTH		(2 + RSN_PN_LEN + 1)
370 #define RSN_MLO_IGTK_KDE_PREFIX8_LINK_ID_SHIFT	4
371 #define RSN_MLO_IGTK_KDE_PREFIX8_LINK_ID_MASK	0xF0
372 struct rsn_mlo_igtk_kde {
373 	u8 keyid[2];
374 	u8 pn[RSN_PN_LEN];
375 	u8 prefix8;
376 	u8 igtk[WPA_IGTK_MAX_LEN];
377 } STRUCT_PACKED;
378 
379 #define RSN_MLO_BIGTK_KDE_PREFIX_LENGTH		(2 + RSN_PN_LEN + 1)
380 #define RSN_MLO_BIGTK_KDE_PREFIX8_LINK_ID_SHIFT	4
381 #define RSN_MLO_BIGTK_KDE_PREFIX8_LINK_ID_MASK	0xF0
382 struct rsn_mlo_bigtk_kde {
383 	u8 keyid[2];
384 	u8 pn[RSN_PN_LEN];
385 	u8 prefix8;
386 	u8 bigtk[WPA_BIGTK_MAX_LEN];
387 } STRUCT_PACKED;
388 
389 #define RSN_MLO_LINK_KDE_FIXED_LENGTH		(1 + ETH_ALEN)
390 #define RSN_MLO_LINK_KDE_LINK_INFO_INDEX	0
391 #define RSN_MLO_LINK_KDE_LI_LINK_ID_SHIFT	0
392 #define RSN_MLO_LINK_KDE_LI_LINK_ID_MASK	0x0F
393 #define RSN_MLO_LINK_KDE_LI_RSNE_INFO		0x10
394 #define RSN_MLO_LINK_KDE_LI_RSNXE_INFO		0x20
395 #define RSN_MLO_LINK_KDE_LINK_MAC_INDEX		1
396 
397 struct rsn_mdie {
398 	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
399 	u8 ft_capab;
400 } STRUCT_PACKED;
401 
402 #define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
403 #define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
404 
405 struct rsn_ftie {
406 	u8 mic_control[2];
407 	u8 mic[16];
408 	u8 anonce[WPA_NONCE_LEN];
409 	u8 snonce[WPA_NONCE_LEN];
410 	/* followed by optional parameters */
411 } STRUCT_PACKED;
412 
413 struct rsn_ftie_sha384 {
414 	u8 mic_control[2];
415 	u8 mic[24];
416 	u8 anonce[WPA_NONCE_LEN];
417 	u8 snonce[WPA_NONCE_LEN];
418 	/* followed by optional parameters */
419 } STRUCT_PACKED;
420 
421 struct rsn_ftie_sha512 {
422 	u8 mic_control[2];
423 	u8 mic[32];
424 	u8 anonce[WPA_NONCE_LEN];
425 	u8 snonce[WPA_NONCE_LEN];
426 	/* followed by optional parameters */
427 } STRUCT_PACKED;
428 
429 #define FTIE_SUBELEM_R1KH_ID 1
430 #define FTIE_SUBELEM_GTK 2
431 #define FTIE_SUBELEM_R0KH_ID 3
432 #define FTIE_SUBELEM_IGTK 4
433 #define FTIE_SUBELEM_OCI 5
434 #define FTIE_SUBELEM_BIGTK 6
435 #define FTIE_SUBELEM_MLO_GTK 8
436 #define FTIE_SUBELEM_MLO_IGTK 9
437 #define FTIE_SUBELEM_MLO_BIGTK 10
438 
439 struct rsn_rdie {
440 	u8 id;
441 	u8 descr_count;
442 	le16 status_code;
443 } STRUCT_PACKED;
444 
445 /* WFA Transition Disable KDE (using OUI_WFA) */
446 /* Transition Disable Bitmap bits */
447 #define TRANSITION_DISABLE_WPA3_PERSONAL BIT(0)
448 #define TRANSITION_DISABLE_SAE_PK BIT(1)
449 #define TRANSITION_DISABLE_WPA3_ENTERPRISE BIT(2)
450 #define TRANSITION_DISABLE_ENHANCED_OPEN BIT(3)
451 
452 /* DPP KDE Flags */
453 #define DPP_KDE_PFS_ALLOWED BIT(0)
454 #define DPP_KDE_PFS_REQUIRED BIT(1)
455 
456 #ifdef _MSC_VER
457 #pragma pack(pop)
458 #endif /* _MSC_VER */
459 
460 
461 int wpa_eapol_key_mic(const u8 *key, size_t key_len, int akmp, int ver,
462 		      const u8 *buf, size_t len, u8 *mic);
463 int wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label,
464 		   const u8 *addr1, const u8 *addr2,
465 		   const u8 *nonce1, const u8 *nonce2,
466 		   struct wpa_ptk *ptk, int akmp, int cipher,
467 		   const u8 *z, size_t z_len, size_t kdk_len);
468 int fils_rmsk_to_pmk(int akmp, const u8 *rmsk, size_t rmsk_len,
469 		     const u8 *snonce, const u8 *anonce, const u8 *dh_ss,
470 		     size_t dh_ss_len, u8 *pmk, size_t *pmk_len);
471 int fils_pmkid_erp(int akmp, const u8 *reauth, size_t reauth_len,
472 		   u8 *pmkid);
473 int fils_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const u8 *spa, const u8 *aa,
474 		    const u8 *snonce, const u8 *anonce, const u8 *dhss,
475 		    size_t dhss_len, struct wpa_ptk *ptk,
476 		    u8 *ick, size_t *ick_len, int akmp, int cipher,
477 		    u8 *fils_ft, size_t *fils_ft_len, size_t kdk_len);
478 int fils_key_auth_sk(const u8 *ick, size_t ick_len, const u8 *snonce,
479 		     const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
480 		     const u8 *g_sta, size_t g_sta_len,
481 		     const u8 *g_ap, size_t g_ap_len,
482 		     int akmp, u8 *key_auth_sta, u8 *key_auth_ap,
483 		     size_t *key_auth_len);
484 
485 #ifdef CONFIG_IEEE80211R
486 int wpa_ft_mic(int key_mgmt, const u8 *kck, size_t kck_len, const u8 *sta_addr,
487 	       const u8 *ap_addr, u8 transaction_seqnum,
488 	       const u8 *mdie, size_t mdie_len,
489 	       const u8 *ftie, size_t ftie_len,
490 	       const u8 *rsnie, size_t rsnie_len,
491 	       const u8 *ric, size_t ric_len,
492 	       const u8 *rsnxe, size_t rsnxe_len,
493 	       const struct wpabuf *extra,
494 	       u8 *mic);
495 int wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len,
496 		      const u8 *ssid, size_t ssid_len,
497 		      const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len,
498 		      const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name,
499 		      int key_mgmt);
500 int wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id,
501 			   const u8 *s1kh_id, u8 *pmk_r1_name,
502 			   size_t pmk_r1_len);
503 int wpa_derive_pmk_r1(const u8 *pmk_r0, size_t pmk_r0_len,
504 		      const u8 *pmk_r0_name,
505 		      const u8 *r1kh_id, const u8 *s1kh_id,
506 		      u8 *pmk_r1, u8 *pmk_r1_name);
507 int wpa_pmk_r1_to_ptk(const u8 *pmk_r1, size_t pmk_r1_len, const u8 *snonce,
508 		      const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
509 		      const u8 *pmk_r1_name,
510 		      struct wpa_ptk *ptk, u8 *ptk_name, int akmp, int cipher,
511 		      size_t kdk_len);
512 #endif /* CONFIG_IEEE80211R */
513 
514 struct wpa_ie_data {
515 	int proto;
516 	int pairwise_cipher;
517 	int has_pairwise;
518 	int group_cipher;
519 	int has_group;
520 	int key_mgmt;
521 	int capabilities;
522 	size_t num_pmkid;
523 	const u8 *pmkid;
524 	int mgmt_group_cipher;
525 };
526 
527 
528 int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len,
529 			 struct wpa_ie_data *data);
530 int wpa_parse_wpa_ie_wpa(const u8 *wpa_ie, size_t wpa_ie_len,
531 			 struct wpa_ie_data *data);
532 int wpa_default_rsn_cipher(int freq);
533 
534 void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa,
535 	       u8 *pmkid, int akmp);
536 #ifdef CONFIG_SUITEB
537 int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
538 		       const u8 *spa, u8 *pmkid);
539 #else /* CONFIG_SUITEB */
540 static inline int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
541 				    const u8 *spa, u8 *pmkid)
542 {
543 	return -1;
544 }
545 #endif /* CONFIG_SUITEB */
546 #ifdef CONFIG_SUITEB192
547 int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len, const u8 *aa,
548 			  const u8 *spa, u8 *pmkid);
549 #else /* CONFIG_SUITEB192 */
550 static inline int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len,
551 					const u8 *aa, const u8 *spa, u8 *pmkid)
552 {
553 	return -1;
554 }
555 #endif /* CONFIG_SUITEB192 */
556 
557 const char * wpa_cipher_txt(int cipher);
558 const char * wpa_key_mgmt_txt(int key_mgmt, int proto);
559 u32 wpa_akm_to_suite(int akm);
560 int wpa_compare_rsn_ie(int ft_initial_assoc,
561 		       const u8 *ie1, size_t ie1len,
562 		       const u8 *ie2, size_t ie2len);
563 int wpa_insert_pmkid(u8 *ies, size_t *ies_len, const u8 *pmkid, bool replace);
564 
565 struct wpa_ft_ies {
566 	const u8 *mdie;
567 	size_t mdie_len;
568 	const u8 *ftie;
569 	size_t ftie_len;
570 	const u8 *r1kh_id;
571 	const u8 *gtk;
572 	size_t gtk_len;
573 	const u8 *r0kh_id;
574 	size_t r0kh_id_len;
575 	const u8 *fte_anonce;
576 	const u8 *fte_snonce;
577 	bool fte_rsnxe_used;
578 	unsigned int fte_elem_count;
579 	const u8 *fte_mic;
580 	size_t fte_mic_len;
581 	const u8 *rsn;
582 	size_t rsn_len;
583 	u16 rsn_capab;
584 	const u8 *rsn_pmkid;
585 	const u8 *tie;
586 	size_t tie_len;
587 	const u8 *igtk;
588 	size_t igtk_len;
589 	const u8 *bigtk;
590 	size_t bigtk_len;
591 #ifdef CONFIG_OCV
592 	const u8 *oci;
593 	size_t oci_len;
594 #endif /* CONFIG_OCV */
595 	const u8 *ric;
596 	size_t ric_len;
597 	int key_mgmt;
598 	int pairwise_cipher;
599 	const u8 *rsnxe;
600 	size_t rsnxe_len;
601 	u16 valid_mlo_gtks; /* bitmap of valid link GTK subelements */
602 	const u8 *mlo_gtk[MAX_NUM_MLD_LINKS];
603 	size_t mlo_gtk_len[MAX_NUM_MLD_LINKS];
604 	u16 valid_mlo_igtks; /* bitmap of valid link IGTK subelements */
605 	const u8 *mlo_igtk[MAX_NUM_MLD_LINKS];
606 	size_t mlo_igtk_len[MAX_NUM_MLD_LINKS];
607 	u16 valid_mlo_bigtks; /* bitmap of valid link BIGTK subelements */
608 	const u8 *mlo_bigtk[MAX_NUM_MLD_LINKS];
609 	size_t mlo_bigtk_len[MAX_NUM_MLD_LINKS];
610 
611 	struct wpabuf *fte_buf;
612 };
613 
614 /* IEEE P802.11az/D2.6 - 9.4.2.303 PASN Parameters element */
615 #define WPA_PASN_CTRL_COMEBACK_INFO_PRESENT BIT(0)
616 #define WPA_PASN_CTRL_GROUP_AND_KEY_PRESENT BIT(1)
617 
618 #define WPA_PASN_WRAPPED_DATA_NO      0
619 #define WPA_PASN_WRAPPED_DATA_FT      1
620 #define WPA_PASN_WRAPPED_DATA_FILS_SK 2
621 #define WPA_PASN_WRAPPED_DATA_SAE     3
622 
623 struct pasn_parameter_ie {
624 	u8 id;
625 	u8 len;
626 	u8 id_ext;
627 	u8 control; /* WPA_PASN_CTRL_* */
628 	u8 wrapped_data_format; /* WPA_PASN_WRAPPED_DATA_* */
629 } STRUCT_PACKED;
630 
631 struct wpa_pasn_params_data {
632 	u8 wrapped_data_format;
633 	u16 after;
634 	u8 comeback_len;
635 	const u8 *comeback;
636 	u16 group;
637 	u8 pubkey_len;
638 	const u8 *pubkey;
639 };
640 
641 /* See RFC 5480 section 2.2 */
642 #define WPA_PASN_PUBKEY_COMPRESSED_0 0x02
643 #define WPA_PASN_PUBKEY_COMPRESSED_1 0x03
644 #define WPA_PASN_PUBKEY_UNCOMPRESSED 0x04
645 
646 int wpa_ft_parse_ies(const u8 *ies, size_t ies_len, struct wpa_ft_ies *parse,
647 		     int key_mgmt, bool reassoc_resp);
648 void wpa_ft_parse_ies_free(struct wpa_ft_ies *parse);
649 
650 struct wpa_eapol_ie_parse {
651 	const u8 *wpa_ie;
652 	size_t wpa_ie_len;
653 	const u8 *rsn_ie;
654 	size_t rsn_ie_len;
655 	const u8 *pmkid;
656 	const u8 *key_id;
657 	const u8 *gtk;
658 	size_t gtk_len;
659 	const u8 *mac_addr;
660 	const u8 *igtk;
661 	size_t igtk_len;
662 	const u8 *bigtk;
663 	size_t bigtk_len;
664 	const u8 *mdie;
665 	size_t mdie_len;
666 	const u8 *ftie;
667 	size_t ftie_len;
668 	const u8 *ip_addr_req;
669 	const u8 *ip_addr_alloc;
670 	const u8 *transition_disable;
671 	size_t transition_disable_len;
672 	const u8 *dpp_kde;
673 	size_t dpp_kde_len;
674 	const u8 *oci;
675 	size_t oci_len;
676 	const u8 *osen;
677 	size_t osen_len;
678 	const u8 *rsnxe;
679 	size_t rsnxe_len;
680 	const u8 *reassoc_deadline;
681 	const u8 *key_lifetime;
682 	const u8 *lnkid;
683 	size_t lnkid_len;
684 	const u8 *ext_capab;
685 	size_t ext_capab_len;
686 	const u8 *supp_rates;
687 	size_t supp_rates_len;
688 	const u8 *ext_supp_rates;
689 	size_t ext_supp_rates_len;
690 	const u8 *ht_capabilities;
691 	const u8 *vht_capabilities;
692 	const u8 *he_capabilities;
693 	size_t he_capab_len;
694 	const u8 *he_6ghz_capabilities;
695 	const u8 *eht_capabilities;
696 	size_t eht_capab_len;
697 	const u8 *supp_channels;
698 	size_t supp_channels_len;
699 	const u8 *supp_oper_classes;
700 	size_t supp_oper_classes_len;
701 	const u8 *ssid;
702 	size_t ssid_len;
703 	u8 qosinfo;
704 	u16 aid;
705 	const u8 *wmm;
706 	size_t wmm_len;
707 	u16 valid_mlo_gtks; /* bitmap of valid link GTK KDEs */
708 	const u8 *mlo_gtk[MAX_NUM_MLD_LINKS];
709 	size_t mlo_gtk_len[MAX_NUM_MLD_LINKS];
710 	u16 valid_mlo_igtks; /* bitmap of valid link IGTK KDEs */
711 	const u8 *mlo_igtk[MAX_NUM_MLD_LINKS];
712 	size_t mlo_igtk_len[MAX_NUM_MLD_LINKS];
713 	u16 valid_mlo_bigtks; /* bitmap of valid link BIGTK KDEs */
714 	const u8 *mlo_bigtk[MAX_NUM_MLD_LINKS];
715 	size_t mlo_bigtk_len[MAX_NUM_MLD_LINKS];
716 	u16 valid_mlo_links; /* bitmap of valid MLO link KDEs */
717 	const u8 *mlo_link[MAX_NUM_MLD_LINKS];
718 	size_t mlo_link_len[MAX_NUM_MLD_LINKS];
719 };
720 
721 int wpa_parse_kde_ies(const u8 *buf, size_t len, struct wpa_eapol_ie_parse *ie);
722 static inline int wpa_supplicant_parse_ies(const u8 *buf, size_t len,
723 					   struct wpa_eapol_ie_parse *ie)
724 {
725 	return wpa_parse_kde_ies(buf, len, ie);
726 }
727 
728 
729 int wpa_cipher_key_len(int cipher);
730 int wpa_cipher_rsc_len(int cipher);
731 enum wpa_alg wpa_cipher_to_alg(int cipher);
732 int wpa_cipher_valid_group(int cipher);
733 int wpa_cipher_valid_pairwise(int cipher);
734 int wpa_cipher_valid_mgmt_group(int cipher);
735 u32 wpa_cipher_to_suite(int proto, int cipher);
736 int rsn_cipher_put_suites(u8 *pos, int ciphers);
737 int wpa_cipher_put_suites(u8 *pos, int ciphers);
738 int wpa_pick_pairwise_cipher(int ciphers, int none_allowed);
739 int wpa_pick_group_cipher(int ciphers);
740 int wpa_parse_cipher(const char *value);
741 int wpa_write_ciphers(char *start, char *end, int ciphers, const char *delim);
742 int wpa_select_ap_group_cipher(int wpa, int wpa_pairwise, int rsn_pairwise);
743 unsigned int wpa_mic_len(int akmp, size_t pmk_len);
744 int wpa_use_akm_defined(int akmp);
745 int wpa_use_cmac(int akmp);
746 int wpa_use_aes_key_wrap(int akmp);
747 int fils_domain_name_hash(const char *domain, u8 *hash);
748 
749 bool pasn_use_sha384(int akmp, int cipher);
750 int pasn_pmk_to_ptk(const u8 *pmk, size_t pmk_len,
751 		    const u8 *spa, const u8 *bssid,
752 		    const u8 *dhss, size_t dhss_len,
753 		    struct wpa_ptk *ptk, int akmp, int cipher,
754 		    size_t kdk_len);
755 
756 u8 pasn_mic_len(int akmp, int cipher);
757 
758 int pasn_mic(const u8 *kck, int akmp, int cipher,
759 	     const u8 *addr1, const u8 *addr2,
760 	     const u8 *data, size_t data_len,
761 	     const u8 *frame, size_t frame_len, u8 *mic);
762 
763 int wpa_ltf_keyseed(struct wpa_ptk *ptk, int akmp, int cipher);
764 
765 int pasn_auth_frame_hash(int akmp, int cipher, const u8 *data, size_t len,
766 			 u8 *hash);
767 
768 void wpa_pasn_build_auth_header(struct wpabuf *buf, const u8 *bssid,
769 				const u8 *src, const u8 *dst,
770 				u8 trans_seq, u16 status);
771 
772 int wpa_pasn_add_rsne(struct wpabuf *buf, const u8 *pmkid,
773 		      int akmp, int cipher);
774 
775 void wpa_pasn_add_parameter_ie(struct wpabuf *buf, u16 pasn_group,
776 			       u8 wrapped_data_format,
777 			       const struct wpabuf *pubkey, bool compressed,
778 			       const struct wpabuf *comeback, int after);
779 
780 int wpa_pasn_add_wrapped_data(struct wpabuf *buf,
781 			      struct wpabuf *wrapped_data_buf);
782 
783 int wpa_pasn_validate_rsne(const struct wpa_ie_data *data);
784 int wpa_pasn_parse_parameter_ie(const u8 *data, u8 len, bool from_ap,
785 				struct wpa_pasn_params_data *pasn_params);
786 
787 void wpa_pasn_add_rsnxe(struct wpabuf *buf, u16 capab);
788 int wpa_pasn_add_extra_ies(struct wpabuf *buf, const u8 *extra_ies, size_t len);
789 
790 #endif /* WPA_COMMON_H */
791