]>
git.ipfire.org Git - thirdparty/hostap.git/blob - src/common/wpa_common.h
2 * WPA definitions shared between hostapd and wpa_supplicant
3 * Copyright (c) 2002-2013, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
12 #define WPA_MAX_SSID_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
23 #define WPA_ALLOWED_PAIRWISE_CIPHERS \
24 (WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | WPA_CIPHER_NONE)
25 #define WPA_ALLOWED_GROUP_CIPHERS \
26 (WPA_CIPHER_CCMP | WPA_CIPHER_GCMP | WPA_CIPHER_TKIP | WPA_CIPHER_WEP104 | \
29 #define WPA_SELECTOR_LEN 4
31 #define RSN_SELECTOR_LEN 4
34 #define RSN_SELECTOR(a, b, c, d) \
35 ((((u32) (a)) << 24) | (((u32) (b)) << 16) | (((u32) (c)) << 8) | \
38 #define WPA_AUTH_KEY_MGMT_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
39 #define WPA_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
40 #define WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
41 #define WPA_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0)
42 #define WPA_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x50, 0xf2, 0)
43 #define WPA_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
44 #define WPA_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x50, 0xf2, 2)
46 #define WPA_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x50, 0xf2, 3)
48 #define WPA_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x50, 0xf2, 4)
49 #define WPA_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x50, 0xf2, 5)
52 #define RSN_AUTH_KEY_MGMT_UNSPEC_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
53 #define RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
54 #ifdef CONFIG_IEEE80211R
55 #define RSN_AUTH_KEY_MGMT_FT_802_1X RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
56 #define RSN_AUTH_KEY_MGMT_FT_PSK RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
57 #endif /* CONFIG_IEEE80211R */
58 #define RSN_AUTH_KEY_MGMT_802_1X_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
59 #define RSN_AUTH_KEY_MGMT_PSK_SHA256 RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
60 #define RSN_AUTH_KEY_MGMT_TPK_HANDSHAKE RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
61 #define RSN_AUTH_KEY_MGMT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
62 #define RSN_AUTH_KEY_MGMT_FT_SAE RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
63 #define RSN_AUTH_KEY_MGMT_CCKM RSN_SELECTOR(0x00, 0x40, 0x96, 0x00)
65 #define RSN_CIPHER_SUITE_NONE RSN_SELECTOR(0x00, 0x0f, 0xac, 0)
66 #define RSN_CIPHER_SUITE_WEP40 RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
67 #define RSN_CIPHER_SUITE_TKIP RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
69 #define RSN_CIPHER_SUITE_WRAP RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
71 #define RSN_CIPHER_SUITE_CCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
72 #define RSN_CIPHER_SUITE_WEP104 RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
73 #ifdef CONFIG_IEEE80211W
74 #define RSN_CIPHER_SUITE_AES_128_CMAC RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
75 #endif /* CONFIG_IEEE80211W */
76 #define RSN_CIPHER_SUITE_NO_GROUP_ADDRESSED RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
77 #define RSN_CIPHER_SUITE_GCMP RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
79 /* EAPOL-Key Key Data Encapsulation
80 * GroupKey and PeerKey require encryption, otherwise, encryption is optional.
82 #define RSN_KEY_DATA_GROUPKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 1)
84 #define RSN_KEY_DATA_STAKEY RSN_SELECTOR(0x00, 0x0f, 0xac, 2)
86 #define RSN_KEY_DATA_MAC_ADDR RSN_SELECTOR(0x00, 0x0f, 0xac, 3)
87 #define RSN_KEY_DATA_PMKID RSN_SELECTOR(0x00, 0x0f, 0xac, 4)
89 #define RSN_KEY_DATA_SMK RSN_SELECTOR(0x00, 0x0f, 0xac, 5)
90 #define RSN_KEY_DATA_NONCE RSN_SELECTOR(0x00, 0x0f, 0xac, 6)
91 #define RSN_KEY_DATA_LIFETIME RSN_SELECTOR(0x00, 0x0f, 0xac, 7)
92 #define RSN_KEY_DATA_ERROR RSN_SELECTOR(0x00, 0x0f, 0xac, 8)
93 #endif /* CONFIG_PEERKEY */
94 #ifdef CONFIG_IEEE80211W
95 #define RSN_KEY_DATA_IGTK RSN_SELECTOR(0x00, 0x0f, 0xac, 9)
96 #endif /* CONFIG_IEEE80211W */
97 #define RSN_KEY_DATA_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 10)
98 #define RSN_KEY_DATA_MULTIBAND_GTK RSN_SELECTOR(0x00, 0x0f, 0xac, 11)
99 #define RSN_KEY_DATA_MULTIBAND_KEYID RSN_SELECTOR(0x00, 0x0f, 0xac, 12)
101 #define WPA_OUI_TYPE RSN_SELECTOR(0x00, 0x50, 0xf2, 1)
103 #define RSN_SELECTOR_PUT(a, val) WPA_PUT_BE32((u8 *) (a), (val))
104 #define RSN_SELECTOR_GET(a) WPA_GET_BE32((const u8 *) (a))
106 #define RSN_NUM_REPLAY_COUNTERS_1 0
107 #define RSN_NUM_REPLAY_COUNTERS_2 1
108 #define RSN_NUM_REPLAY_COUNTERS_4 2
109 #define RSN_NUM_REPLAY_COUNTERS_16 3
113 #pragma pack(push, 1)
114 #endif /* _MSC_VER */
116 #ifdef CONFIG_IEEE80211W
117 #define WPA_IGTK_LEN 16
118 #endif /* CONFIG_IEEE80211W */
121 /* IEEE 802.11, 7.3.2.25.3 RSN Capabilities */
122 #define WPA_CAPABILITY_PREAUTH BIT(0)
123 #define WPA_CAPABILITY_NO_PAIRWISE BIT(1)
124 /* B2-B3: PTKSA Replay Counter */
125 /* B4-B5: GTKSA Replay Counter */
126 #define WPA_CAPABILITY_MFPR BIT(6)
127 #define WPA_CAPABILITY_MFPC BIT(7)
129 #define WPA_CAPABILITY_PEERKEY_ENABLED BIT(9)
130 #define WPA_CAPABILITY_SPP_A_MSDU_CAPABLE BIT(10)
131 #define WPA_CAPABILITY_SPP_A_MSDU_REQUIRED BIT(11)
132 #define WPA_CAPABILITY_PBAC BIT(12)
133 #define WPA_CAPABILITY_EXT_KEY_ID_FOR_UNICAST BIT(13)
134 /* B14-B15: Reserved */
138 #define MOBILITY_DOMAIN_ID_LEN 2
139 #define FT_R0KH_ID_MAX_LEN 48
140 #define FT_R1KH_ID_LEN 6
141 #define WPA_PMK_NAME_LEN 16
144 /* IEEE 802.11, 8.5.2 EAPOL-Key frames */
145 #define WPA_KEY_INFO_TYPE_MASK ((u16) (BIT(0) | BIT(1) | BIT(2)))
146 #define WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 BIT(0)
147 #define WPA_KEY_INFO_TYPE_HMAC_SHA1_AES BIT(1)
148 #define WPA_KEY_INFO_TYPE_AES_128_CMAC 3
149 #define WPA_KEY_INFO_KEY_TYPE BIT(3) /* 1 = Pairwise, 0 = Group key */
150 /* bit4..5 is used in WPA, but is reserved in IEEE 802.11i/RSN */
151 #define WPA_KEY_INFO_KEY_INDEX_MASK (BIT(4) | BIT(5))
152 #define WPA_KEY_INFO_KEY_INDEX_SHIFT 4
153 #define WPA_KEY_INFO_INSTALL BIT(6) /* pairwise */
154 #define WPA_KEY_INFO_TXRX BIT(6) /* group */
155 #define WPA_KEY_INFO_ACK BIT(7)
156 #define WPA_KEY_INFO_MIC BIT(8)
157 #define WPA_KEY_INFO_SECURE BIT(9)
158 #define WPA_KEY_INFO_ERROR BIT(10)
159 #define WPA_KEY_INFO_REQUEST BIT(11)
160 #define WPA_KEY_INFO_ENCR_KEY_DATA BIT(12) /* IEEE 802.11i/RSN only */
161 #define WPA_KEY_INFO_SMK_MESSAGE BIT(13)
164 struct wpa_eapol_key
{
166 /* Note: key_info, key_length, and key_data_length are unaligned */
167 u8 key_info
[2]; /* big endian */
168 u8 key_length
[2]; /* big endian */
169 u8 replay_counter
[WPA_REPLAY_COUNTER_LEN
];
170 u8 key_nonce
[WPA_NONCE_LEN
];
172 u8 key_rsc
[WPA_KEY_RSC_LEN
];
173 u8 key_id
[8]; /* Reserved in IEEE 802.11i/RSN */
175 u8 key_data_length
[2]; /* big endian */
176 /* followed by key_data_length bytes of key_data */
180 * struct wpa_ptk - WPA Pairwise Transient Key
181 * IEEE Std 802.11i-2004 - 8.5.1.2 Pairwise key hierarchy
184 u8 kck
[16]; /* EAPOL-Key Key Confirmation Key (KCK) */
185 u8 kek
[16]; /* EAPOL-Key Key Encryption Key (KEK) */
186 u8 tk1
[16]; /* Temporal Key 1 (TK1) */
188 u8 tk2
[16]; /* Temporal Key 2 (TK2) */
198 * 00-50-f2:1 (OUI:OUI type)
199 * 0x01 0x00 (version; little endian)
200 * (all following fields are optional:)
201 * Group Suite Selector (4 octets) (default: TKIP)
202 * Pairwise Suite Count (2 octets, little endian) (default: 1)
203 * Pairwise Suite List (4 * n octets) (default: TKIP)
204 * Authenticated Key Management Suite Count (2 octets, little endian)
206 * Authenticated Key Management Suite List (4 * n octets)
207 * (default: unspec 802.1X)
208 * WPA Capabilities (2 octets, little endian) (default: 0)
214 u8 oui
[4]; /* 24-bit OUI followed by 8-bit OUI type */
215 u8 version
[2]; /* little endian */
221 * 3/4: one or two RSN IEs + GTK IE (encrypted)
223 * 1/2: GTK IE (encrypted)
228 * 0x01 0x00 (version; little endian)
229 * (all following fields are optional:)
230 * Group Suite Selector (4 octets) (default: CCMP)
231 * Pairwise Suite Count (2 octets, little endian) (default: 1)
232 * Pairwise Suite List (4 * n octets) (default: CCMP)
233 * Authenticated Key Management Suite Count (2 octets, little endian)
235 * Authenticated Key Management Suite List (4 * n octets)
236 * (default: unspec 802.1X)
237 * RSN Capabilities (2 octets, little endian) (default: 0)
238 * PMKID Count (2 octets) (default: 0)
239 * PMKID List (16 * n octets)
240 * Management Group Cipher Suite (4 octets) (default: AES-128-CMAC)
244 u8 elem_id
; /* WLAN_EID_RSN */
246 u8 version
[2]; /* little endian */
250 #ifdef CONFIG_PEERKEY
252 STK_MUI_4WAY_STA_AP
= 1,
253 STK_MUI_4WAY_STAT_STA
= 2,
260 STK_ERR_STA_NRSN
= 2,
264 #endif /* CONFIG_PEERKEY */
266 struct rsn_error_kde
{
271 #ifdef CONFIG_IEEE80211W
272 struct wpa_igtk_kde
{
275 u8 igtk
[WPA_IGTK_LEN
];
277 #endif /* CONFIG_IEEE80211W */
279 #ifdef CONFIG_IEEE80211R
281 u8 mobility_domain
[MOBILITY_DOMAIN_ID_LEN
];
285 #define RSN_FT_CAPAB_FT_OVER_DS BIT(0)
286 #define RSN_FT_CAPAB_FT_RESOURCE_REQ_SUPP BIT(1)
291 u8 anonce
[WPA_NONCE_LEN
];
292 u8 snonce
[WPA_NONCE_LEN
];
293 /* followed by optional parameters */
296 #define FTIE_SUBELEM_R1KH_ID 1
297 #define FTIE_SUBELEM_GTK 2
298 #define FTIE_SUBELEM_R0KH_ID 3
299 #define FTIE_SUBELEM_IGTK 4
307 #endif /* CONFIG_IEEE80211R */
311 #endif /* _MSC_VER */
314 int wpa_eapol_key_mic(const u8
*key
, int ver
, const u8
*buf
, size_t len
,
316 void wpa_pmk_to_ptk(const u8
*pmk
, size_t pmk_len
, const char *label
,
317 const u8
*addr1
, const u8
*addr2
,
318 const u8
*nonce1
, const u8
*nonce2
,
319 u8
*ptk
, size_t ptk_len
, int use_sha256
);
321 #ifdef CONFIG_IEEE80211R
322 int wpa_ft_mic(const u8
*kck
, const u8
*sta_addr
, const u8
*ap_addr
,
323 u8 transaction_seqnum
, const u8
*mdie
, size_t mdie_len
,
324 const u8
*ftie
, size_t ftie_len
,
325 const u8
*rsnie
, size_t rsnie_len
,
326 const u8
*ric
, size_t ric_len
, u8
*mic
);
327 void wpa_derive_pmk_r0(const u8
*xxkey
, size_t xxkey_len
,
328 const u8
*ssid
, size_t ssid_len
,
329 const u8
*mdid
, const u8
*r0kh_id
, size_t r0kh_id_len
,
330 const u8
*s0kh_id
, u8
*pmk_r0
, u8
*pmk_r0_name
);
331 void wpa_derive_pmk_r1_name(const u8
*pmk_r0_name
, const u8
*r1kh_id
,
332 const u8
*s1kh_id
, u8
*pmk_r1_name
);
333 void wpa_derive_pmk_r1(const u8
*pmk_r0
, const u8
*pmk_r0_name
,
334 const u8
*r1kh_id
, const u8
*s1kh_id
,
335 u8
*pmk_r1
, u8
*pmk_r1_name
);
336 void wpa_pmk_r1_to_ptk(const u8
*pmk_r1
, const u8
*snonce
, const u8
*anonce
,
337 const u8
*sta_addr
, const u8
*bssid
,
338 const u8
*pmk_r1_name
,
339 u8
*ptk
, size_t ptk_len
, u8
*ptk_name
);
340 #endif /* CONFIG_IEEE80211R */
350 int mgmt_group_cipher
;
354 int wpa_parse_wpa_ie_rsn(const u8
*rsn_ie
, size_t rsn_ie_len
,
355 struct wpa_ie_data
*data
);
356 int wpa_parse_wpa_ie_wpa(const u8
*wpa_ie
, size_t wpa_ie_len
,
357 struct wpa_ie_data
*data
);
359 void rsn_pmkid(const u8
*pmk
, size_t pmk_len
, const u8
*aa
, const u8
*spa
,
360 u8
*pmkid
, int use_sha256
);
362 const char * wpa_cipher_txt(int cipher
);
363 const char * wpa_key_mgmt_txt(int key_mgmt
, int proto
);
364 int wpa_compare_rsn_ie(int ft_initial_assoc
,
365 const u8
*ie1
, size_t ie1len
,
366 const u8
*ie2
, size_t ie2len
);
367 int wpa_insert_pmkid(u8
*ies
, size_t ies_len
, const u8
*pmkid
);
390 int wpa_ft_parse_ies(const u8
*ies
, size_t ies_len
, struct wpa_ft_ies
*parse
);
392 int wpa_cipher_key_len(int cipher
);
393 int wpa_cipher_rsc_len(int cipher
);
394 int wpa_cipher_to_alg(int cipher
);
395 int wpa_cipher_valid_pairwise(int cipher
);
396 u32
wpa_cipher_to_suite(int proto
, int cipher
);
397 int rsn_cipher_put_suites(u8
*pos
, int ciphers
);
398 int wpa_cipher_put_suites(u8
*pos
, int ciphers
);
399 int wpa_pick_pairwise_cipher(int ciphers
, int none_allowed
);
400 int wpa_pick_group_cipher(int ciphers
);
401 int wpa_parse_cipher(const char *value
);
402 int wpa_write_ciphers(char *start
, char *end
, int ciphers
, const char *delim
);
404 #endif /* WPA_COMMON_H */