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