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