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