blob: da58159e4316be107d4b854e169660b799e10344 [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
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080025#define WPA_ALLOWED_PAIRWISE_CIPHERS \
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080026(WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | WPA_CIPHER_NONE | \
27WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256)
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080028#define WPA_ALLOWED_GROUP_CIPHERS \
Dmitry Shmidt41712582015-06-29 11:02:15 -070029(WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | \
30WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256 | \
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080031WPA_CIPHER_GTK_NOT_USED)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070032#define WPA_ALLOWED_GROUP_MGMT_CIPHERS \
33(WPA_CIPHER_AES_128_CMAC | WPA_CIPHER_BIP_GMAC_128 | WPA_CIPHER_BIP_GMAC_256 | \
34WPA_CIPHER_BIP_CMAC_256)
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -080035
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070036#define WPA_SELECTOR_LEN 4
37#define WPA_VERSION 1
38#define RSN_SELECTOR_LEN 4
39#define RSN_VERSION 1
40
41#define RSN_SELECTOR(a, b, c, d) \
42 ((((u32) (a)) << 24) | (((u32) (b)) << 16) | (((u32) (c)) << 8) | \
43 (u32) (d))
44
45#define WPA_AUTH_KEY_MGMT_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
46#define WPA_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
47#define WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
Dmitry Shmidtd5e49232012-12-03 15:08:10 -080048#define WPA_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070049#define WPA_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070050#define WPA_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070051#define WPA_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x50, 0xf2, 4)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070052
53
54#define RSN_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
55#define RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070056#define RSN_AUTH_KEY_MGMT_FT_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
57#define RSN_AUTH_KEY_MGMT_FT_PSK RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070058#define RSN_AUTH_KEY_MGMT_802_1X_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
59#define RSN_AUTH_KEY_MGMT_PSK_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
60#define RSN_AUTH_KEY_MGMT_TPK_HANDSHAKE RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
Dmitry Shmidtd5e49232012-12-03 15:08:10 -080061#define RSN_AUTH_KEY_MGMT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
62#define RSN_AUTH_KEY_MGMT_FT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080063#define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
Dmitry Shmidt807291d2015-01-27 13:40:23 -080064#define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B_192 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
Roshan Pius3a1667e2018-07-03 15:17:14 -070065#define RSN_AUTH_KEY_MGMT_FT_802_1X_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -080066#define RSN_AUTH_KEY_MGMT_FILS_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 14)
67#define RSN_AUTH_KEY_MGMT_FILS_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 15)
68#define RSN_AUTH_KEY_MGMT_FT_FILS_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 16)
69#define RSN_AUTH_KEY_MGMT_FT_FILS_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 17)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070070#define RSN_AUTH_KEY_MGMT_OWE RSN_SELECTOR(0x00, 0x0f, 0xac, 18)
Dmitry Shmidtd5e49232012-12-03 15:08:10 -080071#define RSN_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0x00)
Dmitry Shmidtf21452a2014-02-26 10:55:25 -080072#define RSN_AUTH_KEY_MGMT_OSEN RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x01)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070073#define RSN_AUTH_KEY_MGMT_DPP RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x02)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070074
75#define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0)
Paul Stewart092955c2017-02-06 09:13:09 -080076#define RSN_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070077#define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
78#if 0
79#define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
80#endif
81#define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
Paul Stewart092955c2017-02-06 09:13:09 -080082#define RSN_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070083#define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070084#define RSN_CIPHER_SUITE_NO_GROUP_ADDRESSED RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -070085#define RSN_CIPHER_SUITE_GCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -080086#define RSN_CIPHER_SUITE_GCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
87#define RSN_CIPHER_SUITE_CCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
88#define RSN_CIPHER_SUITE_BIP_GMAC_128 RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
89#define RSN_CIPHER_SUITE_BIP_GMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
90#define RSN_CIPHER_SUITE_BIP_CMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
Paul Stewart092955c2017-02-06 09:13:09 -080091#define RSN_CIPHER_SUITE_SMS4 RSN_SELECTOR(0x00, 0x14, 0x72, 1)
92#define RSN_CIPHER_SUITE_CKIP RSN_SELECTOR(0x00, 0x40, 0x96, 0)
93#define RSN_CIPHER_SUITE_CKIP_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 1)
94#define RSN_CIPHER_SUITE_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 2)
95/* KRK is defined for nl80211 use only */
96#define RSN_CIPHER_SUITE_KRK RSN_SELECTOR(0x00, 0x40, 0x96, 255)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070097
98/* EAPOL-Key Key Data Encapsulation
99 * GroupKey and PeerKey require encryption, otherwise, encryption is optional.
100 */
101#define RSN_KEY_DATA_GROUPKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
102#if 0
103#define RSN_KEY_DATA_STAKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
104#endif
105#define RSN_KEY_DATA_MAC_ADDR RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
106#define RSN_KEY_DATA_PMKID RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700107#define RSN_KEY_DATA_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700108#define RSN_KEY_DATA_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
109#define RSN_KEY_DATA_MULTIBAND_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
110#define RSN_KEY_DATA_MULTIBAND_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
Hai Shalom74f70d42019-02-11 14:42:39 -0800111#define RSN_KEY_DATA_OCI RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
Hai Shalomfdcde762020-04-02 11:19:20 -0700112#define RSN_KEY_DATA_BIGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 14)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700113
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800114#define WFA_KEY_DATA_IP_ADDR_REQ RSN_SELECTOR(0x50, 0x6f, 0x9a, 4)
115#define WFA_KEY_DATA_IP_ADDR_ALLOC RSN_SELECTOR(0x50, 0x6f, 0x9a, 5)
Hai Shalomfdcde762020-04-02 11:19:20 -0700116#define WFA_KEY_DATA_TRANSITION_DISABLE RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x20)
Dmitry Shmidtcf32e602014-01-28 10:57:39 -0800117
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700118#define WPA_OUI_TYPE RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
119
120#define RSN_SELECTOR_PUT(a, val) WPA_PUT_BE32((u8 *) (a), (val))
121#define RSN_SELECTOR_GET(a) WPA_GET_BE32((const u8 *) (a))
122
123#define RSN_NUM_REPLAY_COUNTERS_1 0
124#define RSN_NUM_REPLAY_COUNTERS_2 1
125#define RSN_NUM_REPLAY_COUNTERS_4 2
126#define RSN_NUM_REPLAY_COUNTERS_16 3
127
128
129#ifdef _MSC_VER
130#pragma pack(push, 1)
131#endif /* _MSC_VER */
132
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700133#define WPA_IGTK_LEN 16
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700134#define WPA_IGTK_MAX_LEN 32
Hai Shalomfdcde762020-04-02 11:19:20 -0700135#define WPA_BIGTK_LEN 16
136#define WPA_BIGTK_MAX_LEN 32
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700137
138
139/* IEEE 802.11, 7.3.2.25.3 RSN Capabilities */
140#define WPA_CAPABILITY_PREAUTH BIT(0)
141#define WPA_CAPABILITY_NO_PAIRWISE BIT(1)
142/* B2-B3: PTKSA Replay Counter */
143/* B4-B5: GTKSA Replay Counter */
144#define WPA_CAPABILITY_MFPR BIT(6)
145#define WPA_CAPABILITY_MFPC BIT(7)
146/* B8: Reserved */
147#define WPA_CAPABILITY_PEERKEY_ENABLED BIT(9)
148#define WPA_CAPABILITY_SPP_A_MSDU_CAPABLE BIT(10)
149#define WPA_CAPABILITY_SPP_A_MSDU_REQUIRED BIT(11)
150#define WPA_CAPABILITY_PBAC BIT(12)
151#define WPA_CAPABILITY_EXT_KEY_ID_FOR_UNICAST BIT(13)
Hai Shalom74f70d42019-02-11 14:42:39 -0800152#define WPA_CAPABILITY_OCVC BIT(14)
153/* B15: Reserved */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700154
155
156/* IEEE 802.11r */
157#define MOBILITY_DOMAIN_ID_LEN 2
158#define FT_R0KH_ID_MAX_LEN 48
159#define FT_R1KH_ID_LEN 6
160#define WPA_PMK_NAME_LEN 16
161
162
163/* IEEE 802.11, 8.5.2 EAPOL-Key frames */
164#define WPA_KEY_INFO_TYPE_MASK ((u16) (BIT(0) | BIT(1) | BIT(2)))
Dmitry Shmidtf21452a2014-02-26 10:55:25 -0800165#define WPA_KEY_INFO_TYPE_AKM_DEFINED 0
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700166#define WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 BIT(0)
167#define WPA_KEY_INFO_TYPE_HMAC_SHA1_AES BIT(1)
168#define WPA_KEY_INFO_TYPE_AES_128_CMAC 3
169#define WPA_KEY_INFO_KEY_TYPE BIT(3) /* 1 = Pairwise, 0 = Group key */
170/* bit4..5 is used in WPA, but is reserved in IEEE 802.11i/RSN */
171#define WPA_KEY_INFO_KEY_INDEX_MASK (BIT(4) | BIT(5))
172#define WPA_KEY_INFO_KEY_INDEX_SHIFT 4
173#define WPA_KEY_INFO_INSTALL BIT(6) /* pairwise */
174#define WPA_KEY_INFO_TXRX BIT(6) /* group */
175#define WPA_KEY_INFO_ACK BIT(7)
176#define WPA_KEY_INFO_MIC BIT(8)
177#define WPA_KEY_INFO_SECURE BIT(9)
178#define WPA_KEY_INFO_ERROR BIT(10)
179#define WPA_KEY_INFO_REQUEST BIT(11)
180#define WPA_KEY_INFO_ENCR_KEY_DATA BIT(12) /* IEEE 802.11i/RSN only */
181#define WPA_KEY_INFO_SMK_MESSAGE BIT(13)
182
183
184struct wpa_eapol_key {
185 u8 type;
186 /* Note: key_info, key_length, and key_data_length are unaligned */
187 u8 key_info[2]; /* big endian */
188 u8 key_length[2]; /* big endian */
189 u8 replay_counter[WPA_REPLAY_COUNTER_LEN];
190 u8 key_nonce[WPA_NONCE_LEN];
191 u8 key_iv[16];
192 u8 key_rsc[WPA_KEY_RSC_LEN];
193 u8 key_id[8]; /* Reserved in IEEE 802.11i/RSN */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800194 /* variable length Key MIC field */
195 /* big endian 2-octet Key Data Length field */
196 /* followed by Key Data Length bytes of Key Data */
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800197} STRUCT_PACKED;
198
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700199#define WPA_EAPOL_KEY_MIC_MAX_LEN 32
200#define WPA_KCK_MAX_LEN 32
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800201#define WPA_KEK_MAX_LEN 64
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800202#define WPA_TK_MAX_LEN 32
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800203#define FILS_ICK_MAX_LEN 48
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700204#define FILS_FT_MAX_LEN 48
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800205
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700206/**
207 * struct wpa_ptk - WPA Pairwise Transient Key
208 * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy
209 */
210struct wpa_ptk {
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800211 u8 kck[WPA_KCK_MAX_LEN]; /* EAPOL-Key Key Confirmation Key (KCK) */
212 u8 kek[WPA_KEK_MAX_LEN]; /* EAPOL-Key Key Encryption Key (KEK) */
213 u8 tk[WPA_TK_MAX_LEN]; /* Temporal Key (TK) */
Roshan Pius3a1667e2018-07-03 15:17:14 -0700214 u8 kck2[WPA_KCK_MAX_LEN]; /* FT reasoc Key Confirmation Key (KCK2) */
215 u8 kek2[WPA_KEK_MAX_LEN]; /* FT reassoc Key Encryption Key (KEK2) */
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800216 size_t kck_len;
217 size_t kek_len;
218 size_t tk_len;
Roshan Pius3a1667e2018-07-03 15:17:14 -0700219 size_t kck2_len;
220 size_t kek2_len;
Mathy Vanhoefc66556c2017-09-29 04:22:51 +0200221 int installed; /* 1 if key has already been installed to driver */
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800222};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700223
Mathy Vanhoef10bfd642017-07-12 16:03:24 +0200224struct wpa_gtk {
225 u8 gtk[WPA_GTK_MAX_LEN];
226 size_t gtk_len;
227};
228
Mathy Vanhoef10bfd642017-07-12 16:03:24 +0200229struct wpa_igtk {
230 u8 igtk[WPA_IGTK_MAX_LEN];
231 size_t igtk_len;
232};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700233
Hai Shalomfdcde762020-04-02 11:19:20 -0700234struct wpa_bigtk {
235 u8 bigtk[WPA_BIGTK_MAX_LEN];
236 size_t bigtk_len;
237};
238
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700239/* WPA IE version 1
240 * 00-50-f2:1 (OUI:OUI type)
241 * 0x01 0x00 (version; little endian)
242 * (all following fields are optional:)
243 * Group Suite Selector (4 octets) (default: TKIP)
244 * Pairwise Suite Count (2 octets, little endian) (default: 1)
245 * Pairwise Suite List (4 * n octets) (default: TKIP)
246 * Authenticated Key Management Suite Count (2 octets, little endian)
247 * (default: 1)
248 * Authenticated Key Management Suite List (4 * n octets)
249 * (default: unspec 802.1X)
250 * WPA Capabilities (2 octets, little endian) (default: 0)
251 */
252
253struct wpa_ie_hdr {
254 u8 elem_id;
255 u8 len;
256 u8 oui[4]; /* 24-bit OUI followed by 8-bit OUI type */
257 u8 version[2]; /* little endian */
258} STRUCT_PACKED;
259
260
261/* 1/4: PMKID
262 * 2/4: RSN IE
263 * 3/4: one or two RSN IEs + GTK IE (encrypted)
264 * 4/4: empty
265 * 1/2: GTK IE (encrypted)
266 * 2/2: empty
267 */
268
269/* RSN IE version 1
270 * 0x01 0x00 (version; little endian)
271 * (all following fields are optional:)
272 * Group Suite Selector (4 octets) (default: CCMP)
273 * Pairwise Suite Count (2 octets, little endian) (default: 1)
274 * Pairwise Suite List (4 * n octets) (default: CCMP)
275 * Authenticated Key Management Suite Count (2 octets, little endian)
276 * (default: 1)
277 * Authenticated Key Management Suite List (4 * n octets)
278 * (default: unspec 802.1X)
279 * RSN Capabilities (2 octets, little endian) (default: 0)
280 * PMKID Count (2 octets) (default: 0)
281 * PMKID List (16 * n octets)
282 * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
283 */
284
285struct rsn_ie_hdr {
286 u8 elem_id; /* WLAN_EID_RSN */
287 u8 len;
288 u8 version[2]; /* little endian */
289} STRUCT_PACKED;
290
291
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700292struct rsn_error_kde {
293 be16 mui;
294 be16 error_type;
295} STRUCT_PACKED;
296
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700297#define WPA_IGTK_KDE_PREFIX_LEN (2 + 6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700298struct wpa_igtk_kde {
299 u8 keyid[2];
300 u8 pn[6];
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700301 u8 igtk[WPA_IGTK_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700302} STRUCT_PACKED;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700303
Hai Shalomfdcde762020-04-02 11:19:20 -0700304#define WPA_BIGTK_KDE_PREFIX_LEN (2 + 6)
305struct wpa_bigtk_kde {
306 u8 keyid[2];
307 u8 pn[6];
308 u8 bigtk[WPA_BIGTK_MAX_LEN];
309} STRUCT_PACKED;
310
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700311struct rsn_mdie {
312 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
313 u8 ft_capab;
314} STRUCT_PACKED;
315
316#define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
317#define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
318
319struct rsn_ftie {
320 u8 mic_control[2];
321 u8 mic[16];
322 u8 anonce[WPA_NONCE_LEN];
323 u8 snonce[WPA_NONCE_LEN];
324 /* followed by optional parameters */
325} STRUCT_PACKED;
326
Roshan Pius3a1667e2018-07-03 15:17:14 -0700327struct rsn_ftie_sha384 {
328 u8 mic_control[2];
329 u8 mic[24];
330 u8 anonce[WPA_NONCE_LEN];
331 u8 snonce[WPA_NONCE_LEN];
332 /* followed by optional parameters */
333} STRUCT_PACKED;
334
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700335#define FTIE_SUBELEM_R1KH_ID 1
336#define FTIE_SUBELEM_GTK 2
337#define FTIE_SUBELEM_R0KH_ID 3
338#define FTIE_SUBELEM_IGTK 4
Hai Shalom74f70d42019-02-11 14:42:39 -0800339#define FTIE_SUBELEM_OCI 5
Hai Shalomfdcde762020-04-02 11:19:20 -0700340#define FTIE_SUBELEM_BIGTK 6
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700341
342struct rsn_rdie {
343 u8 id;
344 u8 descr_count;
345 le16 status_code;
346} STRUCT_PACKED;
347
Hai Shalomfdcde762020-04-02 11:19:20 -0700348/* WFA Transition Disable KDE (using OUI_WFA) */
349/* Transition Disable Bitmap bits */
350#define TRANSITION_DISABLE_WPA3_PERSONAL BIT(0)
351#define TRANSITION_DISABLE_SAE_PK BIT(1)
352#define TRANSITION_DISABLE_WPA3_ENTERPRISE BIT(2)
353#define TRANSITION_DISABLE_ENHANCED_OPEN BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700354
355#ifdef _MSC_VER
356#pragma pack(pop)
357#endif /* _MSC_VER */
358
359
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800360int wpa_eapol_key_mic(const u8 *key, size_t key_len, int akmp, int ver,
361 const u8 *buf, size_t len, u8 *mic);
362int wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label,
363 const u8 *addr1, const u8 *addr2,
364 const u8 *nonce1, const u8 *nonce2,
Hai Shalom021b0b52019-04-10 11:17:58 -0700365 struct wpa_ptk *ptk, int akmp, int cipher,
366 const u8 *z, size_t z_len);
Paul Stewart092955c2017-02-06 09:13:09 -0800367int fils_rmsk_to_pmk(int akmp, const u8 *rmsk, size_t rmsk_len,
368 const u8 *snonce, const u8 *anonce, const u8 *dh_ss,
369 size_t dh_ss_len, u8 *pmk, size_t *pmk_len);
370int fils_pmkid_erp(int akmp, const u8 *reauth, size_t reauth_len,
371 u8 *pmkid);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800372int fils_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const u8 *spa, const u8 *aa,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700373 const u8 *snonce, const u8 *anonce, const u8 *dhss,
374 size_t dhss_len, struct wpa_ptk *ptk,
375 u8 *ick, size_t *ick_len, int akmp, int cipher,
376 u8 *fils_ft, size_t *fils_ft_len);
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800377int fils_key_auth_sk(const u8 *ick, size_t ick_len, const u8 *snonce,
378 const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
379 const u8 *g_sta, size_t g_sta_len,
380 const u8 *g_ap, size_t g_ap_len,
381 int akmp, u8 *key_auth_sta, u8 *key_auth_ap,
382 size_t *key_auth_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700383
384#ifdef CONFIG_IEEE80211R
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800385int wpa_ft_mic(const u8 *kck, size_t kck_len, const u8 *sta_addr,
386 const u8 *ap_addr, u8 transaction_seqnum,
387 const u8 *mdie, size_t mdie_len,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700388 const u8 *ftie, size_t ftie_len,
389 const u8 *rsnie, size_t rsnie_len,
Hai Shalomc3565922019-10-28 11:58:20 -0700390 const u8 *ric, size_t ric_len,
391 const u8 *rsnxe, size_t rsnxe_len,
392 u8 *mic);
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800393int wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len,
394 const u8 *ssid, size_t ssid_len,
395 const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len,
Roshan Pius3a1667e2018-07-03 15:17:14 -0700396 const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name,
397 int use_sha384);
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800398int wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id,
Roshan Pius3a1667e2018-07-03 15:17:14 -0700399 const u8 *s1kh_id, u8 *pmk_r1_name, int use_sha384);
400int wpa_derive_pmk_r1(const u8 *pmk_r0, size_t pmk_r0_len,
401 const u8 *pmk_r0_name,
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800402 const u8 *r1kh_id, const u8 *s1kh_id,
403 u8 *pmk_r1, u8 *pmk_r1_name);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700404int wpa_pmk_r1_to_ptk(const u8 *pmk_r1, size_t pmk_r1_len, const u8 *snonce,
405 const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800406 const u8 *pmk_r1_name,
407 struct wpa_ptk *ptk, u8 *ptk_name, int akmp, int cipher);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700408#endif /* CONFIG_IEEE80211R */
409
410struct wpa_ie_data {
411 int proto;
412 int pairwise_cipher;
Hai Shalom021b0b52019-04-10 11:17:58 -0700413 int has_pairwise;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700414 int group_cipher;
Hai Shalom021b0b52019-04-10 11:17:58 -0700415 int has_group;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700416 int key_mgmt;
417 int capabilities;
418 size_t num_pmkid;
419 const u8 *pmkid;
420 int mgmt_group_cipher;
421};
422
423
424int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len,
425 struct wpa_ie_data *data);
426int wpa_parse_wpa_ie_wpa(const u8 *wpa_ie, size_t wpa_ie_len,
427 struct wpa_ie_data *data);
Hai Shalom021b0b52019-04-10 11:17:58 -0700428int wpa_default_rsn_cipher(int freq);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700429
430void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700431 u8 *pmkid, int akmp);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800432#ifdef CONFIG_SUITEB
433int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
434 const u8 *spa, u8 *pmkid);
435#else /* CONFIG_SUITEB */
436static inline int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
437 const u8 *spa, u8 *pmkid)
438{
439 return -1;
440}
441#endif /* CONFIG_SUITEB */
Dmitry Shmidt807291d2015-01-27 13:40:23 -0800442#ifdef CONFIG_SUITEB192
443int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len, const u8 *aa,
444 const u8 *spa, u8 *pmkid);
445#else /* CONFIG_SUITEB192 */
446static inline int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len,
447 const u8 *aa, const u8 *spa, u8 *pmkid)
448{
449 return -1;
450}
451#endif /* CONFIG_SUITEB192 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700452
453const char * wpa_cipher_txt(int cipher);
454const char * wpa_key_mgmt_txt(int key_mgmt, int proto);
Dmitry Shmidt03658832014-08-13 11:03:49 -0700455u32 wpa_akm_to_suite(int akm);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700456int wpa_compare_rsn_ie(int ft_initial_assoc,
457 const u8 *ie1, size_t ie1len,
458 const u8 *ie2, size_t ie2len);
Dmitry Shmidt1b467752015-12-14 12:45:46 -0800459int wpa_insert_pmkid(u8 *ies, size_t *ies_len, const u8 *pmkid);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700460
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800461struct wpa_ft_ies {
462 const u8 *mdie;
463 size_t mdie_len;
464 const u8 *ftie;
465 size_t ftie_len;
466 const u8 *r1kh_id;
467 const u8 *gtk;
468 size_t gtk_len;
469 const u8 *r0kh_id;
470 size_t r0kh_id_len;
Hai Shalomc3565922019-10-28 11:58:20 -0700471 const u8 *fte_anonce;
472 const u8 *fte_snonce;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800473 const u8 *rsn;
474 size_t rsn_len;
Hai Shalomc3565922019-10-28 11:58:20 -0700475 u16 rsn_capab;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800476 const u8 *rsn_pmkid;
477 const u8 *tie;
478 size_t tie_len;
479 const u8 *igtk;
480 size_t igtk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -0700481 const u8 *bigtk;
482 size_t bigtk_len;
Hai Shalom74f70d42019-02-11 14:42:39 -0800483#ifdef CONFIG_OCV
484 const u8 *oci;
485 size_t oci_len;
486#endif /* CONFIG_OCV */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800487 const u8 *ric;
488 size_t ric_len;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800489 int key_mgmt;
490 int pairwise_cipher;
Hai Shalomc3565922019-10-28 11:58:20 -0700491 const u8 *rsnxe;
492 size_t rsnxe_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800493};
494
Roshan Pius3a1667e2018-07-03 15:17:14 -0700495int wpa_ft_parse_ies(const u8 *ies, size_t ies_len, struct wpa_ft_ies *parse,
496 int use_sha384);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800497
Hai Shalomc3565922019-10-28 11:58:20 -0700498struct wpa_eapol_ie_parse {
499 const u8 *wpa_ie;
500 size_t wpa_ie_len;
501 const u8 *rsn_ie;
502 size_t rsn_ie_len;
503 const u8 *pmkid;
Hai Shalomfdcde762020-04-02 11:19:20 -0700504 const u8 *key_id;
Hai Shalomc3565922019-10-28 11:58:20 -0700505 const u8 *gtk;
506 size_t gtk_len;
507 const u8 *mac_addr;
508 size_t mac_addr_len;
509 const u8 *igtk;
510 size_t igtk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -0700511 const u8 *bigtk;
512 size_t bigtk_len;
Hai Shalomc3565922019-10-28 11:58:20 -0700513 const u8 *mdie;
514 size_t mdie_len;
515 const u8 *ftie;
516 size_t ftie_len;
517 const u8 *ip_addr_req;
518 const u8 *ip_addr_alloc;
Hai Shalomfdcde762020-04-02 11:19:20 -0700519 const u8 *transition_disable;
520 size_t transition_disable_len;
Hai Shalomc3565922019-10-28 11:58:20 -0700521 const u8 *oci;
522 size_t oci_len;
523 const u8 *osen;
524 size_t osen_len;
525 const u8 *rsnxe;
526 size_t rsnxe_len;
527 const u8 *reassoc_deadline;
528 const u8 *key_lifetime;
529 const u8 *lnkid;
530 size_t lnkid_len;
531 const u8 *ext_capab;
532 size_t ext_capab_len;
533 const u8 *supp_rates;
534 size_t supp_rates_len;
535 const u8 *ext_supp_rates;
536 size_t ext_supp_rates_len;
537 const u8 *ht_capabilities;
538 const u8 *vht_capabilities;
539 const u8 *supp_channels;
540 size_t supp_channels_len;
541 const u8 *supp_oper_classes;
542 size_t supp_oper_classes_len;
543 u8 qosinfo;
544 u16 aid;
545 const u8 *wmm;
546 size_t wmm_len;
547};
548
549int wpa_parse_kde_ies(const u8 *buf, size_t len, struct wpa_eapol_ie_parse *ie);
550static inline int wpa_supplicant_parse_ies(const u8 *buf, size_t len,
551 struct wpa_eapol_ie_parse *ie)
552{
553 return wpa_parse_kde_ies(buf, len, ie);
554}
555
556
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700557int wpa_cipher_key_len(int cipher);
558int wpa_cipher_rsc_len(int cipher);
Dmitry Shmidt29333592017-01-09 12:27:11 -0800559enum wpa_alg wpa_cipher_to_alg(int cipher);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -0800560int wpa_cipher_valid_group(int cipher);
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700561int wpa_cipher_valid_pairwise(int cipher);
Dmitry Shmidtb36ed7c2014-03-17 10:57:26 -0700562int wpa_cipher_valid_mgmt_group(int cipher);
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700563u32 wpa_cipher_to_suite(int proto, int cipher);
564int rsn_cipher_put_suites(u8 *pos, int ciphers);
565int wpa_cipher_put_suites(u8 *pos, int ciphers);
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -0800566int wpa_pick_pairwise_cipher(int ciphers, int none_allowed);
567int wpa_pick_group_cipher(int ciphers);
568int wpa_parse_cipher(const char *value);
569int wpa_write_ciphers(char *start, char *end, int ciphers, const char *delim);
570int wpa_select_ap_group_cipher(int wpa, int wpa_pairwise, int rsn_pairwise);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700571unsigned int wpa_mic_len(int akmp, size_t pmk_len);
Roshan Pius3a1667e2018-07-03 15:17:14 -0700572int wpa_use_akm_defined(int akmp);
573int wpa_use_cmac(int akmp);
574int wpa_use_aes_key_wrap(int akmp);
Dmitry Shmidt29333592017-01-09 12:27:11 -0800575int fils_domain_name_hash(const char *domain, u8 *hash);
Dmitry Shmidt4530cfd2012-09-09 15:20:40 -0700576
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700577#endif /* WPA_COMMON_H */