2 * hostapd - IEEE 802.11i-2004 / WPA Authenticator
3 * Copyright (c) 2004-2009, 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.
15 #include "utils/includes.h"
17 #include "utils/common.h"
18 #include "utils/eloop.h"
19 #include "utils/state_machine.h"
20 #include "common/ieee802_11_defs.h"
21 #include "crypto/aes_wrap.h"
22 #include "crypto/crypto.h"
23 #include "crypto/sha1.h"
24 #include "crypto/sha256.h"
25 #include "eapol_auth/eapol_auth_sm.h"
26 #include "ap_config.h"
27 #include "ieee802_11.h"
29 #include "pmksa_cache_auth.h"
30 #include "wpa_auth_i.h"
31 #include "wpa_auth_ie.h"
33 #define STATE_MACHINE_DATA struct wpa_state_machine
34 #define STATE_MACHINE_DEBUG_PREFIX "WPA"
35 #define STATE_MACHINE_ADDR sm->addr
38 static void wpa_send_eapol_timeout(void *eloop_ctx, void *timeout_ctx);
39 static int wpa_sm_step(struct wpa_state_machine *sm);
40 static int wpa_verify_key_mic(struct wpa_ptk *PTK, u8 *data, size_t data_len);
41 static void wpa_sm_call_step(void *eloop_ctx, void *timeout_ctx);
42 static void wpa_group_sm_step(struct wpa_authenticator *wpa_auth,
43 struct wpa_group *group);
44 static void wpa_request_new_ptk(struct wpa_state_machine *sm);
45 static int wpa_gtk_update(struct wpa_authenticator *wpa_auth,
46 struct wpa_group *group);
48 static const u32 dot11RSNAConfigGroupUpdateCount = 4;
49 static const u32 dot11RSNAConfigPairwiseUpdateCount = 4;
50 static const u32 eapol_key_timeout_first = 100; /* ms */
51 static const u32 eapol_key_timeout_subseq = 1000; /* ms */
53 /* TODO: make these configurable */
54 static const int dot11RSNAConfigPMKLifetime = 43200;
55 static const int dot11RSNAConfigPMKReauthThreshold = 70;
56 static const int dot11RSNAConfigSATimeout = 60;
59 static inline void wpa_auth_mic_failure_report(
60 struct wpa_authenticator *wpa_auth, const u8 *addr)
62 if (wpa_auth->cb.mic_failure_report)
63 wpa_auth->cb.mic_failure_report(wpa_auth->cb.ctx, addr);
67 static inline void wpa_auth_set_eapol(struct wpa_authenticator *wpa_auth,
68 const u8 *addr, wpa_eapol_variable var,
71 if (wpa_auth->cb.set_eapol)
72 wpa_auth->cb.set_eapol(wpa_auth->cb.ctx, addr, var, value);
76 static inline int wpa_auth_get_eapol(struct wpa_authenticator *wpa_auth,
77 const u8 *addr, wpa_eapol_variable var)
79 if (wpa_auth->cb.get_eapol == NULL)
81 return wpa_auth->cb.get_eapol(wpa_auth->cb.ctx, addr, var);
85 static inline const u8 * wpa_auth_get_psk(struct wpa_authenticator *wpa_auth,
86 const u8 *addr, const u8 *prev_psk)
88 if (wpa_auth->cb.get_psk == NULL)
90 return wpa_auth->cb.get_psk(wpa_auth->cb.ctx, addr, prev_psk);
94 static inline int wpa_auth_get_msk(struct wpa_authenticator *wpa_auth,
95 const u8 *addr, u8 *msk, size_t *len)
97 if (wpa_auth->cb.get_msk == NULL)
99 return wpa_auth->cb.get_msk(wpa_auth->cb.ctx, addr, msk, len);
103 static inline int wpa_auth_set_key(struct wpa_authenticator *wpa_auth,
105 enum wpa_alg alg, const u8 *addr, int idx,
106 u8 *key, size_t key_len)
108 if (wpa_auth->cb.set_key == NULL)
110 return wpa_auth->cb.set_key(wpa_auth->cb.ctx, vlan_id, alg, addr, idx,
115 static inline int wpa_auth_get_seqnum(struct wpa_authenticator *wpa_auth,
116 const u8 *addr, int idx, u8 *seq)
118 if (wpa_auth->cb.get_seqnum == NULL)
120 return wpa_auth->cb.get_seqnum(wpa_auth->cb.ctx, addr, idx, seq);
125 wpa_auth_send_eapol(struct wpa_authenticator *wpa_auth, const u8 *addr,
126 const u8 *data, size_t data_len, int encrypt)
128 if (wpa_auth->cb.send_eapol == NULL)
130 return wpa_auth->cb.send_eapol(wpa_auth->cb.ctx, addr, data, data_len,
135 int wpa_auth_for_each_sta(struct wpa_authenticator *wpa_auth,
136 int (*cb)(struct wpa_state_machine *sm, void *ctx),
139 if (wpa_auth->cb.for_each_sta == NULL)
141 return wpa_auth->cb.for_each_sta(wpa_auth->cb.ctx, cb, cb_ctx);
145 int wpa_auth_for_each_auth(struct wpa_authenticator *wpa_auth,
146 int (*cb)(struct wpa_authenticator *a, void *ctx),
149 if (wpa_auth->cb.for_each_auth == NULL)
151 return wpa_auth->cb.for_each_auth(wpa_auth->cb.ctx, cb, cb_ctx);
155 void wpa_auth_logger(struct wpa_authenticator *wpa_auth, const u8 *addr,
156 logger_level level, const char *txt)
158 if (wpa_auth->cb.logger == NULL)
160 wpa_auth->cb.logger(wpa_auth->cb.ctx, addr, level, txt);
164 void wpa_auth_vlogger(struct wpa_authenticator *wpa_auth, const u8 *addr,
165 logger_level level, const char *fmt, ...)
171 if (wpa_auth->cb.logger == NULL)
174 maxlen = os_strlen(fmt) + 100;
175 format = os_malloc(maxlen);
180 vsnprintf(format, maxlen, fmt, ap);
183 wpa_auth_logger(wpa_auth, addr, level, format);
189 static void wpa_sta_disconnect(struct wpa_authenticator *wpa_auth,
192 if (wpa_auth->cb.disconnect == NULL)
194 wpa_auth->cb.disconnect(wpa_auth->cb.ctx, addr,
195 WLAN_REASON_PREV_AUTH_NOT_VALID);
199 static int wpa_use_aes_cmac(struct wpa_state_machine *sm)
202 #ifdef CONFIG_IEEE80211R
203 if (wpa_key_mgmt_ft(sm->wpa_key_mgmt))
205 #endif /* CONFIG_IEEE80211R */
206 #ifdef CONFIG_IEEE80211W
207 if (wpa_key_mgmt_sha256(sm->wpa_key_mgmt))
209 #endif /* CONFIG_IEEE80211W */
214 static void wpa_rekey_gmk(void *eloop_ctx, void *timeout_ctx)
216 struct wpa_authenticator *wpa_auth = eloop_ctx;
218 if (os_get_random(wpa_auth->group->GMK, WPA_GMK_LEN)) {
219 wpa_printf(MSG_ERROR, "Failed to get random data for WPA "
222 wpa_auth_logger(wpa_auth, NULL, LOGGER_DEBUG, "GMK rekeyd");
225 if (wpa_auth->conf.wpa_gmk_rekey) {
226 eloop_register_timeout(wpa_auth->conf.wpa_gmk_rekey, 0,
227 wpa_rekey_gmk, wpa_auth, NULL);
232 static void wpa_rekey_gtk(void *eloop_ctx, void *timeout_ctx)
234 struct wpa_authenticator *wpa_auth = eloop_ctx;
235 struct wpa_group *group;
237 wpa_auth_logger(wpa_auth, NULL, LOGGER_DEBUG, "rekeying GTK");
238 for (group = wpa_auth->group; group; group = group->next) {
239 group->GTKReKey = TRUE;
241 group->changed = FALSE;
242 wpa_group_sm_step(wpa_auth, group);
243 } while (group->changed);
246 if (wpa_auth->conf.wpa_group_rekey) {
247 eloop_register_timeout(wpa_auth->conf.wpa_group_rekey,
248 0, wpa_rekey_gtk, wpa_auth, NULL);
253 static void wpa_rekey_ptk(void *eloop_ctx, void *timeout_ctx)
255 struct wpa_authenticator *wpa_auth = eloop_ctx;
256 struct wpa_state_machine *sm = timeout_ctx;
258 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_DEBUG, "rekeying PTK");
259 wpa_request_new_ptk(sm);
264 static int wpa_auth_pmksa_clear_cb(struct wpa_state_machine *sm, void *ctx)
266 if (sm->pmksa == ctx)
272 static void wpa_auth_pmksa_free_cb(struct rsn_pmksa_cache_entry *entry,
275 struct wpa_authenticator *wpa_auth = ctx;
276 wpa_auth_for_each_sta(wpa_auth, wpa_auth_pmksa_clear_cb, entry);
280 static void wpa_group_set_key_len(struct wpa_group *group, int cipher)
283 case WPA_CIPHER_CCMP:
286 case WPA_CIPHER_TKIP:
289 case WPA_CIPHER_WEP104:
292 case WPA_CIPHER_WEP40:
299 static struct wpa_group * wpa_group_init(struct wpa_authenticator *wpa_auth,
302 struct wpa_group *group;
303 u8 buf[ETH_ALEN + 8 + sizeof(group)];
306 group = os_zalloc(sizeof(struct wpa_group));
310 group->GTKAuthenticator = TRUE;
311 group->vlan_id = vlan_id;
313 wpa_group_set_key_len(group, wpa_auth->conf.wpa_group);
315 /* Counter = PRF-256(Random number, "Init Counter",
316 * Local MAC Address || Time)
318 os_memcpy(buf, wpa_auth->addr, ETH_ALEN);
319 wpa_get_ntp_timestamp(buf + ETH_ALEN);
320 os_memcpy(buf + ETH_ALEN + 8, &group, sizeof(group));
321 if (os_get_random(rkey, sizeof(rkey)) ||
322 os_get_random(group->GMK, WPA_GMK_LEN)) {
323 wpa_printf(MSG_ERROR, "Failed to get random data for WPA "
329 sha1_prf(rkey, sizeof(rkey), "Init Counter", buf, sizeof(buf),
330 group->Counter, WPA_NONCE_LEN);
333 wpa_group_sm_step(wpa_auth, group);
334 group->GInit = FALSE;
335 wpa_group_sm_step(wpa_auth, group);
342 * wpa_init - Initialize WPA authenticator
343 * @addr: Authenticator address
344 * @conf: Configuration for WPA authenticator
345 * @cb: Callback functions for WPA authenticator
346 * Returns: Pointer to WPA authenticator data or %NULL on failure
348 struct wpa_authenticator * wpa_init(const u8 *addr,
349 struct wpa_auth_config *conf,
350 struct wpa_auth_callbacks *cb)
352 struct wpa_authenticator *wpa_auth;
354 wpa_auth = os_zalloc(sizeof(struct wpa_authenticator));
355 if (wpa_auth == NULL)
357 os_memcpy(wpa_auth->addr, addr, ETH_ALEN);
358 os_memcpy(&wpa_auth->conf, conf, sizeof(*conf));
359 os_memcpy(&wpa_auth->cb, cb, sizeof(*cb));
361 if (wpa_auth_gen_wpa_ie(wpa_auth)) {
362 wpa_printf(MSG_ERROR, "Could not generate WPA IE.");
367 wpa_auth->group = wpa_group_init(wpa_auth, 0);
368 if (wpa_auth->group == NULL) {
369 os_free(wpa_auth->wpa_ie);
374 wpa_auth->pmksa = pmksa_cache_auth_init(wpa_auth_pmksa_free_cb,
376 if (wpa_auth->pmksa == NULL) {
377 wpa_printf(MSG_ERROR, "PMKSA cache initialization failed.");
378 os_free(wpa_auth->wpa_ie);
383 #ifdef CONFIG_IEEE80211R
384 wpa_auth->ft_pmk_cache = wpa_ft_pmk_cache_init();
385 if (wpa_auth->ft_pmk_cache == NULL) {
386 wpa_printf(MSG_ERROR, "FT PMK cache initialization failed.");
387 os_free(wpa_auth->wpa_ie);
388 pmksa_cache_auth_deinit(wpa_auth->pmksa);
392 #endif /* CONFIG_IEEE80211R */
394 if (wpa_auth->conf.wpa_gmk_rekey) {
395 eloop_register_timeout(wpa_auth->conf.wpa_gmk_rekey, 0,
396 wpa_rekey_gmk, wpa_auth, NULL);
399 if (wpa_auth->conf.wpa_group_rekey) {
400 eloop_register_timeout(wpa_auth->conf.wpa_group_rekey, 0,
401 wpa_rekey_gtk, wpa_auth, NULL);
409 * wpa_deinit - Deinitialize WPA authenticator
410 * @wpa_auth: Pointer to WPA authenticator data from wpa_init()
412 void wpa_deinit(struct wpa_authenticator *wpa_auth)
414 struct wpa_group *group, *prev;
416 eloop_cancel_timeout(wpa_rekey_gmk, wpa_auth, NULL);
417 eloop_cancel_timeout(wpa_rekey_gtk, wpa_auth, NULL);
419 #ifdef CONFIG_PEERKEY
420 while (wpa_auth->stsl_negotiations)
421 wpa_stsl_remove(wpa_auth, wpa_auth->stsl_negotiations);
422 #endif /* CONFIG_PEERKEY */
424 pmksa_cache_auth_deinit(wpa_auth->pmksa);
426 #ifdef CONFIG_IEEE80211R
427 wpa_ft_pmk_cache_deinit(wpa_auth->ft_pmk_cache);
428 wpa_auth->ft_pmk_cache = NULL;
429 #endif /* CONFIG_IEEE80211R */
431 os_free(wpa_auth->wpa_ie);
433 group = wpa_auth->group;
445 * wpa_reconfig - Update WPA authenticator configuration
446 * @wpa_auth: Pointer to WPA authenticator data from wpa_init()
447 * @conf: Configuration for WPA authenticator
449 int wpa_reconfig(struct wpa_authenticator *wpa_auth,
450 struct wpa_auth_config *conf)
452 struct wpa_group *group;
453 if (wpa_auth == NULL)
456 os_memcpy(&wpa_auth->conf, conf, sizeof(*conf));
457 if (wpa_auth_gen_wpa_ie(wpa_auth)) {
458 wpa_printf(MSG_ERROR, "Could not generate WPA IE.");
463 * Reinitialize GTK to make sure it is suitable for the new
466 group = wpa_auth->group;
467 wpa_group_set_key_len(group, wpa_auth->conf.wpa_group);
469 wpa_group_sm_step(wpa_auth, group);
470 group->GInit = FALSE;
471 wpa_group_sm_step(wpa_auth, group);
477 struct wpa_state_machine *
478 wpa_auth_sta_init(struct wpa_authenticator *wpa_auth, const u8 *addr)
480 struct wpa_state_machine *sm;
482 sm = os_zalloc(sizeof(struct wpa_state_machine));
485 os_memcpy(sm->addr, addr, ETH_ALEN);
487 sm->wpa_auth = wpa_auth;
488 sm->group = wpa_auth->group;
494 int wpa_auth_sta_associated(struct wpa_authenticator *wpa_auth,
495 struct wpa_state_machine *sm)
497 if (wpa_auth == NULL || !wpa_auth->conf.wpa || sm == NULL)
500 #ifdef CONFIG_IEEE80211R
501 if (sm->ft_completed) {
502 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_DEBUG,
503 "FT authentication already completed - do not "
504 "start 4-way handshake");
507 #endif /* CONFIG_IEEE80211R */
510 os_memset(&sm->key_replay, 0, sizeof(sm->key_replay));
511 sm->ReAuthenticationRequest = TRUE;
512 return wpa_sm_step(sm);
515 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_DEBUG,
516 "start authentication");
520 if (wpa_sm_step(sm) == 1)
521 return 1; /* should not really happen */
523 sm->AuthenticationRequest = TRUE;
524 return wpa_sm_step(sm);
528 void wpa_auth_sta_no_wpa(struct wpa_state_machine *sm)
530 /* WPA/RSN was not used - clear WPA state. This is needed if the STA
531 * reassociates back to the same AP while the previous entry for the
532 * STA has not yet been removed. */
536 sm->wpa_key_mgmt = 0;
540 static void wpa_free_sta_sm(struct wpa_state_machine *sm)
542 os_free(sm->last_rx_eapol_key);
548 void wpa_auth_sta_deinit(struct wpa_state_machine *sm)
553 if (sm->wpa_auth->conf.wpa_strict_rekey && sm->has_GTK) {
554 wpa_auth_logger(sm->wpa_auth, sm->addr, LOGGER_DEBUG,
555 "strict rekeying - force GTK rekey since STA "
557 eloop_cancel_timeout(wpa_rekey_gtk, sm->wpa_auth, NULL);
558 eloop_register_timeout(0, 500000, wpa_rekey_gtk, sm->wpa_auth,
562 eloop_cancel_timeout(wpa_send_eapol_timeout, sm->wpa_auth, sm);
563 eloop_cancel_timeout(wpa_sm_call_step, sm, NULL);
564 eloop_cancel_timeout(wpa_rekey_ptk, sm->wpa_auth, sm);
565 if (sm->in_step_loop) {
566 /* Must not free state machine while wpa_sm_step() is running.
567 * Freeing will be completed in the end of wpa_sm_step(). */
568 wpa_printf(MSG_DEBUG, "WPA: Registering pending STA state "
569 "machine deinit for " MACSTR, MAC2STR(sm->addr));
570 sm->pending_deinit = 1;
576 static void wpa_request_new_ptk(struct wpa_state_machine *sm)
581 sm->PTKRequest = TRUE;
586 static int wpa_replay_counter_valid(struct wpa_state_machine *sm,
587 const u8 *replay_counter)
590 for (i = 0; i < RSNA_MAX_EAPOL_RETRIES; i++) {
591 if (!sm->key_replay[i].valid)
593 if (os_memcmp(replay_counter, sm->key_replay[i].counter,
594 WPA_REPLAY_COUNTER_LEN) == 0)
601 void wpa_receive(struct wpa_authenticator *wpa_auth,
602 struct wpa_state_machine *sm,
603 u8 *data, size_t data_len)
605 struct ieee802_1x_hdr *hdr;
606 struct wpa_eapol_key *key;
607 u16 key_info, key_data_length;
608 enum { PAIRWISE_2, PAIRWISE_4, GROUP_2, REQUEST,
609 SMK_M1, SMK_M3, SMK_ERROR } msg;
611 struct wpa_eapol_ie_parse kde;
613 const u8 *eapol_key_ie;
614 size_t eapol_key_ie_len;
616 if (wpa_auth == NULL || !wpa_auth->conf.wpa || sm == NULL)
619 if (data_len < sizeof(*hdr) + sizeof(*key))
622 hdr = (struct ieee802_1x_hdr *) data;
623 key = (struct wpa_eapol_key *) (hdr + 1);
624 key_info = WPA_GET_BE16(key->key_info);
625 key_data_length = WPA_GET_BE16(key->key_data_length);
626 if (key_data_length > data_len - sizeof(*hdr) - sizeof(*key)) {
627 wpa_printf(MSG_INFO, "WPA: Invalid EAPOL-Key frame - "
628 "key_data overflow (%d > %lu)",
630 (unsigned long) (data_len - sizeof(*hdr) -
635 if (sm->wpa == WPA_VERSION_WPA2) {
636 if (key->type != EAPOL_KEY_TYPE_RSN) {
637 wpa_printf(MSG_DEBUG, "Ignore EAPOL-Key with "
638 "unexpected type %d in RSN mode",
643 if (key->type != EAPOL_KEY_TYPE_WPA) {
644 wpa_printf(MSG_DEBUG, "Ignore EAPOL-Key with "
645 "unexpected type %d in WPA mode",
651 /* FIX: verify that the EAPOL-Key frame was encrypted if pairwise keys
654 if ((key_info & (WPA_KEY_INFO_SMK_MESSAGE | WPA_KEY_INFO_REQUEST)) ==
655 (WPA_KEY_INFO_SMK_MESSAGE | WPA_KEY_INFO_REQUEST)) {
656 if (key_info & WPA_KEY_INFO_ERROR) {
658 msgtxt = "SMK Error";
663 } else if (key_info & WPA_KEY_INFO_SMK_MESSAGE) {
666 } else if (key_info & WPA_KEY_INFO_REQUEST) {
669 } else if (!(key_info & WPA_KEY_INFO_KEY_TYPE)) {
671 msgtxt = "2/2 Group";
672 } else if (key_data_length == 0) {
674 msgtxt = "4/4 Pairwise";
677 msgtxt = "2/4 Pairwise";
680 /* TODO: key_info type validation for PeerKey */
681 if (msg == REQUEST || msg == PAIRWISE_2 || msg == PAIRWISE_4 ||
683 u16 ver = key_info & WPA_KEY_INFO_TYPE_MASK;
684 if (sm->pairwise == WPA_CIPHER_CCMP) {
685 if (wpa_use_aes_cmac(sm) &&
686 ver != WPA_KEY_INFO_TYPE_AES_128_CMAC) {
687 wpa_auth_logger(wpa_auth, sm->addr,
689 "advertised support for "
690 "AES-128-CMAC, but did not "
695 if (!wpa_use_aes_cmac(sm) &&
696 ver != WPA_KEY_INFO_TYPE_HMAC_SHA1_AES) {
697 wpa_auth_logger(wpa_auth, sm->addr,
699 "did not use HMAC-SHA1-AES "
706 if (key_info & WPA_KEY_INFO_REQUEST) {
707 if (sm->req_replay_counter_used &&
708 os_memcmp(key->replay_counter, sm->req_replay_counter,
709 WPA_REPLAY_COUNTER_LEN) <= 0) {
710 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_WARNING,
711 "received EAPOL-Key request with "
717 if (!(key_info & WPA_KEY_INFO_REQUEST) &&
718 !wpa_replay_counter_valid(sm, key->replay_counter)) {
720 wpa_auth_vlogger(wpa_auth, sm->addr, LOGGER_INFO,
721 "received EAPOL-Key %s with unexpected "
722 "replay counter", msgtxt);
723 for (i = 0; i < RSNA_MAX_EAPOL_RETRIES; i++) {
724 if (!sm->key_replay[i].valid)
726 wpa_hexdump(MSG_DEBUG, "pending replay counter",
727 sm->key_replay[i].counter,
728 WPA_REPLAY_COUNTER_LEN);
730 wpa_hexdump(MSG_DEBUG, "received replay counter",
731 key->replay_counter, WPA_REPLAY_COUNTER_LEN);
737 if (sm->wpa_ptk_state != WPA_PTK_PTKSTART &&
738 sm->wpa_ptk_state != WPA_PTK_PTKCALCNEGOTIATING) {
739 wpa_auth_vlogger(wpa_auth, sm->addr, LOGGER_INFO,
740 "received EAPOL-Key msg 2/4 in "
741 "invalid state (%d) - dropped",
745 if (wpa_parse_kde_ies((u8 *) (key + 1), key_data_length,
747 wpa_auth_vlogger(wpa_auth, sm->addr, LOGGER_INFO,
748 "received EAPOL-Key msg 2/4 with "
749 "invalid Key Data contents");
753 eapol_key_ie = kde.rsn_ie;
754 eapol_key_ie_len = kde.rsn_ie_len;
756 eapol_key_ie = kde.wpa_ie;
757 eapol_key_ie_len = kde.wpa_ie_len;
759 ft = sm->wpa == WPA_VERSION_WPA2 &&
760 wpa_key_mgmt_ft(sm->wpa_key_mgmt);
761 if (sm->wpa_ie == NULL ||
762 wpa_compare_rsn_ie(ft,
763 sm->wpa_ie, sm->wpa_ie_len,
764 eapol_key_ie, eapol_key_ie_len)) {
765 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_INFO,
766 "WPA IE from (Re)AssocReq did not "
767 "match with msg 2/4");
769 wpa_hexdump(MSG_DEBUG, "WPA IE in AssocReq",
770 sm->wpa_ie, sm->wpa_ie_len);
772 wpa_hexdump(MSG_DEBUG, "WPA IE in msg 2/4",
773 eapol_key_ie, eapol_key_ie_len);
774 /* MLME-DEAUTHENTICATE.request */
775 wpa_sta_disconnect(wpa_auth, sm->addr);
778 #ifdef CONFIG_IEEE80211R
780 struct wpa_ie_data ie;
781 if (wpa_parse_wpa_ie_rsn(kde.rsn_ie, kde.rsn_ie_len,
783 ie.num_pmkid != 1 || ie.pmkid == NULL) {
784 wpa_printf(MSG_DEBUG, "FT: No PMKR1Name in "
785 "FT 4-way handshake message 2/4");
786 wpa_sta_disconnect(wpa_auth, sm->addr);
789 os_memcpy(sm->sup_pmk_r1_name, ie.pmkid, PMKID_LEN);
790 wpa_hexdump(MSG_DEBUG, "FT: PMKR1Name from Supplicant",
791 sm->sup_pmk_r1_name, PMKID_LEN);
793 #endif /* CONFIG_IEEE80211R */
796 if (sm->wpa_ptk_state != WPA_PTK_PTKINITNEGOTIATING ||
798 wpa_auth_vlogger(wpa_auth, sm->addr, LOGGER_INFO,
799 "received EAPOL-Key msg 4/4 in "
800 "invalid state (%d) - dropped",
806 if (sm->wpa_ptk_group_state != WPA_PTK_GROUP_REKEYNEGOTIATING
808 wpa_auth_vlogger(wpa_auth, sm->addr, LOGGER_INFO,
809 "received EAPOL-Key msg 2/2 in "
810 "invalid state (%d) - dropped",
811 sm->wpa_ptk_group_state);
815 #ifdef CONFIG_PEERKEY
819 if (!wpa_auth->conf.peerkey) {
820 wpa_printf(MSG_DEBUG, "RSN: SMK M1/M3/Error, but "
821 "PeerKey use disabled - ignoring message");
824 if (!sm->PTK_valid) {
825 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_INFO,
826 "received EAPOL-Key msg SMK in "
827 "invalid state - dropped");
831 #else /* CONFIG_PEERKEY */
835 return; /* STSL disabled - ignore SMK messages */
836 #endif /* CONFIG_PEERKEY */
841 wpa_auth_vlogger(wpa_auth, sm->addr, LOGGER_DEBUG,
842 "received EAPOL-Key frame (%s)", msgtxt);
844 if (key_info & WPA_KEY_INFO_ACK) {
845 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_INFO,
846 "received invalid EAPOL-Key: Key Ack set");
850 if (!(key_info & WPA_KEY_INFO_MIC)) {
851 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_INFO,
852 "received invalid EAPOL-Key: Key MIC not set");
856 sm->MICVerified = FALSE;
858 if (wpa_verify_key_mic(&sm->PTK, data, data_len)) {
859 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_INFO,
860 "received EAPOL-Key with invalid MIC");
863 sm->MICVerified = TRUE;
864 eloop_cancel_timeout(wpa_send_eapol_timeout, wpa_auth, sm);
867 if (key_info & WPA_KEY_INFO_REQUEST) {
868 if (sm->MICVerified) {
869 sm->req_replay_counter_used = 1;
870 os_memcpy(sm->req_replay_counter, key->replay_counter,
871 WPA_REPLAY_COUNTER_LEN);
873 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_INFO,
874 "received EAPOL-Key request with "
880 * TODO: should decrypt key data field if encryption was used;
881 * even though MAC address KDE is not normally encrypted,
882 * supplicant is allowed to encrypt it.
884 if (msg == SMK_ERROR) {
885 #ifdef CONFIG_PEERKEY
886 wpa_smk_error(wpa_auth, sm, key);
887 #endif /* CONFIG_PEERKEY */
889 } else if (key_info & WPA_KEY_INFO_ERROR) {
890 /* Supplicant reported a Michael MIC error */
891 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_INFO,
892 "received EAPOL-Key Error Request "
893 "(STA detected Michael MIC failure)");
894 wpa_auth_mic_failure_report(wpa_auth, sm->addr);
895 sm->dot11RSNAStatsTKIPRemoteMICFailures++;
896 wpa_auth->dot11RSNAStatsTKIPRemoteMICFailures++;
897 /* Error report is not a request for a new key
898 * handshake, but since Authenticator may do it, let's
899 * change the keys now anyway. */
900 wpa_request_new_ptk(sm);
901 } else if (key_info & WPA_KEY_INFO_KEY_TYPE) {
902 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_INFO,
903 "received EAPOL-Key Request for new "
905 wpa_request_new_ptk(sm);
906 #ifdef CONFIG_PEERKEY
907 } else if (msg == SMK_M1) {
908 wpa_smk_m1(wpa_auth, sm, key);
909 #endif /* CONFIG_PEERKEY */
910 } else if (key_data_length > 0 &&
911 wpa_parse_kde_ies((const u8 *) (key + 1),
912 key_data_length, &kde) == 0 &&
915 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_INFO,
916 "received EAPOL-Key Request for GTK "
918 /* FIX: why was this triggering PTK rekeying for the
919 * STA that requested Group Key rekeying?? */
920 /* wpa_request_new_ptk(sta->wpa_sm); */
921 eloop_cancel_timeout(wpa_rekey_gtk, wpa_auth, NULL);
922 wpa_rekey_gtk(wpa_auth, NULL);
925 /* Do not allow the same key replay counter to be reused. This
926 * does also invalidate all other pending replay counters if
927 * retransmissions were used, i.e., we will only process one of
928 * the pending replies and ignore rest if more than one is
930 sm->key_replay[0].valid = FALSE;
933 #ifdef CONFIG_PEERKEY
935 wpa_smk_m3(wpa_auth, sm, key);
938 #endif /* CONFIG_PEERKEY */
940 os_free(sm->last_rx_eapol_key);
941 sm->last_rx_eapol_key = os_malloc(data_len);
942 if (sm->last_rx_eapol_key == NULL)
944 os_memcpy(sm->last_rx_eapol_key, data, data_len);
945 sm->last_rx_eapol_key_len = data_len;
947 sm->EAPOLKeyReceived = TRUE;
948 sm->EAPOLKeyPairwise = !!(key_info & WPA_KEY_INFO_KEY_TYPE);
949 sm->EAPOLKeyRequest = !!(key_info & WPA_KEY_INFO_REQUEST);
950 os_memcpy(sm->SNonce, key->key_nonce, WPA_NONCE_LEN);
955 static void wpa_gmk_to_gtk(const u8 *gmk, const u8 *addr, const u8 *gnonce,
956 u8 *gtk, size_t gtk_len)
958 u8 data[ETH_ALEN + WPA_NONCE_LEN];
960 /* GTK = PRF-X(GMK, "Group key expansion", AA || GNonce) */
961 os_memcpy(data, addr, ETH_ALEN);
962 os_memcpy(data + ETH_ALEN, gnonce, WPA_NONCE_LEN);
964 #ifdef CONFIG_IEEE80211W
965 sha256_prf(gmk, WPA_GMK_LEN, "Group key expansion",
966 data, sizeof(data), gtk, gtk_len);
967 #else /* CONFIG_IEEE80211W */
968 sha1_prf(gmk, WPA_GMK_LEN, "Group key expansion",
969 data, sizeof(data), gtk, gtk_len);
970 #endif /* CONFIG_IEEE80211W */
972 wpa_hexdump_key(MSG_DEBUG, "GMK", gmk, WPA_GMK_LEN);
973 wpa_hexdump_key(MSG_DEBUG, "GTK", gtk, gtk_len);
977 static void wpa_send_eapol_timeout(void *eloop_ctx, void *timeout_ctx)
979 struct wpa_authenticator *wpa_auth = eloop_ctx;
980 struct wpa_state_machine *sm = timeout_ctx;
982 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_DEBUG, "EAPOL-Key timeout");
983 sm->TimeoutEvt = TRUE;
988 void __wpa_send_eapol(struct wpa_authenticator *wpa_auth,
989 struct wpa_state_machine *sm, int key_info,
990 const u8 *key_rsc, const u8 *nonce,
991 const u8 *kde, size_t kde_len,
992 int keyidx, int encr, int force_version)
994 struct ieee802_1x_hdr *hdr;
995 struct wpa_eapol_key *key;
998 int key_data_len, pad_len = 0;
1000 int version, pairwise;
1003 len = sizeof(struct ieee802_1x_hdr) + sizeof(struct wpa_eapol_key);
1006 version = force_version;
1007 else if (wpa_use_aes_cmac(sm))
1008 version = WPA_KEY_INFO_TYPE_AES_128_CMAC;
1009 else if (sm->pairwise == WPA_CIPHER_CCMP)
1010 version = WPA_KEY_INFO_TYPE_HMAC_SHA1_AES;
1012 version = WPA_KEY_INFO_TYPE_HMAC_MD5_RC4;
1014 pairwise = key_info & WPA_KEY_INFO_KEY_TYPE;
1016 wpa_printf(MSG_DEBUG, "WPA: Send EAPOL(version=%d secure=%d mic=%d "
1017 "ack=%d install=%d pairwise=%d kde_len=%lu keyidx=%d "
1020 (key_info & WPA_KEY_INFO_SECURE) ? 1 : 0,
1021 (key_info & WPA_KEY_INFO_MIC) ? 1 : 0,
1022 (key_info & WPA_KEY_INFO_ACK) ? 1 : 0,
1023 (key_info & WPA_KEY_INFO_INSTALL) ? 1 : 0,
1024 pairwise, (unsigned long) kde_len, keyidx, encr);
1026 key_data_len = kde_len;
1028 if ((version == WPA_KEY_INFO_TYPE_HMAC_SHA1_AES ||
1029 version == WPA_KEY_INFO_TYPE_AES_128_CMAC) && encr) {
1030 pad_len = key_data_len % 8;
1032 pad_len = 8 - pad_len;
1033 key_data_len += pad_len + 8;
1036 len += key_data_len;
1038 hdr = os_zalloc(len);
1041 hdr->version = wpa_auth->conf.eapol_version;
1042 hdr->type = IEEE802_1X_TYPE_EAPOL_KEY;
1043 hdr->length = host_to_be16(len - sizeof(*hdr));
1044 key = (struct wpa_eapol_key *) (hdr + 1);
1046 key->type = sm->wpa == WPA_VERSION_WPA2 ?
1047 EAPOL_KEY_TYPE_RSN : EAPOL_KEY_TYPE_WPA;
1048 key_info |= version;
1049 if (encr && sm->wpa == WPA_VERSION_WPA2)
1050 key_info |= WPA_KEY_INFO_ENCR_KEY_DATA;
1051 if (sm->wpa != WPA_VERSION_WPA2)
1052 key_info |= keyidx << WPA_KEY_INFO_KEY_INDEX_SHIFT;
1053 WPA_PUT_BE16(key->key_info, key_info);
1055 alg = pairwise ? sm->pairwise : wpa_auth->conf.wpa_group;
1057 case WPA_CIPHER_CCMP:
1058 WPA_PUT_BE16(key->key_length, 16);
1060 case WPA_CIPHER_TKIP:
1061 WPA_PUT_BE16(key->key_length, 32);
1063 case WPA_CIPHER_WEP40:
1064 WPA_PUT_BE16(key->key_length, 5);
1066 case WPA_CIPHER_WEP104:
1067 WPA_PUT_BE16(key->key_length, 13);
1070 if (key_info & WPA_KEY_INFO_SMK_MESSAGE)
1071 WPA_PUT_BE16(key->key_length, 0);
1073 /* FIX: STSL: what to use as key_replay_counter? */
1074 for (i = RSNA_MAX_EAPOL_RETRIES - 1; i > 0; i--) {
1075 sm->key_replay[i].valid = sm->key_replay[i - 1].valid;
1076 os_memcpy(sm->key_replay[i].counter,
1077 sm->key_replay[i - 1].counter,
1078 WPA_REPLAY_COUNTER_LEN);
1080 inc_byte_array(sm->key_replay[0].counter, WPA_REPLAY_COUNTER_LEN);
1081 os_memcpy(key->replay_counter, sm->key_replay[0].counter,
1082 WPA_REPLAY_COUNTER_LEN);
1083 sm->key_replay[0].valid = TRUE;
1086 os_memcpy(key->key_nonce, nonce, WPA_NONCE_LEN);
1089 os_memcpy(key->key_rsc, key_rsc, WPA_KEY_RSC_LEN);
1092 os_memcpy(key + 1, kde, kde_len);
1093 WPA_PUT_BE16(key->key_data_length, kde_len);
1094 } else if (encr && kde) {
1095 buf = os_zalloc(key_data_len);
1101 os_memcpy(pos, kde, kde_len);
1107 wpa_hexdump_key(MSG_DEBUG, "Plaintext EAPOL-Key Key Data",
1109 if (version == WPA_KEY_INFO_TYPE_HMAC_SHA1_AES ||
1110 version == WPA_KEY_INFO_TYPE_AES_128_CMAC) {
1111 if (aes_wrap(sm->PTK.kek, (key_data_len - 8) / 8, buf,
1112 (u8 *) (key + 1))) {
1117 WPA_PUT_BE16(key->key_data_length, key_data_len);
1120 os_memcpy(key->key_iv,
1121 sm->group->Counter + WPA_NONCE_LEN - 16, 16);
1122 inc_byte_array(sm->group->Counter, WPA_NONCE_LEN);
1123 os_memcpy(ek, key->key_iv, 16);
1124 os_memcpy(ek + 16, sm->PTK.kek, 16);
1125 os_memcpy(key + 1, buf, key_data_len);
1126 rc4_skip(ek, 32, 256, (u8 *) (key + 1), key_data_len);
1127 WPA_PUT_BE16(key->key_data_length, key_data_len);
1132 if (key_info & WPA_KEY_INFO_MIC) {
1133 if (!sm->PTK_valid) {
1134 wpa_auth_logger(wpa_auth, sm->addr, LOGGER_DEBUG,
1135 "PTK not valid when sending EAPOL-Key "
1140 wpa_eapol_key_mic(sm->PTK.kck, version, (u8 *) hdr, len,
1144 wpa_auth_set_eapol(sm->wpa_auth, sm->addr, WPA_EAPOL_inc_EapolFramesTx,
1146 wpa_auth_send_eapol(wpa_auth, sm->addr, (u8 *) hdr, len,
1152 static void wpa_send_eapol(struct wpa_authenticator *wpa_auth,
1153 struct wpa_state_machine *sm, int key_info,
1154 const u8 *key_rsc, const u8 *nonce,
1155 const u8 *kde, size_t kde_len,
1156 int keyidx, int encr)
1159 int pairwise = key_info & WPA_KEY_INFO_KEY_TYPE;
1165 __wpa_send_eapol(wpa_auth, sm, key_info, key_rsc, nonce, kde, kde_len,
1168 ctr = pairwise ? sm->TimeoutCtr : sm->GTimeoutCtr;
1170 timeout_ms = eapol_key_timeout_first;
1172 timeout_ms = eapol_key_timeout_subseq;
1173 eloop_register_timeout(timeout_ms / 1000, (timeout_ms % 1000) * 1000,
1174 wpa_send_eapol_timeout, wpa_auth, sm);
1178 static int wpa_verify_key_mic(struct wpa_ptk *PTK, u8 *data, size_t data_len)
1180 struct ieee802_1x_hdr *hdr;
1181 struct wpa_eapol_key *key;
1186 if (data_len < sizeof(*hdr) + sizeof(*key))
1189 hdr = (struct ieee802_1x_hdr *) data;
1190 key = (struct wpa_eapol_key *) (hdr + 1);
1191 key_info = WPA_GET_BE16(key->key_info);
1192 os_memcpy(mic, key->key_mic, 16);
1193 os_memset(key->key_mic, 0, 16);
1194 if (wpa_eapol_key_mic(PTK->kck, key_info & WPA_KEY_INFO_TYPE_MASK,
1195 data, data_len, key->key_mic) ||
1196 os_memcmp(mic, key->key_mic, 16) != 0)
1198 os_memcpy(key->key_mic, mic, 16);
1203 void wpa_remove_ptk(struct wpa_state_machine *sm)
1205 sm->PTK_valid = FALSE;
1206 os_memset(&sm->PTK, 0, sizeof(sm->PTK));
1207 wpa_auth_set_key(sm->wpa_auth, 0, WPA_ALG_NONE, sm->addr, 0, (u8 *) "",
1209 sm->pairwise_set = FALSE;
1210 eloop_cancel_timeout(wpa_rekey_ptk, sm->wpa_auth, sm);
1214 int wpa_auth_sm_event(struct wpa_state_machine *sm, wpa_event event)
1221 wpa_auth_vlogger(sm->wpa_auth, sm->addr, LOGGER_DEBUG,
1222 "event %d notification", event);
1230 sm->DeauthenticationRequest = TRUE;
1233 case WPA_REAUTH_EAPOL:
1234 if (sm->GUpdateStationKeys) {
1236 * Reauthentication cancels the pending group key
1237 * update for this STA.
1239 sm->group->GKeyDoneStations--;
1240 sm->GUpdateStationKeys = FALSE;
1241 sm->PtkGroupInit = TRUE;
1243 sm->ReAuthenticationRequest = TRUE;
1246 #ifdef CONFIG_IEEE80211R
1247 wpa_printf(MSG_DEBUG, "FT: Retry PTK configuration "
1248 "after association");
1249 wpa_ft_install_ptk(sm);
1251 /* Using FT protocol, not WPA auth state machine */
1252 sm->ft_completed = 1;
1254 #else /* CONFIG_IEEE80211R */
1256 #endif /* CONFIG_IEEE80211R */
1259 #ifdef CONFIG_IEEE80211R
1260 sm->ft_completed = 0;
1261 #endif /* CONFIG_IEEE80211R */
1263 #ifdef CONFIG_IEEE80211W
1264 if (sm->mgmt_frame_prot && event == WPA_AUTH)
1266 #endif /* CONFIG_IEEE80211W */
1269 sm->PTK_valid = FALSE;
1270 os_memset(&sm->PTK, 0, sizeof(sm->PTK));
1272 if (event != WPA_REAUTH_EAPOL)
1276 return wpa_sm_step(sm);
1280 static enum wpa_alg wpa_alg_enum(int alg)
1283 case WPA_CIPHER_CCMP:
1284 return WPA_ALG_CCMP;
1285 case WPA_CIPHER_TKIP:
1286 return WPA_ALG_TKIP;
1287 case WPA_CIPHER_WEP104:
1288 case WPA_CIPHER_WEP40:
1291 return WPA_ALG_NONE;
1296 SM_STATE(WPA_PTK, INITIALIZE)
1298 SM_ENTRY_MA(WPA_PTK, INITIALIZE, wpa_ptk);
1300 /* Init flag is not cleared here, so avoid busy
1301 * loop by claiming nothing changed. */
1302 sm->changed = FALSE;
1306 if (sm->GUpdateStationKeys)
1307 sm->group->GKeyDoneStations--;
1308 sm->GUpdateStationKeys = FALSE;
1309 if (sm->wpa == WPA_VERSION_WPA)
1310 sm->PInitAKeys = FALSE;
1311 if (1 /* Unicast cipher supported AND (ESS OR ((IBSS or WDS) and
1312 * Local AA > Remote AA)) */) {
1315 wpa_auth_set_eapol(sm->wpa_auth, sm->addr, WPA_EAPOL_portEnabled, 0);
1317 wpa_auth_set_eapol(sm->wpa_auth, sm->addr, WPA_EAPOL_portValid, 0);
1319 if (wpa_key_mgmt_wpa_psk(sm->wpa_key_mgmt)) {
1320 wpa_auth_set_eapol(sm->wpa_auth, sm->addr,
1321 WPA_EAPOL_authorized, 0);
1326 SM_STATE(WPA_PTK, DISCONNECT)
1328 SM_ENTRY_MA(WPA_PTK, DISCONNECT, wpa_ptk);
1329 sm->Disconnect = FALSE;
1330 wpa_sta_disconnect(sm->wpa_auth, sm->addr);
1334 SM_STATE(WPA_PTK, DISCONNECTED)
1336 SM_ENTRY_MA(WPA_PTK, DISCONNECTED, wpa_ptk);
1337 sm->DeauthenticationRequest = FALSE;
1341 SM_STATE(WPA_PTK, AUTHENTICATION)
1343 SM_ENTRY_MA(WPA_PTK, AUTHENTICATION, wpa_ptk);
1344 os_memset(&sm->PTK, 0, sizeof(sm->PTK));
1345 sm->PTK_valid = FALSE;
1346 wpa_auth_set_eapol(sm->wpa_auth, sm->addr, WPA_EAPOL_portControl_Auto,
1348 wpa_auth_set_eapol(sm->wpa_auth, sm->addr, WPA_EAPOL_portEnabled, 1);
1349 sm->AuthenticationRequest = FALSE;
1353 SM_STATE(WPA_PTK, AUTHENTICATION2)
1355 SM_ENTRY_MA(WPA_PTK, AUTHENTICATION2, wpa_ptk);
1356 os_memcpy(sm->ANonce, sm->group->Counter, WPA_NONCE_LEN);
1357 inc_byte_array(sm->group->Counter, WPA_NONCE_LEN);
1358 sm->ReAuthenticationRequest = FALSE;
1359 /* IEEE 802.11i does not clear TimeoutCtr here, but this is more
1360 * logical place than INITIALIZE since AUTHENTICATION2 can be
1361 * re-entered on ReAuthenticationRequest without going through
1367 SM_STATE(WPA_PTK, INITPMK)
1369 u8 msk[2 * PMK_LEN];
1370 size_t len = 2 * PMK_LEN;
1372 SM_ENTRY_MA(WPA_PTK, INITPMK, wpa_ptk);
1373 #ifdef CONFIG_IEEE80211R
1375 #endif /* CONFIG_IEEE80211R */
1377 wpa_printf(MSG_DEBUG, "WPA: PMK from PMKSA cache");
1378 os_memcpy(sm->PMK, sm->pmksa->pmk, PMK_LEN);
1379 } else if (wpa_auth_get_msk(sm->wpa_auth, sm->addr, msk, &len) == 0) {
1380 wpa_printf(MSG_DEBUG, "WPA: PMK from EAPOL state machine "
1381 "(len=%lu)", (unsigned long) len);
1382 os_memcpy(sm->PMK, msk, PMK_LEN);
1383 #ifdef CONFIG_IEEE80211R
1384 if (len >= 2 * PMK_LEN) {
1385 os_memcpy(sm->xxkey, msk + PMK_LEN, PMK_LEN);
1386 sm->xxkey_len = PMK_LEN;
1388 #endif /* CONFIG_IEEE80211R */
1390 wpa_printf(MSG_DEBUG, "WPA: Could not get PMK");
1393 sm->req_replay_counter_used = 0;
1394 /* IEEE 802.11i does not set keyRun to FALSE, but not doing this
1395 * will break reauthentication since EAPOL state machines may not be
1396 * get into AUTHENTICATING state that clears keyRun before WPA state
1397 * machine enters AUTHENTICATION2 state and goes immediately to INITPMK
1398 * state and takes PMK from the previously used AAA Key. This will
1399 * eventually fail in 4-Way Handshake because Supplicant uses PMK
1400 * derived from the new AAA Key. Setting keyRun = FALSE here seems to
1401 * be good workaround for this issue. */
1402 wpa_auth_set_eapol(sm->wpa_auth, sm->addr, WPA_EAPOL_keyRun, 0);
1406 SM_STATE(WPA_PTK, INITPSK)
1409 SM_ENTRY_MA(WPA_PTK, INITPSK, wpa_ptk);
1410 psk = wpa_auth_get_psk(sm->wpa_auth, sm->addr, NULL);
1412 os_memcpy(sm->PMK, psk, PMK_LEN);
1413 #ifdef CONFIG_IEEE80211R
1414 os_memcpy(sm->xxkey, psk, PMK_LEN);
1415 sm->xxkey_len = PMK_LEN;
1416 #endif /* CONFIG_IEEE80211R */
1418 sm->req_replay_counter_used = 0;
1422 SM_STATE(WPA_PTK, PTKSTART)
1424 u8 buf[2 + RSN_SELECTOR_LEN + PMKID_LEN], *pmkid = NULL;
1425 size_t pmkid_len = 0;
1427 SM_ENTRY_MA(WPA_PTK, PTKSTART, wpa_ptk);
1428 sm->PTKRequest = FALSE;
1429 sm->TimeoutEvt = FALSE;
1432 if (sm->TimeoutCtr > (int) dot11RSNAConfigPairwiseUpdateCount) {
1433 /* No point in sending the EAPOL-Key - we will disconnect
1434 * immediately following this. */
1438 wpa_auth_logger(sm->wpa_auth, sm->addr, LOGGER_DEBUG,
1439 "sending 1/4 msg of 4-Way Handshake");
1441 * TODO: Could add PMKID even with WPA2-PSK, but only if there is only
1442 * one possible PSK for this STA.
1444 if (sm->wpa == WPA_VERSION_WPA2 &&
1445 wpa_key_mgmt_wpa_ieee8021x(sm->wpa_key_mgmt)) {
1447 pmkid_len = 2 + RSN_SELECTOR_LEN + PMKID_LEN;
1448 pmkid[0] = WLAN_EID_VENDOR_SPECIFIC;
1449 pmkid[1] = RSN_SELECTOR_LEN + PMKID_LEN;
1450 RSN_SELECTOR_PUT(&pmkid[2], RSN_KEY_DATA_PMKID);
1452 os_memcpy(&pmkid[2 + RSN_SELECTOR_LEN],
1453 sm->pmksa->pmkid, PMKID_LEN);
1456 * Calculate PMKID since no PMKSA cache entry was
1457 * available with pre-calculated PMKID.
1459 rsn_pmkid(sm->PMK, PMK_LEN, sm->wpa_auth->addr,
1460 sm->addr, &pmkid[2 + RSN_SELECTOR_LEN],
1461 wpa_key_mgmt_sha256(sm->wpa_key_mgmt));
1464 wpa_send_eapol(sm->wpa_auth, sm,
1465 WPA_KEY_INFO_ACK | WPA_KEY_INFO_KEY_TYPE, NULL,
1466 sm->ANonce, pmkid, pmkid_len, 0, 0);
1470 static int wpa_derive_ptk(struct wpa_state_machine *sm, const u8 *pmk,
1471 struct wpa_ptk *ptk)
1473 size_t ptk_len = sm->pairwise == WPA_CIPHER_CCMP ? 48 : 64;
1474 #ifdef CONFIG_IEEE80211R
1475 if (wpa_key_mgmt_ft(sm->wpa_key_mgmt))
1476 return wpa_auth_derive_ptk_ft(sm, pmk, ptk, ptk_len);
1477 #endif /* CONFIG_IEEE80211R */
1479 wpa_pmk_to_ptk(pmk, PMK_LEN, "Pairwise key expansion",
1480 sm->wpa_auth->addr, sm->addr, sm->ANonce, sm->SNonce,
1481 (u8 *) ptk, ptk_len,
1482 wpa_key_mgmt_sha256(sm->wpa_key_mgmt));
1488 SM_STATE(WPA_PTK, PTKCALCNEGOTIATING)
1492 const u8 *pmk = NULL;
1494 SM_ENTRY_MA(WPA_PTK, PTKCALCNEGOTIATING, wpa_ptk);
1495 sm->EAPOLKeyReceived = FALSE;
1497 /* WPA with IEEE 802.1X: use the derived PMK from EAP
1498 * WPA-PSK: iterate through possible PSKs and select the one matching
1501 if (wpa_key_mgmt_wpa_psk(sm->wpa_key_mgmt)) {
1502 pmk = wpa_auth_get_psk(sm->wpa_auth, sm->addr, pmk);
1508 wpa_derive_ptk(sm, pmk, &PTK);
1510 if (wpa_verify_key_mic(&PTK, sm->last_rx_eapol_key,
1511 sm->last_rx_eapol_key_len) == 0) {
1516 if (!wpa_key_mgmt_wpa_psk(sm->wpa_key_mgmt))
1521 wpa_auth_logger(sm->wpa_auth, sm->addr, LOGGER_DEBUG,
1522 "invalid MIC in msg 2/4 of 4-Way Handshake");
1526 #ifdef CONFIG_IEEE80211R
1527 if (sm->wpa == WPA_VERSION_WPA2 && wpa_key_mgmt_ft(sm->wpa_key_mgmt)) {
1529 * Verify that PMKR1Name from EAPOL-Key message 2/4 matches
1530 * with the value we derived.
1532 if (os_memcmp(sm->sup_pmk_r1_name, sm->pmk_r1_name,
1533 WPA_PMK_NAME_LEN) != 0) {
1534 wpa_auth_logger(sm->wpa_auth, sm->addr, LOGGER_DEBUG,
1535 "PMKR1Name mismatch in FT 4-way "
1537 wpa_hexdump(MSG_DEBUG, "FT: PMKR1Name from "
1539 sm->sup_pmk_r1_name, WPA_PMK_NAME_LEN);
1540 wpa_hexdump(MSG_DEBUG, "FT: Derived PMKR1Name",
1541 sm->pmk_r1_name, WPA_PMK_NAME_LEN);
1545 #endif /* CONFIG_IEEE80211R */
1547 eloop_cancel_timeout(wpa_send_eapol_timeout, sm->wpa_auth, sm);
1549 if (wpa_key_mgmt_wpa_psk(sm->wpa_key_mgmt)) {
1550 /* PSK may have changed from the previous choice, so update
1551 * state machine data based on whatever PSK was selected here.
1553 os_memcpy(sm->PMK, pmk, PMK_LEN);
1556 sm->MICVerified = TRUE;
1558 os_memcpy(&sm->PTK, &PTK, sizeof(PTK));
1559 sm->PTK_valid = TRUE;
1563 SM_STATE(WPA_PTK, PTKCALCNEGOTIATING2)
1565 SM_ENTRY_MA(WPA_PTK, PTKCALCNEGOTIATING2, wpa_ptk);
1570 #ifdef CONFIG_IEEE80211W
1572 static int ieee80211w_kde_len(struct wpa_state_machine *sm)
1574 if (sm->mgmt_frame_prot) {
1575 return 2 + RSN_SELECTOR_LEN + sizeof(struct wpa_igtk_kde);
1582 static u8 * ieee80211w_kde_add(struct wpa_state_machine *sm, u8 *pos)
1584 struct wpa_igtk_kde igtk;
1585 struct wpa_group *gsm = sm->group;
1587 if (!sm->mgmt_frame_prot)
1590 igtk.keyid[0] = gsm->GN_igtk;
1592 if (gsm->wpa_group_state != WPA_GROUP_SETKEYSDONE ||
1593 wpa_auth_get_seqnum(sm->wpa_auth, NULL, gsm->GN_igtk, igtk.pn) < 0)
1594 os_memset(igtk.pn, 0, sizeof(igtk.pn));
1595 os_memcpy(igtk.igtk, gsm->IGTK[gsm->GN_igtk - 4], WPA_IGTK_LEN);
1596 pos = wpa_add_kde(pos, RSN_KEY_DATA_IGTK,
1597 (const u8 *) &igtk, sizeof(igtk), NULL, 0);
1602 #else /* CONFIG_IEEE80211W */
1604 static int ieee80211w_kde_len(struct wpa_state_machine *sm)
1610 static u8 * ieee80211w_kde_add(struct wpa_state_machine *sm, u8 *pos)
1615 #endif /* CONFIG_IEEE80211W */
1618 SM_STATE(WPA_PTK, PTKINITNEGOTIATING)
1620 u8 rsc[WPA_KEY_RSC_LEN], *_rsc, *gtk, *kde, *pos;
1621 size_t gtk_len, kde_len;
1622 struct wpa_group *gsm = sm->group;
1624 int wpa_ie_len, secure, keyidx, encr = 0;
1626 SM_ENTRY_MA(WPA_PTK, PTKINITNEGOTIATING, wpa_ptk);
1627 sm->TimeoutEvt = FALSE;
1630 if (sm->TimeoutCtr > (int) dot11RSNAConfigPairwiseUpdateCount) {
1631 /* No point in sending the EAPOL-Key - we will disconnect
1632 * immediately following this. */
1636 /* Send EAPOL(1, 1, 1, Pair, P, RSC, ANonce, MIC(PTK), RSNIE, GTK[GN])
1638 os_memset(rsc, 0, WPA_KEY_RSC_LEN);
1639 wpa_auth_get_seqnum(sm->wpa_auth, NULL, gsm->GN, rsc);
1640 wpa_ie = sm->wpa_auth->wpa_ie;
1641 wpa_ie_len = sm->wpa_auth->wpa_ie_len;
1642 if (sm->wpa == WPA_VERSION_WPA &&
1643 (sm->wpa_auth->conf.wpa & WPA_PROTO_RSN) &&
1644 wpa_ie_len > wpa_ie[1] + 2 && wpa_ie[0] == WLAN_EID_RSN) {
1645 /* WPA-only STA, remove RSN IE */
1646 wpa_ie = wpa_ie + wpa_ie[1] + 2;
1647 wpa_ie_len = wpa_ie[1] + 2;
1649 wpa_auth_logger(sm->wpa_auth, sm->addr, LOGGER_DEBUG,
1650 "sending 3/4 msg of 4-Way Handshake");
1651 if (sm->wpa == WPA_VERSION_WPA2) {
1652 /* WPA2 send GTK in the 4-way handshake */
1654 gtk = gsm->GTK[gsm->GN - 1];
1655 gtk_len = gsm->GTK_len;
1660 /* WPA does not include GTK in msg 3/4 */
1668 kde_len = wpa_ie_len + ieee80211w_kde_len(sm);
1670 kde_len += 2 + RSN_SELECTOR_LEN + 2 + gtk_len;
1671 #ifdef CONFIG_IEEE80211R
1672 if (wpa_key_mgmt_ft(sm->wpa_key_mgmt))
1673 kde_len += 2 + PMKID_LEN;
1674 #endif /* CONFIG_IEEE80211R */
1675 kde = os_malloc(kde_len);
1680 os_memcpy(pos, wpa_ie, wpa_ie_len);
1682 #ifdef CONFIG_IEEE80211R
1683 if (wpa_key_mgmt_ft(sm->wpa_key_mgmt)) {
1684 int res = wpa_insert_pmkid(kde, pos - kde, sm->pmk_r1_name);
1686 wpa_printf(MSG_ERROR, "FT: Failed to insert "
1687 "PMKR1Name into RSN IE in EAPOL-Key data");
1693 #endif /* CONFIG_IEEE80211R */
1696 hdr[0] = keyidx & 0x03;
1698 pos = wpa_add_kde(pos, RSN_KEY_DATA_GROUPKEY, hdr, 2,
1701 pos = ieee80211w_kde_add(sm, pos);
1703 wpa_send_eapol(sm->wpa_auth, sm,
1704 (secure ? WPA_KEY_INFO_SECURE : 0) | WPA_KEY_INFO_MIC |
1705 WPA_KEY_INFO_ACK | WPA_KEY_INFO_INSTALL |
1706 WPA_KEY_INFO_KEY_TYPE,
1707 _rsc, sm->ANonce, kde, pos - kde, keyidx, encr);
1712 SM_STATE(WPA_PTK, PTKINITDONE)
1714 SM_ENTRY_MA(WPA_PTK, PTKINITDONE, wpa_ptk);
1715 sm->EAPOLKeyReceived = FALSE;
1719 if (sm->pairwise == WPA_CIPHER_TKIP) {
1726 if (wpa_auth_set_key(sm->wpa_auth, 0, alg, sm->addr, 0,
1727 sm->PTK.tk1, klen)) {
1728 wpa_sta_disconnect(sm->wpa_auth, sm->addr);
1731 /* FIX: MLME-SetProtection.Request(TA, Tx_Rx) */
1732 sm->pairwise_set = TRUE;
1734 if (sm->wpa_auth->conf.wpa_ptk_rekey) {
1735 eloop_cancel_timeout(wpa_rekey_ptk, sm->wpa_auth, sm);
1736 eloop_register_timeout(sm->wpa_auth->conf.
1737 wpa_ptk_rekey, 0, wpa_rekey_ptk,
1741 if (wpa_key_mgmt_wpa_psk(sm->wpa_key_mgmt)) {
1742 wpa_auth_set_eapol(sm->wpa_auth, sm->addr,
1743 WPA_EAPOL_authorized, 1);
1747 if (0 /* IBSS == TRUE */) {
1749 if (sm->keycount == 2) {
1750 wpa_auth_set_eapol(sm->wpa_auth, sm->addr,
1751 WPA_EAPOL_portValid, 1);
1754 wpa_auth_set_eapol(sm->wpa_auth, sm->addr, WPA_EAPOL_portValid,
1757 wpa_auth_set_eapol(sm->wpa_auth, sm->addr, WPA_EAPOL_keyAvailable, 0);
1758 wpa_auth_set_eapol(sm->wpa_auth, sm->addr, WPA_EAPOL_keyDone, 1);
1759 if (sm->wpa == WPA_VERSION_WPA)
1760 sm->PInitAKeys = TRUE;
1763 wpa_auth_vlogger(sm->wpa_auth, sm->addr, LOGGER_INFO,
1764 "pairwise key handshake completed (%s)",
1765 sm->wpa == WPA_VERSION_WPA ? "WPA" : "RSN");
1767 #ifdef CONFIG_IEEE80211R
1768 wpa_ft_push_pmk_r1(sm->wpa_auth, sm->addr);
1769 #endif /* CONFIG_IEEE80211R */
1775 struct wpa_authenticator *wpa_auth = sm->wpa_auth;
1778 SM_ENTER(WPA_PTK, INITIALIZE);
1779 else if (sm->Disconnect
1780 /* || FIX: dot11RSNAConfigSALifetime timeout */)
1781 SM_ENTER(WPA_PTK, DISCONNECT);
1782 else if (sm->DeauthenticationRequest)
1783 SM_ENTER(WPA_PTK, DISCONNECTED);
1784 else if (sm->AuthenticationRequest)
1785 SM_ENTER(WPA_PTK, AUTHENTICATION);
1786 else if (sm->ReAuthenticationRequest)
1787 SM_ENTER(WPA_PTK, AUTHENTICATION2);
1788 else if (sm->PTKRequest)
1789 SM_ENTER(WPA_PTK, PTKSTART);
1790 else switch (sm->wpa_ptk_state) {
1791 case WPA_PTK_INITIALIZE:
1793 case WPA_PTK_DISCONNECT:
1794 SM_ENTER(WPA_PTK, DISCONNECTED);
1796 case WPA_PTK_DISCONNECTED:
1797 SM_ENTER(WPA_PTK, INITIALIZE);
1799 case WPA_PTK_AUTHENTICATION:
1800 SM_ENTER(WPA_PTK, AUTHENTICATION2);
1802 case WPA_PTK_AUTHENTICATION2:
1803 if (wpa_key_mgmt_wpa_ieee8021x(sm->wpa_key_mgmt) &&
1804 wpa_auth_get_eapol(sm->wpa_auth, sm->addr,
1805 WPA_EAPOL_keyRun) > 0)
1806 SM_ENTER(WPA_PTK, INITPMK);
1807 else if (wpa_key_mgmt_wpa_psk(sm->wpa_key_mgmt)
1808 /* FIX: && 802.1X::keyRun */)
1809 SM_ENTER(WPA_PTK, INITPSK);
1811 case WPA_PTK_INITPMK:
1812 if (wpa_auth_get_eapol(sm->wpa_auth, sm->addr,
1813 WPA_EAPOL_keyAvailable) > 0)
1814 SM_ENTER(WPA_PTK, PTKSTART);
1816 wpa_auth->dot11RSNA4WayHandshakeFailures++;
1817 SM_ENTER(WPA_PTK, DISCONNECT);
1820 case WPA_PTK_INITPSK:
1821 if (wpa_auth_get_psk(sm->wpa_auth, sm->addr, NULL))
1822 SM_ENTER(WPA_PTK, PTKSTART);
1824 wpa_auth_logger(sm->wpa_auth, sm->addr, LOGGER_INFO,
1825 "no PSK configured for the STA");
1826 wpa_auth->dot11RSNA4WayHandshakeFailures++;
1827 SM_ENTER(WPA_PTK, DISCONNECT);
1830 case WPA_PTK_PTKSTART:
1831 if (sm->EAPOLKeyReceived && !sm->EAPOLKeyRequest &&
1832 sm->EAPOLKeyPairwise)
1833 SM_ENTER(WPA_PTK, PTKCALCNEGOTIATING);
1834 else if (sm->TimeoutCtr >
1835 (int) dot11RSNAConfigPairwiseUpdateCount) {
1836 wpa_auth->dot11RSNA4WayHandshakeFailures++;
1837 SM_ENTER(WPA_PTK, DISCONNECT);
1838 } else if (sm->TimeoutEvt)
1839 SM_ENTER(WPA_PTK, PTKSTART);
1841 case WPA_PTK_PTKCALCNEGOTIATING:
1842 if (sm->MICVerified)
1843 SM_ENTER(WPA_PTK, PTKCALCNEGOTIATING2);
1844 else if (sm->EAPOLKeyReceived && !sm->EAPOLKeyRequest &&
1845 sm->EAPOLKeyPairwise)
1846 SM_ENTER(WPA_PTK, PTKCALCNEGOTIATING);
1847 else if (sm->TimeoutEvt)
1848 SM_ENTER(WPA_PTK, PTKSTART);
1850 case WPA_PTK_PTKCALCNEGOTIATING2:
1851 SM_ENTER(WPA_PTK, PTKINITNEGOTIATING);
1853 case WPA_PTK_PTKINITNEGOTIATING:
1854 if (sm->EAPOLKeyReceived && !sm->EAPOLKeyRequest &&
1855 sm->EAPOLKeyPairwise && sm->MICVerified)
1856 SM_ENTER(WPA_PTK, PTKINITDONE);
1857 else if (sm->TimeoutCtr >
1858 (int) dot11RSNAConfigPairwiseUpdateCount) {
1859 wpa_auth->dot11RSNA4WayHandshakeFailures++;
1860 SM_ENTER(WPA_PTK, DISCONNECT);
1861 } else if (sm->TimeoutEvt)
1862 SM_ENTER(WPA_PTK, PTKINITNEGOTIATING);
1864 case WPA_PTK_PTKINITDONE:
1870 SM_STATE(WPA_PTK_GROUP, IDLE)
1872 SM_ENTRY_MA(WPA_PTK_GROUP, IDLE, wpa_ptk_group);
1874 /* Init flag is not cleared here, so avoid busy
1875 * loop by claiming nothing changed. */
1876 sm->changed = FALSE;
1878 sm->GTimeoutCtr = 0;
1882 SM_STATE(WPA_PTK_GROUP, REKEYNEGOTIATING)
1884 u8 rsc[WPA_KEY_RSC_LEN];
1885 struct wpa_group *gsm = sm->group;
1886 u8 *kde, *pos, hdr[2];
1889 SM_ENTRY_MA(WPA_PTK_GROUP, REKEYNEGOTIATING, wpa_ptk_group);
1892 if (sm->GTimeoutCtr > (int) dot11RSNAConfigGroupUpdateCount) {
1893 /* No point in sending the EAPOL-Key - we will disconnect
1894 * immediately following this. */
1898 if (sm->wpa == WPA_VERSION_WPA)
1899 sm->PInitAKeys = FALSE;
1900 sm->TimeoutEvt = FALSE;
1901 /* Send EAPOL(1, 1, 1, !Pair, G, RSC, GNonce, MIC(PTK), GTK[GN]) */
1902 os_memset(rsc, 0, WPA_KEY_RSC_LEN);
1903 if (gsm->wpa_group_state == WPA_GROUP_SETKEYSDONE)
1904 wpa_auth_get_seqnum(sm->wpa_auth, NULL, gsm->GN, rsc);
1905 wpa_auth_logger(sm->wpa_auth, sm->addr, LOGGER_DEBUG,
1906 "sending 1/2 msg of Group Key Handshake");
1908 if (sm->wpa == WPA_VERSION_WPA2) {
1909 kde_len = 2 + RSN_SELECTOR_LEN + 2 + gsm->GTK_len +
1910 ieee80211w_kde_len(sm);
1911 kde = os_malloc(kde_len);
1916 hdr[0] = gsm->GN & 0x03;
1918 pos = wpa_add_kde(pos, RSN_KEY_DATA_GROUPKEY, hdr, 2,
1919 gsm->GTK[gsm->GN - 1], gsm->GTK_len);
1920 pos = ieee80211w_kde_add(sm, pos);
1922 kde = gsm->GTK[gsm->GN - 1];
1923 pos = kde + gsm->GTK_len;
1926 wpa_send_eapol(sm->wpa_auth, sm,
1927 WPA_KEY_INFO_SECURE | WPA_KEY_INFO_MIC |
1929 (!sm->Pair ? WPA_KEY_INFO_INSTALL : 0),
1930 rsc, gsm->GNonce, kde, pos - kde, gsm->GN, 1);
1931 if (sm->wpa == WPA_VERSION_WPA2)
1936 SM_STATE(WPA_PTK_GROUP, REKEYESTABLISHED)
1938 SM_ENTRY_MA(WPA_PTK_GROUP, REKEYESTABLISHED, wpa_ptk_group);
1939 sm->EAPOLKeyReceived = FALSE;
1940 if (sm->GUpdateStationKeys)
1941 sm->group->GKeyDoneStations--;
1942 sm->GUpdateStationKeys = FALSE;
1943 sm->GTimeoutCtr = 0;
1944 /* FIX: MLME.SetProtection.Request(TA, Tx_Rx) */
1945 wpa_auth_vlogger(sm->wpa_auth, sm->addr, LOGGER_INFO,
1946 "group key handshake completed (%s)",
1947 sm->wpa == WPA_VERSION_WPA ? "WPA" : "RSN");
1952 SM_STATE(WPA_PTK_GROUP, KEYERROR)
1954 SM_ENTRY_MA(WPA_PTK_GROUP, KEYERROR, wpa_ptk_group);
1955 if (sm->GUpdateStationKeys)
1956 sm->group->GKeyDoneStations--;
1957 sm->GUpdateStationKeys = FALSE;
1958 sm->Disconnect = TRUE;
1962 SM_STEP(WPA_PTK_GROUP)
1964 if (sm->Init || sm->PtkGroupInit) {
1965 SM_ENTER(WPA_PTK_GROUP, IDLE);
1966 sm->PtkGroupInit = FALSE;
1967 } else switch (sm->wpa_ptk_group_state) {
1968 case WPA_PTK_GROUP_IDLE:
1969 if (sm->GUpdateStationKeys ||
1970 (sm->wpa == WPA_VERSION_WPA && sm->PInitAKeys))
1971 SM_ENTER(WPA_PTK_GROUP, REKEYNEGOTIATING);
1973 case WPA_PTK_GROUP_REKEYNEGOTIATING:
1974 if (sm->EAPOLKeyReceived && !sm->EAPOLKeyRequest &&
1975 !sm->EAPOLKeyPairwise && sm->MICVerified)
1976 SM_ENTER(WPA_PTK_GROUP, REKEYESTABLISHED);
1977 else if (sm->GTimeoutCtr >
1978 (int) dot11RSNAConfigGroupUpdateCount)
1979 SM_ENTER(WPA_PTK_GROUP, KEYERROR);
1980 else if (sm->TimeoutEvt)
1981 SM_ENTER(WPA_PTK_GROUP, REKEYNEGOTIATING);
1983 case WPA_PTK_GROUP_KEYERROR:
1984 SM_ENTER(WPA_PTK_GROUP, IDLE);
1986 case WPA_PTK_GROUP_REKEYESTABLISHED:
1987 SM_ENTER(WPA_PTK_GROUP, IDLE);
1993 static int wpa_gtk_update(struct wpa_authenticator *wpa_auth,
1994 struct wpa_group *group)
1998 /* FIX: is this the correct way of getting GNonce? */
1999 os_memcpy(group->GNonce, group->Counter, WPA_NONCE_LEN);
2000 inc_byte_array(group->Counter, WPA_NONCE_LEN);
2001 wpa_gmk_to_gtk(group->GMK, wpa_auth->addr, group->GNonce,
2002 group->GTK[group->GN - 1], group->GTK_len);
2004 #ifdef CONFIG_IEEE80211W
2005 if (wpa_auth->conf.ieee80211w != NO_MGMT_FRAME_PROTECTION) {
2006 if (os_get_random(group->IGTK[group->GN_igtk - 4],
2007 WPA_IGTK_LEN) < 0) {
2008 wpa_printf(MSG_INFO, "RSN: Failed to get new random "
2012 wpa_hexdump_key(MSG_DEBUG, "IGTK",
2013 group->IGTK[group->GN_igtk - 4], WPA_IGTK_LEN);
2015 #endif /* CONFIG_IEEE80211W */
2021 static void wpa_group_gtk_init(struct wpa_authenticator *wpa_auth,
2022 struct wpa_group *group)
2024 wpa_printf(MSG_DEBUG, "WPA: group state machine entering state "
2025 "GTK_INIT (VLAN-ID %d)", group->vlan_id);
2026 group->changed = FALSE; /* GInit is not cleared here; avoid loop */
2027 group->wpa_group_state = WPA_GROUP_GTK_INIT;
2030 os_memset(group->GTK, 0, sizeof(group->GTK));
2033 #ifdef CONFIG_IEEE80211W
2036 #endif /* CONFIG_IEEE80211W */
2037 /* GTK[GN] = CalcGTK() */
2038 wpa_gtk_update(wpa_auth, group);
2042 static int wpa_group_update_sta(struct wpa_state_machine *sm, void *ctx)
2044 if (sm->wpa_ptk_state != WPA_PTK_PTKINITDONE) {
2045 wpa_auth_logger(sm->wpa_auth, sm->addr, LOGGER_DEBUG,
2046 "Not in PTKINITDONE; skip Group Key update");
2049 if (sm->GUpdateStationKeys) {
2051 * This should not really happen, but just in case, make sure
2052 * we do not count the same STA twice in GKeyDoneStations.
2054 wpa_auth_logger(sm->wpa_auth, sm->addr, LOGGER_DEBUG,
2055 "GUpdateStationKeys already set - do not "
2056 "increment GKeyDoneStations");
2058 sm->group->GKeyDoneStations++;
2059 sm->GUpdateStationKeys = TRUE;
2066 static void wpa_group_setkeys(struct wpa_authenticator *wpa_auth,
2067 struct wpa_group *group)
2071 wpa_printf(MSG_DEBUG, "WPA: group state machine entering state "
2072 "SETKEYS (VLAN-ID %d)", group->vlan_id);
2073 group->changed = TRUE;
2074 group->wpa_group_state = WPA_GROUP_SETKEYS;
2075 group->GTKReKey = FALSE;
2077 group->GM = group->GN;
2079 #ifdef CONFIG_IEEE80211W
2080 tmp = group->GM_igtk;
2081 group->GM_igtk = group->GN_igtk;
2082 group->GN_igtk = tmp;
2083 #endif /* CONFIG_IEEE80211W */
2084 /* "GKeyDoneStations = GNoStations" is done in more robust way by
2085 * counting the STAs that are marked with GUpdateStationKeys instead of
2086 * including all STAs that could be in not-yet-completed state. */
2087 wpa_gtk_update(wpa_auth, group);
2089 wpa_auth_for_each_sta(wpa_auth, wpa_group_update_sta, NULL);
2090 wpa_printf(MSG_DEBUG, "wpa_group_setkeys: GKeyDoneStations=%d",
2091 group->GKeyDoneStations);
2095 static void wpa_group_setkeysdone(struct wpa_authenticator *wpa_auth,
2096 struct wpa_group *group)
2098 wpa_printf(MSG_DEBUG, "WPA: group state machine entering state "
2099 "SETKEYSDONE (VLAN-ID %d)", group->vlan_id);
2100 group->changed = TRUE;
2101 group->wpa_group_state = WPA_GROUP_SETKEYSDONE;
2102 wpa_auth_set_key(wpa_auth, group->vlan_id,
2103 wpa_alg_enum(wpa_auth->conf.wpa_group),
2104 NULL, group->GN, group->GTK[group->GN - 1],
2107 #ifdef CONFIG_IEEE80211W
2108 if (wpa_auth->conf.ieee80211w != NO_MGMT_FRAME_PROTECTION) {
2109 wpa_auth_set_key(wpa_auth, group->vlan_id, WPA_ALG_IGTK,
2110 NULL, group->GN_igtk,
2111 group->IGTK[group->GN_igtk - 4],
2114 #endif /* CONFIG_IEEE80211W */
2118 static void wpa_group_sm_step(struct wpa_authenticator *wpa_auth,
2119 struct wpa_group *group)
2122 wpa_group_gtk_init(wpa_auth, group);
2123 } else if (group->wpa_group_state == WPA_GROUP_GTK_INIT &&
2124 group->GTKAuthenticator) {
2125 wpa_group_setkeysdone(wpa_auth, group);
2126 } else if (group->wpa_group_state == WPA_GROUP_SETKEYSDONE &&
2128 wpa_group_setkeys(wpa_auth, group);
2129 } else if (group->wpa_group_state == WPA_GROUP_SETKEYS) {
2130 if (group->GKeyDoneStations == 0)
2131 wpa_group_setkeysdone(wpa_auth, group);
2132 else if (group->GTKReKey)
2133 wpa_group_setkeys(wpa_auth, group);
2138 static int wpa_sm_step(struct wpa_state_machine *sm)
2143 if (sm->in_step_loop) {
2144 /* This should not happen, but if it does, make sure we do not
2145 * end up freeing the state machine too early by exiting the
2146 * recursive call. */
2147 wpa_printf(MSG_ERROR, "WPA: wpa_sm_step() called recursively");
2151 sm->in_step_loop = 1;
2153 if (sm->pending_deinit)
2156 sm->changed = FALSE;
2157 sm->wpa_auth->group->changed = FALSE;
2159 SM_STEP_RUN(WPA_PTK);
2160 if (sm->pending_deinit)
2162 SM_STEP_RUN(WPA_PTK_GROUP);
2163 if (sm->pending_deinit)
2165 wpa_group_sm_step(sm->wpa_auth, sm->group);
2166 } while (sm->changed || sm->wpa_auth->group->changed);
2167 sm->in_step_loop = 0;
2169 if (sm->pending_deinit) {
2170 wpa_printf(MSG_DEBUG, "WPA: Completing pending STA state "
2171 "machine deinit for " MACSTR, MAC2STR(sm->addr));
2172 wpa_free_sta_sm(sm);
2179 static void wpa_sm_call_step(void *eloop_ctx, void *timeout_ctx)
2181 struct wpa_state_machine *sm = eloop_ctx;
2186 void wpa_auth_sm_notify(struct wpa_state_machine *sm)
2190 eloop_register_timeout(0, 0, wpa_sm_call_step, sm, NULL);
2194 void wpa_gtk_rekey(struct wpa_authenticator *wpa_auth)
2197 struct wpa_group *group;
2199 if (wpa_auth == NULL)
2202 group = wpa_auth->group;
2204 for (i = 0; i < 2; i++) {
2206 group->GM = group->GN;
2208 #ifdef CONFIG_IEEE80211W
2209 tmp = group->GM_igtk;
2210 group->GM_igtk = group->GN_igtk;
2211 group->GN_igtk = tmp;
2212 #endif /* CONFIG_IEEE80211W */
2213 wpa_gtk_update(wpa_auth, group);
2218 static const char * wpa_bool_txt(int bool)
2220 return bool ? "TRUE" : "FALSE";
2224 static int wpa_cipher_bits(int cipher)
2227 case WPA_CIPHER_CCMP:
2229 case WPA_CIPHER_TKIP:
2231 case WPA_CIPHER_WEP104:
2233 case WPA_CIPHER_WEP40:
2241 #define RSN_SUITE "%02x-%02x-%02x-%d"
2242 #define RSN_SUITE_ARG(s) \
2243 ((s) >> 24) & 0xff, ((s) >> 16) & 0xff, ((s) >> 8) & 0xff, (s) & 0xff
2245 int wpa_get_mib(struct wpa_authenticator *wpa_auth, char *buf, size_t buflen)
2248 char pmkid_txt[PMKID_LEN * 2 + 1];
2250 if (wpa_auth == NULL)
2253 ret = os_snprintf(buf + len, buflen - len,
2254 "dot11RSNAOptionImplemented=TRUE\n"
2255 #ifdef CONFIG_RSN_PREAUTH
2256 "dot11RSNAPreauthenticationImplemented=TRUE\n"
2257 #else /* CONFIG_RSN_PREAUTH */
2258 "dot11RSNAPreauthenticationImplemented=FALSE\n"
2259 #endif /* CONFIG_RSN_PREAUTH */
2260 "dot11RSNAEnabled=%s\n"
2261 "dot11RSNAPreauthenticationEnabled=%s\n",
2262 wpa_bool_txt(wpa_auth->conf.wpa & WPA_PROTO_RSN),
2263 wpa_bool_txt(wpa_auth->conf.rsn_preauth));
2264 if (ret < 0 || (size_t) ret >= buflen - len)
2268 wpa_snprintf_hex(pmkid_txt, sizeof(pmkid_txt),
2269 wpa_auth->dot11RSNAPMKIDUsed, PMKID_LEN);
2272 buf + len, buflen - len,
2273 "dot11RSNAConfigVersion=%u\n"
2274 "dot11RSNAConfigPairwiseKeysSupported=9999\n"
2275 /* FIX: dot11RSNAConfigGroupCipher */
2276 /* FIX: dot11RSNAConfigGroupRekeyMethod */
2277 /* FIX: dot11RSNAConfigGroupRekeyTime */
2278 /* FIX: dot11RSNAConfigGroupRekeyPackets */
2279 "dot11RSNAConfigGroupRekeyStrict=%u\n"
2280 "dot11RSNAConfigGroupUpdateCount=%u\n"
2281 "dot11RSNAConfigPairwiseUpdateCount=%u\n"
2282 "dot11RSNAConfigGroupCipherSize=%u\n"
2283 "dot11RSNAConfigPMKLifetime=%u\n"
2284 "dot11RSNAConfigPMKReauthThreshold=%u\n"
2285 "dot11RSNAConfigNumberOfPTKSAReplayCounters=0\n"
2286 "dot11RSNAConfigSATimeout=%u\n"
2287 "dot11RSNAAuthenticationSuiteSelected=" RSN_SUITE "\n"
2288 "dot11RSNAPairwiseCipherSelected=" RSN_SUITE "\n"
2289 "dot11RSNAGroupCipherSelected=" RSN_SUITE "\n"
2290 "dot11RSNAPMKIDUsed=%s\n"
2291 "dot11RSNAAuthenticationSuiteRequested=" RSN_SUITE "\n"
2292 "dot11RSNAPairwiseCipherRequested=" RSN_SUITE "\n"
2293 "dot11RSNAGroupCipherRequested=" RSN_SUITE "\n"
2294 "dot11RSNATKIPCounterMeasuresInvoked=%u\n"
2295 "dot11RSNA4WayHandshakeFailures=%u\n"
2296 "dot11RSNAConfigNumberOfGTKSAReplayCounters=0\n",
2298 !!wpa_auth->conf.wpa_strict_rekey,
2299 dot11RSNAConfigGroupUpdateCount,
2300 dot11RSNAConfigPairwiseUpdateCount,
2301 wpa_cipher_bits(wpa_auth->conf.wpa_group),
2302 dot11RSNAConfigPMKLifetime,
2303 dot11RSNAConfigPMKReauthThreshold,
2304 dot11RSNAConfigSATimeout,
2305 RSN_SUITE_ARG(wpa_auth->dot11RSNAAuthenticationSuiteSelected),
2306 RSN_SUITE_ARG(wpa_auth->dot11RSNAPairwiseCipherSelected),
2307 RSN_SUITE_ARG(wpa_auth->dot11RSNAGroupCipherSelected),
2309 RSN_SUITE_ARG(wpa_auth->dot11RSNAAuthenticationSuiteRequested),
2310 RSN_SUITE_ARG(wpa_auth->dot11RSNAPairwiseCipherRequested),
2311 RSN_SUITE_ARG(wpa_auth->dot11RSNAGroupCipherRequested),
2312 wpa_auth->dot11RSNATKIPCounterMeasuresInvoked,
2313 wpa_auth->dot11RSNA4WayHandshakeFailures);
2314 if (ret < 0 || (size_t) ret >= buflen - len)
2318 /* TODO: dot11RSNAConfigPairwiseCiphersTable */
2319 /* TODO: dot11RSNAConfigAuthenticationSuitesTable */
2322 ret = os_snprintf(buf + len, buflen - len, "hostapdWPAGroupState=%d\n",
2323 wpa_auth->group->wpa_group_state);
2324 if (ret < 0 || (size_t) ret >= buflen - len)
2332 int wpa_get_mib_sta(struct wpa_state_machine *sm, char *buf, size_t buflen)
2340 /* TODO: FF-FF-FF-FF-FF-FF entry for broadcast/multicast stats */
2342 /* dot11RSNAStatsEntry */
2344 if (sm->wpa == WPA_VERSION_WPA) {
2345 if (sm->pairwise == WPA_CIPHER_CCMP)
2346 pairwise = WPA_CIPHER_SUITE_CCMP;
2347 else if (sm->pairwise == WPA_CIPHER_TKIP)
2348 pairwise = WPA_CIPHER_SUITE_TKIP;
2349 else if (sm->pairwise == WPA_CIPHER_WEP104)
2350 pairwise = WPA_CIPHER_SUITE_WEP104;
2351 else if (sm->pairwise == WPA_CIPHER_WEP40)
2352 pairwise = WPA_CIPHER_SUITE_WEP40;
2353 else if (sm->pairwise == WPA_CIPHER_NONE)
2354 pairwise = WPA_CIPHER_SUITE_NONE;
2355 } else if (sm->wpa == WPA_VERSION_WPA2) {
2356 if (sm->pairwise == WPA_CIPHER_CCMP)
2357 pairwise = RSN_CIPHER_SUITE_CCMP;
2358 else if (sm->pairwise == WPA_CIPHER_TKIP)
2359 pairwise = RSN_CIPHER_SUITE_TKIP;
2360 else if (sm->pairwise == WPA_CIPHER_WEP104)
2361 pairwise = RSN_CIPHER_SUITE_WEP104;
2362 else if (sm->pairwise == WPA_CIPHER_WEP40)
2363 pairwise = RSN_CIPHER_SUITE_WEP40;
2364 else if (sm->pairwise == WPA_CIPHER_NONE)
2365 pairwise = RSN_CIPHER_SUITE_NONE;
2370 buf + len, buflen - len,
2371 /* TODO: dot11RSNAStatsIndex */
2372 "dot11RSNAStatsSTAAddress=" MACSTR "\n"
2373 "dot11RSNAStatsVersion=1\n"
2374 "dot11RSNAStatsSelectedPairwiseCipher=" RSN_SUITE "\n"
2375 /* TODO: dot11RSNAStatsTKIPICVErrors */
2376 "dot11RSNAStatsTKIPLocalMICFailures=%u\n"
2377 "dot11RSNAStatsTKIPRemoveMICFailures=%u\n"
2378 /* TODO: dot11RSNAStatsCCMPReplays */
2379 /* TODO: dot11RSNAStatsCCMPDecryptErrors */
2380 /* TODO: dot11RSNAStatsTKIPReplays */,
2382 RSN_SUITE_ARG(pairwise),
2383 sm->dot11RSNAStatsTKIPLocalMICFailures,
2384 sm->dot11RSNAStatsTKIPRemoteMICFailures);
2385 if (ret < 0 || (size_t) ret >= buflen - len)
2390 ret = os_snprintf(buf + len, buflen - len,
2391 "hostapdWPAPTKState=%d\n"
2392 "hostapdWPAPTKGroupState=%d\n",
2394 sm->wpa_ptk_group_state);
2395 if (ret < 0 || (size_t) ret >= buflen - len)
2403 void wpa_auth_countermeasures_start(struct wpa_authenticator *wpa_auth)
2406 wpa_auth->dot11RSNATKIPCounterMeasuresInvoked++;
2410 int wpa_auth_pairwise_set(struct wpa_state_machine *sm)
2412 return sm && sm->pairwise_set;
2416 int wpa_auth_get_pairwise(struct wpa_state_machine *sm)
2418 return sm->pairwise;
2422 int wpa_auth_sta_key_mgmt(struct wpa_state_machine *sm)
2426 return sm->wpa_key_mgmt;
2430 int wpa_auth_sta_wpa_version(struct wpa_state_machine *sm)
2438 int wpa_auth_sta_clear_pmksa(struct wpa_state_machine *sm,
2439 struct rsn_pmksa_cache_entry *entry)
2441 if (sm == NULL || sm->pmksa != entry)
2448 struct rsn_pmksa_cache_entry *
2449 wpa_auth_sta_get_pmksa(struct wpa_state_machine *sm)
2451 return sm ? sm->pmksa : NULL;
2455 void wpa_auth_sta_local_mic_failure_report(struct wpa_state_machine *sm)
2458 sm->dot11RSNAStatsTKIPLocalMICFailures++;
2462 const u8 * wpa_auth_get_wpa_ie(struct wpa_authenticator *wpa_auth, size_t *len)
2464 if (wpa_auth == NULL)
2466 *len = wpa_auth->wpa_ie_len;
2467 return wpa_auth->wpa_ie;
2471 int wpa_auth_pmksa_add(struct wpa_state_machine *sm, const u8 *pmk,
2472 int session_timeout, struct eapol_state_machine *eapol)
2474 if (sm == NULL || sm->wpa != WPA_VERSION_WPA2)
2477 if (pmksa_cache_auth_add(sm->wpa_auth->pmksa, pmk, PMK_LEN,
2478 sm->wpa_auth->addr, sm->addr, session_timeout,
2479 eapol, sm->wpa_key_mgmt))
2486 int wpa_auth_pmksa_add_preauth(struct wpa_authenticator *wpa_auth,
2487 const u8 *pmk, size_t len, const u8 *sta_addr,
2488 int session_timeout,
2489 struct eapol_state_machine *eapol)
2491 if (wpa_auth == NULL)
2494 if (pmksa_cache_auth_add(wpa_auth->pmksa, pmk, len, wpa_auth->addr,
2495 sta_addr, session_timeout, eapol,
2496 WPA_KEY_MGMT_IEEE8021X))
2503 static struct wpa_group *
2504 wpa_auth_add_group(struct wpa_authenticator *wpa_auth, int vlan_id)
2506 struct wpa_group *group;
2508 if (wpa_auth == NULL || wpa_auth->group == NULL)
2511 wpa_printf(MSG_DEBUG, "WPA: Add group state machine for VLAN-ID %d",
2513 group = wpa_group_init(wpa_auth, vlan_id);
2517 group->next = wpa_auth->group->next;
2518 wpa_auth->group->next = group;
2524 int wpa_auth_sta_set_vlan(struct wpa_state_machine *sm, int vlan_id)
2526 struct wpa_group *group;
2528 if (sm == NULL || sm->wpa_auth == NULL)
2531 group = sm->wpa_auth->group;
2533 if (group->vlan_id == vlan_id)
2535 group = group->next;
2538 if (group == NULL) {
2539 group = wpa_auth_add_group(sm->wpa_auth, vlan_id);
2544 if (sm->group == group)
2547 wpa_printf(MSG_DEBUG, "WPA: Moving STA " MACSTR " to use group state "
2548 "machine for VLAN ID %d", MAC2STR(sm->addr), vlan_id);