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.
22 #include "eapol_supp/eapol_supp_sm.h"
24 #include "pmksa_cache.h"
28 #include "ieee802_11_defs.h"
32 * wpa_cipher_txt - Convert cipher suite to a text string
33 * @cipher: Cipher suite (WPA_CIPHER_* enum)
34 * Returns: Pointer to a text string of the cipher suite name
36 static const char * wpa_cipher_txt(int cipher)
41 case WPA_CIPHER_WEP40:
43 case WPA_CIPHER_WEP104:
56 * wpa_key_mgmt_txt - Convert key management suite to a text string
57 * @key_mgmt: Key management suite (WPA_KEY_MGMT_* enum)
58 * @proto: WPA/WPA2 version (WPA_PROTO_*)
59 * Returns: Pointer to a text string of the key management suite name
61 static const char * wpa_key_mgmt_txt(int key_mgmt, int proto)
64 case WPA_KEY_MGMT_IEEE8021X:
65 return proto == WPA_PROTO_RSN ?
66 "WPA2/IEEE 802.1X/EAP" : "WPA/IEEE 802.1X/EAP";
67 case WPA_KEY_MGMT_PSK:
68 return proto == WPA_PROTO_RSN ?
69 "WPA2-PSK" : "WPA-PSK";
70 case WPA_KEY_MGMT_NONE:
72 case WPA_KEY_MGMT_IEEE8021X_NO_WPA:
73 return "IEEE 802.1X (no WPA)";
74 #ifdef CONFIG_IEEE80211R
75 case WPA_KEY_MGMT_FT_IEEE8021X:
77 case WPA_KEY_MGMT_FT_PSK:
79 #endif /* CONFIG_IEEE80211R */
80 #ifdef CONFIG_IEEE80211W
81 case WPA_KEY_MGMT_IEEE8021X_SHA256:
82 return "WPA2-EAP-SHA256";
83 case WPA_KEY_MGMT_PSK_SHA256:
84 return "WPA2-PSK-SHA256";
85 #endif /* CONFIG_IEEE80211W */
93 * wpa_eapol_key_send - Send WPA/RSN EAPOL-Key message
94 * @sm: Pointer to WPA state machine data from wpa_sm_init()
95 * @kck: Key Confirmation Key (KCK, part of PTK)
96 * @ver: Version field from Key Info
97 * @dest: Destination address for the frame
98 * @proto: Ethertype (usually ETH_P_EAPOL)
99 * @msg: EAPOL-Key message
100 * @msg_len: Length of message
101 * @key_mic: Pointer to the buffer to which the EAPOL-Key MIC is written
103 void wpa_eapol_key_send(struct wpa_sm *sm, const u8 *kck,
104 int ver, const u8 *dest, u16 proto,
105 u8 *msg, size_t msg_len, u8 *key_mic)
107 if (is_zero_ether_addr(dest) && is_zero_ether_addr(sm->bssid)) {
109 * Association event was not yet received; try to fetch
110 * BSSID from the driver.
112 if (wpa_sm_get_bssid(sm, sm->bssid) < 0) {
113 wpa_printf(MSG_DEBUG, "WPA: Failed to read BSSID for "
114 "EAPOL-Key destination address");
117 wpa_printf(MSG_DEBUG, "WPA: Use BSSID (" MACSTR
118 ") as the destination for EAPOL-Key",
123 wpa_eapol_key_mic(kck, ver, msg, msg_len, key_mic);
124 wpa_hexdump(MSG_MSGDUMP, "WPA: TX EAPOL-Key", msg, msg_len);
125 wpa_sm_ether_send(sm, dest, proto, msg, msg_len);
126 eapol_sm_notify_tx_eapol_key(sm->eapol);
132 * wpa_sm_key_request - Send EAPOL-Key Request
133 * @sm: Pointer to WPA state machine data from wpa_sm_init()
134 * @error: Indicate whether this is an Michael MIC error report
135 * @pairwise: 1 = error report for pairwise packet, 0 = for group packet
137 * Send an EAPOL-Key Request to the current authenticator. This function is
138 * used to request rekeying and it is usually called when a local Michael MIC
139 * failure is detected.
141 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise)
144 struct wpa_eapol_key *reply;
146 u8 bssid[ETH_ALEN], *rbuf;
148 if (wpa_key_mgmt_ft(sm->key_mgmt) || wpa_key_mgmt_sha256(sm->key_mgmt))
149 ver = WPA_KEY_INFO_TYPE_AES_128_CMAC;
150 else if (sm->pairwise_cipher == WPA_CIPHER_CCMP)
151 ver = WPA_KEY_INFO_TYPE_HMAC_SHA1_AES;
153 ver = WPA_KEY_INFO_TYPE_HMAC_MD5_RC4;
155 if (wpa_sm_get_bssid(sm, bssid) < 0) {
156 wpa_printf(MSG_WARNING, "Failed to read BSSID for EAPOL-Key "
161 rbuf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_KEY, NULL,
162 sizeof(*reply), &rlen, (void *) &reply);
166 reply->type = sm->proto == WPA_PROTO_RSN ?
167 EAPOL_KEY_TYPE_RSN : EAPOL_KEY_TYPE_WPA;
168 key_info = WPA_KEY_INFO_REQUEST | ver;
170 key_info |= WPA_KEY_INFO_MIC;
172 key_info |= WPA_KEY_INFO_ERROR;
174 key_info |= WPA_KEY_INFO_KEY_TYPE;
175 WPA_PUT_BE16(reply->key_info, key_info);
176 WPA_PUT_BE16(reply->key_length, 0);
177 os_memcpy(reply->replay_counter, sm->request_counter,
178 WPA_REPLAY_COUNTER_LEN);
179 inc_byte_array(sm->request_counter, WPA_REPLAY_COUNTER_LEN);
181 WPA_PUT_BE16(reply->key_data_length, 0);
183 wpa_printf(MSG_INFO, "WPA: Sending EAPOL-Key Request (error=%d "
184 "pairwise=%d ptk_set=%d len=%lu)",
185 error, pairwise, sm->ptk_set, (unsigned long) rlen);
186 wpa_eapol_key_send(sm, sm->ptk.kck, ver, bssid, ETH_P_EAPOL,
187 rbuf, rlen, key_info & WPA_KEY_INFO_MIC ?
188 reply->key_mic : NULL);
192 static int wpa_supplicant_get_pmk(struct wpa_sm *sm,
193 const unsigned char *src_addr,
196 int abort_cached = 0;
198 if (pmkid && !sm->cur_pmksa) {
199 /* When using drivers that generate RSN IE, wpa_supplicant may
200 * not have enough time to get the association information
201 * event before receiving this 1/4 message, so try to find a
202 * matching PMKSA cache entry here. */
203 sm->cur_pmksa = pmksa_cache_get(sm->pmksa, src_addr, pmkid);
205 wpa_printf(MSG_DEBUG, "RSN: found matching PMKID from "
208 wpa_printf(MSG_DEBUG, "RSN: no matching PMKID found");
213 if (pmkid && sm->cur_pmksa &&
214 os_memcmp(pmkid, sm->cur_pmksa->pmkid, PMKID_LEN) == 0) {
215 wpa_hexdump(MSG_DEBUG, "RSN: matched PMKID", pmkid, PMKID_LEN);
216 wpa_sm_set_pmk_from_pmksa(sm);
217 wpa_hexdump_key(MSG_DEBUG, "RSN: PMK from PMKSA cache",
218 sm->pmk, sm->pmk_len);
219 eapol_sm_notify_cached(sm->eapol);
220 #ifdef CONFIG_IEEE80211R
222 #endif /* CONFIG_IEEE80211R */
223 } else if (wpa_key_mgmt_wpa_ieee8021x(sm->key_mgmt) && sm->eapol) {
226 res = eapol_sm_get_key(sm->eapol, sm->pmk, PMK_LEN);
229 * EAP-LEAP is an exception from other EAP methods: it
230 * uses only 16-byte PMK.
232 res = eapol_sm_get_key(sm->eapol, sm->pmk, 16);
235 #ifdef CONFIG_IEEE80211R
237 if (eapol_sm_get_key(sm->eapol, buf, 2 * PMK_LEN) == 0)
239 os_memcpy(sm->xxkey, buf + PMK_LEN, PMK_LEN);
240 sm->xxkey_len = PMK_LEN;
241 os_memset(buf, 0, sizeof(buf));
243 #endif /* CONFIG_IEEE80211R */
246 wpa_hexdump_key(MSG_DEBUG, "WPA: PMK from EAPOL state "
247 "machines", sm->pmk, pmk_len);
248 sm->pmk_len = pmk_len;
249 if (sm->proto == WPA_PROTO_RSN) {
250 pmksa_cache_add(sm->pmksa, sm->pmk, pmk_len,
251 src_addr, sm->own_addr,
252 sm->network_ctx, sm->key_mgmt);
254 if (!sm->cur_pmksa && pmkid &&
255 pmksa_cache_get(sm->pmksa, src_addr, pmkid)) {
256 wpa_printf(MSG_DEBUG, "RSN: the new PMK "
257 "matches with the PMKID");
261 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
262 "WPA: Failed to get master session key from "
263 "EAPOL state machines");
264 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
265 "WPA: Key handshake aborted");
267 wpa_printf(MSG_DEBUG, "RSN: Cancelled PMKSA "
269 sm->cur_pmksa = NULL;
271 } else if (!abort_cached) {
277 if (abort_cached && wpa_key_mgmt_wpa_ieee8021x(sm->key_mgmt)) {
278 /* Send EAPOL-Start to trigger full EAP authentication. */
282 wpa_printf(MSG_DEBUG, "RSN: no PMKSA entry found - trigger "
283 "full EAP authentication");
284 buf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_START,
285 NULL, 0, &buflen, NULL);
287 wpa_sm_ether_send(sm, sm->bssid, ETH_P_EAPOL,
300 * wpa_supplicant_send_2_of_4 - Send message 2 of WPA/RSN 4-Way Handshake
301 * @sm: Pointer to WPA state machine data from wpa_sm_init()
302 * @dst: Destination address for the frame
303 * @key: Pointer to the EAPOL-Key frame header
304 * @ver: Version bits from EAPOL-Key Key Info
305 * @nonce: Nonce value for the EAPOL-Key frame
306 * @wpa_ie: WPA/RSN IE
307 * @wpa_ie_len: Length of the WPA/RSN IE
308 * @ptk: PTK to use for keyed hash and encryption
309 * Returns: 0 on success, -1 on failure
311 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
312 const struct wpa_eapol_key *key,
313 int ver, const u8 *nonce,
314 const u8 *wpa_ie, size_t wpa_ie_len,
318 struct wpa_eapol_key *reply;
321 if (wpa_ie == NULL) {
322 wpa_printf(MSG_WARNING, "WPA: No wpa_ie set - cannot "
327 wpa_hexdump(MSG_DEBUG, "WPA: WPA IE for msg 2/4", wpa_ie, wpa_ie_len);
329 rbuf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_KEY,
330 NULL, sizeof(*reply) + wpa_ie_len,
331 &rlen, (void *) &reply);
335 reply->type = sm->proto == WPA_PROTO_RSN ?
336 EAPOL_KEY_TYPE_RSN : EAPOL_KEY_TYPE_WPA;
337 WPA_PUT_BE16(reply->key_info,
338 ver | WPA_KEY_INFO_KEY_TYPE | WPA_KEY_INFO_MIC);
339 if (sm->proto == WPA_PROTO_RSN)
340 WPA_PUT_BE16(reply->key_length, 0);
342 os_memcpy(reply->key_length, key->key_length, 2);
343 os_memcpy(reply->replay_counter, key->replay_counter,
344 WPA_REPLAY_COUNTER_LEN);
346 WPA_PUT_BE16(reply->key_data_length, wpa_ie_len);
347 os_memcpy(reply + 1, wpa_ie, wpa_ie_len);
349 os_memcpy(reply->key_nonce, nonce, WPA_NONCE_LEN);
351 wpa_printf(MSG_DEBUG, "WPA: Sending EAPOL-Key 2/4");
352 wpa_eapol_key_send(sm, ptk->kck, ver, dst, ETH_P_EAPOL,
353 rbuf, rlen, reply->key_mic);
359 static int wpa_derive_ptk(struct wpa_sm *sm, const unsigned char *src_addr,
360 const struct wpa_eapol_key *key,
363 size_t ptk_len = sm->pairwise_cipher == WPA_CIPHER_CCMP ? 48 : 64;
364 #ifdef CONFIG_IEEE80211R
365 if (wpa_key_mgmt_ft(sm->key_mgmt))
366 return wpa_derive_ptk_ft(sm, src_addr, key, ptk, ptk_len);
367 #endif /* CONFIG_IEEE80211R */
369 wpa_pmk_to_ptk(sm->pmk, sm->pmk_len, "Pairwise key expansion",
370 sm->own_addr, sm->bssid, sm->snonce, key->key_nonce,
372 wpa_key_mgmt_sha256(sm->key_mgmt));
377 static void wpa_supplicant_process_1_of_4(struct wpa_sm *sm,
378 const unsigned char *src_addr,
379 const struct wpa_eapol_key *key,
382 struct wpa_eapol_ie_parse ie;
386 if (wpa_sm_get_network_ctx(sm) == NULL) {
387 wpa_printf(MSG_WARNING, "WPA: No SSID info found (msg 1 of "
392 wpa_sm_set_state(sm, WPA_4WAY_HANDSHAKE);
393 wpa_printf(MSG_DEBUG, "WPA: RX message 1 of 4-Way Handshake from "
394 MACSTR " (ver=%d)", MAC2STR(src_addr), ver);
396 os_memset(&ie, 0, sizeof(ie));
398 #ifndef CONFIG_NO_WPA2
399 if (sm->proto == WPA_PROTO_RSN) {
400 /* RSN: msg 1/4 should contain PMKID for the selected PMK */
401 const u8 *_buf = (const u8 *) (key + 1);
402 size_t len = WPA_GET_BE16(key->key_data_length);
403 wpa_hexdump(MSG_DEBUG, "RSN: msg 1/4 key data", _buf, len);
404 wpa_supplicant_parse_ies(_buf, len, &ie);
406 wpa_hexdump(MSG_DEBUG, "RSN: PMKID from "
407 "Authenticator", ie.pmkid, PMKID_LEN);
410 #endif /* CONFIG_NO_WPA2 */
412 if (wpa_supplicant_get_pmk(sm, src_addr, ie.pmkid))
415 if (sm->renew_snonce) {
416 if (os_get_random(sm->snonce, WPA_NONCE_LEN)) {
417 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
418 "WPA: Failed to get random data for SNonce");
421 sm->renew_snonce = 0;
422 wpa_hexdump(MSG_DEBUG, "WPA: Renewed SNonce",
423 sm->snonce, WPA_NONCE_LEN);
426 /* Calculate PTK which will be stored as a temporary PTK until it has
427 * been verified when processing message 3/4. */
429 wpa_derive_ptk(sm, src_addr, key, ptk);
430 /* Supplicant: swap tx/rx Mic keys */
431 os_memcpy(buf, ptk->u.auth.tx_mic_key, 8);
432 os_memcpy(ptk->u.auth.tx_mic_key, ptk->u.auth.rx_mic_key, 8);
433 os_memcpy(ptk->u.auth.rx_mic_key, buf, 8);
436 if (wpa_supplicant_send_2_of_4(sm, sm->bssid, key, ver, sm->snonce,
437 sm->assoc_wpa_ie, sm->assoc_wpa_ie_len,
441 os_memcpy(sm->anonce, key->key_nonce, WPA_NONCE_LEN);
445 static void wpa_sm_start_preauth(void *eloop_ctx, void *timeout_ctx)
447 struct wpa_sm *sm = eloop_ctx;
448 rsn_preauth_candidate_process(sm);
452 static void wpa_supplicant_key_neg_complete(struct wpa_sm *sm,
453 const u8 *addr, int secure)
455 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
456 "WPA: Key negotiation completed with "
457 MACSTR " [PTK=%s GTK=%s]", MAC2STR(addr),
458 wpa_cipher_txt(sm->pairwise_cipher),
459 wpa_cipher_txt(sm->group_cipher));
460 wpa_sm_cancel_auth_timeout(sm);
461 wpa_sm_set_state(sm, WPA_COMPLETED);
464 wpa_sm_mlme_setprotection(
465 sm, addr, MLME_SETPROTECTION_PROTECT_TYPE_RX_TX,
466 MLME_SETPROTECTION_KEY_TYPE_PAIRWISE);
467 eapol_sm_notify_portValid(sm->eapol, TRUE);
468 if (wpa_key_mgmt_wpa_psk(sm->key_mgmt))
469 eapol_sm_notify_eap_success(sm->eapol, TRUE);
471 * Start preauthentication after a short wait to avoid a
472 * possible race condition between the data receive and key
473 * configuration after the 4-Way Handshake. This increases the
474 * likelyhood of the first preauth EAPOL-Start frame getting to
477 eloop_register_timeout(1, 0, wpa_sm_start_preauth, sm, NULL);
480 if (sm->cur_pmksa && sm->cur_pmksa->opportunistic) {
481 wpa_printf(MSG_DEBUG, "RSN: Authenticator accepted "
482 "opportunistic PMKSA entry - marking it valid");
483 sm->cur_pmksa->opportunistic = 0;
486 #ifdef CONFIG_IEEE80211R
487 if (wpa_key_mgmt_ft(sm->key_mgmt)) {
488 /* Prepare for the next transition */
489 wpa_ft_prepare_auth_request(sm);
491 #endif /* CONFIG_IEEE80211R */
495 static void wpa_sm_rekey_ptk(void *eloop_ctx, void *timeout_ctx)
497 struct wpa_sm *sm = eloop_ctx;
498 wpa_printf(MSG_DEBUG, "WPA: Request PTK rekeying");
499 wpa_sm_key_request(sm, 0, 1);
503 static int wpa_supplicant_install_ptk(struct wpa_sm *sm,
504 const struct wpa_eapol_key *key)
509 u8 null_rsc[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
511 wpa_printf(MSG_DEBUG, "WPA: Installing PTK to the driver.");
513 switch (sm->pairwise_cipher) {
514 case WPA_CIPHER_CCMP:
519 case WPA_CIPHER_TKIP:
524 case WPA_CIPHER_NONE:
525 wpa_printf(MSG_DEBUG, "WPA: Pairwise Cipher Suite: "
526 "NONE - do not use pairwise keys");
529 wpa_printf(MSG_WARNING, "WPA: Unsupported pairwise cipher %d",
530 sm->pairwise_cipher);
534 if (sm->proto == WPA_PROTO_RSN) {
537 key_rsc = key->key_rsc;
538 wpa_hexdump(MSG_DEBUG, "WPA: RSC", key_rsc, rsclen);
541 if (wpa_sm_set_key(sm, alg, sm->bssid, 0, 1, key_rsc, rsclen,
542 (u8 *) sm->ptk.tk1, keylen) < 0) {
543 wpa_printf(MSG_WARNING, "WPA: Failed to set PTK to the "
548 if (sm->wpa_ptk_rekey) {
549 eloop_cancel_timeout(wpa_sm_rekey_ptk, sm, NULL);
550 eloop_register_timeout(sm->wpa_ptk_rekey, 0, wpa_sm_rekey_ptk,
558 static int wpa_supplicant_check_group_cipher(int group_cipher,
559 int keylen, int maxkeylen,
560 int *key_rsc_len, wpa_alg *alg)
564 switch (group_cipher) {
565 case WPA_CIPHER_CCMP:
566 if (keylen != 16 || maxkeylen < 16) {
573 case WPA_CIPHER_TKIP:
574 if (keylen != 32 || maxkeylen < 32) {
581 case WPA_CIPHER_WEP104:
582 if (keylen != 13 || maxkeylen < 13) {
589 case WPA_CIPHER_WEP40:
590 if (keylen != 5 || maxkeylen < 5) {
598 wpa_printf(MSG_WARNING, "WPA: Unsupported Group Cipher %d",
604 wpa_printf(MSG_WARNING, "WPA: Unsupported %s Group Cipher key "
606 wpa_cipher_txt(group_cipher), keylen, maxkeylen);
613 struct wpa_gtk_data {
615 int tx, key_rsc_len, keyidx;
621 static int wpa_supplicant_install_gtk(struct wpa_sm *sm,
622 const struct wpa_gtk_data *gd,
625 const u8 *_gtk = gd->gtk;
628 wpa_hexdump_key(MSG_DEBUG, "WPA: Group Key", gd->gtk, gd->gtk_len);
629 wpa_printf(MSG_DEBUG, "WPA: Installing GTK to the driver "
630 "(keyidx=%d tx=%d len=%d).", gd->keyidx, gd->tx,
632 wpa_hexdump(MSG_DEBUG, "WPA: RSC", key_rsc, gd->key_rsc_len);
633 if (sm->group_cipher == WPA_CIPHER_TKIP) {
634 /* Swap Tx/Rx keys for Michael MIC */
635 os_memcpy(gtk_buf, gd->gtk, 16);
636 os_memcpy(gtk_buf + 16, gd->gtk + 24, 8);
637 os_memcpy(gtk_buf + 24, gd->gtk + 16, 8);
640 if (sm->pairwise_cipher == WPA_CIPHER_NONE) {
641 if (wpa_sm_set_key(sm, gd->alg,
642 (u8 *) "\xff\xff\xff\xff\xff\xff",
643 gd->keyidx, 1, key_rsc, gd->key_rsc_len,
644 _gtk, gd->gtk_len) < 0) {
645 wpa_printf(MSG_WARNING, "WPA: Failed to set "
646 "GTK to the driver (Group only).");
649 } else if (wpa_sm_set_key(sm, gd->alg,
650 (u8 *) "\xff\xff\xff\xff\xff\xff",
651 gd->keyidx, gd->tx, key_rsc, gd->key_rsc_len,
652 _gtk, gd->gtk_len) < 0) {
653 wpa_printf(MSG_WARNING, "WPA: Failed to set GTK to "
662 static int wpa_supplicant_gtk_tx_bit_workaround(const struct wpa_sm *sm,
665 if (tx && sm->pairwise_cipher != WPA_CIPHER_NONE) {
666 /* Ignore Tx bit for GTK if a pairwise key is used. One AP
667 * seemed to set this bit (incorrectly, since Tx is only when
668 * doing Group Key only APs) and without this workaround, the
669 * data connection does not work because wpa_supplicant
670 * configured non-zero keyidx to be used for unicast. */
671 wpa_printf(MSG_INFO, "WPA: Tx bit set for GTK, but pairwise "
672 "keys are used - ignore Tx bit");
679 static int wpa_supplicant_pairwise_gtk(struct wpa_sm *sm,
680 const struct wpa_eapol_key *key,
681 const u8 *gtk, size_t gtk_len,
684 #ifndef CONFIG_NO_WPA2
685 struct wpa_gtk_data gd;
688 * IEEE Std 802.11i-2004 - 8.5.2 EAPOL-Key frames - Figure 43x
690 * KeyID[bits 0-1], Tx [bit 2], Reserved [bits 3-7]
691 * Reserved [bits 0-7]
695 os_memset(&gd, 0, sizeof(gd));
696 wpa_hexdump_key(MSG_DEBUG, "RSN: received GTK in pairwise handshake",
699 if (gtk_len < 2 || gtk_len - 2 > sizeof(gd.gtk))
702 gd.keyidx = gtk[0] & 0x3;
703 gd.tx = wpa_supplicant_gtk_tx_bit_workaround(sm,
704 !!(gtk[0] & BIT(2)));
708 os_memcpy(gd.gtk, gtk, gtk_len);
709 gd.gtk_len = gtk_len;
711 if (wpa_supplicant_check_group_cipher(sm->group_cipher,
713 &gd.key_rsc_len, &gd.alg) ||
714 wpa_supplicant_install_gtk(sm, &gd, key->key_rsc)) {
715 wpa_printf(MSG_DEBUG, "RSN: Failed to install GTK");
719 wpa_supplicant_key_neg_complete(sm, sm->bssid,
720 key_info & WPA_KEY_INFO_SECURE);
722 #else /* CONFIG_NO_WPA2 */
724 #endif /* CONFIG_NO_WPA2 */
728 static int ieee80211w_set_keys(struct wpa_sm *sm,
729 struct wpa_eapol_ie_parse *ie)
731 #ifdef CONFIG_IEEE80211W
732 if (sm->mgmt_group_cipher != WPA_CIPHER_AES_128_CMAC)
736 const struct wpa_igtk_kde *igtk;
738 if (ie->igtk_len != sizeof(*igtk))
740 igtk = (const struct wpa_igtk_kde *) ie->igtk;
741 keyidx = WPA_GET_LE16(igtk->keyid);
742 wpa_printf(MSG_DEBUG, "WPA: IGTK keyid %d "
743 "pn %02x%02x%02x%02x%02x%02x",
744 keyidx, MAC2STR(igtk->pn));
745 wpa_hexdump_key(MSG_DEBUG, "WPA: IGTK",
746 igtk->igtk, WPA_IGTK_LEN);
748 wpa_printf(MSG_WARNING, "WPA: Invalid IGTK KeyID %d",
752 if (wpa_sm_set_key(sm, WPA_ALG_IGTK,
753 (u8 *) "\xff\xff\xff\xff\xff\xff",
754 keyidx, 0, igtk->pn, sizeof(igtk->pn),
755 igtk->igtk, WPA_IGTK_LEN) < 0) {
756 wpa_printf(MSG_WARNING, "WPA: Failed to configure IGTK"
763 #else /* CONFIG_IEEE80211W */
765 #endif /* CONFIG_IEEE80211W */
769 static void wpa_report_ie_mismatch(struct wpa_sm *sm,
770 const char *reason, const u8 *src_addr,
771 const u8 *wpa_ie, size_t wpa_ie_len,
772 const u8 *rsn_ie, size_t rsn_ie_len)
774 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING, "WPA: %s (src=" MACSTR ")",
775 reason, MAC2STR(src_addr));
778 wpa_hexdump(MSG_INFO, "WPA: WPA IE in Beacon/ProbeResp",
779 sm->ap_wpa_ie, sm->ap_wpa_ie_len);
782 if (!sm->ap_wpa_ie) {
783 wpa_printf(MSG_INFO, "WPA: No WPA IE in "
786 wpa_hexdump(MSG_INFO, "WPA: WPA IE in 3/4 msg",
791 wpa_hexdump(MSG_INFO, "WPA: RSN IE in Beacon/ProbeResp",
792 sm->ap_rsn_ie, sm->ap_rsn_ie_len);
795 if (!sm->ap_rsn_ie) {
796 wpa_printf(MSG_INFO, "WPA: No RSN IE in "
799 wpa_hexdump(MSG_INFO, "WPA: RSN IE in 3/4 msg",
803 wpa_sm_disassociate(sm, WLAN_REASON_IE_IN_4WAY_DIFFERS);
807 static int wpa_supplicant_validate_ie(struct wpa_sm *sm,
808 const unsigned char *src_addr,
809 struct wpa_eapol_ie_parse *ie)
811 if (sm->ap_wpa_ie == NULL && sm->ap_rsn_ie == NULL) {
812 wpa_printf(MSG_DEBUG, "WPA: No WPA/RSN IE for this AP known. "
813 "Trying to get from scan results");
814 if (wpa_sm_get_beacon_ie(sm) < 0) {
815 wpa_printf(MSG_WARNING, "WPA: Could not find AP from "
818 wpa_printf(MSG_DEBUG, "WPA: Found the current AP from "
819 "updated scan results");
823 if (ie->wpa_ie == NULL && ie->rsn_ie == NULL &&
824 (sm->ap_wpa_ie || sm->ap_rsn_ie)) {
825 wpa_report_ie_mismatch(sm, "IE in 3/4 msg does not match "
826 "with IE in Beacon/ProbeResp (no IE?)",
827 src_addr, ie->wpa_ie, ie->wpa_ie_len,
828 ie->rsn_ie, ie->rsn_ie_len);
832 if ((ie->wpa_ie && sm->ap_wpa_ie &&
833 (ie->wpa_ie_len != sm->ap_wpa_ie_len ||
834 os_memcmp(ie->wpa_ie, sm->ap_wpa_ie, ie->wpa_ie_len) != 0)) ||
835 (ie->rsn_ie && sm->ap_rsn_ie &&
836 (ie->rsn_ie_len != sm->ap_rsn_ie_len ||
837 os_memcmp(ie->rsn_ie, sm->ap_rsn_ie, ie->rsn_ie_len) != 0))) {
838 wpa_report_ie_mismatch(sm, "IE in 3/4 msg does not match "
839 "with IE in Beacon/ProbeResp",
840 src_addr, ie->wpa_ie, ie->wpa_ie_len,
841 ie->rsn_ie, ie->rsn_ie_len);
845 if (sm->proto == WPA_PROTO_WPA &&
846 ie->rsn_ie && sm->ap_rsn_ie == NULL && sm->rsn_enabled) {
847 wpa_report_ie_mismatch(sm, "Possible downgrade attack "
848 "detected - RSN was enabled and RSN IE "
849 "was in msg 3/4, but not in "
851 src_addr, ie->wpa_ie, ie->wpa_ie_len,
852 ie->rsn_ie, ie->rsn_ie_len);
856 #ifdef CONFIG_IEEE80211R
857 if (wpa_key_mgmt_ft(sm->key_mgmt)) {
858 struct rsn_mdie *mdie;
859 /* TODO: verify that full MDIE matches with the one from scan
860 * results, not only mobility domain */
861 mdie = (struct rsn_mdie *) (ie->mdie + 2);
862 if (ie->mdie == NULL || ie->mdie_len < 2 + sizeof(*mdie) ||
863 os_memcmp(mdie->mobility_domain, sm->mobility_domain,
864 MOBILITY_DOMAIN_ID_LEN) != 0) {
865 wpa_printf(MSG_DEBUG, "FT: MDIE in msg 3/4 did not "
866 "match with the current mobility domain");
870 #endif /* CONFIG_IEEE80211R */
877 * wpa_supplicant_send_4_of_4 - Send message 4 of WPA/RSN 4-Way Handshake
878 * @sm: Pointer to WPA state machine data from wpa_sm_init()
879 * @dst: Destination address for the frame
880 * @key: Pointer to the EAPOL-Key frame header
881 * @ver: Version bits from EAPOL-Key Key Info
882 * @key_info: Key Info
883 * @kde: KDEs to include the EAPOL-Key frame
884 * @kde_len: Length of KDEs
885 * @ptk: PTK to use for keyed hash and encryption
886 * Returns: 0 on success, -1 on failure
888 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
889 const struct wpa_eapol_key *key,
890 u16 ver, u16 key_info,
891 const u8 *kde, size_t kde_len,
895 struct wpa_eapol_key *reply;
899 wpa_hexdump(MSG_DEBUG, "WPA: KDE for msg 4/4", kde, kde_len);
901 rbuf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_KEY, NULL,
902 sizeof(*reply) + kde_len,
903 &rlen, (void *) &reply);
907 reply->type = sm->proto == WPA_PROTO_RSN ?
908 EAPOL_KEY_TYPE_RSN : EAPOL_KEY_TYPE_WPA;
909 key_info &= WPA_KEY_INFO_SECURE;
910 key_info |= ver | WPA_KEY_INFO_KEY_TYPE | WPA_KEY_INFO_MIC;
911 WPA_PUT_BE16(reply->key_info, key_info);
912 if (sm->proto == WPA_PROTO_RSN)
913 WPA_PUT_BE16(reply->key_length, 0);
915 os_memcpy(reply->key_length, key->key_length, 2);
916 os_memcpy(reply->replay_counter, key->replay_counter,
917 WPA_REPLAY_COUNTER_LEN);
919 WPA_PUT_BE16(reply->key_data_length, kde_len);
921 os_memcpy(reply + 1, kde, kde_len);
923 wpa_printf(MSG_DEBUG, "WPA: Sending EAPOL-Key 4/4");
924 wpa_eapol_key_send(sm, ptk->kck, ver, dst, ETH_P_EAPOL,
925 rbuf, rlen, reply->key_mic);
931 static void wpa_supplicant_process_3_of_4(struct wpa_sm *sm,
932 const struct wpa_eapol_key *key,
935 u16 key_info, keylen, len;
937 struct wpa_eapol_ie_parse ie;
939 wpa_sm_set_state(sm, WPA_4WAY_HANDSHAKE);
940 wpa_printf(MSG_DEBUG, "WPA: RX message 3 of 4-Way Handshake from "
941 MACSTR " (ver=%d)", MAC2STR(sm->bssid), ver);
943 key_info = WPA_GET_BE16(key->key_info);
945 pos = (const u8 *) (key + 1);
946 len = WPA_GET_BE16(key->key_data_length);
947 wpa_hexdump(MSG_DEBUG, "WPA: IE KeyData", pos, len);
948 wpa_supplicant_parse_ies(pos, len, &ie);
949 if (ie.gtk && !(key_info & WPA_KEY_INFO_ENCR_KEY_DATA)) {
950 wpa_printf(MSG_WARNING, "WPA: GTK IE in unencrypted key data");
953 #ifdef CONFIG_IEEE80211W
954 if (ie.igtk && !(key_info & WPA_KEY_INFO_ENCR_KEY_DATA)) {
955 wpa_printf(MSG_WARNING, "WPA: IGTK KDE in unencrypted key "
960 if (ie.igtk && ie.igtk_len != sizeof(struct wpa_igtk_kde)) {
961 wpa_printf(MSG_WARNING, "WPA: Invalid IGTK KDE length %lu",
962 (unsigned long) ie.igtk_len);
965 #endif /* CONFIG_IEEE80211W */
967 if (wpa_supplicant_validate_ie(sm, sm->bssid, &ie) < 0)
970 if (os_memcmp(sm->anonce, key->key_nonce, WPA_NONCE_LEN) != 0) {
971 wpa_printf(MSG_WARNING, "WPA: ANonce from message 1 of 4-Way "
972 "Handshake differs from 3 of 4-Way Handshake - drop"
973 " packet (src=" MACSTR ")", MAC2STR(sm->bssid));
977 keylen = WPA_GET_BE16(key->key_length);
978 switch (sm->pairwise_cipher) {
979 case WPA_CIPHER_CCMP:
981 wpa_printf(MSG_WARNING, "WPA: Invalid CCMP key length "
982 "%d (src=" MACSTR ")",
983 keylen, MAC2STR(sm->bssid));
987 case WPA_CIPHER_TKIP:
989 wpa_printf(MSG_WARNING, "WPA: Invalid TKIP key length "
990 "%d (src=" MACSTR ")",
991 keylen, MAC2STR(sm->bssid));
997 if (wpa_supplicant_send_4_of_4(sm, sm->bssid, key, ver, key_info,
1001 /* SNonce was successfully used in msg 3/4, so mark it to be renewed
1002 * for the next 4-Way Handshake. If msg 3 is received again, the old
1003 * SNonce will still be used to avoid changing PTK. */
1004 sm->renew_snonce = 1;
1006 if (key_info & WPA_KEY_INFO_INSTALL) {
1007 wpa_supplicant_install_ptk(sm, key);
1010 if (key_info & WPA_KEY_INFO_SECURE) {
1011 wpa_sm_mlme_setprotection(
1012 sm, sm->bssid, MLME_SETPROTECTION_PROTECT_TYPE_RX,
1013 MLME_SETPROTECTION_KEY_TYPE_PAIRWISE);
1014 eapol_sm_notify_portValid(sm->eapol, TRUE);
1016 wpa_sm_set_state(sm, WPA_GROUP_HANDSHAKE);
1019 wpa_supplicant_pairwise_gtk(sm, key,
1020 ie.gtk, ie.gtk_len, key_info) < 0) {
1021 wpa_printf(MSG_INFO, "RSN: Failed to configure GTK");
1024 if (ieee80211w_set_keys(sm, &ie) < 0)
1025 wpa_printf(MSG_INFO, "RSN: Failed to configure IGTK");
1029 static int wpa_supplicant_process_1_of_2_rsn(struct wpa_sm *sm,
1033 struct wpa_gtk_data *gd)
1036 struct wpa_eapol_ie_parse ie;
1038 wpa_hexdump(MSG_DEBUG, "RSN: msg 1/2 key data", keydata, keydatalen);
1039 wpa_supplicant_parse_ies(keydata, keydatalen, &ie);
1040 if (ie.gtk && !(key_info & WPA_KEY_INFO_ENCR_KEY_DATA)) {
1041 wpa_printf(MSG_WARNING, "WPA: GTK IE in unencrypted key data");
1044 if (ie.gtk == NULL) {
1045 wpa_printf(MSG_INFO, "WPA: No GTK IE in Group Key msg 1/2");
1048 maxkeylen = gd->gtk_len = ie.gtk_len - 2;
1050 if (wpa_supplicant_check_group_cipher(sm->group_cipher,
1051 gd->gtk_len, maxkeylen,
1052 &gd->key_rsc_len, &gd->alg))
1055 wpa_hexdump(MSG_DEBUG, "RSN: received GTK in group key handshake",
1056 ie.gtk, ie.gtk_len);
1057 gd->keyidx = ie.gtk[0] & 0x3;
1058 gd->tx = wpa_supplicant_gtk_tx_bit_workaround(sm,
1059 !!(ie.gtk[0] & BIT(2)));
1060 if (ie.gtk_len - 2 > sizeof(gd->gtk)) {
1061 wpa_printf(MSG_INFO, "RSN: Too long GTK in GTK IE "
1062 "(len=%lu)", (unsigned long) ie.gtk_len - 2);
1065 os_memcpy(gd->gtk, ie.gtk + 2, ie.gtk_len - 2);
1067 if (ieee80211w_set_keys(sm, &ie) < 0)
1068 wpa_printf(MSG_INFO, "RSN: Failed to configure IGTK");
1074 static int wpa_supplicant_process_1_of_2_wpa(struct wpa_sm *sm,
1075 const struct wpa_eapol_key *key,
1076 size_t keydatalen, int key_info,
1077 size_t extra_len, u16 ver,
1078 struct wpa_gtk_data *gd)
1083 gd->gtk_len = WPA_GET_BE16(key->key_length);
1084 maxkeylen = keydatalen;
1085 if (keydatalen > extra_len) {
1086 wpa_printf(MSG_INFO, "WPA: Truncated EAPOL-Key packet:"
1087 " key_data_length=%lu > extra_len=%lu",
1088 (unsigned long) keydatalen,
1089 (unsigned long) extra_len);
1092 if (ver == WPA_KEY_INFO_TYPE_HMAC_SHA1_AES) {
1093 if (maxkeylen < 8) {
1094 wpa_printf(MSG_INFO, "WPA: Too short maxkeylen (%lu)",
1095 (unsigned long) maxkeylen);
1101 if (wpa_supplicant_check_group_cipher(sm->group_cipher,
1102 gd->gtk_len, maxkeylen,
1103 &gd->key_rsc_len, &gd->alg))
1106 gd->keyidx = (key_info & WPA_KEY_INFO_KEY_INDEX_MASK) >>
1107 WPA_KEY_INFO_KEY_INDEX_SHIFT;
1108 if (ver == WPA_KEY_INFO_TYPE_HMAC_MD5_RC4) {
1109 os_memcpy(ek, key->key_iv, 16);
1110 os_memcpy(ek + 16, sm->ptk.kek, 16);
1111 if (keydatalen > sizeof(gd->gtk)) {
1112 wpa_printf(MSG_WARNING, "WPA: RC4 key data "
1114 (unsigned long) keydatalen);
1117 os_memcpy(gd->gtk, key + 1, keydatalen);
1118 rc4_skip(ek, 32, 256, gd->gtk, keydatalen);
1119 } else if (ver == WPA_KEY_INFO_TYPE_HMAC_SHA1_AES) {
1120 if (keydatalen % 8) {
1121 wpa_printf(MSG_WARNING, "WPA: Unsupported AES-WRAP "
1122 "len %lu", (unsigned long) keydatalen);
1125 if (maxkeylen > sizeof(gd->gtk)) {
1126 wpa_printf(MSG_WARNING, "WPA: AES-WRAP key data "
1127 "too long (keydatalen=%lu maxkeylen=%lu)",
1128 (unsigned long) keydatalen,
1129 (unsigned long) maxkeylen);
1132 if (aes_unwrap(sm->ptk.kek, maxkeylen / 8,
1133 (const u8 *) (key + 1), gd->gtk)) {
1134 wpa_printf(MSG_WARNING, "WPA: AES unwrap "
1135 "failed - could not decrypt GTK");
1139 wpa_printf(MSG_WARNING, "WPA: Unsupported key_info type %d",
1143 gd->tx = wpa_supplicant_gtk_tx_bit_workaround(
1144 sm, !!(key_info & WPA_KEY_INFO_TXRX));
1149 static int wpa_supplicant_send_2_of_2(struct wpa_sm *sm,
1150 const struct wpa_eapol_key *key,
1151 int ver, u16 key_info)
1154 struct wpa_eapol_key *reply;
1157 rbuf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_KEY, NULL,
1158 sizeof(*reply), &rlen, (void *) &reply);
1162 reply->type = sm->proto == WPA_PROTO_RSN ?
1163 EAPOL_KEY_TYPE_RSN : EAPOL_KEY_TYPE_WPA;
1164 key_info &= WPA_KEY_INFO_KEY_INDEX_MASK;
1165 key_info |= ver | WPA_KEY_INFO_MIC | WPA_KEY_INFO_SECURE;
1166 WPA_PUT_BE16(reply->key_info, key_info);
1167 if (sm->proto == WPA_PROTO_RSN)
1168 WPA_PUT_BE16(reply->key_length, 0);
1170 os_memcpy(reply->key_length, key->key_length, 2);
1171 os_memcpy(reply->replay_counter, key->replay_counter,
1172 WPA_REPLAY_COUNTER_LEN);
1174 WPA_PUT_BE16(reply->key_data_length, 0);
1176 wpa_printf(MSG_DEBUG, "WPA: Sending EAPOL-Key 2/2");
1177 wpa_eapol_key_send(sm, sm->ptk.kck, ver, sm->bssid, ETH_P_EAPOL,
1178 rbuf, rlen, reply->key_mic);
1184 static void wpa_supplicant_process_1_of_2(struct wpa_sm *sm,
1185 const unsigned char *src_addr,
1186 const struct wpa_eapol_key *key,
1187 int extra_len, u16 ver)
1189 u16 key_info, keydatalen;
1191 struct wpa_gtk_data gd;
1193 os_memset(&gd, 0, sizeof(gd));
1195 rekey = wpa_sm_get_state(sm) == WPA_COMPLETED;
1196 wpa_printf(MSG_DEBUG, "WPA: RX message 1 of Group Key Handshake from "
1197 MACSTR " (ver=%d)", MAC2STR(src_addr), ver);
1199 key_info = WPA_GET_BE16(key->key_info);
1200 keydatalen = WPA_GET_BE16(key->key_data_length);
1202 if (sm->proto == WPA_PROTO_RSN) {
1203 ret = wpa_supplicant_process_1_of_2_rsn(sm,
1204 (const u8 *) (key + 1),
1205 keydatalen, key_info,
1208 ret = wpa_supplicant_process_1_of_2_wpa(sm, key, keydatalen,
1209 key_info, extra_len,
1213 wpa_sm_set_state(sm, WPA_GROUP_HANDSHAKE);
1218 if (wpa_supplicant_install_gtk(sm, &gd, key->key_rsc) ||
1219 wpa_supplicant_send_2_of_2(sm, key, ver, key_info))
1223 wpa_msg(sm->ctx->msg_ctx, MSG_INFO, "WPA: Group rekeying "
1224 "completed with " MACSTR " [GTK=%s]",
1225 MAC2STR(sm->bssid), wpa_cipher_txt(sm->group_cipher));
1226 wpa_sm_cancel_auth_timeout(sm);
1227 wpa_sm_set_state(sm, WPA_COMPLETED);
1229 wpa_supplicant_key_neg_complete(sm, sm->bssid,
1231 WPA_KEY_INFO_SECURE);
1236 static int wpa_supplicant_verify_eapol_key_mic(struct wpa_sm *sm,
1237 struct wpa_eapol_key *key,
1239 const u8 *buf, size_t len)
1244 os_memcpy(mic, key->key_mic, 16);
1246 os_memset(key->key_mic, 0, 16);
1247 wpa_eapol_key_mic(sm->tptk.kck, ver, buf, len,
1249 if (os_memcmp(mic, key->key_mic, 16) != 0) {
1250 wpa_printf(MSG_WARNING, "WPA: Invalid EAPOL-Key MIC "
1251 "when using TPTK - ignoring TPTK");
1256 os_memcpy(&sm->ptk, &sm->tptk, sizeof(sm->ptk));
1260 if (!ok && sm->ptk_set) {
1261 os_memset(key->key_mic, 0, 16);
1262 wpa_eapol_key_mic(sm->ptk.kck, ver, buf, len,
1264 if (os_memcmp(mic, key->key_mic, 16) != 0) {
1265 wpa_printf(MSG_WARNING, "WPA: Invalid EAPOL-Key MIC "
1266 "- dropping packet");
1273 wpa_printf(MSG_WARNING, "WPA: Could not verify EAPOL-Key MIC "
1274 "- dropping packet");
1278 os_memcpy(sm->rx_replay_counter, key->replay_counter,
1279 WPA_REPLAY_COUNTER_LEN);
1280 sm->rx_replay_counter_set = 1;
1285 /* Decrypt RSN EAPOL-Key key data (RC4 or AES-WRAP) */
1286 static int wpa_supplicant_decrypt_key_data(struct wpa_sm *sm,
1287 struct wpa_eapol_key *key, u16 ver)
1289 u16 keydatalen = WPA_GET_BE16(key->key_data_length);
1291 wpa_hexdump(MSG_DEBUG, "RSN: encrypted key data",
1292 (u8 *) (key + 1), keydatalen);
1294 wpa_printf(MSG_WARNING, "WPA: PTK not available, "
1295 "cannot decrypt EAPOL-Key key data.");
1299 /* Decrypt key data here so that this operation does not need
1300 * to be implemented separately for each message type. */
1301 if (ver == WPA_KEY_INFO_TYPE_HMAC_MD5_RC4) {
1303 os_memcpy(ek, key->key_iv, 16);
1304 os_memcpy(ek + 16, sm->ptk.kek, 16);
1305 rc4_skip(ek, 32, 256, (u8 *) (key + 1), keydatalen);
1306 } else if (ver == WPA_KEY_INFO_TYPE_HMAC_SHA1_AES ||
1307 ver == WPA_KEY_INFO_TYPE_AES_128_CMAC) {
1309 if (keydatalen % 8) {
1310 wpa_printf(MSG_WARNING, "WPA: Unsupported "
1311 "AES-WRAP len %d", keydatalen);
1314 keydatalen -= 8; /* AES-WRAP adds 8 bytes */
1315 buf = os_malloc(keydatalen);
1317 wpa_printf(MSG_WARNING, "WPA: No memory for "
1318 "AES-UNWRAP buffer");
1321 if (aes_unwrap(sm->ptk.kek, keydatalen / 8,
1322 (u8 *) (key + 1), buf)) {
1324 wpa_printf(MSG_WARNING, "WPA: AES unwrap failed - "
1325 "could not decrypt EAPOL-Key key data");
1328 os_memcpy(key + 1, buf, keydatalen);
1330 WPA_PUT_BE16(key->key_data_length, keydatalen);
1332 wpa_printf(MSG_WARNING, "WPA: Unsupported key_info type %d",
1336 wpa_hexdump_key(MSG_DEBUG, "WPA: decrypted EAPOL-Key key data",
1337 (u8 *) (key + 1), keydatalen);
1343 * wpa_sm_aborted_cached - Notify WPA that PMKSA caching was aborted
1344 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1346 void wpa_sm_aborted_cached(struct wpa_sm *sm)
1348 if (sm && sm->cur_pmksa) {
1349 wpa_printf(MSG_DEBUG, "RSN: Cancelling PMKSA caching attempt");
1350 sm->cur_pmksa = NULL;
1355 static void wpa_eapol_key_dump(const struct wpa_eapol_key *key)
1357 #ifndef CONFIG_NO_STDOUT_DEBUG
1358 u16 key_info = WPA_GET_BE16(key->key_info);
1360 wpa_printf(MSG_DEBUG, " EAPOL-Key type=%d", key->type);
1361 wpa_printf(MSG_DEBUG, " key_info 0x%x (ver=%d keyidx=%d rsvd=%d %s"
1363 key_info, key_info & WPA_KEY_INFO_TYPE_MASK,
1364 (key_info & WPA_KEY_INFO_KEY_INDEX_MASK) >>
1365 WPA_KEY_INFO_KEY_INDEX_SHIFT,
1366 (key_info & (BIT(13) | BIT(14) | BIT(15))) >> 13,
1367 key_info & WPA_KEY_INFO_KEY_TYPE ? "Pairwise" : "Group",
1368 key_info & WPA_KEY_INFO_INSTALL ? " Install" : "",
1369 key_info & WPA_KEY_INFO_ACK ? " Ack" : "",
1370 key_info & WPA_KEY_INFO_MIC ? " MIC" : "",
1371 key_info & WPA_KEY_INFO_SECURE ? " Secure" : "",
1372 key_info & WPA_KEY_INFO_ERROR ? " Error" : "",
1373 key_info & WPA_KEY_INFO_REQUEST ? " Request" : "",
1374 key_info & WPA_KEY_INFO_ENCR_KEY_DATA ? " Encr" : "");
1375 wpa_printf(MSG_DEBUG, " key_length=%u key_data_length=%u",
1376 WPA_GET_BE16(key->key_length),
1377 WPA_GET_BE16(key->key_data_length));
1378 wpa_hexdump(MSG_DEBUG, " replay_counter",
1379 key->replay_counter, WPA_REPLAY_COUNTER_LEN);
1380 wpa_hexdump(MSG_DEBUG, " key_nonce", key->key_nonce, WPA_NONCE_LEN);
1381 wpa_hexdump(MSG_DEBUG, " key_iv", key->key_iv, 16);
1382 wpa_hexdump(MSG_DEBUG, " key_rsc", key->key_rsc, 8);
1383 wpa_hexdump(MSG_DEBUG, " key_id (reserved)", key->key_id, 8);
1384 wpa_hexdump(MSG_DEBUG, " key_mic", key->key_mic, 16);
1385 #endif /* CONFIG_NO_STDOUT_DEBUG */
1390 * wpa_sm_rx_eapol - Process received WPA EAPOL frames
1391 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1392 * @src_addr: Source MAC address of the EAPOL packet
1393 * @buf: Pointer to the beginning of the EAPOL data (EAPOL header)
1394 * @len: Length of the EAPOL frame
1395 * Returns: 1 = WPA EAPOL-Key processed, 0 = not a WPA EAPOL-Key, -1 failure
1397 * This function is called for each received EAPOL frame. Other than EAPOL-Key
1398 * frames can be skipped if filtering is done elsewhere. wpa_sm_rx_eapol() is
1399 * only processing WPA and WPA2 EAPOL-Key frames.
1401 * The received EAPOL-Key packets are validated and valid packets are replied
1402 * to. In addition, key material (PTK, GTK) is configured at the end of a
1403 * successful key handshake.
1405 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
1406 const u8 *buf, size_t len)
1408 size_t plen, data_len, extra_len;
1409 struct ieee802_1x_hdr *hdr;
1410 struct wpa_eapol_key *key;
1414 struct wpa_peerkey *peerkey = NULL;
1416 #ifdef CONFIG_IEEE80211R
1417 sm->ft_completed = 0;
1418 #endif /* CONFIG_IEEE80211R */
1420 if (len < sizeof(*hdr) + sizeof(*key)) {
1421 wpa_printf(MSG_DEBUG, "WPA: EAPOL frame too short to be a WPA "
1422 "EAPOL-Key (len %lu, expecting at least %lu)",
1423 (unsigned long) len,
1424 (unsigned long) sizeof(*hdr) + sizeof(*key));
1428 tmp = os_malloc(len);
1431 os_memcpy(tmp, buf, len);
1433 hdr = (struct ieee802_1x_hdr *) tmp;
1434 key = (struct wpa_eapol_key *) (hdr + 1);
1435 plen = be_to_host16(hdr->length);
1436 data_len = plen + sizeof(*hdr);
1437 wpa_printf(MSG_DEBUG, "IEEE 802.1X RX: version=%d type=%d length=%lu",
1438 hdr->version, hdr->type, (unsigned long) plen);
1440 if (hdr->version < EAPOL_VERSION) {
1441 /* TODO: backwards compatibility */
1443 if (hdr->type != IEEE802_1X_TYPE_EAPOL_KEY) {
1444 wpa_printf(MSG_DEBUG, "WPA: EAPOL frame (type %u) discarded, "
1445 "not a Key frame", hdr->type);
1449 if (plen > len - sizeof(*hdr) || plen < sizeof(*key)) {
1450 wpa_printf(MSG_DEBUG, "WPA: EAPOL frame payload size %lu "
1451 "invalid (frame size %lu)",
1452 (unsigned long) plen, (unsigned long) len);
1457 if (key->type != EAPOL_KEY_TYPE_WPA && key->type != EAPOL_KEY_TYPE_RSN)
1459 wpa_printf(MSG_DEBUG, "WPA: EAPOL-Key type (%d) unknown, "
1460 "discarded", key->type);
1464 wpa_eapol_key_dump(key);
1466 eapol_sm_notify_lower_layer_success(sm->eapol, 0);
1467 wpa_hexdump(MSG_MSGDUMP, "WPA: RX EAPOL-Key", tmp, len);
1468 if (data_len < len) {
1469 wpa_printf(MSG_DEBUG, "WPA: ignoring %lu bytes after the IEEE "
1470 "802.1X data", (unsigned long) len - data_len);
1472 key_info = WPA_GET_BE16(key->key_info);
1473 ver = key_info & WPA_KEY_INFO_TYPE_MASK;
1474 if (ver != WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 &&
1475 #if defined(CONFIG_IEEE80211R) || defined(CONFIG_IEEE80211W)
1476 ver != WPA_KEY_INFO_TYPE_AES_128_CMAC &&
1477 #endif /* CONFIG_IEEE80211R || CONFIG_IEEE80211W */
1478 ver != WPA_KEY_INFO_TYPE_HMAC_SHA1_AES) {
1479 wpa_printf(MSG_INFO, "WPA: Unsupported EAPOL-Key descriptor "
1480 "version %d.", ver);
1484 #ifdef CONFIG_IEEE80211R
1485 if (wpa_key_mgmt_ft(sm->key_mgmt)) {
1486 /* IEEE 802.11r uses a new key_info type (AES-128-CMAC). */
1487 if (ver != WPA_KEY_INFO_TYPE_AES_128_CMAC) {
1488 wpa_printf(MSG_INFO, "FT: AP did not use "
1493 #endif /* CONFIG_IEEE80211R */
1494 #ifdef CONFIG_IEEE80211W
1495 if (wpa_key_mgmt_sha256(sm->key_mgmt)) {
1496 if (ver != WPA_KEY_INFO_TYPE_AES_128_CMAC) {
1497 wpa_printf(MSG_INFO, "WPA: AP did not use the "
1498 "negotiated AES-128-CMAC.");
1502 #endif /* CONFIG_IEEE80211W */
1503 if (sm->pairwise_cipher == WPA_CIPHER_CCMP &&
1504 ver != WPA_KEY_INFO_TYPE_HMAC_SHA1_AES) {
1505 wpa_printf(MSG_INFO, "WPA: CCMP is used, but EAPOL-Key "
1506 "descriptor version (%d) is not 2.", ver);
1507 if (sm->group_cipher != WPA_CIPHER_CCMP &&
1508 !(key_info & WPA_KEY_INFO_KEY_TYPE)) {
1509 /* Earlier versions of IEEE 802.11i did not explicitly
1510 * require version 2 descriptor for all EAPOL-Key
1511 * packets, so allow group keys to use version 1 if
1512 * CCMP is not used for them. */
1513 wpa_printf(MSG_INFO, "WPA: Backwards compatibility: "
1514 "allow invalid version for non-CCMP group "
1520 #ifdef CONFIG_PEERKEY
1521 for (peerkey = sm->peerkey; peerkey; peerkey = peerkey->next) {
1522 if (os_memcmp(peerkey->addr, src_addr, ETH_ALEN) == 0)
1526 if (!(key_info & WPA_KEY_INFO_SMK_MESSAGE) && peerkey) {
1527 if (!peerkey->initiator && peerkey->replay_counter_set &&
1528 os_memcmp(key->replay_counter, peerkey->replay_counter,
1529 WPA_REPLAY_COUNTER_LEN) <= 0) {
1530 wpa_printf(MSG_WARNING, "RSN: EAPOL-Key Replay "
1531 "Counter did not increase (STK) - dropping "
1534 } else if (peerkey->initiator) {
1535 u8 _tmp[WPA_REPLAY_COUNTER_LEN];
1536 os_memcpy(_tmp, key->replay_counter,
1537 WPA_REPLAY_COUNTER_LEN);
1538 inc_byte_array(_tmp, WPA_REPLAY_COUNTER_LEN);
1539 if (os_memcmp(_tmp, peerkey->replay_counter,
1540 WPA_REPLAY_COUNTER_LEN) != 0) {
1541 wpa_printf(MSG_DEBUG, "RSN: EAPOL-Key Replay "
1542 "Counter did not match (STK) - "
1549 if (peerkey && peerkey->initiator && (key_info & WPA_KEY_INFO_ACK)) {
1550 wpa_printf(MSG_INFO, "RSN: Ack bit in key_info from STK peer");
1553 #endif /* CONFIG_PEERKEY */
1555 if (!peerkey && sm->rx_replay_counter_set &&
1556 os_memcmp(key->replay_counter, sm->rx_replay_counter,
1557 WPA_REPLAY_COUNTER_LEN) <= 0) {
1558 wpa_printf(MSG_WARNING, "WPA: EAPOL-Key Replay Counter did not"
1559 " increase - dropping packet");
1563 if (!(key_info & (WPA_KEY_INFO_ACK | WPA_KEY_INFO_SMK_MESSAGE))
1564 #ifdef CONFIG_PEERKEY
1565 && (peerkey == NULL || !peerkey->initiator)
1566 #endif /* CONFIG_PEERKEY */
1568 wpa_printf(MSG_INFO, "WPA: No Ack bit in key_info");
1572 if (key_info & WPA_KEY_INFO_REQUEST) {
1573 wpa_printf(MSG_INFO, "WPA: EAPOL-Key with Request bit - "
1578 if ((key_info & WPA_KEY_INFO_MIC) && !peerkey &&
1579 wpa_supplicant_verify_eapol_key_mic(sm, key, ver, tmp, data_len))
1582 #ifdef CONFIG_PEERKEY
1583 if ((key_info & WPA_KEY_INFO_MIC) && peerkey &&
1584 peerkey_verify_eapol_key_mic(sm, peerkey, key, ver, tmp, data_len))
1586 #endif /* CONFIG_PEERKEY */
1588 extra_len = data_len - sizeof(*hdr) - sizeof(*key);
1590 if (WPA_GET_BE16(key->key_data_length) > extra_len) {
1591 wpa_msg(sm->ctx->msg_ctx, MSG_INFO, "WPA: Invalid EAPOL-Key "
1592 "frame - key_data overflow (%d > %lu)",
1593 WPA_GET_BE16(key->key_data_length),
1594 (unsigned long) extra_len);
1597 extra_len = WPA_GET_BE16(key->key_data_length);
1599 if (sm->proto == WPA_PROTO_RSN &&
1600 (key_info & WPA_KEY_INFO_ENCR_KEY_DATA)) {
1601 if (wpa_supplicant_decrypt_key_data(sm, key, ver))
1603 extra_len = WPA_GET_BE16(key->key_data_length);
1606 if (key_info & WPA_KEY_INFO_KEY_TYPE) {
1607 if (key_info & WPA_KEY_INFO_KEY_INDEX_MASK) {
1608 wpa_printf(MSG_WARNING, "WPA: Ignored EAPOL-Key "
1609 "(Pairwise) with non-zero key index");
1613 /* PeerKey 4-Way Handshake */
1614 peerkey_rx_eapol_4way(sm, peerkey, key, key_info, ver);
1615 } else if (key_info & WPA_KEY_INFO_MIC) {
1616 /* 3/4 4-Way Handshake */
1617 wpa_supplicant_process_3_of_4(sm, key, ver);
1619 /* 1/4 4-Way Handshake */
1620 wpa_supplicant_process_1_of_4(sm, src_addr, key,
1623 } else if (key_info & WPA_KEY_INFO_SMK_MESSAGE) {
1624 /* PeerKey SMK Handshake */
1625 peerkey_rx_eapol_smk(sm, src_addr, key, extra_len, key_info,
1628 if (key_info & WPA_KEY_INFO_MIC) {
1629 /* 1/2 Group Key Handshake */
1630 wpa_supplicant_process_1_of_2(sm, src_addr, key,
1633 wpa_printf(MSG_WARNING, "WPA: EAPOL-Key (Group) "
1634 "without Mic bit - dropped");
1646 #ifdef CONFIG_CTRL_IFACE
1647 static int wpa_cipher_bits(int cipher)
1650 case WPA_CIPHER_CCMP:
1652 case WPA_CIPHER_TKIP:
1654 case WPA_CIPHER_WEP104:
1656 case WPA_CIPHER_WEP40:
1664 static u32 wpa_key_mgmt_suite(struct wpa_sm *sm)
1666 switch (sm->key_mgmt) {
1667 case WPA_KEY_MGMT_IEEE8021X:
1668 return (sm->proto == WPA_PROTO_RSN ?
1669 RSN_AUTH_KEY_MGMT_UNSPEC_802_1X :
1670 WPA_AUTH_KEY_MGMT_UNSPEC_802_1X);
1671 case WPA_KEY_MGMT_PSK:
1672 return (sm->proto == WPA_PROTO_RSN ?
1673 RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X :
1674 WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X);
1675 #ifdef CONFIG_IEEE80211R
1676 case WPA_KEY_MGMT_FT_IEEE8021X:
1677 return RSN_AUTH_KEY_MGMT_FT_802_1X;
1678 case WPA_KEY_MGMT_FT_PSK:
1679 return RSN_AUTH_KEY_MGMT_FT_PSK;
1680 #endif /* CONFIG_IEEE80211R */
1681 #ifdef CONFIG_IEEE80211W
1682 case WPA_KEY_MGMT_IEEE8021X_SHA256:
1683 return RSN_AUTH_KEY_MGMT_802_1X_SHA256;
1684 case WPA_KEY_MGMT_PSK_SHA256:
1685 return RSN_AUTH_KEY_MGMT_PSK_SHA256;
1686 #endif /* CONFIG_IEEE80211W */
1687 case WPA_KEY_MGMT_WPA_NONE:
1688 return WPA_AUTH_KEY_MGMT_NONE;
1695 static u32 wpa_cipher_suite(struct wpa_sm *sm, int cipher)
1698 case WPA_CIPHER_CCMP:
1699 return (sm->proto == WPA_PROTO_RSN ?
1700 RSN_CIPHER_SUITE_CCMP : WPA_CIPHER_SUITE_CCMP);
1701 case WPA_CIPHER_TKIP:
1702 return (sm->proto == WPA_PROTO_RSN ?
1703 RSN_CIPHER_SUITE_TKIP : WPA_CIPHER_SUITE_TKIP);
1704 case WPA_CIPHER_WEP104:
1705 return (sm->proto == WPA_PROTO_RSN ?
1706 RSN_CIPHER_SUITE_WEP104 : WPA_CIPHER_SUITE_WEP104);
1707 case WPA_CIPHER_WEP40:
1708 return (sm->proto == WPA_PROTO_RSN ?
1709 RSN_CIPHER_SUITE_WEP40 : WPA_CIPHER_SUITE_WEP40);
1710 case WPA_CIPHER_NONE:
1711 return (sm->proto == WPA_PROTO_RSN ?
1712 RSN_CIPHER_SUITE_NONE : WPA_CIPHER_SUITE_NONE);
1719 #define RSN_SUITE "%02x-%02x-%02x-%d"
1720 #define RSN_SUITE_ARG(s) \
1721 ((s) >> 24) & 0xff, ((s) >> 16) & 0xff, ((s) >> 8) & 0xff, (s) & 0xff
1724 * wpa_sm_get_mib - Dump text list of MIB entries
1725 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1726 * @buf: Buffer for the list
1727 * @buflen: Length of the buffer
1728 * Returns: Number of bytes written to buffer
1730 * This function is used fetch dot11 MIB variables.
1732 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
1734 char pmkid_txt[PMKID_LEN * 2 + 1];
1738 if (sm->cur_pmksa) {
1739 wpa_snprintf_hex(pmkid_txt, sizeof(pmkid_txt),
1740 sm->cur_pmksa->pmkid, PMKID_LEN);
1742 pmkid_txt[0] = '\0';
1744 if ((wpa_key_mgmt_wpa_psk(sm->key_mgmt) ||
1745 wpa_key_mgmt_wpa_ieee8021x(sm->key_mgmt)) &&
1746 sm->proto == WPA_PROTO_RSN)
1751 ret = os_snprintf(buf, buflen,
1752 "dot11RSNAOptionImplemented=TRUE\n"
1753 "dot11RSNAPreauthenticationImplemented=TRUE\n"
1754 "dot11RSNAEnabled=%s\n"
1755 "dot11RSNAPreauthenticationEnabled=%s\n"
1756 "dot11RSNAConfigVersion=%d\n"
1757 "dot11RSNAConfigPairwiseKeysSupported=5\n"
1758 "dot11RSNAConfigGroupCipherSize=%d\n"
1759 "dot11RSNAConfigPMKLifetime=%d\n"
1760 "dot11RSNAConfigPMKReauthThreshold=%d\n"
1761 "dot11RSNAConfigNumberOfPTKSAReplayCounters=1\n"
1762 "dot11RSNAConfigSATimeout=%d\n",
1763 rsna ? "TRUE" : "FALSE",
1764 rsna ? "TRUE" : "FALSE",
1766 wpa_cipher_bits(sm->group_cipher),
1767 sm->dot11RSNAConfigPMKLifetime,
1768 sm->dot11RSNAConfigPMKReauthThreshold,
1769 sm->dot11RSNAConfigSATimeout);
1770 if (ret < 0 || (size_t) ret >= buflen)
1775 buf + len, buflen - len,
1776 "dot11RSNAAuthenticationSuiteSelected=" RSN_SUITE "\n"
1777 "dot11RSNAPairwiseCipherSelected=" RSN_SUITE "\n"
1778 "dot11RSNAGroupCipherSelected=" RSN_SUITE "\n"
1779 "dot11RSNAPMKIDUsed=%s\n"
1780 "dot11RSNAAuthenticationSuiteRequested=" RSN_SUITE "\n"
1781 "dot11RSNAPairwiseCipherRequested=" RSN_SUITE "\n"
1782 "dot11RSNAGroupCipherRequested=" RSN_SUITE "\n"
1783 "dot11RSNAConfigNumberOfGTKSAReplayCounters=0\n"
1784 "dot11RSNA4WayHandshakeFailures=%u\n",
1785 RSN_SUITE_ARG(wpa_key_mgmt_suite(sm)),
1786 RSN_SUITE_ARG(wpa_cipher_suite(sm, sm->pairwise_cipher)),
1787 RSN_SUITE_ARG(wpa_cipher_suite(sm, sm->group_cipher)),
1789 RSN_SUITE_ARG(wpa_key_mgmt_suite(sm)),
1790 RSN_SUITE_ARG(wpa_cipher_suite(sm, sm->pairwise_cipher)),
1791 RSN_SUITE_ARG(wpa_cipher_suite(sm, sm->group_cipher)),
1792 sm->dot11RSNA4WayHandshakeFailures);
1793 if (ret >= 0 && (size_t) ret < buflen)
1798 #endif /* CONFIG_CTRL_IFACE */
1801 static void wpa_sm_pmksa_free_cb(struct rsn_pmksa_cache_entry *entry,
1802 void *ctx, int replace)
1804 struct wpa_sm *sm = ctx;
1806 if (sm->cur_pmksa == entry ||
1807 (sm->pmk_len == entry->pmk_len &&
1808 os_memcmp(sm->pmk, entry->pmk, sm->pmk_len) == 0)) {
1809 wpa_printf(MSG_DEBUG, "RSN: removed current PMKSA entry");
1810 sm->cur_pmksa = NULL;
1813 /* A new entry is being added, so no need to
1814 * deauthenticate in this case. This happens when EAP
1815 * authentication is completed again (reauth or failed
1816 * PMKSA caching attempt). */
1820 os_memset(sm->pmk, 0, sizeof(sm->pmk));
1821 wpa_sm_deauthenticate(sm, WLAN_REASON_UNSPECIFIED);
1827 * wpa_sm_init - Initialize WPA state machine
1828 * @ctx: Context pointer for callbacks; this needs to be an allocated buffer
1829 * Returns: Pointer to the allocated WPA state machine data
1831 * This function is used to allocate a new WPA state machine and the returned
1832 * value is passed to all WPA state machine calls.
1834 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
1838 sm = os_zalloc(sizeof(*sm));
1841 sm->renew_snonce = 1;
1844 sm->dot11RSNAConfigPMKLifetime = 43200;
1845 sm->dot11RSNAConfigPMKReauthThreshold = 70;
1846 sm->dot11RSNAConfigSATimeout = 60;
1848 sm->pmksa = pmksa_cache_init(wpa_sm_pmksa_free_cb, sm, sm);
1849 if (sm->pmksa == NULL) {
1850 wpa_printf(MSG_ERROR, "RSN: PMKSA cache initialization "
1861 * wpa_sm_deinit - Deinitialize WPA state machine
1862 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1864 void wpa_sm_deinit(struct wpa_sm *sm)
1868 pmksa_cache_deinit(sm->pmksa);
1869 eloop_cancel_timeout(wpa_sm_start_preauth, sm, NULL);
1870 eloop_cancel_timeout(wpa_sm_rekey_ptk, sm, NULL);
1871 os_free(sm->assoc_wpa_ie);
1872 os_free(sm->ap_wpa_ie);
1873 os_free(sm->ap_rsn_ie);
1881 * wpa_sm_notify_assoc - Notify WPA state machine about association
1882 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1883 * @bssid: The BSSID of the new association
1885 * This function is called to let WPA state machine know that the connection
1888 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
1895 wpa_printf(MSG_DEBUG, "WPA: Association event - clear replay counter");
1896 os_memcpy(sm->bssid, bssid, ETH_ALEN);
1897 os_memset(sm->rx_replay_counter, 0, WPA_REPLAY_COUNTER_LEN);
1898 sm->rx_replay_counter_set = 0;
1899 sm->renew_snonce = 1;
1900 if (os_memcmp(sm->preauth_bssid, bssid, ETH_ALEN) == 0)
1901 rsn_preauth_deinit(sm);
1903 #ifdef CONFIG_IEEE80211R
1904 if (wpa_ft_is_completed(sm)) {
1905 wpa_supplicant_key_neg_complete(sm, sm->bssid, 1);
1907 /* Prepare for the next transition */
1908 wpa_ft_prepare_auth_request(sm);
1912 #endif /* CONFIG_IEEE80211R */
1916 * IEEE 802.11, 8.4.10: Delete PTK SA on (re)association if
1917 * this is not part of a Fast BSS Transition.
1919 wpa_printf(MSG_DEBUG, "WPA: Clear old PTK");
1927 * wpa_sm_notify_disassoc - Notify WPA state machine about disassociation
1928 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1930 * This function is called to let WPA state machine know that the connection
1931 * was lost. This will abort any existing pre-authentication session.
1933 void wpa_sm_notify_disassoc(struct wpa_sm *sm)
1935 rsn_preauth_deinit(sm);
1936 if (wpa_sm_get_state(sm) == WPA_4WAY_HANDSHAKE)
1937 sm->dot11RSNA4WayHandshakeFailures++;
1942 * wpa_sm_set_pmk - Set PMK
1943 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1945 * @pmk_len: The length of the new PMK in bytes
1947 * Configure the PMK for WPA state machine.
1949 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len)
1954 sm->pmk_len = pmk_len;
1955 os_memcpy(sm->pmk, pmk, pmk_len);
1957 #ifdef CONFIG_IEEE80211R
1958 /* Set XXKey to be PSK for FT key derivation */
1959 sm->xxkey_len = pmk_len;
1960 os_memcpy(sm->xxkey, pmk, pmk_len);
1961 #endif /* CONFIG_IEEE80211R */
1966 * wpa_sm_set_pmk_from_pmksa - Set PMK based on the current PMKSA
1967 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1969 * Take the PMK from the current PMKSA into use. If no PMKSA is active, the PMK
1972 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
1977 if (sm->cur_pmksa) {
1978 sm->pmk_len = sm->cur_pmksa->pmk_len;
1979 os_memcpy(sm->pmk, sm->cur_pmksa->pmk, sm->pmk_len);
1981 sm->pmk_len = PMK_LEN;
1982 os_memset(sm->pmk, 0, PMK_LEN);
1988 * wpa_sm_set_fast_reauth - Set fast reauthentication (EAP) enabled/disabled
1989 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1990 * @fast_reauth: Whether fast reauthentication (EAP) is allowed
1992 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
1995 sm->fast_reauth = fast_reauth;
2000 * wpa_sm_set_scard_ctx - Set context pointer for smartcard callbacks
2001 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2002 * @scard_ctx: Context pointer for smartcard related callback functions
2004 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
2008 sm->scard_ctx = scard_ctx;
2009 if (sm->preauth_eapol)
2010 eapol_sm_register_scard_ctx(sm->preauth_eapol, scard_ctx);
2015 * wpa_sm_set_config - Notification of current configration change
2016 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2017 * @config: Pointer to current network configuration
2019 * Notify WPA state machine that configuration has changed. config will be
2020 * stored as a backpointer to network configuration. This can be %NULL to clear
2021 * the stored pointed.
2023 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config)
2029 sm->network_ctx = config->network_ctx;
2030 sm->peerkey_enabled = config->peerkey_enabled;
2031 sm->allowed_pairwise_cipher = config->allowed_pairwise_cipher;
2032 sm->proactive_key_caching = config->proactive_key_caching;
2033 sm->eap_workaround = config->eap_workaround;
2034 sm->eap_conf_ctx = config->eap_conf_ctx;
2036 os_memcpy(sm->ssid, config->ssid, config->ssid_len);
2037 sm->ssid_len = config->ssid_len;
2040 sm->wpa_ptk_rekey = config->wpa_ptk_rekey;
2042 sm->network_ctx = NULL;
2043 sm->peerkey_enabled = 0;
2044 sm->allowed_pairwise_cipher = 0;
2045 sm->proactive_key_caching = 0;
2046 sm->eap_workaround = 0;
2047 sm->eap_conf_ctx = NULL;
2049 sm->wpa_ptk_rekey = 0;
2051 if (config == NULL || config->network_ctx != sm->network_ctx)
2052 pmksa_cache_notify_reconfig(sm->pmksa);
2057 * wpa_sm_set_own_addr - Set own MAC address
2058 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2059 * @addr: Own MAC address
2061 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
2064 os_memcpy(sm->own_addr, addr, ETH_ALEN);
2069 * wpa_sm_set_ifname - Set network interface name
2070 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2071 * @ifname: Interface name
2072 * @bridge_ifname: Optional bridge interface name (for pre-auth)
2074 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
2075 const char *bridge_ifname)
2078 sm->ifname = ifname;
2079 sm->bridge_ifname = bridge_ifname;
2085 * wpa_sm_set_eapol - Set EAPOL state machine pointer
2086 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2087 * @eapol: Pointer to EAPOL state machine allocated with eapol_sm_init()
2089 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
2097 * wpa_sm_set_param - Set WPA state machine parameters
2098 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2099 * @param: Parameter field
2100 * @value: Parameter value
2101 * Returns: 0 on success, -1 on failure
2103 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
2112 case RSNA_PMK_LIFETIME:
2114 sm->dot11RSNAConfigPMKLifetime = value;
2118 case RSNA_PMK_REAUTH_THRESHOLD:
2119 if (value > 0 && value <= 100)
2120 sm->dot11RSNAConfigPMKReauthThreshold = value;
2124 case RSNA_SA_TIMEOUT:
2126 sm->dot11RSNAConfigSATimeout = value;
2130 case WPA_PARAM_PROTO:
2133 case WPA_PARAM_PAIRWISE:
2134 sm->pairwise_cipher = value;
2136 case WPA_PARAM_GROUP:
2137 sm->group_cipher = value;
2139 case WPA_PARAM_KEY_MGMT:
2140 sm->key_mgmt = value;
2142 #ifdef CONFIG_IEEE80211W
2143 case WPA_PARAM_MGMT_GROUP:
2144 sm->mgmt_group_cipher = value;
2146 #endif /* CONFIG_IEEE80211W */
2147 case WPA_PARAM_RSN_ENABLED:
2148 sm->rsn_enabled = value;
2159 * wpa_sm_get_param - Get WPA state machine parameters
2160 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2161 * @param: Parameter field
2162 * Returns: Parameter value
2164 unsigned int wpa_sm_get_param(struct wpa_sm *sm, enum wpa_sm_conf_params param)
2170 case RSNA_PMK_LIFETIME:
2171 return sm->dot11RSNAConfigPMKLifetime;
2172 case RSNA_PMK_REAUTH_THRESHOLD:
2173 return sm->dot11RSNAConfigPMKReauthThreshold;
2174 case RSNA_SA_TIMEOUT:
2175 return sm->dot11RSNAConfigSATimeout;
2176 case WPA_PARAM_PROTO:
2178 case WPA_PARAM_PAIRWISE:
2179 return sm->pairwise_cipher;
2180 case WPA_PARAM_GROUP:
2181 return sm->group_cipher;
2182 case WPA_PARAM_KEY_MGMT:
2183 return sm->key_mgmt;
2184 #ifdef CONFIG_IEEE80211W
2185 case WPA_PARAM_MGMT_GROUP:
2186 return sm->mgmt_group_cipher;
2187 #endif /* CONFIG_IEEE80211W */
2188 case WPA_PARAM_RSN_ENABLED:
2189 return sm->rsn_enabled;
2197 * wpa_sm_get_status - Get WPA state machine
2198 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2199 * @buf: Buffer for status information
2200 * @buflen: Maximum buffer length
2201 * @verbose: Whether to include verbose status information
2202 * Returns: Number of bytes written to buf.
2204 * Query WPA state machine for status information. This function fills in
2205 * a text area with current status information. If the buffer (buf) is not
2206 * large enough, status information will be truncated to fit the buffer.
2208 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
2211 char *pos = buf, *end = buf + buflen;
2214 ret = os_snprintf(pos, end - pos,
2215 "pairwise_cipher=%s\n"
2218 wpa_cipher_txt(sm->pairwise_cipher),
2219 wpa_cipher_txt(sm->group_cipher),
2220 wpa_key_mgmt_txt(sm->key_mgmt, sm->proto));
2221 if (ret < 0 || ret >= end - pos)
2229 * wpa_sm_set_assoc_wpa_ie_default - Generate own WPA/RSN IE from configuration
2230 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2231 * @wpa_ie: Pointer to buffer for WPA/RSN IE
2232 * @wpa_ie_len: Pointer to the length of the wpa_ie buffer
2233 * Returns: 0 on success, -1 on failure
2235 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
2243 res = wpa_gen_wpa_ie(sm, wpa_ie, *wpa_ie_len);
2248 wpa_hexdump(MSG_DEBUG, "WPA: Set own WPA IE default",
2249 wpa_ie, *wpa_ie_len);
2251 if (sm->assoc_wpa_ie == NULL) {
2253 * Make a copy of the WPA/RSN IE so that 4-Way Handshake gets
2254 * the correct version of the IE even if PMKSA caching is
2255 * aborted (which would remove PMKID from IE generation).
2257 sm->assoc_wpa_ie = os_malloc(*wpa_ie_len);
2258 if (sm->assoc_wpa_ie == NULL)
2261 os_memcpy(sm->assoc_wpa_ie, wpa_ie, *wpa_ie_len);
2262 sm->assoc_wpa_ie_len = *wpa_ie_len;
2270 * wpa_sm_set_assoc_wpa_ie - Set own WPA/RSN IE from (Re)AssocReq
2271 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2272 * @ie: Pointer to IE data (starting from id)
2274 * Returns: 0 on success, -1 on failure
2276 * Inform WPA state machine about the WPA/RSN IE used in (Re)Association
2277 * Request frame. The IE will be used to override the default value generated
2278 * with wpa_sm_set_assoc_wpa_ie_default().
2280 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len)
2285 os_free(sm->assoc_wpa_ie);
2286 if (ie == NULL || len == 0) {
2287 wpa_printf(MSG_DEBUG, "WPA: clearing own WPA/RSN IE");
2288 sm->assoc_wpa_ie = NULL;
2289 sm->assoc_wpa_ie_len = 0;
2291 wpa_hexdump(MSG_DEBUG, "WPA: set own WPA/RSN IE", ie, len);
2292 sm->assoc_wpa_ie = os_malloc(len);
2293 if (sm->assoc_wpa_ie == NULL)
2296 os_memcpy(sm->assoc_wpa_ie, ie, len);
2297 sm->assoc_wpa_ie_len = len;
2305 * wpa_sm_set_ap_wpa_ie - Set AP WPA IE from Beacon/ProbeResp
2306 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2307 * @ie: Pointer to IE data (starting from id)
2309 * Returns: 0 on success, -1 on failure
2311 * Inform WPA state machine about the WPA IE used in Beacon / Probe Response
2314 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len)
2319 os_free(sm->ap_wpa_ie);
2320 if (ie == NULL || len == 0) {
2321 wpa_printf(MSG_DEBUG, "WPA: clearing AP WPA IE");
2322 sm->ap_wpa_ie = NULL;
2323 sm->ap_wpa_ie_len = 0;
2325 wpa_hexdump(MSG_DEBUG, "WPA: set AP WPA IE", ie, len);
2326 sm->ap_wpa_ie = os_malloc(len);
2327 if (sm->ap_wpa_ie == NULL)
2330 os_memcpy(sm->ap_wpa_ie, ie, len);
2331 sm->ap_wpa_ie_len = len;
2339 * wpa_sm_set_ap_rsn_ie - Set AP RSN IE from Beacon/ProbeResp
2340 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2341 * @ie: Pointer to IE data (starting from id)
2343 * Returns: 0 on success, -1 on failure
2345 * Inform WPA state machine about the RSN IE used in Beacon / Probe Response
2348 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len)
2353 os_free(sm->ap_rsn_ie);
2354 if (ie == NULL || len == 0) {
2355 wpa_printf(MSG_DEBUG, "WPA: clearing AP RSN IE");
2356 sm->ap_rsn_ie = NULL;
2357 sm->ap_rsn_ie_len = 0;
2359 wpa_hexdump(MSG_DEBUG, "WPA: set AP RSN IE", ie, len);
2360 sm->ap_rsn_ie = os_malloc(len);
2361 if (sm->ap_rsn_ie == NULL)
2364 os_memcpy(sm->ap_rsn_ie, ie, len);
2365 sm->ap_rsn_ie_len = len;
2373 * wpa_sm_parse_own_wpa_ie - Parse own WPA/RSN IE
2374 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2375 * @data: Pointer to data area for parsing results
2376 * Returns: 0 on success, -1 if IE is not known, or -2 on parsing failure
2378 * Parse the contents of the own WPA or RSN IE from (Re)AssocReq and write the
2379 * parsed data into data.
2381 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data)
2383 if (sm == NULL || sm->assoc_wpa_ie == NULL) {
2384 wpa_printf(MSG_DEBUG, "WPA: No WPA/RSN IE available from "
2385 "association info");
2388 if (wpa_parse_wpa_ie(sm->assoc_wpa_ie, sm->assoc_wpa_ie_len, data))
2394 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len)
2396 #ifndef CONFIG_NO_WPA2
2397 return pmksa_cache_list(sm->pmksa, buf, len);
2398 #else /* CONFIG_NO_WPA2 */
2400 #endif /* CONFIG_NO_WPA2 */