]> git.ipfire.org Git - thirdparty/hostap.git/blame - src/common/wpa_common.h
Re-initialize hostapd/wpa_supplicant git repository based on 0.6.3 release
[thirdparty/hostap.git] / src / common / wpa_common.h
CommitLineData
6fc6879b
JM
1/*
2 * WPA definitions shared between hostapd and wpa_supplicant
3 * Copyright (c) 2002-2007, Jouni Malinen <j@w1.fi>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
8 *
9 * Alternatively, this software may be distributed under the terms of BSD
10 * license.
11 *
12 * See README and COPYING for more details.
13 */
14
15#ifndef WPA_COMMON_H
16#define WPA_COMMON_H
17
18#define WPA_MAX_SSID_LEN 32
19
20/* IEEE 802.11i */
21#define PMKID_LEN 16
22#define PMK_LEN 32
23#define WPA_REPLAY_COUNTER_LEN 8
24#define WPA_NONCE_LEN 32
25#define WPA_KEY_RSC_LEN 8
26#define WPA_GMK_LEN 32
27#define WPA_GTK_MAX_LEN 32
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_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
42#define WPA_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
43#define WPA_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
44#if 0
45#define WPA_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x50, 0xf2, 3)
46#endif
47#define WPA_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x50, 0xf2, 4)
48#define WPA_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x50, 0xf2, 5)
49
50
51#define RSN_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
52#define RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
53#ifdef CONFIG_IEEE80211R
54#define RSN_AUTH_KEY_MGMT_FT_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
55#define RSN_AUTH_KEY_MGMT_FT_PSK RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
56#endif /* CONFIG_IEEE80211R */
57#define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0)
58#define RSN_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
59#define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
60#if 0
61#define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
62#endif
63#define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
64#define RSN_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
65#ifdef CONFIG_IEEE80211W
66#define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
67#endif /* CONFIG_IEEE80211W */
68
69/* EAPOL-Key Key Data Encapsulation
70 * GroupKey and PeerKey require encryption, otherwise, encryption is optional.
71 */
72#define RSN_KEY_DATA_GROUPKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
73#if 0
74#define RSN_KEY_DATA_STAKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
75#endif
76#define RSN_KEY_DATA_MAC_ADDR RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
77#define RSN_KEY_DATA_PMKID RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
78#ifdef CONFIG_PEERKEY
79#define RSN_KEY_DATA_SMK RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
80#define RSN_KEY_DATA_NONCE RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
81#define RSN_KEY_DATA_LIFETIME RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
82#define RSN_KEY_DATA_ERROR RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
83#endif /* CONFIG_PEERKEY */
84#ifdef CONFIG_IEEE80211W
85#define RSN_KEY_DATA_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
86#endif /* CONFIG_IEEE80211W */
87
88#define WPA_OUI_TYPE RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
89
90#define RSN_SELECTOR_PUT(a, val) WPA_PUT_BE32((a), (val))
91#define RSN_SELECTOR_GET(a) WPA_GET_BE32((a))
92
93#define RSN_NUM_REPLAY_COUNTERS_1 0
94#define RSN_NUM_REPLAY_COUNTERS_2 1
95#define RSN_NUM_REPLAY_COUNTERS_4 2
96#define RSN_NUM_REPLAY_COUNTERS_16 3
97
98
99#ifdef _MSC_VER
100#pragma pack(push, 1)
101#endif /* _MSC_VER */
102
103#ifdef CONFIG_IEEE80211W
104#define WPA_IGTK_LEN 16
105#endif /* CONFIG_IEEE80211W */
106
107
108/* IEEE 802.11, 7.3.2.25.3 RSN Capabilities */
109#define WPA_CAPABILITY_PREAUTH BIT(0)
110#define WPA_CAPABILITY_MGMT_FRAME_PROTECTION BIT(7)
111#define WPA_CAPABILITY_PEERKEY_ENABLED BIT(9)
112
113
114/* IEEE 802.11r */
115#define MOBILITY_DOMAIN_ID_LEN 2
116#define FT_R0KH_ID_MAX_LEN 48
117#define FT_R1KH_ID_LEN 6
118#define WPA_PMK_NAME_LEN 16
119
120
121/* IEEE 802.11, 8.5.2 EAPOL-Key frames */
122#define WPA_KEY_INFO_TYPE_MASK ((u16) (BIT(0) | BIT(1) | BIT(2)))
123#define WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 BIT(0)
124#define WPA_KEY_INFO_TYPE_HMAC_SHA1_AES BIT(1)
125#define WPA_KEY_INFO_TYPE_AES_128_CMAC 3
126#define WPA_KEY_INFO_KEY_TYPE BIT(3) /* 1 = Pairwise, 0 = Group key */
127/* bit4..5 is used in WPA, but is reserved in IEEE 802.11i/RSN */
128#define WPA_KEY_INFO_KEY_INDEX_MASK (BIT(4) | BIT(5))
129#define WPA_KEY_INFO_KEY_INDEX_SHIFT 4
130#define WPA_KEY_INFO_INSTALL BIT(6) /* pairwise */
131#define WPA_KEY_INFO_TXRX BIT(6) /* group */
132#define WPA_KEY_INFO_ACK BIT(7)
133#define WPA_KEY_INFO_MIC BIT(8)
134#define WPA_KEY_INFO_SECURE BIT(9)
135#define WPA_KEY_INFO_ERROR BIT(10)
136#define WPA_KEY_INFO_REQUEST BIT(11)
137#define WPA_KEY_INFO_ENCR_KEY_DATA BIT(12) /* IEEE 802.11i/RSN only */
138#define WPA_KEY_INFO_SMK_MESSAGE BIT(13)
139
140
141struct wpa_eapol_key {
142 u8 type;
143 /* Note: key_info, key_length, and key_data_length are unaligned */
144 u8 key_info[2]; /* big endian */
145 u8 key_length[2]; /* big endian */
146 u8 replay_counter[WPA_REPLAY_COUNTER_LEN];
147 u8 key_nonce[WPA_NONCE_LEN];
148 u8 key_iv[16];
149 u8 key_rsc[WPA_KEY_RSC_LEN];
150 u8 key_id[8]; /* Reserved in IEEE 802.11i/RSN */
151 u8 key_mic[16];
152 u8 key_data_length[2]; /* big endian */
153 /* followed by key_data_length bytes of key_data */
154} STRUCT_PACKED;
155
156/**
157 * struct wpa_ptk - WPA Pairwise Transient Key
158 * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy
159 */
160struct wpa_ptk {
161 u8 kck[16]; /* EAPOL-Key Key Confirmation Key (KCK) */
162 u8 kek[16]; /* EAPOL-Key Key Encryption Key (KEK) */
163 u8 tk1[16]; /* Temporal Key 1 (TK1) */
164 union {
165 u8 tk2[16]; /* Temporal Key 2 (TK2) */
166 struct {
167 u8 tx_mic_key[8];
168 u8 rx_mic_key[8];
169 } auth;
170 } u;
171} STRUCT_PACKED;
172
173
174/* WPA IE version 1
175 * 00-50-f2:1 (OUI:OUI type)
176 * 0x01 0x00 (version; little endian)
177 * (all following fields are optional:)
178 * Group Suite Selector (4 octets) (default: TKIP)
179 * Pairwise Suite Count (2 octets, little endian) (default: 1)
180 * Pairwise Suite List (4 * n octets) (default: TKIP)
181 * Authenticated Key Management Suite Count (2 octets, little endian)
182 * (default: 1)
183 * Authenticated Key Management Suite List (4 * n octets)
184 * (default: unspec 802.1X)
185 * WPA Capabilities (2 octets, little endian) (default: 0)
186 */
187
188struct wpa_ie_hdr {
189 u8 elem_id;
190 u8 len;
191 u8 oui[3];
192 u8 oui_type;
193 u8 version[2]; /* little endian */
194} STRUCT_PACKED;
195
196
197/* 1/4: PMKID
198 * 2/4: RSN IE
199 * 3/4: one or two RSN IEs + GTK IE (encrypted)
200 * 4/4: empty
201 * 1/2: GTK IE (encrypted)
202 * 2/2: empty
203 */
204
205/* RSN IE version 1
206 * 0x01 0x00 (version; little endian)
207 * (all following fields are optional:)
208 * Group Suite Selector (4 octets) (default: CCMP)
209 * Pairwise Suite Count (2 octets, little endian) (default: 1)
210 * Pairwise Suite List (4 * n octets) (default: CCMP)
211 * Authenticated Key Management Suite Count (2 octets, little endian)
212 * (default: 1)
213 * Authenticated Key Management Suite List (4 * n octets)
214 * (default: unspec 802.1X)
215 * RSN Capabilities (2 octets, little endian) (default: 0)
216 * PMKID Count (2 octets) (default: 0)
217 * PMKID List (16 * n octets)
218 * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
219 */
220
221struct rsn_ie_hdr {
222 u8 elem_id; /* WLAN_EID_RSN */
223 u8 len;
224 u8 version[2]; /* little endian */
225} STRUCT_PACKED;
226
227
228#ifdef CONFIG_PEERKEY
229enum {
230 STK_MUI_4WAY_STA_AP = 1,
231 STK_MUI_4WAY_STAT_STA = 2,
232 STK_MUI_GTK = 3,
233 STK_MUI_SMK = 4
234};
235
236enum {
237 STK_ERR_STA_NR = 1,
238 STK_ERR_STA_NRSN = 2,
239 STK_ERR_CPHR_NS = 3,
240 STK_ERR_NO_STSL = 4
241};
242#endif /* CONFIG_PEERKEY */
243
244struct rsn_error_kde {
245 be16 mui;
246 be16 error_type;
247} STRUCT_PACKED;
248
249#ifdef CONFIG_IEEE80211W
250struct wpa_igtk_kde {
251 u8 keyid[2];
252 u8 pn[6];
253 u8 igtk[WPA_IGTK_LEN];
254} STRUCT_PACKED;
255#endif /* CONFIG_IEEE80211W */
256
257#ifdef CONFIG_IEEE80211R
258struct rsn_mdie {
259 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
260 u8 ft_capab;
261} STRUCT_PACKED;
262
263#define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
264#define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
265
266struct rsn_ftie {
267 u8 mic_control[2];
268 u8 mic[16];
269 u8 anonce[WPA_NONCE_LEN];
270 u8 snonce[WPA_NONCE_LEN];
271 /* followed by optional parameters */
272} STRUCT_PACKED;
273
274#define FTIE_SUBELEM_R1KH_ID 1
275#define FTIE_SUBELEM_GTK 2
276#define FTIE_SUBELEM_R0KH_ID 3
277
278#endif /* CONFIG_IEEE80211R */
279
280#ifdef _MSC_VER
281#pragma pack(pop)
282#endif /* _MSC_VER */
283
284
285int wpa_eapol_key_mic(const u8 *key, int ver, const u8 *buf, size_t len,
286 u8 *mic);
287void wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label,
288 const u8 *addr1, const u8 *addr2,
289 const u8 *nonce1, const u8 *nonce2,
290 u8 *ptk, size_t ptk_len);
291
292#ifdef CONFIG_IEEE80211R
293int wpa_ft_mic(const u8 *kck, const u8 *sta_addr, const u8 *ap_addr,
294 u8 transaction_seqnum, const u8 *mdie, size_t mdie_len,
295 const u8 *ftie, size_t ftie_len,
296 const u8 *rsnie, size_t rsnie_len,
297 const u8 *ric, size_t ric_len, u8 *mic);
298void wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len,
299 const u8 *ssid, size_t ssid_len,
300 const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len,
301 const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name);
302void wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id,
303 const u8 *s1kh_id, u8 *pmk_r1_name);
304void wpa_derive_pmk_r1(const u8 *pmk_r0, const u8 *pmk_r0_name,
305 const u8 *r1kh_id, const u8 *s1kh_id,
306 u8 *pmk_r1, u8 *pmk_r1_name);
307void wpa_pmk_r1_to_ptk(const u8 *pmk_r1, const u8 *snonce, const u8 *anonce,
308 const u8 *sta_addr, const u8 *bssid,
309 const u8 *pmk_r1_name,
310 u8 *ptk, size_t ptk_len, u8 *ptk_name);
311#endif /* CONFIG_IEEE80211R */
312
313struct wpa_ie_data {
314 int proto;
315 int pairwise_cipher;
316 int group_cipher;
317 int key_mgmt;
318 int capabilities;
319 size_t num_pmkid;
320 const u8 *pmkid;
321 int mgmt_group_cipher;
322};
323
324
325int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len,
326 struct wpa_ie_data *data);
327
328#endif /* WPA_COMMON_H */