src/common/wpa_common.h

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