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 *smFlags |= SM_FLAG_STOP_EVAL;
482 if (major == GSS_S_COMPLETE) {
483 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
484 if (GSS_ERROR(major))
486 ctx->state = GSSEAP_STATE_ESTABLISHED;
488 ctx->state = GSSEAP_STATE_REAUTHENTICATE;
492 gssReleaseName(&tmpMinor, &mechTarget);
496 #endif /* GSSEAP_ENABLE_REAUTH */
500 eapGssSmInitVendorInfo(OM_uint32 *minor,
507 gss_channel_bindings_t chanBindings,
508 gss_buffer_t inputToken,
509 gss_buffer_t outputToken,
514 major = makeStringBuffer(minor, "JANET(UK)", outputToken);
515 if (GSS_ERROR(major))
518 return GSS_S_CONTINUE_NEEDED;
523 eapGssSmInitIdentity(OM_uint32 *minor,
530 gss_channel_bindings_t chanBindings,
531 gss_buffer_t inputToken,
532 gss_buffer_t outputToken,
536 struct eap_config eapConfig;
538 assert((ctx->flags & CTX_FLAG_KRB_REAUTH) == 0);
539 assert(inputToken == GSS_C_NO_BUFFER);
541 major = initBegin(minor, cred, ctx, target, mech,
542 reqFlags, timeReq, chanBindings,
544 if (GSS_ERROR(major))
547 memset(&eapConfig, 0, sizeof(eapConfig));
549 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
550 &gssEapPolicyCallbacks,
553 if (ctx->initiatorCtx.eap == NULL) {
554 *minor = GSSEAP_PEER_SM_INIT_FAILURE;
555 return GSS_S_FAILURE;
558 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
560 /* poke EAP state machine */
561 if (eap_peer_sm_step(ctx->initiatorCtx.eap) != 0) {
562 *minor = GSSEAP_PEER_SM_STEP_FAILURE;
563 return GSS_S_FAILURE;
566 /* force sending of empty token */
568 *smFlags |= SM_FLAG_TRANSITION | SM_FLAG_FORCE_SEND_TOKEN;
570 return GSS_S_CONTINUE_NEEDED;
574 eapGssSmInitAuthenticate(OM_uint32 *minor,
581 gss_channel_bindings_t chanBindings,
582 gss_buffer_t inputToken,
583 gss_buffer_t outputToken,
589 struct wpabuf *resp = NULL;
593 assert(inputToken != GSS_C_NO_BUFFER);
595 major = peerConfigInit(minor, cred, ctx);
596 if (GSS_ERROR(major))
599 assert(ctx->initiatorCtx.eap != NULL);
600 assert(ctx->flags & CTX_FLAG_EAP_PORT_ENABLED);
602 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
604 wpabuf_set(&ctx->initiatorCtx.reqData,
605 inputToken->value, inputToken->length);
607 major = GSS_S_CONTINUE_NEEDED;
609 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
610 if (ctx->flags & CTX_FLAG_EAP_RESP) {
611 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
613 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
614 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
615 major = initReady(minor, ctx, reqFlags);
616 if (GSS_ERROR(major))
619 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
620 major = GSS_S_CONTINUE_NEEDED;
621 *smFlags |= SM_FLAG_TRANSITION;
622 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
623 major = GSS_S_DEFECTIVE_CREDENTIAL;
624 *minor = GSSEAP_PEER_AUTH_FAILURE;
626 major = GSS_S_DEFECTIVE_TOKEN;
627 *minor = GSSEAP_PEER_BAD_MESSAGE;
633 gss_buffer_desc respBuf;
635 assert(major == GSS_S_CONTINUE_NEEDED);
637 respBuf.length = wpabuf_len(resp);
638 respBuf.value = (void *)wpabuf_head(resp);
640 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
641 if (GSS_ERROR(tmpMajor)) {
647 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
648 peerConfigFree(&tmpMinor, ctx);
654 eapGssSmInitGssChannelBindings(OM_uint32 *minor,
661 gss_channel_bindings_t chanBindings,
662 gss_buffer_t inputToken,
663 gss_buffer_t outputToken,
667 gss_buffer_desc buffer = GSS_C_EMPTY_BUFFER;
669 if (chanBindings != GSS_C_NO_CHANNEL_BINDINGS)
670 buffer = chanBindings->application_data;
672 major = gssEapWrap(minor, ctx, TRUE, GSS_C_QOP_DEFAULT,
673 &buffer, NULL, outputToken);
674 if (GSS_ERROR(major))
677 assert(outputToken->value != NULL);
680 return GSS_S_CONTINUE_NEEDED;
683 #ifdef GSSEAP_ENABLE_REAUTH
685 eapGssSmInitReauthCreds(OM_uint32 *minor,
692 gss_channel_bindings_t chanBindings,
693 gss_buffer_t inputToken,
694 gss_buffer_t outputToken,
699 major = gssEapStoreReauthCreds(minor, ctx, cred, inputToken);
700 if (GSS_ERROR(major))
704 return GSS_S_CONTINUE_NEEDED;
706 #endif /* GSSEAP_ENABLE_REAUTH */
709 eapGssSmInitCompleteExts(OM_uint32 *minor,
716 gss_channel_bindings_t chanBindings,
717 gss_buffer_t inputToken,
718 gss_buffer_t outputToken,
723 if (ctx->state == GSSEAP_STATE_INITIATOR_EXTS) {
724 *smFlags |= SM_FLAG_TRANSITION | SM_FLAG_STOP_EVAL;
725 return GSS_S_CONTINUE_NEEDED;
727 ctx->state = GSSEAP_STATE_ESTABLISHED;
728 *smFlags |= SM_FLAG_STOP_EVAL;
729 return GSS_S_COMPLETE;
733 static struct gss_eap_sm eapGssInitiatorSm[] = {
735 ITOK_TYPE_CONTEXT_ERR,
737 GSSEAP_STATE_ALL & ~(GSSEAP_STATE_INITIAL),
738 SM_ITOK_FLAG_CRITICAL,
744 ITOK_TYPE_VENDOR_INFO,
745 GSSEAP_STATE_INITIAL,
747 eapGssSmInitVendorInfo,
750 #ifdef GSSEAP_ENABLE_REAUTH
752 ITOK_TYPE_REAUTH_RESP,
753 ITOK_TYPE_REAUTH_REQ,
754 GSSEAP_STATE_INITIAL | GSSEAP_STATE_REAUTHENTICATE,
756 eapGssSmInitGssReauth,
762 GSSEAP_STATE_INITIAL,
763 SM_ITOK_FLAG_CRITICAL | SM_ITOK_FLAG_REQUIRED,
764 eapGssSmInitIdentity,
769 GSSEAP_STATE_AUTHENTICATE,
770 SM_ITOK_FLAG_CRITICAL | SM_ITOK_FLAG_REQUIRED,
771 eapGssSmInitAuthenticate,
775 ITOK_TYPE_GSS_CHANNEL_BINDINGS,
776 GSSEAP_STATE_INITIATOR_EXTS,
777 SM_ITOK_FLAG_CRITICAL | SM_ITOK_FLAG_REQUIRED,
778 eapGssSmInitGssChannelBindings,
783 GSSEAP_STATE_INITIATOR_EXTS,
785 eapGssSmInitCompleteExts
787 #ifdef GSSEAP_ENABLE_REAUTH
789 ITOK_TYPE_REAUTH_CREDS,
791 GSSEAP_STATE_ACCEPTOR_EXTS,
793 eapGssSmInitReauthCreds,
796 /* other extensions go here */
800 GSSEAP_STATE_ACCEPTOR_EXTS,
802 eapGssSmInitCompleteExts
807 gss_init_sec_context(OM_uint32 *minor,
809 gss_ctx_id_t *context_handle,
810 gss_name_t target_name,
814 gss_channel_bindings_t input_chan_bindings,
815 gss_buffer_t input_token,
816 gss_OID *actual_mech_type,
817 gss_buffer_t output_token,
818 OM_uint32 *ret_flags,
821 OM_uint32 major, tmpMinor;
822 gss_ctx_id_t ctx = *context_handle;
826 output_token->length = 0;
827 output_token->value = NULL;
829 if (ctx == GSS_C_NO_CONTEXT) {
830 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
831 *minor = GSSEAP_WRONG_SIZE;
832 return GSS_S_DEFECTIVE_TOKEN;
835 major = gssEapAllocContext(minor, &ctx);
836 if (GSS_ERROR(major))
839 ctx->flags |= CTX_FLAG_INITIATOR;
841 *context_handle = ctx;
844 GSSEAP_MUTEX_LOCK(&ctx->mutex);
846 if (cred == GSS_C_NO_CREDENTIAL) {
847 if (ctx->defaultCred == GSS_C_NO_CREDENTIAL) {
848 major = gssEapAcquireCred(minor,
857 if (GSS_ERROR(major))
861 cred = ctx->defaultCred;
864 GSSEAP_MUTEX_LOCK(&cred->mutex);
867 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
868 major = GSS_S_NO_CRED;
869 *minor = GSSEAP_CRED_USAGE_MISMATCH;
873 major = gssEapSmStep(minor,
884 sizeof(eapGssInitiatorSm) / sizeof(eapGssInitiatorSm[0]));
885 if (GSS_ERROR(major))
888 if (actual_mech_type != NULL) {
889 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
890 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
892 if (ret_flags != NULL)
893 *ret_flags = ctx->gssFlags;
894 if (time_rec != NULL)
895 gssEapContextTime(&tmpMinor, ctx, time_rec);
897 assert(ctx->state == GSSEAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
900 if (cred != GSS_C_NO_CREDENTIAL)
901 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
902 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
904 if (GSS_ERROR(major))
905 gssEapReleaseContext(&tmpMinor, context_handle);