1 /* 2 * WPA definitions shared between hostapd and wpa_supplicant 3 * Copyright (c) 2002-2008, Jouni Malinen <j (at) 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_SELECTOR_LEN 4 24 #define WPA_VERSION 1 25 #define RSN_SELECTOR_LEN 4 26 #define RSN_VERSION 1 27 28 #define RSN_SELECTOR(a, b, c, d) \ 29 ((((u32) (a)) << 24) | (((u32) (b)) << 16) | (((u32) (c)) << 8) | \ 30 (u32) (d)) 31 32 #define WPA_AUTH_KEY_MGMT_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0) 33 #define WPA_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 1) 34 #define WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 2) 35 #define WPA_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0) 36 #define WPA_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x50, 0xf2, 1) 37 #define WPA_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x50, 0xf2, 2) 38 #if 0 39 #define WPA_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x50, 0xf2, 3) 40 #endif 41 #define WPA_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x50, 0xf2, 4) 42 #define WPA_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x50, 0xf2, 5) 43 44 45 #define RSN_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 1) 46 #define RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 2) 47 #ifdef CONFIG_IEEE80211R 48 #define RSN_AUTH_KEY_MGMT_FT_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 3) 49 #define RSN_AUTH_KEY_MGMT_FT_PSK RSN_SELECTOR(0x00, 0x0f, 0xac, 4) 50 #endif /* CONFIG_IEEE80211R */ 51 #define RSN_AUTH_KEY_MGMT_802_1X_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 5) 52 #define RSN_AUTH_KEY_MGMT_PSK_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 6) 53 #define RSN_AUTH_KEY_MGMT_TPK_HANDSHAKE RSN_SELECTOR(0x00, 0x0f, 0xac, 7) 54 55 #define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0) 56 #define RSN_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x0f, 0xac, 1) 57 #define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2) 58 #if 0 59 #define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3) 60 #endif 61 #define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4) 62 #define RSN_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x0f, 0xac, 5) 63 #ifdef CONFIG_IEEE80211W 64 #define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6) 65 #endif /* CONFIG_IEEE80211W */ 66 #define RSN_CIPHER_SUITE_NO_GROUP_ADDRESSED RSN_SELECTOR(0x00, 0x0f, 0xac, 7) 67 #define RSN_CIPHER_SUITE_GCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 8) 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 #define RSN_KEY_DATA_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 10) 88 #define RSN_KEY_DATA_MULTIBAND_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 11) 89 #define RSN_KEY_DATA_MULTIBAND_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 12) 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 /* B8: Reserved */ 119 #define WPA_CAPABILITY_PEERKEY_ENABLED BIT(9) 120 #define WPA_CAPABILITY_SPP_A_MSDU_CAPABLE BIT(10) 121 #define WPA_CAPABILITY_SPP_A_MSDU_REQUIRED BIT(11) 122 #define WPA_CAPABILITY_PBAC BIT(12) 123 #define WPA_CAPABILITY_EXT_KEY_ID_FOR_UNICAST BIT(13) 124 /* B14-B15: Reserved */ 125 126 127 /* IEEE 802.11r */ 128 #define MOBILITY_DOMAIN_ID_LEN 2 129 #define FT_R0KH_ID_MAX_LEN 48 130 #define FT_R1KH_ID_LEN 6 131 #define WPA_PMK_NAME_LEN 16 132 133 134 /* IEEE 802.11, 8.5.2 EAPOL-Key frames */ 135 #define WPA_KEY_INFO_TYPE_MASK ((u16) (BIT(0) | BIT(1) | BIT(2))) 136 #define WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 BIT(0) 137 #define WPA_KEY_INFO_TYPE_HMAC_SHA1_AES BIT(1) 138 #define WPA_KEY_INFO_TYPE_AES_128_CMAC 3 139 #define WPA_KEY_INFO_KEY_TYPE BIT(3) /* 1 = Pairwise, 0 = Group key */ 140 /* bit4..5 is used in WPA, but is reserved in IEEE 802.11i/RSN */ 141 #define WPA_KEY_INFO_KEY_INDEX_MASK (BIT(4) | BIT(5)) 142 #define WPA_KEY_INFO_KEY_INDEX_SHIFT 4 143 #define WPA_KEY_INFO_INSTALL BIT(6) /* pairwise */ 144 #define WPA_KEY_INFO_TXRX BIT(6) /* group */ 145 #define WPA_KEY_INFO_ACK BIT(7) 146 #define WPA_KEY_INFO_MIC BIT(8) 147 #define WPA_KEY_INFO_SECURE BIT(9) 148 #define WPA_KEY_INFO_ERROR BIT(10) 149 #define WPA_KEY_INFO_REQUEST BIT(11) 150 #define WPA_KEY_INFO_ENCR_KEY_DATA BIT(12) /* IEEE 802.11i/RSN only */ 151 #define WPA_KEY_INFO_SMK_MESSAGE BIT(13) 152 153 154 struct wpa_eapol_key { 155 u8 type; 156 /* Note: key_info, key_length, and key_data_length are unaligned */ 157 u8 key_info[2]; /* big endian */ 158 u8 key_length[2]; /* big endian */ 159 u8 replay_counter[WPA_REPLAY_COUNTER_LEN]; 160 u8 key_nonce[WPA_NONCE_LEN]; 161 u8 key_iv[16]; 162 u8 key_rsc[WPA_KEY_RSC_LEN]; 163 u8 key_id[8]; /* Reserved in IEEE 802.11i/RSN */ 164 u8 key_mic[16]; 165 u8 key_data_length[2]; /* big endian */ 166 /* followed by key_data_length bytes of key_data */ 167 } STRUCT_PACKED; 168 169 /** 170 * struct wpa_ptk - WPA Pairwise Transient Key 171 * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy 172 */ 173 struct wpa_ptk { 174 u8 kck[16]; /* EAPOL-Key Key Confirmation Key (KCK) */ 175 u8 kek[16]; /* EAPOL-Key Key Encryption Key (KEK) */ 176 u8 tk1[16]; /* Temporal Key 1 (TK1) */ 177 union { 178 u8 tk2[16]; /* Temporal Key 2 (TK2) */ 179 struct { 180 u8 tx_mic_key[8]; 181 u8 rx_mic_key[8]; 182 } auth; 183 } u; 184 } STRUCT_PACKED; 185 186 187 /* WPA IE version 1 188 * 00-50-f2:1 (OUI:OUI type) 189 * 0x01 0x00 (version; little endian) 190 * (all following fields are optional:) 191 * Group Suite Selector (4 octets) (default: TKIP) 192 * Pairwise Suite Count (2 octets, little endian) (default: 1) 193 * Pairwise Suite List (4 * n octets) (default: TKIP) 194 * Authenticated Key Management Suite Count (2 octets, little endian) 195 * (default: 1) 196 * Authenticated Key Management Suite List (4 * n octets) 197 * (default: unspec 802.1X) 198 * WPA Capabilities (2 octets, little endian) (default: 0) 199 */ 200 201 struct wpa_ie_hdr { 202 u8 elem_id; 203 u8 len; 204 u8 oui[4]; /* 24-bit OUI followed by 8-bit OUI type */ 205 u8 version[2]; /* little endian */ 206 } STRUCT_PACKED; 207 208 209 /* 1/4: PMKID 210 * 2/4: RSN IE 211 * 3/4: one or two RSN IEs + GTK IE (encrypted) 212 * 4/4: empty 213 * 1/2: GTK IE (encrypted) 214 * 2/2: empty 215 */ 216 217 /* RSN IE version 1 218 * 0x01 0x00 (version; little endian) 219 * (all following fields are optional:) 220 * Group Suite Selector (4 octets) (default: CCMP) 221 * Pairwise Suite Count (2 octets, little endian) (default: 1) 222 * Pairwise Suite List (4 * n octets) (default: CCMP) 223 * Authenticated Key Management Suite Count (2 octets, little endian) 224 * (default: 1) 225 * Authenticated Key Management Suite List (4 * n octets) 226 * (default: unspec 802.1X) 227 * RSN Capabilities (2 octets, little endian) (default: 0) 228 * PMKID Count (2 octets) (default: 0) 229 * PMKID List (16 * n octets) 230 * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC) 231 */ 232 233 struct rsn_ie_hdr { 234 u8 elem_id; /* WLAN_EID_RSN */ 235 u8 len; 236 u8 version[2]; /* little endian */ 237 } STRUCT_PACKED; 238 239 240 #ifdef CONFIG_PEERKEY 241 enum { 242 STK_MUI_4WAY_STA_AP = 1, 243 STK_MUI_4WAY_STAT_STA = 2, 244 STK_MUI_GTK = 3, 245 STK_MUI_SMK = 4 246 }; 247 248 enum { 249 STK_ERR_STA_NR = 1, 250 STK_ERR_STA_NRSN = 2, 251 STK_ERR_CPHR_NS = 3, 252 STK_ERR_NO_STSL = 4 253 }; 254 #endif /* CONFIG_PEERKEY */ 255 256 struct rsn_error_kde { 257 be16 mui; 258 be16 error_type; 259 } STRUCT_PACKED; 260 261 #ifdef CONFIG_IEEE80211W 262 struct wpa_igtk_kde { 263 u8 keyid[2]; 264 u8 pn[6]; 265 u8 igtk[WPA_IGTK_LEN]; 266 } STRUCT_PACKED; 267 #endif /* CONFIG_IEEE80211W */ 268 269 #ifdef CONFIG_IEEE80211R 270 struct rsn_mdie { 271 u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN]; 272 u8 ft_capab; 273 } STRUCT_PACKED; 274 275 #define RSN_FT_CAPAB_FT_OVER_DS BIT(0) 276 #define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1) 277 278 struct rsn_ftie { 279 u8 mic_control[2]; 280 u8 mic[16]; 281 u8 anonce[WPA_NONCE_LEN]; 282 u8 snonce[WPA_NONCE_LEN]; 283 /* followed by optional parameters */ 284 } STRUCT_PACKED; 285 286 #define FTIE_SUBELEM_R1KH_ID 1 287 #define FTIE_SUBELEM_GTK 2 288 #define FTIE_SUBELEM_R0KH_ID 3 289 #define FTIE_SUBELEM_IGTK 4 290 291 struct rsn_rdie { 292 u8 id; 293 u8 descr_count; 294 le16 status_code; 295 } STRUCT_PACKED; 296 297 #endif /* CONFIG_IEEE80211R */ 298 299 #ifdef _MSC_VER 300 #pragma pack(pop) 301 #endif /* _MSC_VER */ 302 303 304 int wpa_eapol_key_mic(const u8 *key, int ver, const u8 *buf, size_t len, 305 u8 *mic); 306 void wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label, 307 const u8 *addr1, const u8 *addr2, 308 const u8 *nonce1, const u8 *nonce2, 309 u8 *ptk, size_t ptk_len, int use_sha256); 310 311 #ifdef CONFIG_IEEE80211R 312 int wpa_ft_mic(const u8 *kck, const u8 *sta_addr, const u8 *ap_addr, 313 u8 transaction_seqnum, const u8 *mdie, size_t mdie_len, 314 const u8 *ftie, size_t ftie_len, 315 const u8 *rsnie, size_t rsnie_len, 316 const u8 *ric, size_t ric_len, u8 *mic); 317 void wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len, 318 const u8 *ssid, size_t ssid_len, 319 const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len, 320 const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name); 321 void wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id, 322 const u8 *s1kh_id, u8 *pmk_r1_name); 323 void wpa_derive_pmk_r1(const u8 *pmk_r0, const u8 *pmk_r0_name, 324 const u8 *r1kh_id, const u8 *s1kh_id, 325 u8 *pmk_r1, u8 *pmk_r1_name); 326 void wpa_pmk_r1_to_ptk(const u8 *pmk_r1, const u8 *snonce, const u8 *anonce, 327 const u8 *sta_addr, const u8 *bssid, 328 const u8 *pmk_r1_name, 329 u8 *ptk, size_t ptk_len, u8 *ptk_name); 330 #endif /* CONFIG_IEEE80211R */ 331 332 struct wpa_ie_data { 333 int proto; 334 int pairwise_cipher; 335 int group_cipher; 336 int key_mgmt; 337 int capabilities; 338 size_t num_pmkid; 339 const u8 *pmkid; 340 int mgmt_group_cipher; 341 }; 342 343 344 int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len, 345 struct wpa_ie_data *data); 346 int wpa_parse_wpa_ie_wpa(const u8 *wpa_ie, size_t wpa_ie_len, 347 struct wpa_ie_data *data); 348 349 void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa, 350 u8 *pmkid, int use_sha256); 351 352 const char * wpa_cipher_txt(int cipher); 353 const char * wpa_key_mgmt_txt(int key_mgmt, int proto); 354 int wpa_compare_rsn_ie(int ft_initial_assoc, 355 const u8 *ie1, size_t ie1len, 356 const u8 *ie2, size_t ie2len); 357 int wpa_insert_pmkid(u8 *ies, size_t ies_len, const u8 *pmkid); 358 359 struct wpa_ft_ies { 360 const u8 *mdie; 361 size_t mdie_len; 362 const u8 *ftie; 363 size_t ftie_len; 364 const u8 *r1kh_id; 365 const u8 *gtk; 366 size_t gtk_len; 367 const u8 *r0kh_id; 368 size_t r0kh_id_len; 369 const u8 *rsn; 370 size_t rsn_len; 371 const u8 *rsn_pmkid; 372 const u8 *tie; 373 size_t tie_len; 374 const u8 *igtk; 375 size_t igtk_len; 376 const u8 *ric; 377 size_t ric_len; 378 }; 379 380 int wpa_ft_parse_ies(const u8 *ies, size_t ies_len, struct wpa_ft_ies *parse); 381 382 int wpa_cipher_key_len(int cipher); 383 int wpa_cipher_rsc_len(int cipher); 384 int wpa_cipher_to_alg(int cipher); 385 int wpa_cipher_valid_pairwise(int cipher); 386 u32 wpa_cipher_to_suite(int proto, int cipher); 387 int rsn_cipher_put_suites(u8 *pos, int ciphers); 388 int wpa_cipher_put_suites(u8 *pos, int ciphers); 389 390 #endif /* WPA_COMMON_H */ 391
