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