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 if (cred == GSS_C_NO_CREDENTIAL)
221 return GSS_S_NO_CRED;
223 GSSEAP_KRB_INIT(&krbContext);
225 eapPeerConfig->fragment_size = 1024;
228 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
231 return GSS_S_FAILURE;
234 eapPeerConfig->identity = (unsigned char *)identity;
235 eapPeerConfig->identity_len = strlen(identity);
236 eapPeerConfig->password = (unsigned char *)cred->password.value;
237 eapPeerConfig->password_len = cred->password.length;
239 return GSS_S_COMPLETE;
243 peerConfigFree(OM_uint32 *minor,
246 krb5_context krbContext;
247 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
249 GSSEAP_KRB_INIT(&krbContext);
251 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
253 return GSS_S_COMPLETE;
257 initReady(OM_uint32 *minor, gss_ctx_id_t ctx)
260 const unsigned char *key;
262 krb5_enctype encryptionType;
265 /* Cache encryption type derived from selected mechanism OID */
266 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &encryptionType);
267 if (GSS_ERROR(major))
270 if (encryptionType != ENCTYPE_NULL &&
271 eap_key_available(ctx->initiatorCtx.eap)) {
272 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
274 if (keyLength >= EAP_EMSK_LEN) {
275 major = gssEapDeriveRfc3961Key(minor,
276 &key[EAP_EMSK_LEN / 2],
280 if (GSS_ERROR(major))
283 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
285 if (GSS_ERROR(major))
292 ctx->encryptionType = encryptionType;
295 * draft-howlett-eap-gss says that integrity/confidentialty should
296 * always be advertised as available, but if we have no keying
297 * material it seems confusing to the caller to advertise this.
299 ctx->gssFlags &= ~(GSS_C_INTEG_FLAG | GSS_C_CONF_FLAG);
302 major = sequenceInit(minor,
305 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
306 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
308 if (GSS_ERROR(major))
311 return GSS_S_COMPLETE;
315 initBegin(OM_uint32 *minor,
322 gss_channel_bindings_t chanBindings,
323 gss_buffer_t inputToken,
324 gss_buffer_t outputToken)
328 if (cred != GSS_C_NO_CREDENTIAL && cred->expiryTime)
329 ctx->expiryTime = cred->expiryTime;
330 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
333 ctx->expiryTime = time(NULL) + timeReq;
335 if (cred != GSS_C_NO_CREDENTIAL) {
336 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
337 if (GSS_ERROR(major))
341 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
342 if (GSS_ERROR(major))
345 if (mech == GSS_C_NULL_OID || oidEqual(mech, GSS_EAP_MECHANISM)) {
346 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
347 } else if (gssEapIsConcreteMechanismOid(mech)) {
348 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
349 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
351 major = GSS_S_BAD_MECH;
353 if (GSS_ERROR(major))
356 /* If credentials were provided, check they're usable with this mech */
357 if (!gssEapCredAvailable(cred, ctx->mechanismUsed))
358 return GSS_S_BAD_MECH;
360 return GSS_S_COMPLETE;
364 eapGssSmInitIdentity(OM_uint32 *minor,
371 gss_channel_bindings_t chanBindings,
372 gss_buffer_t inputToken,
373 gss_buffer_t outputToken)
376 int initialContextToken;
378 initialContextToken = (inputToken->length == 0);
379 if (!initialContextToken)
380 return GSS_S_DEFECTIVE_TOKEN;
382 major = initBegin(minor, cred, ctx, target, mech,
383 reqFlags, timeReq, chanBindings,
384 inputToken, outputToken);
385 if (GSS_ERROR(major))
388 ctx->state = EAP_STATE_AUTHENTICATE;
390 return GSS_S_CONTINUE_NEEDED;
393 static struct wpabuf emptyWpaBuffer;
396 eapGssSmInitAuthenticate(OM_uint32 *minor,
403 gss_channel_bindings_t chanBindings,
404 gss_buffer_t inputToken,
405 gss_buffer_t outputToken)
410 struct wpabuf *resp = NULL;
411 int initialContextToken;
413 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
414 inputToken->length == 0);
416 major = peerConfigInit(minor, cred, ctx);
417 if (GSS_ERROR(major))
420 if (ctx->initiatorCtx.eap == NULL) {
421 struct eap_config eapConfig;
423 memset(&eapConfig, 0, sizeof(eapConfig));
425 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
426 &gssEapPolicyCallbacks,
429 if (ctx->initiatorCtx.eap == NULL) {
430 major = GSS_S_FAILURE;
434 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
437 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
439 wpabuf_set(&ctx->initiatorCtx.reqData,
440 inputToken->value, inputToken->length);
442 major = GSS_S_CONTINUE_NEEDED;
444 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
445 if (ctx->flags & CTX_FLAG_EAP_RESP) {
446 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
448 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
449 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
450 major = initReady(minor, ctx);
451 if (GSS_ERROR(major))
454 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
455 major = GSS_S_CONTINUE_NEEDED;
456 ctx->state = EAP_STATE_EXTENSIONS_REQ;
457 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
458 major = GSS_S_DEFECTIVE_CREDENTIAL;
459 } else if (code == 0 && initialContextToken) {
460 resp = &emptyWpaBuffer;
461 major = GSS_S_CONTINUE_NEEDED;
463 major = GSS_S_DEFECTIVE_TOKEN;
469 gss_buffer_desc respBuf;
471 assert(major == GSS_S_CONTINUE_NEEDED);
473 respBuf.length = wpabuf_len(resp);
474 respBuf.value = (void *)wpabuf_head(resp);
476 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
477 if (GSS_ERROR(tmpMajor)) {
483 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
484 peerConfigFree(&tmpMinor, ctx);
490 initGssChannelBindings(OM_uint32 *minor,
492 gss_channel_bindings_t chanBindings,
493 gss_buffer_t outputToken)
496 gss_buffer_desc buffer = GSS_C_EMPTY_BUFFER;
499 if (chanBindings != GSS_C_NO_CHANNEL_BINDINGS)
500 buffer = chanBindings->application_data;
502 major = gssEapWrap(minor, ctx, TRUE, GSS_C_QOP_DEFAULT,
503 &buffer, NULL, outputToken);
504 if (GSS_ERROR(major))
507 return GSS_S_CONTINUE_NEEDED;
511 eapGssSmInitExtensionsReq(OM_uint32 *minor,
518 gss_channel_bindings_t chanBindings,
519 gss_buffer_t inputToken,
520 gss_buffer_t outputToken)
522 OM_uint32 major, tmpMinor;
523 gss_buffer_desc cbToken = GSS_C_EMPTY_BUFFER;
525 major = initGssChannelBindings(minor, ctx, chanBindings, &cbToken);
526 if (GSS_ERROR(major))
529 ctx->state = EAP_STATE_EXTENSIONS_RESP;
531 major = duplicateBuffer(minor, &cbToken, outputToken);
532 if (GSS_ERROR(major)) {
533 gss_release_buffer(&tmpMinor, &cbToken);
537 gss_release_buffer(&tmpMinor, &cbToken);
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)
554 #ifdef GSSEAP_ENABLE_REAUTH
557 major = gssEapStoreReauthCreds(minor, ctx, cred, inputToken);
558 if (GSS_ERROR(major))
562 ctx->state = EAP_STATE_ESTABLISHED;
564 return GSS_S_COMPLETE;
568 eapGssSmInitEstablished(OM_uint32 *minor,
575 gss_channel_bindings_t chanBindings,
576 gss_buffer_t inputToken,
577 gss_buffer_t outputToken)
579 /* Called with already established context */
581 return GSS_S_BAD_STATUS;
584 static struct gss_eap_initiator_sm {
585 enum gss_eap_token_type inputTokenType;
586 enum gss_eap_token_type outputTokenType;
587 OM_uint32 (*processToken)(OM_uint32 *,
594 gss_channel_bindings_t,
597 } eapGssInitiatorSm[] = {
598 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
599 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
600 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
601 { TOK_TYPE_EXT_RESP,TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
602 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
603 #ifdef GSSEAP_ENABLE_REAUTH
604 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
609 gss_init_sec_context(OM_uint32 *minor,
611 gss_ctx_id_t *context_handle,
612 gss_name_t target_name,
616 gss_channel_bindings_t input_chan_bindings,
617 gss_buffer_t input_token,
618 gss_OID *actual_mech_type,
619 gss_buffer_t output_token,
620 OM_uint32 *ret_flags,
624 OM_uint32 tmpMajor, tmpMinor;
625 gss_ctx_id_t ctx = *context_handle;
626 struct gss_eap_initiator_sm *sm = NULL;
627 gss_buffer_desc innerInputToken;
628 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
629 enum gss_eap_token_type tokType;
633 output_token->length = 0;
634 output_token->value = NULL;
636 if (cred != GSS_C_NO_CREDENTIAL && !(cred->flags & CRED_FLAG_INITIATE)) {
637 return GSS_S_NO_CRED;
640 if (ctx == GSS_C_NO_CONTEXT) {
641 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
642 return GSS_S_DEFECTIVE_TOKEN;
645 major = gssEapAllocContext(minor, &ctx);
646 if (GSS_ERROR(major))
649 ctx->flags |= CTX_FLAG_INITIATOR;
651 #ifdef GSSEAP_ENABLE_REAUTH
652 if (canReauthP(cred))
653 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
656 *context_handle = ctx;
659 GSSEAP_MUTEX_LOCK(&ctx->mutex);
661 sm = &eapGssInitiatorSm[ctx->state];
663 if (input_token != GSS_C_NO_BUFFER) {
664 major = gssEapVerifyToken(minor, ctx, input_token,
665 &tokType, &innerInputToken);
666 if (GSS_ERROR(major))
669 if (tokType != sm->inputTokenType) {
670 major = GSS_S_DEFECTIVE_TOKEN;
674 innerInputToken.length = 0;
675 innerInputToken.value = NULL;
679 * Advance through state machine whilst empty tokens are emitted and
680 * the status is not GSS_S_COMPLETE or an error status.
683 sm = &eapGssInitiatorSm[ctx->state];
685 major = (sm->processToken)(minor,
695 if (GSS_ERROR(major))
697 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
699 if (actual_mech_type != NULL) {
700 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
701 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
703 if (innerOutputToken.value != NULL) {
704 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
705 sm->outputTokenType, output_token);
706 if (GSS_ERROR(tmpMajor)) {
712 if (ret_flags != NULL)
713 *ret_flags = ctx->gssFlags;
714 if (time_rec != NULL)
715 gssEapContextTime(&tmpMinor, ctx, time_rec);
717 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
720 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
722 if (GSS_ERROR(major))
723 gssEapReleaseContext(&tmpMinor, context_handle);
725 gss_release_buffer(&tmpMinor, &innerOutputToken);
730 #ifdef GSSEAP_ENABLE_REAUTH
732 canReauthP(gss_cred_id_t cred)
734 return (cred != GSS_C_NO_CREDENTIAL &&
735 cred->krbCred != GSS_C_NO_CREDENTIAL &&
736 cred->expiryTime > time(NULL));
740 eapGssSmInitGssReauth(OM_uint32 *minor,
747 gss_channel_bindings_t chanBindings,
748 gss_buffer_t inputToken,
749 gss_buffer_t outputToken)
751 OM_uint32 major, tmpMinor;
752 gss_name_t mechTarget = GSS_C_NO_NAME;
753 gss_OID actualMech = GSS_C_NO_OID;
754 OM_uint32 gssFlags, timeRec;
756 assert(cred != GSS_C_NO_CREDENTIAL);
758 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
760 if (inputToken->length == 0) {
761 major = initBegin(minor, cred, ctx, target, mech,
762 reqFlags, timeReq, chanBindings,
763 inputToken, outputToken);
764 if (GSS_ERROR(major))
768 major = gssEapMechToGlueName(minor, target, &mechTarget);
769 if (GSS_ERROR(major))
772 major = gssInitSecContext(minor,
776 (gss_OID)gss_mech_krb5,
777 reqFlags, /* | GSS_C_DCE_STYLE, */
785 if (GSS_ERROR(major))
788 ctx->gssFlags = gssFlags;
790 if (major == GSS_S_COMPLETE) {
791 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
792 if (GSS_ERROR(major))
794 ctx->state = EAP_STATE_ESTABLISHED;
798 gssReleaseName(&tmpMinor, &mechTarget);
802 #endif /* GSSEAP_ENABLE_REAUTH */