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