1/*
2 * WPA definitions shared between hostapd and wpa_supplicant
3 * Copyright (c) 2002-2015, 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 WPA_REPLAY_COUNTER_LEN 8
16#define WPA_NONCE_LEN 32
17#define WPA_KEY_RSC_LEN 8
18#define WPA_GMK_LEN 32
19#define WPA_GTK_MAX_LEN 32
20
21#define WPA_ALLOWED_PAIRWISE_CIPHERS \
22(WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | WPA_CIPHER_NONE | \
23WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256)
24#define WPA_ALLOWED_GROUP_CIPHERS \
25(WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | \
26WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256 | \
27WPA_CIPHER_GTK_NOT_USED)
28
29#define WPA_SELECTOR_LEN 4
30#define WPA_VERSION 1
31#define RSN_SELECTOR_LEN 4
32#define RSN_VERSION 1
33
34#define RSN_SELECTOR(a, b, c, d) \
35	((((u32) (a)) << 24) | (((u32) (b)) << 16) | (((u32) (c)) << 8) | \
36	 (u32) (d))
37
38#define WPA_AUTH_KEY_MGMT_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
39#define WPA_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
40#define WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
41#define WPA_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0)
42#define WPA_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
43#define WPA_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
44#define WPA_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x50, 0xf2, 4)
45
46
47#define RSN_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
48#define RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
49#ifdef CONFIG_IEEE80211R
50#define RSN_AUTH_KEY_MGMT_FT_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
51#define RSN_AUTH_KEY_MGMT_FT_PSK RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
52#endif /* CONFIG_IEEE80211R */
53#define RSN_AUTH_KEY_MGMT_802_1X_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
54#define RSN_AUTH_KEY_MGMT_PSK_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
55#define RSN_AUTH_KEY_MGMT_TPK_HANDSHAKE RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
56#define RSN_AUTH_KEY_MGMT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
57#define RSN_AUTH_KEY_MGMT_FT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
58#define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
59#define RSN_AUTH_KEY_MGMT_802_1X_SUITE_B_192 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
60#define RSN_AUTH_KEY_MGMT_FT_802_1X_SUITE_B_192 \
61RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
62#define RSN_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0x00)
63#define RSN_AUTH_KEY_MGMT_OSEN RSN_SELECTOR(0x50, 0x6f, 0x9a, 0x01)
64
65#define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0)
66#define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
67#if 0
68#define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
69#endif
70#define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
71#define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
72#define RSN_CIPHER_SUITE_NO_GROUP_ADDRESSED RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
73#define RSN_CIPHER_SUITE_GCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
74#define RSN_CIPHER_SUITE_GCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
75#define RSN_CIPHER_SUITE_CCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
76#define RSN_CIPHER_SUITE_BIP_GMAC_128 RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
77#define RSN_CIPHER_SUITE_BIP_GMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
78#define RSN_CIPHER_SUITE_BIP_CMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
79
80/* EAPOL-Key Key Data Encapsulation
81 * GroupKey and PeerKey require encryption, otherwise, encryption is optional.
82 */
83#define RSN_KEY_DATA_GROUPKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
84#if 0
85#define RSN_KEY_DATA_STAKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
86#endif
87#define RSN_KEY_DATA_MAC_ADDR RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
88#define RSN_KEY_DATA_PMKID RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
89#ifdef CONFIG_PEERKEY
90#define RSN_KEY_DATA_SMK RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
91#define RSN_KEY_DATA_NONCE RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
92#define RSN_KEY_DATA_LIFETIME RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
93#define RSN_KEY_DATA_ERROR RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
94#endif /* CONFIG_PEERKEY */
95#ifdef CONFIG_IEEE80211W
96#define RSN_KEY_DATA_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
97#endif /* CONFIG_IEEE80211W */
98#define RSN_KEY_DATA_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
99#define RSN_KEY_DATA_MULTIBAND_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
100#define RSN_KEY_DATA_MULTIBAND_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
101
102#define WFA_KEY_DATA_IP_ADDR_REQ RSN_SELECTOR(0x50, 0x6f, 0x9a, 4)
103#define WFA_KEY_DATA_IP_ADDR_ALLOC RSN_SELECTOR(0x50, 0x6f, 0x9a, 5)
104
105#define WPA_OUI_TYPE RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
106
107#define RSN_SELECTOR_PUT(a, val) WPA_PUT_BE32((u8 *) (a), (val))
108#define RSN_SELECTOR_GET(a) WPA_GET_BE32((const u8 *) (a))
109
110#define RSN_NUM_REPLAY_COUNTERS_1 0
111#define RSN_NUM_REPLAY_COUNTERS_2 1
112#define RSN_NUM_REPLAY_COUNTERS_4 2
113#define RSN_NUM_REPLAY_COUNTERS_16 3
114
115
116#ifdef _MSC_VER
117#pragma pack(push, 1)
118#endif /* _MSC_VER */
119
120#ifdef CONFIG_IEEE80211W
121#define WPA_IGTK_LEN 16
122#define WPA_IGTK_MAX_LEN 32
123#endif /* CONFIG_IEEE80211W */
124
125
126/* IEEE 802.11, 7.3.2.25.3 RSN Capabilities */
127#define WPA_CAPABILITY_PREAUTH BIT(0)
128#define WPA_CAPABILITY_NO_PAIRWISE BIT(1)
129/* B2-B3: PTKSA Replay Counter */
130/* B4-B5: GTKSA Replay Counter */
131#define WPA_CAPABILITY_MFPR BIT(6)
132#define WPA_CAPABILITY_MFPC BIT(7)
133/* B8: Reserved */
134#define WPA_CAPABILITY_PEERKEY_ENABLED BIT(9)
135#define WPA_CAPABILITY_SPP_A_MSDU_CAPABLE BIT(10)
136#define WPA_CAPABILITY_SPP_A_MSDU_REQUIRED BIT(11)
137#define WPA_CAPABILITY_PBAC BIT(12)
138#define WPA_CAPABILITY_EXT_KEY_ID_FOR_UNICAST BIT(13)
139/* B14-B15: Reserved */
140
141
142/* IEEE 802.11r */
143#define MOBILITY_DOMAIN_ID_LEN 2
144#define FT_R0KH_ID_MAX_LEN 48
145#define FT_R1KH_ID_LEN 6
146#define WPA_PMK_NAME_LEN 16
147
148
149/* IEEE 802.11, 8.5.2 EAPOL-Key frames */
150#define WPA_KEY_INFO_TYPE_MASK ((u16) (BIT(0) | BIT(1) | BIT(2)))
151#define WPA_KEY_INFO_TYPE_AKM_DEFINED 0
152#define WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 BIT(0)
153#define WPA_KEY_INFO_TYPE_HMAC_SHA1_AES BIT(1)
154#define WPA_KEY_INFO_TYPE_AES_128_CMAC 3
155#define WPA_KEY_INFO_KEY_TYPE BIT(3) /* 1 = Pairwise, 0 = Group key */
156/* bit4..5 is used in WPA, but is reserved in IEEE 802.11i/RSN */
157#define WPA_KEY_INFO_KEY_INDEX_MASK (BIT(4) | BIT(5))
158#define WPA_KEY_INFO_KEY_INDEX_SHIFT 4
159#define WPA_KEY_INFO_INSTALL BIT(6) /* pairwise */
160#define WPA_KEY_INFO_TXRX BIT(6) /* group */
161#define WPA_KEY_INFO_ACK BIT(7)
162#define WPA_KEY_INFO_MIC BIT(8)
163#define WPA_KEY_INFO_SECURE BIT(9)
164#define WPA_KEY_INFO_ERROR BIT(10)
165#define WPA_KEY_INFO_REQUEST BIT(11)
166#define WPA_KEY_INFO_ENCR_KEY_DATA BIT(12) /* IEEE 802.11i/RSN only */
167#define WPA_KEY_INFO_SMK_MESSAGE BIT(13)
168
169
170struct wpa_eapol_key {
171	u8 type;
172	/* Note: key_info, key_length, and key_data_length are unaligned */
173	u8 key_info[2]; /* big endian */
174	u8 key_length[2]; /* big endian */
175	u8 replay_counter[WPA_REPLAY_COUNTER_LEN];
176	u8 key_nonce[WPA_NONCE_LEN];
177	u8 key_iv[16];
178	u8 key_rsc[WPA_KEY_RSC_LEN];
179	u8 key_id[8]; /* Reserved in IEEE 802.11i/RSN */
180	u8 key_mic[16];
181	u8 key_data_length[2]; /* big endian */
182	/* followed by key_data_length bytes of key_data */
183} STRUCT_PACKED;
184
185struct wpa_eapol_key_192 {
186	u8 type;
187	/* Note: key_info, key_length, and key_data_length are unaligned */
188	u8 key_info[2]; /* big endian */
189	u8 key_length[2]; /* big endian */
190	u8 replay_counter[WPA_REPLAY_COUNTER_LEN];
191	u8 key_nonce[WPA_NONCE_LEN];
192	u8 key_iv[16];
193	u8 key_rsc[WPA_KEY_RSC_LEN];
194	u8 key_id[8]; /* Reserved in IEEE 802.11i/RSN */
195	u8 key_mic[24];
196	u8 key_data_length[2]; /* big endian */
197	/* followed by key_data_length bytes of key_data */
198} STRUCT_PACKED;
199
200#define WPA_EAPOL_KEY_MIC_MAX_LEN 24
201#define WPA_KCK_MAX_LEN 24
202#define WPA_KEK_MAX_LEN 32
203#define WPA_TK_MAX_LEN 32
204
205/**
206 * struct wpa_ptk - WPA Pairwise Transient Key
207 * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy
208 */
209struct wpa_ptk {
210	u8 kck[WPA_KCK_MAX_LEN]; /* EAPOL-Key Key Confirmation Key (KCK) */
211	u8 kek[WPA_KEK_MAX_LEN]; /* EAPOL-Key Key Encryption Key (KEK) */
212	u8 tk[WPA_TK_MAX_LEN]; /* Temporal Key (TK) */
213	size_t kck_len;
214	size_t kek_len;
215	size_t tk_len;
216};
217
218
219/* WPA IE version 1
220 * 00-50-f2:1 (OUI:OUI type)
221 * 0x01 0x00 (version; little endian)
222 * (all following fields are optional:)
223 * Group Suite Selector (4 octets) (default: TKIP)
224 * Pairwise Suite Count (2 octets, little endian) (default: 1)
225 * Pairwise Suite List (4 * n octets) (default: TKIP)
226 * Authenticated Key Management Suite Count (2 octets, little endian)
227 *    (default: 1)
228 * Authenticated Key Management Suite List (4 * n octets)
229 *    (default: unspec 802.1X)
230 * WPA Capabilities (2 octets, little endian) (default: 0)
231 */
232
233struct wpa_ie_hdr {
234	u8 elem_id;
235	u8 len;
236	u8 oui[4]; /* 24-bit OUI followed by 8-bit OUI type */
237	u8 version[2]; /* little endian */
238} STRUCT_PACKED;
239
240
241/* 1/4: PMKID
242 * 2/4: RSN IE
243 * 3/4: one or two RSN IEs + GTK IE (encrypted)
244 * 4/4: empty
245 * 1/2: GTK IE (encrypted)
246 * 2/2: empty
247 */
248
249/* RSN IE version 1
250 * 0x01 0x00 (version; little endian)
251 * (all following fields are optional:)
252 * Group Suite Selector (4 octets) (default: CCMP)
253 * Pairwise Suite Count (2 octets, little endian) (default: 1)
254 * Pairwise Suite List (4 * n octets) (default: CCMP)
255 * Authenticated Key Management Suite Count (2 octets, little endian)
256 *    (default: 1)
257 * Authenticated Key Management Suite List (4 * n octets)
258 *    (default: unspec 802.1X)
259 * RSN Capabilities (2 octets, little endian) (default: 0)
260 * PMKID Count (2 octets) (default: 0)
261 * PMKID List (16 * n octets)
262 * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
263 */
264
265struct rsn_ie_hdr {
266	u8 elem_id; /* WLAN_EID_RSN */
267	u8 len;
268	u8 version[2]; /* little endian */
269} STRUCT_PACKED;
270
271
272#ifdef CONFIG_PEERKEY
273enum {
274	STK_MUI_4WAY_STA_AP = 1,
275	STK_MUI_4WAY_STAT_STA = 2,
276	STK_MUI_GTK = 3,
277	STK_MUI_SMK = 4
278};
279
280enum {
281	STK_ERR_STA_NR = 1,
282	STK_ERR_STA_NRSN = 2,
283	STK_ERR_CPHR_NS = 3,
284	STK_ERR_NO_STSL = 4
285};
286#endif /* CONFIG_PEERKEY */
287
288struct rsn_error_kde {
289	be16 mui;
290	be16 error_type;
291} STRUCT_PACKED;
292
293#ifdef CONFIG_IEEE80211W
294#define WPA_IGTK_KDE_PREFIX_LEN (2 + 6)
295struct wpa_igtk_kde {
296	u8 keyid[2];
297	u8 pn[6];
298	u8 igtk[WPA_IGTK_MAX_LEN];
299} STRUCT_PACKED;
300#endif /* CONFIG_IEEE80211W */
301
302struct rsn_mdie {
303	u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
304	u8 ft_capab;
305} STRUCT_PACKED;
306
307#define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
308#define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
309
310struct rsn_ftie {
311	u8 mic_control[2];
312	u8 mic[16];
313	u8 anonce[WPA_NONCE_LEN];
314	u8 snonce[WPA_NONCE_LEN];
315	/* followed by optional parameters */
316} STRUCT_PACKED;
317
318#define FTIE_SUBELEM_R1KH_ID 1
319#define FTIE_SUBELEM_GTK 2
320#define FTIE_SUBELEM_R0KH_ID 3
321#define FTIE_SUBELEM_IGTK 4
322
323struct rsn_rdie {
324	u8 id;
325	u8 descr_count;
326	le16 status_code;
327} STRUCT_PACKED;
328
329
330#ifdef _MSC_VER
331#pragma pack(pop)
332#endif /* _MSC_VER */
333
334
335int wpa_eapol_key_mic(const u8 *key, size_t key_len, int akmp, int ver,
336		      const u8 *buf, size_t len, u8 *mic);
337int wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label,
338		   const u8 *addr1, const u8 *addr2,
339		   const u8 *nonce1, const u8 *nonce2,
340		   struct wpa_ptk *ptk, int akmp, int cipher);
341
342#ifdef CONFIG_IEEE80211R
343int wpa_ft_mic(const u8 *kck, size_t kck_len, const u8 *sta_addr,
344	       const u8 *ap_addr, u8 transaction_seqnum,
345	       const u8 *mdie, size_t mdie_len,
346	       const u8 *ftie, size_t ftie_len,
347	       const u8 *rsnie, size_t rsnie_len,
348	       const u8 *ric, size_t ric_len, u8 *mic);
349void wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len,
350		       const u8 *ssid, size_t ssid_len,
351		       const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len,
352		       const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name);
353void wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id,
354			    const u8 *s1kh_id, u8 *pmk_r1_name);
355void wpa_derive_pmk_r1(const u8 *pmk_r0, const u8 *pmk_r0_name,
356		       const u8 *r1kh_id, const u8 *s1kh_id,
357		       u8 *pmk_r1, u8 *pmk_r1_name);
358int wpa_pmk_r1_to_ptk(const u8 *pmk_r1, const u8 *snonce, const u8 *anonce,
359		      const u8 *sta_addr, const u8 *bssid,
360		      const u8 *pmk_r1_name,
361		      struct wpa_ptk *ptk, u8 *ptk_name, int akmp, int cipher);
362#endif /* CONFIG_IEEE80211R */
363
364struct wpa_ie_data {
365	int proto;
366	int pairwise_cipher;
367	int group_cipher;
368	int key_mgmt;
369	int capabilities;
370	size_t num_pmkid;
371	const u8 *pmkid;
372	int mgmt_group_cipher;
373};
374
375
376int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len,
377			 struct wpa_ie_data *data);
378int wpa_parse_wpa_ie_wpa(const u8 *wpa_ie, size_t wpa_ie_len,
379			 struct wpa_ie_data *data);
380
381void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa,
382	       u8 *pmkid, int use_sha256);
383#ifdef CONFIG_SUITEB
384int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
385		       const u8 *spa, u8 *pmkid);
386#else /* CONFIG_SUITEB */
387static inline int rsn_pmkid_suite_b(const u8 *kck, size_t kck_len, const u8 *aa,
388				    const u8 *spa, u8 *pmkid)
389{
390	return -1;
391}
392#endif /* CONFIG_SUITEB */
393#ifdef CONFIG_SUITEB192
394int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len, const u8 *aa,
395			  const u8 *spa, u8 *pmkid);
396#else /* CONFIG_SUITEB192 */
397static inline int rsn_pmkid_suite_b_192(const u8 *kck, size_t kck_len,
398					const u8 *aa, const u8 *spa, u8 *pmkid)
399{
400	return -1;
401}
402#endif /* CONFIG_SUITEB192 */
403
404const char * wpa_cipher_txt(int cipher);
405const char * wpa_key_mgmt_txt(int key_mgmt, int proto);
406u32 wpa_akm_to_suite(int akm);
407int wpa_compare_rsn_ie(int ft_initial_assoc,
408		       const u8 *ie1, size_t ie1len,
409		       const u8 *ie2, size_t ie2len);
410int wpa_insert_pmkid(u8 *ies, size_t ies_len, const u8 *pmkid);
411
412struct wpa_ft_ies {
413	const u8 *mdie;
414	size_t mdie_len;
415	const u8 *ftie;
416	size_t ftie_len;
417	const u8 *r1kh_id;
418	const u8 *gtk;
419	size_t gtk_len;
420	const u8 *r0kh_id;
421	size_t r0kh_id_len;
422	const u8 *rsn;
423	size_t rsn_len;
424	const u8 *rsn_pmkid;
425	const u8 *tie;
426	size_t tie_len;
427	const u8 *igtk;
428	size_t igtk_len;
429	const u8 *ric;
430	size_t ric_len;
431};
432
433int wpa_ft_parse_ies(const u8 *ies, size_t ies_len, struct wpa_ft_ies *parse);
434
435int wpa_cipher_key_len(int cipher);
436int wpa_cipher_rsc_len(int cipher);
437int wpa_cipher_to_alg(int cipher);
438int wpa_cipher_valid_pairwise(int cipher);
439int wpa_cipher_valid_mgmt_group(int cipher);
440u32 wpa_cipher_to_suite(int proto, int cipher);
441int rsn_cipher_put_suites(u8 *pos, int ciphers);
442int wpa_cipher_put_suites(u8 *pos, int ciphers);
443int wpa_pick_pairwise_cipher(int ciphers, int none_allowed);
444int wpa_pick_group_cipher(int ciphers);
445int wpa_parse_cipher(const char *value);
446int wpa_write_ciphers(char *start, char *end, int ciphers, const char *delim);
447int wpa_select_ap_group_cipher(int wpa, int wpa_pairwise, int rsn_pairwise);
448unsigned int wpa_mic_len(int akmp);
449
450#endif /* WPA_COMMON_H */
451