2 * Copyright (c) 2011, 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"
41 policyVariableToFlag(enum eapol_bool_var variable)
46 case EAPOL_eapSuccess:
47 flag = CTX_FLAG_EAP_SUCCESS;
49 case EAPOL_eapRestart:
50 flag = CTX_FLAG_EAP_RESTART;
53 flag = CTX_FLAG_EAP_FAIL;
56 flag = CTX_FLAG_EAP_RESP;
59 flag = CTX_FLAG_EAP_NO_RESP;
62 flag = CTX_FLAG_EAP_REQ;
64 case EAPOL_portEnabled:
65 flag = CTX_FLAG_EAP_PORT_ENABLED;
68 flag = CTX_FLAG_EAP_ALT_ACCEPT;
71 flag = CTX_FLAG_EAP_ALT_REJECT;
78 static struct eap_peer_config *
79 peerGetConfig(void *ctx)
81 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
83 return &gssCtx->initiatorCtx.eapPeerConfig;
87 peerGetBool(void *data, enum eapol_bool_var variable)
89 gss_ctx_id_t ctx = data;
92 if (ctx == GSS_C_NO_CONTEXT)
95 flag = policyVariableToFlag(variable);
97 return ((ctx->flags & flag) != 0);
101 peerSetBool(void *data, enum eapol_bool_var variable,
104 gss_ctx_id_t ctx = data;
107 if (ctx == GSS_C_NO_CONTEXT)
110 flag = policyVariableToFlag(variable);
115 ctx->flags &= ~(flag);
119 peerGetInt(void *data, enum eapol_int_var variable)
121 gss_ctx_id_t ctx = data;
123 if (ctx == GSS_C_NO_CONTEXT)
126 assert(CTX_IS_INITIATOR(ctx));
129 case EAPOL_idleWhile:
130 return ctx->initiatorCtx.idleWhile;
138 peerSetInt(void *data, enum eapol_int_var variable,
141 gss_ctx_id_t ctx = data;
143 if (ctx == GSS_C_NO_CONTEXT)
146 assert(CTX_IS_INITIATOR(ctx));
149 case EAPOL_idleWhile:
150 ctx->initiatorCtx.idleWhile = value;
155 static struct wpabuf *
156 peerGetEapReqData(void *ctx)
158 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
160 return &gssCtx->initiatorCtx.reqData;
164 peerSetConfigBlob(void *ctx, struct wpa_config_blob *blob)
168 static const struct wpa_config_blob *
169 peerGetConfigBlob(void *ctx, const char *name)
175 peerNotifyPending(void *ctx)
179 static struct eapol_callbacks gssEapPolicyCallbacks = {
192 extern int wpa_debug_level;
196 peerConfigInit(OM_uint32 *minor,
200 krb5_context krbContext;
201 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
202 krb5_error_code code;
203 char *identity, *anonymousIdentity;
205 eapPeerConfig->identity = NULL;
206 eapPeerConfig->identity_len = 0;
207 eapPeerConfig->password = NULL;
208 eapPeerConfig->password_len = 0;
210 assert(cred != GSS_C_NO_CREDENTIAL);
212 GSSEAP_KRB_INIT(&krbContext);
214 eapPeerConfig->fragment_size = 1024;
219 assert(cred->name != GSS_C_NO_NAME);
221 if ((cred->name->flags & (NAME_FLAG_NAI | NAME_FLAG_SERVICE)) == 0) {
222 *minor = GSSEAP_BAD_INITIATOR_NAME;
223 return GSS_S_BAD_NAME;
226 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
229 return GSS_S_FAILURE;
232 anonymousIdentity = strchr(identity, '@');
233 if (anonymousIdentity == NULL)
234 anonymousIdentity = "";
236 eapPeerConfig->identity = (unsigned char *)identity;
237 eapPeerConfig->identity_len = strlen(identity);
238 eapPeerConfig->anonymous_identity = (unsigned char *)anonymousIdentity;
239 eapPeerConfig->anonymous_identity_len = strlen(anonymousIdentity);
240 eapPeerConfig->password = (unsigned char *)cred->password.value;
241 eapPeerConfig->password_len = cred->password.length;
244 return GSS_S_COMPLETE;
248 peerConfigFree(OM_uint32 *minor,
251 krb5_context krbContext;
252 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
254 GSSEAP_KRB_INIT(&krbContext);
256 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
259 return GSS_S_COMPLETE;
263 * Mark an initiator context as ready for cryptographic operations
266 initReady(OM_uint32 *minor, gss_ctx_id_t ctx, OM_uint32 reqFlags)
269 const unsigned char *key;
273 /* XXX actually check for mutual auth */
274 if (reqFlags & GSS_C_MUTUAL_FLAG)
275 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
278 /* Cache encryption type derived from selected mechanism OID */
279 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &ctx->encryptionType);
280 if (GSS_ERROR(major))
283 if (!eap_key_available(ctx->initiatorCtx.eap)) {
284 *minor = GSSEAP_KEY_UNAVAILABLE;
285 return GSS_S_UNAVAILABLE;
288 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
290 if (keyLength < EAP_EMSK_LEN) {
291 *minor = GSSEAP_KEY_TOO_SHORT;
292 return GSS_S_UNAVAILABLE;
295 major = gssEapDeriveRfc3961Key(minor,
296 &key[EAP_EMSK_LEN / 2],
300 if (GSS_ERROR(major))
303 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
305 if (GSS_ERROR(major))
308 major = sequenceInit(minor,
311 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
312 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
314 if (GSS_ERROR(major))
318 return GSS_S_COMPLETE;
322 initBegin(OM_uint32 *minor,
329 gss_channel_bindings_t chanBindings,
330 gss_buffer_t inputToken)
334 assert(cred != GSS_C_NO_CREDENTIAL);
336 if (cred->expiryTime)
337 ctx->expiryTime = cred->expiryTime;
338 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
341 ctx->expiryTime = time(NULL) + timeReq;
344 * The credential mutex protects its name, however we need to
345 * explicitly lock the acceptor name (unlikely as it may be
346 * that it has attributes set on it).
348 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
349 if (GSS_ERROR(major))
352 GSSEAP_MUTEX_LOCK(&target->mutex);
354 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
355 if (GSS_ERROR(major)) {
356 GSSEAP_MUTEX_UNLOCK(&target->mutex);
360 GSSEAP_MUTEX_UNLOCK(&target->mutex);
362 if (mech == GSS_C_NULL_OID) {
363 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
364 } else if (gssEapIsConcreteMechanismOid(mech)) {
365 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
366 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
368 major = GSS_S_BAD_MECH;
369 *minor = GSSEAP_WRONG_MECH;
371 if (GSS_ERROR(major))
374 /* If credentials were provided, check they're usable with this mech */
375 if (!gssEapCredAvailable(cred, ctx->mechanismUsed)) {
376 *minor = GSSEAP_CRED_MECH_MISMATCH;
377 return GSS_S_BAD_MECH;
381 return GSS_S_COMPLETE;
385 eapGssSmInitError(OM_uint32 *minor,
392 gss_channel_bindings_t chanBindings,
393 gss_buffer_t inputToken,
394 gss_buffer_t outputToken,
400 if (inputToken->length < 8) {
401 *minor = GSSEAP_TOK_TRUNC;
402 return GSS_S_DEFECTIVE_TOKEN;
405 p = (unsigned char *)inputToken->value;
407 major = load_uint32_be(&p[0]);
408 *minor = ERROR_TABLE_BASE_eapg + load_uint32_be(&p[4]);
410 if (!GSS_ERROR(major) || !IS_WIRE_ERROR(*minor)) {
411 major = GSS_S_FAILURE;
412 *minor = GSSEAP_BAD_ERROR_TOKEN;
415 assert(GSS_ERROR(major));
420 #ifdef GSSEAP_ENABLE_REAUTH
422 eapGssSmInitGssReauth(OM_uint32 *minor,
429 gss_channel_bindings_t chanBindings,
430 gss_buffer_t inputToken,
431 gss_buffer_t outputToken,
434 OM_uint32 major, tmpMinor;
435 gss_name_t mechTarget = GSS_C_NO_NAME;
436 gss_OID actualMech = GSS_C_NO_OID;
437 OM_uint32 gssFlags, timeRec;
439 assert(cred != GSS_C_NO_CREDENTIAL);
441 if (ctx->state == GSSEAP_STATE_INITIAL) {
442 if (!gssEapCanReauthP(cred, target, timeReq))
443 return GSS_S_CONTINUE_NEEDED;
445 major = initBegin(minor, cred, ctx, target, mech,
446 reqFlags, timeReq, chanBindings,
448 if (GSS_ERROR(major))
451 ctx->flags |= CTX_FLAG_KRB_REAUTH;
452 } else if ((ctx->flags & CTX_FLAG_KRB_REAUTH) == 0) {
453 major = GSS_S_DEFECTIVE_TOKEN;
454 *minor = GSSEAP_WRONG_ITOK;
458 major = gssEapMechToGlueName(minor, target, &mechTarget);
459 if (GSS_ERROR(major))
462 major = gssInitSecContext(minor,
466 (gss_OID)gss_mech_krb5,
475 if (GSS_ERROR(major))
478 ctx->gssFlags = gssFlags;
480 if (major == GSS_S_COMPLETE) {
481 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
482 if (GSS_ERROR(major))
484 ctx->state = GSSEAP_STATE_ACCEPTOR_EXTS;
487 *smFlags |= SM_FLAG_TRANSITION | SM_FLAG_STOP_EVAL;
490 gssReleaseName(&tmpMinor, &mechTarget);
494 #endif /* GSSEAP_ENABLE_REAUTH */
498 eapGssSmInitVendorInfo(OM_uint32 *minor,
505 gss_channel_bindings_t chanBindings,
506 gss_buffer_t inputToken,
507 gss_buffer_t outputToken,
512 major = makeStringBuffer(minor, "JANET(UK)", outputToken);
513 if (GSS_ERROR(major))
516 return GSS_S_CONTINUE_NEEDED;
521 eapGssSmInitIdentity(OM_uint32 *minor,
528 gss_channel_bindings_t chanBindings,
529 gss_buffer_t inputToken,
530 gss_buffer_t outputToken,
534 struct eap_config eapConfig;
536 assert((ctx->flags & CTX_FLAG_KRB_REAUTH) == 0);
537 assert(inputToken == GSS_C_NO_BUFFER);
539 major = initBegin(minor, cred, ctx, target, mech,
540 reqFlags, timeReq, chanBindings,
542 if (GSS_ERROR(major))
545 memset(&eapConfig, 0, sizeof(eapConfig));
547 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
548 &gssEapPolicyCallbacks,
551 if (ctx->initiatorCtx.eap == NULL) {
552 *minor = GSSEAP_PEER_SM_INIT_FAILURE;
553 return GSS_S_FAILURE;
556 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
558 /* poke EAP state machine */
559 if (eap_peer_sm_step(ctx->initiatorCtx.eap) != 0) {
560 *minor = GSSEAP_PEER_SM_STEP_FAILURE;
561 return GSS_S_FAILURE;
564 /* force sending of empty token */
566 *smFlags |= SM_FLAG_TRANSITION | SM_FLAG_FORCE_SEND_TOKEN;
568 return GSS_S_CONTINUE_NEEDED;
572 eapGssSmInitAuthenticate(OM_uint32 *minor,
579 gss_channel_bindings_t chanBindings,
580 gss_buffer_t inputToken,
581 gss_buffer_t outputToken,
587 struct wpabuf *resp = NULL;
591 assert(inputToken != GSS_C_NO_BUFFER);
593 major = peerConfigInit(minor, cred, ctx);
594 if (GSS_ERROR(major))
597 assert(ctx->initiatorCtx.eap != NULL);
598 assert(ctx->flags & CTX_FLAG_EAP_PORT_ENABLED);
600 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
602 wpabuf_set(&ctx->initiatorCtx.reqData,
603 inputToken->value, inputToken->length);
605 major = GSS_S_CONTINUE_NEEDED;
607 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
608 if (ctx->flags & CTX_FLAG_EAP_RESP) {
609 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
611 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
612 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
613 major = initReady(minor, ctx, reqFlags);
614 if (GSS_ERROR(major))
617 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
618 major = GSS_S_CONTINUE_NEEDED;
619 *smFlags |= SM_FLAG_TRANSITION;
620 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
621 major = GSS_S_DEFECTIVE_CREDENTIAL;
622 *minor = GSSEAP_PEER_AUTH_FAILURE;
624 major = GSS_S_DEFECTIVE_TOKEN;
625 *minor = GSSEAP_PEER_BAD_MESSAGE;
631 gss_buffer_desc respBuf;
633 assert(major == GSS_S_CONTINUE_NEEDED);
635 respBuf.length = wpabuf_len(resp);
636 respBuf.value = (void *)wpabuf_head(resp);
638 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
639 if (GSS_ERROR(tmpMajor)) {
645 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
646 peerConfigFree(&tmpMinor, ctx);
652 eapGssSmInitGssChannelBindings(OM_uint32 *minor,
659 gss_channel_bindings_t chanBindings,
660 gss_buffer_t inputToken,
661 gss_buffer_t outputToken,
665 gss_buffer_desc buffer = GSS_C_EMPTY_BUFFER;
667 if (chanBindings != GSS_C_NO_CHANNEL_BINDINGS)
668 buffer = chanBindings->application_data;
670 major = gssEapWrap(minor, ctx, TRUE, GSS_C_QOP_DEFAULT,
671 &buffer, NULL, outputToken);
672 if (GSS_ERROR(major))
675 assert(outputToken->value != NULL);
678 return GSS_S_CONTINUE_NEEDED;
681 #ifdef GSSEAP_ENABLE_REAUTH
683 eapGssSmInitReauthCreds(OM_uint32 *minor,
690 gss_channel_bindings_t chanBindings,
691 gss_buffer_t inputToken,
692 gss_buffer_t outputToken,
697 major = gssEapStoreReauthCreds(minor, ctx, cred, inputToken);
698 if (GSS_ERROR(major))
702 return GSS_S_CONTINUE_NEEDED;
704 #endif /* GSSEAP_ENABLE_REAUTH */
707 eapGssSmInitCompleteAcceptorExts(OM_uint32 *minor,
714 gss_channel_bindings_t chanBindings,
715 gss_buffer_t inputToken,
716 gss_buffer_t outputToken,
720 *smFlags |= SM_FLAG_TRANSITION | SM_FLAG_STOP_EVAL;
721 return GSS_S_COMPLETE;
725 eapGssSmInitCompleteInitiatorExts(OM_uint32 *minor,
732 gss_channel_bindings_t chanBindings,
733 gss_buffer_t inputToken,
734 gss_buffer_t outputToken,
738 *smFlags |= SM_FLAG_TRANSITION | SM_FLAG_STOP_EVAL;
739 return GSS_S_CONTINUE_NEEDED;
741 static struct gss_eap_sm eapGssInitiatorSm[] = {
743 ITOK_TYPE_CONTEXT_ERR,
745 GSSEAP_STATE_ALL & ~(GSSEAP_STATE_INITIAL),
750 #ifdef GSSEAP_ENABLE_REAUTH
752 ITOK_TYPE_REAUTH_RESP,
753 ITOK_TYPE_REAUTH_REQ,
754 GSSEAP_STATE_INITIAL | GSSEAP_STATE_AUTHENTICATE,
757 eapGssSmInitGssReauth,
763 ITOK_TYPE_VENDOR_INFO,
764 GSSEAP_STATE_INITIAL,
767 eapGssSmInitVendorInfo,
773 GSSEAP_STATE_INITIAL,
776 eapGssSmInitIdentity,
781 GSSEAP_STATE_AUTHENTICATE,
784 eapGssSmInitAuthenticate,
788 ITOK_TYPE_GSS_CHANNEL_BINDINGS,
789 GSSEAP_STATE_INITIATOR_EXTS,
792 eapGssSmInitGssChannelBindings,
797 GSSEAP_STATE_INITIATOR_EXTS,
800 eapGssSmInitCompleteInitiatorExts
802 #ifdef GSSEAP_ENABLE_REAUTH
804 ITOK_TYPE_REAUTH_CREDS,
806 GSSEAP_STATE_ACCEPTOR_EXTS,
809 eapGssSmInitReauthCreds,
812 /* other extensions go here */
816 GSSEAP_STATE_ACCEPTOR_EXTS,
819 eapGssSmInitCompleteAcceptorExts
824 gss_init_sec_context(OM_uint32 *minor,
826 gss_ctx_id_t *context_handle,
827 gss_name_t target_name,
831 gss_channel_bindings_t input_chan_bindings,
832 gss_buffer_t input_token,
833 gss_OID *actual_mech_type,
834 gss_buffer_t output_token,
835 OM_uint32 *ret_flags,
838 OM_uint32 major, tmpMinor;
839 gss_ctx_id_t ctx = *context_handle;
843 output_token->length = 0;
844 output_token->value = NULL;
846 if (ctx == GSS_C_NO_CONTEXT) {
847 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
848 *minor = GSSEAP_WRONG_SIZE;
849 return GSS_S_DEFECTIVE_TOKEN;
852 major = gssEapAllocContext(minor, &ctx);
853 if (GSS_ERROR(major))
856 ctx->flags |= CTX_FLAG_INITIATOR;
858 *context_handle = ctx;
861 GSSEAP_MUTEX_LOCK(&ctx->mutex);
863 if (cred == GSS_C_NO_CREDENTIAL) {
864 if (ctx->defaultCred == GSS_C_NO_CREDENTIAL) {
865 major = gssEapAcquireCred(minor,
874 if (GSS_ERROR(major))
878 cred = ctx->defaultCred;
881 GSSEAP_MUTEX_LOCK(&cred->mutex);
884 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
885 major = GSS_S_NO_CRED;
886 *minor = GSSEAP_CRED_USAGE_MISMATCH;
890 major = gssEapSmStep(minor,
901 sizeof(eapGssInitiatorSm) / sizeof(eapGssInitiatorSm[0]));
902 if (GSS_ERROR(major))
905 if (actual_mech_type != NULL) {
906 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
907 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
909 if (ret_flags != NULL)
910 *ret_flags = ctx->gssFlags;
911 if (time_rec != NULL)
912 gssEapContextTime(&tmpMinor, ctx, time_rec);
914 assert(ctx->state == GSSEAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
917 if (cred != GSS_C_NO_CREDENTIAL)
918 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
919 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
921 if (GSS_ERROR(major))
922 gssEapReleaseContext(&tmpMinor, context_handle);