2 * WPA Supplicant - WPA state machine and EAPOL-Key processing
3 * Copyright (c) 2003-2015, Jouni Malinen <j@w1.fi>
4 * Copyright(c) 2015 Intel Deutschland GmbH
6 * This software may be distributed under the terms of the BSD license.
7 * See README for more details.
13 #include "crypto/aes_wrap.h"
14 #include "crypto/crypto.h"
15 #include "crypto/random.h"
16 #include "common/ieee802_11_defs.h"
17 #include "eapol_supp/eapol_supp_sm.h"
21 #include "pmksa_cache.h"
27 static const u8 null_rsc[8] = { 0, 0, 0, 0, 0, 0, 0, 0 };
31 * wpa_eapol_key_send - Send WPA/RSN EAPOL-Key message
32 * @sm: Pointer to WPA state machine data from wpa_sm_init()
33 * @kck: Key Confirmation Key (KCK, part of PTK)
34 * @kck_len: KCK length in octets
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
41 * Returns: >= 0 on success, < 0 on failure
43 int wpa_eapol_key_send(struct wpa_sm *sm, const u8 *kck, size_t kck_len,
44 int ver, const u8 *dest, u16 proto,
45 u8 *msg, size_t msg_len, u8 *key_mic)
48 size_t mic_len = wpa_mic_len(sm->key_mgmt);
50 if (is_zero_ether_addr(dest) && is_zero_ether_addr(sm->bssid)) {
52 * Association event was not yet received; try to fetch
53 * BSSID from the driver.
55 if (wpa_sm_get_bssid(sm, sm->bssid) < 0) {
56 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
57 "WPA: Failed to read BSSID for "
58 "EAPOL-Key destination address");
61 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
62 "WPA: Use BSSID (" MACSTR
63 ") as the destination for EAPOL-Key",
68 wpa_eapol_key_mic(kck, kck_len, sm->key_mgmt, ver, msg, msg_len,
70 wpa_msg(sm->ctx->msg_ctx, MSG_ERROR,
71 "WPA: Failed to generate EAPOL-Key version %d key_mgmt 0x%x MIC",
75 wpa_hexdump_key(MSG_DEBUG, "WPA: KCK", kck, kck_len);
76 wpa_hexdump(MSG_DEBUG, "WPA: Derived Key MIC", key_mic, mic_len);
77 wpa_hexdump(MSG_MSGDUMP, "WPA: TX EAPOL-Key", msg, msg_len);
78 ret = wpa_sm_ether_send(sm, dest, proto, msg, msg_len);
79 eapol_sm_notify_tx_eapol_key(sm->eapol);
87 * wpa_sm_key_request - Send EAPOL-Key Request
88 * @sm: Pointer to WPA state machine data from wpa_sm_init()
89 * @error: Indicate whether this is an Michael MIC error report
90 * @pairwise: 1 = error report for pairwise packet, 0 = for group packet
92 * Send an EAPOL-Key Request to the current authenticator. This function is
93 * used to request rekeying and it is usually called when a local Michael MIC
94 * failure is detected.
96 void wpa_sm_key_request(struct wpa_sm *sm, int error, int pairwise)
98 size_t mic_len, hdrlen, rlen;
99 struct wpa_eapol_key *reply;
100 struct wpa_eapol_key_192 *reply192;
102 u8 bssid[ETH_ALEN], *rbuf, *key_mic;
104 if (sm->key_mgmt == WPA_KEY_MGMT_OSEN ||
105 wpa_key_mgmt_suite_b(sm->key_mgmt))
106 ver = WPA_KEY_INFO_TYPE_AKM_DEFINED;
107 else if (wpa_key_mgmt_ft(sm->key_mgmt) ||
108 wpa_key_mgmt_sha256(sm->key_mgmt))
109 ver = WPA_KEY_INFO_TYPE_AES_128_CMAC;
110 else if (sm->pairwise_cipher != WPA_CIPHER_TKIP)
111 ver = WPA_KEY_INFO_TYPE_HMAC_SHA1_AES;
113 ver = WPA_KEY_INFO_TYPE_HMAC_MD5_RC4;
115 if (wpa_sm_get_bssid(sm, bssid) < 0) {
116 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
117 "Failed to read BSSID for EAPOL-Key request");
121 mic_len = wpa_mic_len(sm->key_mgmt);
122 hdrlen = mic_len == 24 ? sizeof(*reply192) : sizeof(*reply);
123 rbuf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_KEY, NULL,
124 hdrlen, &rlen, (void *) &reply);
127 reply192 = (struct wpa_eapol_key_192 *) reply;
129 reply->type = (sm->proto == WPA_PROTO_RSN ||
130 sm->proto == WPA_PROTO_OSEN) ?
131 EAPOL_KEY_TYPE_RSN : EAPOL_KEY_TYPE_WPA;
132 key_info = WPA_KEY_INFO_REQUEST | ver;
134 key_info |= WPA_KEY_INFO_MIC | WPA_KEY_INFO_SECURE;
136 key_info |= WPA_KEY_INFO_ERROR;
138 key_info |= WPA_KEY_INFO_KEY_TYPE;
139 WPA_PUT_BE16(reply->key_info, key_info);
140 WPA_PUT_BE16(reply->key_length, 0);
141 os_memcpy(reply->replay_counter, sm->request_counter,
142 WPA_REPLAY_COUNTER_LEN);
143 inc_byte_array(sm->request_counter, WPA_REPLAY_COUNTER_LEN);
146 WPA_PUT_BE16(reply192->key_data_length, 0);
148 WPA_PUT_BE16(reply->key_data_length, 0);
149 if (!(key_info & WPA_KEY_INFO_MIC))
152 key_mic = reply192->key_mic; /* same offset in reply */
154 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
155 "WPA: Sending EAPOL-Key Request (error=%d "
156 "pairwise=%d ptk_set=%d len=%lu)",
157 error, pairwise, sm->ptk_set, (unsigned long) rlen);
158 wpa_eapol_key_send(sm, sm->ptk.kck, sm->ptk.kck_len, ver, bssid,
159 ETH_P_EAPOL, rbuf, rlen, key_mic);
163 static void wpa_supplicant_key_mgmt_set_pmk(struct wpa_sm *sm)
165 #ifdef CONFIG_IEEE80211R
166 if (sm->key_mgmt == WPA_KEY_MGMT_FT_IEEE8021X) {
167 if (wpa_sm_key_mgmt_set_pmk(sm, sm->xxkey, sm->xxkey_len))
168 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
169 "RSN: Cannot set low order 256 bits of MSK for key management offload");
171 #endif /* CONFIG_IEEE80211R */
172 if (wpa_sm_key_mgmt_set_pmk(sm, sm->pmk, sm->pmk_len))
173 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
174 "RSN: Cannot set PMK for key management offload");
175 #ifdef CONFIG_IEEE80211R
177 #endif /* CONFIG_IEEE80211R */
181 static int wpa_supplicant_get_pmk(struct wpa_sm *sm,
182 const unsigned char *src_addr,
185 int abort_cached = 0;
187 if (pmkid && !sm->cur_pmksa) {
188 /* When using drivers that generate RSN IE, wpa_supplicant may
189 * not have enough time to get the association information
190 * event before receiving this 1/4 message, so try to find a
191 * matching PMKSA cache entry here. */
192 sm->cur_pmksa = pmksa_cache_get(sm->pmksa, src_addr, pmkid,
195 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
196 "RSN: found matching PMKID from PMKSA cache");
198 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
199 "RSN: no matching PMKID found");
204 if (pmkid && sm->cur_pmksa &&
205 os_memcmp_const(pmkid, sm->cur_pmksa->pmkid, PMKID_LEN) == 0) {
206 wpa_hexdump(MSG_DEBUG, "RSN: matched PMKID", pmkid, PMKID_LEN);
207 wpa_sm_set_pmk_from_pmksa(sm);
208 wpa_hexdump_key(MSG_DEBUG, "RSN: PMK from PMKSA cache",
209 sm->pmk, sm->pmk_len);
210 eapol_sm_notify_cached(sm->eapol);
211 #ifdef CONFIG_IEEE80211R
213 #endif /* CONFIG_IEEE80211R */
214 } else if (wpa_key_mgmt_wpa_ieee8021x(sm->key_mgmt) && sm->eapol) {
217 if (sm->key_mgmt & WPA_KEY_MGMT_IEEE8021X_SUITE_B_192)
218 pmk_len = PMK_LEN_SUITE_B_192;
221 res = eapol_sm_get_key(sm->eapol, sm->pmk, pmk_len);
223 if (pmk_len == PMK_LEN) {
225 * EAP-LEAP is an exception from other EAP
226 * methods: it uses only 16-byte PMK.
228 res = eapol_sm_get_key(sm->eapol, sm->pmk, 16);
232 #ifdef CONFIG_IEEE80211R
234 if (eapol_sm_get_key(sm->eapol, buf, 2 * PMK_LEN) == 0)
236 os_memcpy(sm->xxkey, buf + PMK_LEN, PMK_LEN);
237 sm->xxkey_len = PMK_LEN;
238 os_memset(buf, 0, sizeof(buf));
240 #endif /* CONFIG_IEEE80211R */
243 struct rsn_pmksa_cache_entry *sa = NULL;
244 wpa_hexdump_key(MSG_DEBUG, "WPA: PMK from EAPOL state "
245 "machines", sm->pmk, pmk_len);
246 sm->pmk_len = pmk_len;
247 wpa_supplicant_key_mgmt_set_pmk(sm);
248 if (sm->proto == WPA_PROTO_RSN &&
249 !wpa_key_mgmt_suite_b(sm->key_mgmt) &&
250 !wpa_key_mgmt_ft(sm->key_mgmt)) {
251 sa = pmksa_cache_add(sm->pmksa,
252 sm->pmk, pmk_len, NULL,
254 src_addr, sm->own_addr,
258 if (!sm->cur_pmksa && pmkid &&
259 pmksa_cache_get(sm->pmksa, src_addr, pmkid, NULL))
261 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
262 "RSN: the new PMK matches with the "
265 } else if (sa && !sm->cur_pmksa && pmkid) {
267 * It looks like the authentication server
268 * derived mismatching MSK. This should not
269 * really happen, but bugs happen.. There is not
270 * much we can do here without knowing what
271 * exactly caused the server to misbehave.
273 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
274 "RSN: PMKID mismatch - authentication server may have derived different MSK?!");
281 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
282 "WPA: Failed to get master session key from "
283 "EAPOL state machines - key handshake "
286 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
287 "RSN: Cancelled PMKSA caching "
289 sm->cur_pmksa = NULL;
291 } else if (!abort_cached) {
297 if (abort_cached && wpa_key_mgmt_wpa_ieee8021x(sm->key_mgmt) &&
298 !wpa_key_mgmt_suite_b(sm->key_mgmt) &&
299 !wpa_key_mgmt_ft(sm->key_mgmt) && sm->key_mgmt != WPA_KEY_MGMT_OSEN)
301 /* Send EAPOL-Start to trigger full EAP authentication. */
305 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
306 "RSN: no PMKSA entry found - trigger "
307 "full EAP authentication");
308 buf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_START,
309 NULL, 0, &buflen, NULL);
311 wpa_sm_ether_send(sm, sm->bssid, ETH_P_EAPOL,
325 * wpa_supplicant_send_2_of_4 - Send message 2 of WPA/RSN 4-Way Handshake
326 * @sm: Pointer to WPA state machine data from wpa_sm_init()
327 * @dst: Destination address for the frame
328 * @key: Pointer to the EAPOL-Key frame header
329 * @ver: Version bits from EAPOL-Key Key Info
330 * @nonce: Nonce value for the EAPOL-Key frame
331 * @wpa_ie: WPA/RSN IE
332 * @wpa_ie_len: Length of the WPA/RSN IE
333 * @ptk: PTK to use for keyed hash and encryption
334 * Returns: >= 0 on success, < 0 on failure
336 int wpa_supplicant_send_2_of_4(struct wpa_sm *sm, const unsigned char *dst,
337 const struct wpa_eapol_key *key,
338 int ver, const u8 *nonce,
339 const u8 *wpa_ie, size_t wpa_ie_len,
342 size_t mic_len, hdrlen, rlen;
343 struct wpa_eapol_key *reply;
344 struct wpa_eapol_key_192 *reply192;
346 u8 *rsn_ie_buf = NULL;
348 if (wpa_ie == NULL) {
349 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING, "WPA: No wpa_ie set - "
350 "cannot generate msg 2/4");
354 #ifdef CONFIG_IEEE80211R
355 if (wpa_key_mgmt_ft(sm->key_mgmt)) {
359 * Add PMKR1Name into RSN IE (PMKID-List) and add MDIE and
360 * FTIE from (Re)Association Response.
362 rsn_ie_buf = os_malloc(wpa_ie_len + 2 + 2 + PMKID_LEN +
363 sm->assoc_resp_ies_len);
364 if (rsn_ie_buf == NULL)
366 os_memcpy(rsn_ie_buf, wpa_ie, wpa_ie_len);
367 res = wpa_insert_pmkid(rsn_ie_buf, &wpa_ie_len,
374 if (sm->assoc_resp_ies) {
375 os_memcpy(rsn_ie_buf + wpa_ie_len, sm->assoc_resp_ies,
376 sm->assoc_resp_ies_len);
377 wpa_ie_len += sm->assoc_resp_ies_len;
382 #endif /* CONFIG_IEEE80211R */
384 wpa_hexdump(MSG_DEBUG, "WPA: WPA IE for msg 2/4", wpa_ie, wpa_ie_len);
386 mic_len = wpa_mic_len(sm->key_mgmt);
387 hdrlen = mic_len == 24 ? sizeof(*reply192) : sizeof(*reply);
388 rbuf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_KEY,
389 NULL, hdrlen + wpa_ie_len,
390 &rlen, (void *) &reply);
395 reply192 = (struct wpa_eapol_key_192 *) reply;
397 reply->type = (sm->proto == WPA_PROTO_RSN ||
398 sm->proto == WPA_PROTO_OSEN) ?
399 EAPOL_KEY_TYPE_RSN : EAPOL_KEY_TYPE_WPA;
400 WPA_PUT_BE16(reply->key_info,
401 ver | WPA_KEY_INFO_KEY_TYPE | WPA_KEY_INFO_MIC);
402 if (sm->proto == WPA_PROTO_RSN || sm->proto == WPA_PROTO_OSEN)
403 WPA_PUT_BE16(reply->key_length, 0);
405 os_memcpy(reply->key_length, key->key_length, 2);
406 os_memcpy(reply->replay_counter, key->replay_counter,
407 WPA_REPLAY_COUNTER_LEN);
408 wpa_hexdump(MSG_DEBUG, "WPA: Replay Counter", reply->replay_counter,
409 WPA_REPLAY_COUNTER_LEN);
411 key_mic = reply192->key_mic; /* same offset for reply and reply192 */
413 WPA_PUT_BE16(reply192->key_data_length, wpa_ie_len);
414 os_memcpy(reply192 + 1, wpa_ie, wpa_ie_len);
416 WPA_PUT_BE16(reply->key_data_length, wpa_ie_len);
417 os_memcpy(reply + 1, wpa_ie, wpa_ie_len);
421 os_memcpy(reply->key_nonce, nonce, WPA_NONCE_LEN);
423 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: Sending EAPOL-Key 2/4");
424 return wpa_eapol_key_send(sm, ptk->kck, ptk->kck_len, ver, dst,
425 ETH_P_EAPOL, rbuf, rlen, key_mic);
429 static int wpa_derive_ptk(struct wpa_sm *sm, const unsigned char *src_addr,
430 const struct wpa_eapol_key *key, struct wpa_ptk *ptk)
432 #ifdef CONFIG_IEEE80211R
433 if (wpa_key_mgmt_ft(sm->key_mgmt))
434 return wpa_derive_ptk_ft(sm, src_addr, key, ptk);
435 #endif /* CONFIG_IEEE80211R */
437 return wpa_pmk_to_ptk(sm->pmk, sm->pmk_len, "Pairwise key expansion",
438 sm->own_addr, sm->bssid, sm->snonce,
439 key->key_nonce, ptk, sm->key_mgmt,
440 sm->pairwise_cipher);
444 static void wpa_supplicant_process_1_of_4(struct wpa_sm *sm,
445 const unsigned char *src_addr,
446 const struct wpa_eapol_key *key,
447 u16 ver, const u8 *key_data,
450 struct wpa_eapol_ie_parse ie;
453 u8 *kde, *kde_buf = NULL;
456 if (wpa_sm_get_network_ctx(sm) == NULL) {
457 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING, "WPA: No SSID info "
458 "found (msg 1 of 4)");
462 wpa_sm_set_state(sm, WPA_4WAY_HANDSHAKE);
463 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: RX message 1 of 4-Way "
464 "Handshake from " MACSTR " (ver=%d)", MAC2STR(src_addr), ver);
466 os_memset(&ie, 0, sizeof(ie));
468 if (sm->proto == WPA_PROTO_RSN || sm->proto == WPA_PROTO_OSEN) {
469 /* RSN: msg 1/4 should contain PMKID for the selected PMK */
470 wpa_hexdump(MSG_DEBUG, "RSN: msg 1/4 key data",
471 key_data, key_data_len);
472 if (wpa_supplicant_parse_ies(key_data, key_data_len, &ie) < 0)
475 wpa_hexdump(MSG_DEBUG, "RSN: PMKID from "
476 "Authenticator", ie.pmkid, PMKID_LEN);
480 res = wpa_supplicant_get_pmk(sm, src_addr, ie.pmkid);
482 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "RSN: Do not reply to "
483 "msg 1/4 - requesting full EAP authentication");
489 if (sm->renew_snonce) {
490 if (random_get_bytes(sm->snonce, WPA_NONCE_LEN)) {
491 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
492 "WPA: Failed to get random data for SNonce");
495 sm->renew_snonce = 0;
496 wpa_hexdump(MSG_DEBUG, "WPA: Renewed SNonce",
497 sm->snonce, WPA_NONCE_LEN);
500 /* Calculate PTK which will be stored as a temporary PTK until it has
501 * been verified when processing message 3/4. */
503 wpa_derive_ptk(sm, src_addr, key, ptk);
504 if (sm->pairwise_cipher == WPA_CIPHER_TKIP) {
506 /* Supplicant: swap tx/rx Mic keys */
507 os_memcpy(buf, &ptk->tk[16], 8);
508 os_memcpy(&ptk->tk[16], &ptk->tk[24], 8);
509 os_memcpy(&ptk->tk[24], buf, 8);
510 os_memset(buf, 0, sizeof(buf));
515 kde = sm->assoc_wpa_ie;
516 kde_len = sm->assoc_wpa_ie_len;
520 kde_buf = os_malloc(kde_len + 2 + RSN_SELECTOR_LEN + 1);
523 wpa_printf(MSG_DEBUG, "P2P: Add IP Address Request KDE "
524 "into EAPOL-Key 2/4");
525 os_memcpy(kde_buf, kde, kde_len);
528 *pos++ = WLAN_EID_VENDOR_SPECIFIC;
529 *pos++ = RSN_SELECTOR_LEN + 1;
530 RSN_SELECTOR_PUT(pos, WFA_KEY_DATA_IP_ADDR_REQ);
531 pos += RSN_SELECTOR_LEN;
536 #endif /* CONFIG_P2P */
538 if (wpa_supplicant_send_2_of_4(sm, sm->bssid, key, ver, sm->snonce,
539 kde, kde_len, ptk) < 0)
543 os_memcpy(sm->anonce, key->key_nonce, WPA_NONCE_LEN);
548 wpa_sm_deauthenticate(sm, WLAN_REASON_UNSPECIFIED);
552 static void wpa_sm_start_preauth(void *eloop_ctx, void *timeout_ctx)
554 struct wpa_sm *sm = eloop_ctx;
555 rsn_preauth_candidate_process(sm);
559 static void wpa_supplicant_key_neg_complete(struct wpa_sm *sm,
560 const u8 *addr, int secure)
562 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
563 "WPA: Key negotiation completed with "
564 MACSTR " [PTK=%s GTK=%s]", MAC2STR(addr),
565 wpa_cipher_txt(sm->pairwise_cipher),
566 wpa_cipher_txt(sm->group_cipher));
567 wpa_sm_cancel_auth_timeout(sm);
568 wpa_sm_set_state(sm, WPA_COMPLETED);
571 wpa_sm_mlme_setprotection(
572 sm, addr, MLME_SETPROTECTION_PROTECT_TYPE_RX_TX,
573 MLME_SETPROTECTION_KEY_TYPE_PAIRWISE);
574 eapol_sm_notify_portValid(sm->eapol, TRUE);
575 if (wpa_key_mgmt_wpa_psk(sm->key_mgmt))
576 eapol_sm_notify_eap_success(sm->eapol, TRUE);
578 * Start preauthentication after a short wait to avoid a
579 * possible race condition between the data receive and key
580 * configuration after the 4-Way Handshake. This increases the
581 * likelihood of the first preauth EAPOL-Start frame getting to
584 eloop_register_timeout(1, 0, wpa_sm_start_preauth, sm, NULL);
587 if (sm->cur_pmksa && sm->cur_pmksa->opportunistic) {
588 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
589 "RSN: Authenticator accepted "
590 "opportunistic PMKSA entry - marking it valid");
591 sm->cur_pmksa->opportunistic = 0;
594 #ifdef CONFIG_IEEE80211R
595 if (wpa_key_mgmt_ft(sm->key_mgmt)) {
596 /* Prepare for the next transition */
597 wpa_ft_prepare_auth_request(sm, NULL);
599 #endif /* CONFIG_IEEE80211R */
603 static void wpa_sm_rekey_ptk(void *eloop_ctx, void *timeout_ctx)
605 struct wpa_sm *sm = eloop_ctx;
606 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: Request PTK rekeying");
607 wpa_sm_key_request(sm, 0, 1);
611 static int wpa_supplicant_install_ptk(struct wpa_sm *sm,
612 const struct wpa_eapol_key *key)
618 if (!sm->tk_to_set) {
619 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
620 "WPA: Do not re-install same PTK to the driver");
624 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
625 "WPA: Installing PTK to the driver");
627 if (sm->pairwise_cipher == WPA_CIPHER_NONE) {
628 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: Pairwise Cipher "
629 "Suite: NONE - do not use pairwise keys");
633 if (!wpa_cipher_valid_pairwise(sm->pairwise_cipher)) {
634 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
635 "WPA: Unsupported pairwise cipher %d",
636 sm->pairwise_cipher);
640 alg = wpa_cipher_to_alg(sm->pairwise_cipher);
641 keylen = wpa_cipher_key_len(sm->pairwise_cipher);
642 rsclen = wpa_cipher_rsc_len(sm->pairwise_cipher);
644 if (sm->proto == WPA_PROTO_RSN || sm->proto == WPA_PROTO_OSEN) {
647 key_rsc = key->key_rsc;
648 wpa_hexdump(MSG_DEBUG, "WPA: RSC", key_rsc, rsclen);
651 if (wpa_sm_set_key(sm, alg, sm->bssid, 0, 1, key_rsc, rsclen,
652 sm->ptk.tk, keylen) < 0) {
653 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
654 "WPA: Failed to set PTK to the "
655 "driver (alg=%d keylen=%d bssid=" MACSTR ")",
656 alg, keylen, MAC2STR(sm->bssid));
660 /* TK is not needed anymore in supplicant */
661 os_memset(sm->ptk.tk, 0, WPA_TK_MAX_LEN);
664 if (sm->wpa_ptk_rekey) {
665 eloop_cancel_timeout(wpa_sm_rekey_ptk, sm, NULL);
666 eloop_register_timeout(sm->wpa_ptk_rekey, 0, wpa_sm_rekey_ptk,
674 static int wpa_supplicant_check_group_cipher(struct wpa_sm *sm,
676 int keylen, int maxkeylen,
682 *alg = wpa_cipher_to_alg(group_cipher);
683 if (*alg == WPA_ALG_NONE) {
684 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
685 "WPA: Unsupported Group Cipher %d",
689 *key_rsc_len = wpa_cipher_rsc_len(group_cipher);
691 klen = wpa_cipher_key_len(group_cipher);
692 if (keylen != klen || maxkeylen < klen) {
693 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
694 "WPA: Unsupported %s Group Cipher key length %d (%d)",
695 wpa_cipher_txt(group_cipher), keylen, maxkeylen);
702 struct wpa_gtk_data {
704 int tx, key_rsc_len, keyidx;
710 static int wpa_supplicant_install_gtk(struct wpa_sm *sm,
711 const struct wpa_gtk_data *gd,
714 const u8 *_gtk = gd->gtk;
717 wpa_hexdump_key(MSG_DEBUG, "WPA: Group Key", gd->gtk, gd->gtk_len);
718 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
719 "WPA: Installing GTK to the driver (keyidx=%d tx=%d len=%d)",
720 gd->keyidx, gd->tx, gd->gtk_len);
721 wpa_hexdump(MSG_DEBUG, "WPA: RSC", key_rsc, gd->key_rsc_len);
722 if (sm->group_cipher == WPA_CIPHER_TKIP) {
723 /* Swap Tx/Rx keys for Michael MIC */
724 os_memcpy(gtk_buf, gd->gtk, 16);
725 os_memcpy(gtk_buf + 16, gd->gtk + 24, 8);
726 os_memcpy(gtk_buf + 24, gd->gtk + 16, 8);
729 if (sm->pairwise_cipher == WPA_CIPHER_NONE) {
730 if (wpa_sm_set_key(sm, gd->alg, NULL,
731 gd->keyidx, 1, key_rsc, gd->key_rsc_len,
732 _gtk, gd->gtk_len) < 0) {
733 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
734 "WPA: Failed to set GTK to the driver "
736 os_memset(gtk_buf, 0, sizeof(gtk_buf));
739 } else if (wpa_sm_set_key(sm, gd->alg, broadcast_ether_addr,
740 gd->keyidx, gd->tx, key_rsc, gd->key_rsc_len,
741 _gtk, gd->gtk_len) < 0) {
742 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
743 "WPA: Failed to set GTK to "
744 "the driver (alg=%d keylen=%d keyidx=%d)",
745 gd->alg, gd->gtk_len, gd->keyidx);
746 os_memset(gtk_buf, 0, sizeof(gtk_buf));
749 os_memset(gtk_buf, 0, sizeof(gtk_buf));
755 static int wpa_supplicant_gtk_tx_bit_workaround(const struct wpa_sm *sm,
758 if (tx && sm->pairwise_cipher != WPA_CIPHER_NONE) {
759 /* Ignore Tx bit for GTK if a pairwise key is used. One AP
760 * seemed to set this bit (incorrectly, since Tx is only when
761 * doing Group Key only APs) and without this workaround, the
762 * data connection does not work because wpa_supplicant
763 * configured non-zero keyidx to be used for unicast. */
764 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
765 "WPA: Tx bit set for GTK, but pairwise "
766 "keys are used - ignore Tx bit");
773 static int wpa_supplicant_rsc_relaxation(const struct wpa_sm *sm,
778 if (!sm->wpa_rsc_relaxation)
781 rsclen = wpa_cipher_rsc_len(sm->group_cipher);
784 * Try to detect RSC (endian) corruption issue where the AP sends
785 * the RSC bytes in EAPOL-Key message in the wrong order, both if
786 * it's actually a 6-byte field (as it should be) and if it treats
787 * it as an 8-byte field.
788 * An AP model known to have this bug is the Sapido RB-1632.
790 if (rsclen == 6 && ((rsc[5] && !rsc[0]) || rsc[6] || rsc[7])) {
791 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
792 "RSC %02x%02x%02x%02x%02x%02x%02x%02x is likely bogus, using 0",
793 rsc[0], rsc[1], rsc[2], rsc[3],
794 rsc[4], rsc[5], rsc[6], rsc[7]);
803 static int wpa_supplicant_pairwise_gtk(struct wpa_sm *sm,
804 const struct wpa_eapol_key *key,
805 const u8 *gtk, size_t gtk_len,
808 struct wpa_gtk_data gd;
812 * IEEE Std 802.11i-2004 - 8.5.2 EAPOL-Key frames - Figure 43x
814 * KeyID[bits 0-1], Tx [bit 2], Reserved [bits 3-7]
815 * Reserved [bits 0-7]
819 os_memset(&gd, 0, sizeof(gd));
820 wpa_hexdump_key(MSG_DEBUG, "RSN: received GTK in pairwise handshake",
823 if (gtk_len < 2 || gtk_len - 2 > sizeof(gd.gtk))
826 gd.keyidx = gtk[0] & 0x3;
827 gd.tx = wpa_supplicant_gtk_tx_bit_workaround(sm,
828 !!(gtk[0] & BIT(2)));
832 os_memcpy(gd.gtk, gtk, gtk_len);
833 gd.gtk_len = gtk_len;
835 key_rsc = key->key_rsc;
836 if (wpa_supplicant_rsc_relaxation(sm, key->key_rsc))
839 if (sm->group_cipher != WPA_CIPHER_GTK_NOT_USED &&
840 (wpa_supplicant_check_group_cipher(sm, sm->group_cipher,
842 &gd.key_rsc_len, &gd.alg) ||
843 wpa_supplicant_install_gtk(sm, &gd, key_rsc))) {
844 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
845 "RSN: Failed to install GTK");
846 os_memset(&gd, 0, sizeof(gd));
849 os_memset(&gd, 0, sizeof(gd));
851 wpa_supplicant_key_neg_complete(sm, sm->bssid,
852 key_info & WPA_KEY_INFO_SECURE);
857 static int ieee80211w_set_keys(struct wpa_sm *sm,
858 struct wpa_eapol_ie_parse *ie)
860 #ifdef CONFIG_IEEE80211W
861 if (!wpa_cipher_valid_mgmt_group(sm->mgmt_group_cipher))
866 const struct wpa_igtk_kde *igtk;
868 len = wpa_cipher_key_len(sm->mgmt_group_cipher);
869 if (ie->igtk_len != WPA_IGTK_KDE_PREFIX_LEN + len)
871 igtk = (const struct wpa_igtk_kde *) ie->igtk;
872 keyidx = WPA_GET_LE16(igtk->keyid);
873 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: IGTK keyid %d "
874 "pn %02x%02x%02x%02x%02x%02x",
875 keyidx, MAC2STR(igtk->pn));
876 wpa_hexdump_key(MSG_DEBUG, "WPA: IGTK",
879 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
880 "WPA: Invalid IGTK KeyID %d", keyidx);
883 if (wpa_sm_set_key(sm, wpa_cipher_to_alg(sm->mgmt_group_cipher),
884 broadcast_ether_addr,
885 keyidx, 0, igtk->pn, sizeof(igtk->pn),
886 igtk->igtk, len) < 0) {
887 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
888 "WPA: Failed to configure IGTK to the driver");
894 #else /* CONFIG_IEEE80211W */
896 #endif /* CONFIG_IEEE80211W */
900 static void wpa_report_ie_mismatch(struct wpa_sm *sm,
901 const char *reason, const u8 *src_addr,
902 const u8 *wpa_ie, size_t wpa_ie_len,
903 const u8 *rsn_ie, size_t rsn_ie_len)
905 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING, "WPA: %s (src=" MACSTR ")",
906 reason, MAC2STR(src_addr));
909 wpa_hexdump(MSG_INFO, "WPA: WPA IE in Beacon/ProbeResp",
910 sm->ap_wpa_ie, sm->ap_wpa_ie_len);
913 if (!sm->ap_wpa_ie) {
914 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
915 "WPA: No WPA IE in Beacon/ProbeResp");
917 wpa_hexdump(MSG_INFO, "WPA: WPA IE in 3/4 msg",
922 wpa_hexdump(MSG_INFO, "WPA: RSN IE in Beacon/ProbeResp",
923 sm->ap_rsn_ie, sm->ap_rsn_ie_len);
926 if (!sm->ap_rsn_ie) {
927 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
928 "WPA: No RSN IE in Beacon/ProbeResp");
930 wpa_hexdump(MSG_INFO, "WPA: RSN IE in 3/4 msg",
934 wpa_sm_deauthenticate(sm, WLAN_REASON_IE_IN_4WAY_DIFFERS);
938 #ifdef CONFIG_IEEE80211R
940 static int ft_validate_mdie(struct wpa_sm *sm,
941 const unsigned char *src_addr,
942 struct wpa_eapol_ie_parse *ie,
943 const u8 *assoc_resp_mdie)
945 struct rsn_mdie *mdie;
947 mdie = (struct rsn_mdie *) (ie->mdie + 2);
948 if (ie->mdie == NULL || ie->mdie_len < 2 + sizeof(*mdie) ||
949 os_memcmp(mdie->mobility_domain, sm->mobility_domain,
950 MOBILITY_DOMAIN_ID_LEN) != 0) {
951 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "FT: MDIE in msg 3/4 did "
952 "not match with the current mobility domain");
956 if (assoc_resp_mdie &&
957 (assoc_resp_mdie[1] != ie->mdie[1] ||
958 os_memcmp(assoc_resp_mdie, ie->mdie, 2 + ie->mdie[1]) != 0)) {
959 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "FT: MDIE mismatch");
960 wpa_hexdump(MSG_DEBUG, "FT: MDIE in EAPOL-Key msg 3/4",
961 ie->mdie, 2 + ie->mdie[1]);
962 wpa_hexdump(MSG_DEBUG, "FT: MDIE in (Re)Association Response",
963 assoc_resp_mdie, 2 + assoc_resp_mdie[1]);
971 static int ft_validate_ftie(struct wpa_sm *sm,
972 const unsigned char *src_addr,
973 struct wpa_eapol_ie_parse *ie,
974 const u8 *assoc_resp_ftie)
976 if (ie->ftie == NULL) {
977 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
978 "FT: No FTIE in EAPOL-Key msg 3/4");
982 if (assoc_resp_ftie == NULL)
985 if (assoc_resp_ftie[1] != ie->ftie[1] ||
986 os_memcmp(assoc_resp_ftie, ie->ftie, 2 + ie->ftie[1]) != 0) {
987 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "FT: FTIE mismatch");
988 wpa_hexdump(MSG_DEBUG, "FT: FTIE in EAPOL-Key msg 3/4",
989 ie->ftie, 2 + ie->ftie[1]);
990 wpa_hexdump(MSG_DEBUG, "FT: FTIE in (Re)Association Response",
991 assoc_resp_ftie, 2 + assoc_resp_ftie[1]);
999 static int ft_validate_rsnie(struct wpa_sm *sm,
1000 const unsigned char *src_addr,
1001 struct wpa_eapol_ie_parse *ie)
1003 struct wpa_ie_data rsn;
1009 * Verify that PMKR1Name from EAPOL-Key message 3/4
1010 * matches with the value we derived.
1012 if (wpa_parse_wpa_ie_rsn(ie->rsn_ie, ie->rsn_ie_len, &rsn) < 0 ||
1013 rsn.num_pmkid != 1 || rsn.pmkid == NULL) {
1014 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "FT: No PMKR1Name in "
1015 "FT 4-way handshake message 3/4");
1019 if (os_memcmp_const(rsn.pmkid, sm->pmk_r1_name, WPA_PMK_NAME_LEN) != 0)
1021 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1022 "FT: PMKR1Name mismatch in "
1023 "FT 4-way handshake message 3/4");
1024 wpa_hexdump(MSG_DEBUG, "FT: PMKR1Name from Authenticator",
1025 rsn.pmkid, WPA_PMK_NAME_LEN);
1026 wpa_hexdump(MSG_DEBUG, "FT: Derived PMKR1Name",
1027 sm->pmk_r1_name, WPA_PMK_NAME_LEN);
1035 static int wpa_supplicant_validate_ie_ft(struct wpa_sm *sm,
1036 const unsigned char *src_addr,
1037 struct wpa_eapol_ie_parse *ie)
1039 const u8 *pos, *end, *mdie = NULL, *ftie = NULL;
1041 if (sm->assoc_resp_ies) {
1042 pos = sm->assoc_resp_ies;
1043 end = pos + sm->assoc_resp_ies_len;
1044 while (end - pos > 2) {
1045 if (2 + pos[1] > end - pos)
1048 case WLAN_EID_MOBILITY_DOMAIN:
1051 case WLAN_EID_FAST_BSS_TRANSITION:
1059 if (ft_validate_mdie(sm, src_addr, ie, mdie) < 0 ||
1060 ft_validate_ftie(sm, src_addr, ie, ftie) < 0 ||
1061 ft_validate_rsnie(sm, src_addr, ie) < 0)
1067 #endif /* CONFIG_IEEE80211R */
1070 static int wpa_supplicant_validate_ie(struct wpa_sm *sm,
1071 const unsigned char *src_addr,
1072 struct wpa_eapol_ie_parse *ie)
1074 if (sm->ap_wpa_ie == NULL && sm->ap_rsn_ie == NULL) {
1075 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1076 "WPA: No WPA/RSN IE for this AP known. "
1077 "Trying to get from scan results");
1078 if (wpa_sm_get_beacon_ie(sm) < 0) {
1079 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1080 "WPA: Could not find AP from "
1081 "the scan results");
1083 wpa_msg(sm->ctx->msg_ctx, MSG_DEBUG,
1084 "WPA: Found the current AP from "
1085 "updated scan results");
1089 if (ie->wpa_ie == NULL && ie->rsn_ie == NULL &&
1090 (sm->ap_wpa_ie || sm->ap_rsn_ie)) {
1091 wpa_report_ie_mismatch(sm, "IE in 3/4 msg does not match "
1092 "with IE in Beacon/ProbeResp (no IE?)",
1093 src_addr, ie->wpa_ie, ie->wpa_ie_len,
1094 ie->rsn_ie, ie->rsn_ie_len);
1098 if ((ie->wpa_ie && sm->ap_wpa_ie &&
1099 (ie->wpa_ie_len != sm->ap_wpa_ie_len ||
1100 os_memcmp(ie->wpa_ie, sm->ap_wpa_ie, ie->wpa_ie_len) != 0)) ||
1101 (ie->rsn_ie && sm->ap_rsn_ie &&
1102 wpa_compare_rsn_ie(wpa_key_mgmt_ft(sm->key_mgmt),
1103 sm->ap_rsn_ie, sm->ap_rsn_ie_len,
1104 ie->rsn_ie, ie->rsn_ie_len))) {
1105 wpa_report_ie_mismatch(sm, "IE in 3/4 msg does not match "
1106 "with IE in Beacon/ProbeResp",
1107 src_addr, ie->wpa_ie, ie->wpa_ie_len,
1108 ie->rsn_ie, ie->rsn_ie_len);
1112 if (sm->proto == WPA_PROTO_WPA &&
1113 ie->rsn_ie && sm->ap_rsn_ie == NULL && sm->rsn_enabled) {
1114 wpa_report_ie_mismatch(sm, "Possible downgrade attack "
1115 "detected - RSN was enabled and RSN IE "
1116 "was in msg 3/4, but not in "
1118 src_addr, ie->wpa_ie, ie->wpa_ie_len,
1119 ie->rsn_ie, ie->rsn_ie_len);
1123 #ifdef CONFIG_IEEE80211R
1124 if (wpa_key_mgmt_ft(sm->key_mgmt) &&
1125 wpa_supplicant_validate_ie_ft(sm, src_addr, ie) < 0)
1127 #endif /* CONFIG_IEEE80211R */
1134 * wpa_supplicant_send_4_of_4 - Send message 4 of WPA/RSN 4-Way Handshake
1135 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1136 * @dst: Destination address for the frame
1137 * @key: Pointer to the EAPOL-Key frame header
1138 * @ver: Version bits from EAPOL-Key Key Info
1139 * @key_info: Key Info
1140 * @ptk: PTK to use for keyed hash and encryption
1141 * Returns: >= 0 on success, < 0 on failure
1143 int wpa_supplicant_send_4_of_4(struct wpa_sm *sm, const unsigned char *dst,
1144 const struct wpa_eapol_key *key,
1145 u16 ver, u16 key_info,
1146 struct wpa_ptk *ptk)
1148 size_t mic_len, hdrlen, rlen;
1149 struct wpa_eapol_key *reply;
1150 struct wpa_eapol_key_192 *reply192;
1153 mic_len = wpa_mic_len(sm->key_mgmt);
1154 hdrlen = mic_len == 24 ? sizeof(*reply192) : sizeof(*reply);
1155 rbuf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_KEY, NULL,
1156 hdrlen, &rlen, (void *) &reply);
1159 reply192 = (struct wpa_eapol_key_192 *) reply;
1161 reply->type = (sm->proto == WPA_PROTO_RSN ||
1162 sm->proto == WPA_PROTO_OSEN) ?
1163 EAPOL_KEY_TYPE_RSN : EAPOL_KEY_TYPE_WPA;
1164 key_info &= WPA_KEY_INFO_SECURE;
1165 key_info |= ver | WPA_KEY_INFO_KEY_TYPE | WPA_KEY_INFO_MIC;
1166 WPA_PUT_BE16(reply->key_info, key_info);
1167 if (sm->proto == WPA_PROTO_RSN || sm->proto == WPA_PROTO_OSEN)
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 key_mic = reply192->key_mic; /* same offset for reply and reply192 */
1176 WPA_PUT_BE16(reply192->key_data_length, 0);
1178 WPA_PUT_BE16(reply->key_data_length, 0);
1180 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: Sending EAPOL-Key 4/4");
1181 return wpa_eapol_key_send(sm, ptk->kck, ptk->kck_len, ver, dst,
1182 ETH_P_EAPOL, rbuf, rlen, key_mic);
1186 static void wpa_supplicant_process_3_of_4(struct wpa_sm *sm,
1187 const struct wpa_eapol_key *key,
1188 u16 ver, const u8 *key_data,
1189 size_t key_data_len)
1191 u16 key_info, keylen;
1192 struct wpa_eapol_ie_parse ie;
1194 wpa_sm_set_state(sm, WPA_4WAY_HANDSHAKE);
1195 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: RX message 3 of 4-Way "
1196 "Handshake from " MACSTR " (ver=%d)", MAC2STR(sm->bssid), ver);
1198 key_info = WPA_GET_BE16(key->key_info);
1200 wpa_hexdump(MSG_DEBUG, "WPA: IE KeyData", key_data, key_data_len);
1201 if (wpa_supplicant_parse_ies(key_data, key_data_len, &ie) < 0)
1203 if (ie.gtk && !(key_info & WPA_KEY_INFO_ENCR_KEY_DATA)) {
1204 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1205 "WPA: GTK IE in unencrypted key data");
1208 #ifdef CONFIG_IEEE80211W
1209 if (ie.igtk && !(key_info & WPA_KEY_INFO_ENCR_KEY_DATA)) {
1210 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1211 "WPA: IGTK KDE in unencrypted key data");
1216 wpa_cipher_valid_mgmt_group(sm->mgmt_group_cipher) &&
1217 ie.igtk_len != WPA_IGTK_KDE_PREFIX_LEN +
1218 (unsigned int) wpa_cipher_key_len(sm->mgmt_group_cipher)) {
1219 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1220 "WPA: Invalid IGTK KDE length %lu",
1221 (unsigned long) ie.igtk_len);
1224 #endif /* CONFIG_IEEE80211W */
1226 if (wpa_supplicant_validate_ie(sm, sm->bssid, &ie) < 0)
1229 if (os_memcmp(sm->anonce, key->key_nonce, WPA_NONCE_LEN) != 0) {
1230 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1231 "WPA: ANonce from message 1 of 4-Way Handshake "
1232 "differs from 3 of 4-Way Handshake - drop packet (src="
1233 MACSTR ")", MAC2STR(sm->bssid));
1237 keylen = WPA_GET_BE16(key->key_length);
1238 if (keylen != wpa_cipher_key_len(sm->pairwise_cipher)) {
1239 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1240 "WPA: Invalid %s key length %d (src=" MACSTR
1241 ")", wpa_cipher_txt(sm->pairwise_cipher), keylen,
1242 MAC2STR(sm->bssid));
1247 if (ie.ip_addr_alloc) {
1248 os_memcpy(sm->p2p_ip_addr, ie.ip_addr_alloc, 3 * 4);
1249 wpa_hexdump(MSG_DEBUG, "P2P: IP address info",
1250 sm->p2p_ip_addr, sizeof(sm->p2p_ip_addr));
1252 #endif /* CONFIG_P2P */
1254 if (wpa_supplicant_send_4_of_4(sm, sm->bssid, key, ver, key_info,
1259 /* SNonce was successfully used in msg 3/4, so mark it to be renewed
1260 * for the next 4-Way Handshake. If msg 3 is received again, the old
1261 * SNonce will still be used to avoid changing PTK. */
1262 sm->renew_snonce = 1;
1264 if (key_info & WPA_KEY_INFO_INSTALL) {
1265 if (wpa_supplicant_install_ptk(sm, key))
1269 if (key_info & WPA_KEY_INFO_SECURE) {
1270 wpa_sm_mlme_setprotection(
1271 sm, sm->bssid, MLME_SETPROTECTION_PROTECT_TYPE_RX,
1272 MLME_SETPROTECTION_KEY_TYPE_PAIRWISE);
1273 eapol_sm_notify_portValid(sm->eapol, TRUE);
1275 wpa_sm_set_state(sm, WPA_GROUP_HANDSHAKE);
1277 if (sm->group_cipher == WPA_CIPHER_GTK_NOT_USED) {
1278 wpa_supplicant_key_neg_complete(sm, sm->bssid,
1279 key_info & WPA_KEY_INFO_SECURE);
1280 } else if (ie.gtk &&
1281 wpa_supplicant_pairwise_gtk(sm, key,
1282 ie.gtk, ie.gtk_len, key_info) < 0) {
1283 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1284 "RSN: Failed to configure GTK");
1288 if (ieee80211w_set_keys(sm, &ie) < 0) {
1289 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1290 "RSN: Failed to configure IGTK");
1295 wpa_sm_set_rekey_offload(sm);
1297 if (sm->proto == WPA_PROTO_RSN && wpa_key_mgmt_suite_b(sm->key_mgmt)) {
1298 struct rsn_pmksa_cache_entry *sa;
1300 sa = pmksa_cache_add(sm->pmksa, sm->pmk, sm->pmk_len, NULL,
1301 sm->ptk.kck, sm->ptk.kck_len,
1302 sm->bssid, sm->own_addr,
1303 sm->network_ctx, sm->key_mgmt);
1308 sm->msg_3_of_4_ok = 1;
1312 wpa_sm_deauthenticate(sm, WLAN_REASON_UNSPECIFIED);
1316 static int wpa_supplicant_process_1_of_2_rsn(struct wpa_sm *sm,
1320 struct wpa_gtk_data *gd)
1323 struct wpa_eapol_ie_parse ie;
1325 wpa_hexdump(MSG_DEBUG, "RSN: msg 1/2 key data", keydata, keydatalen);
1326 if (wpa_supplicant_parse_ies(keydata, keydatalen, &ie) < 0)
1328 if (ie.gtk && !(key_info & WPA_KEY_INFO_ENCR_KEY_DATA)) {
1329 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1330 "WPA: GTK IE in unencrypted key data");
1333 if (ie.gtk == NULL) {
1334 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1335 "WPA: No GTK IE in Group Key msg 1/2");
1338 maxkeylen = gd->gtk_len = ie.gtk_len - 2;
1340 if (wpa_supplicant_check_group_cipher(sm, sm->group_cipher,
1341 gd->gtk_len, maxkeylen,
1342 &gd->key_rsc_len, &gd->alg))
1345 wpa_hexdump_key(MSG_DEBUG, "RSN: received GTK in group key handshake",
1346 ie.gtk, ie.gtk_len);
1347 gd->keyidx = ie.gtk[0] & 0x3;
1348 gd->tx = wpa_supplicant_gtk_tx_bit_workaround(sm,
1349 !!(ie.gtk[0] & BIT(2)));
1350 if (ie.gtk_len - 2 > sizeof(gd->gtk)) {
1351 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1352 "RSN: Too long GTK in GTK IE (len=%lu)",
1353 (unsigned long) ie.gtk_len - 2);
1356 os_memcpy(gd->gtk, ie.gtk + 2, ie.gtk_len - 2);
1358 if (ieee80211w_set_keys(sm, &ie) < 0)
1359 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1360 "RSN: Failed to configure IGTK");
1366 static int wpa_supplicant_process_1_of_2_wpa(struct wpa_sm *sm,
1367 const struct wpa_eapol_key *key,
1369 size_t key_data_len, u16 key_info,
1370 u16 ver, struct wpa_gtk_data *gd)
1375 gtk_len = WPA_GET_BE16(key->key_length);
1376 maxkeylen = key_data_len;
1377 if (ver == WPA_KEY_INFO_TYPE_HMAC_SHA1_AES) {
1378 if (maxkeylen < 8) {
1379 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1380 "WPA: Too short maxkeylen (%lu)",
1381 (unsigned long) maxkeylen);
1387 if (gtk_len > maxkeylen ||
1388 wpa_supplicant_check_group_cipher(sm, sm->group_cipher,
1390 &gd->key_rsc_len, &gd->alg))
1393 gd->gtk_len = gtk_len;
1394 gd->keyidx = (key_info & WPA_KEY_INFO_KEY_INDEX_MASK) >>
1395 WPA_KEY_INFO_KEY_INDEX_SHIFT;
1396 if (ver == WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 && sm->ptk.kek_len == 16) {
1397 #ifdef CONFIG_NO_RC4
1398 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1399 "WPA: RC4 not supported in the build");
1401 #else /* CONFIG_NO_RC4 */
1403 if (key_data_len > sizeof(gd->gtk)) {
1404 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1405 "WPA: RC4 key data too long (%lu)",
1406 (unsigned long) key_data_len);
1409 os_memcpy(ek, key->key_iv, 16);
1410 os_memcpy(ek + 16, sm->ptk.kek, sm->ptk.kek_len);
1411 os_memcpy(gd->gtk, key_data, key_data_len);
1412 if (rc4_skip(ek, 32, 256, gd->gtk, key_data_len)) {
1413 os_memset(ek, 0, sizeof(ek));
1414 wpa_msg(sm->ctx->msg_ctx, MSG_ERROR,
1418 os_memset(ek, 0, sizeof(ek));
1419 #endif /* CONFIG_NO_RC4 */
1420 } else if (ver == WPA_KEY_INFO_TYPE_HMAC_SHA1_AES) {
1421 if (maxkeylen % 8) {
1422 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1423 "WPA: Unsupported AES-WRAP len %lu",
1424 (unsigned long) maxkeylen);
1427 if (maxkeylen > sizeof(gd->gtk)) {
1428 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1429 "WPA: AES-WRAP key data "
1430 "too long (keydatalen=%lu maxkeylen=%lu)",
1431 (unsigned long) key_data_len,
1432 (unsigned long) maxkeylen);
1435 if (aes_unwrap(sm->ptk.kek, sm->ptk.kek_len, maxkeylen / 8,
1436 key_data, gd->gtk)) {
1437 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1438 "WPA: AES unwrap failed - could not decrypt "
1443 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1444 "WPA: Unsupported key_info type %d", ver);
1447 gd->tx = wpa_supplicant_gtk_tx_bit_workaround(
1448 sm, !!(key_info & WPA_KEY_INFO_TXRX));
1453 static int wpa_supplicant_send_2_of_2(struct wpa_sm *sm,
1454 const struct wpa_eapol_key *key,
1455 int ver, u16 key_info)
1457 size_t mic_len, hdrlen, rlen;
1458 struct wpa_eapol_key *reply;
1459 struct wpa_eapol_key_192 *reply192;
1462 mic_len = wpa_mic_len(sm->key_mgmt);
1463 hdrlen = mic_len == 24 ? sizeof(*reply192) : sizeof(*reply);
1464 rbuf = wpa_sm_alloc_eapol(sm, IEEE802_1X_TYPE_EAPOL_KEY, NULL,
1465 hdrlen, &rlen, (void *) &reply);
1468 reply192 = (struct wpa_eapol_key_192 *) reply;
1470 reply->type = (sm->proto == WPA_PROTO_RSN ||
1471 sm->proto == WPA_PROTO_OSEN) ?
1472 EAPOL_KEY_TYPE_RSN : EAPOL_KEY_TYPE_WPA;
1473 key_info &= WPA_KEY_INFO_KEY_INDEX_MASK;
1474 key_info |= ver | WPA_KEY_INFO_MIC | WPA_KEY_INFO_SECURE;
1475 WPA_PUT_BE16(reply->key_info, key_info);
1476 if (sm->proto == WPA_PROTO_RSN || sm->proto == WPA_PROTO_OSEN)
1477 WPA_PUT_BE16(reply->key_length, 0);
1479 os_memcpy(reply->key_length, key->key_length, 2);
1480 os_memcpy(reply->replay_counter, key->replay_counter,
1481 WPA_REPLAY_COUNTER_LEN);
1483 key_mic = reply192->key_mic; /* same offset for reply and reply192 */
1485 WPA_PUT_BE16(reply192->key_data_length, 0);
1487 WPA_PUT_BE16(reply->key_data_length, 0);
1489 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: Sending EAPOL-Key 2/2");
1490 return wpa_eapol_key_send(sm, sm->ptk.kck, sm->ptk.kck_len, ver,
1491 sm->bssid, ETH_P_EAPOL, rbuf, rlen, key_mic);
1495 static void wpa_supplicant_process_1_of_2(struct wpa_sm *sm,
1496 const unsigned char *src_addr,
1497 const struct wpa_eapol_key *key,
1499 size_t key_data_len, u16 ver)
1503 struct wpa_gtk_data gd;
1506 if (!sm->msg_3_of_4_ok) {
1507 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1508 "WPA: Group Key Handshake started prior to completion of 4-way handshake");
1512 os_memset(&gd, 0, sizeof(gd));
1514 rekey = wpa_sm_get_state(sm) == WPA_COMPLETED;
1515 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: RX message 1 of Group Key "
1516 "Handshake from " MACSTR " (ver=%d)", MAC2STR(src_addr), ver);
1518 key_info = WPA_GET_BE16(key->key_info);
1520 if (sm->proto == WPA_PROTO_RSN || sm->proto == WPA_PROTO_OSEN) {
1521 ret = wpa_supplicant_process_1_of_2_rsn(sm, key_data,
1522 key_data_len, key_info,
1525 ret = wpa_supplicant_process_1_of_2_wpa(sm, key, key_data,
1527 key_info, ver, &gd);
1530 wpa_sm_set_state(sm, WPA_GROUP_HANDSHAKE);
1535 key_rsc = key->key_rsc;
1536 if (wpa_supplicant_rsc_relaxation(sm, key->key_rsc))
1539 if (wpa_supplicant_install_gtk(sm, &gd, key_rsc) ||
1540 wpa_supplicant_send_2_of_2(sm, key, ver, key_info) < 0)
1542 os_memset(&gd, 0, sizeof(gd));
1545 wpa_msg(sm->ctx->msg_ctx, MSG_INFO, "WPA: Group rekeying "
1546 "completed with " MACSTR " [GTK=%s]",
1547 MAC2STR(sm->bssid), wpa_cipher_txt(sm->group_cipher));
1548 wpa_sm_cancel_auth_timeout(sm);
1549 wpa_sm_set_state(sm, WPA_COMPLETED);
1551 wpa_supplicant_key_neg_complete(sm, sm->bssid,
1553 WPA_KEY_INFO_SECURE);
1556 wpa_sm_set_rekey_offload(sm);
1561 os_memset(&gd, 0, sizeof(gd));
1562 wpa_sm_deauthenticate(sm, WLAN_REASON_UNSPECIFIED);
1566 static int wpa_supplicant_verify_eapol_key_mic(struct wpa_sm *sm,
1567 struct wpa_eapol_key_192 *key,
1569 const u8 *buf, size_t len)
1571 u8 mic[WPA_EAPOL_KEY_MIC_MAX_LEN];
1573 size_t mic_len = wpa_mic_len(sm->key_mgmt);
1575 os_memcpy(mic, key->key_mic, mic_len);
1577 os_memset(key->key_mic, 0, mic_len);
1578 wpa_eapol_key_mic(sm->tptk.kck, sm->tptk.kck_len, sm->key_mgmt,
1579 ver, buf, len, key->key_mic);
1580 if (os_memcmp_const(mic, key->key_mic, mic_len) != 0) {
1581 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1582 "WPA: Invalid EAPOL-Key MIC "
1583 "when using TPTK - ignoring TPTK");
1588 os_memcpy(&sm->ptk, &sm->tptk, sizeof(sm->ptk));
1589 os_memset(&sm->tptk, 0, sizeof(sm->tptk));
1593 if (!ok && sm->ptk_set) {
1594 os_memset(key->key_mic, 0, mic_len);
1595 wpa_eapol_key_mic(sm->ptk.kck, sm->ptk.kck_len, sm->key_mgmt,
1596 ver, buf, len, key->key_mic);
1597 if (os_memcmp_const(mic, key->key_mic, mic_len) != 0) {
1598 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1599 "WPA: Invalid EAPOL-Key MIC - "
1607 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1608 "WPA: Could not verify EAPOL-Key MIC - "
1613 os_memcpy(sm->rx_replay_counter, key->replay_counter,
1614 WPA_REPLAY_COUNTER_LEN);
1615 sm->rx_replay_counter_set = 1;
1620 /* Decrypt RSN EAPOL-Key key data (RC4 or AES-WRAP) */
1621 static int wpa_supplicant_decrypt_key_data(struct wpa_sm *sm,
1622 struct wpa_eapol_key *key, u16 ver,
1623 u8 *key_data, size_t *key_data_len)
1625 wpa_hexdump(MSG_DEBUG, "RSN: encrypted key data",
1626 key_data, *key_data_len);
1628 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1629 "WPA: PTK not available, cannot decrypt EAPOL-Key Key "
1634 /* Decrypt key data here so that this operation does not need
1635 * to be implemented separately for each message type. */
1636 if (ver == WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 && sm->ptk.kek_len == 16) {
1637 #ifdef CONFIG_NO_RC4
1638 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1639 "WPA: RC4 not supported in the build");
1641 #else /* CONFIG_NO_RC4 */
1643 os_memcpy(ek, key->key_iv, 16);
1644 os_memcpy(ek + 16, sm->ptk.kek, sm->ptk.kek_len);
1645 if (rc4_skip(ek, 32, 256, key_data, *key_data_len)) {
1646 os_memset(ek, 0, sizeof(ek));
1647 wpa_msg(sm->ctx->msg_ctx, MSG_ERROR,
1651 os_memset(ek, 0, sizeof(ek));
1652 #endif /* CONFIG_NO_RC4 */
1653 } else if (ver == WPA_KEY_INFO_TYPE_HMAC_SHA1_AES ||
1654 ver == WPA_KEY_INFO_TYPE_AES_128_CMAC ||
1655 sm->key_mgmt == WPA_KEY_MGMT_OSEN ||
1656 wpa_key_mgmt_suite_b(sm->key_mgmt)) {
1658 if (*key_data_len < 8 || *key_data_len % 8) {
1659 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1660 "WPA: Unsupported AES-WRAP len %u",
1661 (unsigned int) *key_data_len);
1664 *key_data_len -= 8; /* AES-WRAP adds 8 bytes */
1665 buf = os_malloc(*key_data_len);
1667 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1668 "WPA: No memory for AES-UNWRAP buffer");
1671 if (aes_unwrap(sm->ptk.kek, sm->ptk.kek_len, *key_data_len / 8,
1673 bin_clear_free(buf, *key_data_len);
1674 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1675 "WPA: AES unwrap failed - "
1676 "could not decrypt EAPOL-Key key data");
1679 os_memcpy(key_data, buf, *key_data_len);
1680 bin_clear_free(buf, *key_data_len);
1681 WPA_PUT_BE16(key->key_data_length, *key_data_len);
1683 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1684 "WPA: Unsupported key_info type %d", ver);
1687 wpa_hexdump_key(MSG_DEBUG, "WPA: decrypted EAPOL-Key key data",
1688 key_data, *key_data_len);
1694 * wpa_sm_aborted_cached - Notify WPA that PMKSA caching was aborted
1695 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1697 void wpa_sm_aborted_cached(struct wpa_sm *sm)
1699 if (sm && sm->cur_pmksa) {
1700 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1701 "RSN: Cancelling PMKSA caching attempt");
1702 sm->cur_pmksa = NULL;
1707 static void wpa_eapol_key_dump(struct wpa_sm *sm,
1708 const struct wpa_eapol_key *key,
1709 unsigned int key_data_len,
1710 const u8 *mic, unsigned int mic_len)
1712 #ifndef CONFIG_NO_STDOUT_DEBUG
1713 u16 key_info = WPA_GET_BE16(key->key_info);
1715 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, " EAPOL-Key type=%d", key->type);
1716 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1717 " key_info 0x%x (ver=%d keyidx=%d rsvd=%d %s%s%s%s%s%s%s%s)",
1718 key_info, key_info & WPA_KEY_INFO_TYPE_MASK,
1719 (key_info & WPA_KEY_INFO_KEY_INDEX_MASK) >>
1720 WPA_KEY_INFO_KEY_INDEX_SHIFT,
1721 (key_info & (BIT(13) | BIT(14) | BIT(15))) >> 13,
1722 key_info & WPA_KEY_INFO_KEY_TYPE ? "Pairwise" : "Group",
1723 key_info & WPA_KEY_INFO_INSTALL ? " Install" : "",
1724 key_info & WPA_KEY_INFO_ACK ? " Ack" : "",
1725 key_info & WPA_KEY_INFO_MIC ? " MIC" : "",
1726 key_info & WPA_KEY_INFO_SECURE ? " Secure" : "",
1727 key_info & WPA_KEY_INFO_ERROR ? " Error" : "",
1728 key_info & WPA_KEY_INFO_REQUEST ? " Request" : "",
1729 key_info & WPA_KEY_INFO_ENCR_KEY_DATA ? " Encr" : "");
1730 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1731 " key_length=%u key_data_length=%u",
1732 WPA_GET_BE16(key->key_length), key_data_len);
1733 wpa_hexdump(MSG_DEBUG, " replay_counter",
1734 key->replay_counter, WPA_REPLAY_COUNTER_LEN);
1735 wpa_hexdump(MSG_DEBUG, " key_nonce", key->key_nonce, WPA_NONCE_LEN);
1736 wpa_hexdump(MSG_DEBUG, " key_iv", key->key_iv, 16);
1737 wpa_hexdump(MSG_DEBUG, " key_rsc", key->key_rsc, 8);
1738 wpa_hexdump(MSG_DEBUG, " key_id (reserved)", key->key_id, 8);
1739 wpa_hexdump(MSG_DEBUG, " key_mic", mic, mic_len);
1740 #endif /* CONFIG_NO_STDOUT_DEBUG */
1745 * wpa_sm_rx_eapol - Process received WPA EAPOL frames
1746 * @sm: Pointer to WPA state machine data from wpa_sm_init()
1747 * @src_addr: Source MAC address of the EAPOL packet
1748 * @buf: Pointer to the beginning of the EAPOL data (EAPOL header)
1749 * @len: Length of the EAPOL frame
1750 * Returns: 1 = WPA EAPOL-Key processed, 0 = not a WPA EAPOL-Key, -1 failure
1752 * This function is called for each received EAPOL frame. Other than EAPOL-Key
1753 * frames can be skipped if filtering is done elsewhere. wpa_sm_rx_eapol() is
1754 * only processing WPA and WPA2 EAPOL-Key frames.
1756 * The received EAPOL-Key packets are validated and valid packets are replied
1757 * to. In addition, key material (PTK, GTK) is configured at the end of a
1758 * successful key handshake.
1760 int wpa_sm_rx_eapol(struct wpa_sm *sm, const u8 *src_addr,
1761 const u8 *buf, size_t len)
1763 size_t plen, data_len, key_data_len;
1764 const struct ieee802_1x_hdr *hdr;
1765 struct wpa_eapol_key *key;
1766 struct wpa_eapol_key_192 *key192;
1770 struct wpa_peerkey *peerkey = NULL;
1772 size_t mic_len, keyhdrlen;
1774 #ifdef CONFIG_IEEE80211R
1775 sm->ft_completed = 0;
1776 #endif /* CONFIG_IEEE80211R */
1778 mic_len = wpa_mic_len(sm->key_mgmt);
1779 keyhdrlen = mic_len == 24 ? sizeof(*key192) : sizeof(*key);
1781 if (len < sizeof(*hdr) + keyhdrlen) {
1782 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1783 "WPA: EAPOL frame too short to be a WPA "
1784 "EAPOL-Key (len %lu, expecting at least %lu)",
1785 (unsigned long) len,
1786 (unsigned long) sizeof(*hdr) + keyhdrlen);
1790 hdr = (const struct ieee802_1x_hdr *) buf;
1791 plen = be_to_host16(hdr->length);
1792 data_len = plen + sizeof(*hdr);
1793 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1794 "IEEE 802.1X RX: version=%d type=%d length=%lu",
1795 hdr->version, hdr->type, (unsigned long) plen);
1797 if (hdr->version < EAPOL_VERSION) {
1798 /* TODO: backwards compatibility */
1800 if (hdr->type != IEEE802_1X_TYPE_EAPOL_KEY) {
1801 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1802 "WPA: EAPOL frame (type %u) discarded, "
1803 "not a Key frame", hdr->type);
1807 wpa_hexdump(MSG_MSGDUMP, "WPA: RX EAPOL-Key", buf, len);
1808 if (plen > len - sizeof(*hdr) || plen < keyhdrlen) {
1809 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1810 "WPA: EAPOL frame payload size %lu "
1811 "invalid (frame size %lu)",
1812 (unsigned long) plen, (unsigned long) len);
1816 if (data_len < len) {
1817 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1818 "WPA: ignoring %lu bytes after the IEEE 802.1X data",
1819 (unsigned long) len - data_len);
1823 * Make a copy of the frame since we need to modify the buffer during
1824 * MAC validation and Key Data decryption.
1826 tmp = os_malloc(data_len);
1829 os_memcpy(tmp, buf, data_len);
1830 key = (struct wpa_eapol_key *) (tmp + sizeof(struct ieee802_1x_hdr));
1831 key192 = (struct wpa_eapol_key_192 *)
1832 (tmp + sizeof(struct ieee802_1x_hdr));
1834 key_data = (u8 *) (key192 + 1);
1836 key_data = (u8 *) (key + 1);
1838 if (key->type != EAPOL_KEY_TYPE_WPA && key->type != EAPOL_KEY_TYPE_RSN)
1840 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1841 "WPA: EAPOL-Key type (%d) unknown, discarded",
1848 key_data_len = WPA_GET_BE16(key192->key_data_length);
1850 key_data_len = WPA_GET_BE16(key->key_data_length);
1851 wpa_eapol_key_dump(sm, key, key_data_len, key192->key_mic, mic_len);
1853 if (key_data_len > plen - keyhdrlen) {
1854 wpa_msg(sm->ctx->msg_ctx, MSG_INFO, "WPA: Invalid EAPOL-Key "
1855 "frame - key_data overflow (%u > %u)",
1856 (unsigned int) key_data_len,
1857 (unsigned int) (plen - keyhdrlen));
1861 eapol_sm_notify_lower_layer_success(sm->eapol, 0);
1862 key_info = WPA_GET_BE16(key->key_info);
1863 ver = key_info & WPA_KEY_INFO_TYPE_MASK;
1864 if (ver != WPA_KEY_INFO_TYPE_HMAC_MD5_RC4 &&
1865 #if defined(CONFIG_IEEE80211R) || defined(CONFIG_IEEE80211W)
1866 ver != WPA_KEY_INFO_TYPE_AES_128_CMAC &&
1867 #endif /* CONFIG_IEEE80211R || CONFIG_IEEE80211W */
1868 ver != WPA_KEY_INFO_TYPE_HMAC_SHA1_AES &&
1869 !wpa_key_mgmt_suite_b(sm->key_mgmt) &&
1870 sm->key_mgmt != WPA_KEY_MGMT_OSEN) {
1871 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1872 "WPA: Unsupported EAPOL-Key descriptor version %d",
1877 if (sm->key_mgmt == WPA_KEY_MGMT_OSEN &&
1878 ver != WPA_KEY_INFO_TYPE_AKM_DEFINED) {
1879 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1880 "OSEN: Unsupported EAPOL-Key descriptor version %d",
1885 if (wpa_key_mgmt_suite_b(sm->key_mgmt) &&
1886 ver != WPA_KEY_INFO_TYPE_AKM_DEFINED) {
1887 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1888 "RSN: Unsupported EAPOL-Key descriptor version %d (expected AKM defined = 0)",
1893 #ifdef CONFIG_IEEE80211R
1894 if (wpa_key_mgmt_ft(sm->key_mgmt)) {
1895 /* IEEE 802.11r uses a new key_info type (AES-128-CMAC). */
1896 if (ver != WPA_KEY_INFO_TYPE_AES_128_CMAC) {
1897 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1898 "FT: AP did not use AES-128-CMAC");
1902 #endif /* CONFIG_IEEE80211R */
1903 #ifdef CONFIG_IEEE80211W
1904 if (wpa_key_mgmt_sha256(sm->key_mgmt)) {
1905 if (ver != WPA_KEY_INFO_TYPE_AES_128_CMAC &&
1906 sm->key_mgmt != WPA_KEY_MGMT_OSEN &&
1907 !wpa_key_mgmt_suite_b(sm->key_mgmt)) {
1908 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1909 "WPA: AP did not use the "
1910 "negotiated AES-128-CMAC");
1914 #endif /* CONFIG_IEEE80211W */
1915 if (sm->pairwise_cipher == WPA_CIPHER_CCMP &&
1916 !wpa_key_mgmt_suite_b(sm->key_mgmt) &&
1917 ver != WPA_KEY_INFO_TYPE_HMAC_SHA1_AES) {
1918 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1919 "WPA: CCMP is used, but EAPOL-Key "
1920 "descriptor version (%d) is not 2", ver);
1921 if (sm->group_cipher != WPA_CIPHER_CCMP &&
1922 !(key_info & WPA_KEY_INFO_KEY_TYPE)) {
1923 /* Earlier versions of IEEE 802.11i did not explicitly
1924 * require version 2 descriptor for all EAPOL-Key
1925 * packets, so allow group keys to use version 1 if
1926 * CCMP is not used for them. */
1927 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1928 "WPA: Backwards compatibility: allow invalid "
1929 "version for non-CCMP group keys");
1930 } else if (ver == WPA_KEY_INFO_TYPE_AES_128_CMAC) {
1931 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1932 "WPA: Interoperability workaround: allow incorrect (should have been HMAC-SHA1), but stronger (is AES-128-CMAC), descriptor version to be used");
1935 } else if (sm->pairwise_cipher == WPA_CIPHER_GCMP &&
1936 !wpa_key_mgmt_suite_b(sm->key_mgmt) &&
1937 ver != WPA_KEY_INFO_TYPE_HMAC_SHA1_AES) {
1938 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1939 "WPA: GCMP is used, but EAPOL-Key "
1940 "descriptor version (%d) is not 2", ver);
1944 #ifdef CONFIG_PEERKEY
1945 for (peerkey = sm->peerkey; peerkey; peerkey = peerkey->next) {
1946 if (os_memcmp(peerkey->addr, src_addr, ETH_ALEN) == 0)
1950 if (!(key_info & WPA_KEY_INFO_SMK_MESSAGE) && peerkey) {
1951 if (!peerkey->initiator && peerkey->replay_counter_set &&
1952 os_memcmp(key->replay_counter, peerkey->replay_counter,
1953 WPA_REPLAY_COUNTER_LEN) <= 0) {
1954 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1955 "RSN: EAPOL-Key Replay Counter did not "
1956 "increase (STK) - dropping packet");
1958 } else if (peerkey->initiator) {
1959 u8 _tmp[WPA_REPLAY_COUNTER_LEN];
1960 os_memcpy(_tmp, key->replay_counter,
1961 WPA_REPLAY_COUNTER_LEN);
1962 inc_byte_array(_tmp, WPA_REPLAY_COUNTER_LEN);
1963 if (os_memcmp(_tmp, peerkey->replay_counter,
1964 WPA_REPLAY_COUNTER_LEN) != 0) {
1965 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
1966 "RSN: EAPOL-Key Replay "
1967 "Counter did not match (STK) - "
1974 if (peerkey && peerkey->initiator && (key_info & WPA_KEY_INFO_ACK)) {
1975 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1976 "RSN: Ack bit in key_info from STK peer");
1979 #endif /* CONFIG_PEERKEY */
1981 if (!peerkey && sm->rx_replay_counter_set &&
1982 os_memcmp(key->replay_counter, sm->rx_replay_counter,
1983 WPA_REPLAY_COUNTER_LEN) <= 0) {
1984 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
1985 "WPA: EAPOL-Key Replay Counter did not increase - "
1990 if (!(key_info & (WPA_KEY_INFO_ACK | WPA_KEY_INFO_SMK_MESSAGE))
1991 #ifdef CONFIG_PEERKEY
1992 && (peerkey == NULL || !peerkey->initiator)
1993 #endif /* CONFIG_PEERKEY */
1995 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
1996 "WPA: No Ack bit in key_info");
2000 if (key_info & WPA_KEY_INFO_REQUEST) {
2001 wpa_msg(sm->ctx->msg_ctx, MSG_INFO,
2002 "WPA: EAPOL-Key with Request bit - dropped");
2006 if ((key_info & WPA_KEY_INFO_MIC) && !peerkey &&
2007 wpa_supplicant_verify_eapol_key_mic(sm, key192, ver, tmp, data_len))
2010 #ifdef CONFIG_PEERKEY
2011 if ((key_info & WPA_KEY_INFO_MIC) && peerkey &&
2012 peerkey_verify_eapol_key_mic(sm, peerkey, key192, ver, tmp,
2015 #endif /* CONFIG_PEERKEY */
2017 if ((sm->proto == WPA_PROTO_RSN || sm->proto == WPA_PROTO_OSEN) &&
2018 (key_info & WPA_KEY_INFO_ENCR_KEY_DATA)) {
2019 if (wpa_supplicant_decrypt_key_data(sm, key, ver, key_data,
2024 if (key_info & WPA_KEY_INFO_KEY_TYPE) {
2025 if (key_info & WPA_KEY_INFO_KEY_INDEX_MASK) {
2026 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
2027 "WPA: Ignored EAPOL-Key (Pairwise) with "
2028 "non-zero key index");
2032 /* PeerKey 4-Way Handshake */
2033 peerkey_rx_eapol_4way(sm, peerkey, key, key_info, ver,
2034 key_data, key_data_len);
2035 } else if (key_info & WPA_KEY_INFO_MIC) {
2036 /* 3/4 4-Way Handshake */
2037 wpa_supplicant_process_3_of_4(sm, key, ver, key_data,
2040 /* 1/4 4-Way Handshake */
2041 wpa_supplicant_process_1_of_4(sm, src_addr, key,
2045 } else if (key_info & WPA_KEY_INFO_SMK_MESSAGE) {
2046 /* PeerKey SMK Handshake */
2047 peerkey_rx_eapol_smk(sm, src_addr, key, key_data_len, key_info,
2050 if (key_info & WPA_KEY_INFO_MIC) {
2051 /* 1/2 Group Key Handshake */
2052 wpa_supplicant_process_1_of_2(sm, src_addr, key,
2053 key_data, key_data_len,
2056 wpa_msg(sm->ctx->msg_ctx, MSG_WARNING,
2057 "WPA: EAPOL-Key (Group) without Mic bit - "
2065 bin_clear_free(tmp, data_len);
2070 #ifdef CONFIG_CTRL_IFACE
2071 static u32 wpa_key_mgmt_suite(struct wpa_sm *sm)
2073 switch (sm->key_mgmt) {
2074 case WPA_KEY_MGMT_IEEE8021X:
2075 return ((sm->proto == WPA_PROTO_RSN ||
2076 sm->proto == WPA_PROTO_OSEN) ?
2077 RSN_AUTH_KEY_MGMT_UNSPEC_802_1X :
2078 WPA_AUTH_KEY_MGMT_UNSPEC_802_1X);
2079 case WPA_KEY_MGMT_PSK:
2080 return (sm->proto == WPA_PROTO_RSN ?
2081 RSN_AUTH_KEY_MGMT_PSK_OVER_802_1X :
2082 WPA_AUTH_KEY_MGMT_PSK_OVER_802_1X);
2083 #ifdef CONFIG_IEEE80211R
2084 case WPA_KEY_MGMT_FT_IEEE8021X:
2085 return RSN_AUTH_KEY_MGMT_FT_802_1X;
2086 case WPA_KEY_MGMT_FT_PSK:
2087 return RSN_AUTH_KEY_MGMT_FT_PSK;
2088 #endif /* CONFIG_IEEE80211R */
2089 #ifdef CONFIG_IEEE80211W
2090 case WPA_KEY_MGMT_IEEE8021X_SHA256:
2091 return RSN_AUTH_KEY_MGMT_802_1X_SHA256;
2092 case WPA_KEY_MGMT_PSK_SHA256:
2093 return RSN_AUTH_KEY_MGMT_PSK_SHA256;
2094 #endif /* CONFIG_IEEE80211W */
2095 case WPA_KEY_MGMT_CCKM:
2096 return (sm->proto == WPA_PROTO_RSN ?
2097 RSN_AUTH_KEY_MGMT_CCKM:
2098 WPA_AUTH_KEY_MGMT_CCKM);
2099 case WPA_KEY_MGMT_WPA_NONE:
2100 return WPA_AUTH_KEY_MGMT_NONE;
2101 case WPA_KEY_MGMT_IEEE8021X_SUITE_B:
2102 return RSN_AUTH_KEY_MGMT_802_1X_SUITE_B;
2103 case WPA_KEY_MGMT_IEEE8021X_SUITE_B_192:
2104 return RSN_AUTH_KEY_MGMT_802_1X_SUITE_B_192;
2111 #define RSN_SUITE "%02x-%02x-%02x-%d"
2112 #define RSN_SUITE_ARG(s) \
2113 ((s) >> 24) & 0xff, ((s) >> 16) & 0xff, ((s) >> 8) & 0xff, (s) & 0xff
2116 * wpa_sm_get_mib - Dump text list of MIB entries
2117 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2118 * @buf: Buffer for the list
2119 * @buflen: Length of the buffer
2120 * Returns: Number of bytes written to buffer
2122 * This function is used fetch dot11 MIB variables.
2124 int wpa_sm_get_mib(struct wpa_sm *sm, char *buf, size_t buflen)
2126 char pmkid_txt[PMKID_LEN * 2 + 1];
2130 if (sm->cur_pmksa) {
2131 wpa_snprintf_hex(pmkid_txt, sizeof(pmkid_txt),
2132 sm->cur_pmksa->pmkid, PMKID_LEN);
2134 pmkid_txt[0] = '\0';
2136 if ((wpa_key_mgmt_wpa_psk(sm->key_mgmt) ||
2137 wpa_key_mgmt_wpa_ieee8021x(sm->key_mgmt)) &&
2138 sm->proto == WPA_PROTO_RSN)
2143 ret = os_snprintf(buf, buflen,
2144 "dot11RSNAOptionImplemented=TRUE\n"
2145 "dot11RSNAPreauthenticationImplemented=TRUE\n"
2146 "dot11RSNAEnabled=%s\n"
2147 "dot11RSNAPreauthenticationEnabled=%s\n"
2148 "dot11RSNAConfigVersion=%d\n"
2149 "dot11RSNAConfigPairwiseKeysSupported=5\n"
2150 "dot11RSNAConfigGroupCipherSize=%d\n"
2151 "dot11RSNAConfigPMKLifetime=%d\n"
2152 "dot11RSNAConfigPMKReauthThreshold=%d\n"
2153 "dot11RSNAConfigNumberOfPTKSAReplayCounters=1\n"
2154 "dot11RSNAConfigSATimeout=%d\n",
2155 rsna ? "TRUE" : "FALSE",
2156 rsna ? "TRUE" : "FALSE",
2158 wpa_cipher_key_len(sm->group_cipher) * 8,
2159 sm->dot11RSNAConfigPMKLifetime,
2160 sm->dot11RSNAConfigPMKReauthThreshold,
2161 sm->dot11RSNAConfigSATimeout);
2162 if (os_snprintf_error(buflen, ret))
2167 buf + len, buflen - len,
2168 "dot11RSNAAuthenticationSuiteSelected=" RSN_SUITE "\n"
2169 "dot11RSNAPairwiseCipherSelected=" RSN_SUITE "\n"
2170 "dot11RSNAGroupCipherSelected=" RSN_SUITE "\n"
2171 "dot11RSNAPMKIDUsed=%s\n"
2172 "dot11RSNAAuthenticationSuiteRequested=" RSN_SUITE "\n"
2173 "dot11RSNAPairwiseCipherRequested=" RSN_SUITE "\n"
2174 "dot11RSNAGroupCipherRequested=" RSN_SUITE "\n"
2175 "dot11RSNAConfigNumberOfGTKSAReplayCounters=0\n"
2176 "dot11RSNA4WayHandshakeFailures=%u\n",
2177 RSN_SUITE_ARG(wpa_key_mgmt_suite(sm)),
2178 RSN_SUITE_ARG(wpa_cipher_to_suite(sm->proto,
2179 sm->pairwise_cipher)),
2180 RSN_SUITE_ARG(wpa_cipher_to_suite(sm->proto,
2183 RSN_SUITE_ARG(wpa_key_mgmt_suite(sm)),
2184 RSN_SUITE_ARG(wpa_cipher_to_suite(sm->proto,
2185 sm->pairwise_cipher)),
2186 RSN_SUITE_ARG(wpa_cipher_to_suite(sm->proto,
2188 sm->dot11RSNA4WayHandshakeFailures);
2189 if (!os_snprintf_error(buflen - len, ret))
2194 #endif /* CONFIG_CTRL_IFACE */
2197 static void wpa_sm_pmksa_free_cb(struct rsn_pmksa_cache_entry *entry,
2198 void *ctx, enum pmksa_free_reason reason)
2200 struct wpa_sm *sm = ctx;
2203 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "RSN: PMKSA cache entry free_cb: "
2204 MACSTR " reason=%d", MAC2STR(entry->aa), reason);
2206 if (sm->cur_pmksa == entry) {
2207 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
2208 "RSN: %s current PMKSA entry",
2209 reason == PMKSA_REPLACE ? "replaced" : "removed");
2210 pmksa_cache_clear_current(sm);
2213 * If an entry is simply being replaced, there's no need to
2214 * deauthenticate because it will be immediately re-added.
2215 * This happens when EAP authentication is completed again
2216 * (reauth or failed PMKSA caching attempt).
2218 if (reason != PMKSA_REPLACE)
2222 if (reason == PMKSA_EXPIRE &&
2223 (sm->pmk_len == entry->pmk_len &&
2224 os_memcmp(sm->pmk, entry->pmk, sm->pmk_len) == 0)) {
2225 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
2226 "RSN: deauthenticating due to expired PMK");
2227 pmksa_cache_clear_current(sm);
2232 os_memset(sm->pmk, 0, sizeof(sm->pmk));
2233 wpa_sm_deauthenticate(sm, WLAN_REASON_UNSPECIFIED);
2239 * wpa_sm_init - Initialize WPA state machine
2240 * @ctx: Context pointer for callbacks; this needs to be an allocated buffer
2241 * Returns: Pointer to the allocated WPA state machine data
2243 * This function is used to allocate a new WPA state machine and the returned
2244 * value is passed to all WPA state machine calls.
2246 struct wpa_sm * wpa_sm_init(struct wpa_sm_ctx *ctx)
2250 sm = os_zalloc(sizeof(*sm));
2253 dl_list_init(&sm->pmksa_candidates);
2254 sm->renew_snonce = 1;
2257 sm->dot11RSNAConfigPMKLifetime = 43200;
2258 sm->dot11RSNAConfigPMKReauthThreshold = 70;
2259 sm->dot11RSNAConfigSATimeout = 60;
2261 sm->pmksa = pmksa_cache_init(wpa_sm_pmksa_free_cb, sm, sm);
2262 if (sm->pmksa == NULL) {
2263 wpa_msg(sm->ctx->msg_ctx, MSG_ERROR,
2264 "RSN: PMKSA cache initialization failed");
2274 * wpa_sm_deinit - Deinitialize WPA state machine
2275 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2277 void wpa_sm_deinit(struct wpa_sm *sm)
2281 pmksa_cache_deinit(sm->pmksa);
2282 eloop_cancel_timeout(wpa_sm_start_preauth, sm, NULL);
2283 eloop_cancel_timeout(wpa_sm_rekey_ptk, sm, NULL);
2284 os_free(sm->assoc_wpa_ie);
2285 os_free(sm->ap_wpa_ie);
2286 os_free(sm->ap_rsn_ie);
2290 #ifdef CONFIG_IEEE80211R
2291 os_free(sm->assoc_resp_ies);
2292 #endif /* CONFIG_IEEE80211R */
2293 #ifdef CONFIG_TESTING_OPTIONS
2294 wpabuf_free(sm->test_assoc_ie);
2295 #endif /* CONFIG_TESTING_OPTIONS */
2301 * wpa_sm_notify_assoc - Notify WPA state machine about association
2302 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2303 * @bssid: The BSSID of the new association
2305 * This function is called to let WPA state machine know that the connection
2308 void wpa_sm_notify_assoc(struct wpa_sm *sm, const u8 *bssid)
2315 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
2316 "WPA: Association event - clear replay counter");
2317 os_memcpy(sm->bssid, bssid, ETH_ALEN);
2318 os_memset(sm->rx_replay_counter, 0, WPA_REPLAY_COUNTER_LEN);
2319 sm->rx_replay_counter_set = 0;
2320 sm->renew_snonce = 1;
2321 if (os_memcmp(sm->preauth_bssid, bssid, ETH_ALEN) == 0)
2322 rsn_preauth_deinit(sm);
2324 #ifdef CONFIG_IEEE80211R
2325 if (wpa_ft_is_completed(sm)) {
2327 * Clear portValid to kick EAPOL state machine to re-enter
2328 * AUTHENTICATED state to get the EAPOL port Authorized.
2330 eapol_sm_notify_portValid(sm->eapol, FALSE);
2331 wpa_supplicant_key_neg_complete(sm, sm->bssid, 1);
2333 /* Prepare for the next transition */
2334 wpa_ft_prepare_auth_request(sm, NULL);
2338 #endif /* CONFIG_IEEE80211R */
2342 * IEEE 802.11, 8.4.10: Delete PTK SA on (re)association if
2343 * this is not part of a Fast BSS Transition.
2345 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: Clear old PTK");
2347 os_memset(&sm->ptk, 0, sizeof(sm->ptk));
2349 os_memset(&sm->tptk, 0, sizeof(sm->tptk));
2354 #endif /* CONFIG_TDLS */
2357 os_memset(sm->p2p_ip_addr, 0, sizeof(sm->p2p_ip_addr));
2358 #endif /* CONFIG_P2P */
2363 * wpa_sm_notify_disassoc - Notify WPA state machine about disassociation
2364 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2366 * This function is called to let WPA state machine know that the connection
2367 * was lost. This will abort any existing pre-authentication session.
2369 void wpa_sm_notify_disassoc(struct wpa_sm *sm)
2371 eloop_cancel_timeout(wpa_sm_start_preauth, sm, NULL);
2372 eloop_cancel_timeout(wpa_sm_rekey_ptk, sm, NULL);
2374 rsn_preauth_deinit(sm);
2375 pmksa_cache_clear_current(sm);
2376 if (wpa_sm_get_state(sm) == WPA_4WAY_HANDSHAKE)
2377 sm->dot11RSNA4WayHandshakeFailures++;
2379 wpa_tdls_disassoc(sm);
2380 #endif /* CONFIG_TDLS */
2382 /* Keys are not needed in the WPA state machine anymore */
2385 sm->msg_3_of_4_ok = 0;
2390 * wpa_sm_set_pmk - Set PMK
2391 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2393 * @pmk_len: The length of the new PMK in bytes
2394 * @pmkid: Calculated PMKID
2395 * @bssid: AA to add into PMKSA cache or %NULL to not cache the PMK
2397 * Configure the PMK for WPA state machine.
2399 void wpa_sm_set_pmk(struct wpa_sm *sm, const u8 *pmk, size_t pmk_len,
2400 const u8 *pmkid, const u8 *bssid)
2405 sm->pmk_len = pmk_len;
2406 os_memcpy(sm->pmk, pmk, pmk_len);
2408 #ifdef CONFIG_IEEE80211R
2409 /* Set XXKey to be PSK for FT key derivation */
2410 sm->xxkey_len = pmk_len;
2411 os_memcpy(sm->xxkey, pmk, pmk_len);
2412 #endif /* CONFIG_IEEE80211R */
2415 pmksa_cache_add(sm->pmksa, pmk, pmk_len, pmkid, NULL, 0,
2416 bssid, sm->own_addr,
2417 sm->network_ctx, sm->key_mgmt);
2423 * wpa_sm_set_pmk_from_pmksa - Set PMK based on the current PMKSA
2424 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2426 * Take the PMK from the current PMKSA into use. If no PMKSA is active, the PMK
2429 void wpa_sm_set_pmk_from_pmksa(struct wpa_sm *sm)
2434 if (sm->cur_pmksa) {
2435 sm->pmk_len = sm->cur_pmksa->pmk_len;
2436 os_memcpy(sm->pmk, sm->cur_pmksa->pmk, sm->pmk_len);
2438 sm->pmk_len = PMK_LEN;
2439 os_memset(sm->pmk, 0, PMK_LEN);
2445 * wpa_sm_set_fast_reauth - Set fast reauthentication (EAP) enabled/disabled
2446 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2447 * @fast_reauth: Whether fast reauthentication (EAP) is allowed
2449 void wpa_sm_set_fast_reauth(struct wpa_sm *sm, int fast_reauth)
2452 sm->fast_reauth = fast_reauth;
2457 * wpa_sm_set_scard_ctx - Set context pointer for smartcard callbacks
2458 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2459 * @scard_ctx: Context pointer for smartcard related callback functions
2461 void wpa_sm_set_scard_ctx(struct wpa_sm *sm, void *scard_ctx)
2465 sm->scard_ctx = scard_ctx;
2466 if (sm->preauth_eapol)
2467 eapol_sm_register_scard_ctx(sm->preauth_eapol, scard_ctx);
2472 * wpa_sm_set_config - Notification of current configration change
2473 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2474 * @config: Pointer to current network configuration
2476 * Notify WPA state machine that configuration has changed. config will be
2477 * stored as a backpointer to network configuration. This can be %NULL to clear
2478 * the stored pointed.
2480 void wpa_sm_set_config(struct wpa_sm *sm, struct rsn_supp_config *config)
2486 sm->network_ctx = config->network_ctx;
2487 sm->peerkey_enabled = config->peerkey_enabled;
2488 sm->allowed_pairwise_cipher = config->allowed_pairwise_cipher;
2489 sm->proactive_key_caching = config->proactive_key_caching;
2490 sm->eap_workaround = config->eap_workaround;
2491 sm->eap_conf_ctx = config->eap_conf_ctx;
2493 os_memcpy(sm->ssid, config->ssid, config->ssid_len);
2494 sm->ssid_len = config->ssid_len;
2497 sm->wpa_ptk_rekey = config->wpa_ptk_rekey;
2498 sm->p2p = config->p2p;
2499 sm->wpa_rsc_relaxation = config->wpa_rsc_relaxation;
2501 sm->network_ctx = NULL;
2502 sm->peerkey_enabled = 0;
2503 sm->allowed_pairwise_cipher = 0;
2504 sm->proactive_key_caching = 0;
2505 sm->eap_workaround = 0;
2506 sm->eap_conf_ctx = NULL;
2508 sm->wpa_ptk_rekey = 0;
2510 sm->wpa_rsc_relaxation = 0;
2516 * wpa_sm_set_own_addr - Set own MAC address
2517 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2518 * @addr: Own MAC address
2520 void wpa_sm_set_own_addr(struct wpa_sm *sm, const u8 *addr)
2523 os_memcpy(sm->own_addr, addr, ETH_ALEN);
2528 * wpa_sm_set_ifname - Set network interface name
2529 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2530 * @ifname: Interface name
2531 * @bridge_ifname: Optional bridge interface name (for pre-auth)
2533 void wpa_sm_set_ifname(struct wpa_sm *sm, const char *ifname,
2534 const char *bridge_ifname)
2537 sm->ifname = ifname;
2538 sm->bridge_ifname = bridge_ifname;
2544 * wpa_sm_set_eapol - Set EAPOL state machine pointer
2545 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2546 * @eapol: Pointer to EAPOL state machine allocated with eapol_sm_init()
2548 void wpa_sm_set_eapol(struct wpa_sm *sm, struct eapol_sm *eapol)
2556 * wpa_sm_set_param - Set WPA state machine parameters
2557 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2558 * @param: Parameter field
2559 * @value: Parameter value
2560 * Returns: 0 on success, -1 on failure
2562 int wpa_sm_set_param(struct wpa_sm *sm, enum wpa_sm_conf_params param,
2571 case RSNA_PMK_LIFETIME:
2573 sm->dot11RSNAConfigPMKLifetime = value;
2577 case RSNA_PMK_REAUTH_THRESHOLD:
2578 if (value > 0 && value <= 100)
2579 sm->dot11RSNAConfigPMKReauthThreshold = value;
2583 case RSNA_SA_TIMEOUT:
2585 sm->dot11RSNAConfigSATimeout = value;
2589 case WPA_PARAM_PROTO:
2592 case WPA_PARAM_PAIRWISE:
2593 sm->pairwise_cipher = value;
2595 case WPA_PARAM_GROUP:
2596 sm->group_cipher = value;
2598 case WPA_PARAM_KEY_MGMT:
2599 sm->key_mgmt = value;
2601 #ifdef CONFIG_IEEE80211W
2602 case WPA_PARAM_MGMT_GROUP:
2603 sm->mgmt_group_cipher = value;
2605 #endif /* CONFIG_IEEE80211W */
2606 case WPA_PARAM_RSN_ENABLED:
2607 sm->rsn_enabled = value;
2621 * wpa_sm_get_status - Get WPA state machine
2622 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2623 * @buf: Buffer for status information
2624 * @buflen: Maximum buffer length
2625 * @verbose: Whether to include verbose status information
2626 * Returns: Number of bytes written to buf.
2628 * Query WPA state machine for status information. This function fills in
2629 * a text area with current status information. If the buffer (buf) is not
2630 * large enough, status information will be truncated to fit the buffer.
2632 int wpa_sm_get_status(struct wpa_sm *sm, char *buf, size_t buflen,
2635 char *pos = buf, *end = buf + buflen;
2638 ret = os_snprintf(pos, end - pos,
2639 "pairwise_cipher=%s\n"
2642 wpa_cipher_txt(sm->pairwise_cipher),
2643 wpa_cipher_txt(sm->group_cipher),
2644 wpa_key_mgmt_txt(sm->key_mgmt, sm->proto));
2645 if (os_snprintf_error(end - pos, ret))
2649 if (sm->mfp != NO_MGMT_FRAME_PROTECTION && sm->ap_rsn_ie) {
2650 struct wpa_ie_data rsn;
2651 if (wpa_parse_wpa_ie_rsn(sm->ap_rsn_ie, sm->ap_rsn_ie_len, &rsn)
2653 rsn.capabilities & (WPA_CAPABILITY_MFPR |
2654 WPA_CAPABILITY_MFPC)) {
2655 ret = os_snprintf(pos, end - pos, "pmf=%d\n",
2657 WPA_CAPABILITY_MFPR) ? 2 : 1);
2658 if (os_snprintf_error(end - pos, ret))
2668 int wpa_sm_pmf_enabled(struct wpa_sm *sm)
2670 struct wpa_ie_data rsn;
2672 if (sm->mfp == NO_MGMT_FRAME_PROTECTION || !sm->ap_rsn_ie)
2675 if (wpa_parse_wpa_ie_rsn(sm->ap_rsn_ie, sm->ap_rsn_ie_len, &rsn) >= 0 &&
2676 rsn.capabilities & (WPA_CAPABILITY_MFPR | WPA_CAPABILITY_MFPC))
2684 * wpa_sm_set_assoc_wpa_ie_default - Generate own WPA/RSN IE from configuration
2685 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2686 * @wpa_ie: Pointer to buffer for WPA/RSN IE
2687 * @wpa_ie_len: Pointer to the length of the wpa_ie buffer
2688 * Returns: 0 on success, -1 on failure
2690 int wpa_sm_set_assoc_wpa_ie_default(struct wpa_sm *sm, u8 *wpa_ie,
2698 #ifdef CONFIG_TESTING_OPTIONS
2699 if (sm->test_assoc_ie) {
2700 wpa_printf(MSG_DEBUG,
2701 "TESTING: Replace association WPA/RSN IE");
2702 if (*wpa_ie_len < wpabuf_len(sm->test_assoc_ie))
2704 os_memcpy(wpa_ie, wpabuf_head(sm->test_assoc_ie),
2705 wpabuf_len(sm->test_assoc_ie));
2706 res = wpabuf_len(sm->test_assoc_ie);
2708 #endif /* CONFIG_TESTING_OPTIONS */
2709 res = wpa_gen_wpa_ie(sm, wpa_ie, *wpa_ie_len);
2714 wpa_hexdump(MSG_DEBUG, "WPA: Set own WPA IE default",
2715 wpa_ie, *wpa_ie_len);
2717 if (sm->assoc_wpa_ie == NULL) {
2719 * Make a copy of the WPA/RSN IE so that 4-Way Handshake gets
2720 * the correct version of the IE even if PMKSA caching is
2721 * aborted (which would remove PMKID from IE generation).
2723 sm->assoc_wpa_ie = os_malloc(*wpa_ie_len);
2724 if (sm->assoc_wpa_ie == NULL)
2727 os_memcpy(sm->assoc_wpa_ie, wpa_ie, *wpa_ie_len);
2728 sm->assoc_wpa_ie_len = *wpa_ie_len;
2736 * wpa_sm_set_assoc_wpa_ie - Set own WPA/RSN IE from (Re)AssocReq
2737 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2738 * @ie: Pointer to IE data (starting from id)
2740 * Returns: 0 on success, -1 on failure
2742 * Inform WPA state machine about the WPA/RSN IE used in (Re)Association
2743 * Request frame. The IE will be used to override the default value generated
2744 * with wpa_sm_set_assoc_wpa_ie_default().
2746 int wpa_sm_set_assoc_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len)
2751 os_free(sm->assoc_wpa_ie);
2752 if (ie == NULL || len == 0) {
2753 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
2754 "WPA: clearing own WPA/RSN IE");
2755 sm->assoc_wpa_ie = NULL;
2756 sm->assoc_wpa_ie_len = 0;
2758 wpa_hexdump(MSG_DEBUG, "WPA: set own WPA/RSN IE", ie, len);
2759 sm->assoc_wpa_ie = os_malloc(len);
2760 if (sm->assoc_wpa_ie == NULL)
2763 os_memcpy(sm->assoc_wpa_ie, ie, len);
2764 sm->assoc_wpa_ie_len = len;
2772 * wpa_sm_set_ap_wpa_ie - Set AP WPA IE from Beacon/ProbeResp
2773 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2774 * @ie: Pointer to IE data (starting from id)
2776 * Returns: 0 on success, -1 on failure
2778 * Inform WPA state machine about the WPA IE used in Beacon / Probe Response
2781 int wpa_sm_set_ap_wpa_ie(struct wpa_sm *sm, const u8 *ie, size_t len)
2786 os_free(sm->ap_wpa_ie);
2787 if (ie == NULL || len == 0) {
2788 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
2789 "WPA: clearing AP WPA IE");
2790 sm->ap_wpa_ie = NULL;
2791 sm->ap_wpa_ie_len = 0;
2793 wpa_hexdump(MSG_DEBUG, "WPA: set AP WPA IE", ie, len);
2794 sm->ap_wpa_ie = os_malloc(len);
2795 if (sm->ap_wpa_ie == NULL)
2798 os_memcpy(sm->ap_wpa_ie, ie, len);
2799 sm->ap_wpa_ie_len = len;
2807 * wpa_sm_set_ap_rsn_ie - Set AP RSN IE from Beacon/ProbeResp
2808 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2809 * @ie: Pointer to IE data (starting from id)
2811 * Returns: 0 on success, -1 on failure
2813 * Inform WPA state machine about the RSN IE used in Beacon / Probe Response
2816 int wpa_sm_set_ap_rsn_ie(struct wpa_sm *sm, const u8 *ie, size_t len)
2821 os_free(sm->ap_rsn_ie);
2822 if (ie == NULL || len == 0) {
2823 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
2824 "WPA: clearing AP RSN IE");
2825 sm->ap_rsn_ie = NULL;
2826 sm->ap_rsn_ie_len = 0;
2828 wpa_hexdump(MSG_DEBUG, "WPA: set AP RSN IE", ie, len);
2829 sm->ap_rsn_ie = os_malloc(len);
2830 if (sm->ap_rsn_ie == NULL)
2833 os_memcpy(sm->ap_rsn_ie, ie, len);
2834 sm->ap_rsn_ie_len = len;
2842 * wpa_sm_parse_own_wpa_ie - Parse own WPA/RSN IE
2843 * @sm: Pointer to WPA state machine data from wpa_sm_init()
2844 * @data: Pointer to data area for parsing results
2845 * Returns: 0 on success, -1 if IE is not known, or -2 on parsing failure
2847 * Parse the contents of the own WPA or RSN IE from (Re)AssocReq and write the
2848 * parsed data into data.
2850 int wpa_sm_parse_own_wpa_ie(struct wpa_sm *sm, struct wpa_ie_data *data)
2855 if (sm->assoc_wpa_ie == NULL) {
2856 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG,
2857 "WPA: No WPA/RSN IE available from association info");
2860 if (wpa_parse_wpa_ie(sm->assoc_wpa_ie, sm->assoc_wpa_ie_len, data))
2866 int wpa_sm_pmksa_cache_list(struct wpa_sm *sm, char *buf, size_t len)
2868 return pmksa_cache_list(sm->pmksa, buf, len);
2872 void wpa_sm_drop_sa(struct wpa_sm *sm)
2874 wpa_dbg(sm->ctx->msg_ctx, MSG_DEBUG, "WPA: Clear old PMK and PTK");
2877 os_memset(sm->pmk, 0, sizeof(sm->pmk));
2878 os_memset(&sm->ptk, 0, sizeof(sm->ptk));
2879 os_memset(&sm->tptk, 0, sizeof(sm->tptk));
2880 #ifdef CONFIG_IEEE80211R
2881 os_memset(sm->xxkey, 0, sizeof(sm->xxkey));
2882 os_memset(sm->pmk_r0, 0, sizeof(sm->pmk_r0));
2883 os_memset(sm->pmk_r1, 0, sizeof(sm->pmk_r1));
2884 #endif /* CONFIG_IEEE80211R */
2888 int wpa_sm_has_ptk(struct wpa_sm *sm)
2896 void wpa_sm_update_replay_ctr(struct wpa_sm *sm, const u8 *replay_ctr)
2898 os_memcpy(sm->rx_replay_counter, replay_ctr, WPA_REPLAY_COUNTER_LEN);
2902 void wpa_sm_pmksa_cache_flush(struct wpa_sm *sm, void *network_ctx)
2904 pmksa_cache_flush(sm->pmksa, network_ctx, NULL, 0);
2909 int wpa_wnmsleep_install_key(struct wpa_sm *sm, u8 subelem_id, u8 *buf)
2912 u8 keylen; /* plaintext key len */
2915 if (subelem_id == WNM_SLEEP_SUBELEM_GTK) {
2916 struct wpa_gtk_data gd;
2918 os_memset(&gd, 0, sizeof(gd));
2919 keylen = wpa_cipher_key_len(sm->group_cipher);
2920 gd.key_rsc_len = wpa_cipher_rsc_len(sm->group_cipher);
2921 gd.alg = wpa_cipher_to_alg(sm->group_cipher);
2922 if (gd.alg == WPA_ALG_NONE) {
2923 wpa_printf(MSG_DEBUG, "Unsupported group cipher suite");
2928 keyinfo = WPA_GET_LE16(buf + 2);
2929 gd.gtk_len = keylen;
2930 if (gd.gtk_len != buf[4]) {
2931 wpa_printf(MSG_DEBUG, "GTK len mismatch len %d vs %d",
2932 gd.gtk_len, buf[4]);
2935 gd.keyidx = keyinfo & 0x03; /* B0 - B1 */
2936 gd.tx = wpa_supplicant_gtk_tx_bit_workaround(
2937 sm, !!(keyinfo & WPA_KEY_INFO_TXRX));
2939 os_memcpy(gd.gtk, buf + 13, gd.gtk_len);
2941 wpa_hexdump_key(MSG_DEBUG, "Install GTK (WNM SLEEP)",
2942 gd.gtk, gd.gtk_len);
2943 if (wpa_supplicant_install_gtk(sm, &gd, key_rsc)) {
2944 os_memset(&gd, 0, sizeof(gd));
2945 wpa_printf(MSG_DEBUG, "Failed to install the GTK in "
2949 os_memset(&gd, 0, sizeof(gd));
2950 #ifdef CONFIG_IEEE80211W
2951 } else if (subelem_id == WNM_SLEEP_SUBELEM_IGTK) {
2952 struct wpa_igtk_kde igd;
2955 os_memset(&igd, 0, sizeof(igd));
2956 keylen = wpa_cipher_key_len(sm->mgmt_group_cipher);
2957 os_memcpy(igd.keyid, buf + 2, 2);
2958 os_memcpy(igd.pn, buf + 4, 6);
2960 keyidx = WPA_GET_LE16(igd.keyid);
2961 os_memcpy(igd.igtk, buf + 10, keylen);
2963 wpa_hexdump_key(MSG_DEBUG, "Install IGTK (WNM SLEEP)",
2965 if (wpa_sm_set_key(sm, wpa_cipher_to_alg(sm->mgmt_group_cipher),
2966 broadcast_ether_addr,
2967 keyidx, 0, igd.pn, sizeof(igd.pn),
2968 igd.igtk, keylen) < 0) {
2969 wpa_printf(MSG_DEBUG, "Failed to install the IGTK in "
2971 os_memset(&igd, 0, sizeof(igd));
2974 os_memset(&igd, 0, sizeof(igd));
2975 #endif /* CONFIG_IEEE80211W */
2977 wpa_printf(MSG_DEBUG, "Unknown element id");
2983 #endif /* CONFIG_WNM */
2986 #ifdef CONFIG_PEERKEY
2987 int wpa_sm_rx_eapol_peerkey(struct wpa_sm *sm, const u8 *src_addr,
2988 const u8 *buf, size_t len)
2990 struct wpa_peerkey *peerkey;
2992 for (peerkey = sm->peerkey; peerkey; peerkey = peerkey->next) {
2993 if (os_memcmp(peerkey->addr, src_addr, ETH_ALEN) == 0)
3000 wpa_sm_rx_eapol(sm, src_addr, buf, len);
3004 #endif /* CONFIG_PEERKEY */
3009 int wpa_sm_get_p2p_ip_addr(struct wpa_sm *sm, u8 *buf)
3011 if (sm == NULL || WPA_GET_BE32(sm->p2p_ip_addr) == 0)
3013 os_memcpy(buf, sm->p2p_ip_addr, 3 * 4);
3017 #endif /* CONFIG_P2P */
3020 void wpa_sm_set_rx_replay_ctr(struct wpa_sm *sm, const u8 *rx_replay_counter)
3022 if (rx_replay_counter == NULL)
3025 os_memcpy(sm->rx_replay_counter, rx_replay_counter,
3026 WPA_REPLAY_COUNTER_LEN);
3027 sm->rx_replay_counter_set = 1;
3028 wpa_printf(MSG_DEBUG, "Updated key replay counter");
3032 void wpa_sm_set_ptk_kck_kek(struct wpa_sm *sm,
3033 const u8 *ptk_kck, size_t ptk_kck_len,
3034 const u8 *ptk_kek, size_t ptk_kek_len)
3036 if (ptk_kck && ptk_kck_len <= WPA_KCK_MAX_LEN) {
3037 os_memcpy(sm->ptk.kck, ptk_kck, ptk_kck_len);
3038 sm->ptk.kck_len = ptk_kck_len;
3039 wpa_printf(MSG_DEBUG, "Updated PTK KCK");
3041 if (ptk_kek && ptk_kek_len <= WPA_KEK_MAX_LEN) {
3042 os_memcpy(sm->ptk.kek, ptk_kek, ptk_kek_len);
3043 sm->ptk.kek_len = ptk_kek_len;
3044 wpa_printf(MSG_DEBUG, "Updated PTK KEK");
3050 #ifdef CONFIG_TESTING_OPTIONS
3051 void wpa_sm_set_test_assoc_ie(struct wpa_sm *sm, struct wpabuf *buf)
3053 wpabuf_free(sm->test_assoc_ie);
3054 sm->test_assoc_ie = buf;
3056 #endif /* CONFIG_TESTING_OPTIONS */