blob: 065dc7113de63ab25f0dfd29f26af128cf49f4d6 [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * WPA definitions shared between hostapd and wpa_supplicant
Roshan Pius3a1667e2018-07-03 15:17:14 -07003 * Copyright (c) 2002-2018, Jouni Malinen <j@w1.fi>
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 */
8
9#ifndef WPA_COMMON_H
10#define WPA_COMMON_H
11
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070012/* IEEE 802.11i */
13#define PMKID_LEN 16
14#define PMK_LEN 32
Dmitry Shmidtd80a4012015-11-05 16:35:40 -080015#define PMK_LEN_SUITE_B_192 48
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070016#define PMK_LEN_MAX 64
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070017#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
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070023#define OWE_DH_GROUP 19
24
Hai Shalomb755a2a2020-04-23 21:49:02 -070025#ifdef CONFIG_NO_TKIP
26#define WPA_ALLOWED_PAIRWISE_CIPHERS \
27(WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_NONE | \
28WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256)
29#define WPA_ALLOWED_GROUP_CIPHERS \
30(WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | \
31WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256 | \
32WPA_CIPHER_GTK_NOT_USED)
33#else /* CONFIG_NO_TKIP */
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080034#define WPA_ALLOWED_PAIRWISE_CIPHERS \
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080035(WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | WPA_CIPHER_NONE | \
36WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256)
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080037#define WPA_ALLOWED_GROUP_CIPHERS \
Dmitry Shmidt41712582015-06-29 11:02:15 -070038(WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | \
39WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256 | \
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080040WPA_CIPHER_GTK_NOT_USED)
Hai Shalomb755a2a2020-04-23 21:49:02 -070041#endif /* CONFIG_NO_TKIP */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070042#define WPA_ALLOWED_GROUP_MGMT_CIPHERS \
43(WPA_CIPHER_AES_128_CMAC | WPA_CIPHER_BIP_GMAC_128 | WPA_CIPHER_BIP_GMAC_256 | \
44WPA_CIPHER_BIP_CMAC_256)
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080045
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070046#define WPA_SELECTOR_LEN 4
47#define WPA_VERSION 1
48#define RSN_SELECTOR_LEN 4
49#define RSN_VERSION 1
50
51#define RSN_SELECTOR(a, b, c, d) \
52 ((((u32) (a)) << 24) | (((u32) (b)) << 16) | (((u32) (c)) << 8) | \
53 (u32) (d))
54
55#define WPA_AUTH_KEY_MGMT_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
56#define WPA_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
57#define WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
Dmitry Shmidtd5e49232012-12-03 15:08:10 -080058#define WPA_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070059#define WPA_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070060#define WPA_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070061#define WPA_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x50, 0xf2, 4)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070062
63
64#define RSN_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
65#define RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070066#define RSN_AUTH_KEY_MGMT_FT_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
67#define RSN_AUTH_KEY_MGMT_FT_PSK RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070068#define RSN_AUTH_KEY_MGMT_802_1X_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
69#define RSN_AUTH_KEY_MGMT_PSK_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
70#define RSN_AUTH_KEY_MGMT_TPK_HANDSHAKE RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
Dmitry Shmidtd5e49232012-12-03 15:08:10 -080071#define RSN_AUTH_KEY_MGMT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
72#define RSN_AUTH_KEY_MGMT_FT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080073#define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
Dmitry Shmidt807291d2015-01-27 13:40:23 -080074#define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B_192 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
Roshan Pius3a1667e2018-07-03 15:17:14 -070075#define RSN_AUTH_KEY_MGMT_FT_802_1X_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -080076#define RSN_AUTH_KEY_MGMT_FILS_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 14)
77#define RSN_AUTH_KEY_MGMT_FILS_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 15)
78#define RSN_AUTH_KEY_MGMT_FT_FILS_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 16)
79#define RSN_AUTH_KEY_MGMT_FT_FILS_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 17)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070080#define RSN_AUTH_KEY_MGMT_OWE RSN_SELECTOR(0x00, 0x0f, 0xac, 18)
Dmitry Shmidtd5e49232012-12-03 15:08:10 -080081#define RSN_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0x00)
Dmitry Shmidtf21452a2014-02-26 10:55:25 -080082#define RSN_AUTH_KEY_MGMT_OSEN RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x01)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070083#define RSN_AUTH_KEY_MGMT_DPP RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x02)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070084
85#define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0)
Paul Stewart092955c2017-02-06 09:13:09 -080086#define RSN_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070087#define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
88#if 0
89#define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
90#endif
91#define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
Paul Stewart092955c2017-02-06 09:13:09 -080092#define RSN_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070093#define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070094#define RSN_CIPHER_SUITE_NO_GROUP_ADDRESSED RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070095#define RSN_CIPHER_SUITE_GCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080096#define RSN_CIPHER_SUITE_GCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
97#define RSN_CIPHER_SUITE_CCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
98#define RSN_CIPHER_SUITE_BIP_GMAC_128 RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
99#define RSN_CIPHER_SUITE_BIP_GMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
100#define RSN_CIPHER_SUITE_BIP_CMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
Paul Stewart092955c2017-02-06 09:13:09 -0800101#define RSN_CIPHER_SUITE_SMS4 RSN_SELECTOR(0x00, 0x14, 0x72, 1)
102#define RSN_CIPHER_SUITE_CKIP RSN_SELECTOR(0x00, 0x40, 0x96, 0)
103#define RSN_CIPHER_SUITE_CKIP_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 1)
104#define RSN_CIPHER_SUITE_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 2)
105/* KRK is defined for nl80211 use only */
106#define RSN_CIPHER_SUITE_KRK RSN_SELECTOR(0x00, 0x40, 0x96, 255)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700107
108/* EAPOL-Key Key Data Encapsulation
109 * GroupKey and PeerKey require encryption, otherwise, encryption is optional.
110 */
111#define RSN_KEY_DATA_GROUPKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
112#if 0
113#define RSN_KEY_DATA_STAKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
114#endif
115#define RSN_KEY_DATA_MAC_ADDR RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
116#define RSN_KEY_DATA_PMKID RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700117#define RSN_KEY_DATA_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700118#define RSN_KEY_DATA_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
119#define RSN_KEY_DATA_MULTIBAND_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
120#define RSN_KEY_DATA_MULTIBAND_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
Hai Shalom74f70d42019-02-11 14:42:39 -0800121#define RSN_KEY_DATA_OCI RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
Hai Shalomfdcde762020-04-02 11:19:20 -0700122#define RSN_KEY_DATA_BIGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 14)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700123
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800124#define WFA_KEY_DATA_IP_ADDR_REQ RSN_SELECTOR(0x50, 0x6f, 0x9a, 4)
125#define WFA_KEY_DATA_IP_ADDR_ALLOC RSN_SELECTOR(0x50, 0x6f, 0x9a, 5)
Hai Shalomfdcde762020-04-02 11:19:20 -0700126#define WFA_KEY_DATA_TRANSITION_DISABLE RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x20)
Hai Shalom4fbc08f2020-05-18 12:37:00 -0700127#define WFA_KEY_DATA_DPP RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x21)
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800128
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700129#define WPA_OUI_TYPE RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
130
131#define RSN_SELECTOR_PUT(a, val) WPA_PUT_BE32((u8 *) (a), (val))
132#define RSN_SELECTOR_GET(a) WPA_GET_BE32((const u8 *) (a))
133
134#define RSN_NUM_REPLAY_COUNTERS_1 0
135#define RSN_NUM_REPLAY_COUNTERS_2 1
136#define RSN_NUM_REPLAY_COUNTERS_4 2
137#define RSN_NUM_REPLAY_COUNTERS_16 3
138
139
140#ifdef _MSC_VER
141#pragma pack(push, 1)
142#endif /* _MSC_VER */
143
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700144#define WPA_IGTK_LEN 16
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700145#define WPA_IGTK_MAX_LEN 32
Hai Shalomfdcde762020-04-02 11:19:20 -0700146#define WPA_BIGTK_LEN 16
147#define WPA_BIGTK_MAX_LEN 32
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700148
149
150/* IEEE 802.11, 7.3.2.25.3 RSN Capabilities */
151#define WPA_CAPABILITY_PREAUTH BIT(0)
152#define WPA_CAPABILITY_NO_PAIRWISE BIT(1)
153/* B2-B3: PTKSA Replay Counter */
154/* B4-B5: GTKSA Replay Counter */
155#define WPA_CAPABILITY_MFPR BIT(6)
156#define WPA_CAPABILITY_MFPC BIT(7)
157/* B8: Reserved */
158#define WPA_CAPABILITY_PEERKEY_ENABLED BIT(9)
159#define WPA_CAPABILITY_SPP_A_MSDU_CAPABLE BIT(10)
160#define WPA_CAPABILITY_SPP_A_MSDU_REQUIRED BIT(11)
161#define WPA_CAPABILITY_PBAC BIT(12)
162#define WPA_CAPABILITY_EXT_KEY_ID_FOR_UNICAST BIT(13)
Hai Shalom74f70d42019-02-11 14:42:39 -0800163#define WPA_CAPABILITY_OCVC BIT(14)
164/* B15: Reserved */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700165
166
167/* IEEE 802.11r */
168#define MOBILITY_DOMAIN_ID_LEN 2
169#define FT_R0KH_ID_MAX_LEN 48
170#define FT_R1KH_ID_LEN 6
171#define WPA_PMK_NAME_LEN 16
172
173
174/* IEEE 802.11, 8.5.2 EAPOL-Key frames */
175#define WPA_KEY_INFO_TYPE_MASK ((u16) (BIT(0) | BIT(1) | BIT(2)))
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800176#define WPA_KEY_INFO_TYPE_AKM_DEFINED 0
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700177#define WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 BIT(0)
178#define WPA_KEY_INFO_TYPE_HMAC_SHA1_AES BIT(1)
179#define WPA_KEY_INFO_TYPE_AES_128_CMAC 3
180#define WPA_KEY_INFO_KEY_TYPE BIT(3) /* 1 = Pairwise, 0 = Group key */
181/* bit4..5 is used in WPA, but is reserved in IEEE 802.11i/RSN */
182#define WPA_KEY_INFO_KEY_INDEX_MASK (BIT(4) | BIT(5))
183#define WPA_KEY_INFO_KEY_INDEX_SHIFT 4
184#define WPA_KEY_INFO_INSTALL BIT(6) /* pairwise */
185#define WPA_KEY_INFO_TXRX BIT(6) /* group */
186#define WPA_KEY_INFO_ACK BIT(7)
187#define WPA_KEY_INFO_MIC BIT(8)
188#define WPA_KEY_INFO_SECURE BIT(9)
189#define WPA_KEY_INFO_ERROR BIT(10)
190#define WPA_KEY_INFO_REQUEST BIT(11)
191#define WPA_KEY_INFO_ENCR_KEY_DATA BIT(12) /* IEEE 802.11i/RSN only */
192#define WPA_KEY_INFO_SMK_MESSAGE BIT(13)
193
194
195struct wpa_eapol_key {
196 u8 type;
197 /* Note: key_info, key_length, and key_data_length are unaligned */
198 u8 key_info[2]; /* big endian */
199 u8 key_length[2]; /* big endian */
200 u8 replay_counter[WPA_REPLAY_COUNTER_LEN];
201 u8 key_nonce[WPA_NONCE_LEN];
202 u8 key_iv[16];
203 u8 key_rsc[WPA_KEY_RSC_LEN];
204 u8 key_id[8]; /* Reserved in IEEE 802.11i/RSN */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800205 /* variable length Key MIC field */
206 /* big endian 2-octet Key Data Length field */
207 /* followed by Key Data Length bytes of Key Data */
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800208} STRUCT_PACKED;
209
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700210#define WPA_EAPOL_KEY_MIC_MAX_LEN 32
211#define WPA_KCK_MAX_LEN 32
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800212#define WPA_KEK_MAX_LEN 64
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800213#define WPA_TK_MAX_LEN 32
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800214#define FILS_ICK_MAX_LEN 48
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700215#define FILS_FT_MAX_LEN 48
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800216
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700217/**
218 * struct wpa_ptk - WPA Pairwise Transient Key
219 * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy
220 */
221struct wpa_ptk {
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800222 u8 kck[WPA_KCK_MAX_LEN]; /* EAPOL-Key Key Confirmation Key (KCK) */
223 u8 kek[WPA_KEK_MAX_LEN]; /* EAPOL-Key Key Encryption Key (KEK) */
224 u8 tk[WPA_TK_MAX_LEN]; /* Temporal Key (TK) */
Roshan Pius3a1667e2018-07-03 15:17:14 -0700225 u8 kck2[WPA_KCK_MAX_LEN]; /* FT reasoc Key Confirmation Key (KCK2) */
226 u8 kek2[WPA_KEK_MAX_LEN]; /* FT reassoc Key Encryption Key (KEK2) */
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800227 size_t kck_len;
228 size_t kek_len;
229 size_t tk_len;
Roshan Pius3a1667e2018-07-03 15:17:14 -0700230 size_t kck2_len;
231 size_t kek2_len;
Mathy Vanhoefc66556c2017-09-29 04:22:51 +0200232 int installed; /* 1 if key has already been installed to driver */
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800233};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700234
Mathy Vanhoef10bfd642017-07-12 16:03:24 +0200235struct wpa_gtk {
236 u8 gtk[WPA_GTK_MAX_LEN];
237 size_t gtk_len;
238};
239
Mathy Vanhoef10bfd642017-07-12 16:03:24 +0200240struct wpa_igtk {
241 u8 igtk[WPA_IGTK_MAX_LEN];
242 size_t igtk_len;
243};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700244
Hai Shalomfdcde762020-04-02 11:19:20 -0700245struct wpa_bigtk {
246 u8 bigtk[WPA_BIGTK_MAX_LEN];
247 size_t bigtk_len;
248};
249
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700250/* WPA IE version 1
251 * 00-50-f2:1 (OUI:OUI type)
252 * 0x01 0x00 (version; little endian)
253 * (all following fields are optional:)
254 * Group Suite Selector (4 octets) (default: TKIP)
255 * Pairwise Suite Count (2 octets, little endian) (default: 1)
256 * Pairwise Suite List (4 * n octets) (default: TKIP)
257 * Authenticated Key Management Suite Count (2 octets, little endian)
258 * (default: 1)
259 * Authenticated Key Management Suite List (4 * n octets)
260 * (default: unspec 802.1X)
261 * WPA Capabilities (2 octets, little endian) (default: 0)
262 */
263
264struct wpa_ie_hdr {
265 u8 elem_id;
266 u8 len;
267 u8 oui[4]; /* 24-bit OUI followed by 8-bit OUI type */
268 u8 version[2]; /* little endian */
269} STRUCT_PACKED;
270
271
272/* 1/4: PMKID
273 * 2/4: RSN IE
274 * 3/4: one or two RSN IEs + GTK IE (encrypted)
275 * 4/4: empty
276 * 1/2: GTK IE (encrypted)
277 * 2/2: empty
278 */
279
280/* RSN IE version 1
281 * 0x01 0x00 (version; little endian)
282 * (all following fields are optional:)
283 * Group Suite Selector (4 octets) (default: CCMP)
284 * Pairwise Suite Count (2 octets, little endian) (default: 1)
285 * Pairwise Suite List (4 * n octets) (default: CCMP)
286 * Authenticated Key Management Suite Count (2 octets, little endian)
287 * (default: 1)
288 * Authenticated Key Management Suite List (4 * n octets)
289 * (default: unspec 802.1X)
290 * RSN Capabilities (2 octets, little endian) (default: 0)
291 * PMKID Count (2 octets) (default: 0)
292 * PMKID List (16 * n octets)
293 * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
294 */
295
296struct rsn_ie_hdr {
297 u8 elem_id; /* WLAN_EID_RSN */
298 u8 len;
299 u8 version[2]; /* little endian */
300} STRUCT_PACKED;
301
302
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700303struct rsn_error_kde {
304 be16 mui;
305 be16 error_type;
306} STRUCT_PACKED;
307
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700308#define WPA_IGTK_KDE_PREFIX_LEN (2 + 6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700309struct wpa_igtk_kde {
310 u8 keyid[2];
311 u8 pn[6];
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700312 u8 igtk[WPA_IGTK_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700313} STRUCT_PACKED;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700314
Hai Shalomfdcde762020-04-02 11:19:20 -0700315#define WPA_BIGTK_KDE_PREFIX_LEN (2 + 6)
316struct wpa_bigtk_kde {
317 u8 keyid[2];
318 u8 pn[6];
319 u8 bigtk[WPA_BIGTK_MAX_LEN];
320} STRUCT_PACKED;
321
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700322struct rsn_mdie {
323 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
324 u8 ft_capab;
325} STRUCT_PACKED;
326
327#define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
328#define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
329
330struct rsn_ftie {
331 u8 mic_control[2];
332 u8 mic[16];
333 u8 anonce[WPA_NONCE_LEN];
334 u8 snonce[WPA_NONCE_LEN];
335 /* followed by optional parameters */
336} STRUCT_PACKED;
337
Roshan Pius3a1667e2018-07-03 15:17:14 -0700338struct rsn_ftie_sha384 {
339 u8 mic_control[2];
340 u8 mic[24];
341 u8 anonce[WPA_NONCE_LEN];
342 u8 snonce[WPA_NONCE_LEN];
343 /* followed by optional parameters */
344} STRUCT_PACKED;
345
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700346#define FTIE_SUBELEM_R1KH_ID 1
347#define FTIE_SUBELEM_GTK 2
348#define FTIE_SUBELEM_R0KH_ID 3
349#define FTIE_SUBELEM_IGTK 4
Hai Shalom74f70d42019-02-11 14:42:39 -0800350#define FTIE_SUBELEM_OCI 5
Hai Shalomfdcde762020-04-02 11:19:20 -0700351#define FTIE_SUBELEM_BIGTK 6
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700352
353struct rsn_rdie {
354 u8 id;
355 u8 descr_count;
356 le16 status_code;
357} STRUCT_PACKED;
358
Hai Shalomfdcde762020-04-02 11:19:20 -0700359/* WFA Transition Disable KDE (using OUI_WFA) */
360/* Transition Disable Bitmap bits */
361#define TRANSITION_DISABLE_WPA3_PERSONAL BIT(0)
362#define TRANSITION_DISABLE_SAE_PK BIT(1)
363#define TRANSITION_DISABLE_WPA3_ENTERPRISE BIT(2)
364#define TRANSITION_DISABLE_ENHANCED_OPEN BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700365
Hai Shalom4fbc08f2020-05-18 12:37:00 -0700366/* DPP KDE Flags */
367#define DPP_KDE_PFS_ALLOWED BIT(0)
368#define DPP_KDE_PFS_REQUIRED BIT(1)
369
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700370#ifdef _MSC_VER
371#pragma pack(pop)
372#endif /* _MSC_VER */
373
374
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800375int wpa_eapol_key_mic(const u8 *key, size_t key_len, int akmp, int ver,
376 const u8 *buf, size_t len, u8 *mic);
377int wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label,
378 const u8 *addr1, const u8 *addr2,
379 const u8 *nonce1, const u8 *nonce2,
Hai Shalom021b0b52019-04-10 11:17:58 -0700380 struct wpa_ptk *ptk, int akmp, int cipher,
381 const u8 *z, size_t z_len);
Paul Stewart092955c2017-02-06 09:13:09 -0800382int fils_rmsk_to_pmk(int akmp, const u8 *rmsk, size_t rmsk_len,
383 const u8 *snonce, const u8 *anonce, const u8 *dh_ss,
384 size_t dh_ss_len, u8 *pmk, size_t *pmk_len);
385int fils_pmkid_erp(int akmp, const u8 *reauth, size_t reauth_len,
386 u8 *pmkid);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800387int fils_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const u8 *spa, const u8 *aa,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700388 const u8 *snonce, const u8 *anonce, const u8 *dhss,
389 size_t dhss_len, struct wpa_ptk *ptk,
390 u8 *ick, size_t *ick_len, int akmp, int cipher,
391 u8 *fils_ft, size_t *fils_ft_len);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800392int fils_key_auth_sk(const u8 *ick, size_t ick_len, const u8 *snonce,
393 const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
394 const u8 *g_sta, size_t g_sta_len,
395 const u8 *g_ap, size_t g_ap_len,
396 int akmp, u8 *key_auth_sta, u8 *key_auth_ap,
397 size_t *key_auth_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700398
399#ifdef CONFIG_IEEE80211R
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800400int wpa_ft_mic(const u8 *kck, size_t kck_len, const u8 *sta_addr,
401 const u8 *ap_addr, u8 transaction_seqnum,
402 const u8 *mdie, size_t mdie_len,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700403 const u8 *ftie, size_t ftie_len,
404 const u8 *rsnie, size_t rsnie_len,
Hai Shalomc3565922019-10-28 11:58:20 -0700405 const u8 *ric, size_t ric_len,
406 const u8 *rsnxe, size_t rsnxe_len,
407 u8 *mic);
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800408int wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len,
409 const u8 *ssid, size_t ssid_len,
410 const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len,
Roshan Pius3a1667e2018-07-03 15:17:14 -0700411 const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name,
412 int use_sha384);
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800413int wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id,
Roshan Pius3a1667e2018-07-03 15:17:14 -0700414 const u8 *s1kh_id, u8 *pmk_r1_name, int use_sha384);
415int wpa_derive_pmk_r1(const u8 *pmk_r0, size_t pmk_r0_len,
416 const u8 *pmk_r0_name,
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800417 const u8 *r1kh_id, const u8 *s1kh_id,
418 u8 *pmk_r1, u8 *pmk_r1_name);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700419int wpa_pmk_r1_to_ptk(const u8 *pmk_r1, size_t pmk_r1_len, const u8 *snonce,
420 const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800421 const u8 *pmk_r1_name,
422 struct wpa_ptk *ptk, u8 *ptk_name, int akmp, int cipher);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700423#endif /* CONFIG_IEEE80211R */
424
425struct wpa_ie_data {
426 int proto;
427 int pairwise_cipher;
Hai Shalom021b0b52019-04-10 11:17:58 -0700428 int has_pairwise;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700429 int group_cipher;
Hai Shalom021b0b52019-04-10 11:17:58 -0700430 int has_group;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700431 int key_mgmt;
432 int capabilities;
433 size_t num_pmkid;
434 const u8 *pmkid;
435 int mgmt_group_cipher;
436};
437
438
439int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len,
440 struct wpa_ie_data *data);
441int wpa_parse_wpa_ie_wpa(const u8 *wpa_ie, size_t wpa_ie_len,
442 struct wpa_ie_data *data);
Hai Shalom021b0b52019-04-10 11:17:58 -0700443int wpa_default_rsn_cipher(int freq);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700444
445void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700446 u8 *pmkid, int akmp);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800447#ifdef CONFIG_SUITEB
448int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
449 const u8 *spa, u8 *pmkid);
450#else /* CONFIG_SUITEB */
451static inline int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
452 const u8 *spa, u8 *pmkid)
453{
454 return -1;
455}
456#endif /* CONFIG_SUITEB */
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800457#ifdef CONFIG_SUITEB192
458int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len, const u8 *aa,
459 const u8 *spa, u8 *pmkid);
460#else /* CONFIG_SUITEB192 */
461static inline int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len,
462 const u8 *aa, const u8 *spa, u8 *pmkid)
463{
464 return -1;
465}
466#endif /* CONFIG_SUITEB192 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700467
468const char * wpa_cipher_txt(int cipher);
469const char * wpa_key_mgmt_txt(int key_mgmt, int proto);
Dmitry Shmidt03658832014-08-13 11:03:49 -0700470u32 wpa_akm_to_suite(int akm);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700471int wpa_compare_rsn_ie(int ft_initial_assoc,
472 const u8 *ie1, size_t ie1len,
473 const u8 *ie2, size_t ie2len);
Dmitry Shmidt1b467752015-12-14 12:45:46 -0800474int wpa_insert_pmkid(u8 *ies, size_t *ies_len, const u8 *pmkid);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700475
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800476struct wpa_ft_ies {
477 const u8 *mdie;
478 size_t mdie_len;
479 const u8 *ftie;
480 size_t ftie_len;
481 const u8 *r1kh_id;
482 const u8 *gtk;
483 size_t gtk_len;
484 const u8 *r0kh_id;
485 size_t r0kh_id_len;
Hai Shalomc3565922019-10-28 11:58:20 -0700486 const u8 *fte_anonce;
487 const u8 *fte_snonce;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800488 const u8 *rsn;
489 size_t rsn_len;
Hai Shalomc3565922019-10-28 11:58:20 -0700490 u16 rsn_capab;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800491 const u8 *rsn_pmkid;
492 const u8 *tie;
493 size_t tie_len;
494 const u8 *igtk;
495 size_t igtk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -0700496 const u8 *bigtk;
497 size_t bigtk_len;
Hai Shalom74f70d42019-02-11 14:42:39 -0800498#ifdef CONFIG_OCV
499 const u8 *oci;
500 size_t oci_len;
501#endif /* CONFIG_OCV */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800502 const u8 *ric;
503 size_t ric_len;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800504 int key_mgmt;
505 int pairwise_cipher;
Hai Shalomc3565922019-10-28 11:58:20 -0700506 const u8 *rsnxe;
507 size_t rsnxe_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800508};
509
Roshan Pius3a1667e2018-07-03 15:17:14 -0700510int wpa_ft_parse_ies(const u8 *ies, size_t ies_len, struct wpa_ft_ies *parse,
511 int use_sha384);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800512
Hai Shalomc3565922019-10-28 11:58:20 -0700513struct wpa_eapol_ie_parse {
514 const u8 *wpa_ie;
515 size_t wpa_ie_len;
516 const u8 *rsn_ie;
517 size_t rsn_ie_len;
518 const u8 *pmkid;
Hai Shalomfdcde762020-04-02 11:19:20 -0700519 const u8 *key_id;
Hai Shalomc3565922019-10-28 11:58:20 -0700520 const u8 *gtk;
521 size_t gtk_len;
522 const u8 *mac_addr;
523 size_t mac_addr_len;
524 const u8 *igtk;
525 size_t igtk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -0700526 const u8 *bigtk;
527 size_t bigtk_len;
Hai Shalomc3565922019-10-28 11:58:20 -0700528 const u8 *mdie;
529 size_t mdie_len;
530 const u8 *ftie;
531 size_t ftie_len;
532 const u8 *ip_addr_req;
533 const u8 *ip_addr_alloc;
Hai Shalomfdcde762020-04-02 11:19:20 -0700534 const u8 *transition_disable;
535 size_t transition_disable_len;
Hai Shalom4fbc08f2020-05-18 12:37:00 -0700536 const u8 *dpp_kde;
537 size_t dpp_kde_len;
Hai Shalomc3565922019-10-28 11:58:20 -0700538 const u8 *oci;
539 size_t oci_len;
540 const u8 *osen;
541 size_t osen_len;
542 const u8 *rsnxe;
543 size_t rsnxe_len;
544 const u8 *reassoc_deadline;
545 const u8 *key_lifetime;
546 const u8 *lnkid;
547 size_t lnkid_len;
548 const u8 *ext_capab;
549 size_t ext_capab_len;
550 const u8 *supp_rates;
551 size_t supp_rates_len;
552 const u8 *ext_supp_rates;
553 size_t ext_supp_rates_len;
554 const u8 *ht_capabilities;
555 const u8 *vht_capabilities;
556 const u8 *supp_channels;
557 size_t supp_channels_len;
558 const u8 *supp_oper_classes;
559 size_t supp_oper_classes_len;
560 u8 qosinfo;
561 u16 aid;
562 const u8 *wmm;
563 size_t wmm_len;
564};
565
566int wpa_parse_kde_ies(const u8 *buf, size_t len, struct wpa_eapol_ie_parse *ie);
567static inline int wpa_supplicant_parse_ies(const u8 *buf, size_t len,
568 struct wpa_eapol_ie_parse *ie)
569{
570 return wpa_parse_kde_ies(buf, len, ie);
571}
572
573
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700574int wpa_cipher_key_len(int cipher);
575int wpa_cipher_rsc_len(int cipher);
Dmitry Shmidt29333592017-01-09 12:27:11 -0800576enum wpa_alg wpa_cipher_to_alg(int cipher);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800577int wpa_cipher_valid_group(int cipher);
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700578int wpa_cipher_valid_pairwise(int cipher);
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700579int wpa_cipher_valid_mgmt_group(int cipher);
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700580u32 wpa_cipher_to_suite(int proto, int cipher);
581int rsn_cipher_put_suites(u8 *pos, int ciphers);
582int wpa_cipher_put_suites(u8 *pos, int ciphers);
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800583int wpa_pick_pairwise_cipher(int ciphers, int none_allowed);
584int wpa_pick_group_cipher(int ciphers);
585int wpa_parse_cipher(const char *value);
586int wpa_write_ciphers(char *start, char *end, int ciphers, const char *delim);
587int wpa_select_ap_group_cipher(int wpa, int wpa_pairwise, int rsn_pairwise);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700588unsigned int wpa_mic_len(int akmp, size_t pmk_len);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700589int wpa_use_akm_defined(int akmp);
590int wpa_use_cmac(int akmp);
591int wpa_use_aes_key_wrap(int akmp);
Dmitry Shmidt29333592017-01-09 12:27:11 -0800592int fils_domain_name_hash(const char *domain, u8 *hash);
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700593
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700594#endif /* WPA_COMMON_H */