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