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 struct wpa_gtk {
 191         u8 gtk[WPA_GTK_MAX_LEN];
 192         size_t gtk_len;
 193 };
 194
 195 #ifdef CONFIG_IEEE80211W
 196 struct wpa_igtk {
 197         u8 igtk[WPA_IGTK_MAX_LEN];
 198         size_t igtk_len;
 199 };
 200 #endif /* CONFIG_IEEE80211W */
 201
 202 /* WPA IE version 1
 203  * 00-50-f2:1 (OUI:OUI type)
 204  * 0x01 0x00 (version; little endian)
 205  * (all following fields are optional:)
 206  * Group Suite Selector (4 octets) (default: TKIP)
 207  * Pairwise Suite Count (2 octets, little endian) (default: 1)
 208  * Pairwise Suite List (4 * n octets) (default: TKIP)
 209  * Authenticated Key Management Suite Count (2 octets, little endian)
 210  *    (default: 1)
 211  * Authenticated Key Management Suite List (4 * n octets)
 212  *    (default: unspec 802.1X)
 213  * WPA Capabilities (2 octets, little endian) (default: 0)
 214  */
 215
 216 struct wpa_ie_hdr {
 217         u8 elem_id;
 218         u8 len;
 219         u8 oui[4]; /* 24-bit OUI followed by 8-bit OUI type */
 220         u8 version[2]; /* little endian */
 221 } STRUCT_PACKED;
 222
 223
 224 /* 1/4: PMKID
 225  * 2/4: RSN IE
 226  * 3/4: one or two RSN IEs + GTK IE (encrypted)
 227  * 4/4: empty
 228  * 1/2: GTK IE (encrypted)
 229  * 2/2: empty
 230  */
 231
 232 /* RSN IE version 1
 233  * 0x01 0x00 (version; little endian)
 234  * (all following fields are optional:)
 235  * Group Suite Selector (4 octets) (default: CCMP)
 236  * Pairwise Suite Count (2 octets, little endian) (default: 1)
 237  * Pairwise Suite List (4 * n octets) (default: CCMP)
 238  * Authenticated Key Management Suite Count (2 octets, little endian)
 239  *    (default: 1)
 240  * Authenticated Key Management Suite List (4 * n octets)
 241  *    (default: unspec 802.1X)
 242  * RSN Capabilities (2 octets, little endian) (default: 0)
 243  * PMKID Count (2 octets) (default: 0)
 244  * PMKID List (16 * n octets)
 245  * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
 246  */
 247
 248 struct rsn_ie_hdr {
 249         u8 elem_id; /* WLAN_EID_RSN */
 250         u8 len;
 251         u8 version[2]; /* little endian */
 252 } STRUCT_PACKED;
 253
 254
 255 #ifdef CONFIG_PEERKEY
 256 enum {
 257         STK_MUI_4WAY_STA_AP = 1,
 258         STK_MUI_4WAY_STAT_STA = 2,
 259         STK_MUI_GTK = 3,
 260         STK_MUI_SMK = 4
 261 };
 262
 263 enum {
 264         STK_ERR_STA_NR = 1,
 265         STK_ERR_STA_NRSN = 2,
 266         STK_ERR_CPHR_NS = 3,
 267         STK_ERR_NO_STSL = 4
 268 };
 269 #endif /* CONFIG_PEERKEY */
 270
 271 struct rsn_error_kde {
 272         be16 mui;
 273         be16 error_type;
 274 } STRUCT_PACKED;
 275
 276 #ifdef CONFIG_IEEE80211W
 277 struct wpa_igtk_kde {
 278         u8 keyid[2];
 279         u8 pn[6];
 280         u8 igtk[WPA_IGTK_LEN];
 281 } STRUCT_PACKED;
 282 #endif /* CONFIG_IEEE80211W */
 283
 284 #ifdef CONFIG_IEEE80211R
 285 struct rsn_mdie {
 286         u8 mobility_domain[MOBILITY_DOMAIN_ID_LEN];
 287         u8 ft_capab;
 288 } STRUCT_PACKED;
 289
 290 #define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
 291 #define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
 292
 293 struct rsn_ftie {
 294         u8 mic_control[2];
 295         u8 mic[16];
 296         u8 anonce[WPA_NONCE_LEN];
 297         u8 snonce[WPA_NONCE_LEN];
 298         /* followed by optional parameters */
 299 } STRUCT_PACKED;
 300
 301 #define FTIE_SUBELEM_R1KH_ID 1
 302 #define FTIE_SUBELEM_GTK 2
 303 #define FTIE_SUBELEM_R0KH_ID 3
 304 #define FTIE_SUBELEM_IGTK 4
 305
 306 struct rsn_rdie {
 307         u8 id;
 308         u8 descr_count;
 309         le16 status_code;
 310 } STRUCT_PACKED;
 311
 312 #endif /* CONFIG_IEEE80211R */
 313
 314 #ifdef _MSC_VER
 315 #pragma pack(pop)
 316 #endif /* _MSC_VER */
 317
 318
 319 int wpa_eapol_key_mic(const u8 *key, int ver, const u8 *buf, size_t len,
 320                       u8 *mic);
 321 void wpa_pmk_to_ptk(const u8 *pmk, size_t pmk_len, const char *label,
 322                     const u8 *addr1, const u8 *addr2,
 323                     const u8 *nonce1, const u8 *nonce2,
 324                     u8 *ptk, size_t ptk_len, int use_sha256);
 325
 326 #ifdef CONFIG_IEEE80211R
 327 int wpa_ft_mic(const u8 *kck, const u8 *sta_addr, const u8 *ap_addr,
 328                u8 transaction_seqnum, const u8 *mdie, size_t mdie_len,
 329                const u8 *ftie, size_t ftie_len,
 330                const u8 *rsnie, size_t rsnie_len,
 331                const u8 *ric, size_t ric_len, u8 *mic);
 332 void wpa_derive_pmk_r0(const u8 *xxkey, size_t xxkey_len,
 333                        const u8 *ssid, size_t ssid_len,
 334                        const u8 *mdid, const u8 *r0kh_id, size_t r0kh_id_len,
 335                        const u8 *s0kh_id, u8 *pmk_r0, u8 *pmk_r0_name);
 336 void wpa_derive_pmk_r1_name(const u8 *pmk_r0_name, const u8 *r1kh_id,
 337                             const u8 *s1kh_id, u8 *pmk_r1_name);
 338 void wpa_derive_pmk_r1(const u8 *pmk_r0, const u8 *pmk_r0_name,
 339                        const u8 *r1kh_id, const u8 *s1kh_id,
 340                        u8 *pmk_r1, u8 *pmk_r1_name);
 341 void wpa_pmk_r1_to_ptk(const u8 *pmk_r1, const u8 *snonce, const u8 *anonce,
 342                        const u8 *sta_addr, const u8 *bssid,
 343                        const u8 *pmk_r1_name,
 344                        u8 *ptk, size_t ptk_len, u8 *ptk_name);
 345 #endif /* CONFIG_IEEE80211R */
 346
 347 struct wpa_ie_data {
 348         int proto;
 349         int pairwise_cipher;
 350         int group_cipher;
 351         int key_mgmt;
 352         int capabilities;
 353         size_t num_pmkid;
 354         const u8 *pmkid;
 355         int mgmt_group_cipher;
 356 };
 357
 358
 359 int wpa_parse_wpa_ie_rsn(const u8 *rsn_ie, size_t rsn_ie_len,
 360                          struct wpa_ie_data *data);
 361 int wpa_parse_wpa_ie_wpa(const u8 *wpa_ie, size_t wpa_ie_len,
 362                          struct wpa_ie_data *data);
 363
 364 void rsn_pmkid(const u8 *pmk, size_t pmk_len, const u8 *aa, const u8 *spa,
 365                u8 *pmkid, int use_sha256);
 366
 367 const char * wpa_cipher_txt(int cipher);
 368 const char * wpa_key_mgmt_txt(int key_mgmt, int proto);
 369 int wpa_compare_rsn_ie(int ft_initial_assoc,
 370                        const u8 *ie1, size_t ie1len,
 371                        const u8 *ie2, size_t ie2len);
 372 int wpa_insert_pmkid(u8 *ies, size_t ies_len, const u8 *pmkid);
 373
 374 struct wpa_ft_ies {
 375         const u8 *mdie;
 376         size_t mdie_len;
 377         const u8 *ftie;
 378         size_t ftie_len;
 379         const u8 *r1kh_id;
 380         const u8 *gtk;
 381         size_t gtk_len;
 382         const u8 *r0kh_id;
 383         size_t r0kh_id_len;
 384         const u8 *rsn;
 385         size_t rsn_len;
 386         const u8 *rsn_pmkid;
 387         const u8 *tie;
 388         size_t tie_len;
 389         const u8 *igtk;
 390         size_t igtk_len;
 391         const u8 *ric;
 392         size_t ric_len;
 393 };
 394
 395 int wpa_ft_parse_ies(const u8 *ies, size_t ies_len, struct wpa_ft_ies *parse);
 396
 397 int wpa_cipher_key_len(int cipher);
 398 int wpa_cipher_rsc_len(int cipher);
 399 int wpa_cipher_to_alg(int cipher);
 400 int wpa_cipher_valid_pairwise(int cipher);
 401 u32 wpa_cipher_to_suite(int proto, int cipher);
 402 int rsn_cipher_put_suites(u8 *pos, int ciphers);
 403 int wpa_cipher_put_suites(u8 *pos, int ciphers);
 404
 405 #endif /* WPA_COMMON_H */