2 * Copyright (c) 2010, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of JANET(UK) nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 #include "gssapiP_eap.h"
35 #ifdef GSSEAP_ENABLE_REAUTH
37 eapGssSmInitGssReauth(OM_uint32 *minor,
44 gss_channel_bindings_t chanBindings,
45 gss_buffer_t inputToken,
46 gss_buffer_t outputToken);
50 policyVariableToFlag(enum eapol_bool_var variable)
55 case EAPOL_eapSuccess:
56 flag = CTX_FLAG_EAP_SUCCESS;
58 case EAPOL_eapRestart:
59 flag = CTX_FLAG_EAP_RESTART;
62 flag = CTX_FLAG_EAP_FAIL;
65 flag = CTX_FLAG_EAP_RESP;
68 flag = CTX_FLAG_EAP_NO_RESP;
71 flag = CTX_FLAG_EAP_REQ;
73 case EAPOL_portEnabled:
74 flag = CTX_FLAG_EAP_PORT_ENABLED;
77 flag = CTX_FLAG_EAP_ALT_ACCEPT;
80 flag = CTX_FLAG_EAP_ALT_REJECT;
87 static struct eap_peer_config *
88 peerGetConfig(void *ctx)
90 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
92 return &gssCtx->initiatorCtx.eapPeerConfig;
96 peerGetBool(void *data, enum eapol_bool_var variable)
98 gss_ctx_id_t ctx = data;
101 if (ctx == GSS_C_NO_CONTEXT)
104 flag = policyVariableToFlag(variable);
106 return ((ctx->flags & flag) != 0);
110 peerSetBool(void *data, enum eapol_bool_var variable,
113 gss_ctx_id_t ctx = data;
116 if (ctx == GSS_C_NO_CONTEXT)
119 flag = policyVariableToFlag(variable);
124 ctx->flags &= ~(flag);
128 peerGetInt(void *data, enum eapol_int_var variable)
130 gss_ctx_id_t ctx = data;
132 if (ctx == GSS_C_NO_CONTEXT)
135 assert(CTX_IS_INITIATOR(ctx));
138 case EAPOL_idleWhile:
139 return ctx->initiatorCtx.idleWhile;
147 peerSetInt(void *data, enum eapol_int_var variable,
150 gss_ctx_id_t ctx = data;
152 if (ctx == GSS_C_NO_CONTEXT)
155 assert(CTX_IS_INITIATOR(ctx));
158 case EAPOL_idleWhile:
159 ctx->initiatorCtx.idleWhile = value;
164 static struct wpabuf *
165 peerGetEapReqData(void *ctx)
167 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
169 return &gssCtx->initiatorCtx.reqData;
173 peerSetConfigBlob(void *ctx, struct wpa_config_blob *blob)
177 static const struct wpa_config_blob *
178 peerGetConfigBlob(void *ctx, const char *name)
184 peerNotifyPending(void *ctx)
188 static struct eapol_callbacks gssEapPolicyCallbacks = {
200 extern int wpa_debug_level;
203 peerConfigInit(OM_uint32 *minor,
207 krb5_context krbContext;
208 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
209 krb5_error_code code;
212 eapPeerConfig->identity = NULL;
213 eapPeerConfig->identity_len = 0;
214 eapPeerConfig->password = NULL;
215 eapPeerConfig->password_len = 0;
217 assert(cred != GSS_C_NO_CREDENTIAL);
219 GSSEAP_KRB_INIT(&krbContext);
221 eapPeerConfig->fragment_size = 1024;
224 if ((cred->name->flags & (NAME_FLAG_NAI | NAME_FLAG_SERVICE)) == 0) {
225 *minor = GSSEAP_BAD_INITIATOR_NAME;
226 return GSS_S_BAD_NAME;
229 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
232 return GSS_S_FAILURE;
235 eapPeerConfig->identity = (unsigned char *)identity;
236 eapPeerConfig->identity_len = strlen(identity);
237 eapPeerConfig->password = (unsigned char *)cred->password.value;
238 eapPeerConfig->password_len = cred->password.length;
241 return GSS_S_COMPLETE;
245 peerConfigFree(OM_uint32 *minor,
248 krb5_context krbContext;
249 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
251 GSSEAP_KRB_INIT(&krbContext);
253 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
256 return GSS_S_COMPLETE;
260 * Mark an initiator context as ready for cryptographic operations
263 initReady(OM_uint32 *minor, gss_ctx_id_t ctx, OM_uint32 reqFlags)
266 const unsigned char *key;
270 /* XXX actually check for mutual auth */
271 if (reqFlags & GSS_C_MUTUAL_FLAG)
272 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
275 /* Cache encryption type derived from selected mechanism OID */
276 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &ctx->encryptionType);
277 if (GSS_ERROR(major))
280 if (!eap_key_available(ctx->initiatorCtx.eap)) {
281 *minor = GSSEAP_KEY_UNAVAILABLE;
282 return GSS_S_UNAVAILABLE;
285 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
287 if (keyLength < EAP_EMSK_LEN) {
288 *minor = GSSEAP_KEY_TOO_SHORT;
289 return GSS_S_UNAVAILABLE;
292 major = gssEapDeriveRfc3961Key(minor,
293 &key[EAP_EMSK_LEN / 2],
297 if (GSS_ERROR(major))
300 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
302 if (GSS_ERROR(major))
305 major = sequenceInit(minor,
308 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
309 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
311 if (GSS_ERROR(major))
315 return GSS_S_COMPLETE;
319 initBegin(OM_uint32 *minor,
326 gss_channel_bindings_t chanBindings,
327 gss_buffer_t inputToken,
328 gss_buffer_t outputToken)
332 assert(cred != GSS_C_NO_CREDENTIAL);
334 if (cred->expiryTime)
335 ctx->expiryTime = cred->expiryTime;
336 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
339 ctx->expiryTime = time(NULL) + timeReq;
342 * The credential mutex protects its name, however we need to
343 * explicitly lock the acceptor name (unlikely as it may be
344 * that it has attributes set on it).
346 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
347 if (GSS_ERROR(major))
350 GSSEAP_MUTEX_LOCK(&target->mutex);
352 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
353 if (GSS_ERROR(major)) {
354 GSSEAP_MUTEX_UNLOCK(&target->mutex);
358 GSSEAP_MUTEX_UNLOCK(&target->mutex);
360 if (mech == GSS_C_NULL_OID) {
361 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
362 } else if (gssEapIsConcreteMechanismOid(mech)) {
363 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
364 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
366 *minor = GSSEAP_WRONG_MECH;
367 major = GSS_S_BAD_MECH;
369 if (GSS_ERROR(major))
372 /* If credentials were provided, check they're usable with this mech */
373 if (!gssEapCredAvailable(cred, ctx->mechanismUsed)) {
374 *minor = GSSEAP_CRED_MECH_MISMATCH;
375 return GSS_S_BAD_MECH;
379 return GSS_S_COMPLETE;
383 eapGssSmInitIdentity(OM_uint32 *minor,
390 gss_channel_bindings_t chanBindings,
391 gss_buffer_t inputToken,
392 gss_buffer_t outputToken)
395 int initialContextToken;
397 initialContextToken = (inputToken->length == 0);
398 if (!initialContextToken) {
399 *minor = GSSEAP_WRONG_SIZE;
400 return GSS_S_DEFECTIVE_TOKEN;
403 major = initBegin(minor, cred, ctx, target, mech,
404 reqFlags, timeReq, chanBindings,
405 inputToken, outputToken);
406 if (GSS_ERROR(major))
409 ctx->state = EAP_STATE_AUTHENTICATE;
412 return GSS_S_CONTINUE_NEEDED;
415 static struct wpabuf emptyWpaBuffer;
418 eapGssSmInitAuthenticate(OM_uint32 *minor,
425 gss_channel_bindings_t chanBindings,
426 gss_buffer_t inputToken,
427 gss_buffer_t outputToken)
432 struct wpabuf *resp = NULL;
433 int initialContextToken;
437 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
438 inputToken->length == 0);
440 major = peerConfigInit(minor, cred, ctx);
441 if (GSS_ERROR(major))
444 if (ctx->initiatorCtx.eap == NULL) {
445 struct eap_config eapConfig;
447 memset(&eapConfig, 0, sizeof(eapConfig));
449 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
450 &gssEapPolicyCallbacks,
453 if (ctx->initiatorCtx.eap == NULL) {
454 *minor = GSSEAP_PEER_SM_INIT_FAILURE;
455 major = GSS_S_FAILURE;
459 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
462 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
464 wpabuf_set(&ctx->initiatorCtx.reqData,
465 inputToken->value, inputToken->length);
467 major = GSS_S_CONTINUE_NEEDED;
469 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
470 if (ctx->flags & CTX_FLAG_EAP_RESP) {
471 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
473 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
474 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
475 major = initReady(minor, ctx, reqFlags);
476 if (GSS_ERROR(major))
479 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
480 major = GSS_S_CONTINUE_NEEDED;
481 ctx->state = EAP_STATE_EXTENSIONS_REQ;
482 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
483 *minor = GSSEAP_PEER_AUTH_FAILURE;
484 major = GSS_S_DEFECTIVE_CREDENTIAL;
485 } else if (code == 0 && initialContextToken) {
486 resp = &emptyWpaBuffer;
487 major = GSS_S_CONTINUE_NEEDED;
489 *minor = GSSEAP_PEER_BAD_MESSAGE;
490 major = GSS_S_DEFECTIVE_TOKEN;
496 gss_buffer_desc respBuf;
498 assert(major == GSS_S_CONTINUE_NEEDED);
500 respBuf.length = wpabuf_len(resp);
501 respBuf.value = (void *)wpabuf_head(resp);
503 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
504 if (GSS_ERROR(tmpMajor)) {
510 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
511 peerConfigFree(&tmpMinor, ctx);
517 eapGssSmInitExtensionsReq(OM_uint32 *minor,
524 gss_channel_bindings_t chanBindings,
525 gss_buffer_t inputToken,
526 gss_buffer_t outputToken)
530 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
531 if (GSS_ERROR(major))
534 assert(outputToken->value != NULL);
536 ctx->state = EAP_STATE_EXTENSIONS_RESP;
539 return GSS_S_CONTINUE_NEEDED;
543 eapGssSmInitExtensionsResp(OM_uint32 *minor,
550 gss_channel_bindings_t chanBindings,
551 gss_buffer_t inputToken,
552 gss_buffer_t outputToken)
556 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
557 if (GSS_ERROR(major))
560 ctx->state = EAP_STATE_ESTABLISHED;
563 return GSS_S_COMPLETE;
567 eapGssSmInitEstablished(OM_uint32 *minor,
574 gss_channel_bindings_t chanBindings,
575 gss_buffer_t inputToken,
576 gss_buffer_t outputToken)
578 /* Called with already established context */
579 *minor = GSSEAP_CONTEXT_ESTABLISHED;
580 return GSS_S_BAD_STATUS;
584 eapGssSmInitError(OM_uint32 *minor,
591 gss_channel_bindings_t chanBindings,
592 gss_buffer_t inputToken,
593 gss_buffer_t outputToken)
598 if (inputToken->length < 8) {
599 *minor = GSSEAP_TOK_TRUNC;
600 return GSS_S_DEFECTIVE_TOKEN;
603 p = (unsigned char *)inputToken->value;
605 major = load_uint32_be(&p[0]);
606 *minor = ERROR_TABLE_BASE_eapg + load_uint32_be(&p[4]);
608 if (!GSS_ERROR(major)) {
609 *minor = GSSEAP_BAD_ERROR_TOKEN;
610 major = GSS_S_FAILURE;
616 static struct gss_eap_initiator_sm {
617 enum gss_eap_token_type inputTokenType;
618 enum gss_eap_token_type outputTokenType;
619 OM_uint32 (*processToken)(OM_uint32 *,
626 gss_channel_bindings_t,
629 } eapGssInitiatorSm[] = {
630 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
631 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
632 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
633 { TOK_TYPE_EXT_RESP, TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
634 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
635 { TOK_TYPE_CONTEXT_ERR, TOK_TYPE_NONE, eapGssSmInitError },
636 #ifdef GSSEAP_ENABLE_REAUTH
637 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
642 gss_init_sec_context(OM_uint32 *minor,
644 gss_ctx_id_t *context_handle,
645 gss_name_t target_name,
649 gss_channel_bindings_t input_chan_bindings,
650 gss_buffer_t input_token,
651 gss_OID *actual_mech_type,
652 gss_buffer_t output_token,
653 OM_uint32 *ret_flags,
657 OM_uint32 tmpMajor, tmpMinor;
658 gss_ctx_id_t ctx = *context_handle;
659 struct gss_eap_initiator_sm *sm = NULL;
660 gss_buffer_desc innerInputToken;
661 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
662 enum gss_eap_token_type tokType;
663 gss_cred_id_t defaultCred = GSS_C_NO_CREDENTIAL;
664 int initialContextToken = 0;
668 output_token->length = 0;
669 output_token->value = NULL;
671 if (ctx == GSS_C_NO_CONTEXT) {
672 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
673 *minor = GSSEAP_WRONG_SIZE;
674 return GSS_S_DEFECTIVE_TOKEN;
677 major = gssEapAllocContext(minor, &ctx);
678 if (GSS_ERROR(major))
681 ctx->flags |= CTX_FLAG_INITIATOR;
683 initialContextToken = 1;
684 *context_handle = ctx;
687 GSSEAP_MUTEX_LOCK(&ctx->mutex);
689 if (cred == GSS_C_NO_CREDENTIAL) {
690 if (ctx->initiatorCtx.defaultCred == GSS_C_NO_CREDENTIAL) {
691 major = gssEapAcquireCred(minor,
700 if (GSS_ERROR(major))
704 cred = ctx->initiatorCtx.defaultCred;
707 GSSEAP_MUTEX_LOCK(&cred->mutex);
709 #ifdef GSSEAP_ENABLE_REAUTH
710 if (initialContextToken && gssEapCanReauthP(cred, target_name, time_req))
711 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
714 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
715 *minor = GSSEAP_CRED_USAGE_MISMATCH;
716 major = GSS_S_NO_CRED;
720 sm = &eapGssInitiatorSm[ctx->state];
722 if (input_token != GSS_C_NO_BUFFER) {
723 major = gssEapVerifyToken(minor, ctx, input_token,
724 &tokType, &innerInputToken);
725 if (GSS_ERROR(major))
728 if (tokType == TOK_TYPE_CONTEXT_ERR) {
729 ctx->state = EAP_STATE_ERROR;
730 } else if (tokType != sm->inputTokenType) {
731 *minor = GSSEAP_WRONG_TOK_ID;
732 major = GSS_S_DEFECTIVE_TOKEN;
736 innerInputToken.length = 0;
737 innerInputToken.value = NULL;
741 * Advance through state machine whilst empty tokens are emitted and
742 * the status is not GSS_S_COMPLETE or an error status.
745 sm = &eapGssInitiatorSm[ctx->state];
747 major = (sm->processToken)(minor,
757 if (GSS_ERROR(major))
759 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
761 if (actual_mech_type != NULL) {
762 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
763 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
765 if (innerOutputToken.value != NULL) {
766 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
767 sm->outputTokenType, output_token);
768 if (GSS_ERROR(tmpMajor)) {
774 if (ret_flags != NULL)
775 *ret_flags = ctx->gssFlags;
776 if (time_rec != NULL)
777 gssEapContextTime(&tmpMinor, ctx, time_rec);
779 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
782 if (cred != GSS_C_NO_CREDENTIAL)
783 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
784 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
786 if (GSS_ERROR(major))
787 gssEapReleaseContext(&tmpMinor, context_handle);
789 gss_release_buffer(&tmpMinor, &innerOutputToken);
794 #ifdef GSSEAP_ENABLE_REAUTH
796 eapGssSmInitGssReauth(OM_uint32 *minor,
803 gss_channel_bindings_t chanBindings,
804 gss_buffer_t inputToken,
805 gss_buffer_t outputToken)
807 OM_uint32 major, tmpMinor;
808 gss_name_t mechTarget = GSS_C_NO_NAME;
809 gss_OID actualMech = GSS_C_NO_OID;
810 OM_uint32 gssFlags, timeRec;
812 assert(cred != GSS_C_NO_CREDENTIAL);
814 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
816 if (inputToken->length == 0) {
817 major = initBegin(minor, cred, ctx, target, mech,
818 reqFlags, timeReq, chanBindings,
819 inputToken, outputToken);
820 if (GSS_ERROR(major))
824 major = gssEapMechToGlueName(minor, target, &mechTarget);
825 if (GSS_ERROR(major))
828 major = gssInitSecContext(minor,
832 (gss_OID)gss_mech_krb5,
833 reqFlags, /* | GSS_C_DCE_STYLE, */
841 if (GSS_ERROR(major))
844 ctx->gssFlags = gssFlags;
846 if (major == GSS_S_COMPLETE) {
847 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
848 if (GSS_ERROR(major))
850 ctx->state = EAP_STATE_ESTABLISHED;
854 gssReleaseName(&tmpMinor, &mechTarget);
858 #endif /* GSSEAP_ENABLE_REAUTH */