xref: /freebsd/contrib/wpa/src/common/wpa_common.h (revision 4bc523382c7e72183c32be2c3aedecc1f5e844dd)
139beb93cSSam Leffler /*
239beb93cSSam Leffler  * WPA definitions shared between hostapd and wpa_supplicant
385732ac8SCy Schubert  * Copyright (c) 2002-2018, Jouni Malinen <j@w1.fi>
439beb93cSSam Leffler  *
5f05cddf9SRui Paulo  * This software may be distributed under the terms of the BSD license.
6f05cddf9SRui Paulo  * See README for more details.
739beb93cSSam Leffler  */
839beb93cSSam Leffler 
939beb93cSSam Leffler #ifndef WPA_COMMON_H
1039beb93cSSam Leffler #define WPA_COMMON_H
1139beb93cSSam Leffler 
1239beb93cSSam Leffler /* IEEE 802.11i */
1339beb93cSSam Leffler #define PMKID_LEN 16
1439beb93cSSam Leffler #define PMK_LEN 32
15780fb4a2SCy Schubert #define PMK_LEN_SUITE_B_192 48
1685732ac8SCy Schubert #define PMK_LEN_MAX 64
1739beb93cSSam Leffler #define WPA_REPLAY_COUNTER_LEN 8
1839beb93cSSam Leffler #define WPA_NONCE_LEN 32
1939beb93cSSam Leffler #define WPA_KEY_RSC_LEN 8
2039beb93cSSam Leffler #define WPA_GMK_LEN 32
2139beb93cSSam Leffler #define WPA_GTK_MAX_LEN 32
2239beb93cSSam Leffler 
2385732ac8SCy Schubert #define OWE_DH_GROUP 19
2485732ac8SCy Schubert 
255b9c547cSRui Paulo #define WPA_ALLOWED_PAIRWISE_CIPHERS \
265b9c547cSRui Paulo (WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | WPA_CIPHER_NONE | \
275b9c547cSRui Paulo WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256)
285b9c547cSRui Paulo #define WPA_ALLOWED_GROUP_CIPHERS \
29325151a3SRui Paulo (WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | \
30325151a3SRui Paulo WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256 | \
315b9c547cSRui Paulo WPA_CIPHER_GTK_NOT_USED)
3285732ac8SCy Schubert #define WPA_ALLOWED_GROUP_MGMT_CIPHERS \
3385732ac8SCy Schubert (WPA_CIPHER_AES_128_CMAC | WPA_CIPHER_BIP_GMAC_128 | WPA_CIPHER_BIP_GMAC_256 | \
3485732ac8SCy Schubert WPA_CIPHER_BIP_CMAC_256)
355b9c547cSRui Paulo 
3639beb93cSSam Leffler #define WPA_SELECTOR_LEN 4
3739beb93cSSam Leffler #define WPA_VERSION 1
3839beb93cSSam Leffler #define RSN_SELECTOR_LEN 4
3939beb93cSSam Leffler #define RSN_VERSION 1
4039beb93cSSam Leffler 
4139beb93cSSam Leffler #define RSN_SELECTOR(a, b, c, d) \
4239beb93cSSam Leffler 	((((u32) (a)) << 24) | (((u32) (b)) << 16) | (((u32) (c)) << 8) | \
4339beb93cSSam Leffler 	 (u32) (d))
4439beb93cSSam Leffler 
4539beb93cSSam Leffler #define WPA_AUTH_KEY_MGMT_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
4639beb93cSSam Leffler #define WPA_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
4739beb93cSSam Leffler #define WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
48f05cddf9SRui Paulo #define WPA_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0)
4939beb93cSSam Leffler #define WPA_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
5039beb93cSSam Leffler #define WPA_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
5139beb93cSSam Leffler #define WPA_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x50, 0xf2, 4)
5239beb93cSSam Leffler 
5339beb93cSSam Leffler 
5439beb93cSSam Leffler #define RSN_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
5539beb93cSSam Leffler #define RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
5639beb93cSSam Leffler #define RSN_AUTH_KEY_MGMT_FT_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
5739beb93cSSam Leffler #define RSN_AUTH_KEY_MGMT_FT_PSK RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
5839beb93cSSam Leffler #define RSN_AUTH_KEY_MGMT_802_1X_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
5939beb93cSSam Leffler #define RSN_AUTH_KEY_MGMT_PSK_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
60f05cddf9SRui Paulo #define RSN_AUTH_KEY_MGMT_TPK_HANDSHAKE RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
61f05cddf9SRui Paulo #define RSN_AUTH_KEY_MGMT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
62f05cddf9SRui Paulo #define RSN_AUTH_KEY_MGMT_FT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
635b9c547cSRui Paulo #define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
645b9c547cSRui Paulo #define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B_192 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
6585732ac8SCy Schubert #define RSN_AUTH_KEY_MGMT_FT_802_1X_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
6685732ac8SCy Schubert #define RSN_AUTH_KEY_MGMT_FILS_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 14)
6785732ac8SCy Schubert #define RSN_AUTH_KEY_MGMT_FILS_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 15)
6885732ac8SCy Schubert #define RSN_AUTH_KEY_MGMT_FT_FILS_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 16)
6985732ac8SCy Schubert #define RSN_AUTH_KEY_MGMT_FT_FILS_SHA384 RSN_SELECTOR(0x00, 0x0f, 0xac, 17)
7085732ac8SCy Schubert #define RSN_AUTH_KEY_MGMT_OWE RSN_SELECTOR(0x00, 0x0f, 0xac, 18)
71f05cddf9SRui Paulo #define RSN_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0x00)
725b9c547cSRui Paulo #define RSN_AUTH_KEY_MGMT_OSEN RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x01)
7385732ac8SCy Schubert #define RSN_AUTH_KEY_MGMT_DPP RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x02)
7439beb93cSSam Leffler 
7539beb93cSSam Leffler #define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0)
7685732ac8SCy Schubert #define RSN_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
7739beb93cSSam Leffler #define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
7839beb93cSSam Leffler #if 0
7939beb93cSSam Leffler #define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
8039beb93cSSam Leffler #endif
8139beb93cSSam Leffler #define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
8285732ac8SCy Schubert #define RSN_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
8339beb93cSSam Leffler #define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
84f05cddf9SRui Paulo #define RSN_CIPHER_SUITE_NO_GROUP_ADDRESSED RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
85f05cddf9SRui Paulo #define RSN_CIPHER_SUITE_GCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
865b9c547cSRui Paulo #define RSN_CIPHER_SUITE_GCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
875b9c547cSRui Paulo #define RSN_CIPHER_SUITE_CCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
885b9c547cSRui Paulo #define RSN_CIPHER_SUITE_BIP_GMAC_128 RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
895b9c547cSRui Paulo #define RSN_CIPHER_SUITE_BIP_GMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
905b9c547cSRui Paulo #define RSN_CIPHER_SUITE_BIP_CMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
9185732ac8SCy Schubert #define RSN_CIPHER_SUITE_SMS4 RSN_SELECTOR(0x00, 0x14, 0x72, 1)
9285732ac8SCy Schubert #define RSN_CIPHER_SUITE_CKIP RSN_SELECTOR(0x00, 0x40, 0x96, 0)
9385732ac8SCy Schubert #define RSN_CIPHER_SUITE_CKIP_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 1)
9485732ac8SCy Schubert #define RSN_CIPHER_SUITE_CMIC RSN_SELECTOR(0x00, 0x40, 0x96, 2)
9585732ac8SCy Schubert /* KRK is defined for nl80211 use only */
9685732ac8SCy Schubert #define RSN_CIPHER_SUITE_KRK RSN_SELECTOR(0x00, 0x40, 0x96, 255)
9739beb93cSSam Leffler 
9839beb93cSSam Leffler /* EAPOL-Key Key Data Encapsulation
9939beb93cSSam Leffler  * GroupKey and PeerKey require encryption, otherwise, encryption is optional.
10039beb93cSSam Leffler  */
10139beb93cSSam Leffler #define RSN_KEY_DATA_GROUPKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
10239beb93cSSam Leffler #if 0
10339beb93cSSam Leffler #define RSN_KEY_DATA_STAKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
10439beb93cSSam Leffler #endif
10539beb93cSSam Leffler #define RSN_KEY_DATA_MAC_ADDR RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
10639beb93cSSam Leffler #define RSN_KEY_DATA_PMKID RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
10739beb93cSSam Leffler #ifdef CONFIG_IEEE80211W
10839beb93cSSam Leffler #define RSN_KEY_DATA_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
10939beb93cSSam Leffler #endif /* CONFIG_IEEE80211W */
110f05cddf9SRui Paulo #define RSN_KEY_DATA_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
111f05cddf9SRui Paulo #define RSN_KEY_DATA_MULTIBAND_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
112f05cddf9SRui Paulo #define RSN_KEY_DATA_MULTIBAND_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
113*4bc52338SCy Schubert #define RSN_KEY_DATA_OCI RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
11439beb93cSSam Leffler 
1155b9c547cSRui Paulo #define WFA_KEY_DATA_IP_ADDR_REQ RSN_SELECTOR(0x50, 0x6f, 0x9a, 4)
1165b9c547cSRui Paulo #define WFA_KEY_DATA_IP_ADDR_ALLOC RSN_SELECTOR(0x50, 0x6f, 0x9a, 5)
1175b9c547cSRui Paulo 
11839beb93cSSam Leffler #define WPA_OUI_TYPE RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
11939beb93cSSam Leffler 
12039beb93cSSam Leffler #define RSN_SELECTOR_PUT(a, val) WPA_PUT_BE32((u8 *) (a), (val))
12139beb93cSSam Leffler #define RSN_SELECTOR_GET(a) WPA_GET_BE32((const u8 *) (a))
12239beb93cSSam Leffler 
12339beb93cSSam Leffler #define RSN_NUM_REPLAY_COUNTERS_1 0
12439beb93cSSam Leffler #define RSN_NUM_REPLAY_COUNTERS_2 1
12539beb93cSSam Leffler #define RSN_NUM_REPLAY_COUNTERS_4 2
12639beb93cSSam Leffler #define RSN_NUM_REPLAY_COUNTERS_16 3
12739beb93cSSam Leffler 
12839beb93cSSam Leffler 
12939beb93cSSam Leffler #ifdef _MSC_VER
13039beb93cSSam Leffler #pragma pack(push, 1)
13139beb93cSSam Leffler #endif /* _MSC_VER */
13239beb93cSSam Leffler 
13339beb93cSSam Leffler #ifdef CONFIG_IEEE80211W
13439beb93cSSam Leffler #define WPA_IGTK_LEN 16
1355b9c547cSRui Paulo #define WPA_IGTK_MAX_LEN 32
13639beb93cSSam Leffler #endif /* CONFIG_IEEE80211W */
13739beb93cSSam Leffler 
13839beb93cSSam Leffler 
13939beb93cSSam Leffler /* IEEE 802.11, 7.3.2.25.3 RSN Capabilities */
14039beb93cSSam Leffler #define WPA_CAPABILITY_PREAUTH BIT(0)
14139beb93cSSam Leffler #define WPA_CAPABILITY_NO_PAIRWISE BIT(1)
14239beb93cSSam Leffler /* B2-B3: PTKSA Replay Counter */
14339beb93cSSam Leffler /* B4-B5: GTKSA Replay Counter */
14439beb93cSSam Leffler #define WPA_CAPABILITY_MFPR BIT(6)
14539beb93cSSam Leffler #define WPA_CAPABILITY_MFPC BIT(7)
146f05cddf9SRui Paulo /* B8: Reserved */
14739beb93cSSam Leffler #define WPA_CAPABILITY_PEERKEY_ENABLED BIT(9)
148f05cddf9SRui Paulo #define WPA_CAPABILITY_SPP_A_MSDU_CAPABLE BIT(10)
149f05cddf9SRui Paulo #define WPA_CAPABILITY_SPP_A_MSDU_REQUIRED BIT(11)
150f05cddf9SRui Paulo #define WPA_CAPABILITY_PBAC BIT(12)
151f05cddf9SRui Paulo #define WPA_CAPABILITY_EXT_KEY_ID_FOR_UNICAST BIT(13)
152*4bc52338SCy Schubert #define WPA_CAPABILITY_OCVC BIT(14)
153*4bc52338SCy Schubert /* B15: Reserved */
15439beb93cSSam Leffler 
15539beb93cSSam Leffler 
15639beb93cSSam Leffler /* IEEE 802.11r */
15739beb93cSSam Leffler #define MOBILITY_DOMAIN_ID_LEN 2
15839beb93cSSam Leffler #define FT_R0KH_ID_MAX_LEN 48
15939beb93cSSam Leffler #define FT_R1KH_ID_LEN 6
16039beb93cSSam Leffler #define WPA_PMK_NAME_LEN 16
16139beb93cSSam Leffler 
16239beb93cSSam Leffler 
16339beb93cSSam Leffler /* IEEE 802.11, 8.5.2 EAPOL-Key frames */
16439beb93cSSam Leffler #define WPA_KEY_INFO_TYPE_MASK ((u16) (BIT(0) | BIT(1) | BIT(2)))
1655b9c547cSRui Paulo #define WPA_KEY_INFO_TYPE_AKM_DEFINED 0
16639beb93cSSam Leffler #define WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 BIT(0)
16739beb93cSSam Leffler #define WPA_KEY_INFO_TYPE_HMAC_SHA1_AES BIT(1)
16839beb93cSSam Leffler #define WPA_KEY_INFO_TYPE_AES_128_CMAC 3
16939beb93cSSam Leffler #define WPA_KEY_INFO_KEY_TYPE BIT(3) /* 1 = Pairwise, 0 = Group key */
17039beb93cSSam Leffler /* bit4..5 is used in WPA, but is reserved in IEEE 802.11i/RSN */
17139beb93cSSam Leffler #define WPA_KEY_INFO_KEY_INDEX_MASK (BIT(4) | BIT(5))
17239beb93cSSam Leffler #define WPA_KEY_INFO_KEY_INDEX_SHIFT 4
17339beb93cSSam Leffler #define WPA_KEY_INFO_INSTALL BIT(6) /* pairwise */
17439beb93cSSam Leffler #define WPA_KEY_INFO_TXRX BIT(6) /* group */
17539beb93cSSam Leffler #define WPA_KEY_INFO_ACK BIT(7)
17639beb93cSSam Leffler #define WPA_KEY_INFO_MIC BIT(8)
17739beb93cSSam Leffler #define WPA_KEY_INFO_SECURE BIT(9)
17839beb93cSSam Leffler #define WPA_KEY_INFO_ERROR BIT(10)
17939beb93cSSam Leffler #define WPA_KEY_INFO_REQUEST BIT(11)
18039beb93cSSam Leffler #define WPA_KEY_INFO_ENCR_KEY_DATA BIT(12) /* IEEE 802.11i/RSN only */
18139beb93cSSam Leffler #define WPA_KEY_INFO_SMK_MESSAGE BIT(13)
18239beb93cSSam Leffler 
18339beb93cSSam Leffler 
18439beb93cSSam Leffler struct wpa_eapol_key {
18539beb93cSSam Leffler 	u8 type;
18639beb93cSSam Leffler 	/* Note: key_info, key_length, and key_data_length are unaligned */
18739beb93cSSam Leffler 	u8 key_info[2]; /* big endian */
18839beb93cSSam Leffler 	u8 key_length[2]; /* big endian */
18939beb93cSSam Leffler 	u8 replay_counter[WPA_REPLAY_COUNTER_LEN];
19039beb93cSSam Leffler 	u8 key_nonce[WPA_NONCE_LEN];
19139beb93cSSam Leffler 	u8 key_iv[16];
19239beb93cSSam Leffler 	u8 key_rsc[WPA_KEY_RSC_LEN];
19339beb93cSSam Leffler 	u8 key_id[8]; /* Reserved in IEEE 802.11i/RSN */
19485732ac8SCy Schubert 	/* variable length Key MIC field */
19585732ac8SCy Schubert 	/* big endian 2-octet Key Data Length field */
19685732ac8SCy Schubert 	/* followed by Key Data Length bytes of Key Data */
19739beb93cSSam Leffler } STRUCT_PACKED;
19839beb93cSSam Leffler 
19985732ac8SCy Schubert #define WPA_EAPOL_KEY_MIC_MAX_LEN 32
20085732ac8SCy Schubert #define WPA_KCK_MAX_LEN 32
20185732ac8SCy Schubert #define WPA_KEK_MAX_LEN 64
2025b9c547cSRui Paulo #define WPA_TK_MAX_LEN 32
20385732ac8SCy Schubert #define FILS_ICK_MAX_LEN 48
20485732ac8SCy Schubert #define FILS_FT_MAX_LEN 48
2055b9c547cSRui Paulo 
20639beb93cSSam Leffler /**
20739beb93cSSam Leffler  * struct wpa_ptk - WPA Pairwise Transient Key
20839beb93cSSam Leffler  * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy
20939beb93cSSam Leffler  */
21039beb93cSSam Leffler struct wpa_ptk {
2115b9c547cSRui Paulo 	u8 kck[WPA_KCK_MAX_LEN]; /* EAPOL-Key Key Confirmation Key (KCK) */
2125b9c547cSRui Paulo 	u8 kek[WPA_KEK_MAX_LEN]; /* EAPOL-Key Key Encryption Key (KEK) */
2135b9c547cSRui Paulo 	u8 tk[WPA_TK_MAX_LEN]; /* Temporal Key (TK) */
21485732ac8SCy Schubert 	u8 kck2[WPA_KCK_MAX_LEN]; /* FT reasoc Key Confirmation Key (KCK2) */
21585732ac8SCy Schubert 	u8 kek2[WPA_KEK_MAX_LEN]; /* FT reassoc Key Encryption Key (KEK2) */
2165b9c547cSRui Paulo 	size_t kck_len;
2175b9c547cSRui Paulo 	size_t kek_len;
2185b9c547cSRui Paulo 	size_t tk_len;
21985732ac8SCy Schubert 	size_t kck2_len;
22085732ac8SCy Schubert 	size_t kek2_len;
221a2063804SGordon Tetlow 	int installed; /* 1 if key has already been installed to driver */
2225b9c547cSRui Paulo };
22339beb93cSSam Leffler 
224a2063804SGordon Tetlow struct wpa_gtk {
225a2063804SGordon Tetlow 	u8 gtk[WPA_GTK_MAX_LEN];
226a2063804SGordon Tetlow 	size_t gtk_len;
227a2063804SGordon Tetlow };
228a2063804SGordon Tetlow 
229a2063804SGordon Tetlow #ifdef CONFIG_IEEE80211W
230a2063804SGordon Tetlow struct wpa_igtk {
231a2063804SGordon Tetlow 	u8 igtk[WPA_IGTK_MAX_LEN];
232a2063804SGordon Tetlow 	size_t igtk_len;
233a2063804SGordon Tetlow };
234a2063804SGordon Tetlow #endif /* CONFIG_IEEE80211W */
23539beb93cSSam Leffler 
23639beb93cSSam Leffler /* WPA IE version 1
23739beb93cSSam Leffler  * 00-50-f2:1 (OUI:OUI type)
23839beb93cSSam Leffler  * 0x01 0x00 (version; little endian)
23939beb93cSSam Leffler  * (all following fields are optional:)
24039beb93cSSam Leffler  * Group Suite Selector (4 octets) (default: TKIP)
24139beb93cSSam Leffler  * Pairwise Suite Count (2 octets, little endian) (default: 1)
24239beb93cSSam Leffler  * Pairwise Suite List (4 * n octets) (default: TKIP)
24339beb93cSSam Leffler  * Authenticated Key Management Suite Count (2 octets, little endian)
24439beb93cSSam Leffler  *    (default: 1)
24539beb93cSSam Leffler  * Authenticated Key Management Suite List (4 * n octets)
24639beb93cSSam Leffler  *    (default: unspec 802.1X)
24739beb93cSSam Leffler  * WPA Capabilities (2 octets, little endian) (default: 0)
24839beb93cSSam Leffler  */
24939beb93cSSam Leffler 
25039beb93cSSam Leffler struct wpa_ie_hdr {
25139beb93cSSam Leffler 	u8 elem_id;
25239beb93cSSam Leffler 	u8 len;
25339beb93cSSam Leffler 	u8 oui[4]; /* 24-bit OUI followed by 8-bit OUI type */
25439beb93cSSam Leffler 	u8 version[2]; /* little endian */
25539beb93cSSam Leffler } STRUCT_PACKED;
25639beb93cSSam Leffler 
25739beb93cSSam Leffler 
25839beb93cSSam Leffler /* 1/4: PMKID
25939beb93cSSam Leffler  * 2/4: RSN IE
26039beb93cSSam Leffler  * 3/4: one or two RSN IEs + GTK IE (encrypted)
26139beb93cSSam Leffler  * 4/4: empty
26239beb93cSSam Leffler  * 1/2: GTK IE (encrypted)
26339beb93cSSam Leffler  * 2/2: empty
26439beb93cSSam Leffler  */
26539beb93cSSam Leffler 
26639beb93cSSam Leffler /* RSN IE version 1
26739beb93cSSam Leffler  * 0x01 0x00 (version; little endian)
26839beb93cSSam Leffler  * (all following fields are optional:)
26939beb93cSSam Leffler  * Group Suite Selector (4 octets) (default: CCMP)
27039beb93cSSam Leffler  * Pairwise Suite Count (2 octets, little endian) (default: 1)
27139beb93cSSam Leffler  * Pairwise Suite List (4 * n octets) (default: CCMP)
27239beb93cSSam Leffler  * Authenticated Key Management Suite Count (2 octets, little endian)
27339beb93cSSam Leffler  *    (default: 1)
27439beb93cSSam Leffler  * Authenticated Key Management Suite List (4 * n octets)
27539beb93cSSam Leffler  *    (default: unspec 802.1X)
27639beb93cSSam Leffler  * RSN Capabilities (2 octets, little endian) (default: 0)
27739beb93cSSam Leffler  * PMKID Count (2 octets) (default: 0)
27839beb93cSSam Leffler  * PMKID List (16 * n octets)
27939beb93cSSam Leffler  * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
28039beb93cSSam Leffler  */
28139beb93cSSam Leffler 
28239beb93cSSam Leffler struct rsn_ie_hdr {
28339beb93cSSam Leffler 	u8 elem_id; /* WLAN_EID_RSN */
28439beb93cSSam Leffler 	u8 len;
28539beb93cSSam Leffler 	u8 version[2]; /* little endian */
28639beb93cSSam Leffler } STRUCT_PACKED;
28739beb93cSSam Leffler 
28839beb93cSSam Leffler 
28939beb93cSSam Leffler struct rsn_error_kde {
29039beb93cSSam Leffler 	be16 mui;
29139beb93cSSam Leffler 	be16 error_type;
29239beb93cSSam Leffler } STRUCT_PACKED;
29339beb93cSSam Leffler 
29439beb93cSSam Leffler #ifdef CONFIG_IEEE80211W
2955b9c547cSRui Paulo #define WPA_IGTK_KDE_PREFIX_LEN (2 + 6)
29639beb93cSSam Leffler struct wpa_igtk_kde {
29739beb93cSSam Leffler 	u8 keyid[2];
29839beb93cSSam Leffler 	u8 pn[6];
2995b9c547cSRui Paulo 	u8 igtk[WPA_IGTK_MAX_LEN];
30039beb93cSSam Leffler } STRUCT_PACKED;
30139beb93cSSam Leffler #endif /* CONFIG_IEEE80211W */
30239beb93cSSam Leffler 
30339beb93cSSam Leffler struct rsn_mdie {
30439beb93cSSam Leffler 	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
30539beb93cSSam Leffler 	u8 ft_capab;
30639beb93cSSam Leffler } STRUCT_PACKED;
30739beb93cSSam Leffler 
30839beb93cSSam Leffler #define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
30939beb93cSSam Leffler #define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
31039beb93cSSam Leffler 
31139beb93cSSam Leffler struct rsn_ftie {
31239beb93cSSam Leffler 	u8 mic_control[2];
31339beb93cSSam Leffler 	u8 mic[16];
31439beb93cSSam Leffler 	u8 anonce[WPA_NONCE_LEN];
31539beb93cSSam Leffler 	u8 snonce[WPA_NONCE_LEN];
31639beb93cSSam Leffler 	/* followed by optional parameters */
31739beb93cSSam Leffler } STRUCT_PACKED;
31839beb93cSSam Leffler 
31985732ac8SCy Schubert struct rsn_ftie_sha384 {
32085732ac8SCy Schubert 	u8 mic_control[2];
32185732ac8SCy Schubert 	u8 mic[24];
32285732ac8SCy Schubert 	u8 anonce[WPA_NONCE_LEN];
32385732ac8SCy Schubert 	u8 snonce[WPA_NONCE_LEN];
32485732ac8SCy Schubert 	/* followed by optional parameters */
32585732ac8SCy Schubert } STRUCT_PACKED;
32685732ac8SCy Schubert 
32739beb93cSSam Leffler #define FTIE_SUBELEM_R1KH_ID 1
32839beb93cSSam Leffler #define FTIE_SUBELEM_GTK 2
32939beb93cSSam Leffler #define FTIE_SUBELEM_R0KH_ID 3
33039beb93cSSam Leffler #define FTIE_SUBELEM_IGTK 4
331*4bc52338SCy Schubert #define FTIE_SUBELEM_OCI 5
33239beb93cSSam Leffler 
333e28a4053SRui Paulo struct rsn_rdie {
334e28a4053SRui Paulo 	u8 id;
335e28a4053SRui Paulo 	u8 descr_count;
336e28a4053SRui Paulo 	le16 status_code;
337e28a4053SRui Paulo } STRUCT_PACKED;
338e28a4053SRui Paulo 
33939beb93cSSam Leffler 
34039beb93cSSam Leffler #ifdef _MSC_VER
34139beb93cSSam Leffler #pragma pack(pop)
34239beb93cSSam Leffler #endif /* _MSC_VER */
34339beb93cSSam Leffler 
34439beb93cSSam Leffler 
3455b9c547cSRui Paulo int wpa_eapol_key_mic(const u8 *key, size_t key_len, int akmp, int ver,
3465b9c547cSRui Paulo 		      const u8 *buf, size_t len, u8 *mic);
3475b9c547cSRui Paulo int wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label,
34839beb93cSSam Leffler 		   const u8 *addr1, const u8 *addr2,
34939beb93cSSam Leffler 		   const u8 *nonce1, const u8 *nonce2,
350*4bc52338SCy Schubert 		   struct wpa_ptk *ptk, int akmp, int cipher,
351*4bc52338SCy Schubert 		   const u8 *z, size_t z_len);
35285732ac8SCy Schubert int fils_rmsk_to_pmk(int akmp, const u8 *rmsk, size_t rmsk_len,
35385732ac8SCy Schubert 		     const u8 *snonce, const u8 *anonce, const u8 *dh_ss,
35485732ac8SCy Schubert 		     size_t dh_ss_len, u8 *pmk, size_t *pmk_len);
35585732ac8SCy Schubert int fils_pmkid_erp(int akmp, const u8 *reauth, size_t reauth_len,
35685732ac8SCy Schubert 		   u8 *pmkid);
35785732ac8SCy Schubert int fils_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const u8 *spa, const u8 *aa,
35885732ac8SCy Schubert 		    const u8 *snonce, const u8 *anonce, const u8 *dhss,
35985732ac8SCy Schubert 		    size_t dhss_len, struct wpa_ptk *ptk,
36085732ac8SCy Schubert 		    u8 *ick, size_t *ick_len, int akmp, int cipher,
36185732ac8SCy Schubert 		    u8 *fils_ft, size_t *fils_ft_len);
36285732ac8SCy Schubert int fils_key_auth_sk(const u8 *ick, size_t ick_len, const u8 *snonce,
36385732ac8SCy Schubert 		     const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
36485732ac8SCy Schubert 		     const u8 *g_sta, size_t g_sta_len,
36585732ac8SCy Schubert 		     const u8 *g_ap, size_t g_ap_len,
36685732ac8SCy Schubert 		     int akmp, u8 *key_auth_sta, u8 *key_auth_ap,
36785732ac8SCy Schubert 		     size_t *key_auth_len);
36839beb93cSSam Leffler 
36939beb93cSSam Leffler #ifdef CONFIG_IEEE80211R
3705b9c547cSRui Paulo int wpa_ft_mic(const u8 *kck, size_t kck_len, const u8 *sta_addr,
3715b9c547cSRui Paulo 	       const u8 *ap_addr, u8 transaction_seqnum,
3725b9c547cSRui Paulo 	       const u8 *mdie, size_t mdie_len,
37339beb93cSSam Leffler 	       const u8 *ftie, size_t ftie_len,
37439beb93cSSam Leffler 	       const u8 *rsnie, size_t rsnie_len,
37539beb93cSSam Leffler 	       const u8 *ric, size_t ric_len, u8 *mic);
37685732ac8SCy Schubert int wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len,
37739beb93cSSam Leffler 		      const u8 *ssid, size_t ssid_len,
37839beb93cSSam Leffler 		      const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len,
37985732ac8SCy Schubert 		      const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name,
38085732ac8SCy Schubert 		      int use_sha384);
38185732ac8SCy Schubert int wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id,
38285732ac8SCy Schubert 			   const u8 *s1kh_id, u8 *pmk_r1_name, int use_sha384);
38385732ac8SCy Schubert int wpa_derive_pmk_r1(const u8 *pmk_r0, size_t pmk_r0_len,
38485732ac8SCy Schubert 		      const u8 *pmk_r0_name,
38539beb93cSSam Leffler 		      const u8 *r1kh_id, const u8 *s1kh_id,
38639beb93cSSam Leffler 		      u8 *pmk_r1, u8 *pmk_r1_name);
38785732ac8SCy Schubert int wpa_pmk_r1_to_ptk(const u8 *pmk_r1, size_t pmk_r1_len, const u8 *snonce,
38885732ac8SCy Schubert 		      const u8 *anonce, const u8 *sta_addr, const u8 *bssid,
38939beb93cSSam Leffler 		      const u8 *pmk_r1_name,
3905b9c547cSRui Paulo 		      struct wpa_ptk *ptk, u8 *ptk_name, int akmp, int cipher);
39139beb93cSSam Leffler #endif /* CONFIG_IEEE80211R */
39239beb93cSSam Leffler 
39339beb93cSSam Leffler struct wpa_ie_data {
39439beb93cSSam Leffler 	int proto;
39539beb93cSSam Leffler 	int pairwise_cipher;
396*4bc52338SCy Schubert 	int has_pairwise;
39739beb93cSSam Leffler 	int group_cipher;
398*4bc52338SCy Schubert 	int has_group;
39939beb93cSSam Leffler 	int key_mgmt;
40039beb93cSSam Leffler 	int capabilities;
40139beb93cSSam Leffler 	size_t num_pmkid;
40239beb93cSSam Leffler 	const u8 *pmkid;
40339beb93cSSam Leffler 	int mgmt_group_cipher;
40439beb93cSSam Leffler };
40539beb93cSSam Leffler 
40639beb93cSSam Leffler 
40739beb93cSSam Leffler int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len,
40839beb93cSSam Leffler 			 struct wpa_ie_data *data);
409f05cddf9SRui Paulo int wpa_parse_wpa_ie_wpa(const u8 *wpa_ie, size_t wpa_ie_len,
410f05cddf9SRui Paulo 			 struct wpa_ie_data *data);
411*4bc52338SCy Schubert int wpa_default_rsn_cipher(int freq);
41239beb93cSSam Leffler 
413e28a4053SRui Paulo void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa,
41485732ac8SCy Schubert 	       u8 *pmkid, int akmp);
4155b9c547cSRui Paulo #ifdef CONFIG_SUITEB
4165b9c547cSRui Paulo int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
4175b9c547cSRui Paulo 		       const u8 *spa, u8 *pmkid);
4185b9c547cSRui Paulo #else /* CONFIG_SUITEB */
4195b9c547cSRui Paulo static inline int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
4205b9c547cSRui Paulo 				    const u8 *spa, u8 *pmkid)
4215b9c547cSRui Paulo {
4225b9c547cSRui Paulo 	return -1;
4235b9c547cSRui Paulo }
4245b9c547cSRui Paulo #endif /* CONFIG_SUITEB */
4255b9c547cSRui Paulo #ifdef CONFIG_SUITEB192
4265b9c547cSRui Paulo int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len, const u8 *aa,
4275b9c547cSRui Paulo 			  const u8 *spa, u8 *pmkid);
4285b9c547cSRui Paulo #else /* CONFIG_SUITEB192 */
4295b9c547cSRui Paulo static inline int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len,
4305b9c547cSRui Paulo 					const u8 *aa, const u8 *spa, u8 *pmkid)
4315b9c547cSRui Paulo {
4325b9c547cSRui Paulo 	return -1;
4335b9c547cSRui Paulo }
4345b9c547cSRui Paulo #endif /* CONFIG_SUITEB192 */
435e28a4053SRui Paulo 
436e28a4053SRui Paulo const char * wpa_cipher_txt(int cipher);
437e28a4053SRui Paulo const char * wpa_key_mgmt_txt(int key_mgmt, int proto);
4385b9c547cSRui Paulo u32 wpa_akm_to_suite(int akm);
439e28a4053SRui Paulo int wpa_compare_rsn_ie(int ft_initial_assoc,
440e28a4053SRui Paulo 		       const u8 *ie1, size_t ie1len,
441e28a4053SRui Paulo 		       const u8 *ie2, size_t ie2len);
442780fb4a2SCy Schubert int wpa_insert_pmkid(u8 *ies, size_t *ies_len, const u8 *pmkid);
443e28a4053SRui Paulo 
444f05cddf9SRui Paulo struct wpa_ft_ies {
445f05cddf9SRui Paulo 	const u8 *mdie;
446f05cddf9SRui Paulo 	size_t mdie_len;
447f05cddf9SRui Paulo 	const u8 *ftie;
448f05cddf9SRui Paulo 	size_t ftie_len;
449f05cddf9SRui Paulo 	const u8 *r1kh_id;
450f05cddf9SRui Paulo 	const u8 *gtk;
451f05cddf9SRui Paulo 	size_t gtk_len;
452f05cddf9SRui Paulo 	const u8 *r0kh_id;
453f05cddf9SRui Paulo 	size_t r0kh_id_len;
454f05cddf9SRui Paulo 	const u8 *rsn;
455f05cddf9SRui Paulo 	size_t rsn_len;
456f05cddf9SRui Paulo 	const u8 *rsn_pmkid;
457f05cddf9SRui Paulo 	const u8 *tie;
458f05cddf9SRui Paulo 	size_t tie_len;
459f05cddf9SRui Paulo 	const u8 *igtk;
460f05cddf9SRui Paulo 	size_t igtk_len;
461*4bc52338SCy Schubert #ifdef CONFIG_OCV
462*4bc52338SCy Schubert 	const u8 *oci;
463*4bc52338SCy Schubert 	size_t oci_len;
464*4bc52338SCy Schubert #endif /* CONFIG_OCV */
465f05cddf9SRui Paulo 	const u8 *ric;
466f05cddf9SRui Paulo 	size_t ric_len;
46785732ac8SCy Schubert 	int key_mgmt;
46885732ac8SCy Schubert 	int pairwise_cipher;
469f05cddf9SRui Paulo };
470f05cddf9SRui Paulo 
47185732ac8SCy Schubert int wpa_ft_parse_ies(const u8 *ies, size_t ies_len, struct wpa_ft_ies *parse,
47285732ac8SCy Schubert 		     int use_sha384);
473f05cddf9SRui Paulo 
474f05cddf9SRui Paulo int wpa_cipher_key_len(int cipher);
475f05cddf9SRui Paulo int wpa_cipher_rsc_len(int cipher);
47685732ac8SCy Schubert enum wpa_alg wpa_cipher_to_alg(int cipher);
477325151a3SRui Paulo int wpa_cipher_valid_group(int cipher);
478f05cddf9SRui Paulo int wpa_cipher_valid_pairwise(int cipher);
4795b9c547cSRui Paulo int wpa_cipher_valid_mgmt_group(int cipher);
480f05cddf9SRui Paulo u32 wpa_cipher_to_suite(int proto, int cipher);
481f05cddf9SRui Paulo int rsn_cipher_put_suites(u8 *pos, int ciphers);
482f05cddf9SRui Paulo int wpa_cipher_put_suites(u8 *pos, int ciphers);
4835b9c547cSRui Paulo int wpa_pick_pairwise_cipher(int ciphers, int none_allowed);
4845b9c547cSRui Paulo int wpa_pick_group_cipher(int ciphers);
4855b9c547cSRui Paulo int wpa_parse_cipher(const char *value);
4865b9c547cSRui Paulo int wpa_write_ciphers(char *start, char *end, int ciphers, const char *delim);
4875b9c547cSRui Paulo int wpa_select_ap_group_cipher(int wpa, int wpa_pairwise, int rsn_pairwise);
48885732ac8SCy Schubert unsigned int wpa_mic_len(int akmp, size_t pmk_len);
48985732ac8SCy Schubert int wpa_use_akm_defined(int akmp);
49085732ac8SCy Schubert int wpa_use_cmac(int akmp);
49185732ac8SCy Schubert int wpa_use_aes_key_wrap(int akmp);
49285732ac8SCy Schubert int fils_domain_name_hash(const char *domain, u8 *hash);
493f05cddf9SRui Paulo 
49439beb93cSSam Leffler #endif /* WPA_COMMON_H */
495