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