contrib/wpa/src/common/wpa_common.h

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