Merge branch 'vendor/TNFTP'
[dragonfly.git] / contrib / hostapd / src / common / wpa_common.h
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 | \
25 WPA_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 | \
28 WPA_CIPHER_WEP40 | WPA_CIPHER_GCMP_256 | WPA_CIPHER_CCMP_256 | \
29 WPA_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 \
68 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
69 #define RSN_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0x00)
70
71 #define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0)
72 #define RSN_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
73 #define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
74 #if 0
75 #define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
76 #endif
77 #define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
78 #define RSN_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
79 #ifdef CONFIG_IEEE80211W
80 #define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
81 #endif /* CONFIG_IEEE80211W */
82 #define RSN_CIPHER_SUITE_NO_GROUP_ADDRESSED RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
83 #define RSN_CIPHER_SUITE_GCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
84 #define RSN_CIPHER_SUITE_GCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
85 #define RSN_CIPHER_SUITE_CCMP_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
86 #define RSN_CIPHER_SUITE_BIP_GMAC_128 RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
87 #define RSN_CIPHER_SUITE_BIP_GMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
88 #define RSN_CIPHER_SUITE_BIP_CMAC_256 RSN_SELECTOR(0x00, 0x0f, 0xac, 13)
89
90 /* EAPOL-Key Key Data Encapsulation
91  * GroupKey and PeerKey require encryption, otherwise, encryption is optional.
92  */
93 #define RSN_KEY_DATA_GROUPKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
94 #if 0
95 #define RSN_KEY_DATA_STAKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
96 #endif
97 #define RSN_KEY_DATA_MAC_ADDR RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
98 #define RSN_KEY_DATA_PMKID RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
99 #ifdef CONFIG_PEERKEY
100 #define RSN_KEY_DATA_SMK RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
101 #define RSN_KEY_DATA_NONCE RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
102 #define RSN_KEY_DATA_LIFETIME RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
103 #define RSN_KEY_DATA_ERROR RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
104 #endif /* CONFIG_PEERKEY */
105 #ifdef CONFIG_IEEE80211W
106 #define RSN_KEY_DATA_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
107 #endif /* CONFIG_IEEE80211W */
108 #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)
111
112 #define WFA_KEY_DATA_IP_ADDR_REQ RSN_SELECTOR(0x50, 0x6f, 0x9a, 4)
113 #define WFA_KEY_DATA_IP_ADDR_ALLOC RSN_SELECTOR(0x50, 0x6f, 0x9a, 5)
114
115 #define WPA_OUI_TYPE RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
116
117 #define RSN_SELECTOR_PUT(a, val) WPA_PUT_BE32((u8 *) (a), (val))
118 #define RSN_SELECTOR_GET(a) WPA_GET_BE32((const u8 *) (a))
119
120 #define RSN_NUM_REPLAY_COUNTERS_1 0
121 #define RSN_NUM_REPLAY_COUNTERS_2 1
122 #define RSN_NUM_REPLAY_COUNTERS_4 2
123 #define RSN_NUM_REPLAY_COUNTERS_16 3
124
125
126 #ifdef _MSC_VER
127 #pragma pack(push, 1)
128 #endif /* _MSC_VER */
129
130 #ifdef CONFIG_IEEE80211W
131 #define WPA_IGTK_LEN 16
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_HMAC_MD5_RC4 BIT(0)
161 #define WPA_KEY_INFO_TYPE_HMAC_SHA1_AES BIT(1)
162 #define WPA_KEY_INFO_TYPE_AES_128_CMAC 3
163 #define WPA_KEY_INFO_KEY_TYPE BIT(3) /* 1 = Pairwise, 0 = Group key */
164 /* bit4..5 is used in WPA, but is reserved in IEEE 802.11i/RSN */
165 #define WPA_KEY_INFO_KEY_INDEX_MASK (BIT(4) | BIT(5))
166 #define WPA_KEY_INFO_KEY_INDEX_SHIFT 4
167 #define WPA_KEY_INFO_INSTALL BIT(6) /* pairwise */
168 #define WPA_KEY_INFO_TXRX BIT(6) /* group */
169 #define WPA_KEY_INFO_ACK BIT(7)
170 #define WPA_KEY_INFO_MIC BIT(8)
171 #define WPA_KEY_INFO_SECURE BIT(9)
172 #define WPA_KEY_INFO_ERROR BIT(10)
173 #define WPA_KEY_INFO_REQUEST BIT(11)
174 #define WPA_KEY_INFO_ENCR_KEY_DATA BIT(12) /* IEEE 802.11i/RSN only */
175 #define WPA_KEY_INFO_SMK_MESSAGE BIT(13)
176
177
178 struct wpa_eapol_key {
179         u8 type;
180         /* Note: key_info, key_length, and key_data_length are unaligned */
181         u8 key_info[2]; /* big endian */
182         u8 key_length[2]; /* big endian */
183         u8 replay_counter[WPA_REPLAY_COUNTER_LEN];
184         u8 key_nonce[WPA_NONCE_LEN];
185         u8 key_iv[16];
186         u8 key_rsc[WPA_KEY_RSC_LEN];
187         u8 key_id[8]; /* Reserved in IEEE 802.11i/RSN */
188         u8 key_mic[16];
189         u8 key_data_length[2]; /* big endian */
190         /* followed by key_data_length bytes of key_data */
191 } STRUCT_PACKED;
192
193 /**
194  * struct wpa_ptk - WPA Pairwise Transient Key
195  * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy
196  */
197 struct wpa_ptk {
198         u8 kck[16]; /* EAPOL-Key Key Confirmation Key (KCK) */
199         u8 kek[16]; /* EAPOL-Key Key Encryption Key (KEK) */
200         u8 tk1[16]; /* Temporal Key 1 (TK1) */
201         union {
202                 u8 tk2[16]; /* Temporal Key 2 (TK2) */
203                 struct {
204                         u8 tx_mic_key[8];
205                         u8 rx_mic_key[8];
206                 } auth;
207         } u;
208 } STRUCT_PACKED;
209
210
211 /* WPA IE version 1
212  * 00-50-f2:1 (OUI:OUI type)
213  * 0x01 0x00 (version; little endian)
214  * (all following fields are optional:)
215  * Group Suite Selector (4 octets) (default: TKIP)
216  * Pairwise Suite Count (2 octets, little endian) (default: 1)
217  * Pairwise Suite List (4 * n octets) (default: TKIP)
218  * Authenticated Key Management Suite Count (2 octets, little endian)
219  *    (default: 1)
220  * Authenticated Key Management Suite List (4 * n octets)
221  *    (default: unspec 802.1X)
222  * WPA Capabilities (2 octets, little endian) (default: 0)
223  */
224
225 struct wpa_ie_hdr {
226         u8 elem_id;
227         u8 len;
228         u8 oui[4]; /* 24-bit OUI followed by 8-bit OUI type */
229         u8 version[2]; /* little endian */
230 } STRUCT_PACKED;
231
232
233 /* 1/4: PMKID
234  * 2/4: RSN IE
235  * 3/4: one or two RSN IEs + GTK IE (encrypted)
236  * 4/4: empty
237  * 1/2: GTK IE (encrypted)
238  * 2/2: empty
239  */
240
241 /* RSN IE version 1
242  * 0x01 0x00 (version; little endian)
243  * (all following fields are optional:)
244  * Group Suite Selector (4 octets) (default: CCMP)
245  * Pairwise Suite Count (2 octets, little endian) (default: 1)
246  * Pairwise Suite List (4 * n octets) (default: CCMP)
247  * Authenticated Key Management Suite Count (2 octets, little endian)
248  *    (default: 1)
249  * Authenticated Key Management Suite List (4 * n octets)
250  *    (default: unspec 802.1X)
251  * RSN Capabilities (2 octets, little endian) (default: 0)
252  * PMKID Count (2 octets) (default: 0)
253  * PMKID List (16 * n octets)
254  * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
255  */
256
257 struct rsn_ie_hdr {
258         u8 elem_id; /* WLAN_EID_RSN */
259         u8 len;
260         u8 version[2]; /* little endian */
261 } STRUCT_PACKED;
262
263
264 #ifdef CONFIG_PEERKEY
265 enum {
266         STK_MUI_4WAY_STA_AP = 1,
267         STK_MUI_4WAY_STAT_STA = 2,
268         STK_MUI_GTK = 3,
269         STK_MUI_SMK = 4
270 };
271
272 enum {
273         STK_ERR_STA_NR = 1,
274         STK_ERR_STA_NRSN = 2,
275         STK_ERR_CPHR_NS = 3,
276         STK_ERR_NO_STSL = 4
277 };
278 #endif /* CONFIG_PEERKEY */
279
280 struct rsn_error_kde {
281         be16 mui;
282         be16 error_type;
283 } STRUCT_PACKED;
284
285 #ifdef CONFIG_IEEE80211W
286 struct wpa_igtk_kde {
287         u8 keyid[2];
288         u8 pn[6];
289         u8 igtk[WPA_IGTK_LEN];
290 } STRUCT_PACKED;
291 #endif /* CONFIG_IEEE80211W */
292
293 #ifdef CONFIG_IEEE80211R
294 struct rsn_mdie {
295         u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
296         u8 ft_capab;
297 } STRUCT_PACKED;
298
299 #define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
300 #define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
301
302 struct rsn_ftie {
303         u8 mic_control[2];
304         u8 mic[16];
305         u8 anonce[WPA_NONCE_LEN];
306         u8 snonce[WPA_NONCE_LEN];
307         /* followed by optional parameters */
308 } STRUCT_PACKED;
309
310 #define FTIE_SUBELEM_R1KH_ID 1
311 #define FTIE_SUBELEM_GTK 2
312 #define FTIE_SUBELEM_R0KH_ID 3
313 #define FTIE_SUBELEM_IGTK 4
314
315 struct rsn_rdie {
316         u8 id;
317         u8 descr_count;
318         le16 status_code;
319 } STRUCT_PACKED;
320
321 #endif /* CONFIG_IEEE80211R */
322
323 #ifdef _MSC_VER
324 #pragma pack(pop)
325 #endif /* _MSC_VER */
326
327
328 int wpa_eapol_key_mic(const u8 *key, int ver, const u8 *buf, size_t len,
329                       u8 *mic);
330 void wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label,
331                     const u8 *addr1, const u8 *addr2,
332                     const u8 *nonce1, const u8 *nonce2,
333                     u8 *ptk, size_t ptk_len, int use_sha256);
334
335 #ifdef CONFIG_IEEE80211R
336 int wpa_ft_mic(const u8 *kck, const u8 *sta_addr, const u8 *ap_addr,
337                u8 transaction_seqnum, const u8 *mdie, size_t mdie_len,
338                const u8 *ftie, size_t ftie_len,
339                const u8 *rsnie, size_t rsnie_len,
340                const u8 *ric, size_t ric_len, u8 *mic);
341 void wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len,
342                        const u8 *ssid, size_t ssid_len,
343                        const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len,
344                        const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name);
345 void wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id,
346                             const u8 *s1kh_id, u8 *pmk_r1_name);
347 void wpa_derive_pmk_r1(const u8 *pmk_r0, const u8 *pmk_r0_name,
348                        const u8 *r1kh_id, const u8 *s1kh_id,
349                        u8 *pmk_r1, u8 *pmk_r1_name);
350 void wpa_pmk_r1_to_ptk(const u8 *pmk_r1, const u8 *snonce, const u8 *anonce,
351                        const u8 *sta_addr, const u8 *bssid,
352                        const u8 *pmk_r1_name,
353                        u8 *ptk, size_t ptk_len, u8 *ptk_name);
354 #endif /* CONFIG_IEEE80211R */
355
356 struct wpa_ie_data {
357         int proto;
358         int pairwise_cipher;
359         int group_cipher;
360         int key_mgmt;
361         int capabilities;
362         size_t num_pmkid;
363         const u8 *pmkid;
364         int mgmt_group_cipher;
365 };
366
367
368 int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len,
369                          struct wpa_ie_data *data);
370 int wpa_parse_wpa_ie_wpa(const u8 *wpa_ie, size_t wpa_ie_len,
371                          struct wpa_ie_data *data);
372
373 void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa,
374                u8 *pmkid, int use_sha256);
375
376 const char * wpa_cipher_txt(int cipher);
377 const char * wpa_key_mgmt_txt(int key_mgmt, int proto);
378 int wpa_compare_rsn_ie(int ft_initial_assoc,
379                        const u8 *ie1, size_t ie1len,
380                        const u8 *ie2, size_t ie2len);
381 int wpa_insert_pmkid(u8 *ies, size_t ies_len, const u8 *pmkid);
382
383 struct wpa_ft_ies {
384         const u8 *mdie;
385         size_t mdie_len;
386         const u8 *ftie;
387         size_t ftie_len;
388         const u8 *r1kh_id;
389         const u8 *gtk;
390         size_t gtk_len;
391         const u8 *r0kh_id;
392         size_t r0kh_id_len;
393         const u8 *rsn;
394         size_t rsn_len;
395         const u8 *rsn_pmkid;
396         const u8 *tie;
397         size_t tie_len;
398         const u8 *igtk;
399         size_t igtk_len;
400         const u8 *ric;
401         size_t ric_len;
402 };
403
404 int wpa_ft_parse_ies(const u8 *ies, size_t ies_len, struct wpa_ft_ies *parse);
405
406 int wpa_cipher_key_len(int cipher);
407 int wpa_cipher_rsc_len(int cipher);
408 int wpa_cipher_to_alg(int cipher);
409 int wpa_cipher_valid_pairwise(int cipher);
410 u32 wpa_cipher_to_suite(int proto, int cipher);
411 int rsn_cipher_put_suites(u8 *pos, int ciphers);
412 int wpa_cipher_put_suites(u8 *pos, int ciphers);
413 int wpa_pick_pairwise_cipher(int ciphers, int none_allowed);
414 int wpa_pick_group_cipher(int ciphers);
415 int wpa_parse_cipher(const char *value);
416 int wpa_write_ciphers(char *start, char *end, int ciphers, const char *delim);
417 int wpa_select_ap_group_cipher(int wpa, int wpa_pairwise, int rsn_pairwise);
418
419 #endif /* WPA_COMMON_H */