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 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
227 return GSS_S_FAILURE;
230 eapPeerConfig->identity = (unsigned char *)identity;
231 eapPeerConfig->identity_len = strlen(identity);
232 eapPeerConfig->password = (unsigned char *)cred->password.value;
233 eapPeerConfig->password_len = cred->password.length;
235 return GSS_S_COMPLETE;
239 peerConfigFree(OM_uint32 *minor,
242 krb5_context krbContext;
243 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
245 GSSEAP_KRB_INIT(&krbContext);
247 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
249 return GSS_S_COMPLETE;
253 * Mark an initiator context as ready for cryptographic operations
256 initReady(OM_uint32 *minor, gss_ctx_id_t ctx, OM_uint32 reqFlags)
259 const unsigned char *key;
263 /* XXX actually check for mutual auth */
264 if (reqFlags & GSS_C_MUTUAL_FLAG)
265 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
268 /* Cache encryption type derived from selected mechanism OID */
269 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &ctx->encryptionType);
270 if (GSS_ERROR(major))
273 if (!eap_key_available(ctx->initiatorCtx.eap)) {
274 *minor = GSSEAP_KEY_UNAVAILABLE;
275 return GSS_S_UNAVAILABLE;
278 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
280 if (keyLength < EAP_EMSK_LEN) {
281 *minor = GSSEAP_KEY_TOO_SHORT;
282 return GSS_S_UNAVAILABLE;
285 major = gssEapDeriveRfc3961Key(minor,
286 &key[EAP_EMSK_LEN / 2],
290 if (GSS_ERROR(major))
293 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
295 if (GSS_ERROR(major))
298 major = sequenceInit(minor,
301 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
302 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
304 if (GSS_ERROR(major))
308 return GSS_S_COMPLETE;
312 initBegin(OM_uint32 *minor,
319 gss_channel_bindings_t chanBindings,
320 gss_buffer_t inputToken,
321 gss_buffer_t outputToken)
325 assert(cred != GSS_C_NO_CREDENTIAL);
327 if (cred->expiryTime)
328 ctx->expiryTime = cred->expiryTime;
329 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
332 ctx->expiryTime = time(NULL) + timeReq;
335 * The credential mutex protects its name, however we need to
336 * explicitly lock the acceptor name (unlikely as it may be
337 * that it has attributes set on it).
339 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
340 if (GSS_ERROR(major))
343 GSSEAP_MUTEX_LOCK(&target->mutex);
345 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
346 if (GSS_ERROR(major)) {
347 GSSEAP_MUTEX_UNLOCK(&target->mutex);
351 GSSEAP_MUTEX_UNLOCK(&target->mutex);
353 if (mech == GSS_C_NULL_OID) {
354 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
355 } else if (gssEapIsConcreteMechanismOid(mech)) {
356 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
357 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
359 *minor = GSSEAP_WRONG_MECH;
360 major = GSS_S_BAD_MECH;
362 if (GSS_ERROR(major))
365 /* If credentials were provided, check they're usable with this mech */
366 if (!gssEapCredAvailable(cred, ctx->mechanismUsed))
367 return GSS_S_BAD_MECH;
369 return GSS_S_COMPLETE;
373 eapGssSmInitIdentity(OM_uint32 *minor,
380 gss_channel_bindings_t chanBindings,
381 gss_buffer_t inputToken,
382 gss_buffer_t outputToken)
385 int initialContextToken;
387 initialContextToken = (inputToken->length == 0);
388 if (!initialContextToken) {
389 *minor = GSSEAP_WRONG_SIZE;
390 return GSS_S_DEFECTIVE_TOKEN;
393 major = initBegin(minor, cred, ctx, target, mech,
394 reqFlags, timeReq, chanBindings,
395 inputToken, outputToken);
396 if (GSS_ERROR(major))
399 ctx->state = EAP_STATE_AUTHENTICATE;
401 return GSS_S_CONTINUE_NEEDED;
404 static struct wpabuf emptyWpaBuffer;
407 eapGssSmInitAuthenticate(OM_uint32 *minor,
414 gss_channel_bindings_t chanBindings,
415 gss_buffer_t inputToken,
416 gss_buffer_t outputToken)
421 struct wpabuf *resp = NULL;
422 int initialContextToken;
424 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
425 inputToken->length == 0);
427 major = peerConfigInit(minor, cred, ctx);
428 if (GSS_ERROR(major))
431 if (ctx->initiatorCtx.eap == NULL) {
432 struct eap_config eapConfig;
434 memset(&eapConfig, 0, sizeof(eapConfig));
436 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
437 &gssEapPolicyCallbacks,
440 if (ctx->initiatorCtx.eap == NULL) {
441 *minor = GSSEAP_PEER_INIT_FAILURE;
442 major = GSS_S_FAILURE;
446 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
449 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
451 wpabuf_set(&ctx->initiatorCtx.reqData,
452 inputToken->value, inputToken->length);
454 major = GSS_S_CONTINUE_NEEDED;
456 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
457 if (ctx->flags & CTX_FLAG_EAP_RESP) {
458 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
460 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
461 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
462 major = initReady(minor, ctx, reqFlags);
463 if (GSS_ERROR(major))
466 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
467 major = GSS_S_CONTINUE_NEEDED;
468 ctx->state = EAP_STATE_EXTENSIONS_REQ;
469 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
470 *minor = GSSEAP_PEER_AUTH_FAILURE;
471 major = GSS_S_DEFECTIVE_CREDENTIAL;
472 } else if (code == 0 && initialContextToken) {
473 resp = &emptyWpaBuffer;
474 major = GSS_S_CONTINUE_NEEDED;
476 *minor = GSSEAP_PEER_BAD_MESSAGE;
477 major = GSS_S_DEFECTIVE_TOKEN;
483 gss_buffer_desc respBuf;
485 assert(major == GSS_S_CONTINUE_NEEDED);
487 respBuf.length = wpabuf_len(resp);
488 respBuf.value = (void *)wpabuf_head(resp);
490 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
491 if (GSS_ERROR(tmpMajor)) {
497 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
498 peerConfigFree(&tmpMinor, ctx);
504 eapGssSmInitExtensionsReq(OM_uint32 *minor,
511 gss_channel_bindings_t chanBindings,
512 gss_buffer_t inputToken,
513 gss_buffer_t outputToken)
517 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
518 if (GSS_ERROR(major))
521 assert(outputToken->value != NULL);
523 ctx->state = EAP_STATE_EXTENSIONS_RESP;
525 return GSS_S_CONTINUE_NEEDED;
529 eapGssSmInitExtensionsResp(OM_uint32 *minor,
536 gss_channel_bindings_t chanBindings,
537 gss_buffer_t inputToken,
538 gss_buffer_t outputToken)
542 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
543 if (GSS_ERROR(major))
546 ctx->state = EAP_STATE_ESTABLISHED;
548 return GSS_S_COMPLETE;
552 eapGssSmInitEstablished(OM_uint32 *minor,
559 gss_channel_bindings_t chanBindings,
560 gss_buffer_t inputToken,
561 gss_buffer_t outputToken)
563 /* Called with already established context */
564 *minor = GSSEAP_CONTEXT_ESTABLISHED;
565 return GSS_S_BAD_STATUS;
569 eapGssSmInitError(OM_uint32 *minor,
576 gss_channel_bindings_t chanBindings,
577 gss_buffer_t inputToken,
578 gss_buffer_t outputToken)
583 if (inputToken->length < 8) {
584 *minor = GSSEAP_WRONG_SIZE;
585 return GSS_S_DEFECTIVE_TOKEN;
588 p = (unsigned char *)inputToken->value;
590 major = load_uint32_be(&p[0]);
591 *minor = ERROR_TABLE_BASE_eapg + load_uint32_be(&p[4]);
593 if (!GSS_ERROR(major)) {
594 *minor = GSSEAP_BAD_ERROR_TOKEN;
595 major = GSS_S_FAILURE;
601 static struct gss_eap_initiator_sm {
602 enum gss_eap_token_type inputTokenType;
603 enum gss_eap_token_type outputTokenType;
604 OM_uint32 (*processToken)(OM_uint32 *,
611 gss_channel_bindings_t,
614 } eapGssInitiatorSm[] = {
615 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
616 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
617 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
618 { TOK_TYPE_EXT_RESP, TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
619 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
620 { TOK_TYPE_CONTEXT_ERR, TOK_TYPE_NONE, eapGssSmInitError },
621 #ifdef GSSEAP_ENABLE_REAUTH
622 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
627 gss_init_sec_context(OM_uint32 *minor,
629 gss_ctx_id_t *context_handle,
630 gss_name_t target_name,
634 gss_channel_bindings_t input_chan_bindings,
635 gss_buffer_t input_token,
636 gss_OID *actual_mech_type,
637 gss_buffer_t output_token,
638 OM_uint32 *ret_flags,
642 OM_uint32 tmpMajor, tmpMinor;
643 gss_ctx_id_t ctx = *context_handle;
644 struct gss_eap_initiator_sm *sm = NULL;
645 gss_buffer_desc innerInputToken;
646 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
647 enum gss_eap_token_type tokType;
648 gss_cred_id_t defaultCred = GSS_C_NO_CREDENTIAL;
649 int initialContextToken = 0;
653 output_token->length = 0;
654 output_token->value = NULL;
656 if (ctx == GSS_C_NO_CONTEXT) {
657 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
658 *minor = GSSEAP_WRONG_SIZE;
659 return GSS_S_DEFECTIVE_TOKEN;
662 major = gssEapAllocContext(minor, &ctx);
663 if (GSS_ERROR(major))
666 ctx->flags |= CTX_FLAG_INITIATOR;
668 initialContextToken = 1;
669 *context_handle = ctx;
672 GSSEAP_MUTEX_LOCK(&ctx->mutex);
674 if (cred == GSS_C_NO_CREDENTIAL) {
675 if (ctx->initiatorCtx.defaultCred == GSS_C_NO_CREDENTIAL) {
676 major = gssEapAcquireCred(minor,
685 if (GSS_ERROR(major))
689 cred = ctx->initiatorCtx.defaultCred;
692 GSSEAP_MUTEX_LOCK(&cred->mutex);
694 #ifdef GSSEAP_ENABLE_REAUTH
695 if (initialContextToken && gssEapCanReauthP(cred, target_name, time_req))
696 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
699 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
700 *minor = GSSEAP_CRED_USAGE_MISMATCH;
701 major = GSS_S_NO_CRED;
705 sm = &eapGssInitiatorSm[ctx->state];
707 if (input_token != GSS_C_NO_BUFFER) {
708 major = gssEapVerifyToken(minor, ctx, input_token,
709 &tokType, &innerInputToken);
710 if (GSS_ERROR(major))
713 if (tokType == TOK_TYPE_CONTEXT_ERR) {
714 ctx->state = EAP_STATE_ERROR;
715 } else if (tokType != sm->inputTokenType) {
716 *minor = GSSEAP_WRONG_TOK_ID;
717 major = GSS_S_DEFECTIVE_TOKEN;
721 innerInputToken.length = 0;
722 innerInputToken.value = NULL;
726 * Advance through state machine whilst empty tokens are emitted and
727 * the status is not GSS_S_COMPLETE or an error status.
730 sm = &eapGssInitiatorSm[ctx->state];
732 major = (sm->processToken)(minor,
742 if (GSS_ERROR(major))
744 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
746 if (actual_mech_type != NULL) {
747 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
748 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
750 if (innerOutputToken.value != NULL) {
751 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
752 sm->outputTokenType, output_token);
753 if (GSS_ERROR(tmpMajor)) {
759 if (ret_flags != NULL)
760 *ret_flags = ctx->gssFlags;
761 if (time_rec != NULL)
762 gssEapContextTime(&tmpMinor, ctx, time_rec);
764 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
767 if (cred != GSS_C_NO_CREDENTIAL)
768 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
769 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
771 if (GSS_ERROR(major))
772 gssEapReleaseContext(&tmpMinor, context_handle);
774 gss_release_buffer(&tmpMinor, &innerOutputToken);
779 #ifdef GSSEAP_ENABLE_REAUTH
781 eapGssSmInitGssReauth(OM_uint32 *minor,
788 gss_channel_bindings_t chanBindings,
789 gss_buffer_t inputToken,
790 gss_buffer_t outputToken)
792 OM_uint32 major, tmpMinor;
793 gss_name_t mechTarget = GSS_C_NO_NAME;
794 gss_OID actualMech = GSS_C_NO_OID;
795 OM_uint32 gssFlags, timeRec;
797 assert(cred != GSS_C_NO_CREDENTIAL);
799 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
801 if (inputToken->length == 0) {
802 major = initBegin(minor, cred, ctx, target, mech,
803 reqFlags, timeReq, chanBindings,
804 inputToken, outputToken);
805 if (GSS_ERROR(major))
809 major = gssEapMechToGlueName(minor, target, &mechTarget);
810 if (GSS_ERROR(major))
813 major = gssInitSecContext(minor,
817 (gss_OID)gss_mech_krb5,
818 reqFlags, /* | GSS_C_DCE_STYLE, */
826 if (GSS_ERROR(major))
829 ctx->gssFlags = gssFlags;
831 if (major == GSS_S_COMPLETE) {
832 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
833 if (GSS_ERROR(major))
835 ctx->state = EAP_STATE_ESTABLISHED;
839 gssReleaseName(&tmpMinor, &mechTarget);
843 #endif /* GSSEAP_ENABLE_REAUTH */