2 * IEEE 802.1X-2004 Authenticator - EAPOL state machine
3 * Copyright (c) 2002-2009, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
13 #include "state_machine.h"
14 #include "common/eapol_common.h"
15 #include "eap_common/eap_defs.h"
16 #include "eap_common/eap_common.h"
17 #include "eap_server/eap.h"
18 #include "eapol_auth_sm.h"
19 #include "eapol_auth_sm_i.h"
21 #define STATE_MACHINE_DATA struct eapol_state_machine
22 #define STATE_MACHINE_DEBUG_PREFIX "IEEE 802.1X"
23 #define STATE_MACHINE_ADDR sm->addr
25 static struct eapol_callbacks eapol_cb;
27 /* EAPOL state machines are described in IEEE Std 802.1X-2004, Chap. 8.2 */
29 #define setPortAuthorized() \
30 sm->eapol->cb.set_port_authorized(sm->eapol->conf.ctx, sm->sta, 1)
31 #define setPortUnauthorized() \
32 sm->eapol->cb.set_port_authorized(sm->eapol->conf.ctx, sm->sta, 0)
35 #define txCannedFail() eapol_auth_tx_canned_eap(sm, 0)
36 #define txCannedSuccess() eapol_auth_tx_canned_eap(sm, 1)
37 #define txReq() eapol_auth_tx_req(sm)
38 #define abortAuth() sm->eapol->cb.abort_auth(sm->eapol->conf.ctx, sm->sta)
39 #define txKey() sm->eapol->cb.tx_key(sm->eapol->conf.ctx, sm->sta)
40 #define processKey() do { } while (0)
43 static void eapol_sm_step_run(struct eapol_state_machine *sm);
44 static void eapol_sm_step_cb(void *eloop_ctx, void *timeout_ctx);
45 static void eapol_auth_initialize(struct eapol_state_machine *sm);
48 static void eapol_auth_logger(struct eapol_authenticator *eapol,
49 const u8 *addr, eapol_logger_level level,
52 if (eapol->cb.logger == NULL)
54 eapol->cb.logger(eapol->conf.ctx, addr, level, txt);
58 static void eapol_auth_vlogger(struct eapol_authenticator *eapol,
59 const u8 *addr, eapol_logger_level level,
66 if (eapol->cb.logger == NULL)
69 maxlen = os_strlen(fmt) + 100;
70 format = os_malloc(maxlen);
75 vsnprintf(format, maxlen, fmt, ap);
78 eapol_auth_logger(eapol, addr, level, format);
84 static void eapol_auth_tx_canned_eap(struct eapol_state_machine *sm,
89 os_memset(&eap, 0, sizeof(eap));
91 eap.code = success ? EAP_CODE_SUCCESS : EAP_CODE_FAILURE;
92 eap.identifier = ++sm->last_eap_id;
93 eap.length = host_to_be16(sizeof(eap));
95 eapol_auth_vlogger(sm->eapol, sm->addr, EAPOL_LOGGER_DEBUG,
96 "Sending canned EAP packet %s (identifier %d)",
97 success ? "SUCCESS" : "FAILURE", eap.identifier);
98 sm->eapol->cb.eapol_send(sm->eapol->conf.ctx, sm->sta,
99 IEEE802_1X_TYPE_EAP_PACKET,
100 (u8 *) &eap, sizeof(eap));
101 sm->dot1xAuthEapolFramesTx++;
105 static void eapol_auth_tx_req(struct eapol_state_machine *sm)
107 if (sm->eap_if->eapReqData == NULL ||
108 wpabuf_len(sm->eap_if->eapReqData) < sizeof(struct eap_hdr)) {
109 eapol_auth_logger(sm->eapol, sm->addr,
111 "TxReq called, but there is no EAP request "
112 "from authentication server");
116 if (sm->flags & EAPOL_SM_WAIT_START) {
117 wpa_printf(MSG_DEBUG, "EAPOL: Drop EAPOL TX to " MACSTR
118 " while waiting for EAPOL-Start",
123 sm->last_eap_id = eap_get_id(sm->eap_if->eapReqData);
124 eapol_auth_vlogger(sm->eapol, sm->addr, EAPOL_LOGGER_DEBUG,
125 "Sending EAP Packet (identifier %d)",
127 sm->eapol->cb.eapol_send(sm->eapol->conf.ctx, sm->sta,
128 IEEE802_1X_TYPE_EAP_PACKET,
129 wpabuf_head(sm->eap_if->eapReqData),
130 wpabuf_len(sm->eap_if->eapReqData));
131 sm->dot1xAuthEapolFramesTx++;
132 if (eap_get_type(sm->eap_if->eapReqData) == EAP_TYPE_IDENTITY)
133 sm->dot1xAuthEapolReqIdFramesTx++;
135 sm->dot1xAuthEapolReqFramesTx++;
140 * eapol_port_timers_tick - Port Timers state machine
141 * @eloop_ctx: struct eapol_state_machine *
142 * @timeout_ctx: Not used
144 * This statemachine is implemented as a function that will be called
145 * once a second as a registered event loop timeout.
147 static void eapol_port_timers_tick(void *eloop_ctx, void *timeout_ctx)
149 struct eapol_state_machine *state = timeout_ctx;
151 if (state->aWhile > 0) {
153 if (state->aWhile == 0) {
154 wpa_printf(MSG_DEBUG, "IEEE 802.1X: " MACSTR
156 MAC2STR(state->addr));
160 if (state->quietWhile > 0) {
162 if (state->quietWhile == 0) {
163 wpa_printf(MSG_DEBUG, "IEEE 802.1X: " MACSTR
164 " - quietWhile --> 0",
165 MAC2STR(state->addr));
169 if (state->reAuthWhen > 0) {
171 if (state->reAuthWhen == 0) {
172 wpa_printf(MSG_DEBUG, "IEEE 802.1X: " MACSTR
173 " - reAuthWhen --> 0",
174 MAC2STR(state->addr));
178 if (state->eap_if->retransWhile > 0) {
179 state->eap_if->retransWhile--;
180 if (state->eap_if->retransWhile == 0) {
181 wpa_printf(MSG_DEBUG, "IEEE 802.1X: " MACSTR
182 " - (EAP) retransWhile --> 0",
183 MAC2STR(state->addr));
187 eapol_sm_step_run(state);
189 eloop_register_timeout(1, 0, eapol_port_timers_tick, eloop_ctx, state);
194 /* Authenticator PAE state machine */
196 SM_STATE(AUTH_PAE, INITIALIZE)
198 SM_ENTRY_MA(AUTH_PAE, INITIALIZE, auth_pae);
203 SM_STATE(AUTH_PAE, DISCONNECTED)
205 int from_initialize = sm->auth_pae_state == AUTH_PAE_INITIALIZE;
207 if (sm->eapolLogoff) {
208 if (sm->auth_pae_state == AUTH_PAE_CONNECTING)
209 sm->authEapLogoffsWhileConnecting++;
210 else if (sm->auth_pae_state == AUTH_PAE_AUTHENTICATED)
211 sm->authAuthEapLogoffWhileAuthenticated++;
214 SM_ENTRY_MA(AUTH_PAE, DISCONNECTED, auth_pae);
216 sm->authPortStatus = Unauthorized;
217 setPortUnauthorized();
219 sm->eapolLogoff = FALSE;
220 if (!from_initialize) {
221 sm->eapol->cb.finished(sm->eapol->conf.ctx, sm->sta, 0,
222 sm->flags & EAPOL_SM_PREAUTH);
227 SM_STATE(AUTH_PAE, RESTART)
229 if (sm->auth_pae_state == AUTH_PAE_AUTHENTICATED) {
230 if (sm->reAuthenticate)
231 sm->authAuthReauthsWhileAuthenticated++;
233 sm->authAuthEapStartsWhileAuthenticated++;
235 sm->authAuthEapLogoffWhileAuthenticated++;
238 SM_ENTRY_MA(AUTH_PAE, RESTART, auth_pae);
240 sm->eap_if->eapRestart = TRUE;
244 SM_STATE(AUTH_PAE, CONNECTING)
246 if (sm->auth_pae_state != AUTH_PAE_CONNECTING)
247 sm->authEntersConnecting++;
249 SM_ENTRY_MA(AUTH_PAE, CONNECTING, auth_pae);
251 sm->reAuthenticate = FALSE;
256 SM_STATE(AUTH_PAE, HELD)
258 if (sm->auth_pae_state == AUTH_PAE_AUTHENTICATING && sm->authFail)
259 sm->authAuthFailWhileAuthenticating++;
261 SM_ENTRY_MA(AUTH_PAE, HELD, auth_pae);
263 sm->authPortStatus = Unauthorized;
264 setPortUnauthorized();
265 sm->quietWhile = sm->quietPeriod;
266 sm->eapolLogoff = FALSE;
268 eapol_auth_vlogger(sm->eapol, sm->addr, EAPOL_LOGGER_WARNING,
269 "authentication failed - EAP type: %d (%s)",
270 sm->eap_type_authsrv,
271 eap_server_get_name(0, sm->eap_type_authsrv));
272 if (sm->eap_type_authsrv != sm->eap_type_supp) {
273 eapol_auth_vlogger(sm->eapol, sm->addr, EAPOL_LOGGER_INFO,
274 "Supplicant used different EAP type: "
275 "%d (%s)", sm->eap_type_supp,
276 eap_server_get_name(0, sm->eap_type_supp));
278 sm->eapol->cb.finished(sm->eapol->conf.ctx, sm->sta, 0,
279 sm->flags & EAPOL_SM_PREAUTH);
283 SM_STATE(AUTH_PAE, AUTHENTICATED)
287 if (sm->auth_pae_state == AUTH_PAE_AUTHENTICATING && sm->authSuccess)
288 sm->authAuthSuccessesWhileAuthenticating++;
290 SM_ENTRY_MA(AUTH_PAE, AUTHENTICATED, auth_pae);
292 sm->authPortStatus = Authorized;
295 if (sm->flags & EAPOL_SM_PREAUTH)
296 extra = " (pre-authentication)";
297 else if (sm->flags & EAPOL_SM_FROM_PMKSA_CACHE)
298 extra = " (PMKSA cache)";
299 eapol_auth_vlogger(sm->eapol, sm->addr, EAPOL_LOGGER_INFO,
300 "authenticated - EAP type: %d (%s)%s",
301 sm->eap_type_authsrv,
302 eap_server_get_name(0, sm->eap_type_authsrv),
304 sm->eapol->cb.finished(sm->eapol->conf.ctx, sm->sta, 1,
305 sm->flags & EAPOL_SM_PREAUTH);
309 SM_STATE(AUTH_PAE, AUTHENTICATING)
311 SM_ENTRY_MA(AUTH_PAE, AUTHENTICATING, auth_pae);
313 sm->eapolStart = FALSE;
314 sm->authSuccess = FALSE;
315 sm->authFail = FALSE;
316 sm->authTimeout = FALSE;
317 sm->authStart = TRUE;
323 SM_STATE(AUTH_PAE, ABORTING)
325 if (sm->auth_pae_state == AUTH_PAE_AUTHENTICATING) {
327 sm->authAuthTimeoutsWhileAuthenticating++;
329 sm->authAuthEapStartsWhileAuthenticating++;
331 sm->authAuthEapLogoffWhileAuthenticating++;
334 SM_ENTRY_MA(AUTH_PAE, ABORTING, auth_pae);
336 sm->authAbort = TRUE;
342 SM_STATE(AUTH_PAE, FORCE_AUTH)
344 SM_ENTRY_MA(AUTH_PAE, FORCE_AUTH, auth_pae);
346 sm->authPortStatus = Authorized;
348 sm->portMode = ForceAuthorized;
349 sm->eapolStart = FALSE;
354 SM_STATE(AUTH_PAE, FORCE_UNAUTH)
356 SM_ENTRY_MA(AUTH_PAE, FORCE_UNAUTH, auth_pae);
358 sm->authPortStatus = Unauthorized;
359 setPortUnauthorized();
360 sm->portMode = ForceUnauthorized;
361 sm->eapolStart = FALSE;
368 if ((sm->portControl == Auto && sm->portMode != sm->portControl) ||
369 sm->initialize || !sm->eap_if->portEnabled)
370 SM_ENTER_GLOBAL(AUTH_PAE, INITIALIZE);
371 else if (sm->portControl == ForceAuthorized &&
372 sm->portMode != sm->portControl &&
373 !(sm->initialize || !sm->eap_if->portEnabled))
374 SM_ENTER_GLOBAL(AUTH_PAE, FORCE_AUTH);
375 else if (sm->portControl == ForceUnauthorized &&
376 sm->portMode != sm->portControl &&
377 !(sm->initialize || !sm->eap_if->portEnabled))
378 SM_ENTER_GLOBAL(AUTH_PAE, FORCE_UNAUTH);
380 switch (sm->auth_pae_state) {
381 case AUTH_PAE_INITIALIZE:
382 SM_ENTER(AUTH_PAE, DISCONNECTED);
384 case AUTH_PAE_DISCONNECTED:
385 SM_ENTER(AUTH_PAE, RESTART);
387 case AUTH_PAE_RESTART:
388 if (!sm->eap_if->eapRestart)
389 SM_ENTER(AUTH_PAE, CONNECTING);
392 if (sm->quietWhile == 0)
393 SM_ENTER(AUTH_PAE, RESTART);
395 case AUTH_PAE_CONNECTING:
396 if (sm->eapolLogoff || sm->reAuthCount > sm->reAuthMax)
397 SM_ENTER(AUTH_PAE, DISCONNECTED);
398 else if ((sm->eap_if->eapReq &&
399 sm->reAuthCount <= sm->reAuthMax) ||
400 sm->eap_if->eapSuccess || sm->eap_if->eapFail)
401 SM_ENTER(AUTH_PAE, AUTHENTICATING);
403 case AUTH_PAE_AUTHENTICATED:
404 if (sm->eapolStart || sm->reAuthenticate)
405 SM_ENTER(AUTH_PAE, RESTART);
406 else if (sm->eapolLogoff || !sm->portValid)
407 SM_ENTER(AUTH_PAE, DISCONNECTED);
409 case AUTH_PAE_AUTHENTICATING:
410 if (sm->authSuccess && sm->portValid)
411 SM_ENTER(AUTH_PAE, AUTHENTICATED);
412 else if (sm->authFail ||
413 (sm->keyDone && !sm->portValid))
414 SM_ENTER(AUTH_PAE, HELD);
415 else if (sm->eapolStart || sm->eapolLogoff ||
417 SM_ENTER(AUTH_PAE, ABORTING);
419 case AUTH_PAE_ABORTING:
420 if (sm->eapolLogoff && !sm->authAbort)
421 SM_ENTER(AUTH_PAE, DISCONNECTED);
422 else if (!sm->eapolLogoff && !sm->authAbort)
423 SM_ENTER(AUTH_PAE, RESTART);
425 case AUTH_PAE_FORCE_AUTH:
427 SM_ENTER(AUTH_PAE, FORCE_AUTH);
429 case AUTH_PAE_FORCE_UNAUTH:
431 SM_ENTER(AUTH_PAE, FORCE_UNAUTH);
439 /* Backend Authentication state machine */
441 SM_STATE(BE_AUTH, INITIALIZE)
443 SM_ENTRY_MA(BE_AUTH, INITIALIZE, be_auth);
446 sm->eap_if->eapNoReq = FALSE;
447 sm->authAbort = FALSE;
451 SM_STATE(BE_AUTH, REQUEST)
453 SM_ENTRY_MA(BE_AUTH, REQUEST, be_auth);
456 sm->eap_if->eapReq = FALSE;
457 sm->backendOtherRequestsToSupplicant++;
460 * Clearing eapolEap here is not specified in IEEE Std 802.1X-2004, but
461 * it looks like this would be logical thing to do there since the old
462 * EAP response would not be valid anymore after the new EAP request
465 * A race condition has been reported, in which hostapd ended up
466 * sending out EAP-Response/Identity as a response to the first
467 * EAP-Request from the main EAP method. This can be avoided by
468 * clearing eapolEap here.
470 sm->eapolEap = FALSE;
474 SM_STATE(BE_AUTH, RESPONSE)
476 SM_ENTRY_MA(BE_AUTH, RESPONSE, be_auth);
478 sm->authTimeout = FALSE;
479 sm->eapolEap = FALSE;
480 sm->eap_if->eapNoReq = FALSE;
481 sm->aWhile = sm->serverTimeout;
482 sm->eap_if->eapResp = TRUE;
483 /* sendRespToServer(); */
484 sm->backendResponses++;
488 SM_STATE(BE_AUTH, SUCCESS)
490 SM_ENTRY_MA(BE_AUTH, SUCCESS, be_auth);
493 sm->authSuccess = TRUE;
498 SM_STATE(BE_AUTH, FAIL)
500 SM_ENTRY_MA(BE_AUTH, FAIL, be_auth);
507 SM_STATE(BE_AUTH, TIMEOUT)
509 SM_ENTRY_MA(BE_AUTH, TIMEOUT, be_auth);
511 sm->authTimeout = TRUE;
515 SM_STATE(BE_AUTH, IDLE)
517 SM_ENTRY_MA(BE_AUTH, IDLE, be_auth);
519 sm->authStart = FALSE;
523 SM_STATE(BE_AUTH, IGNORE)
525 SM_ENTRY_MA(BE_AUTH, IGNORE, be_auth);
527 sm->eap_if->eapNoReq = FALSE;
533 if (sm->portControl != Auto || sm->initialize || sm->authAbort) {
534 SM_ENTER_GLOBAL(BE_AUTH, INITIALIZE);
538 switch (sm->be_auth_state) {
539 case BE_AUTH_INITIALIZE:
540 SM_ENTER(BE_AUTH, IDLE);
542 case BE_AUTH_REQUEST:
544 SM_ENTER(BE_AUTH, RESPONSE);
545 else if (sm->eap_if->eapReq)
546 SM_ENTER(BE_AUTH, REQUEST);
547 else if (sm->eap_if->eapTimeout)
548 SM_ENTER(BE_AUTH, TIMEOUT);
550 case BE_AUTH_RESPONSE:
551 if (sm->eap_if->eapNoReq)
552 SM_ENTER(BE_AUTH, IGNORE);
553 if (sm->eap_if->eapReq) {
554 sm->backendAccessChallenges++;
555 SM_ENTER(BE_AUTH, REQUEST);
556 } else if (sm->aWhile == 0)
557 SM_ENTER(BE_AUTH, TIMEOUT);
558 else if (sm->eap_if->eapFail) {
559 sm->backendAuthFails++;
560 SM_ENTER(BE_AUTH, FAIL);
561 } else if (sm->eap_if->eapSuccess) {
562 sm->backendAuthSuccesses++;
563 SM_ENTER(BE_AUTH, SUCCESS);
566 case BE_AUTH_SUCCESS:
567 SM_ENTER(BE_AUTH, IDLE);
570 SM_ENTER(BE_AUTH, IDLE);
572 case BE_AUTH_TIMEOUT:
573 SM_ENTER(BE_AUTH, IDLE);
576 if (sm->eap_if->eapFail && sm->authStart)
577 SM_ENTER(BE_AUTH, FAIL);
578 else if (sm->eap_if->eapReq && sm->authStart)
579 SM_ENTER(BE_AUTH, REQUEST);
580 else if (sm->eap_if->eapSuccess && sm->authStart)
581 SM_ENTER(BE_AUTH, SUCCESS);
585 SM_ENTER(BE_AUTH, RESPONSE);
586 else if (sm->eap_if->eapReq)
587 SM_ENTER(BE_AUTH, REQUEST);
588 else if (sm->eap_if->eapTimeout)
589 SM_ENTER(BE_AUTH, TIMEOUT);
596 /* Reauthentication Timer state machine */
598 SM_STATE(REAUTH_TIMER, INITIALIZE)
600 SM_ENTRY_MA(REAUTH_TIMER, INITIALIZE, reauth_timer);
602 sm->reAuthWhen = sm->reAuthPeriod;
606 SM_STATE(REAUTH_TIMER, REAUTHENTICATE)
608 SM_ENTRY_MA(REAUTH_TIMER, REAUTHENTICATE, reauth_timer);
610 sm->reAuthenticate = TRUE;
611 sm->eapol->cb.eapol_event(sm->eapol->conf.ctx, sm->sta,
612 EAPOL_AUTH_REAUTHENTICATE);
616 SM_STEP(REAUTH_TIMER)
618 if (sm->portControl != Auto || sm->initialize ||
619 sm->authPortStatus == Unauthorized || !sm->reAuthEnabled) {
620 SM_ENTER_GLOBAL(REAUTH_TIMER, INITIALIZE);
624 switch (sm->reauth_timer_state) {
625 case REAUTH_TIMER_INITIALIZE:
626 if (sm->reAuthWhen == 0)
627 SM_ENTER(REAUTH_TIMER, REAUTHENTICATE);
629 case REAUTH_TIMER_REAUTHENTICATE:
630 SM_ENTER(REAUTH_TIMER, INITIALIZE);
637 /* Authenticator Key Transmit state machine */
639 SM_STATE(AUTH_KEY_TX, NO_KEY_TRANSMIT)
641 SM_ENTRY_MA(AUTH_KEY_TX, NO_KEY_TRANSMIT, auth_key_tx);
645 SM_STATE(AUTH_KEY_TX, KEY_TRANSMIT)
647 SM_ENTRY_MA(AUTH_KEY_TX, KEY_TRANSMIT, auth_key_tx);
650 sm->eap_if->eapKeyAvailable = FALSE;
657 if (sm->initialize || sm->portControl != Auto) {
658 SM_ENTER_GLOBAL(AUTH_KEY_TX, NO_KEY_TRANSMIT);
662 switch (sm->auth_key_tx_state) {
663 case AUTH_KEY_TX_NO_KEY_TRANSMIT:
664 if (sm->keyTxEnabled && sm->eap_if->eapKeyAvailable &&
665 sm->keyRun && !(sm->flags & EAPOL_SM_USES_WPA))
666 SM_ENTER(AUTH_KEY_TX, KEY_TRANSMIT);
668 case AUTH_KEY_TX_KEY_TRANSMIT:
669 if (!sm->keyTxEnabled || !sm->keyRun)
670 SM_ENTER(AUTH_KEY_TX, NO_KEY_TRANSMIT);
671 else if (sm->eap_if->eapKeyAvailable)
672 SM_ENTER(AUTH_KEY_TX, KEY_TRANSMIT);
679 /* Key Receive state machine */
681 SM_STATE(KEY_RX, NO_KEY_RECEIVE)
683 SM_ENTRY_MA(KEY_RX, NO_KEY_RECEIVE, key_rx);
687 SM_STATE(KEY_RX, KEY_RECEIVE)
689 SM_ENTRY_MA(KEY_RX, KEY_RECEIVE, key_rx);
698 if (sm->initialize || !sm->eap_if->portEnabled) {
699 SM_ENTER_GLOBAL(KEY_RX, NO_KEY_RECEIVE);
703 switch (sm->key_rx_state) {
704 case KEY_RX_NO_KEY_RECEIVE:
706 SM_ENTER(KEY_RX, KEY_RECEIVE);
708 case KEY_RX_KEY_RECEIVE:
710 SM_ENTER(KEY_RX, KEY_RECEIVE);
717 /* Controlled Directions state machine */
719 SM_STATE(CTRL_DIR, FORCE_BOTH)
721 SM_ENTRY_MA(CTRL_DIR, FORCE_BOTH, ctrl_dir);
722 sm->operControlledDirections = Both;
726 SM_STATE(CTRL_DIR, IN_OR_BOTH)
728 SM_ENTRY_MA(CTRL_DIR, IN_OR_BOTH, ctrl_dir);
729 sm->operControlledDirections = sm->adminControlledDirections;
735 if (sm->initialize) {
736 SM_ENTER_GLOBAL(CTRL_DIR, IN_OR_BOTH);
740 switch (sm->ctrl_dir_state) {
741 case CTRL_DIR_FORCE_BOTH:
742 if (sm->eap_if->portEnabled && sm->operEdge)
743 SM_ENTER(CTRL_DIR, IN_OR_BOTH);
745 case CTRL_DIR_IN_OR_BOTH:
746 if (sm->operControlledDirections !=
747 sm->adminControlledDirections)
748 SM_ENTER(CTRL_DIR, IN_OR_BOTH);
749 if (!sm->eap_if->portEnabled || !sm->operEdge)
750 SM_ENTER(CTRL_DIR, FORCE_BOTH);
757 struct eapol_state_machine *
758 eapol_auth_alloc(struct eapol_authenticator *eapol, const u8 *addr,
759 int flags, const struct wpabuf *assoc_wps_ie,
760 const struct wpabuf *assoc_p2p_ie, void *sta_ctx,
761 const char *identity, const char *radius_cui)
763 struct eapol_state_machine *sm;
764 struct eap_config eap_conf;
769 sm = os_zalloc(sizeof(*sm));
771 wpa_printf(MSG_DEBUG, "IEEE 802.1X state machine allocation "
775 sm->radius_identifier = -1;
776 os_memcpy(sm->addr, addr, ETH_ALEN);
782 /* Set default values for state machine constants */
783 sm->auth_pae_state = AUTH_PAE_INITIALIZE;
784 sm->quietPeriod = AUTH_PAE_DEFAULT_quietPeriod;
785 sm->reAuthMax = AUTH_PAE_DEFAULT_reAuthMax;
787 sm->be_auth_state = BE_AUTH_INITIALIZE;
788 sm->serverTimeout = BE_AUTH_DEFAULT_serverTimeout;
790 sm->reauth_timer_state = REAUTH_TIMER_INITIALIZE;
791 sm->reAuthPeriod = eapol->conf.eap_reauth_period;
792 sm->reAuthEnabled = eapol->conf.eap_reauth_period > 0 ? TRUE : FALSE;
794 sm->auth_key_tx_state = AUTH_KEY_TX_NO_KEY_TRANSMIT;
796 sm->key_rx_state = KEY_RX_NO_KEY_RECEIVE;
798 sm->ctrl_dir_state = CTRL_DIR_IN_OR_BOTH;
800 sm->portControl = Auto;
802 if (!eapol->conf.wpa &&
803 (eapol->default_wep_key || eapol->conf.individual_wep_key_len > 0))
804 sm->keyTxEnabled = TRUE;
806 sm->keyTxEnabled = FALSE;
808 sm->portValid = FALSE;
810 sm->portValid = TRUE;
812 os_memset(&eap_conf, 0, sizeof(eap_conf));
813 eap_conf.eap_server = eapol->conf.eap_server;
814 eap_conf.ssl_ctx = eapol->conf.ssl_ctx;
815 eap_conf.msg_ctx = eapol->conf.msg_ctx;
816 eap_conf.eap_sim_db_priv = eapol->conf.eap_sim_db_priv;
817 eap_conf.pac_opaque_encr_key = eapol->conf.pac_opaque_encr_key;
818 eap_conf.eap_fast_a_id = eapol->conf.eap_fast_a_id;
819 eap_conf.eap_fast_a_id_len = eapol->conf.eap_fast_a_id_len;
820 eap_conf.eap_fast_a_id_info = eapol->conf.eap_fast_a_id_info;
821 eap_conf.eap_fast_prov = eapol->conf.eap_fast_prov;
822 eap_conf.pac_key_lifetime = eapol->conf.pac_key_lifetime;
823 eap_conf.pac_key_refresh_time = eapol->conf.pac_key_refresh_time;
824 eap_conf.eap_sim_aka_result_ind = eapol->conf.eap_sim_aka_result_ind;
825 eap_conf.tnc = eapol->conf.tnc;
826 eap_conf.wps = eapol->conf.wps;
827 eap_conf.assoc_wps_ie = assoc_wps_ie;
828 eap_conf.assoc_p2p_ie = assoc_p2p_ie;
829 eap_conf.peer_addr = addr;
830 eap_conf.fragment_size = eapol->conf.fragment_size;
831 eap_conf.pwd_group = eapol->conf.pwd_group;
832 eap_conf.pbc_in_m1 = eapol->conf.pbc_in_m1;
833 eap_conf.server_id = eapol->conf.server_id;
834 eap_conf.server_id_len = eapol->conf.server_id_len;
835 sm->eap = eap_server_sm_init(sm, &eapol_cb, &eap_conf);
836 if (sm->eap == NULL) {
840 sm->eap_if = eap_get_interface(sm->eap);
842 eapol_auth_initialize(sm);
845 sm->identity = (u8 *) os_strdup(identity);
847 sm->identity_len = os_strlen(identity);
850 sm->radius_cui = wpabuf_alloc_copy(radius_cui,
851 os_strlen(radius_cui));
857 void eapol_auth_free(struct eapol_state_machine *sm)
862 eloop_cancel_timeout(eapol_port_timers_tick, NULL, sm);
863 eloop_cancel_timeout(eapol_sm_step_cb, sm, NULL);
865 eap_server_sm_deinit(sm->eap);
870 static int eapol_sm_sta_entry_alive(struct eapol_authenticator *eapol,
873 return eapol->cb.sta_entry_alive(eapol->conf.ctx, addr);
877 static void eapol_sm_step_run(struct eapol_state_machine *sm)
879 struct eapol_authenticator *eapol = sm->eapol;
881 unsigned int prev_auth_pae, prev_be_auth, prev_reauth_timer,
882 prev_auth_key_tx, prev_key_rx, prev_ctrl_dir;
885 os_memcpy(addr, sm->addr, ETH_ALEN);
888 * Allow EAPOL state machines to run as long as there are state
889 * changes, but exit and return here through event loop if more than
890 * 100 steps is needed as a precaution against infinite loops inside
894 prev_auth_pae = sm->auth_pae_state;
895 prev_be_auth = sm->be_auth_state;
896 prev_reauth_timer = sm->reauth_timer_state;
897 prev_auth_key_tx = sm->auth_key_tx_state;
898 prev_key_rx = sm->key_rx_state;
899 prev_ctrl_dir = sm->ctrl_dir_state;
901 SM_STEP_RUN(AUTH_PAE);
902 if (sm->initializing || eapol_sm_sta_entry_alive(eapol, addr))
903 SM_STEP_RUN(BE_AUTH);
904 if (sm->initializing || eapol_sm_sta_entry_alive(eapol, addr))
905 SM_STEP_RUN(REAUTH_TIMER);
906 if (sm->initializing || eapol_sm_sta_entry_alive(eapol, addr))
907 SM_STEP_RUN(AUTH_KEY_TX);
908 if (sm->initializing || eapol_sm_sta_entry_alive(eapol, addr))
910 if (sm->initializing || eapol_sm_sta_entry_alive(eapol, addr))
911 SM_STEP_RUN(CTRL_DIR);
913 if (prev_auth_pae != sm->auth_pae_state ||
914 prev_be_auth != sm->be_auth_state ||
915 prev_reauth_timer != sm->reauth_timer_state ||
916 prev_auth_key_tx != sm->auth_key_tx_state ||
917 prev_key_rx != sm->key_rx_state ||
918 prev_ctrl_dir != sm->ctrl_dir_state) {
921 /* Re-run from eloop timeout */
926 if (eapol_sm_sta_entry_alive(eapol, addr) && sm->eap) {
927 if (eap_server_sm_step(sm->eap)) {
930 /* Re-run from eloop timeout */
935 /* TODO: find a better location for this */
936 if (sm->eap_if->aaaEapResp) {
937 sm->eap_if->aaaEapResp = FALSE;
938 if (sm->eap_if->aaaEapRespData == NULL) {
939 wpa_printf(MSG_DEBUG, "EAPOL: aaaEapResp set, "
940 "but no aaaEapRespData available");
943 sm->eapol->cb.aaa_send(
944 sm->eapol->conf.ctx, sm->sta,
945 wpabuf_head(sm->eap_if->aaaEapRespData),
946 wpabuf_len(sm->eap_if->aaaEapRespData));
950 if (eapol_sm_sta_entry_alive(eapol, addr))
951 sm->eapol->cb.eapol_event(sm->eapol->conf.ctx, sm->sta,
952 EAPOL_AUTH_SM_CHANGE);
956 static void eapol_sm_step_cb(void *eloop_ctx, void *timeout_ctx)
958 struct eapol_state_machine *sm = eloop_ctx;
959 eapol_sm_step_run(sm);
964 * eapol_auth_step - Advance EAPOL state machines
965 * @sm: EAPOL state machine
967 * This function is called to advance EAPOL state machines after any change
968 * that could affect their state.
970 void eapol_auth_step(struct eapol_state_machine *sm)
973 * Run eapol_sm_step_run from a registered timeout to make sure that
974 * other possible timeouts/events are processed and to avoid long
975 * function call chains.
978 eloop_register_timeout(0, 0, eapol_sm_step_cb, sm, NULL);
982 static void eapol_auth_initialize(struct eapol_state_machine *sm)
984 sm->initializing = TRUE;
985 /* Initialize the state machines by asserting initialize and then
986 * deasserting it after one step */
987 sm->initialize = TRUE;
988 eapol_sm_step_run(sm);
989 sm->initialize = FALSE;
990 eapol_sm_step_run(sm);
991 sm->initializing = FALSE;
993 /* Start one second tick for port timers state machine */
994 eloop_cancel_timeout(eapol_port_timers_tick, NULL, sm);
995 eloop_register_timeout(1, 0, eapol_port_timers_tick, NULL, sm);
999 static int eapol_sm_get_eap_user(void *ctx, const u8 *identity,
1000 size_t identity_len, int phase2,
1001 struct eap_user *user)
1003 struct eapol_state_machine *sm = ctx;
1004 return sm->eapol->cb.get_eap_user(sm->eapol->conf.ctx, identity,
1005 identity_len, phase2, user);
1009 static const char * eapol_sm_get_eap_req_id_text(void *ctx, size_t *len)
1011 struct eapol_state_machine *sm = ctx;
1012 *len = sm->eapol->conf.eap_req_id_text_len;
1013 return sm->eapol->conf.eap_req_id_text;
1017 static struct eapol_callbacks eapol_cb =
1019 eapol_sm_get_eap_user,
1020 eapol_sm_get_eap_req_id_text
1024 int eapol_auth_eap_pending_cb(struct eapol_state_machine *sm, void *ctx)
1026 if (sm == NULL || ctx == NULL || ctx != sm->eap)
1029 eap_sm_pending_cb(sm->eap);
1030 eapol_auth_step(sm);
1036 static int eapol_auth_conf_clone(struct eapol_auth_config *dst,
1037 struct eapol_auth_config *src)
1039 dst->ctx = src->ctx;
1040 dst->eap_reauth_period = src->eap_reauth_period;
1041 dst->wpa = src->wpa;
1042 dst->individual_wep_key_len = src->individual_wep_key_len;
1043 dst->eap_server = src->eap_server;
1044 dst->ssl_ctx = src->ssl_ctx;
1045 dst->msg_ctx = src->msg_ctx;
1046 dst->eap_sim_db_priv = src->eap_sim_db_priv;
1047 os_free(dst->eap_req_id_text);
1048 dst->pwd_group = src->pwd_group;
1049 dst->pbc_in_m1 = src->pbc_in_m1;
1050 dst->server_id = src->server_id;
1051 dst->server_id_len = src->server_id_len;
1052 if (src->eap_req_id_text) {
1053 dst->eap_req_id_text = os_malloc(src->eap_req_id_text_len);
1054 if (dst->eap_req_id_text == NULL)
1056 os_memcpy(dst->eap_req_id_text, src->eap_req_id_text,
1057 src->eap_req_id_text_len);
1058 dst->eap_req_id_text_len = src->eap_req_id_text_len;
1060 dst->eap_req_id_text = NULL;
1061 dst->eap_req_id_text_len = 0;
1063 if (src->pac_opaque_encr_key) {
1064 dst->pac_opaque_encr_key = os_malloc(16);
1065 if (dst->pac_opaque_encr_key == NULL) {
1066 os_free(dst->eap_req_id_text);
1069 os_memcpy(dst->pac_opaque_encr_key, src->pac_opaque_encr_key,
1072 dst->pac_opaque_encr_key = NULL;
1073 if (src->eap_fast_a_id) {
1074 dst->eap_fast_a_id = os_malloc(src->eap_fast_a_id_len);
1075 if (dst->eap_fast_a_id == NULL) {
1076 os_free(dst->eap_req_id_text);
1077 os_free(dst->pac_opaque_encr_key);
1080 os_memcpy(dst->eap_fast_a_id, src->eap_fast_a_id,
1081 src->eap_fast_a_id_len);
1082 dst->eap_fast_a_id_len = src->eap_fast_a_id_len;
1084 dst->eap_fast_a_id = NULL;
1085 if (src->eap_fast_a_id_info) {
1086 dst->eap_fast_a_id_info = os_strdup(src->eap_fast_a_id_info);
1087 if (dst->eap_fast_a_id_info == NULL) {
1088 os_free(dst->eap_req_id_text);
1089 os_free(dst->pac_opaque_encr_key);
1090 os_free(dst->eap_fast_a_id);
1094 dst->eap_fast_a_id_info = NULL;
1095 dst->eap_fast_prov = src->eap_fast_prov;
1096 dst->pac_key_lifetime = src->pac_key_lifetime;
1097 dst->pac_key_refresh_time = src->pac_key_refresh_time;
1098 dst->eap_sim_aka_result_ind = src->eap_sim_aka_result_ind;
1099 dst->tnc = src->tnc;
1100 dst->wps = src->wps;
1101 dst->fragment_size = src->fragment_size;
1106 static void eapol_auth_conf_free(struct eapol_auth_config *conf)
1108 os_free(conf->eap_req_id_text);
1109 conf->eap_req_id_text = NULL;
1110 os_free(conf->pac_opaque_encr_key);
1111 conf->pac_opaque_encr_key = NULL;
1112 os_free(conf->eap_fast_a_id);
1113 conf->eap_fast_a_id = NULL;
1114 os_free(conf->eap_fast_a_id_info);
1115 conf->eap_fast_a_id_info = NULL;
1119 struct eapol_authenticator * eapol_auth_init(struct eapol_auth_config *conf,
1120 struct eapol_auth_cb *cb)
1122 struct eapol_authenticator *eapol;
1124 eapol = os_zalloc(sizeof(*eapol));
1128 if (eapol_auth_conf_clone(&eapol->conf, conf) < 0) {
1133 if (conf->individual_wep_key_len > 0) {
1134 /* use key0 in individual key and key1 in broadcast key */
1135 eapol->default_wep_key_idx = 1;
1138 eapol->cb.eapol_send = cb->eapol_send;
1139 eapol->cb.aaa_send = cb->aaa_send;
1140 eapol->cb.finished = cb->finished;
1141 eapol->cb.get_eap_user = cb->get_eap_user;
1142 eapol->cb.sta_entry_alive = cb->sta_entry_alive;
1143 eapol->cb.logger = cb->logger;
1144 eapol->cb.set_port_authorized = cb->set_port_authorized;
1145 eapol->cb.abort_auth = cb->abort_auth;
1146 eapol->cb.tx_key = cb->tx_key;
1147 eapol->cb.eapol_event = cb->eapol_event;
1153 void eapol_auth_deinit(struct eapol_authenticator *eapol)
1158 eapol_auth_conf_free(&eapol->conf);
1159 os_free(eapol->default_wep_key);