2 * EAP peer state machines (RFC 4137)
3 * Copyright (c) 2004-2008, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
14 * This file implements the Peer State Machine as defined in RFC 4137. The used
15 * states and state transitions match mostly with the RFC. However, there are
16 * couple of additional transitions for working around small issues noticed
17 * during testing. These exceptions are explained in comments within the
18 * functions in this file. The method functions, m.func(), are similar to the
19 * ones used in RFC 4137, but some small changes have used here to optimize
20 * operations and to add functionality needed for fast re-authentication
21 * (session resumption).
28 #include "eap_config.h"
31 #include "pcsc_funcs.h"
33 #include "state_machine.h"
35 #define STATE_MACHINE_DATA struct eap_sm
36 #define STATE_MACHINE_DEBUG_PREFIX "EAP"
38 #define EAP_MAX_AUTH_ROUNDS 50
41 static Boolean eap_sm_allowMethod(struct eap_sm *sm, int vendor,
43 static struct wpabuf * eap_sm_buildNak(struct eap_sm *sm, int id);
44 static void eap_sm_processIdentity(struct eap_sm *sm,
45 const struct wpabuf *req);
46 static void eap_sm_processNotify(struct eap_sm *sm, const struct wpabuf *req);
47 static struct wpabuf * eap_sm_buildNotify(int id);
48 static void eap_sm_parseEapReq(struct eap_sm *sm, const struct wpabuf *req);
49 #if defined(CONFIG_CTRL_IFACE) || !defined(CONFIG_NO_STDOUT_DEBUG)
50 static const char * eap_sm_method_state_txt(EapMethodState state);
51 static const char * eap_sm_decision_txt(EapDecision decision);
52 #endif /* CONFIG_CTRL_IFACE || !CONFIG_NO_STDOUT_DEBUG */
56 static Boolean eapol_get_bool(struct eap_sm *sm, enum eapol_bool_var var)
58 return sm->eapol_cb->get_bool(sm->eapol_ctx, var);
62 static void eapol_set_bool(struct eap_sm *sm, enum eapol_bool_var var,
65 sm->eapol_cb->set_bool(sm->eapol_ctx, var, value);
69 static unsigned int eapol_get_int(struct eap_sm *sm, enum eapol_int_var var)
71 return sm->eapol_cb->get_int(sm->eapol_ctx, var);
75 static void eapol_set_int(struct eap_sm *sm, enum eapol_int_var var,
78 sm->eapol_cb->set_int(sm->eapol_ctx, var, value);
82 static struct wpabuf * eapol_get_eapReqData(struct eap_sm *sm)
84 return sm->eapol_cb->get_eapReqData(sm->eapol_ctx);
88 static void eap_deinit_prev_method(struct eap_sm *sm, const char *txt)
90 if (sm->m == NULL || sm->eap_method_priv == NULL)
93 wpa_printf(MSG_DEBUG, "EAP: deinitialize previously used EAP method "
94 "(%d, %s) at %s", sm->selectedMethod, sm->m->name, txt);
95 sm->m->deinit(sm, sm->eap_method_priv);
96 sm->eap_method_priv = NULL;
102 * eap_allowed_method - Check whether EAP method is allowed
103 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
104 * @vendor: Vendor-Id for expanded types or 0 = IETF for legacy types
106 * Returns: 1 = allowed EAP method, 0 = not allowed
108 static int eap_allowed_method(struct eap_sm *sm, int vendor, u32 method)
110 struct eap_peer_config *config = eap_get_config(sm);
112 struct eap_method_type *m;
114 if (config == NULL || config->eap_methods == NULL)
117 m = config->eap_methods;
118 for (i = 0; m[i].vendor != EAP_VENDOR_IETF ||
119 m[i].method != EAP_TYPE_NONE; i++) {
120 if (m[i].vendor == vendor && m[i].method == method)
128 * This state initializes state machine variables when the machine is
129 * activated (portEnabled = TRUE). This is also used when re-starting
130 * authentication (eapRestart == TRUE).
132 SM_STATE(EAP, INITIALIZE)
134 SM_ENTRY(EAP, INITIALIZE);
135 if (sm->fast_reauth && sm->m && sm->m->has_reauth_data &&
136 sm->m->has_reauth_data(sm, sm->eap_method_priv)) {
137 wpa_printf(MSG_DEBUG, "EAP: maintaining EAP method data for "
138 "fast reauthentication");
139 sm->m->deinit_for_reauth(sm, sm->eap_method_priv);
141 eap_deinit_prev_method(sm, "INITIALIZE");
143 sm->selectedMethod = EAP_TYPE_NONE;
144 sm->methodState = METHOD_NONE;
145 sm->allowNotifications = TRUE;
146 sm->decision = DECISION_FAIL;
147 eapol_set_int(sm, EAPOL_idleWhile, sm->ClientTimeout);
148 eapol_set_bool(sm, EAPOL_eapSuccess, FALSE);
149 eapol_set_bool(sm, EAPOL_eapFail, FALSE);
150 os_free(sm->eapKeyData);
151 sm->eapKeyData = NULL;
152 sm->eapKeyAvailable = FALSE;
153 eapol_set_bool(sm, EAPOL_eapRestart, FALSE);
154 sm->lastId = -1; /* new session - make sure this does not match with
155 * the first EAP-Packet */
157 * RFC 4137 does not reset eapResp and eapNoResp here. However, this
158 * seemed to be able to trigger cases where both were set and if EAPOL
159 * state machine uses eapNoResp first, it may end up not sending a real
160 * reply correctly. This occurred when the workaround in FAIL state set
161 * eapNoResp = TRUE.. Maybe that workaround needs to be fixed to do
164 eapol_set_bool(sm, EAPOL_eapResp, FALSE);
165 eapol_set_bool(sm, EAPOL_eapNoResp, FALSE);
171 * This state is reached whenever service from the lower layer is interrupted
172 * or unavailable (portEnabled == FALSE). Immediate transition to INITIALIZE
173 * occurs when the port becomes enabled.
175 SM_STATE(EAP, DISABLED)
177 SM_ENTRY(EAP, DISABLED);
183 * The state machine spends most of its time here, waiting for something to
184 * happen. This state is entered unconditionally from INITIALIZE, DISCARD, and
185 * SEND_RESPONSE states.
194 * This state is entered when an EAP packet is received (eapReq == TRUE) to
195 * parse the packet header.
197 SM_STATE(EAP, RECEIVED)
199 const struct wpabuf *eapReqData;
201 SM_ENTRY(EAP, RECEIVED);
202 eapReqData = eapol_get_eapReqData(sm);
203 /* parse rxReq, rxSuccess, rxFailure, reqId, reqMethod */
204 eap_sm_parseEapReq(sm, eapReqData);
210 * This state is entered when a request for a new type comes in. Either the
211 * correct method is started, or a Nak response is built.
213 SM_STATE(EAP, GET_METHOD)
218 SM_ENTRY(EAP, GET_METHOD);
220 if (sm->reqMethod == EAP_TYPE_EXPANDED)
221 method = sm->reqVendorMethod;
223 method = sm->reqMethod;
225 if (!eap_sm_allowMethod(sm, sm->reqVendor, method)) {
226 wpa_printf(MSG_DEBUG, "EAP: vendor %u method %u not allowed",
227 sm->reqVendor, method);
232 * RFC 4137 does not define specific operation for fast
233 * re-authentication (session resumption). The design here is to allow
234 * the previously used method data to be maintained for
235 * re-authentication if the method support session resumption.
236 * Otherwise, the previously used method data is freed and a new method
239 if (sm->fast_reauth &&
240 sm->m && sm->m->vendor == sm->reqVendor &&
241 sm->m->method == method &&
242 sm->m->has_reauth_data &&
243 sm->m->has_reauth_data(sm, sm->eap_method_priv)) {
244 wpa_printf(MSG_DEBUG, "EAP: Using previous method data"
245 " for fast re-authentication");
248 eap_deinit_prev_method(sm, "GET_METHOD");
252 sm->selectedMethod = sm->reqMethod;
254 sm->m = eap_peer_get_eap_method(sm->reqVendor, method);
256 wpa_printf(MSG_DEBUG, "EAP: Could not find selected method: "
257 "vendor %d method %d",
258 sm->reqVendor, method);
262 wpa_printf(MSG_DEBUG, "EAP: Initialize selected EAP method: "
263 "vendor %u method %u (%s)",
264 sm->reqVendor, method, sm->m->name);
266 sm->eap_method_priv = sm->m->init_for_reauth(
267 sm, sm->eap_method_priv);
269 sm->eap_method_priv = sm->m->init(sm);
271 if (sm->eap_method_priv == NULL) {
272 struct eap_peer_config *config = eap_get_config(sm);
273 wpa_msg(sm->msg_ctx, MSG_INFO,
274 "EAP: Failed to initialize EAP method: vendor %u "
276 sm->reqVendor, method, sm->m->name);
278 sm->methodState = METHOD_NONE;
279 sm->selectedMethod = EAP_TYPE_NONE;
280 if (sm->reqMethod == EAP_TYPE_TLS && config &&
281 (config->pending_req_pin ||
282 config->pending_req_passphrase)) {
284 * Return without generating Nak in order to allow
285 * entering of PIN code or passphrase to retry the
286 * current EAP packet.
288 wpa_printf(MSG_DEBUG, "EAP: Pending PIN/passphrase "
289 "request - skip Nak");
296 sm->methodState = METHOD_INIT;
297 wpa_msg(sm->msg_ctx, MSG_INFO, WPA_EVENT_EAP_METHOD
298 "EAP vendor %u method %u (%s) selected",
299 sm->reqVendor, method, sm->m->name);
303 wpabuf_free(sm->eapRespData);
304 sm->eapRespData = NULL;
305 sm->eapRespData = eap_sm_buildNak(sm, sm->reqId);
310 * The method processing happens here. The request from the authenticator is
311 * processed, and an appropriate response packet is built.
313 SM_STATE(EAP, METHOD)
315 struct wpabuf *eapReqData;
316 struct eap_method_ret ret;
318 SM_ENTRY(EAP, METHOD);
320 wpa_printf(MSG_WARNING, "EAP::METHOD - method not selected");
324 eapReqData = eapol_get_eapReqData(sm);
327 * Get ignore, methodState, decision, allowNotifications, and
328 * eapRespData. RFC 4137 uses three separate method procedure (check,
329 * process, and buildResp) in this state. These have been combined into
330 * a single function call to m->process() in order to optimize EAP
331 * method implementation interface a bit. These procedures are only
332 * used from within this METHOD state, so there is no need to keep
333 * these as separate C functions.
335 * The RFC 4137 procedures return values as follows:
336 * ignore = m.check(eapReqData)
337 * (methodState, decision, allowNotifications) = m.process(eapReqData)
338 * eapRespData = m.buildResp(reqId)
340 os_memset(&ret, 0, sizeof(ret));
341 ret.ignore = sm->ignore;
342 ret.methodState = sm->methodState;
343 ret.decision = sm->decision;
344 ret.allowNotifications = sm->allowNotifications;
345 wpabuf_free(sm->eapRespData);
346 sm->eapRespData = NULL;
347 sm->eapRespData = sm->m->process(sm, sm->eap_method_priv, &ret,
349 wpa_printf(MSG_DEBUG, "EAP: method process -> ignore=%s "
350 "methodState=%s decision=%s",
351 ret.ignore ? "TRUE" : "FALSE",
352 eap_sm_method_state_txt(ret.methodState),
353 eap_sm_decision_txt(ret.decision));
355 sm->ignore = ret.ignore;
358 sm->methodState = ret.methodState;
359 sm->decision = ret.decision;
360 sm->allowNotifications = ret.allowNotifications;
362 if (sm->m->isKeyAvailable && sm->m->getKey &&
363 sm->m->isKeyAvailable(sm, sm->eap_method_priv)) {
364 os_free(sm->eapKeyData);
365 sm->eapKeyData = sm->m->getKey(sm, sm->eap_method_priv,
372 * This state signals the lower layer that a response packet is ready to be
375 SM_STATE(EAP, SEND_RESPONSE)
377 SM_ENTRY(EAP, SEND_RESPONSE);
378 wpabuf_free(sm->lastRespData);
379 if (sm->eapRespData) {
381 os_memcpy(sm->last_md5, sm->req_md5, 16);
382 sm->lastId = sm->reqId;
383 sm->lastRespData = wpabuf_dup(sm->eapRespData);
384 eapol_set_bool(sm, EAPOL_eapResp, TRUE);
386 sm->lastRespData = NULL;
387 eapol_set_bool(sm, EAPOL_eapReq, FALSE);
388 eapol_set_int(sm, EAPOL_idleWhile, sm->ClientTimeout);
393 * This state signals the lower layer that the request was discarded, and no
394 * response packet will be sent at this time.
396 SM_STATE(EAP, DISCARD)
398 SM_ENTRY(EAP, DISCARD);
399 eapol_set_bool(sm, EAPOL_eapReq, FALSE);
400 eapol_set_bool(sm, EAPOL_eapNoResp, TRUE);
405 * Handles requests for Identity method and builds a response.
407 SM_STATE(EAP, IDENTITY)
409 const struct wpabuf *eapReqData;
411 SM_ENTRY(EAP, IDENTITY);
412 eapReqData = eapol_get_eapReqData(sm);
413 eap_sm_processIdentity(sm, eapReqData);
414 wpabuf_free(sm->eapRespData);
415 sm->eapRespData = NULL;
416 sm->eapRespData = eap_sm_buildIdentity(sm, sm->reqId, 0);
421 * Handles requests for Notification method and builds a response.
423 SM_STATE(EAP, NOTIFICATION)
425 const struct wpabuf *eapReqData;
427 SM_ENTRY(EAP, NOTIFICATION);
428 eapReqData = eapol_get_eapReqData(sm);
429 eap_sm_processNotify(sm, eapReqData);
430 wpabuf_free(sm->eapRespData);
431 sm->eapRespData = NULL;
432 sm->eapRespData = eap_sm_buildNotify(sm->reqId);
437 * This state retransmits the previous response packet.
439 SM_STATE(EAP, RETRANSMIT)
441 SM_ENTRY(EAP, RETRANSMIT);
442 wpabuf_free(sm->eapRespData);
443 if (sm->lastRespData)
444 sm->eapRespData = wpabuf_dup(sm->lastRespData);
446 sm->eapRespData = NULL;
451 * This state is entered in case of a successful completion of authentication
452 * and state machine waits here until port is disabled or EAP authentication is
455 SM_STATE(EAP, SUCCESS)
457 SM_ENTRY(EAP, SUCCESS);
458 if (sm->eapKeyData != NULL)
459 sm->eapKeyAvailable = TRUE;
460 eapol_set_bool(sm, EAPOL_eapSuccess, TRUE);
463 * RFC 4137 does not clear eapReq here, but this seems to be required
464 * to avoid processing the same request twice when state machine is
467 eapol_set_bool(sm, EAPOL_eapReq, FALSE);
470 * RFC 4137 does not set eapNoResp here, but this seems to be required
471 * to get EAPOL Supplicant backend state machine into SUCCESS state. In
472 * addition, either eapResp or eapNoResp is required to be set after
473 * processing the received EAP frame.
475 eapol_set_bool(sm, EAPOL_eapNoResp, TRUE);
477 wpa_msg(sm->msg_ctx, MSG_INFO, WPA_EVENT_EAP_SUCCESS
478 "EAP authentication completed successfully");
483 * This state is entered in case of a failure and state machine waits here
484 * until port is disabled or EAP authentication is restarted.
486 SM_STATE(EAP, FAILURE)
488 SM_ENTRY(EAP, FAILURE);
489 eapol_set_bool(sm, EAPOL_eapFail, TRUE);
492 * RFC 4137 does not clear eapReq here, but this seems to be required
493 * to avoid processing the same request twice when state machine is
496 eapol_set_bool(sm, EAPOL_eapReq, FALSE);
499 * RFC 4137 does not set eapNoResp here. However, either eapResp or
500 * eapNoResp is required to be set after processing the received EAP
503 eapol_set_bool(sm, EAPOL_eapNoResp, TRUE);
505 wpa_msg(sm->msg_ctx, MSG_INFO, WPA_EVENT_EAP_FAILURE
506 "EAP authentication failed");
510 static int eap_success_workaround(struct eap_sm *sm, int reqId, int lastId)
513 * At least Microsoft IAS and Meetinghouse Aegis seem to be sending
514 * EAP-Success/Failure with lastId + 1 even though RFC 3748 and
515 * RFC 4137 require that reqId == lastId. In addition, it looks like
516 * Ringmaster v2.1.2.0 would be using lastId + 2 in EAP-Success.
518 * Accept this kind of Id if EAP workarounds are enabled. These are
519 * unauthenticated plaintext messages, so this should have minimal
520 * security implications (bit easier to fake EAP-Success/Failure).
522 if (sm->workaround && (reqId == ((lastId + 1) & 0xff) ||
523 reqId == ((lastId + 2) & 0xff))) {
524 wpa_printf(MSG_DEBUG, "EAP: Workaround for unexpected "
525 "identifier field in EAP Success: "
526 "reqId=%d lastId=%d (these are supposed to be "
527 "same)", reqId, lastId);
530 wpa_printf(MSG_DEBUG, "EAP: EAP-Success Id mismatch - reqId=%d "
531 "lastId=%d", reqId, lastId);
537 * RFC 4137 - Appendix A.1: EAP Peer State Machine - State transitions
540 static void eap_peer_sm_step_idle(struct eap_sm *sm)
543 * The first three transitions are from RFC 4137. The last two are
544 * local additions to handle special cases with LEAP and PEAP server
545 * not sending EAP-Success in some cases.
547 if (eapol_get_bool(sm, EAPOL_eapReq))
548 SM_ENTER(EAP, RECEIVED);
549 else if ((eapol_get_bool(sm, EAPOL_altAccept) &&
550 sm->decision != DECISION_FAIL) ||
551 (eapol_get_int(sm, EAPOL_idleWhile) == 0 &&
552 sm->decision == DECISION_UNCOND_SUCC))
553 SM_ENTER(EAP, SUCCESS);
554 else if (eapol_get_bool(sm, EAPOL_altReject) ||
555 (eapol_get_int(sm, EAPOL_idleWhile) == 0 &&
556 sm->decision != DECISION_UNCOND_SUCC) ||
557 (eapol_get_bool(sm, EAPOL_altAccept) &&
558 sm->methodState != METHOD_CONT &&
559 sm->decision == DECISION_FAIL))
560 SM_ENTER(EAP, FAILURE);
561 else if (sm->selectedMethod == EAP_TYPE_LEAP &&
562 sm->leap_done && sm->decision != DECISION_FAIL &&
563 sm->methodState == METHOD_DONE)
564 SM_ENTER(EAP, SUCCESS);
565 else if (sm->selectedMethod == EAP_TYPE_PEAP &&
566 sm->peap_done && sm->decision != DECISION_FAIL &&
567 sm->methodState == METHOD_DONE)
568 SM_ENTER(EAP, SUCCESS);
572 static int eap_peer_req_is_duplicate(struct eap_sm *sm)
576 duplicate = (sm->reqId == sm->lastId) && sm->rxReq;
577 if (sm->workaround && duplicate &&
578 os_memcmp(sm->req_md5, sm->last_md5, 16) != 0) {
580 * RFC 4137 uses (reqId == lastId) as the only verification for
581 * duplicate EAP requests. However, this misses cases where the
582 * AS is incorrectly using the same id again; and
583 * unfortunately, such implementations exist. Use MD5 hash as
584 * an extra verification for the packets being duplicate to
585 * workaround these issues.
587 wpa_printf(MSG_DEBUG, "EAP: AS used the same Id again, but "
588 "EAP packets were not identical");
589 wpa_printf(MSG_DEBUG, "EAP: workaround - assume this is not a "
598 static void eap_peer_sm_step_received(struct eap_sm *sm)
600 int duplicate = eap_peer_req_is_duplicate(sm);
603 * Two special cases below for LEAP are local additions to work around
604 * odd LEAP behavior (EAP-Success in the middle of authentication and
605 * then swapped roles). Other transitions are based on RFC 4137.
607 if (sm->rxSuccess && sm->decision != DECISION_FAIL &&
608 (sm->reqId == sm->lastId ||
609 eap_success_workaround(sm, sm->reqId, sm->lastId)))
610 SM_ENTER(EAP, SUCCESS);
611 else if (sm->methodState != METHOD_CONT &&
613 sm->decision != DECISION_UNCOND_SUCC) ||
614 (sm->rxSuccess && sm->decision == DECISION_FAIL &&
615 (sm->selectedMethod != EAP_TYPE_LEAP ||
616 sm->methodState != METHOD_MAY_CONT))) &&
617 (sm->reqId == sm->lastId ||
618 eap_success_workaround(sm, sm->reqId, sm->lastId)))
619 SM_ENTER(EAP, FAILURE);
620 else if (sm->rxReq && duplicate)
621 SM_ENTER(EAP, RETRANSMIT);
622 else if (sm->rxReq && !duplicate &&
623 sm->reqMethod == EAP_TYPE_NOTIFICATION &&
624 sm->allowNotifications)
625 SM_ENTER(EAP, NOTIFICATION);
626 else if (sm->rxReq && !duplicate &&
627 sm->selectedMethod == EAP_TYPE_NONE &&
628 sm->reqMethod == EAP_TYPE_IDENTITY)
629 SM_ENTER(EAP, IDENTITY);
630 else if (sm->rxReq && !duplicate &&
631 sm->selectedMethod == EAP_TYPE_NONE &&
632 sm->reqMethod != EAP_TYPE_IDENTITY &&
633 sm->reqMethod != EAP_TYPE_NOTIFICATION)
634 SM_ENTER(EAP, GET_METHOD);
635 else if (sm->rxReq && !duplicate &&
636 sm->reqMethod == sm->selectedMethod &&
637 sm->methodState != METHOD_DONE)
638 SM_ENTER(EAP, METHOD);
639 else if (sm->selectedMethod == EAP_TYPE_LEAP &&
640 (sm->rxSuccess || sm->rxResp))
641 SM_ENTER(EAP, METHOD);
643 SM_ENTER(EAP, DISCARD);
647 static void eap_peer_sm_step_local(struct eap_sm *sm)
649 switch (sm->EAP_state) {
654 if (eapol_get_bool(sm, EAPOL_portEnabled) &&
656 SM_ENTER(EAP, INITIALIZE);
659 eap_peer_sm_step_idle(sm);
662 eap_peer_sm_step_received(sm);
665 if (sm->selectedMethod == sm->reqMethod)
666 SM_ENTER(EAP, METHOD);
668 SM_ENTER(EAP, SEND_RESPONSE);
672 SM_ENTER(EAP, DISCARD);
674 SM_ENTER(EAP, SEND_RESPONSE);
676 case EAP_SEND_RESPONSE:
683 SM_ENTER(EAP, SEND_RESPONSE);
685 case EAP_NOTIFICATION:
686 SM_ENTER(EAP, SEND_RESPONSE);
689 SM_ENTER(EAP, SEND_RESPONSE);
701 /* Global transitions */
702 if (eapol_get_bool(sm, EAPOL_eapRestart) &&
703 eapol_get_bool(sm, EAPOL_portEnabled))
704 SM_ENTER_GLOBAL(EAP, INITIALIZE);
705 else if (!eapol_get_bool(sm, EAPOL_portEnabled) || sm->force_disabled)
706 SM_ENTER_GLOBAL(EAP, DISABLED);
707 else if (sm->num_rounds > EAP_MAX_AUTH_ROUNDS) {
708 /* RFC 4137 does not place any limit on number of EAP messages
709 * in an authentication session. However, some error cases have
710 * ended up in a state were EAP messages were sent between the
711 * peer and server in a loop (e.g., TLS ACK frame in both
712 * direction). Since this is quite undesired outcome, limit the
713 * total number of EAP round-trips and abort authentication if
714 * this limit is exceeded.
716 if (sm->num_rounds == EAP_MAX_AUTH_ROUNDS + 1) {
717 wpa_msg(sm->msg_ctx, MSG_INFO, "EAP: more than %d "
718 "authentication rounds - abort",
719 EAP_MAX_AUTH_ROUNDS);
721 SM_ENTER_GLOBAL(EAP, FAILURE);
724 /* Local transitions */
725 eap_peer_sm_step_local(sm);
730 static Boolean eap_sm_allowMethod(struct eap_sm *sm, int vendor,
733 if (!eap_allowed_method(sm, vendor, method)) {
734 wpa_printf(MSG_DEBUG, "EAP: configuration does not allow: "
735 "vendor %u method %u", vendor, method);
738 if (eap_peer_get_eap_method(vendor, method))
740 wpa_printf(MSG_DEBUG, "EAP: not included in build: "
741 "vendor %u method %u", vendor, method);
746 static struct wpabuf * eap_sm_build_expanded_nak(
747 struct eap_sm *sm, int id, const struct eap_method *methods,
752 const struct eap_method *m;
754 wpa_printf(MSG_DEBUG, "EAP: Building expanded EAP-Nak");
756 /* RFC 3748 - 5.3.2: Expanded Nak */
757 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_EXPANDED,
758 8 + 8 * (count + 1), EAP_CODE_RESPONSE, id);
762 wpabuf_put_be24(resp, EAP_VENDOR_IETF);
763 wpabuf_put_be32(resp, EAP_TYPE_NAK);
765 for (m = methods; m; m = m->next) {
766 if (sm->reqVendor == m->vendor &&
767 sm->reqVendorMethod == m->method)
768 continue; /* do not allow the current method again */
769 if (eap_allowed_method(sm, m->vendor, m->method)) {
770 wpa_printf(MSG_DEBUG, "EAP: allowed type: "
771 "vendor=%u method=%u",
772 m->vendor, m->method);
773 wpabuf_put_u8(resp, EAP_TYPE_EXPANDED);
774 wpabuf_put_be24(resp, m->vendor);
775 wpabuf_put_be32(resp, m->method);
781 wpa_printf(MSG_DEBUG, "EAP: no more allowed methods");
782 wpabuf_put_u8(resp, EAP_TYPE_EXPANDED);
783 wpabuf_put_be24(resp, EAP_VENDOR_IETF);
784 wpabuf_put_be32(resp, EAP_TYPE_NONE);
787 eap_update_len(resp);
793 static struct wpabuf * eap_sm_buildNak(struct eap_sm *sm, int id)
797 int found = 0, expanded_found = 0;
799 const struct eap_method *methods, *m;
801 wpa_printf(MSG_DEBUG, "EAP: Building EAP-Nak (requested type %u "
802 "vendor=%u method=%u not allowed)", sm->reqMethod,
803 sm->reqVendor, sm->reqVendorMethod);
804 methods = eap_peer_get_methods(&count);
807 if (sm->reqMethod == EAP_TYPE_EXPANDED)
808 return eap_sm_build_expanded_nak(sm, id, methods, count);
810 /* RFC 3748 - 5.3.1: Legacy Nak */
811 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_NAK,
812 sizeof(struct eap_hdr) + 1 + count + 1,
813 EAP_CODE_RESPONSE, id);
817 start = wpabuf_put(resp, 0);
818 for (m = methods; m; m = m->next) {
819 if (m->vendor == EAP_VENDOR_IETF && m->method == sm->reqMethod)
820 continue; /* do not allow the current method again */
821 if (eap_allowed_method(sm, m->vendor, m->method)) {
822 if (m->vendor != EAP_VENDOR_IETF) {
826 wpabuf_put_u8(resp, EAP_TYPE_EXPANDED);
828 wpabuf_put_u8(resp, m->method);
833 wpabuf_put_u8(resp, EAP_TYPE_NONE);
834 wpa_hexdump(MSG_DEBUG, "EAP: allowed methods", start, found);
836 eap_update_len(resp);
842 static void eap_sm_processIdentity(struct eap_sm *sm, const struct wpabuf *req)
844 const struct eap_hdr *hdr = wpabuf_head(req);
845 const u8 *pos = (const u8 *) (hdr + 1);
848 wpa_msg(sm->msg_ctx, MSG_INFO, WPA_EVENT_EAP_STARTED
849 "EAP authentication started");
852 * RFC 3748 - 5.1: Identity
853 * Data field may contain a displayable message in UTF-8. If this
854 * includes NUL-character, only the data before that should be
855 * displayed. Some EAP implementasitons may piggy-back additional
856 * options after the NUL.
858 /* TODO: could save displayable message so that it can be shown to the
859 * user in case of interaction is required */
860 wpa_hexdump_ascii(MSG_DEBUG, "EAP: EAP-Request Identity data",
861 pos, be_to_host16(hdr->length) - 5);
866 static int eap_sm_imsi_identity(struct eap_sm *sm,
867 struct eap_peer_config *conf)
872 struct eap_method_type *m = conf->eap_methods;
875 imsi_len = sizeof(imsi);
876 if (scard_get_imsi(sm->scard_ctx, imsi, &imsi_len)) {
877 wpa_printf(MSG_WARNING, "Failed to get IMSI from SIM");
881 wpa_hexdump_ascii(MSG_DEBUG, "IMSI", (u8 *) imsi, imsi_len);
883 for (i = 0; m && (m[i].vendor != EAP_VENDOR_IETF ||
884 m[i].method != EAP_TYPE_NONE); i++) {
885 if (m[i].vendor == EAP_VENDOR_IETF &&
886 m[i].method == EAP_TYPE_AKA) {
892 os_free(conf->identity);
893 conf->identity = os_malloc(1 + imsi_len);
894 if (conf->identity == NULL) {
895 wpa_printf(MSG_WARNING, "Failed to allocate buffer for "
896 "IMSI-based identity");
900 conf->identity[0] = aka ? '0' : '1';
901 os_memcpy(conf->identity + 1, imsi, imsi_len);
902 conf->identity_len = 1 + imsi_len;
906 #endif /* PCSC_FUNCS */
909 static int eap_sm_set_scard_pin(struct eap_sm *sm,
910 struct eap_peer_config *conf)
913 if (scard_set_pin(sm->scard_ctx, conf->pin)) {
915 * Make sure the same PIN is not tried again in order to avoid
921 wpa_printf(MSG_WARNING, "PIN validation failed");
922 eap_sm_request_pin(sm);
926 #else /* PCSC_FUNCS */
928 #endif /* PCSC_FUNCS */
931 static int eap_sm_get_scard_identity(struct eap_sm *sm,
932 struct eap_peer_config *conf)
935 if (eap_sm_set_scard_pin(sm, conf))
938 return eap_sm_imsi_identity(sm, conf);
939 #else /* PCSC_FUNCS */
941 #endif /* PCSC_FUNCS */
946 * eap_sm_buildIdentity - Build EAP-Identity/Response for the current network
947 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
948 * @id: EAP identifier for the packet
949 * @encrypted: Whether the packet is for encrypted tunnel (EAP phase 2)
950 * Returns: Pointer to the allocated EAP-Identity/Response packet or %NULL on
953 * This function allocates and builds an EAP-Identity/Response packet for the
954 * current network. The caller is responsible for freeing the returned data.
956 struct wpabuf * eap_sm_buildIdentity(struct eap_sm *sm, int id, int encrypted)
958 struct eap_peer_config *config = eap_get_config(sm);
963 if (config == NULL) {
964 wpa_printf(MSG_WARNING, "EAP: buildIdentity: configuration "
965 "was not available");
969 if (sm->m && sm->m->get_identity &&
970 (identity = sm->m->get_identity(sm, sm->eap_method_priv,
971 &identity_len)) != NULL) {
972 wpa_hexdump_ascii(MSG_DEBUG, "EAP: using method re-auth "
973 "identity", identity, identity_len);
974 } else if (!encrypted && config->anonymous_identity) {
975 identity = config->anonymous_identity;
976 identity_len = config->anonymous_identity_len;
977 wpa_hexdump_ascii(MSG_DEBUG, "EAP: using anonymous identity",
978 identity, identity_len);
980 identity = config->identity;
981 identity_len = config->identity_len;
982 wpa_hexdump_ascii(MSG_DEBUG, "EAP: using real identity",
983 identity, identity_len);
986 if (identity == NULL) {
987 wpa_printf(MSG_WARNING, "EAP: buildIdentity: identity "
988 "configuration was not available");
990 if (eap_sm_get_scard_identity(sm, config) < 0)
992 identity = config->identity;
993 identity_len = config->identity_len;
994 wpa_hexdump_ascii(MSG_DEBUG, "permanent identity from "
995 "IMSI", identity, identity_len);
997 eap_sm_request_identity(sm);
1000 } else if (config->pcsc) {
1001 if (eap_sm_set_scard_pin(sm, config) < 0)
1005 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_IDENTITY, identity_len,
1006 EAP_CODE_RESPONSE, id);
1010 wpabuf_put_data(resp, identity, identity_len);
1016 static void eap_sm_processNotify(struct eap_sm *sm, const struct wpabuf *req)
1022 pos = eap_hdr_validate(EAP_VENDOR_IETF, EAP_TYPE_NOTIFICATION, req,
1026 wpa_hexdump_ascii(MSG_DEBUG, "EAP: EAP-Request Notification data",
1029 msg = os_malloc(msg_len + 1);
1032 for (i = 0; i < msg_len; i++)
1033 msg[i] = isprint(pos[i]) ? (char) pos[i] : '_';
1034 msg[msg_len] = '\0';
1035 wpa_msg(sm->msg_ctx, MSG_INFO, "%s%s",
1036 WPA_EVENT_EAP_NOTIFICATION, msg);
1041 static struct wpabuf * eap_sm_buildNotify(int id)
1043 struct wpabuf *resp;
1045 wpa_printf(MSG_DEBUG, "EAP: Generating EAP-Response Notification");
1046 resp = eap_msg_alloc(EAP_VENDOR_IETF, EAP_TYPE_NOTIFICATION, 0,
1047 EAP_CODE_RESPONSE, id);
1055 static void eap_sm_parseEapReq(struct eap_sm *sm, const struct wpabuf *req)
1057 const struct eap_hdr *hdr;
1061 sm->rxReq = sm->rxResp = sm->rxSuccess = sm->rxFailure = FALSE;
1063 sm->reqMethod = EAP_TYPE_NONE;
1064 sm->reqVendor = EAP_VENDOR_IETF;
1065 sm->reqVendorMethod = EAP_TYPE_NONE;
1067 if (req == NULL || wpabuf_len(req) < sizeof(*hdr))
1070 hdr = wpabuf_head(req);
1071 plen = be_to_host16(hdr->length);
1072 if (plen > wpabuf_len(req)) {
1073 wpa_printf(MSG_DEBUG, "EAP: Ignored truncated EAP-Packet "
1074 "(len=%lu plen=%lu)",
1075 (unsigned long) wpabuf_len(req),
1076 (unsigned long) plen);
1080 sm->reqId = hdr->identifier;
1082 if (sm->workaround) {
1084 addr[0] = wpabuf_head(req);
1085 md5_vector(1, addr, &plen, sm->req_md5);
1088 switch (hdr->code) {
1089 case EAP_CODE_REQUEST:
1090 if (plen < sizeof(*hdr) + 1) {
1091 wpa_printf(MSG_DEBUG, "EAP: Too short EAP-Request - "
1096 pos = (const u8 *) (hdr + 1);
1097 sm->reqMethod = *pos++;
1098 if (sm->reqMethod == EAP_TYPE_EXPANDED) {
1099 if (plen < sizeof(*hdr) + 8) {
1100 wpa_printf(MSG_DEBUG, "EAP: Ignored truncated "
1101 "expanded EAP-Packet (plen=%lu)",
1102 (unsigned long) plen);
1105 sm->reqVendor = WPA_GET_BE24(pos);
1107 sm->reqVendorMethod = WPA_GET_BE32(pos);
1109 wpa_printf(MSG_DEBUG, "EAP: Received EAP-Request id=%d "
1110 "method=%u vendor=%u vendorMethod=%u",
1111 sm->reqId, sm->reqMethod, sm->reqVendor,
1112 sm->reqVendorMethod);
1114 case EAP_CODE_RESPONSE:
1115 if (sm->selectedMethod == EAP_TYPE_LEAP) {
1117 * LEAP differs from RFC 4137 by using reversed roles
1118 * for mutual authentication and because of this, we
1119 * need to accept EAP-Response frames if LEAP is used.
1121 if (plen < sizeof(*hdr) + 1) {
1122 wpa_printf(MSG_DEBUG, "EAP: Too short "
1123 "EAP-Response - no Type field");
1127 pos = (const u8 *) (hdr + 1);
1128 sm->reqMethod = *pos;
1129 wpa_printf(MSG_DEBUG, "EAP: Received EAP-Response for "
1130 "LEAP method=%d id=%d",
1131 sm->reqMethod, sm->reqId);
1134 wpa_printf(MSG_DEBUG, "EAP: Ignored EAP-Response");
1136 case EAP_CODE_SUCCESS:
1137 wpa_printf(MSG_DEBUG, "EAP: Received EAP-Success");
1138 sm->rxSuccess = TRUE;
1140 case EAP_CODE_FAILURE:
1141 wpa_printf(MSG_DEBUG, "EAP: Received EAP-Failure");
1142 sm->rxFailure = TRUE;
1145 wpa_printf(MSG_DEBUG, "EAP: Ignored EAP-Packet with unknown "
1146 "code %d", hdr->code);
1153 * eap_peer_sm_init - Allocate and initialize EAP peer state machine
1154 * @eapol_ctx: Context data to be used with eapol_cb calls
1155 * @eapol_cb: Pointer to EAPOL callback functions
1156 * @msg_ctx: Context data for wpa_msg() calls
1157 * @conf: EAP configuration
1158 * Returns: Pointer to the allocated EAP state machine or %NULL on failure
1160 * This function allocates and initializes an EAP state machine. In addition,
1161 * this initializes TLS library for the new EAP state machine. eapol_cb pointer
1162 * will be in use until eap_peer_sm_deinit() is used to deinitialize this EAP
1163 * state machine. Consequently, the caller must make sure that this data
1164 * structure remains alive while the EAP state machine is active.
1166 struct eap_sm * eap_peer_sm_init(void *eapol_ctx,
1167 struct eapol_callbacks *eapol_cb,
1168 void *msg_ctx, struct eap_config *conf)
1171 struct tls_config tlsconf;
1173 sm = os_zalloc(sizeof(*sm));
1176 sm->eapol_ctx = eapol_ctx;
1177 sm->eapol_cb = eapol_cb;
1178 sm->msg_ctx = msg_ctx;
1179 sm->ClientTimeout = 60;
1181 os_memcpy(sm->mac_addr, conf->mac_addr, ETH_ALEN);
1183 os_memset(&tlsconf, 0, sizeof(tlsconf));
1184 tlsconf.opensc_engine_path = conf->opensc_engine_path;
1185 tlsconf.pkcs11_engine_path = conf->pkcs11_engine_path;
1186 tlsconf.pkcs11_module_path = conf->pkcs11_module_path;
1187 sm->ssl_ctx = tls_init(&tlsconf);
1188 if (sm->ssl_ctx == NULL) {
1189 wpa_printf(MSG_WARNING, "SSL: Failed to initialize TLS "
1200 * eap_peer_sm_deinit - Deinitialize and free an EAP peer state machine
1201 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1203 * This function deinitializes EAP state machine and frees all allocated
1206 void eap_peer_sm_deinit(struct eap_sm *sm)
1210 eap_deinit_prev_method(sm, "EAP deinit");
1212 tls_deinit(sm->ssl_ctx);
1218 * eap_peer_sm_step - Step EAP peer state machine
1219 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1220 * Returns: 1 if EAP state was changed or 0 if not
1222 * This function advances EAP state machine to a new state to match with the
1223 * current variables. This should be called whenever variables used by the EAP
1224 * state machine have changed.
1226 int eap_peer_sm_step(struct eap_sm *sm)
1230 sm->changed = FALSE;
1234 } while (sm->changed);
1240 * eap_sm_abort - Abort EAP authentication
1241 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1243 * Release system resources that have been allocated for the authentication
1244 * session without fully deinitializing the EAP state machine.
1246 void eap_sm_abort(struct eap_sm *sm)
1248 wpabuf_free(sm->lastRespData);
1249 sm->lastRespData = NULL;
1250 wpabuf_free(sm->eapRespData);
1251 sm->eapRespData = NULL;
1252 os_free(sm->eapKeyData);
1253 sm->eapKeyData = NULL;
1255 /* This is not clearly specified in the EAP statemachines draft, but
1256 * it seems necessary to make sure that some of the EAPOL variables get
1257 * cleared for the next authentication. */
1258 eapol_set_bool(sm, EAPOL_eapSuccess, FALSE);
1262 #ifdef CONFIG_CTRL_IFACE
1263 static const char * eap_sm_state_txt(int state)
1266 case EAP_INITIALIZE:
1267 return "INITIALIZE";
1274 case EAP_GET_METHOD:
1275 return "GET_METHOD";
1278 case EAP_SEND_RESPONSE:
1279 return "SEND_RESPONSE";
1284 case EAP_NOTIFICATION:
1285 return "NOTIFICATION";
1286 case EAP_RETRANSMIT:
1287 return "RETRANSMIT";
1296 #endif /* CONFIG_CTRL_IFACE */
1299 #if defined(CONFIG_CTRL_IFACE) || !defined(CONFIG_NO_STDOUT_DEBUG)
1300 static const char * eap_sm_method_state_txt(EapMethodState state)
1309 case METHOD_MAY_CONT:
1319 static const char * eap_sm_decision_txt(EapDecision decision)
1324 case DECISION_COND_SUCC:
1326 case DECISION_UNCOND_SUCC:
1327 return "UNCOND_SUCC";
1332 #endif /* CONFIG_CTRL_IFACE || !CONFIG_NO_STDOUT_DEBUG */
1335 #ifdef CONFIG_CTRL_IFACE
1338 * eap_sm_get_status - Get EAP state machine status
1339 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1340 * @buf: Buffer for status information
1341 * @buflen: Maximum buffer length
1342 * @verbose: Whether to include verbose status information
1343 * Returns: Number of bytes written to buf.
1345 * Query EAP state machine for status information. This function fills in a
1346 * text area with current status information from the EAPOL state machine. If
1347 * the buffer (buf) is not large enough, status information will be truncated
1348 * to fit the buffer.
1350 int eap_sm_get_status(struct eap_sm *sm, char *buf, size_t buflen, int verbose)
1357 len = os_snprintf(buf, buflen,
1359 eap_sm_state_txt(sm->EAP_state));
1360 if (len < 0 || (size_t) len >= buflen)
1363 if (sm->selectedMethod != EAP_TYPE_NONE) {
1368 const struct eap_method *m =
1369 eap_peer_get_eap_method(EAP_VENDOR_IETF,
1370 sm->selectedMethod);
1376 ret = os_snprintf(buf + len, buflen - len,
1377 "selectedMethod=%d (EAP-%s)\n",
1378 sm->selectedMethod, name);
1379 if (ret < 0 || (size_t) ret >= buflen - len)
1383 if (sm->m && sm->m->get_status) {
1384 len += sm->m->get_status(sm, sm->eap_method_priv,
1385 buf + len, buflen - len,
1391 ret = os_snprintf(buf + len, buflen - len,
1395 "ClientTimeout=%d\n",
1397 eap_sm_method_state_txt(sm->methodState),
1398 eap_sm_decision_txt(sm->decision),
1400 if (ret < 0 || (size_t) ret >= buflen - len)
1407 #endif /* CONFIG_CTRL_IFACE */
1410 #if defined(CONFIG_CTRL_IFACE) || !defined(CONFIG_NO_STDOUT_DEBUG)
1412 TYPE_IDENTITY, TYPE_PASSWORD, TYPE_OTP, TYPE_PIN, TYPE_NEW_PASSWORD,
1414 } eap_ctrl_req_type;
1416 static void eap_sm_request(struct eap_sm *sm, eap_ctrl_req_type type,
1417 const char *msg, size_t msglen)
1419 struct eap_peer_config *config;
1420 char *field, *txt, *tmp;
1424 config = eap_get_config(sm);
1432 config->pending_req_identity++;
1437 config->pending_req_password++;
1439 case TYPE_NEW_PASSWORD:
1440 field = "NEW_PASSWORD";
1441 txt = "New Password";
1442 config->pending_req_new_password++;
1447 config->pending_req_pin++;
1452 tmp = os_malloc(msglen + 3);
1456 os_memcpy(tmp + 1, msg, msglen);
1457 tmp[msglen + 1] = ']';
1458 tmp[msglen + 2] = '\0';
1460 os_free(config->pending_req_otp);
1461 config->pending_req_otp = tmp;
1462 config->pending_req_otp_len = msglen + 3;
1464 if (config->pending_req_otp == NULL)
1466 txt = config->pending_req_otp;
1469 case TYPE_PASSPHRASE:
1470 field = "PASSPHRASE";
1471 txt = "Private key passphrase";
1472 config->pending_req_passphrase++;
1478 if (sm->eapol_cb->eap_param_needed)
1479 sm->eapol_cb->eap_param_needed(sm->eapol_ctx, field, txt);
1481 #else /* CONFIG_CTRL_IFACE || !CONFIG_NO_STDOUT_DEBUG */
1482 #define eap_sm_request(sm, type, msg, msglen) do { } while (0)
1483 #endif /* CONFIG_CTRL_IFACE || !CONFIG_NO_STDOUT_DEBUG */
1487 * eap_sm_request_identity - Request identity from user (ctrl_iface)
1488 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1490 * EAP methods can call this function to request identity information for the
1491 * current network. This is normally called when the identity is not included
1492 * in the network configuration. The request will be sent to monitor programs
1493 * through the control interface.
1495 void eap_sm_request_identity(struct eap_sm *sm)
1497 eap_sm_request(sm, TYPE_IDENTITY, NULL, 0);
1502 * eap_sm_request_password - Request password from user (ctrl_iface)
1503 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1505 * EAP methods can call this function to request password information for the
1506 * current network. This is normally called when the password is not included
1507 * in the network configuration. The request will be sent to monitor programs
1508 * through the control interface.
1510 void eap_sm_request_password(struct eap_sm *sm)
1512 eap_sm_request(sm, TYPE_PASSWORD, NULL, 0);
1517 * eap_sm_request_new_password - Request new password from user (ctrl_iface)
1518 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1520 * EAP methods can call this function to request new password information for
1521 * the current network. This is normally called when the EAP method indicates
1522 * that the current password has expired and password change is required. The
1523 * request will be sent to monitor programs through the control interface.
1525 void eap_sm_request_new_password(struct eap_sm *sm)
1527 eap_sm_request(sm, TYPE_NEW_PASSWORD, NULL, 0);
1532 * eap_sm_request_pin - Request SIM or smart card PIN from user (ctrl_iface)
1533 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1535 * EAP methods can call this function to request SIM or smart card PIN
1536 * information for the current network. This is normally called when the PIN is
1537 * not included in the network configuration. The request will be sent to
1538 * monitor programs through the control interface.
1540 void eap_sm_request_pin(struct eap_sm *sm)
1542 eap_sm_request(sm, TYPE_PIN, NULL, 0);
1547 * eap_sm_request_otp - Request one time password from user (ctrl_iface)
1548 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1549 * @msg: Message to be displayed to the user when asking for OTP
1550 * @msg_len: Length of the user displayable message
1552 * EAP methods can call this function to request open time password (OTP) for
1553 * the current network. The request will be sent to monitor programs through
1554 * the control interface.
1556 void eap_sm_request_otp(struct eap_sm *sm, const char *msg, size_t msg_len)
1558 eap_sm_request(sm, TYPE_OTP, msg, msg_len);
1563 * eap_sm_request_passphrase - Request passphrase from user (ctrl_iface)
1564 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1566 * EAP methods can call this function to request passphrase for a private key
1567 * for the current network. This is normally called when the passphrase is not
1568 * included in the network configuration. The request will be sent to monitor
1569 * programs through the control interface.
1571 void eap_sm_request_passphrase(struct eap_sm *sm)
1573 eap_sm_request(sm, TYPE_PASSPHRASE, NULL, 0);
1578 * eap_sm_notify_ctrl_attached - Notification of attached monitor
1579 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1581 * Notify EAP state machines that a monitor was attached to the control
1582 * interface to trigger re-sending of pending requests for user input.
1584 void eap_sm_notify_ctrl_attached(struct eap_sm *sm)
1586 struct eap_peer_config *config = eap_get_config(sm);
1591 /* Re-send any pending requests for user data since a new control
1592 * interface was added. This handles cases where the EAP authentication
1593 * starts immediately after system startup when the user interface is
1594 * not yet running. */
1595 if (config->pending_req_identity)
1596 eap_sm_request_identity(sm);
1597 if (config->pending_req_password)
1598 eap_sm_request_password(sm);
1599 if (config->pending_req_new_password)
1600 eap_sm_request_new_password(sm);
1601 if (config->pending_req_otp)
1602 eap_sm_request_otp(sm, NULL, 0);
1603 if (config->pending_req_pin)
1604 eap_sm_request_pin(sm);
1605 if (config->pending_req_passphrase)
1606 eap_sm_request_passphrase(sm);
1610 static int eap_allowed_phase2_type(int vendor, int type)
1612 if (vendor != EAP_VENDOR_IETF)
1614 return type != EAP_TYPE_PEAP && type != EAP_TYPE_TTLS &&
1615 type != EAP_TYPE_FAST;
1620 * eap_get_phase2_type - Get EAP type for the given EAP phase 2 method name
1621 * @name: EAP method name, e.g., MD5
1622 * @vendor: Buffer for returning EAP Vendor-Id
1623 * Returns: EAP method type or %EAP_TYPE_NONE if not found
1625 * This function maps EAP type names into EAP type numbers that are allowed for
1626 * Phase 2, i.e., for tunneled authentication. Phase 2 is used, e.g., with
1627 * EAP-PEAP, EAP-TTLS, and EAP-FAST.
1629 u32 eap_get_phase2_type(const char *name, int *vendor)
1632 u8 type = eap_peer_get_type(name, &v);
1633 if (eap_allowed_phase2_type(v, type)) {
1637 *vendor = EAP_VENDOR_IETF;
1638 return EAP_TYPE_NONE;
1643 * eap_get_phase2_types - Get list of allowed EAP phase 2 types
1644 * @config: Pointer to a network configuration
1645 * @count: Pointer to a variable to be filled with number of returned EAP types
1646 * Returns: Pointer to allocated type list or %NULL on failure
1648 * This function generates an array of allowed EAP phase 2 (tunneled) types for
1649 * the given network configuration.
1651 struct eap_method_type * eap_get_phase2_types(struct eap_peer_config *config,
1654 struct eap_method_type *buf;
1658 const struct eap_method *methods, *m;
1660 methods = eap_peer_get_methods(&mcount);
1661 if (methods == NULL)
1664 buf = os_malloc(mcount * sizeof(struct eap_method_type));
1668 for (m = methods; m; m = m->next) {
1671 if (eap_allowed_phase2_type(vendor, method)) {
1672 if (vendor == EAP_VENDOR_IETF &&
1673 method == EAP_TYPE_TLS && config &&
1674 config->private_key2 == NULL)
1676 buf[*count].vendor = vendor;
1677 buf[*count].method = method;
1687 * eap_set_fast_reauth - Update fast_reauth setting
1688 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1689 * @enabled: 1 = Fast reauthentication is enabled, 0 = Disabled
1691 void eap_set_fast_reauth(struct eap_sm *sm, int enabled)
1693 sm->fast_reauth = enabled;
1698 * eap_set_workaround - Update EAP workarounds setting
1699 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1700 * @workaround: 1 = Enable EAP workarounds, 0 = Disable EAP workarounds
1702 void eap_set_workaround(struct eap_sm *sm, unsigned int workaround)
1704 sm->workaround = workaround;
1709 * eap_get_config - Get current network configuration
1710 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1711 * Returns: Pointer to the current network configuration or %NULL if not found
1713 * EAP peer methods should avoid using this function if they can use other
1714 * access functions, like eap_get_config_identity() and
1715 * eap_get_config_password(), that do not require direct access to
1716 * struct eap_peer_config.
1718 struct eap_peer_config * eap_get_config(struct eap_sm *sm)
1720 return sm->eapol_cb->get_config(sm->eapol_ctx);
1725 * eap_get_config_identity - Get identity from the network configuration
1726 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1727 * @len: Buffer for the length of the identity
1728 * Returns: Pointer to the identity or %NULL if not found
1730 const u8 * eap_get_config_identity(struct eap_sm *sm, size_t *len)
1732 struct eap_peer_config *config = eap_get_config(sm);
1735 *len = config->identity_len;
1736 return config->identity;
1741 * eap_get_config_password - Get password from the network configuration
1742 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1743 * @len: Buffer for the length of the password
1744 * Returns: Pointer to the password or %NULL if not found
1746 const u8 * eap_get_config_password(struct eap_sm *sm, size_t *len)
1748 struct eap_peer_config *config = eap_get_config(sm);
1751 *len = config->password_len;
1752 return config->password;
1757 * eap_get_config_password2 - Get password from the network configuration
1758 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1759 * @len: Buffer for the length of the password
1760 * @hash: Buffer for returning whether the password is stored as a
1761 * NtPasswordHash instead of plaintext password; can be %NULL if this
1762 * information is not needed
1763 * Returns: Pointer to the password or %NULL if not found
1765 const u8 * eap_get_config_password2(struct eap_sm *sm, size_t *len, int *hash)
1767 struct eap_peer_config *config = eap_get_config(sm);
1770 *len = config->password_len;
1772 *hash = !!(config->flags & EAP_CONFIG_FLAGS_PASSWORD_NTHASH);
1773 return config->password;
1778 * eap_get_config_new_password - Get new password from network configuration
1779 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1780 * @len: Buffer for the length of the new password
1781 * Returns: Pointer to the new password or %NULL if not found
1783 const u8 * eap_get_config_new_password(struct eap_sm *sm, size_t *len)
1785 struct eap_peer_config *config = eap_get_config(sm);
1788 *len = config->new_password_len;
1789 return config->new_password;
1794 * eap_get_config_otp - Get one-time password from the network configuration
1795 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1796 * @len: Buffer for the length of the one-time password
1797 * Returns: Pointer to the one-time password or %NULL if not found
1799 const u8 * eap_get_config_otp(struct eap_sm *sm, size_t *len)
1801 struct eap_peer_config *config = eap_get_config(sm);
1804 *len = config->otp_len;
1810 * eap_clear_config_otp - Clear used one-time password
1811 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1813 * This function clears a used one-time password (OTP) from the current network
1814 * configuration. This should be called when the OTP has been used and is not
1817 void eap_clear_config_otp(struct eap_sm *sm)
1819 struct eap_peer_config *config = eap_get_config(sm);
1822 os_memset(config->otp, 0, config->otp_len);
1823 os_free(config->otp);
1825 config->otp_len = 0;
1830 * eap_get_config_phase1 - Get phase1 data from the network configuration
1831 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1832 * Returns: Pointer to the phase1 data or %NULL if not found
1834 const char * eap_get_config_phase1(struct eap_sm *sm)
1836 struct eap_peer_config *config = eap_get_config(sm);
1839 return config->phase1;
1844 * eap_get_config_phase2 - Get phase2 data from the network configuration
1845 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1846 * Returns: Pointer to the phase1 data or %NULL if not found
1848 const char * eap_get_config_phase2(struct eap_sm *sm)
1850 struct eap_peer_config *config = eap_get_config(sm);
1853 return config->phase2;
1858 * eap_key_available - Get key availability (eapKeyAvailable variable)
1859 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1860 * Returns: 1 if EAP keying material is available, 0 if not
1862 int eap_key_available(struct eap_sm *sm)
1864 return sm ? sm->eapKeyAvailable : 0;
1869 * eap_notify_success - Notify EAP state machine about external success trigger
1870 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1872 * This function is called when external event, e.g., successful completion of
1873 * WPA-PSK key handshake, is indicating that EAP state machine should move to
1874 * success state. This is mainly used with security modes that do not use EAP
1875 * state machine (e.g., WPA-PSK).
1877 void eap_notify_success(struct eap_sm *sm)
1880 sm->decision = DECISION_COND_SUCC;
1881 sm->EAP_state = EAP_SUCCESS;
1887 * eap_notify_lower_layer_success - Notification of lower layer success
1888 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1890 * Notify EAP state machines that a lower layer has detected a successful
1891 * authentication. This is used to recover from dropped EAP-Success messages.
1893 void eap_notify_lower_layer_success(struct eap_sm *sm)
1898 if (eapol_get_bool(sm, EAPOL_eapSuccess) ||
1899 sm->decision == DECISION_FAIL ||
1900 (sm->methodState != METHOD_MAY_CONT &&
1901 sm->methodState != METHOD_DONE))
1904 if (sm->eapKeyData != NULL)
1905 sm->eapKeyAvailable = TRUE;
1906 eapol_set_bool(sm, EAPOL_eapSuccess, TRUE);
1907 wpa_msg(sm->msg_ctx, MSG_INFO, WPA_EVENT_EAP_SUCCESS
1908 "EAP authentication completed successfully (based on lower "
1914 * eap_get_eapKeyData - Get master session key (MSK) from EAP state machine
1915 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1916 * @len: Pointer to variable that will be set to number of bytes in the key
1917 * Returns: Pointer to the EAP keying data or %NULL on failure
1919 * Fetch EAP keying material (MSK, eapKeyData) from the EAP state machine. The
1920 * key is available only after a successful authentication. EAP state machine
1921 * continues to manage the key data and the caller must not change or free the
1924 const u8 * eap_get_eapKeyData(struct eap_sm *sm, size_t *len)
1926 if (sm == NULL || sm->eapKeyData == NULL) {
1931 *len = sm->eapKeyDataLen;
1932 return sm->eapKeyData;
1937 * eap_get_eapKeyData - Get EAP response data
1938 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1939 * Returns: Pointer to the EAP response (eapRespData) or %NULL on failure
1941 * Fetch EAP response (eapRespData) from the EAP state machine. This data is
1942 * available when EAP state machine has processed an incoming EAP request. The
1943 * EAP state machine does not maintain a reference to the response after this
1944 * function is called and the caller is responsible for freeing the data.
1946 struct wpabuf * eap_get_eapRespData(struct eap_sm *sm)
1948 struct wpabuf *resp;
1950 if (sm == NULL || sm->eapRespData == NULL)
1953 resp = sm->eapRespData;
1954 sm->eapRespData = NULL;
1961 * eap_sm_register_scard_ctx - Notification of smart card context
1962 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1963 * @ctx: Context data for smart card operations
1965 * Notify EAP state machines of context data for smart card operations. This
1966 * context data will be used as a parameter for scard_*() functions.
1968 void eap_register_scard_ctx(struct eap_sm *sm, void *ctx)
1971 sm->scard_ctx = ctx;
1976 * eap_set_config_blob - Set or add a named configuration blob
1977 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1978 * @blob: New value for the blob
1980 * Adds a new configuration blob or replaces the current value of an existing
1983 void eap_set_config_blob(struct eap_sm *sm, struct wpa_config_blob *blob)
1985 #ifndef CONFIG_NO_CONFIG_BLOBS
1986 sm->eapol_cb->set_config_blob(sm->eapol_ctx, blob);
1987 #endif /* CONFIG_NO_CONFIG_BLOBS */
1992 * eap_get_config_blob - Get a named configuration blob
1993 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
1994 * @name: Name of the blob
1995 * Returns: Pointer to blob data or %NULL if not found
1997 const struct wpa_config_blob * eap_get_config_blob(struct eap_sm *sm,
2000 #ifndef CONFIG_NO_CONFIG_BLOBS
2001 return sm->eapol_cb->get_config_blob(sm->eapol_ctx, name);
2002 #else /* CONFIG_NO_CONFIG_BLOBS */
2004 #endif /* CONFIG_NO_CONFIG_BLOBS */
2009 * eap_set_force_disabled - Set force_disabled flag
2010 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
2011 * @disabled: 1 = EAP disabled, 0 = EAP enabled
2013 * This function is used to force EAP state machine to be disabled when it is
2014 * not in use (e.g., with WPA-PSK or plaintext connections).
2016 void eap_set_force_disabled(struct eap_sm *sm, int disabled)
2018 sm->force_disabled = disabled;
2023 * eap_notify_pending - Notify that EAP method is ready to re-process a request
2024 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
2026 * An EAP method can perform a pending operation (e.g., to get a response from
2027 * an external process). Once the response is available, this function can be
2028 * used to request EAPOL state machine to retry delivering the previously
2029 * received (and still unanswered) EAP request to EAP state machine.
2031 void eap_notify_pending(struct eap_sm *sm)
2033 sm->eapol_cb->notify_pending(sm->eapol_ctx);
2038 * eap_invalidate_cached_session - Mark cached session data invalid
2039 * @sm: Pointer to EAP state machine allocated with eap_peer_sm_init()
2041 void eap_invalidate_cached_session(struct eap_sm *sm)
2044 eap_deinit_prev_method(sm, "invalidate");