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