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 canReauthP(gss_cred_id_t cred);
40 eapGssSmInitGssReauth(OM_uint32 *minor,
47 gss_channel_bindings_t chanBindings,
48 gss_buffer_t inputToken,
49 gss_buffer_t outputToken);
53 policyVariableToFlag(enum eapol_bool_var variable)
58 case EAPOL_eapSuccess:
59 flag = CTX_FLAG_EAP_SUCCESS;
61 case EAPOL_eapRestart:
62 flag = CTX_FLAG_EAP_RESTART;
65 flag = CTX_FLAG_EAP_FAIL;
68 flag = CTX_FLAG_EAP_RESP;
71 flag = CTX_FLAG_EAP_NO_RESP;
74 flag = CTX_FLAG_EAP_REQ;
76 case EAPOL_portEnabled:
77 flag = CTX_FLAG_EAP_PORT_ENABLED;
80 flag = CTX_FLAG_EAP_ALT_ACCEPT;
83 flag = CTX_FLAG_EAP_ALT_REJECT;
90 static struct eap_peer_config *
91 peerGetConfig(void *ctx)
93 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
95 return &gssCtx->initiatorCtx.eapPeerConfig;
99 peerGetBool(void *data, enum eapol_bool_var variable)
101 gss_ctx_id_t ctx = data;
104 if (ctx == GSS_C_NO_CONTEXT)
107 flag = policyVariableToFlag(variable);
109 return ((ctx->flags & flag) != 0);
113 peerSetBool(void *data, enum eapol_bool_var variable,
116 gss_ctx_id_t ctx = data;
119 if (ctx == GSS_C_NO_CONTEXT)
122 flag = policyVariableToFlag(variable);
127 ctx->flags &= ~(flag);
131 peerGetInt(void *data, enum eapol_int_var variable)
133 gss_ctx_id_t ctx = data;
135 if (ctx == GSS_C_NO_CONTEXT)
138 assert(CTX_IS_INITIATOR(ctx));
141 case EAPOL_idleWhile:
142 return ctx->initiatorCtx.idleWhile;
150 peerSetInt(void *data, enum eapol_int_var variable,
153 gss_ctx_id_t ctx = data;
155 if (ctx == GSS_C_NO_CONTEXT)
158 assert(CTX_IS_INITIATOR(ctx));
161 case EAPOL_idleWhile:
162 ctx->initiatorCtx.idleWhile = value;
167 static struct wpabuf *
168 peerGetEapReqData(void *ctx)
170 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
172 return &gssCtx->initiatorCtx.reqData;
176 peerSetConfigBlob(void *ctx, struct wpa_config_blob *blob)
180 static const struct wpa_config_blob *
181 peerGetConfigBlob(void *ctx, const char *name)
187 peerNotifyPending(void *ctx)
191 static struct eapol_callbacks gssEapPolicyCallbacks = {
203 extern int wpa_debug_level;
206 peerConfigInit(OM_uint32 *minor,
210 krb5_context krbContext;
211 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
212 krb5_error_code code;
215 GSSEAP_KRB_INIT(&krbContext);
217 eapPeerConfig->fragment_size = 1024;
220 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
223 return GSS_S_FAILURE;
226 eapPeerConfig->identity = (unsigned char *)identity;
227 eapPeerConfig->identity_len = strlen(identity);
228 eapPeerConfig->password = (unsigned char *)cred->password.value;
229 eapPeerConfig->password_len = cred->password.length;
231 return GSS_S_COMPLETE;
235 peerConfigFree(OM_uint32 *minor,
238 krb5_context krbContext;
239 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
241 GSSEAP_KRB_INIT(&krbContext);
243 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
245 return GSS_S_COMPLETE;
249 initReady(OM_uint32 *minor, gss_ctx_id_t ctx)
252 const unsigned char *key;
254 krb5_enctype encryptionType;
257 /* Cache encryption type derived from selected mechanism OID */
258 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &encryptionType);
259 if (GSS_ERROR(major))
262 if (encryptionType != ENCTYPE_NULL &&
263 eap_key_available(ctx->initiatorCtx.eap)) {
264 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
266 if (keyLength >= EAP_EMSK_LEN) {
267 major = gssEapDeriveRfc3961Key(minor,
268 &key[EAP_EMSK_LEN / 2],
272 if (GSS_ERROR(major))
275 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
277 if (GSS_ERROR(major))
284 ctx->encryptionType = encryptionType;
287 * draft-howlett-eap-gss says that integrity/confidentialty should
288 * always be advertised as available, but if we have no keying
289 * material it seems confusing to the caller to advertise this.
291 ctx->gssFlags &= ~(GSS_C_INTEG_FLAG | GSS_C_CONF_FLAG);
294 major = sequenceInit(minor,
297 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
298 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
300 if (GSS_ERROR(major))
303 return GSS_S_COMPLETE;
307 initBegin(OM_uint32 *minor,
314 gss_channel_bindings_t chanBindings,
315 gss_buffer_t inputToken,
316 gss_buffer_t outputToken)
320 if (cred != GSS_C_NO_CREDENTIAL && cred->expiryTime)
321 ctx->expiryTime = cred->expiryTime;
322 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
325 ctx->expiryTime = time(NULL) + timeReq;
327 if (cred != GSS_C_NO_CREDENTIAL) {
328 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
329 if (GSS_ERROR(major))
333 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
334 if (GSS_ERROR(major))
337 if (mech == GSS_C_NULL_OID || oidEqual(mech, GSS_EAP_MECHANISM)) {
338 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
339 } else if (gssEapIsConcreteMechanismOid(mech)) {
340 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
341 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
343 major = GSS_S_BAD_MECH;
345 if (GSS_ERROR(major))
348 /* If credentials were provided, check they're usable with this mech */
349 if (!gssEapCredAvailable(cred, ctx->mechanismUsed))
350 return GSS_S_BAD_MECH;
352 return GSS_S_COMPLETE;
356 eapGssSmInitIdentity(OM_uint32 *minor,
363 gss_channel_bindings_t chanBindings,
364 gss_buffer_t inputToken,
365 gss_buffer_t outputToken)
368 int initialContextToken;
370 initialContextToken = (inputToken->length == 0);
371 if (!initialContextToken)
372 return GSS_S_DEFECTIVE_TOKEN;
374 major = initBegin(minor, cred, ctx, target, mech,
375 reqFlags, timeReq, chanBindings,
376 inputToken, outputToken);
377 if (GSS_ERROR(major))
380 ctx->state = EAP_STATE_AUTHENTICATE;
382 return GSS_S_CONTINUE_NEEDED;
385 static struct wpabuf emptyWpaBuffer;
388 eapGssSmInitAuthenticate(OM_uint32 *minor,
395 gss_channel_bindings_t chanBindings,
396 gss_buffer_t inputToken,
397 gss_buffer_t outputToken)
402 struct wpabuf *resp = NULL;
403 int initialContextToken;
405 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
406 inputToken->length == 0);
408 major = peerConfigInit(minor, cred, ctx);
409 if (GSS_ERROR(major))
412 if (ctx->initiatorCtx.eap == NULL) {
413 struct eap_config eapConfig;
415 memset(&eapConfig, 0, sizeof(eapConfig));
417 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
418 &gssEapPolicyCallbacks,
421 if (ctx->initiatorCtx.eap == NULL) {
422 major = GSS_S_FAILURE;
426 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
429 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
431 wpabuf_set(&ctx->initiatorCtx.reqData,
432 inputToken->value, inputToken->length);
434 major = GSS_S_CONTINUE_NEEDED;
436 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
437 if (ctx->flags & CTX_FLAG_EAP_RESP) {
438 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
440 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
441 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
442 major = initReady(minor, ctx);
443 if (GSS_ERROR(major))
446 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
447 major = GSS_S_CONTINUE_NEEDED;
448 ctx->state = EAP_STATE_EXTENSIONS_REQ;
449 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
450 major = GSS_S_DEFECTIVE_CREDENTIAL;
451 } else if (code == 0 && initialContextToken) {
452 resp = &emptyWpaBuffer;
453 major = GSS_S_CONTINUE_NEEDED;
455 major = GSS_S_DEFECTIVE_TOKEN;
461 gss_buffer_desc respBuf;
463 assert(major == GSS_S_CONTINUE_NEEDED);
465 respBuf.length = wpabuf_len(resp);
466 respBuf.value = (void *)wpabuf_head(resp);
468 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
469 if (GSS_ERROR(tmpMajor)) {
475 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
476 peerConfigFree(&tmpMinor, ctx);
482 initGssChannelBindings(OM_uint32 *minor,
484 gss_channel_bindings_t chanBindings,
485 gss_buffer_t outputToken)
488 gss_buffer_desc buffer = GSS_C_EMPTY_BUFFER;
491 if (chanBindings != GSS_C_NO_CHANNEL_BINDINGS)
492 buffer = chanBindings->application_data;
494 major = gssEapWrap(minor, ctx, TRUE, GSS_C_QOP_DEFAULT,
495 &buffer, NULL, outputToken);
496 if (GSS_ERROR(major))
499 return GSS_S_CONTINUE_NEEDED;
503 eapGssSmInitExtensionsReq(OM_uint32 *minor,
510 gss_channel_bindings_t chanBindings,
511 gss_buffer_t inputToken,
512 gss_buffer_t outputToken)
514 OM_uint32 major, tmpMinor;
515 gss_buffer_desc cbToken = GSS_C_EMPTY_BUFFER;
517 major = initGssChannelBindings(minor, ctx, chanBindings, &cbToken);
518 if (GSS_ERROR(major))
521 ctx->state = EAP_STATE_EXTENSIONS_RESP;
523 major = duplicateBuffer(minor, &cbToken, outputToken);
524 if (GSS_ERROR(major)) {
525 gss_release_buffer(&tmpMinor, &cbToken);
529 gss_release_buffer(&tmpMinor, &cbToken);
531 return GSS_S_CONTINUE_NEEDED;
535 eapGssSmInitExtensionsResp(OM_uint32 *minor,
542 gss_channel_bindings_t chanBindings,
543 gss_buffer_t inputToken,
544 gss_buffer_t outputToken)
546 #ifdef GSSEAP_ENABLE_REAUTH
549 major = gssEapStoreReauthCreds(minor, ctx, cred, inputToken);
550 if (GSS_ERROR(major))
554 ctx->state = EAP_STATE_ESTABLISHED;
556 return GSS_S_COMPLETE;
560 eapGssSmInitEstablished(OM_uint32 *minor,
567 gss_channel_bindings_t chanBindings,
568 gss_buffer_t inputToken,
569 gss_buffer_t outputToken)
571 /* Called with already established context */
573 return GSS_S_BAD_STATUS;
576 static struct gss_eap_initiator_sm {
577 enum gss_eap_token_type inputTokenType;
578 enum gss_eap_token_type outputTokenType;
579 OM_uint32 (*processToken)(OM_uint32 *,
586 gss_channel_bindings_t,
589 } eapGssInitiatorSm[] = {
590 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
591 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
592 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
593 { TOK_TYPE_EXT_RESP,TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
594 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
595 #ifdef GSSEAP_ENABLE_REAUTH
596 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
601 gss_init_sec_context(OM_uint32 *minor,
603 gss_ctx_id_t *context_handle,
604 gss_name_t target_name,
608 gss_channel_bindings_t input_chan_bindings,
609 gss_buffer_t input_token,
610 gss_OID *actual_mech_type,
611 gss_buffer_t output_token,
612 OM_uint32 *ret_flags,
616 OM_uint32 tmpMajor, tmpMinor;
617 gss_ctx_id_t ctx = *context_handle;
618 struct gss_eap_initiator_sm *sm = NULL;
619 gss_buffer_desc innerInputToken;
620 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
621 enum gss_eap_token_type tokType;
625 output_token->length = 0;
626 output_token->value = NULL;
628 if (cred != GSS_C_NO_CREDENTIAL && !(cred->flags & CRED_FLAG_INITIATE)) {
629 return GSS_S_NO_CRED;
632 if (ctx == GSS_C_NO_CONTEXT) {
633 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
634 return GSS_S_DEFECTIVE_TOKEN;
637 major = gssEapAllocContext(minor, &ctx);
638 if (GSS_ERROR(major))
641 ctx->flags |= CTX_FLAG_INITIATOR;
643 #ifdef GSSEAP_ENABLE_REAUTH
644 if (canReauthP(cred))
645 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
648 *context_handle = ctx;
651 GSSEAP_MUTEX_LOCK(&ctx->mutex);
653 sm = &eapGssInitiatorSm[ctx->state];
655 if (input_token != GSS_C_NO_BUFFER) {
656 major = gssEapVerifyToken(minor, ctx, input_token,
657 &tokType, &innerInputToken);
658 if (GSS_ERROR(major))
661 if (tokType != sm->inputTokenType) {
662 major = GSS_S_DEFECTIVE_TOKEN;
666 innerInputToken.length = 0;
667 innerInputToken.value = NULL;
671 * Advance through state machine whilst empty tokens are emitted and
672 * the status is not GSS_S_COMPLETE or an error status.
675 sm = &eapGssInitiatorSm[ctx->state];
677 major = (sm->processToken)(minor,
687 if (GSS_ERROR(major))
689 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
691 if (actual_mech_type != NULL) {
692 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
693 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
695 if (innerOutputToken.value != NULL) {
696 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
697 sm->outputTokenType, output_token);
698 if (GSS_ERROR(tmpMajor)) {
704 if (ret_flags != NULL)
705 *ret_flags = ctx->gssFlags;
706 if (time_rec != NULL)
707 gssEapContextTime(&tmpMinor, ctx, time_rec);
709 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
712 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
714 if (GSS_ERROR(major))
715 gssEapReleaseContext(&tmpMinor, context_handle);
717 gss_release_buffer(&tmpMinor, &innerOutputToken);
722 #ifdef GSSEAP_ENABLE_REAUTH
724 canReauthP(gss_cred_id_t cred)
726 return (cred != GSS_C_NO_CREDENTIAL &&
727 cred->krbCred != GSS_C_NO_CREDENTIAL &&
728 cred->expiryTime > time(NULL));
732 eapGssSmInitGssReauth(OM_uint32 *minor,
739 gss_channel_bindings_t chanBindings,
740 gss_buffer_t inputToken,
741 gss_buffer_t outputToken)
743 OM_uint32 major, tmpMinor;
744 gss_name_t mechTarget = GSS_C_NO_NAME;
745 gss_OID actualMech = GSS_C_NO_OID;
746 OM_uint32 gssFlags, timeRec;
748 assert(cred != GSS_C_NO_CREDENTIAL);
750 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
752 if (inputToken->length == 0) {
753 major = initBegin(minor, cred, ctx, target, mech,
754 reqFlags, timeReq, chanBindings,
755 inputToken, outputToken);
756 if (GSS_ERROR(major))
760 major = gssEapMechToGlueName(minor, target, &mechTarget);
761 if (GSS_ERROR(major))
764 major = gssInitSecContext(minor,
768 (gss_OID)gss_mech_krb5,
769 reqFlags, /* | GSS_C_DCE_STYLE, */
777 if (GSS_ERROR(major))
780 ctx->gssFlags = gssFlags;
782 if (major == GSS_S_COMPLETE) {
783 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
784 if (GSS_ERROR(major))
786 ctx->state = EAP_STATE_ESTABLISHED;
790 gssReleaseName(&tmpMinor, &mechTarget);
794 #endif /* GSSEAP_ENABLE_REAUTH */