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, OM_uint32 reqFlags)
259 const unsigned char *key;
261 krb5_enctype encryptionType;
265 /* XXX actually check for mutual auth */
266 if (reqFlags & GSS_C_MUTUAL_FLAG)
267 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
270 /* Cache encryption type derived from selected mechanism OID */
271 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &encryptionType);
272 if (GSS_ERROR(major))
275 if (encryptionType != ENCTYPE_NULL &&
276 eap_key_available(ctx->initiatorCtx.eap)) {
277 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
279 if (keyLength >= EAP_EMSK_LEN) {
280 major = gssEapDeriveRfc3961Key(minor,
281 &key[EAP_EMSK_LEN / 2],
285 if (GSS_ERROR(major))
288 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
290 if (GSS_ERROR(major))
297 ctx->encryptionType = encryptionType;
300 * draft-howlett-eap-gss says that integrity/confidentialty should
301 * always be advertised as available, but if we have no keying
302 * material it seems confusing to the caller to advertise this.
304 ctx->gssFlags &= ~(GSS_C_INTEG_FLAG | GSS_C_CONF_FLAG);
307 major = sequenceInit(minor,
310 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
311 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
313 if (GSS_ERROR(major))
316 return GSS_S_COMPLETE;
320 initBegin(OM_uint32 *minor,
327 gss_channel_bindings_t chanBindings,
328 gss_buffer_t inputToken,
329 gss_buffer_t outputToken)
333 assert(cred != GSS_C_NO_CREDENTIAL);
335 if (cred->expiryTime)
336 ctx->expiryTime = cred->expiryTime;
337 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
340 ctx->expiryTime = time(NULL) + timeReq;
342 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
343 if (GSS_ERROR(major))
346 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
347 if (GSS_ERROR(major))
350 if (mech == GSS_C_NULL_OID || oidEqual(mech, GSS_EAP_MECHANISM)) {
351 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
352 } else if (gssEapIsConcreteMechanismOid(mech)) {
353 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
354 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
356 major = GSS_S_BAD_MECH;
358 if (GSS_ERROR(major))
361 /* If credentials were provided, check they're usable with this mech */
362 if (!gssEapCredAvailable(cred, ctx->mechanismUsed))
363 return GSS_S_BAD_MECH;
365 return GSS_S_COMPLETE;
369 eapGssSmInitIdentity(OM_uint32 *minor,
376 gss_channel_bindings_t chanBindings,
377 gss_buffer_t inputToken,
378 gss_buffer_t outputToken)
381 int initialContextToken;
383 initialContextToken = (inputToken->length == 0);
384 if (!initialContextToken)
385 return GSS_S_DEFECTIVE_TOKEN;
387 major = initBegin(minor, cred, ctx, target, mech,
388 reqFlags, timeReq, chanBindings,
389 inputToken, outputToken);
390 if (GSS_ERROR(major))
393 ctx->state = EAP_STATE_AUTHENTICATE;
395 return GSS_S_CONTINUE_NEEDED;
398 static struct wpabuf emptyWpaBuffer;
401 eapGssSmInitAuthenticate(OM_uint32 *minor,
408 gss_channel_bindings_t chanBindings,
409 gss_buffer_t inputToken,
410 gss_buffer_t outputToken)
415 struct wpabuf *resp = NULL;
416 int initialContextToken;
418 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
419 inputToken->length == 0);
421 major = peerConfigInit(minor, cred, ctx);
422 if (GSS_ERROR(major))
425 if (ctx->initiatorCtx.eap == NULL) {
426 struct eap_config eapConfig;
428 memset(&eapConfig, 0, sizeof(eapConfig));
430 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
431 &gssEapPolicyCallbacks,
434 if (ctx->initiatorCtx.eap == NULL) {
435 major = GSS_S_FAILURE;
439 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
442 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
444 wpabuf_set(&ctx->initiatorCtx.reqData,
445 inputToken->value, inputToken->length);
447 major = GSS_S_CONTINUE_NEEDED;
449 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
450 if (ctx->flags & CTX_FLAG_EAP_RESP) {
451 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
453 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
454 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
455 major = initReady(minor, ctx, reqFlags);
456 if (GSS_ERROR(major))
459 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
460 major = GSS_S_CONTINUE_NEEDED;
461 ctx->state = EAP_STATE_EXTENSIONS_REQ;
462 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
463 major = GSS_S_DEFECTIVE_CREDENTIAL;
464 } else if (code == 0 && initialContextToken) {
465 resp = &emptyWpaBuffer;
466 major = GSS_S_CONTINUE_NEEDED;
468 major = GSS_S_DEFECTIVE_TOKEN;
474 gss_buffer_desc respBuf;
476 assert(major == GSS_S_CONTINUE_NEEDED);
478 respBuf.length = wpabuf_len(resp);
479 respBuf.value = (void *)wpabuf_head(resp);
481 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
482 if (GSS_ERROR(tmpMajor)) {
488 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
489 peerConfigFree(&tmpMinor, ctx);
495 initGssChannelBindings(OM_uint32 *minor,
497 gss_channel_bindings_t chanBindings,
498 gss_buffer_t outputToken)
501 gss_buffer_desc buffer = GSS_C_EMPTY_BUFFER;
504 if (chanBindings != GSS_C_NO_CHANNEL_BINDINGS)
505 buffer = chanBindings->application_data;
507 major = gssEapWrap(minor, ctx, TRUE, GSS_C_QOP_DEFAULT,
508 &buffer, NULL, outputToken);
509 if (GSS_ERROR(major))
512 return GSS_S_CONTINUE_NEEDED;
516 eapGssSmInitExtensionsReq(OM_uint32 *minor,
523 gss_channel_bindings_t chanBindings,
524 gss_buffer_t inputToken,
525 gss_buffer_t outputToken)
527 OM_uint32 major, tmpMinor;
528 gss_buffer_desc cbToken = GSS_C_EMPTY_BUFFER;
530 major = initGssChannelBindings(minor, ctx, chanBindings, &cbToken);
531 if (GSS_ERROR(major))
534 ctx->state = EAP_STATE_EXTENSIONS_RESP;
536 major = duplicateBuffer(minor, &cbToken, outputToken);
537 if (GSS_ERROR(major)) {
538 gss_release_buffer(&tmpMinor, &cbToken);
542 gss_release_buffer(&tmpMinor, &cbToken);
544 return GSS_S_CONTINUE_NEEDED;
548 eapGssSmInitExtensionsResp(OM_uint32 *minor,
555 gss_channel_bindings_t chanBindings,
556 gss_buffer_t inputToken,
557 gss_buffer_t outputToken)
559 #ifdef GSSEAP_ENABLE_REAUTH
562 major = gssEapStoreReauthCreds(minor, ctx, cred, inputToken);
563 if (GSS_ERROR(major))
567 ctx->state = EAP_STATE_ESTABLISHED;
569 return GSS_S_COMPLETE;
573 eapGssSmInitEstablished(OM_uint32 *minor,
580 gss_channel_bindings_t chanBindings,
581 gss_buffer_t inputToken,
582 gss_buffer_t outputToken)
584 /* Called with already established context */
586 return GSS_S_BAD_STATUS;
589 static struct gss_eap_initiator_sm {
590 enum gss_eap_token_type inputTokenType;
591 enum gss_eap_token_type outputTokenType;
592 OM_uint32 (*processToken)(OM_uint32 *,
599 gss_channel_bindings_t,
602 } eapGssInitiatorSm[] = {
603 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
604 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
605 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
606 { TOK_TYPE_EXT_RESP,TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
607 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
608 #ifdef GSSEAP_ENABLE_REAUTH
609 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
614 gss_init_sec_context(OM_uint32 *minor,
616 gss_ctx_id_t *context_handle,
617 gss_name_t target_name,
621 gss_channel_bindings_t input_chan_bindings,
622 gss_buffer_t input_token,
623 gss_OID *actual_mech_type,
624 gss_buffer_t output_token,
625 OM_uint32 *ret_flags,
629 OM_uint32 tmpMajor, tmpMinor;
630 gss_ctx_id_t ctx = *context_handle;
631 struct gss_eap_initiator_sm *sm = NULL;
632 gss_buffer_desc innerInputToken;
633 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
634 enum gss_eap_token_type tokType;
635 gss_cred_id_t defaultCred = GSS_C_NO_CREDENTIAL;
639 output_token->length = 0;
640 output_token->value = NULL;
642 if (ctx == GSS_C_NO_CONTEXT) {
643 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
644 return GSS_S_DEFECTIVE_TOKEN;
647 major = gssEapAllocContext(minor, &ctx);
648 if (GSS_ERROR(major))
651 ctx->flags |= CTX_FLAG_INITIATOR;
653 #ifdef GSSEAP_ENABLE_REAUTH
654 if (canReauthP(cred))
655 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
658 *context_handle = ctx;
661 if (cred != GSS_C_NO_CREDENTIAL) {
662 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
663 major = GSS_S_NO_CRED;
667 if (ctx->initiatorCtx.defaultCred == GSS_C_NO_CREDENTIAL) {
668 major = gssEapAcquireCred(minor,
677 if (GSS_ERROR(major))
681 cred = ctx->initiatorCtx.defaultCred;
684 GSSEAP_MUTEX_LOCK(&ctx->mutex);
686 sm = &eapGssInitiatorSm[ctx->state];
688 if (input_token != GSS_C_NO_BUFFER) {
689 major = gssEapVerifyToken(minor, ctx, input_token,
690 &tokType, &innerInputToken);
691 if (GSS_ERROR(major))
694 if (tokType != sm->inputTokenType) {
695 major = GSS_S_DEFECTIVE_TOKEN;
699 innerInputToken.length = 0;
700 innerInputToken.value = NULL;
704 * Advance through state machine whilst empty tokens are emitted and
705 * the status is not GSS_S_COMPLETE or an error status.
708 sm = &eapGssInitiatorSm[ctx->state];
710 major = (sm->processToken)(minor,
720 if (GSS_ERROR(major))
722 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
724 if (actual_mech_type != NULL) {
725 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
726 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
728 if (innerOutputToken.value != NULL) {
729 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
730 sm->outputTokenType, output_token);
731 if (GSS_ERROR(tmpMajor)) {
737 if (ret_flags != NULL)
738 *ret_flags = ctx->gssFlags;
739 if (time_rec != NULL)
740 gssEapContextTime(&tmpMinor, ctx, time_rec);
742 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
745 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
747 if (GSS_ERROR(major))
748 gssEapReleaseContext(&tmpMinor, context_handle);
750 gss_release_buffer(&tmpMinor, &innerOutputToken);
755 #ifdef GSSEAP_ENABLE_REAUTH
757 canReauthP(gss_cred_id_t cred)
759 return (cred != GSS_C_NO_CREDENTIAL &&
760 cred->krbCred != GSS_C_NO_CREDENTIAL &&
761 cred->expiryTime > time(NULL));
765 eapGssSmInitGssReauth(OM_uint32 *minor,
772 gss_channel_bindings_t chanBindings,
773 gss_buffer_t inputToken,
774 gss_buffer_t outputToken)
776 OM_uint32 major, tmpMinor;
777 gss_name_t mechTarget = GSS_C_NO_NAME;
778 gss_OID actualMech = GSS_C_NO_OID;
779 OM_uint32 gssFlags, timeRec;
781 assert(cred != GSS_C_NO_CREDENTIAL);
783 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
785 if (inputToken->length == 0) {
786 major = initBegin(minor, cred, ctx, target, mech,
787 reqFlags, timeReq, chanBindings,
788 inputToken, outputToken);
789 if (GSS_ERROR(major))
793 major = gssEapMechToGlueName(minor, target, &mechTarget);
794 if (GSS_ERROR(major))
797 major = gssInitSecContext(minor,
801 (gss_OID)gss_mech_krb5,
802 reqFlags, /* | GSS_C_DCE_STYLE, */
810 if (GSS_ERROR(major))
813 ctx->gssFlags = gssFlags;
815 if (major == GSS_S_COMPLETE) {
816 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
817 if (GSS_ERROR(major))
819 ctx->state = EAP_STATE_ESTABLISHED;
823 gssReleaseName(&tmpMinor, &mechTarget);
827 #endif /* GSSEAP_ENABLE_REAUTH */