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 eapPeerConfig->identity = NULL;
216 eapPeerConfig->identity_len = 0;
217 eapPeerConfig->password = NULL;
218 eapPeerConfig->password_len = 0;
220 assert(cred != GSS_C_NO_CREDENTIAL);
222 GSSEAP_KRB_INIT(&krbContext);
224 eapPeerConfig->fragment_size = 1024;
227 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
230 return GSS_S_FAILURE;
233 eapPeerConfig->identity = (unsigned char *)identity;
234 eapPeerConfig->identity_len = strlen(identity);
235 eapPeerConfig->password = (unsigned char *)cred->password.value;
236 eapPeerConfig->password_len = cred->password.length;
238 return GSS_S_COMPLETE;
242 peerConfigFree(OM_uint32 *minor,
245 krb5_context krbContext;
246 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
248 GSSEAP_KRB_INIT(&krbContext);
250 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
252 return GSS_S_COMPLETE;
256 initReady(OM_uint32 *minor, gss_ctx_id_t ctx)
259 const unsigned char *key;
261 krb5_enctype encryptionType;
264 /* Cache encryption type derived from selected mechanism OID */
265 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &encryptionType);
266 if (GSS_ERROR(major))
269 if (encryptionType != ENCTYPE_NULL &&
270 eap_key_available(ctx->initiatorCtx.eap)) {
271 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
273 if (keyLength >= EAP_EMSK_LEN) {
274 major = gssEapDeriveRfc3961Key(minor,
275 &key[EAP_EMSK_LEN / 2],
279 if (GSS_ERROR(major))
282 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
284 if (GSS_ERROR(major))
291 ctx->encryptionType = encryptionType;
294 * draft-howlett-eap-gss says that integrity/confidentialty should
295 * always be advertised as available, but if we have no keying
296 * material it seems confusing to the caller to advertise this.
298 ctx->gssFlags &= ~(GSS_C_INTEG_FLAG | GSS_C_CONF_FLAG);
301 major = sequenceInit(minor,
304 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
305 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
307 if (GSS_ERROR(major))
310 return GSS_S_COMPLETE;
314 initBegin(OM_uint32 *minor,
321 gss_channel_bindings_t chanBindings,
322 gss_buffer_t inputToken,
323 gss_buffer_t outputToken)
327 assert(cred != GSS_C_NO_CREDENTIAL);
329 if (cred->expiryTime)
330 ctx->expiryTime = cred->expiryTime;
331 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
334 ctx->expiryTime = time(NULL) + timeReq;
336 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
337 if (GSS_ERROR(major))
340 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
341 if (GSS_ERROR(major))
344 if (mech == GSS_C_NULL_OID || oidEqual(mech, GSS_EAP_MECHANISM)) {
345 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
346 } else if (gssEapIsConcreteMechanismOid(mech)) {
347 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
348 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
350 major = GSS_S_BAD_MECH;
352 if (GSS_ERROR(major))
355 /* If credentials were provided, check they're usable with this mech */
356 if (!gssEapCredAvailable(cred, ctx->mechanismUsed))
357 return GSS_S_BAD_MECH;
359 return GSS_S_COMPLETE;
363 eapGssSmInitIdentity(OM_uint32 *minor,
370 gss_channel_bindings_t chanBindings,
371 gss_buffer_t inputToken,
372 gss_buffer_t outputToken)
375 int initialContextToken;
377 initialContextToken = (inputToken->length == 0);
378 if (!initialContextToken)
379 return GSS_S_DEFECTIVE_TOKEN;
381 major = initBegin(minor, cred, ctx, target, mech,
382 reqFlags, timeReq, chanBindings,
383 inputToken, outputToken);
384 if (GSS_ERROR(major))
387 ctx->state = EAP_STATE_AUTHENTICATE;
389 return GSS_S_CONTINUE_NEEDED;
392 static struct wpabuf emptyWpaBuffer;
395 eapGssSmInitAuthenticate(OM_uint32 *minor,
402 gss_channel_bindings_t chanBindings,
403 gss_buffer_t inputToken,
404 gss_buffer_t outputToken)
409 struct wpabuf *resp = NULL;
410 int initialContextToken;
412 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
413 inputToken->length == 0);
415 major = peerConfigInit(minor, cred, ctx);
416 if (GSS_ERROR(major))
419 if (ctx->initiatorCtx.eap == NULL) {
420 struct eap_config eapConfig;
422 memset(&eapConfig, 0, sizeof(eapConfig));
424 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
425 &gssEapPolicyCallbacks,
428 if (ctx->initiatorCtx.eap == NULL) {
429 major = GSS_S_FAILURE;
433 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
436 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
438 wpabuf_set(&ctx->initiatorCtx.reqData,
439 inputToken->value, inputToken->length);
441 major = GSS_S_CONTINUE_NEEDED;
443 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
444 if (ctx->flags & CTX_FLAG_EAP_RESP) {
445 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
447 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
448 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
449 major = initReady(minor, ctx);
450 if (GSS_ERROR(major))
453 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
454 major = GSS_S_CONTINUE_NEEDED;
455 ctx->state = EAP_STATE_EXTENSIONS_REQ;
456 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
457 major = GSS_S_DEFECTIVE_CREDENTIAL;
458 } else if (code == 0 && initialContextToken) {
459 resp = &emptyWpaBuffer;
460 major = GSS_S_CONTINUE_NEEDED;
462 major = GSS_S_DEFECTIVE_TOKEN;
468 gss_buffer_desc respBuf;
470 assert(major == GSS_S_CONTINUE_NEEDED);
472 respBuf.length = wpabuf_len(resp);
473 respBuf.value = (void *)wpabuf_head(resp);
475 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
476 if (GSS_ERROR(tmpMajor)) {
482 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
483 peerConfigFree(&tmpMinor, ctx);
489 initGssChannelBindings(OM_uint32 *minor,
491 gss_channel_bindings_t chanBindings,
492 gss_buffer_t outputToken)
495 gss_buffer_desc buffer = GSS_C_EMPTY_BUFFER;
498 if (chanBindings != GSS_C_NO_CHANNEL_BINDINGS)
499 buffer = chanBindings->application_data;
501 major = gssEapWrap(minor, ctx, TRUE, GSS_C_QOP_DEFAULT,
502 &buffer, NULL, outputToken);
503 if (GSS_ERROR(major))
506 return GSS_S_CONTINUE_NEEDED;
510 eapGssSmInitExtensionsReq(OM_uint32 *minor,
517 gss_channel_bindings_t chanBindings,
518 gss_buffer_t inputToken,
519 gss_buffer_t outputToken)
521 OM_uint32 major, tmpMinor;
522 gss_buffer_desc cbToken = GSS_C_EMPTY_BUFFER;
524 major = initGssChannelBindings(minor, ctx, chanBindings, &cbToken);
525 if (GSS_ERROR(major))
528 ctx->state = EAP_STATE_EXTENSIONS_RESP;
530 major = duplicateBuffer(minor, &cbToken, outputToken);
531 if (GSS_ERROR(major)) {
532 gss_release_buffer(&tmpMinor, &cbToken);
536 gss_release_buffer(&tmpMinor, &cbToken);
538 return GSS_S_CONTINUE_NEEDED;
542 eapGssSmInitExtensionsResp(OM_uint32 *minor,
549 gss_channel_bindings_t chanBindings,
550 gss_buffer_t inputToken,
551 gss_buffer_t outputToken)
553 #ifdef GSSEAP_ENABLE_REAUTH
556 major = gssEapStoreReauthCreds(minor, ctx, cred, inputToken);
557 if (GSS_ERROR(major))
561 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 */
580 return GSS_S_BAD_STATUS;
583 static struct gss_eap_initiator_sm {
584 enum gss_eap_token_type inputTokenType;
585 enum gss_eap_token_type outputTokenType;
586 OM_uint32 (*processToken)(OM_uint32 *,
593 gss_channel_bindings_t,
596 } eapGssInitiatorSm[] = {
597 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
598 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
599 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
600 { TOK_TYPE_EXT_RESP,TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
601 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
602 #ifdef GSSEAP_ENABLE_REAUTH
603 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
608 gss_init_sec_context(OM_uint32 *minor,
610 gss_ctx_id_t *context_handle,
611 gss_name_t target_name,
615 gss_channel_bindings_t input_chan_bindings,
616 gss_buffer_t input_token,
617 gss_OID *actual_mech_type,
618 gss_buffer_t output_token,
619 OM_uint32 *ret_flags,
623 OM_uint32 tmpMajor, tmpMinor;
624 gss_ctx_id_t ctx = *context_handle;
625 struct gss_eap_initiator_sm *sm = NULL;
626 gss_buffer_desc innerInputToken;
627 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
628 enum gss_eap_token_type tokType;
629 gss_cred_id_t defaultCred = GSS_C_NO_CREDENTIAL;
633 output_token->length = 0;
634 output_token->value = NULL;
636 if (cred != GSS_C_NO_CREDENTIAL) {
637 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
638 major = GSS_S_NO_CRED;
642 major = gssEapAcquireCred(minor, GSS_C_NO_NAME, GSS_C_NO_BUFFER,
643 time_req, GSS_C_NO_OID_SET, GSS_C_INITIATE,
644 &defaultCred, NULL, NULL);
645 if (GSS_ERROR(major))
651 if (ctx == GSS_C_NO_CONTEXT) {
652 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
653 return GSS_S_DEFECTIVE_TOKEN;
656 major = gssEapAllocContext(minor, &ctx);
657 if (GSS_ERROR(major))
660 ctx->flags |= CTX_FLAG_INITIATOR;
662 #ifdef GSSEAP_ENABLE_REAUTH
663 if (canReauthP(cred))
664 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
667 *context_handle = ctx;
670 GSSEAP_MUTEX_LOCK(&ctx->mutex);
672 sm = &eapGssInitiatorSm[ctx->state];
674 if (input_token != GSS_C_NO_BUFFER) {
675 major = gssEapVerifyToken(minor, ctx, input_token,
676 &tokType, &innerInputToken);
677 if (GSS_ERROR(major))
680 if (tokType != sm->inputTokenType) {
681 major = GSS_S_DEFECTIVE_TOKEN;
685 innerInputToken.length = 0;
686 innerInputToken.value = NULL;
690 * Advance through state machine whilst empty tokens are emitted and
691 * the status is not GSS_S_COMPLETE or an error status.
694 sm = &eapGssInitiatorSm[ctx->state];
696 major = (sm->processToken)(minor,
706 if (GSS_ERROR(major))
708 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
710 if (actual_mech_type != NULL) {
711 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
712 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
714 if (innerOutputToken.value != NULL) {
715 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
716 sm->outputTokenType, output_token);
717 if (GSS_ERROR(tmpMajor)) {
723 if (ret_flags != NULL)
724 *ret_flags = ctx->gssFlags;
725 if (time_rec != NULL)
726 gssEapContextTime(&tmpMinor, ctx, time_rec);
728 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
731 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
733 if (GSS_ERROR(major))
734 gssEapReleaseContext(&tmpMinor, context_handle);
736 gss_release_buffer(&tmpMinor, &innerOutputToken);
737 gssEapReleaseCred(&tmpMinor, &defaultCred);
742 #ifdef GSSEAP_ENABLE_REAUTH
744 canReauthP(gss_cred_id_t cred)
746 return (cred != GSS_C_NO_CREDENTIAL &&
747 cred->krbCred != GSS_C_NO_CREDENTIAL &&
748 cred->expiryTime > time(NULL));
752 eapGssSmInitGssReauth(OM_uint32 *minor,
759 gss_channel_bindings_t chanBindings,
760 gss_buffer_t inputToken,
761 gss_buffer_t outputToken)
763 OM_uint32 major, tmpMinor;
764 gss_name_t mechTarget = GSS_C_NO_NAME;
765 gss_OID actualMech = GSS_C_NO_OID;
766 OM_uint32 gssFlags, timeRec;
768 assert(cred != GSS_C_NO_CREDENTIAL);
770 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
772 if (inputToken->length == 0) {
773 major = initBegin(minor, cred, ctx, target, mech,
774 reqFlags, timeReq, chanBindings,
775 inputToken, outputToken);
776 if (GSS_ERROR(major))
780 major = gssEapMechToGlueName(minor, target, &mechTarget);
781 if (GSS_ERROR(major))
784 major = gssInitSecContext(minor,
788 (gss_OID)gss_mech_krb5,
789 reqFlags, /* | GSS_C_DCE_STYLE, */
797 if (GSS_ERROR(major))
800 ctx->gssFlags = gssFlags;
802 if (major == GSS_S_COMPLETE) {
803 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
804 if (GSS_ERROR(major))
806 ctx->state = EAP_STATE_ESTABLISHED;
810 gssReleaseName(&tmpMinor, &mechTarget);
814 #endif /* GSSEAP_ENABLE_REAUTH */