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