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
34 * Establish a security context on the initiator (client). These functions
38 #include "gssapiP_eap.h"
40 #ifdef GSSEAP_ENABLE_REAUTH
42 eapGssSmInitGssReauth(OM_uint32 *minor,
49 gss_channel_bindings_t chanBindings,
50 gss_buffer_t inputToken,
51 gss_buffer_t outputToken);
55 policyVariableToFlag(enum eapol_bool_var variable)
60 case EAPOL_eapSuccess:
61 flag = CTX_FLAG_EAP_SUCCESS;
63 case EAPOL_eapRestart:
64 flag = CTX_FLAG_EAP_RESTART;
67 flag = CTX_FLAG_EAP_FAIL;
70 flag = CTX_FLAG_EAP_RESP;
73 flag = CTX_FLAG_EAP_NO_RESP;
76 flag = CTX_FLAG_EAP_REQ;
78 case EAPOL_portEnabled:
79 flag = CTX_FLAG_EAP_PORT_ENABLED;
82 flag = CTX_FLAG_EAP_ALT_ACCEPT;
85 flag = CTX_FLAG_EAP_ALT_REJECT;
92 static struct eap_peer_config *
93 peerGetConfig(void *ctx)
95 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
97 return &gssCtx->initiatorCtx.eapPeerConfig;
101 peerGetBool(void *data, enum eapol_bool_var variable)
103 gss_ctx_id_t ctx = data;
106 if (ctx == GSS_C_NO_CONTEXT)
109 flag = policyVariableToFlag(variable);
111 return ((ctx->flags & flag) != 0);
115 peerSetBool(void *data, enum eapol_bool_var variable,
118 gss_ctx_id_t ctx = data;
121 if (ctx == GSS_C_NO_CONTEXT)
124 flag = policyVariableToFlag(variable);
129 ctx->flags &= ~(flag);
133 peerGetInt(void *data, enum eapol_int_var variable)
135 gss_ctx_id_t ctx = data;
137 if (ctx == GSS_C_NO_CONTEXT)
140 assert(CTX_IS_INITIATOR(ctx));
143 case EAPOL_idleWhile:
144 return ctx->initiatorCtx.idleWhile;
152 peerSetInt(void *data, enum eapol_int_var variable,
155 gss_ctx_id_t ctx = data;
157 if (ctx == GSS_C_NO_CONTEXT)
160 assert(CTX_IS_INITIATOR(ctx));
163 case EAPOL_idleWhile:
164 ctx->initiatorCtx.idleWhile = value;
169 static struct wpabuf *
170 peerGetEapReqData(void *ctx)
172 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
174 return &gssCtx->initiatorCtx.reqData;
178 peerSetConfigBlob(void *ctx, struct wpa_config_blob *blob)
182 static const struct wpa_config_blob *
183 peerGetConfigBlob(void *ctx, const char *name)
189 peerNotifyPending(void *ctx)
193 static struct eapol_callbacks gssEapPolicyCallbacks = {
206 extern int wpa_debug_level;
210 peerConfigInit(OM_uint32 *minor,
214 krb5_context krbContext;
215 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
216 krb5_error_code code;
219 eapPeerConfig->identity = NULL;
220 eapPeerConfig->identity_len = 0;
221 eapPeerConfig->password = NULL;
222 eapPeerConfig->password_len = 0;
224 assert(cred != GSS_C_NO_CREDENTIAL);
226 GSSEAP_KRB_INIT(&krbContext);
228 eapPeerConfig->fragment_size = 1024;
233 assert(cred->name != GSS_C_NO_NAME);
235 if ((cred->name->flags & (NAME_FLAG_NAI | NAME_FLAG_SERVICE)) == 0) {
236 *minor = GSSEAP_BAD_INITIATOR_NAME;
237 return GSS_S_BAD_NAME;
240 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
243 return GSS_S_FAILURE;
246 eapPeerConfig->identity = (unsigned char *)identity;
247 eapPeerConfig->identity_len = strlen(identity);
248 eapPeerConfig->password = (unsigned char *)cred->password.value;
249 eapPeerConfig->password_len = cred->password.length;
252 return GSS_S_COMPLETE;
256 peerConfigFree(OM_uint32 *minor,
259 krb5_context krbContext;
260 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
262 GSSEAP_KRB_INIT(&krbContext);
264 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
267 return GSS_S_COMPLETE;
271 * Mark an initiator context as ready for cryptographic operations
274 initReady(OM_uint32 *minor, gss_ctx_id_t ctx, OM_uint32 reqFlags)
277 const unsigned char *key;
281 /* XXX actually check for mutual auth */
282 if (reqFlags & GSS_C_MUTUAL_FLAG)
283 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
286 /* Cache encryption type derived from selected mechanism OID */
287 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &ctx->encryptionType);
288 if (GSS_ERROR(major))
291 if (!eap_key_available(ctx->initiatorCtx.eap)) {
292 *minor = GSSEAP_KEY_UNAVAILABLE;
293 return GSS_S_UNAVAILABLE;
296 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
298 if (keyLength < EAP_EMSK_LEN) {
299 *minor = GSSEAP_KEY_TOO_SHORT;
300 return GSS_S_UNAVAILABLE;
303 major = gssEapDeriveRfc3961Key(minor,
304 &key[EAP_EMSK_LEN / 2],
308 if (GSS_ERROR(major))
311 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
313 if (GSS_ERROR(major))
316 major = sequenceInit(minor,
319 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
320 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
322 if (GSS_ERROR(major))
326 return GSS_S_COMPLETE;
330 initBegin(OM_uint32 *minor,
337 gss_channel_bindings_t chanBindings,
338 gss_buffer_t inputToken,
339 gss_buffer_t outputToken)
343 assert(cred != GSS_C_NO_CREDENTIAL);
345 if (cred->expiryTime)
346 ctx->expiryTime = cred->expiryTime;
347 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
350 ctx->expiryTime = time(NULL) + timeReq;
353 * The credential mutex protects its name, however we need to
354 * explicitly lock the acceptor name (unlikely as it may be
355 * that it has attributes set on it).
357 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
358 if (GSS_ERROR(major))
361 GSSEAP_MUTEX_LOCK(&target->mutex);
363 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
364 if (GSS_ERROR(major)) {
365 GSSEAP_MUTEX_UNLOCK(&target->mutex);
369 GSSEAP_MUTEX_UNLOCK(&target->mutex);
371 if (mech == GSS_C_NULL_OID) {
372 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
373 } else if (gssEapIsConcreteMechanismOid(mech)) {
374 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
375 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
377 major = GSS_S_BAD_MECH;
378 *minor = GSSEAP_WRONG_MECH;
380 if (GSS_ERROR(major))
383 /* If credentials were provided, check they're usable with this mech */
384 if (!gssEapCredAvailable(cred, ctx->mechanismUsed)) {
385 *minor = GSSEAP_CRED_MECH_MISMATCH;
386 return GSS_S_BAD_MECH;
390 return GSS_S_COMPLETE;
394 eapGssSmInitIdentity(OM_uint32 *minor,
401 gss_channel_bindings_t chanBindings,
402 gss_buffer_t inputToken,
403 gss_buffer_t outputToken)
406 int initialContextToken;
408 initialContextToken = (inputToken->length == 0);
409 if (!initialContextToken) {
410 *minor = GSSEAP_WRONG_SIZE;
411 return GSS_S_DEFECTIVE_TOKEN;
414 major = initBegin(minor, cred, ctx, target, mech,
415 reqFlags, timeReq, chanBindings,
416 inputToken, outputToken);
417 if (GSS_ERROR(major))
420 ctx->state = GSSEAP_STATE_AUTHENTICATE;
423 return GSS_S_CONTINUE_NEEDED;
426 static struct wpabuf emptyWpaBuffer;
429 eapGssSmInitAuthenticate(OM_uint32 *minor,
436 gss_channel_bindings_t chanBindings,
437 gss_buffer_t inputToken,
438 gss_buffer_t outputToken)
443 struct wpabuf *resp = NULL;
444 int initialContextToken;
448 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
449 inputToken->length == 0);
451 major = peerConfigInit(minor, cred, ctx);
452 if (GSS_ERROR(major))
455 if (ctx->initiatorCtx.eap == NULL) {
456 struct eap_config eapConfig;
458 memset(&eapConfig, 0, sizeof(eapConfig));
460 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
461 &gssEapPolicyCallbacks,
464 if (ctx->initiatorCtx.eap == NULL) {
465 major = GSS_S_FAILURE;
466 *minor = GSSEAP_PEER_SM_INIT_FAILURE;
470 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
473 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
475 wpabuf_set(&ctx->initiatorCtx.reqData,
476 inputToken->value, inputToken->length);
478 major = GSS_S_CONTINUE_NEEDED;
480 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
481 if (ctx->flags & CTX_FLAG_EAP_RESP) {
482 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
484 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
485 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
486 major = initReady(minor, ctx, reqFlags);
487 if (GSS_ERROR(major))
490 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
491 major = GSS_S_CONTINUE_NEEDED;
492 ctx->state = GSSEAP_STATE_EXTENSIONS_REQ;
493 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
494 major = GSS_S_DEFECTIVE_CREDENTIAL;
495 *minor = GSSEAP_PEER_AUTH_FAILURE;
496 } else if (code == 0 && initialContextToken) {
497 resp = &emptyWpaBuffer;
498 major = GSS_S_CONTINUE_NEEDED;
500 major = GSS_S_DEFECTIVE_TOKEN;
501 *minor = GSSEAP_PEER_BAD_MESSAGE;
507 gss_buffer_desc respBuf;
509 assert(major == GSS_S_CONTINUE_NEEDED);
511 respBuf.length = wpabuf_len(resp);
512 respBuf.value = (void *)wpabuf_head(resp);
514 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
515 if (GSS_ERROR(tmpMajor)) {
521 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
522 peerConfigFree(&tmpMinor, ctx);
528 eapGssSmInitExtensionsReq(OM_uint32 *minor,
535 gss_channel_bindings_t chanBindings,
536 gss_buffer_t inputToken,
537 gss_buffer_t outputToken)
541 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
542 if (GSS_ERROR(major))
545 assert(outputToken->value != NULL);
547 ctx->state = GSSEAP_STATE_EXTENSIONS_RESP;
550 return GSS_S_CONTINUE_NEEDED;
554 eapGssSmInitExtensionsResp(OM_uint32 *minor,
561 gss_channel_bindings_t chanBindings,
562 gss_buffer_t inputToken,
563 gss_buffer_t outputToken)
567 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
568 if (GSS_ERROR(major))
571 ctx->state = GSSEAP_STATE_ESTABLISHED;
574 return GSS_S_COMPLETE;
578 eapGssSmInitEstablished(OM_uint32 *minor,
585 gss_channel_bindings_t chanBindings,
586 gss_buffer_t inputToken,
587 gss_buffer_t outputToken)
589 /* Called with already established context */
590 *minor = GSSEAP_CONTEXT_ESTABLISHED;
591 return GSS_S_BAD_STATUS;
595 eapGssSmInitError(OM_uint32 *minor,
602 gss_channel_bindings_t chanBindings,
603 gss_buffer_t inputToken,
604 gss_buffer_t outputToken)
609 if (inputToken->length < 8) {
610 *minor = GSSEAP_TOK_TRUNC;
611 return GSS_S_DEFECTIVE_TOKEN;
614 p = (unsigned char *)inputToken->value;
616 major = load_uint32_be(&p[0]);
617 *minor = ERROR_TABLE_BASE_eapg + load_uint32_be(&p[4]);
619 if (!GSS_ERROR(major) || !IS_WIRE_ERROR(*minor)) {
620 major = GSS_S_FAILURE;
621 *minor = GSSEAP_BAD_ERROR_TOKEN;
627 static struct gss_eap_initiator_sm {
628 enum gss_eap_token_type inputTokenType;
629 enum gss_eap_token_type outputTokenType;
630 OM_uint32 (*processToken)(OM_uint32 *,
637 gss_channel_bindings_t,
640 } eapGssInitiatorSm[] = {
641 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
642 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
643 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
644 { TOK_TYPE_EXT_RESP, TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
645 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
646 { TOK_TYPE_CONTEXT_ERR, TOK_TYPE_NONE, eapGssSmInitError },
647 #ifdef GSSEAP_ENABLE_REAUTH
648 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
653 gss_init_sec_context(OM_uint32 *minor,
655 gss_ctx_id_t *context_handle,
656 gss_name_t target_name,
660 gss_channel_bindings_t input_chan_bindings,
661 gss_buffer_t input_token,
662 gss_OID *actual_mech_type,
663 gss_buffer_t output_token,
664 OM_uint32 *ret_flags,
668 OM_uint32 tmpMajor, tmpMinor;
669 gss_ctx_id_t ctx = *context_handle;
670 struct gss_eap_initiator_sm *sm = NULL;
671 gss_buffer_desc innerInputToken;
672 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
673 enum gss_eap_token_type tokType;
674 int initialContextToken = 0;
678 output_token->length = 0;
679 output_token->value = NULL;
681 if (ctx == GSS_C_NO_CONTEXT) {
682 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
683 *minor = GSSEAP_WRONG_SIZE;
684 return GSS_S_DEFECTIVE_TOKEN;
687 major = gssEapAllocContext(minor, &ctx);
688 if (GSS_ERROR(major))
691 ctx->flags |= CTX_FLAG_INITIATOR;
693 initialContextToken = 1;
694 *context_handle = ctx;
697 GSSEAP_MUTEX_LOCK(&ctx->mutex);
699 if (cred == GSS_C_NO_CREDENTIAL) {
700 if (ctx->defaultCred == GSS_C_NO_CREDENTIAL) {
701 major = gssEapAcquireCred(minor,
710 if (GSS_ERROR(major))
714 cred = ctx->defaultCred;
717 GSSEAP_MUTEX_LOCK(&cred->mutex);
719 #ifdef GSSEAP_ENABLE_REAUTH
720 if (initialContextToken && gssEapCanReauthP(cred, target_name, time_req))
721 ctx->state = GSSEAP_STATE_KRB_REAUTH;
724 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
725 major = GSS_S_NO_CRED;
726 *minor = GSSEAP_CRED_USAGE_MISMATCH;
730 sm = &eapGssInitiatorSm[ctx->state];
732 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
733 major = gssEapVerifyToken(minor, ctx, input_token,
734 &tokType, &innerInputToken);
735 if (GSS_ERROR(major))
738 if (tokType == TOK_TYPE_CONTEXT_ERR) {
739 ctx->state = GSSEAP_STATE_ERROR;
740 } else if (tokType != sm->inputTokenType) {
741 major = GSS_S_DEFECTIVE_TOKEN;
742 *minor = GSSEAP_WRONG_TOK_ID;
746 innerInputToken.length = 0;
747 innerInputToken.value = NULL;
751 * Advance through state machine whilst empty tokens are emitted and
752 * the status is not GSS_S_COMPLETE or an error status.
755 sm = &eapGssInitiatorSm[ctx->state];
757 major = (sm->processToken)(minor,
767 if (GSS_ERROR(major))
769 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
771 if (actual_mech_type != NULL) {
772 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
773 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
775 if (innerOutputToken.value != NULL) {
776 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
777 sm->outputTokenType, output_token);
778 if (GSS_ERROR(tmpMajor)) {
784 if (ret_flags != NULL)
785 *ret_flags = ctx->gssFlags;
786 if (time_rec != NULL)
787 gssEapContextTime(&tmpMinor, ctx, time_rec);
789 assert(ctx->state == GSSEAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
792 if (cred != GSS_C_NO_CREDENTIAL)
793 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
794 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
796 if (GSS_ERROR(major))
797 gssEapReleaseContext(&tmpMinor, context_handle);
799 gss_release_buffer(&tmpMinor, &innerOutputToken);
804 #ifdef GSSEAP_ENABLE_REAUTH
806 eapGssSmInitGssReauth(OM_uint32 *minor,
813 gss_channel_bindings_t chanBindings,
814 gss_buffer_t inputToken,
815 gss_buffer_t outputToken)
817 OM_uint32 major, tmpMinor;
818 gss_name_t mechTarget = GSS_C_NO_NAME;
819 gss_OID actualMech = GSS_C_NO_OID;
820 OM_uint32 gssFlags, timeRec;
822 assert(cred != GSS_C_NO_CREDENTIAL);
824 ctx->flags |= CTX_FLAG_KRB_REAUTH;
826 if (inputToken->length == 0) {
827 major = initBegin(minor, cred, ctx, target, mech,
828 reqFlags, timeReq, chanBindings,
829 inputToken, outputToken);
830 if (GSS_ERROR(major))
834 major = gssEapMechToGlueName(minor, target, &mechTarget);
835 if (GSS_ERROR(major))
838 major = gssInitSecContext(minor,
842 (gss_OID)gss_mech_krb5,
843 reqFlags, /* | GSS_C_DCE_STYLE, */
851 if (GSS_ERROR(major))
854 ctx->gssFlags = gssFlags;
856 if (major == GSS_S_COMPLETE) {
857 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
858 if (GSS_ERROR(major))
860 ctx->state = GSSEAP_STATE_ESTABLISHED;
864 gssReleaseName(&tmpMinor, &mechTarget);
868 #endif /* GSSEAP_ENABLE_REAUTH */