2 * WPA Supplicant - WPA state machine and EAPOL-Key processing
3 * Copyright (c) 2003-2008, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
18 #include "crypto/aes_wrap.h"
19 #include "crypto/crypto.h"
20 #include "common/ieee802_11_defs.h"
21 #include "eapol_supp/eapol_supp_sm.h"
25 #include "pmksa_cache.h"
32 * wpa_eapol_key_send - Send WPA/RSN EAPOL-Key message
33 * @sm: Pointer to WPA state machine data from wpa_sm_init()
34 * @kck: Key Confirmation Key (KCK, part of PTK)
35 * @ver: Version field from Key Info
36 * @dest: Destination address for the frame
37 * @proto: Ethertype (usually ETH_P_EAPOL)
38 * @msg: EAPOL-Key message
39 * @msg_len: Length of message
40 * @key_mic: Pointer to the buffer to which the EAPOL-Key MIC is written
42 void wpa_eapol_key_send(struct wpa_sm
*sm
, const u8
*kck
,
43 int ver
, const u8
*dest
, u16 proto
,
44 u8
*msg
, size_t msg_len
, u8
*key_mic
)
46 if (is_zero_ether_addr(dest
) && is_zero_ether_addr(sm
->bssid
)) {
48 * Association event was not yet received; try to fetch
49 * BSSID from the driver.
51 if (wpa_sm_get_bssid(sm
, sm
->bssid
) < 0) {
52 wpa_printf(MSG_DEBUG
, "WPA: Failed to read BSSID for "
53 "EAPOL-Key destination address");
56 wpa_printf(MSG_DEBUG
, "WPA: Use BSSID (" MACSTR
57 ") as the destination for EAPOL-Key",
62 wpa_eapol_key_mic(kck
, ver
, msg
, msg_len
, key_mic
)) {
63 wpa_printf(MSG_ERROR
, "WPA: Failed to generate EAPOL-Key "
64 "version %d MIC", ver
);
67 wpa_hexdump(MSG_MSGDUMP
, "WPA: TX EAPOL-Key", msg
, msg_len
);
68 wpa_sm_ether_send(sm
, dest
, proto
, msg
, msg_len
);
69 eapol_sm_notify_tx_eapol_key(sm
->eapol
);
76 * wpa_sm_key_request - Send EAPOL-Key Request
77 * @sm: Pointer to WPA state machine data from wpa_sm_init()
78 * @error: Indicate whether this is an Michael MIC error report
79 * @pairwise: 1 = error report for pairwise packet, 0 = for group packet
81 * Send an EAPOL-Key Request to the current authenticator. This function is
82 * used to request rekeying and it is usually called when a local Michael MIC
83 * failure is detected.
85 void wpa_sm_key_request(struct wpa_sm
*sm
, int error
, int pairwise
)
88 struct wpa_eapol_key
*reply
;
90 u8 bssid
[ETH_ALEN
], *rbuf
;
92 if (wpa_key_mgmt_ft(sm
->key_mgmt
) || wpa_key_mgmt_sha256(sm
->key_mgmt
))
93 ver
= WPA_KEY_INFO_TYPE_AES_128_CMAC
;
94 else if (sm
->pairwise_cipher
== WPA_CIPHER_CCMP
)
95 ver
= WPA_KEY_INFO_TYPE_HMAC_SHA1_AES
;
97 ver
= WPA_KEY_INFO_TYPE_HMAC_MD5_RC4
;
99 if (wpa_sm_get_bssid(sm
, bssid
) < 0) {
100 wpa_printf(MSG_WARNING
, "Failed to read BSSID for EAPOL-Key "
105 rbuf
= wpa_sm_alloc_eapol(sm
, IEEE802_1X_TYPE_EAPOL_KEY
, NULL
,
106 sizeof(*reply
), &rlen
, (void *) &reply
);
110 reply
->type
= sm
->proto
== WPA_PROTO_RSN
?
111 EAPOL_KEY_TYPE_RSN
: EAPOL_KEY_TYPE_WPA
;
112 key_info
= WPA_KEY_INFO_REQUEST
| ver
;
114 key_info
|= WPA_KEY_INFO_MIC
;
116 key_info
|= WPA_KEY_INFO_ERROR
;
118 key_info
|= WPA_KEY_INFO_KEY_TYPE
;
119 WPA_PUT_BE16(reply
->key_info
, key_info
);
120 WPA_PUT_BE16(reply
->key_length
, 0);
121 os_memcpy(reply
->replay_counter
, sm
->request_counter
,
122 WPA_REPLAY_COUNTER_LEN
);
123 inc_byte_array(sm
->request_counter
, WPA_REPLAY_COUNTER_LEN
);
125 WPA_PUT_BE16(reply
->key_data_length
, 0);
127 wpa_printf(MSG_INFO
, "WPA: Sending EAPOL-Key Request (error=%d "
128 "pairwise=%d ptk_set=%d len=%lu)",
129 error
, pairwise
, sm
->ptk_set
, (unsigned long) rlen
);
130 wpa_eapol_key_send(sm
, sm
->ptk
.kck
, ver
, bssid
, ETH_P_EAPOL
,
131 rbuf
, rlen
, key_info
& WPA_KEY_INFO_MIC
?
132 reply
->key_mic
: NULL
);
136 static int wpa_supplicant_get_pmk(struct wpa_sm
*sm
,
137 const unsigned char *src_addr
,
140 int abort_cached
= 0;
142 if (pmkid
&& !sm
->cur_pmksa
) {
143 /* When using drivers that generate RSN IE, wpa_supplicant may
144 * not have enough time to get the association information
145 * event before receiving this 1/4 message, so try to find a
146 * matching PMKSA cache entry here. */
147 sm
->cur_pmksa
= pmksa_cache_get(sm
->pmksa
, src_addr
, pmkid
);
149 wpa_printf(MSG_DEBUG
, "RSN: found matching PMKID from "
152 wpa_printf(MSG_DEBUG
, "RSN: no matching PMKID found");
157 if (pmkid
&& sm
->cur_pmksa
&&
158 os_memcmp(pmkid
, sm
->cur_pmksa
->pmkid
, PMKID_LEN
) == 0) {
159 wpa_hexdump(MSG_DEBUG
, "RSN: matched PMKID", pmkid
, PMKID_LEN
);
160 wpa_sm_set_pmk_from_pmksa(sm
);
161 wpa_hexdump_key(MSG_DEBUG
, "RSN: PMK from PMKSA cache",
162 sm
->pmk
, sm
->pmk_len
);
163 eapol_sm_notify_cached(sm
->eapol
);
164 #ifdef CONFIG_IEEE80211R
166 #endif /* CONFIG_IEEE80211R */
167 } else if (wpa_key_mgmt_wpa_ieee8021x(sm
->key_mgmt
) && sm
->eapol
) {
170 res
= eapol_sm_get_key(sm
->eapol
, sm
->pmk
, PMK_LEN
);
173 * EAP-LEAP is an exception from other EAP methods: it
174 * uses only 16-byte PMK.
176 res
= eapol_sm_get_key(sm
->eapol
, sm
->pmk
, 16);
179 #ifdef CONFIG_IEEE80211R
181 if (eapol_sm_get_key(sm
->eapol
, buf
, 2 * PMK_LEN
) == 0)
183 os_memcpy(sm
->xxkey
, buf
+ PMK_LEN
, PMK_LEN
);
184 sm
->xxkey_len
= PMK_LEN
;
185 os_memset(buf
, 0, sizeof(buf
));
187 #endif /* CONFIG_IEEE80211R */
190 wpa_hexdump_key(MSG_DEBUG
, "WPA: PMK from EAPOL state "
191 "machines", sm
->pmk
, pmk_len
);
192 sm
->pmk_len
= pmk_len
;
193 if (sm
->proto
== WPA_PROTO_RSN
) {
194 pmksa_cache_add(sm
->pmksa
, sm
->pmk
, pmk_len
,
195 src_addr
, sm
->own_addr
,
196 sm
->network_ctx
, sm
->key_mgmt
);
198 if (!sm
->cur_pmksa
&& pmkid
&&
199 pmksa_cache_get(sm
->pmksa
, src_addr
, pmkid
)) {
200 wpa_printf(MSG_DEBUG
, "RSN: the new PMK "
201 "matches with the PMKID");
205 wpa_msg(sm
->ctx
->msg_ctx
, MSG_WARNING
,
206 "WPA: Failed to get master session key from "
207 "EAPOL state machines");
208 wpa_msg(sm
->ctx
->msg_ctx
, MSG_WARNING
,
209 "WPA: Key handshake aborted");
211 wpa_printf(MSG_DEBUG
, "RSN: Cancelled PMKSA "
213 sm
->cur_pmksa
= NULL
;
215 } else if (!abort_cached
) {
221 if (abort_cached
&& wpa_key_mgmt_wpa_ieee8021x(sm
->key_mgmt
)) {
222 /* Send EAPOL-Start to trigger full EAP authentication. */
226 wpa_printf(MSG_DEBUG
, "RSN: no PMKSA entry found - trigger "
227 "full EAP authentication");
228 buf
= wpa_sm_alloc_eapol(sm
, IEEE802_1X_TYPE_EAPOL_START
,
229 NULL
, 0, &buflen
, NULL
);
231 wpa_sm_ether_send(sm
, sm
->bssid
, ETH_P_EAPOL
,
244 * wpa_supplicant_send_2_of_4 - Send message 2 of WPA/RSN 4-Way Handshake
245 * @sm: Pointer to WPA state machine data from wpa_sm_init()
246 * @dst: Destination address for the frame
247 * @key: Pointer to the EAPOL-Key frame header
248 * @ver: Version bits from EAPOL-Key Key Info
249 * @nonce: Nonce value for the EAPOL-Key frame
250 * @wpa_ie: WPA/RSN IE
251 * @wpa_ie_len: Length of the WPA/RSN IE
252 * @ptk: PTK to use for keyed hash and encryption
253 * Returns: 0 on success, -1 on failure
255 int wpa_supplicant_send_2_of_4(struct wpa_sm
*sm
, const unsigned char *dst
,
256 const struct wpa_eapol_key
*key
,
257 int ver
, const u8
*nonce
,
258 const u8
*wpa_ie
, size_t wpa_ie_len
,
262 struct wpa_eapol_key
*reply
;
265 if (wpa_ie
== NULL
) {
266 wpa_printf(MSG_WARNING
, "WPA: No wpa_ie set - cannot "
271 wpa_hexdump(MSG_DEBUG
, "WPA: WPA IE for msg 2/4", wpa_ie
, wpa_ie_len
);
273 rbuf
= wpa_sm_alloc_eapol(sm
, IEEE802_1X_TYPE_EAPOL_KEY
,
274 NULL
, sizeof(*reply
) + wpa_ie_len
,
275 &rlen
, (void *) &reply
);
279 reply
->type
= sm
->proto
== WPA_PROTO_RSN
?
280 EAPOL_KEY_TYPE_RSN
: EAPOL_KEY_TYPE_WPA
;
281 WPA_PUT_BE16(reply
->key_info
,
282 ver
| WPA_KEY_INFO_KEY_TYPE
| WPA_KEY_INFO_MIC
);
283 if (sm
->proto
== WPA_PROTO_RSN
)
284 WPA_PUT_BE16(reply
->key_length
, 0);
286 os_memcpy(reply
->key_length
, key
->key_length
, 2);
287 os_memcpy(reply
->replay_counter
, key
->replay_counter
,
288 WPA_REPLAY_COUNTER_LEN
);
290 WPA_PUT_BE16(reply
->key_data_length
, wpa_ie_len
);
291 os_memcpy(reply
+ 1, wpa_ie
, wpa_ie_len
);
293 os_memcpy(reply
->key_nonce
, nonce
, WPA_NONCE_LEN
);
295 wpa_printf(MSG_DEBUG
, "WPA: Sending EAPOL-Key 2/4");
296 wpa_eapol_key_send(sm
, ptk
->kck
, ver
, dst
, ETH_P_EAPOL
,
297 rbuf
, rlen
, reply
->key_mic
);
303 static int wpa_derive_ptk(struct wpa_sm
*sm
, const unsigned char *src_addr
,
304 const struct wpa_eapol_key
*key
,
307 size_t ptk_len
= sm
->pairwise_cipher
== WPA_CIPHER_CCMP
? 48 : 64;
308 #ifdef CONFIG_IEEE80211R
309 if (wpa_key_mgmt_ft(sm
->key_mgmt
))
310 return wpa_derive_ptk_ft(sm
, src_addr
, key
, ptk
, ptk_len
);
311 #endif /* CONFIG_IEEE80211R */
313 wpa_pmk_to_ptk(sm
->pmk
, sm
->pmk_len
, "Pairwise key expansion",
314 sm
->own_addr
, sm
->bssid
, sm
->snonce
, key
->key_nonce
,
316 wpa_key_mgmt_sha256(sm
->key_mgmt
));
321 static void wpa_supplicant_process_1_of_4(struct wpa_sm
*sm
,
322 const unsigned char *src_addr
,
323 const struct wpa_eapol_key
*key
,
326 struct wpa_eapol_ie_parse ie
;
330 if (wpa_sm_get_network_ctx(sm
) == NULL
) {
331 wpa_printf(MSG_WARNING
, "WPA: No SSID info found (msg 1 of "
336 wpa_sm_set_state(sm
, WPA_4WAY_HANDSHAKE
);
337 wpa_printf(MSG_DEBUG
, "WPA: RX message 1 of 4-Way Handshake from "
338 MACSTR
" (ver=%d)", MAC2STR(src_addr
), ver
);
340 os_memset(&ie
, 0, sizeof(ie
));
342 #ifndef CONFIG_NO_WPA2
343 if (sm
->proto
== WPA_PROTO_RSN
) {
344 /* RSN: msg 1/4 should contain PMKID for the selected PMK */
345 const u8
*_buf
= (const u8
*) (key
+ 1);
346 size_t len
= WPA_GET_BE16(key
->key_data_length
);
347 wpa_hexdump(MSG_DEBUG
, "RSN: msg 1/4 key data", _buf
, len
);
348 wpa_supplicant_parse_ies(_buf
, len
, &ie
);
350 wpa_hexdump(MSG_DEBUG
, "RSN: PMKID from "
351 "Authenticator", ie
.pmkid
, PMKID_LEN
);
354 #endif /* CONFIG_NO_WPA2 */
356 if (wpa_supplicant_get_pmk(sm
, src_addr
, ie
.pmkid
))
359 if (sm
->renew_snonce
) {
360 if (os_get_random(sm
->snonce
, WPA_NONCE_LEN
)) {
361 wpa_msg(sm
->ctx
->msg_ctx
, MSG_WARNING
,
362 "WPA: Failed to get random data for SNonce");
365 sm
->renew_snonce
= 0;
366 wpa_hexdump(MSG_DEBUG
, "WPA: Renewed SNonce",
367 sm
->snonce
, WPA_NONCE_LEN
);
370 /* Calculate PTK which will be stored as a temporary PTK until it has
371 * been verified when processing message 3/4. */
373 wpa_derive_ptk(sm
, src_addr
, key
, ptk
);
374 /* Supplicant: swap tx/rx Mic keys */
375 os_memcpy(buf
, ptk
->u
.auth
.tx_mic_key
, 8);
376 os_memcpy(ptk
->u
.auth
.tx_mic_key
, ptk
->u
.auth
.rx_mic_key
, 8);
377 os_memcpy(ptk
->u
.auth
.rx_mic_key
, buf
, 8);
380 if (wpa_supplicant_send_2_of_4(sm
, sm
->bssid
, key
, ver
, sm
->snonce
,
381 sm
->assoc_wpa_ie
, sm
->assoc_wpa_ie_len
,
385 os_memcpy(sm
->anonce
, key
->key_nonce
, WPA_NONCE_LEN
);
389 wpa_sm_deauthenticate(sm
, WLAN_REASON_UNSPECIFIED
);
393 static void wpa_sm_start_preauth(void *eloop_ctx
, void *timeout_ctx
)
395 struct wpa_sm
*sm
= eloop_ctx
;
396 rsn_preauth_candidate_process(sm
);
400 static void wpa_supplicant_key_neg_complete(struct wpa_sm
*sm
,
401 const u8
*addr
, int secure
)
403 wpa_msg(sm
->ctx
->msg_ctx
, MSG_INFO
,
404 "WPA: Key negotiation completed with "
405 MACSTR
" [PTK=%s GTK=%s]", MAC2STR(addr
),
406 wpa_cipher_txt(sm
->pairwise_cipher
),
407 wpa_cipher_txt(sm
->group_cipher
));
408 wpa_sm_cancel_auth_timeout(sm
);
409 wpa_sm_set_state(sm
, WPA_COMPLETED
);
412 wpa_sm_mlme_setprotection(
413 sm
, addr
, MLME_SETPROTECTION_PROTECT_TYPE_RX_TX
,
414 MLME_SETPROTECTION_KEY_TYPE_PAIRWISE
);
415 eapol_sm_notify_portValid(sm
->eapol
, TRUE
);
416 if (wpa_key_mgmt_wpa_psk(sm
->key_mgmt
))
417 eapol_sm_notify_eap_success(sm
->eapol
, TRUE
);
419 * Start preauthentication after a short wait to avoid a
420 * possible race condition between the data receive and key
421 * configuration after the 4-Way Handshake. This increases the
422 * likelyhood of the first preauth EAPOL-Start frame getting to
425 eloop_register_timeout(1, 0, wpa_sm_start_preauth
, sm
, NULL
);
428 if (sm
->cur_pmksa
&& sm
->cur_pmksa
->opportunistic
) {
429 wpa_printf(MSG_DEBUG
, "RSN: Authenticator accepted "
430 "opportunistic PMKSA entry - marking it valid");
431 sm
->cur_pmksa
->opportunistic
= 0;
434 #ifdef CONFIG_IEEE80211R
435 if (wpa_key_mgmt_ft(sm
->key_mgmt
)) {
436 /* Prepare for the next transition */
437 wpa_ft_prepare_auth_request(sm
);
439 #endif /* CONFIG_IEEE80211R */
443 static void wpa_sm_rekey_ptk(void *eloop_ctx
, void *timeout_ctx
)
445 struct wpa_sm
*sm
= eloop_ctx
;
446 wpa_printf(MSG_DEBUG
, "WPA: Request PTK rekeying");
447 wpa_sm_key_request(sm
, 0, 1);
451 static int wpa_supplicant_install_ptk(struct wpa_sm
*sm
,
452 const struct wpa_eapol_key
*key
)
457 u8 null_rsc
[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
459 wpa_printf(MSG_DEBUG
, "WPA: Installing PTK to the driver.");
461 switch (sm
->pairwise_cipher
) {
462 case WPA_CIPHER_CCMP
:
467 case WPA_CIPHER_TKIP
:
472 case WPA_CIPHER_NONE
:
473 wpa_printf(MSG_DEBUG
, "WPA: Pairwise Cipher Suite: "
474 "NONE - do not use pairwise keys");
477 wpa_printf(MSG_WARNING
, "WPA: Unsupported pairwise cipher %d",
478 sm
->pairwise_cipher
);
482 if (sm
->proto
== WPA_PROTO_RSN
) {
485 key_rsc
= key
->key_rsc
;
486 wpa_hexdump(MSG_DEBUG
, "WPA: RSC", key_rsc
, rsclen
);
489 if (wpa_sm_set_key(sm
, alg
, sm
->bssid
, 0, 1, key_rsc
, rsclen
,
490 (u8
*) sm
->ptk
.tk1
, keylen
) < 0) {
491 wpa_printf(MSG_WARNING
, "WPA: Failed to set PTK to the "
492 "driver (alg=%d keylen=%d bssid=" MACSTR
")",
493 alg
, keylen
, MAC2STR(sm
->bssid
));
497 if (sm
->wpa_ptk_rekey
) {
498 eloop_cancel_timeout(wpa_sm_rekey_ptk
, sm
, NULL
);
499 eloop_register_timeout(sm
->wpa_ptk_rekey
, 0, wpa_sm_rekey_ptk
,
507 static int wpa_supplicant_check_group_cipher(int group_cipher
,
508 int keylen
, int maxkeylen
,
514 switch (group_cipher
) {
515 case WPA_CIPHER_CCMP
:
516 if (keylen
!= 16 || maxkeylen
< 16) {
523 case WPA_CIPHER_TKIP
:
524 if (keylen
!= 32 || maxkeylen
< 32) {
531 case WPA_CIPHER_WEP104
:
532 if (keylen
!= 13 || maxkeylen
< 13) {
539 case WPA_CIPHER_WEP40
:
540 if (keylen
!= 5 || maxkeylen
< 5) {
548 wpa_printf(MSG_WARNING
, "WPA: Unsupported Group Cipher %d",
554 wpa_printf(MSG_WARNING
, "WPA: Unsupported %s Group Cipher key "
556 wpa_cipher_txt(group_cipher
), keylen
, maxkeylen
);
563 struct wpa_gtk_data
{
565 int tx
, key_rsc_len
, keyidx
;
571 static int wpa_supplicant_install_gtk(struct wpa_sm
*sm
,
572 const struct wpa_gtk_data
*gd
,
575 const u8
*_gtk
= gd
->gtk
;
578 wpa_hexdump_key(MSG_DEBUG
, "WPA: Group Key", gd
->gtk
, gd
->gtk_len
);
579 wpa_printf(MSG_DEBUG
, "WPA: Installing GTK to the driver "
580 "(keyidx=%d tx=%d len=%d).", gd
->keyidx
, gd
->tx
,
582 wpa_hexdump(MSG_DEBUG
, "WPA: RSC", key_rsc
, gd
->key_rsc_len
);
583 if (sm
->group_cipher
== WPA_CIPHER_TKIP
) {
584 /* Swap Tx/Rx keys for Michael MIC */
585 os_memcpy(gtk_buf
, gd
->gtk
, 16);
586 os_memcpy(gtk_buf
+ 16, gd
->gtk
+ 24, 8);
587 os_memcpy(gtk_buf
+ 24, gd
->gtk
+ 16, 8);
590 if (sm
->pairwise_cipher
== WPA_CIPHER_NONE
) {
591 if (wpa_sm_set_key(sm
, gd
->alg
,
592 (u8
*) "\xff\xff\xff\xff\xff\xff",
593 gd
->keyidx
, 1, key_rsc
, gd
->key_rsc_len
,
594 _gtk
, gd
->gtk_len
) < 0) {
595 wpa_printf(MSG_WARNING
, "WPA: Failed to set "
596 "GTK to the driver (Group only).");
599 } else if (wpa_sm_set_key(sm
, gd
->alg
,
600 (u8
*) "\xff\xff\xff\xff\xff\xff",
601 gd
->keyidx
, gd
->tx
, key_rsc
, gd
->key_rsc_len
,
602 _gtk
, gd
->gtk_len
) < 0) {
603 wpa_printf(MSG_WARNING
, "WPA: Failed to set GTK to "
604 "the driver (alg=%d keylen=%d keyidx=%d)",
605 gd
->alg
, gd
->gtk_len
, gd
->keyidx
);
613 static int wpa_supplicant_gtk_tx_bit_workaround(const struct wpa_sm
*sm
,
616 if (tx
&& sm
->pairwise_cipher
!= WPA_CIPHER_NONE
) {
617 /* Ignore Tx bit for GTK if a pairwise key is used. One AP
618 * seemed to set this bit (incorrectly, since Tx is only when
619 * doing Group Key only APs) and without this workaround, the
620 * data connection does not work because wpa_supplicant
621 * configured non-zero keyidx to be used for unicast. */
622 wpa_printf(MSG_INFO
, "WPA: Tx bit set for GTK, but pairwise "
623 "keys are used - ignore Tx bit");
630 static int wpa_supplicant_pairwise_gtk(struct wpa_sm
*sm
,
631 const struct wpa_eapol_key
*key
,
632 const u8
*gtk
, size_t gtk_len
,
635 #ifndef CONFIG_NO_WPA2
636 struct wpa_gtk_data gd
;
639 * IEEE Std 802.11i-2004 - 8.5.2 EAPOL-Key frames - Figure 43x
641 * KeyID[bits 0-1], Tx [bit 2], Reserved [bits 3-7]
642 * Reserved [bits 0-7]
646 os_memset(&gd
, 0, sizeof(gd
));
647 wpa_hexdump_key(MSG_DEBUG
, "RSN: received GTK in pairwise handshake",
650 if (gtk_len
< 2 || gtk_len
- 2 > sizeof(gd
.gtk
))
653 gd
.keyidx
= gtk
[0] & 0x3;
654 gd
.tx
= wpa_supplicant_gtk_tx_bit_workaround(sm
,
655 !!(gtk
[0] & BIT(2)));
659 os_memcpy(gd
.gtk
, gtk
, gtk_len
);
660 gd
.gtk_len
= gtk_len
;
662 if (wpa_supplicant_check_group_cipher(sm
->group_cipher
,
664 &gd
.key_rsc_len
, &gd
.alg
) ||
665 wpa_supplicant_install_gtk(sm
, &gd
, key
->key_rsc
)) {
666 wpa_printf(MSG_DEBUG
, "RSN: Failed to install GTK");
670 wpa_supplicant_key_neg_complete(sm
, sm
->bssid
,
671 key_info
& WPA_KEY_INFO_SECURE
);
673 #else /* CONFIG_NO_WPA2 */
675 #endif /* CONFIG_NO_WPA2 */
679 static int ieee80211w_set_keys(struct wpa_sm
*sm
,
680 struct wpa_eapol_ie_parse
*ie
)
682 #ifdef CONFIG_IEEE80211W
683 if (sm
->mgmt_group_cipher
!= WPA_CIPHER_AES_128_CMAC
)
687 const struct wpa_igtk_kde
*igtk
;
689 if (ie
->igtk_len
!= sizeof(*igtk
))
691 igtk
= (const struct wpa_igtk_kde
*) ie
->igtk
;
692 keyidx
= WPA_GET_LE16(igtk
->keyid
);
693 wpa_printf(MSG_DEBUG
, "WPA: IGTK keyid %d "
694 "pn %02x%02x%02x%02x%02x%02x",
695 keyidx
, MAC2STR(igtk
->pn
));
696 wpa_hexdump_key(MSG_DEBUG
, "WPA: IGTK",
697 igtk
->igtk
, WPA_IGTK_LEN
);
699 wpa_printf(MSG_WARNING
, "WPA: Invalid IGTK KeyID %d",
703 if (wpa_sm_set_key(sm
, WPA_ALG_IGTK
,
704 (u8
*) "\xff\xff\xff\xff\xff\xff",
705 keyidx
, 0, igtk
->pn
, sizeof(igtk
->pn
),
706 igtk
->igtk
, WPA_IGTK_LEN
) < 0) {
707 wpa_printf(MSG_WARNING
, "WPA: Failed to configure IGTK"
714 #else /* CONFIG_IEEE80211W */
716 #endif /* CONFIG_IEEE80211W */
720 static void wpa_report_ie_mismatch(struct wpa_sm
*sm
,
721 const char *reason
, const u8
*src_addr
,
722 const u8
*wpa_ie
, size_t wpa_ie_len
,
723 const u8
*rsn_ie
, size_t rsn_ie_len
)
725 wpa_msg(sm
->ctx
->msg_ctx
, MSG_WARNING
, "WPA: %s (src=" MACSTR
")",
726 reason
, MAC2STR(src_addr
));
729 wpa_hexdump(MSG_INFO
, "WPA: WPA IE in Beacon/ProbeResp",
730 sm
->ap_wpa_ie
, sm
->ap_wpa_ie_len
);
733 if (!sm
->ap_wpa_ie
) {
734 wpa_printf(MSG_INFO
, "WPA: No WPA IE in "
737 wpa_hexdump(MSG_INFO
, "WPA: WPA IE in 3/4 msg",
742 wpa_hexdump(MSG_INFO
, "WPA: RSN IE in Beacon/ProbeResp",
743 sm
->ap_rsn_ie
, sm
->ap_rsn_ie_len
);
746 if (!sm
->ap_rsn_ie
) {
747 wpa_printf(MSG_INFO
, "WPA: No RSN IE in "
750 wpa_hexdump(MSG_INFO
, "WPA: RSN IE in 3/4 msg",
754 wpa_sm_disassociate(sm
, WLAN_REASON_IE_IN_4WAY_DIFFERS
);
758 static int wpa_supplicant_validate_ie(struct wpa_sm
*sm
,
759 const unsigned char *src_addr
,
760 struct wpa_eapol_ie_parse
*ie
)
762 if (sm
->ap_wpa_ie
== NULL
&& sm
->ap_rsn_ie
== NULL
) {
763 wpa_printf(MSG_DEBUG
, "WPA: No WPA/RSN IE for this AP known. "
764 "Trying to get from scan results");
765 if (wpa_sm_get_beacon_ie(sm
) < 0) {
766 wpa_printf(MSG_WARNING
, "WPA: Could not find AP from "
769 wpa_printf(MSG_DEBUG
, "WPA: Found the current AP from "
770 "updated scan results");
774 if (ie
->wpa_ie
== NULL
&& ie
->rsn_ie
== NULL
&&
775 (sm
->ap_wpa_ie
|| sm
->ap_rsn_ie
)) {
776 wpa_report_ie_mismatch(sm
, "IE in 3/4 msg does not match "
777 "with IE in Beacon/ProbeResp (no IE?)",
778 src_addr
, ie
->wpa_ie
, ie
->wpa_ie_len
,
779 ie
->rsn_ie
, ie
->rsn_ie_len
);
783 if ((ie
->wpa_ie
&& sm
->ap_wpa_ie
&&
784 (ie
->wpa_ie_len
!= sm
->ap_wpa_ie_len
||
785 os_memcmp(ie
->wpa_ie
, sm
->ap_wpa_ie
, ie
->wpa_ie_len
) != 0)) ||
786 (ie
->rsn_ie
&& sm
->ap_rsn_ie
&&
787 (ie
->rsn_ie_len
!= sm
->ap_rsn_ie_len
||
788 os_memcmp(ie
->rsn_ie
, sm
->ap_rsn_ie
, ie
->rsn_ie_len
) != 0))) {
789 wpa_report_ie_mismatch(sm
, "IE in 3/4 msg does not match "
790 "with IE in Beacon/ProbeResp",
791 src_addr
, ie
->wpa_ie
, ie
->wpa_ie_len
,
792 ie
->rsn_ie
, ie
->rsn_ie_len
);
796 if (sm
->proto
== WPA_PROTO_WPA
&&
797 ie
->rsn_ie
&& sm
->ap_rsn_ie
== NULL
&& sm
->rsn_enabled
) {
798 wpa_report_ie_mismatch(sm
, "Possible downgrade attack "
799 "detected - RSN was enabled and RSN IE "
800 "was in msg 3/4, but not in "
802 src_addr
, ie
->wpa_ie
, ie
->wpa_ie_len
,
803 ie
->rsn_ie
, ie
->rsn_ie_len
);
807 #ifdef CONFIG_IEEE80211R
808 if (wpa_key_mgmt_ft(sm
->key_mgmt
)) {
809 struct rsn_mdie
*mdie
;
810 /* TODO: verify that full MDIE matches with the one from scan
811 * results, not only mobility domain */
812 mdie
= (struct rsn_mdie
*) (ie
->mdie
+ 2);
813 if (ie
->mdie
== NULL
|| ie
->mdie_len
< 2 + sizeof(*mdie
) ||
814 os_memcmp(mdie
->mobility_domain
, sm
->mobility_domain
,
815 MOBILITY_DOMAIN_ID_LEN
) != 0) {
816 wpa_printf(MSG_DEBUG
, "FT: MDIE in msg 3/4 did not "
817 "match with the current mobility domain");
821 #endif /* CONFIG_IEEE80211R */
828 * wpa_supplicant_send_4_of_4 - Send message 4 of WPA/RSN 4-Way Handshake
829 * @sm: Pointer to WPA state machine data from wpa_sm_init()
830 * @dst: Destination address for the frame
831 * @key: Pointer to the EAPOL-Key frame header
832 * @ver: Version bits from EAPOL-Key Key Info
833 * @key_info: Key Info
834 * @kde: KDEs to include the EAPOL-Key frame
835 * @kde_len: Length of KDEs
836 * @ptk: PTK to use for keyed hash and encryption
837 * Returns: 0 on success, -1 on failure
839 int wpa_supplicant_send_4_of_4(struct wpa_sm
*sm
, const unsigned char *dst
,
840 const struct wpa_eapol_key
*key
,
841 u16 ver
, u16 key_info
,
842 const u8
*kde
, size_t kde_len
,
846 struct wpa_eapol_key
*reply
;
850 wpa_hexdump(MSG_DEBUG
, "WPA: KDE for msg 4/4", kde
, kde_len
);
852 rbuf
= wpa_sm_alloc_eapol(sm
, IEEE802_1X_TYPE_EAPOL_KEY
, NULL
,
853 sizeof(*reply
) + kde_len
,
854 &rlen
, (void *) &reply
);
858 reply
->type
= sm
->proto
== WPA_PROTO_RSN
?
859 EAPOL_KEY_TYPE_RSN
: EAPOL_KEY_TYPE_WPA
;
860 key_info
&= WPA_KEY_INFO_SECURE
;
861 key_info
|= ver
| WPA_KEY_INFO_KEY_TYPE
| WPA_KEY_INFO_MIC
;
862 WPA_PUT_BE16(reply
->key_info
, key_info
);
863 if (sm
->proto
== WPA_PROTO_RSN
)
864 WPA_PUT_BE16(reply
->key_length
, 0);
866 os_memcpy(reply
->key_length
, key
->key_length
, 2);
867 os_memcpy(reply
->replay_counter
, key
->replay_counter
,
868 WPA_REPLAY_COUNTER_LEN
);
870 WPA_PUT_BE16(reply
->key_data_length
, kde_len
);
872 os_memcpy(reply
+ 1, kde
, kde_len
);
874 wpa_printf(MSG_DEBUG
, "WPA: Sending EAPOL-Key 4/4");
875 wpa_eapol_key_send(sm
, ptk
->kck
, ver
, dst
, ETH_P_EAPOL
,
876 rbuf
, rlen
, reply
->key_mic
);
882 static void wpa_supplicant_process_3_of_4(struct wpa_sm
*sm
,
883 const struct wpa_eapol_key
*key
,
886 u16 key_info
, keylen
, len
;
888 struct wpa_eapol_ie_parse ie
;
890 wpa_sm_set_state(sm
, WPA_4WAY_HANDSHAKE
);
891 wpa_printf(MSG_DEBUG
, "WPA: RX message 3 of 4-Way Handshake from "
892 MACSTR
" (ver=%d)", MAC2STR(sm
->bssid
), ver
);
894 key_info
= WPA_GET_BE16(key
->key_info
);
896 pos
= (const u8
*) (key
+ 1);
897 len
= WPA_GET_BE16(key
->key_data_length
);
898 wpa_hexdump(MSG_DEBUG
, "WPA: IE KeyData", pos
, len
);
899 wpa_supplicant_parse_ies(pos
, len
, &ie
);
900 if (ie
.gtk
&& !(key_info
& WPA_KEY_INFO_ENCR_KEY_DATA
)) {
901 wpa_printf(MSG_WARNING
, "WPA: GTK IE in unencrypted key data");
904 #ifdef CONFIG_IEEE80211W
905 if (ie
.igtk
&& !(key_info
& WPA_KEY_INFO_ENCR_KEY_DATA
)) {
906 wpa_printf(MSG_WARNING
, "WPA: IGTK KDE in unencrypted key "
911 if (ie
.igtk
&& ie
.igtk_len
!= sizeof(struct wpa_igtk_kde
)) {
912 wpa_printf(MSG_WARNING
, "WPA: Invalid IGTK KDE length %lu",
913 (unsigned long) ie
.igtk_len
);
916 #endif /* CONFIG_IEEE80211W */
918 if (wpa_supplicant_validate_ie(sm
, sm
->bssid
, &ie
) < 0)
921 if (os_memcmp(sm
->anonce
, key
->key_nonce
, WPA_NONCE_LEN
) != 0) {
922 wpa_printf(MSG_WARNING
, "WPA: ANonce from message 1 of 4-Way "
923 "Handshake differs from 3 of 4-Way Handshake - drop"
924 " packet (src=" MACSTR
")", MAC2STR(sm
->bssid
));
928 keylen
= WPA_GET_BE16(key
->key_length
);
929 switch (sm
->pairwise_cipher
) {
930 case WPA_CIPHER_CCMP
:
932 wpa_printf(MSG_WARNING
, "WPA: Invalid CCMP key length "
933 "%d (src=" MACSTR
")",
934 keylen
, MAC2STR(sm
->bssid
));
938 case WPA_CIPHER_TKIP
:
940 wpa_printf(MSG_WARNING
, "WPA: Invalid TKIP key length "
941 "%d (src=" MACSTR
")",
942 keylen
, MAC2STR(sm
->bssid
));
948 if (wpa_supplicant_send_4_of_4(sm
, sm
->bssid
, key
, ver
, key_info
,
949 NULL
, 0, &sm
->ptk
)) {
953 /* SNonce was successfully used in msg 3/4, so mark it to be renewed
954 * for the next 4-Way Handshake. If msg 3 is received again, the old
955 * SNonce will still be used to avoid changing PTK. */
956 sm
->renew_snonce
= 1;
958 if (key_info
& WPA_KEY_INFO_INSTALL
) {
959 if (wpa_supplicant_install_ptk(sm
, key
))
963 if (key_info
& WPA_KEY_INFO_SECURE
) {
964 wpa_sm_mlme_setprotection(
965 sm
, sm
->bssid
, MLME_SETPROTECTION_PROTECT_TYPE_RX
,
966 MLME_SETPROTECTION_KEY_TYPE_PAIRWISE
);
967 eapol_sm_notify_portValid(sm
->eapol
, TRUE
);
969 wpa_sm_set_state(sm
, WPA_GROUP_HANDSHAKE
);
972 wpa_supplicant_pairwise_gtk(sm
, key
,
973 ie
.gtk
, ie
.gtk_len
, key_info
) < 0) {
974 wpa_printf(MSG_INFO
, "RSN: Failed to configure GTK");
978 if (ieee80211w_set_keys(sm
, &ie
) < 0) {
979 wpa_printf(MSG_INFO
, "RSN: Failed to configure IGTK");
986 wpa_sm_deauthenticate(sm
, WLAN_REASON_UNSPECIFIED
);
990 static int wpa_supplicant_process_1_of_2_rsn(struct wpa_sm
*sm
,
994 struct wpa_gtk_data
*gd
)
997 struct wpa_eapol_ie_parse ie
;
999 wpa_hexdump(MSG_DEBUG
, "RSN: msg 1/2 key data", keydata
, keydatalen
);
1000 wpa_supplicant_parse_ies(keydata
, keydatalen
, &ie
);
1001 if (ie
.gtk
&& !(key_info
& WPA_KEY_INFO_ENCR_KEY_DATA
)) {
1002 wpa_printf(MSG_WARNING
, "WPA: GTK IE in unencrypted key data");
1005 if (ie
.gtk
== NULL
) {
1006 wpa_printf(MSG_INFO
, "WPA: No GTK IE in Group Key msg 1/2");
1009 maxkeylen
= gd
->gtk_len
= ie
.gtk_len
- 2;
1011 if (wpa_supplicant_check_group_cipher(sm
->group_cipher
,
1012 gd
->gtk_len
, maxkeylen
,
1013 &gd
->key_rsc_len
, &gd
->alg
))
1016 wpa_hexdump(MSG_DEBUG
, "RSN: received GTK in group key handshake",
1017 ie
.gtk
, ie
.gtk_len
);
1018 gd
->keyidx
= ie
.gtk
[0] & 0x3;
1019 gd
->tx
= wpa_supplicant_gtk_tx_bit_workaround(sm
,
1020 !!(ie
.gtk
[0] & BIT(2)));
1021 if (ie
.gtk_len
- 2 > sizeof(gd
->gtk
)) {
1022 wpa_printf(MSG_INFO
, "RSN: Too long GTK in GTK IE "
1023 "(len=%lu)", (unsigned long) ie
.gtk_len
- 2);
1026 os_memcpy(gd
->gtk
, ie
.gtk
+ 2, ie
.gtk_len
- 2);
1028 if (ieee80211w_set_keys(sm
, &ie
) < 0)
1029 wpa_printf(MSG_INFO
, "RSN: Failed to configure IGTK");
1035 static int wpa_supplicant_process_1_of_2_wpa(struct wpa_sm
*sm
,
1036 const struct wpa_eapol_key
*key
,
1037 size_t keydatalen
, int key_info
,
1038 size_t extra_len
, u16 ver
,
1039 struct wpa_gtk_data
*gd
)
1044 gd
->gtk_len
= WPA_GET_BE16(key
->key_length
);
1045 maxkeylen
= keydatalen
;
1046 if (keydatalen
> extra_len
) {
1047 wpa_printf(MSG_INFO
, "WPA: Truncated EAPOL-Key packet:"
1048 " key_data_length=%lu > extra_len=%lu",
1049 (unsigned long) keydatalen
,
1050 (unsigned long) extra_len
);
1053 if (ver
== WPA_KEY_INFO_TYPE_HMAC_SHA1_AES
) {
1054 if (maxkeylen
< 8) {
1055 wpa_printf(MSG_INFO
, "WPA: Too short maxkeylen (%lu)",
1056 (unsigned long) maxkeylen
);
1062 if (wpa_supplicant_check_group_cipher(sm
->group_cipher
,
1063 gd
->gtk_len
, maxkeylen
,
1064 &gd
->key_rsc_len
, &gd
->alg
))
1067 gd
->keyidx
= (key_info
& WPA_KEY_INFO_KEY_INDEX_MASK
) >>
1068 WPA_KEY_INFO_KEY_INDEX_SHIFT
;
1069 if (ver
== WPA_KEY_INFO_TYPE_HMAC_MD5_RC4
) {
1070 os_memcpy(ek
, key
->key_iv
, 16);
1071 os_memcpy(ek
+ 16, sm
->ptk
.kek
, 16);
1072 if (keydatalen
> sizeof(gd
->gtk
)) {
1073 wpa_printf(MSG_WARNING
, "WPA: RC4 key data "
1075 (unsigned long) keydatalen
);
1078 os_memcpy(gd
->gtk
, key
+ 1, keydatalen
);
1079 if (rc4_skip(ek
, 32, 256, gd
->gtk
, keydatalen
)) {
1080 wpa_printf(MSG_ERROR
, "WPA: RC4 failed");
1083 } else if (ver
== WPA_KEY_INFO_TYPE_HMAC_SHA1_AES
) {
1084 if (keydatalen
% 8) {
1085 wpa_printf(MSG_WARNING
, "WPA: Unsupported AES-WRAP "
1086 "len %lu", (unsigned long) keydatalen
);
1089 if (maxkeylen
> sizeof(gd
->gtk
)) {
1090 wpa_printf(MSG_WARNING
, "WPA: AES-WRAP key data "
1091 "too long (keydatalen=%lu maxkeylen=%lu)",
1092 (unsigned long) keydatalen
,
1093 (unsigned long) maxkeylen
);
1096 if (aes_unwrap(sm
->ptk
.kek
, maxkeylen
/ 8,
1097 (const u8
*) (key
+ 1), gd
->gtk
)) {
1098 wpa_printf(MSG_WARNING
, "WPA: AES unwrap "
1099 "failed - could not decrypt GTK");
1103 wpa_printf(MSG_WARNING
, "WPA: Unsupported key_info type %d",
1107 gd
->tx
= wpa_supplicant_gtk_tx_bit_workaround(
1108 sm
, !!(key_info
& WPA_KEY_INFO_TXRX
));
1113 static int wpa_supplicant_send_2_of_2(struct wpa_sm
*sm
,
1114 const struct wpa_eapol_key
*key
,
1115 int ver
, u16 key_info
)
1118 struct wpa_eapol_key
*reply
;
1121 rbuf
= wpa_sm_alloc_eapol(sm
, IEEE802_1X_TYPE_EAPOL_KEY
, NULL
,
1122 sizeof(*reply
), &rlen
, (void *) &reply
);
1126 reply
->type
= sm
->proto
== WPA_PROTO_RSN
?
1127 EAPOL_KEY_TYPE_RSN
: EAPOL_KEY_TYPE_WPA
;
1128 key_info
&= WPA_KEY_INFO_KEY_INDEX_MASK
;
1129 key_info
|= ver
| WPA_KEY_INFO_MIC
| WPA_KEY_INFO_SECURE
;
1130 WPA_PUT_BE16(reply
->key_info
, key_info
);
1131 if (sm
->proto
== WPA_PROTO_RSN
)
1132 WPA_PUT_BE16(reply
->key_length
, 0);
1134 os_memcpy(reply
->key_length
, key
->key_length
, 2);
1135 os_memcpy(reply
->replay_counter
, key
->replay_counter
,
1136 WPA_REPLAY_COUNTER_LEN
);
1138 WPA_PUT_BE16(reply
->key_data_length
, 0);
1140 wpa_printf(MSG_DEBUG
, "WPA: Sending EAPOL-Key 2/2");
1141 wpa_eapol_key_send(sm
, sm
->ptk
.kck
, ver
, sm
->bssid
, ETH_P_EAPOL
,
1142 rbuf
, rlen
, reply
->key_mic
);
1148 static void wpa_supplicant_process_1_of_2(struct wpa_sm
*sm
,
1149 const unsigned char *src_addr
,
1150 const struct wpa_eapol_key
*key
,
1151 int extra_len
, u16 ver
)
1153 u16 key_info
, keydatalen
;
1155 struct wpa_gtk_data gd
;
1157 os_memset(&gd
, 0, sizeof(gd
));
1159 rekey
= wpa_sm_get_state(sm
) == WPA_COMPLETED
;
1160 wpa_printf(MSG_DEBUG
, "WPA: RX message 1 of Group Key Handshake from "
1161 MACSTR
" (ver=%d)", MAC2STR(src_addr
), ver
);
1163 key_info
= WPA_GET_BE16(key
->key_info
);
1164 keydatalen
= WPA_GET_BE16(key
->key_data_length
);
1166 if (sm
->proto
== WPA_PROTO_RSN
) {
1167 ret
= wpa_supplicant_process_1_of_2_rsn(sm
,
1168 (const u8
*) (key
+ 1),
1169 keydatalen
, key_info
,
1172 ret
= wpa_supplicant_process_1_of_2_wpa(sm
, key
, keydatalen
,
1173 key_info
, extra_len
,
1177 wpa_sm_set_state(sm
, WPA_GROUP_HANDSHAKE
);
1182 if (wpa_supplicant_install_gtk(sm
, &gd
, key
->key_rsc
) ||
1183 wpa_supplicant_send_2_of_2(sm
, key
, ver
, key_info
))
1187 wpa_msg(sm
->ctx
->msg_ctx
, MSG_INFO
, "WPA: Group rekeying "
1188 "completed with " MACSTR
" [GTK=%s]",
1189 MAC2STR(sm
->bssid
), wpa_cipher_txt(sm
->group_cipher
));
1190 wpa_sm_cancel_auth_timeout(sm
);
1191 wpa_sm_set_state(sm
, WPA_COMPLETED
);
1193 wpa_supplicant_key_neg_complete(sm
, sm
->bssid
,
1195 WPA_KEY_INFO_SECURE
);
1200 wpa_sm_deauthenticate(sm
, WLAN_REASON_UNSPECIFIED
);
1204 static int wpa_supplicant_verify_eapol_key_mic(struct wpa_sm
*sm
,
1205 struct wpa_eapol_key
*key
,
1207 const u8
*buf
, size_t len
)
1212 os_memcpy(mic
, key
->key_mic
, 16);
1214 os_memset(key
->key_mic
, 0, 16);
1215 wpa_eapol_key_mic(sm
->tptk
.kck
, ver
, buf
, len
,
1217 if (os_memcmp(mic
, key
->key_mic
, 16) != 0) {
1218 wpa_printf(MSG_WARNING
, "WPA: Invalid EAPOL-Key MIC "
1219 "when using TPTK - ignoring TPTK");
1224 os_memcpy(&sm
->ptk
, &sm
->tptk
, sizeof(sm
->ptk
));
1228 if (!ok
&& sm
->ptk_set
) {
1229 os_memset(key
->key_mic
, 0, 16);
1230 wpa_eapol_key_mic(sm
->ptk
.kck
, ver
, buf
, len
,
1232 if (os_memcmp(mic
, key
->key_mic
, 16) != 0) {
1233 wpa_printf(MSG_WARNING
, "WPA: Invalid EAPOL-Key MIC "
1234 "- dropping packet");
1241 wpa_printf(MSG_WARNING
, "WPA: Could not verify EAPOL-Key MIC "
1242 "- dropping packet");
1246 os_memcpy(sm
->rx_replay_counter
, key
->replay_counter
,
1247 WPA_REPLAY_COUNTER_LEN
);
1248 sm
->rx_replay_counter_set
= 1;
1253 /* Decrypt RSN EAPOL-Key key data (RC4 or AES-WRAP) */
1254 static int wpa_supplicant_decrypt_key_data(struct wpa_sm
*sm
,
1255 struct wpa_eapol_key
*key
, u16 ver
)
1257 u16 keydatalen
= WPA_GET_BE16(key
->key_data_length
);
1259 wpa_hexdump(MSG_DEBUG
, "RSN: encrypted key data",
1260 (u8
*) (key
+ 1), keydatalen
);
1262 wpa_printf(MSG_WARNING
, "WPA: PTK not available, "
1263 "cannot decrypt EAPOL-Key key data.");
1267 /* Decrypt key data here so that this operation does not need
1268 * to be implemented separately for each message type. */
1269 if (ver
== WPA_KEY_INFO_TYPE_HMAC_MD5_RC4
) {
1271 os_memcpy(ek
, key
->key_iv
, 16);
1272 os_memcpy(ek
+ 16, sm
->ptk
.kek
, 16);
1273 if (rc4_skip(ek
, 32, 256, (u8
*) (key
+ 1), keydatalen
)) {
1274 wpa_printf(MSG_ERROR
, "WPA: RC4 failed");
1277 } else if (ver
== WPA_KEY_INFO_TYPE_HMAC_SHA1_AES
||
1278 ver
== WPA_KEY_INFO_TYPE_AES_128_CMAC
) {
1280 if (keydatalen
% 8) {
1281 wpa_printf(MSG_WARNING
, "WPA: Unsupported "
1282 "AES-WRAP len %d", keydatalen
);
1285 keydatalen
-= 8; /* AES-WRAP adds 8 bytes */
1286 buf
= os_malloc(keydatalen
);
1288 wpa_printf(MSG_WARNING
, "WPA: No memory for "
1289 "AES-UNWRAP buffer");
1292 if (aes_unwrap(sm
->ptk
.kek
, keydatalen
/ 8,
1293 (u8
*) (key
+ 1), buf
)) {
1295 wpa_printf(MSG_WARNING
, "WPA: AES unwrap failed - "
1296 "could not decrypt EAPOL-Key key data");
1299 os_memcpy(key
+ 1, buf
, keydatalen
);
1301 WPA_PUT_BE16(key
->key_data_length
, keydatalen
);
1303 wpa_printf(MSG_WARNING
, "WPA: Unsupported key_info type %d",
1307 wpa_hexdump_key(MSG_DEBUG
, "WPA: decrypted EAPOL-Key key data",
1308 (u8
*) (key
+ 1), keydatalen
);
1314 * wpa_sm_aborted_cached - Notify WPA that PMKSA caching was aborted
1315 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1317 void wpa_sm_aborted_cached(struct wpa_sm
*sm
)
1319 if (sm
&& sm
->cur_pmksa
) {
1320 wpa_printf(MSG_DEBUG
, "RSN: Cancelling PMKSA caching attempt");
1321 sm
->cur_pmksa
= NULL
;
1326 static void wpa_eapol_key_dump(const struct wpa_eapol_key
*key
)
1328 #ifndef CONFIG_NO_STDOUT_DEBUG
1329 u16 key_info
= WPA_GET_BE16(key
->key_info
);
1331 wpa_printf(MSG_DEBUG
, " EAPOL-Key type=%d", key
->type
);
1332 wpa_printf(MSG_DEBUG
, " key_info 0x%x (ver=%d keyidx=%d rsvd=%d %s"
1334 key_info
, key_info
& WPA_KEY_INFO_TYPE_MASK
,
1335 (key_info
& WPA_KEY_INFO_KEY_INDEX_MASK
) >>
1336 WPA_KEY_INFO_KEY_INDEX_SHIFT
,
1337 (key_info
& (BIT(13) | BIT(14) | BIT(15))) >> 13,
1338 key_info
& WPA_KEY_INFO_KEY_TYPE
? "Pairwise" : "Group",
1339 key_info
& WPA_KEY_INFO_INSTALL
? " Install" : "",
1340 key_info
& WPA_KEY_INFO_ACK
? " Ack" : "",
1341 key_info
& WPA_KEY_INFO_MIC
? " MIC" : "",
1342 key_info
& WPA_KEY_INFO_SECURE
? " Secure" : "",
1343 key_info
& WPA_KEY_INFO_ERROR
? " Error" : "",
1344 key_info
& WPA_KEY_INFO_REQUEST
? " Request" : "",
1345 key_info
& WPA_KEY_INFO_ENCR_KEY_DATA
? " Encr" : "");
1346 wpa_printf(MSG_DEBUG
, " key_length=%u key_data_length=%u",
1347 WPA_GET_BE16(key
->key_length
),
1348 WPA_GET_BE16(key
->key_data_length
));
1349 wpa_hexdump(MSG_DEBUG
, " replay_counter",
1350 key
->replay_counter
, WPA_REPLAY_COUNTER_LEN
);
1351 wpa_hexdump(MSG_DEBUG
, " key_nonce", key
->key_nonce
, WPA_NONCE_LEN
);
1352 wpa_hexdump(MSG_DEBUG
, " key_iv", key
->key_iv
, 16);
1353 wpa_hexdump(MSG_DEBUG
, " key_rsc", key
->key_rsc
, 8);
1354 wpa_hexdump(MSG_DEBUG
, " key_id (reserved)", key
->key_id
, 8);
1355 wpa_hexdump(MSG_DEBUG
, " key_mic", key
->key_mic
, 16);
1356 #endif /* CONFIG_NO_STDOUT_DEBUG */
1361 * wpa_sm_rx_eapol - Process received WPA EAPOL frames
1362 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1363 * @src_addr: Source MAC address of the EAPOL packet
1364 * @buf: Pointer to the beginning of the EAPOL data (EAPOL header)
1365 * @len: Length of the EAPOL frame
1366 * Returns: 1 = WPA EAPOL-Key processed, 0 = not a WPA EAPOL-Key, -1 failure
1368 * This function is called for each received EAPOL frame. Other than EAPOL-Key
1369 * frames can be skipped if filtering is done elsewhere. wpa_sm_rx_eapol() is
1370 * only processing WPA and WPA2 EAPOL-Key frames.
1372 * The received EAPOL-Key packets are validated and valid packets are replied
1373 * to. In addition, key material (PTK, GTK) is configured at the end of a
1374 * successful key handshake.
1376 int wpa_sm_rx_eapol(struct wpa_sm
*sm
, const u8
*src_addr
,
1377 const u8
*buf
, size_t len
)
1379 size_t plen
, data_len
, extra_len
;
1380 struct ieee802_1x_hdr
*hdr
;
1381 struct wpa_eapol_key
*key
;
1385 struct wpa_peerkey
*peerkey
= NULL
;
1387 #ifdef CONFIG_IEEE80211R
1388 sm
->ft_completed
= 0;
1389 #endif /* CONFIG_IEEE80211R */
1391 if (len
< sizeof(*hdr
) + sizeof(*key
)) {
1392 wpa_printf(MSG_DEBUG
, "WPA: EAPOL frame too short to be a WPA "
1393 "EAPOL-Key (len %lu, expecting at least %lu)",
1394 (unsigned long) len
,
1395 (unsigned long) sizeof(*hdr
) + sizeof(*key
));
1399 tmp
= os_malloc(len
);
1402 os_memcpy(tmp
, buf
, len
);
1404 hdr
= (struct ieee802_1x_hdr
*) tmp
;
1405 key
= (struct wpa_eapol_key
*) (hdr
+ 1);
1406 plen
= be_to_host16(hdr
->length
);
1407 data_len
= plen
+ sizeof(*hdr
);
1408 wpa_printf(MSG_DEBUG
, "IEEE 802.1X RX: version=%d type=%d length=%lu",
1409 hdr
->version
, hdr
->type
, (unsigned long) plen
);
1411 if (hdr
->version
< EAPOL_VERSION
) {
1412 /* TODO: backwards compatibility */
1414 if (hdr
->type
!= IEEE802_1X_TYPE_EAPOL_KEY
) {
1415 wpa_printf(MSG_DEBUG
, "WPA: EAPOL frame (type %u) discarded, "
1416 "not a Key frame", hdr
->type
);
1420 if (plen
> len
- sizeof(*hdr
) || plen
< sizeof(*key
)) {
1421 wpa_printf(MSG_DEBUG
, "WPA: EAPOL frame payload size %lu "
1422 "invalid (frame size %lu)",
1423 (unsigned long) plen
, (unsigned long) len
);
1428 if (key
->type
!= EAPOL_KEY_TYPE_WPA
&& key
->type
!= EAPOL_KEY_TYPE_RSN
)
1430 wpa_printf(MSG_DEBUG
, "WPA: EAPOL-Key type (%d) unknown, "
1431 "discarded", key
->type
);
1435 wpa_eapol_key_dump(key
);
1437 eapol_sm_notify_lower_layer_success(sm
->eapol
, 0);
1438 wpa_hexdump(MSG_MSGDUMP
, "WPA: RX EAPOL-Key", tmp
, len
);
1439 if (data_len
< len
) {
1440 wpa_printf(MSG_DEBUG
, "WPA: ignoring %lu bytes after the IEEE "
1441 "802.1X data", (unsigned long) len
- data_len
);
1443 key_info
= WPA_GET_BE16(key
->key_info
);
1444 ver
= key_info
& WPA_KEY_INFO_TYPE_MASK
;
1445 if (ver
!= WPA_KEY_INFO_TYPE_HMAC_MD5_RC4
&&
1446 #if defined(CONFIG_IEEE80211R) || defined(CONFIG_IEEE80211W)
1447 ver
!= WPA_KEY_INFO_TYPE_AES_128_CMAC
&&
1448 #endif /* CONFIG_IEEE80211R || CONFIG_IEEE80211W */
1449 ver
!= WPA_KEY_INFO_TYPE_HMAC_SHA1_AES
) {
1450 wpa_printf(MSG_INFO
, "WPA: Unsupported EAPOL-Key descriptor "
1451 "version %d.", ver
);
1455 #ifdef CONFIG_IEEE80211R
1456 if (wpa_key_mgmt_ft(sm
->key_mgmt
)) {
1457 /* IEEE 802.11r uses a new key_info type (AES-128-CMAC). */
1458 if (ver
!= WPA_KEY_INFO_TYPE_AES_128_CMAC
) {
1459 wpa_printf(MSG_INFO
, "FT: AP did not use "
1464 #endif /* CONFIG_IEEE80211R */
1465 #ifdef CONFIG_IEEE80211W
1466 if (wpa_key_mgmt_sha256(sm
->key_mgmt
)) {
1467 if (ver
!= WPA_KEY_INFO_TYPE_AES_128_CMAC
) {
1468 wpa_printf(MSG_INFO
, "WPA: AP did not use the "
1469 "negotiated AES-128-CMAC.");
1473 #endif /* CONFIG_IEEE80211W */
1474 if (sm
->pairwise_cipher
== WPA_CIPHER_CCMP
&&
1475 ver
!= WPA_KEY_INFO_TYPE_HMAC_SHA1_AES
) {
1476 wpa_printf(MSG_INFO
, "WPA: CCMP is used, but EAPOL-Key "
1477 "descriptor version (%d) is not 2.", ver
);
1478 if (sm
->group_cipher
!= WPA_CIPHER_CCMP
&&
1479 !(key_info
& WPA_KEY_INFO_KEY_TYPE
)) {
1480 /* Earlier versions of IEEE 802.11i did not explicitly
1481 * require version 2 descriptor for all EAPOL-Key
1482 * packets, so allow group keys to use version 1 if
1483 * CCMP is not used for them. */
1484 wpa_printf(MSG_INFO
, "WPA: Backwards compatibility: "
1485 "allow invalid version for non-CCMP group "
1491 #ifdef CONFIG_PEERKEY
1492 for (peerkey
= sm
->peerkey
; peerkey
; peerkey
= peerkey
->next
) {
1493 if (os_memcmp(peerkey
->addr
, src_addr
, ETH_ALEN
) == 0)
1497 if (!(key_info
& WPA_KEY_INFO_SMK_MESSAGE
) && peerkey
) {
1498 if (!peerkey
->initiator
&& peerkey
->replay_counter_set
&&
1499 os_memcmp(key
->replay_counter
, peerkey
->replay_counter
,
1500 WPA_REPLAY_COUNTER_LEN
) <= 0) {
1501 wpa_printf(MSG_WARNING
, "RSN: EAPOL-Key Replay "
1502 "Counter did not increase (STK) - dropping "
1505 } else if (peerkey
->initiator
) {
1506 u8 _tmp
[WPA_REPLAY_COUNTER_LEN
];
1507 os_memcpy(_tmp
, key
->replay_counter
,
1508 WPA_REPLAY_COUNTER_LEN
);
1509 inc_byte_array(_tmp
, WPA_REPLAY_COUNTER_LEN
);
1510 if (os_memcmp(_tmp
, peerkey
->replay_counter
,
1511 WPA_REPLAY_COUNTER_LEN
) != 0) {
1512 wpa_printf(MSG_DEBUG
, "RSN: EAPOL-Key Replay "
1513 "Counter did not match (STK) - "
1520 if (peerkey
&& peerkey
->initiator
&& (key_info
& WPA_KEY_INFO_ACK
)) {
1521 wpa_printf(MSG_INFO
, "RSN: Ack bit in key_info from STK peer");
1524 #endif /* CONFIG_PEERKEY */
1526 if (!peerkey
&& sm
->rx_replay_counter_set
&&
1527 os_memcmp(key
->replay_counter
, sm
->rx_replay_counter
,
1528 WPA_REPLAY_COUNTER_LEN
) <= 0) {
1529 wpa_printf(MSG_WARNING
, "WPA: EAPOL-Key Replay Counter did not"
1530 " increase - dropping packet");
1534 if (!(key_info
& (WPA_KEY_INFO_ACK
| WPA_KEY_INFO_SMK_MESSAGE
))
1535 #ifdef CONFIG_PEERKEY
1536 && (peerkey
== NULL
|| !peerkey
->initiator
)
1537 #endif /* CONFIG_PEERKEY */
1539 wpa_printf(MSG_INFO
, "WPA: No Ack bit in key_info");
1543 if (key_info
& WPA_KEY_INFO_REQUEST
) {
1544 wpa_printf(MSG_INFO
, "WPA: EAPOL-Key with Request bit - "
1549 if ((key_info
& WPA_KEY_INFO_MIC
) && !peerkey
&&
1550 wpa_supplicant_verify_eapol_key_mic(sm
, key
, ver
, tmp
, data_len
))
1553 #ifdef CONFIG_PEERKEY
1554 if ((key_info
& WPA_KEY_INFO_MIC
) && peerkey
&&
1555 peerkey_verify_eapol_key_mic(sm
, peerkey
, key
, ver
, tmp
, data_len
))
1557 #endif /* CONFIG_PEERKEY */
1559 extra_len
= data_len
- sizeof(*hdr
) - sizeof(*key
);
1561 if (WPA_GET_BE16(key
->key_data_length
) > extra_len
) {
1562 wpa_msg(sm
->ctx
->msg_ctx
, MSG_INFO
, "WPA: Invalid EAPOL-Key "
1563 "frame - key_data overflow (%d > %lu)",
1564 WPA_GET_BE16(key
->key_data_length
),
1565 (unsigned long) extra_len
);
1568 extra_len
= WPA_GET_BE16(key
->key_data_length
);
1570 if (sm
->proto
== WPA_PROTO_RSN
&&
1571 (key_info
& WPA_KEY_INFO_ENCR_KEY_DATA
)) {
1572 if (wpa_supplicant_decrypt_key_data(sm
, key
, ver
))
1574 extra_len
= WPA_GET_BE16(key
->key_data_length
);
1577 if (key_info
& WPA_KEY_INFO_KEY_TYPE
) {
1578 if (key_info
& WPA_KEY_INFO_KEY_INDEX_MASK
) {
1579 wpa_printf(MSG_WARNING
, "WPA: Ignored EAPOL-Key "
1580 "(Pairwise) with non-zero key index");
1584 /* PeerKey 4-Way Handshake */
1585 peerkey_rx_eapol_4way(sm
, peerkey
, key
, key_info
, ver
);
1586 } else if (key_info
& WPA_KEY_INFO_MIC
) {
1587 /* 3/4 4-Way Handshake */
1588 wpa_supplicant_process_3_of_4(sm
, key
, ver
);
1590 /* 1/4 4-Way Handshake */
1591 wpa_supplicant_process_1_of_4(sm
, src_addr
, key
,
1594 } else if (key_info
& WPA_KEY_INFO_SMK_MESSAGE
) {
1595 /* PeerKey SMK Handshake */
1596 peerkey_rx_eapol_smk(sm
, src_addr
, key
, extra_len
, key_info
,
1599 if (key_info
& WPA_KEY_INFO_MIC
) {
1600 /* 1/2 Group Key Handshake */
1601 wpa_supplicant_process_1_of_2(sm
, src_addr
, key
,
1604 wpa_printf(MSG_WARNING
, "WPA: EAPOL-Key (Group) "
1605 "without Mic bit - dropped");
1617 #ifdef CONFIG_CTRL_IFACE
1618 static int wpa_cipher_bits(int cipher
)
1621 case WPA_CIPHER_CCMP
:
1623 case WPA_CIPHER_TKIP
:
1625 case WPA_CIPHER_WEP104
:
1627 case WPA_CIPHER_WEP40
:
1635 static u32
wpa_key_mgmt_suite(struct wpa_sm
*sm
)
1637 switch (sm
->key_mgmt
) {
1638 case WPA_KEY_MGMT_IEEE8021X
:
1639 return (sm
->proto
== WPA_PROTO_RSN
?
1640 RSN_AUTH_KEY_MGMT_UNSPEC_802_1X
:
1641 WPA_AUTH_KEY_MGMT_UNSPEC_802_1X
);
1642 case WPA_KEY_MGMT_PSK
:
1643 return (sm
->proto
== WPA_PROTO_RSN
?
1644 RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X
:
1645 WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X
);
1646 #ifdef CONFIG_IEEE80211R
1647 case WPA_KEY_MGMT_FT_IEEE8021X
:
1648 return RSN_AUTH_KEY_MGMT_FT_802_1X
;
1649 case WPA_KEY_MGMT_FT_PSK
:
1650 return RSN_AUTH_KEY_MGMT_FT_PSK
;
1651 #endif /* CONFIG_IEEE80211R */
1652 #ifdef CONFIG_IEEE80211W
1653 case WPA_KEY_MGMT_IEEE8021X_SHA256
:
1654 return RSN_AUTH_KEY_MGMT_802_1X_SHA256
;
1655 case WPA_KEY_MGMT_PSK_SHA256
:
1656 return RSN_AUTH_KEY_MGMT_PSK_SHA256
;
1657 #endif /* CONFIG_IEEE80211W */
1658 case WPA_KEY_MGMT_WPA_NONE
:
1659 return WPA_AUTH_KEY_MGMT_NONE
;
1666 static u32
wpa_cipher_suite(struct wpa_sm
*sm
, int cipher
)
1669 case WPA_CIPHER_CCMP
:
1670 return (sm
->proto
== WPA_PROTO_RSN
?
1671 RSN_CIPHER_SUITE_CCMP
: WPA_CIPHER_SUITE_CCMP
);
1672 case WPA_CIPHER_TKIP
:
1673 return (sm
->proto
== WPA_PROTO_RSN
?
1674 RSN_CIPHER_SUITE_TKIP
: WPA_CIPHER_SUITE_TKIP
);
1675 case WPA_CIPHER_WEP104
:
1676 return (sm
->proto
== WPA_PROTO_RSN
?
1677 RSN_CIPHER_SUITE_WEP104
: WPA_CIPHER_SUITE_WEP104
);
1678 case WPA_CIPHER_WEP40
:
1679 return (sm
->proto
== WPA_PROTO_RSN
?
1680 RSN_CIPHER_SUITE_WEP40
: WPA_CIPHER_SUITE_WEP40
);
1681 case WPA_CIPHER_NONE
:
1682 return (sm
->proto
== WPA_PROTO_RSN
?
1683 RSN_CIPHER_SUITE_NONE
: WPA_CIPHER_SUITE_NONE
);
1690 #define RSN_SUITE "%02x-%02x-%02x-%d"
1691 #define RSN_SUITE_ARG(s) \
1692 ((s) >> 24) & 0xff, ((s) >> 16) & 0xff, ((s) >> 8) & 0xff, (s) & 0xff
1695 * wpa_sm_get_mib - Dump text list of MIB entries
1696 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1697 * @buf: Buffer for the list
1698 * @buflen: Length of the buffer
1699 * Returns: Number of bytes written to buffer
1701 * This function is used fetch dot11 MIB variables.
1703 int wpa_sm_get_mib(struct wpa_sm
*sm
, char *buf
, size_t buflen
)
1705 char pmkid_txt
[PMKID_LEN
* 2 + 1];
1709 if (sm
->cur_pmksa
) {
1710 wpa_snprintf_hex(pmkid_txt
, sizeof(pmkid_txt
),
1711 sm
->cur_pmksa
->pmkid
, PMKID_LEN
);
1713 pmkid_txt
[0] = '\0';
1715 if ((wpa_key_mgmt_wpa_psk(sm
->key_mgmt
) ||
1716 wpa_key_mgmt_wpa_ieee8021x(sm
->key_mgmt
)) &&
1717 sm
->proto
== WPA_PROTO_RSN
)
1722 ret
= os_snprintf(buf
, buflen
,
1723 "dot11RSNAOptionImplemented=TRUE\n"
1724 "dot11RSNAPreauthenticationImplemented=TRUE\n"
1725 "dot11RSNAEnabled=%s\n"
1726 "dot11RSNAPreauthenticationEnabled=%s\n"
1727 "dot11RSNAConfigVersion=%d\n"
1728 "dot11RSNAConfigPairwiseKeysSupported=5\n"
1729 "dot11RSNAConfigGroupCipherSize=%d\n"
1730 "dot11RSNAConfigPMKLifetime=%d\n"
1731 "dot11RSNAConfigPMKReauthThreshold=%d\n"
1732 "dot11RSNAConfigNumberOfPTKSAReplayCounters=1\n"
1733 "dot11RSNAConfigSATimeout=%d\n",
1734 rsna
? "TRUE" : "FALSE",
1735 rsna
? "TRUE" : "FALSE",
1737 wpa_cipher_bits(sm
->group_cipher
),
1738 sm
->dot11RSNAConfigPMKLifetime
,
1739 sm
->dot11RSNAConfigPMKReauthThreshold
,
1740 sm
->dot11RSNAConfigSATimeout
);
1741 if (ret
< 0 || (size_t) ret
>= buflen
)
1746 buf
+ len
, buflen
- len
,
1747 "dot11RSNAAuthenticationSuiteSelected=" RSN_SUITE
"\n"
1748 "dot11RSNAPairwiseCipherSelected=" RSN_SUITE
"\n"
1749 "dot11RSNAGroupCipherSelected=" RSN_SUITE
"\n"
1750 "dot11RSNAPMKIDUsed=%s\n"
1751 "dot11RSNAAuthenticationSuiteRequested=" RSN_SUITE
"\n"
1752 "dot11RSNAPairwiseCipherRequested=" RSN_SUITE
"\n"
1753 "dot11RSNAGroupCipherRequested=" RSN_SUITE
"\n"
1754 "dot11RSNAConfigNumberOfGTKSAReplayCounters=0\n"
1755 "dot11RSNA4WayHandshakeFailures=%u\n",
1756 RSN_SUITE_ARG(wpa_key_mgmt_suite(sm
)),
1757 RSN_SUITE_ARG(wpa_cipher_suite(sm
, sm
->pairwise_cipher
)),
1758 RSN_SUITE_ARG(wpa_cipher_suite(sm
, sm
->group_cipher
)),
1760 RSN_SUITE_ARG(wpa_key_mgmt_suite(sm
)),
1761 RSN_SUITE_ARG(wpa_cipher_suite(sm
, sm
->pairwise_cipher
)),
1762 RSN_SUITE_ARG(wpa_cipher_suite(sm
, sm
->group_cipher
)),
1763 sm
->dot11RSNA4WayHandshakeFailures
);
1764 if (ret
>= 0 && (size_t) ret
< buflen
)
1769 #endif /* CONFIG_CTRL_IFACE */
1772 static void wpa_sm_pmksa_free_cb(struct rsn_pmksa_cache_entry
*entry
,
1773 void *ctx
, int replace
)
1775 struct wpa_sm
*sm
= ctx
;
1777 if (sm
->cur_pmksa
== entry
||
1778 (sm
->pmk_len
== entry
->pmk_len
&&
1779 os_memcmp(sm
->pmk
, entry
->pmk
, sm
->pmk_len
) == 0)) {
1780 wpa_printf(MSG_DEBUG
, "RSN: removed current PMKSA entry");
1781 sm
->cur_pmksa
= NULL
;
1784 /* A new entry is being added, so no need to
1785 * deauthenticate in this case. This happens when EAP
1786 * authentication is completed again (reauth or failed
1787 * PMKSA caching attempt). */
1791 os_memset(sm
->pmk
, 0, sizeof(sm
->pmk
));
1792 wpa_sm_deauthenticate(sm
, WLAN_REASON_UNSPECIFIED
);
1798 * wpa_sm_init - Initialize WPA state machine
1799 * @ctx: Context pointer for callbacks; this needs to be an allocated buffer
1800 * Returns: Pointer to the allocated WPA state machine data
1802 * This function is used to allocate a new WPA state machine and the returned
1803 * value is passed to all WPA state machine calls.
1805 struct wpa_sm
* wpa_sm_init(struct wpa_sm_ctx
*ctx
)
1809 sm
= os_zalloc(sizeof(*sm
));
1812 sm
->renew_snonce
= 1;
1815 sm
->dot11RSNAConfigPMKLifetime
= 43200;
1816 sm
->dot11RSNAConfigPMKReauthThreshold
= 70;
1817 sm
->dot11RSNAConfigSATimeout
= 60;
1819 sm
->pmksa
= pmksa_cache_init(wpa_sm_pmksa_free_cb
, sm
, sm
);
1820 if (sm
->pmksa
== NULL
) {
1821 wpa_printf(MSG_ERROR
, "RSN: PMKSA cache initialization "
1832 * wpa_sm_deinit - Deinitialize WPA state machine
1833 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1835 void wpa_sm_deinit(struct wpa_sm
*sm
)
1839 pmksa_cache_deinit(sm
->pmksa
);
1840 eloop_cancel_timeout(wpa_sm_start_preauth
, sm
, NULL
);
1841 eloop_cancel_timeout(wpa_sm_rekey_ptk
, sm
, NULL
);
1842 os_free(sm
->assoc_wpa_ie
);
1843 os_free(sm
->ap_wpa_ie
);
1844 os_free(sm
->ap_rsn_ie
);
1852 * wpa_sm_notify_assoc - Notify WPA state machine about association
1853 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1854 * @bssid: The BSSID of the new association
1856 * This function is called to let WPA state machine know that the connection
1859 void wpa_sm_notify_assoc(struct wpa_sm
*sm
, const u8
*bssid
)
1866 wpa_printf(MSG_DEBUG
, "WPA: Association event - clear replay counter");
1867 os_memcpy(sm
->bssid
, bssid
, ETH_ALEN
);
1868 os_memset(sm
->rx_replay_counter
, 0, WPA_REPLAY_COUNTER_LEN
);
1869 sm
->rx_replay_counter_set
= 0;
1870 sm
->renew_snonce
= 1;
1871 if (os_memcmp(sm
->preauth_bssid
, bssid
, ETH_ALEN
) == 0)
1872 rsn_preauth_deinit(sm
);
1874 #ifdef CONFIG_IEEE80211R
1875 if (wpa_ft_is_completed(sm
)) {
1876 wpa_supplicant_key_neg_complete(sm
, sm
->bssid
, 1);
1878 /* Prepare for the next transition */
1879 wpa_ft_prepare_auth_request(sm
);
1883 #endif /* CONFIG_IEEE80211R */
1887 * IEEE 802.11, 8.4.10: Delete PTK SA on (re)association if
1888 * this is not part of a Fast BSS Transition.
1890 wpa_printf(MSG_DEBUG
, "WPA: Clear old PTK");
1898 * wpa_sm_notify_disassoc - Notify WPA state machine about disassociation
1899 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1901 * This function is called to let WPA state machine know that the connection
1902 * was lost. This will abort any existing pre-authentication session.
1904 void wpa_sm_notify_disassoc(struct wpa_sm
*sm
)
1906 rsn_preauth_deinit(sm
);
1907 if (wpa_sm_get_state(sm
) == WPA_4WAY_HANDSHAKE
)
1908 sm
->dot11RSNA4WayHandshakeFailures
++;
1913 * wpa_sm_set_pmk - Set PMK
1914 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1916 * @pmk_len: The length of the new PMK in bytes
1918 * Configure the PMK for WPA state machine.
1920 void wpa_sm_set_pmk(struct wpa_sm
*sm
, const u8
*pmk
, size_t pmk_len
)
1925 sm
->pmk_len
= pmk_len
;
1926 os_memcpy(sm
->pmk
, pmk
, pmk_len
);
1928 #ifdef CONFIG_IEEE80211R
1929 /* Set XXKey to be PSK for FT key derivation */
1930 sm
->xxkey_len
= pmk_len
;
1931 os_memcpy(sm
->xxkey
, pmk
, pmk_len
);
1932 #endif /* CONFIG_IEEE80211R */
1937 * wpa_sm_set_pmk_from_pmksa - Set PMK based on the current PMKSA
1938 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1940 * Take the PMK from the current PMKSA into use. If no PMKSA is active, the PMK
1943 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm
*sm
)
1948 if (sm
->cur_pmksa
) {
1949 sm
->pmk_len
= sm
->cur_pmksa
->pmk_len
;
1950 os_memcpy(sm
->pmk
, sm
->cur_pmksa
->pmk
, sm
->pmk_len
);
1952 sm
->pmk_len
= PMK_LEN
;
1953 os_memset(sm
->pmk
, 0, PMK_LEN
);
1959 * wpa_sm_set_fast_reauth - Set fast reauthentication (EAP) enabled/disabled
1960 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1961 * @fast_reauth: Whether fast reauthentication (EAP) is allowed
1963 void wpa_sm_set_fast_reauth(struct wpa_sm
*sm
, int fast_reauth
)
1966 sm
->fast_reauth
= fast_reauth
;
1971 * wpa_sm_set_scard_ctx - Set context pointer for smartcard callbacks
1972 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1973 * @scard_ctx: Context pointer for smartcard related callback functions
1975 void wpa_sm_set_scard_ctx(struct wpa_sm
*sm
, void *scard_ctx
)
1979 sm
->scard_ctx
= scard_ctx
;
1980 if (sm
->preauth_eapol
)
1981 eapol_sm_register_scard_ctx(sm
->preauth_eapol
, scard_ctx
);
1986 * wpa_sm_set_config - Notification of current configration change
1987 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1988 * @config: Pointer to current network configuration
1990 * Notify WPA state machine that configuration has changed. config will be
1991 * stored as a backpointer to network configuration. This can be %NULL to clear
1992 * the stored pointed.
1994 void wpa_sm_set_config(struct wpa_sm
*sm
, struct rsn_supp_config
*config
)
2000 sm
->network_ctx
= config
->network_ctx
;
2001 sm
->peerkey_enabled
= config
->peerkey_enabled
;
2002 sm
->allowed_pairwise_cipher
= config
->allowed_pairwise_cipher
;
2003 sm
->proactive_key_caching
= config
->proactive_key_caching
;
2004 sm
->eap_workaround
= config
->eap_workaround
;
2005 sm
->eap_conf_ctx
= config
->eap_conf_ctx
;
2007 os_memcpy(sm
->ssid
, config
->ssid
, config
->ssid_len
);
2008 sm
->ssid_len
= config
->ssid_len
;
2011 sm
->wpa_ptk_rekey
= config
->wpa_ptk_rekey
;
2013 sm
->network_ctx
= NULL
;
2014 sm
->peerkey_enabled
= 0;
2015 sm
->allowed_pairwise_cipher
= 0;
2016 sm
->proactive_key_caching
= 0;
2017 sm
->eap_workaround
= 0;
2018 sm
->eap_conf_ctx
= NULL
;
2020 sm
->wpa_ptk_rekey
= 0;
2022 if (config
== NULL
|| config
->network_ctx
!= sm
->network_ctx
)
2023 pmksa_cache_notify_reconfig(sm
->pmksa
);
2028 * wpa_sm_set_own_addr - Set own MAC address
2029 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2030 * @addr: Own MAC address
2032 void wpa_sm_set_own_addr(struct wpa_sm
*sm
, const u8
*addr
)
2035 os_memcpy(sm
->own_addr
, addr
, ETH_ALEN
);
2040 * wpa_sm_set_ifname - Set network interface name
2041 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2042 * @ifname: Interface name
2043 * @bridge_ifname: Optional bridge interface name (for pre-auth)
2045 void wpa_sm_set_ifname(struct wpa_sm
*sm
, const char *ifname
,
2046 const char *bridge_ifname
)
2049 sm
->ifname
= ifname
;
2050 sm
->bridge_ifname
= bridge_ifname
;
2056 * wpa_sm_set_eapol - Set EAPOL state machine pointer
2057 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2058 * @eapol: Pointer to EAPOL state machine allocated with eapol_sm_init()
2060 void wpa_sm_set_eapol(struct wpa_sm
*sm
, struct eapol_sm
*eapol
)
2068 * wpa_sm_set_param - Set WPA state machine parameters
2069 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2070 * @param: Parameter field
2071 * @value: Parameter value
2072 * Returns: 0 on success, -1 on failure
2074 int wpa_sm_set_param(struct wpa_sm
*sm
, enum wpa_sm_conf_params param
,
2083 case RSNA_PMK_LIFETIME
:
2085 sm
->dot11RSNAConfigPMKLifetime
= value
;
2089 case RSNA_PMK_REAUTH_THRESHOLD
:
2090 if (value
> 0 && value
<= 100)
2091 sm
->dot11RSNAConfigPMKReauthThreshold
= value
;
2095 case RSNA_SA_TIMEOUT
:
2097 sm
->dot11RSNAConfigSATimeout
= value
;
2101 case WPA_PARAM_PROTO
:
2104 case WPA_PARAM_PAIRWISE
:
2105 sm
->pairwise_cipher
= value
;
2107 case WPA_PARAM_GROUP
:
2108 sm
->group_cipher
= value
;
2110 case WPA_PARAM_KEY_MGMT
:
2111 sm
->key_mgmt
= value
;
2113 #ifdef CONFIG_IEEE80211W
2114 case WPA_PARAM_MGMT_GROUP
:
2115 sm
->mgmt_group_cipher
= value
;
2117 #endif /* CONFIG_IEEE80211W */
2118 case WPA_PARAM_RSN_ENABLED
:
2119 sm
->rsn_enabled
= value
;
2130 * wpa_sm_get_param - Get WPA state machine parameters
2131 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2132 * @param: Parameter field
2133 * Returns: Parameter value
2135 unsigned int wpa_sm_get_param(struct wpa_sm
*sm
, enum wpa_sm_conf_params param
)
2141 case RSNA_PMK_LIFETIME
:
2142 return sm
->dot11RSNAConfigPMKLifetime
;
2143 case RSNA_PMK_REAUTH_THRESHOLD
:
2144 return sm
->dot11RSNAConfigPMKReauthThreshold
;
2145 case RSNA_SA_TIMEOUT
:
2146 return sm
->dot11RSNAConfigSATimeout
;
2147 case WPA_PARAM_PROTO
:
2149 case WPA_PARAM_PAIRWISE
:
2150 return sm
->pairwise_cipher
;
2151 case WPA_PARAM_GROUP
:
2152 return sm
->group_cipher
;
2153 case WPA_PARAM_KEY_MGMT
:
2154 return sm
->key_mgmt
;
2155 #ifdef CONFIG_IEEE80211W
2156 case WPA_PARAM_MGMT_GROUP
:
2157 return sm
->mgmt_group_cipher
;
2158 #endif /* CONFIG_IEEE80211W */
2159 case WPA_PARAM_RSN_ENABLED
:
2160 return sm
->rsn_enabled
;
2168 * wpa_sm_get_status - Get WPA state machine
2169 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2170 * @buf: Buffer for status information
2171 * @buflen: Maximum buffer length
2172 * @verbose: Whether to include verbose status information
2173 * Returns: Number of bytes written to buf.
2175 * Query WPA state machine for status information. This function fills in
2176 * a text area with current status information. If the buffer (buf) is not
2177 * large enough, status information will be truncated to fit the buffer.
2179 int wpa_sm_get_status(struct wpa_sm
*sm
, char *buf
, size_t buflen
,
2182 char *pos
= buf
, *end
= buf
+ buflen
;
2185 ret
= os_snprintf(pos
, end
- pos
,
2186 "pairwise_cipher=%s\n"
2189 wpa_cipher_txt(sm
->pairwise_cipher
),
2190 wpa_cipher_txt(sm
->group_cipher
),
2191 wpa_key_mgmt_txt(sm
->key_mgmt
, sm
->proto
));
2192 if (ret
< 0 || ret
>= end
- pos
)
2200 * wpa_sm_set_assoc_wpa_ie_default - Generate own WPA/RSN IE from configuration
2201 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2202 * @wpa_ie: Pointer to buffer for WPA/RSN IE
2203 * @wpa_ie_len: Pointer to the length of the wpa_ie buffer
2204 * Returns: 0 on success, -1 on failure
2206 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm
*sm
, u8
*wpa_ie
,
2214 res
= wpa_gen_wpa_ie(sm
, wpa_ie
, *wpa_ie_len
);
2219 wpa_hexdump(MSG_DEBUG
, "WPA: Set own WPA IE default",
2220 wpa_ie
, *wpa_ie_len
);
2222 if (sm
->assoc_wpa_ie
== NULL
) {
2224 * Make a copy of the WPA/RSN IE so that 4-Way Handshake gets
2225 * the correct version of the IE even if PMKSA caching is
2226 * aborted (which would remove PMKID from IE generation).
2228 sm
->assoc_wpa_ie
= os_malloc(*wpa_ie_len
);
2229 if (sm
->assoc_wpa_ie
== NULL
)
2232 os_memcpy(sm
->assoc_wpa_ie
, wpa_ie
, *wpa_ie_len
);
2233 sm
->assoc_wpa_ie_len
= *wpa_ie_len
;
2241 * wpa_sm_set_assoc_wpa_ie - Set own WPA/RSN IE from (Re)AssocReq
2242 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2243 * @ie: Pointer to IE data (starting from id)
2245 * Returns: 0 on success, -1 on failure
2247 * Inform WPA state machine about the WPA/RSN IE used in (Re)Association
2248 * Request frame. The IE will be used to override the default value generated
2249 * with wpa_sm_set_assoc_wpa_ie_default().
2251 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm
*sm
, const u8
*ie
, size_t len
)
2256 os_free(sm
->assoc_wpa_ie
);
2257 if (ie
== NULL
|| len
== 0) {
2258 wpa_printf(MSG_DEBUG
, "WPA: clearing own WPA/RSN IE");
2259 sm
->assoc_wpa_ie
= NULL
;
2260 sm
->assoc_wpa_ie_len
= 0;
2262 wpa_hexdump(MSG_DEBUG
, "WPA: set own WPA/RSN IE", ie
, len
);
2263 sm
->assoc_wpa_ie
= os_malloc(len
);
2264 if (sm
->assoc_wpa_ie
== NULL
)
2267 os_memcpy(sm
->assoc_wpa_ie
, ie
, len
);
2268 sm
->assoc_wpa_ie_len
= len
;
2276 * wpa_sm_set_ap_wpa_ie - Set AP WPA IE from Beacon/ProbeResp
2277 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2278 * @ie: Pointer to IE data (starting from id)
2280 * Returns: 0 on success, -1 on failure
2282 * Inform WPA state machine about the WPA IE used in Beacon / Probe Response
2285 int wpa_sm_set_ap_wpa_ie(struct wpa_sm
*sm
, const u8
*ie
, size_t len
)
2290 os_free(sm
->ap_wpa_ie
);
2291 if (ie
== NULL
|| len
== 0) {
2292 wpa_printf(MSG_DEBUG
, "WPA: clearing AP WPA IE");
2293 sm
->ap_wpa_ie
= NULL
;
2294 sm
->ap_wpa_ie_len
= 0;
2296 wpa_hexdump(MSG_DEBUG
, "WPA: set AP WPA IE", ie
, len
);
2297 sm
->ap_wpa_ie
= os_malloc(len
);
2298 if (sm
->ap_wpa_ie
== NULL
)
2301 os_memcpy(sm
->ap_wpa_ie
, ie
, len
);
2302 sm
->ap_wpa_ie_len
= len
;
2310 * wpa_sm_set_ap_rsn_ie - Set AP RSN IE from Beacon/ProbeResp
2311 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2312 * @ie: Pointer to IE data (starting from id)
2314 * Returns: 0 on success, -1 on failure
2316 * Inform WPA state machine about the RSN IE used in Beacon / Probe Response
2319 int wpa_sm_set_ap_rsn_ie(struct wpa_sm
*sm
, const u8
*ie
, size_t len
)
2324 os_free(sm
->ap_rsn_ie
);
2325 if (ie
== NULL
|| len
== 0) {
2326 wpa_printf(MSG_DEBUG
, "WPA: clearing AP RSN IE");
2327 sm
->ap_rsn_ie
= NULL
;
2328 sm
->ap_rsn_ie_len
= 0;
2330 wpa_hexdump(MSG_DEBUG
, "WPA: set AP RSN IE", ie
, len
);
2331 sm
->ap_rsn_ie
= os_malloc(len
);
2332 if (sm
->ap_rsn_ie
== NULL
)
2335 os_memcpy(sm
->ap_rsn_ie
, ie
, len
);
2336 sm
->ap_rsn_ie_len
= len
;
2344 * wpa_sm_parse_own_wpa_ie - Parse own WPA/RSN IE
2345 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2346 * @data: Pointer to data area for parsing results
2347 * Returns: 0 on success, -1 if IE is not known, or -2 on parsing failure
2349 * Parse the contents of the own WPA or RSN IE from (Re)AssocReq and write the
2350 * parsed data into data.
2352 int wpa_sm_parse_own_wpa_ie(struct wpa_sm
*sm
, struct wpa_ie_data
*data
)
2354 if (sm
== NULL
|| sm
->assoc_wpa_ie
== NULL
) {
2355 wpa_printf(MSG_DEBUG
, "WPA: No WPA/RSN IE available from "
2356 "association info");
2359 if (wpa_parse_wpa_ie(sm
->assoc_wpa_ie
, sm
->assoc_wpa_ie_len
, data
))
2365 int wpa_sm_pmksa_cache_list(struct wpa_sm
*sm
, char *buf
, size_t len
)
2367 #ifndef CONFIG_NO_WPA2
2368 return pmksa_cache_list(sm
->pmksa
, buf
, len
);
2369 #else /* CONFIG_NO_WPA2 */
2371 #endif /* CONFIG_NO_WPA2 */