source: wpa_supplicant/vendor/current/src/common/wpa_common.h@ 793

Last change on this file since 793 was 793, checked in by andi.b@gmx.net, 11 years ago

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