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 eapGssSmInitGssReauth(OM_uint32 *minor,
44 gss_channel_bindings_t chanBindings,
45 gss_buffer_t inputToken,
46 gss_buffer_t outputToken);
50 policyVariableToFlag(enum eapol_bool_var variable)
55 case EAPOL_eapSuccess:
56 flag = CTX_FLAG_EAP_SUCCESS;
58 case EAPOL_eapRestart:
59 flag = CTX_FLAG_EAP_RESTART;
62 flag = CTX_FLAG_EAP_FAIL;
65 flag = CTX_FLAG_EAP_RESP;
68 flag = CTX_FLAG_EAP_NO_RESP;
71 flag = CTX_FLAG_EAP_REQ;
73 case EAPOL_portEnabled:
74 flag = CTX_FLAG_EAP_PORT_ENABLED;
77 flag = CTX_FLAG_EAP_ALT_ACCEPT;
80 flag = CTX_FLAG_EAP_ALT_REJECT;
87 static struct eap_peer_config *
88 peerGetConfig(void *ctx)
90 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
92 return &gssCtx->initiatorCtx.eapPeerConfig;
96 peerGetBool(void *data, enum eapol_bool_var variable)
98 gss_ctx_id_t ctx = data;
101 if (ctx == GSS_C_NO_CONTEXT)
104 flag = policyVariableToFlag(variable);
106 return ((ctx->flags & flag) != 0);
110 peerSetBool(void *data, enum eapol_bool_var variable,
113 gss_ctx_id_t ctx = data;
116 if (ctx == GSS_C_NO_CONTEXT)
119 flag = policyVariableToFlag(variable);
124 ctx->flags &= ~(flag);
128 peerGetInt(void *data, enum eapol_int_var variable)
130 gss_ctx_id_t ctx = data;
132 if (ctx == GSS_C_NO_CONTEXT)
135 assert(CTX_IS_INITIATOR(ctx));
138 case EAPOL_idleWhile:
139 return ctx->initiatorCtx.idleWhile;
147 peerSetInt(void *data, enum eapol_int_var variable,
150 gss_ctx_id_t ctx = data;
152 if (ctx == GSS_C_NO_CONTEXT)
155 assert(CTX_IS_INITIATOR(ctx));
158 case EAPOL_idleWhile:
159 ctx->initiatorCtx.idleWhile = value;
164 static struct wpabuf *
165 peerGetEapReqData(void *ctx)
167 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
169 return &gssCtx->initiatorCtx.reqData;
173 peerSetConfigBlob(void *ctx, struct wpa_config_blob *blob)
177 static const struct wpa_config_blob *
178 peerGetConfigBlob(void *ctx, const char *name)
184 peerNotifyPending(void *ctx)
188 static struct eapol_callbacks gssEapPolicyCallbacks = {
200 extern int wpa_debug_level;
203 peerConfigInit(OM_uint32 *minor,
207 krb5_context krbContext;
208 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
209 krb5_error_code code;
212 eapPeerConfig->identity = NULL;
213 eapPeerConfig->identity_len = 0;
214 eapPeerConfig->password = NULL;
215 eapPeerConfig->password_len = 0;
217 assert(cred != GSS_C_NO_CREDENTIAL);
219 GSSEAP_KRB_INIT(&krbContext);
221 eapPeerConfig->fragment_size = 1024;
224 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
227 return GSS_S_FAILURE;
230 eapPeerConfig->identity = (unsigned char *)identity;
231 eapPeerConfig->identity_len = strlen(identity);
232 eapPeerConfig->password = (unsigned char *)cred->password.value;
233 eapPeerConfig->password_len = cred->password.length;
235 return GSS_S_COMPLETE;
239 peerConfigFree(OM_uint32 *minor,
242 krb5_context krbContext;
243 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
245 GSSEAP_KRB_INIT(&krbContext);
247 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
249 return GSS_S_COMPLETE;
253 initReady(OM_uint32 *minor, gss_ctx_id_t ctx, OM_uint32 reqFlags)
256 const unsigned char *key;
258 krb5_enctype encryptionType;
262 /* XXX actually check for mutual auth */
263 if (reqFlags & GSS_C_MUTUAL_FLAG)
264 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
267 /* Cache encryption type derived from selected mechanism OID */
268 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &encryptionType);
269 if (GSS_ERROR(major))
272 if (encryptionType != ENCTYPE_NULL &&
273 eap_key_available(ctx->initiatorCtx.eap)) {
274 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
276 if (keyLength >= EAP_EMSK_LEN) {
277 major = gssEapDeriveRfc3961Key(minor,
278 &key[EAP_EMSK_LEN / 2],
282 if (GSS_ERROR(major))
285 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
287 if (GSS_ERROR(major))
294 ctx->encryptionType = encryptionType;
297 * draft-howlett-eap-gss says that integrity/confidentialty should
298 * always be advertised as available, but if we have no keying
299 * material it seems confusing to the caller to advertise this.
301 ctx->gssFlags &= ~(GSS_C_INTEG_FLAG | GSS_C_CONF_FLAG);
304 major = sequenceInit(minor,
307 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
308 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
310 if (GSS_ERROR(major))
313 return GSS_S_COMPLETE;
317 initBegin(OM_uint32 *minor,
324 gss_channel_bindings_t chanBindings,
325 gss_buffer_t inputToken,
326 gss_buffer_t outputToken)
330 assert(cred != GSS_C_NO_CREDENTIAL);
332 if (cred->expiryTime)
333 ctx->expiryTime = cred->expiryTime;
334 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
337 ctx->expiryTime = time(NULL) + timeReq;
340 * The credential mutex protects its name, however we need to
341 * explicitly lock the acceptor name (unlikely as it may be
342 * that it has attributes set on it).
344 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
345 if (GSS_ERROR(major))
348 GSSEAP_MUTEX_LOCK(&target->mutex);
350 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
351 if (GSS_ERROR(major)) {
352 GSSEAP_MUTEX_UNLOCK(&target->mutex);
356 GSSEAP_MUTEX_UNLOCK(&target->mutex);
358 if (mech == GSS_C_NULL_OID) {
359 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
360 } else if (gssEapIsConcreteMechanismOid(mech)) {
361 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
362 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
364 major = GSS_S_BAD_MECH;
366 if (GSS_ERROR(major))
369 /* If credentials were provided, check they're usable with this mech */
370 if (!gssEapCredAvailable(cred, ctx->mechanismUsed))
371 return GSS_S_BAD_MECH;
373 return GSS_S_COMPLETE;
377 eapGssSmInitIdentity(OM_uint32 *minor,
384 gss_channel_bindings_t chanBindings,
385 gss_buffer_t inputToken,
386 gss_buffer_t outputToken)
389 int initialContextToken;
391 initialContextToken = (inputToken->length == 0);
392 if (!initialContextToken)
393 return GSS_S_DEFECTIVE_TOKEN;
395 major = initBegin(minor, cred, ctx, target, mech,
396 reqFlags, timeReq, chanBindings,
397 inputToken, outputToken);
398 if (GSS_ERROR(major))
401 ctx->state = EAP_STATE_AUTHENTICATE;
403 return GSS_S_CONTINUE_NEEDED;
406 static struct wpabuf emptyWpaBuffer;
409 eapGssSmInitAuthenticate(OM_uint32 *minor,
416 gss_channel_bindings_t chanBindings,
417 gss_buffer_t inputToken,
418 gss_buffer_t outputToken)
423 struct wpabuf *resp = NULL;
424 int initialContextToken;
426 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
427 inputToken->length == 0);
429 major = peerConfigInit(minor, cred, ctx);
430 if (GSS_ERROR(major))
433 if (ctx->initiatorCtx.eap == NULL) {
434 struct eap_config eapConfig;
436 memset(&eapConfig, 0, sizeof(eapConfig));
438 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
439 &gssEapPolicyCallbacks,
442 if (ctx->initiatorCtx.eap == NULL) {
443 major = GSS_S_FAILURE;
447 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
450 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
452 wpabuf_set(&ctx->initiatorCtx.reqData,
453 inputToken->value, inputToken->length);
455 major = GSS_S_CONTINUE_NEEDED;
457 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
458 if (ctx->flags & CTX_FLAG_EAP_RESP) {
459 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
461 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
462 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
463 major = initReady(minor, ctx, reqFlags);
464 if (GSS_ERROR(major))
467 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
468 major = GSS_S_CONTINUE_NEEDED;
469 ctx->state = EAP_STATE_EXTENSIONS_REQ;
470 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
471 major = GSS_S_DEFECTIVE_CREDENTIAL;
472 } else if (code == 0 && initialContextToken) {
473 resp = &emptyWpaBuffer;
474 major = GSS_S_CONTINUE_NEEDED;
476 major = GSS_S_DEFECTIVE_TOKEN;
482 gss_buffer_desc respBuf;
484 assert(major == GSS_S_CONTINUE_NEEDED);
486 respBuf.length = wpabuf_len(resp);
487 respBuf.value = (void *)wpabuf_head(resp);
489 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
490 if (GSS_ERROR(tmpMajor)) {
496 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
497 peerConfigFree(&tmpMinor, ctx);
503 initGssChannelBindings(OM_uint32 *minor,
505 gss_channel_bindings_t chanBindings,
506 gss_buffer_t outputToken)
509 gss_buffer_desc buffer = GSS_C_EMPTY_BUFFER;
512 if (chanBindings != GSS_C_NO_CHANNEL_BINDINGS)
513 buffer = chanBindings->application_data;
515 major = gssEapWrap(minor, ctx, TRUE, GSS_C_QOP_DEFAULT,
516 &buffer, NULL, outputToken);
517 if (GSS_ERROR(major))
520 return GSS_S_CONTINUE_NEEDED;
524 eapGssSmInitExtensionsReq(OM_uint32 *minor,
531 gss_channel_bindings_t chanBindings,
532 gss_buffer_t inputToken,
533 gss_buffer_t outputToken)
535 OM_uint32 major, tmpMinor;
536 gss_buffer_desc cbToken = GSS_C_EMPTY_BUFFER;
538 major = initGssChannelBindings(minor, ctx, chanBindings, &cbToken);
539 if (GSS_ERROR(major))
542 ctx->state = EAP_STATE_EXTENSIONS_RESP;
544 major = duplicateBuffer(minor, &cbToken, outputToken);
545 if (GSS_ERROR(major)) {
546 gss_release_buffer(&tmpMinor, &cbToken);
550 gss_release_buffer(&tmpMinor, &cbToken);
552 return GSS_S_CONTINUE_NEEDED;
556 eapGssSmInitExtensionsResp(OM_uint32 *minor,
563 gss_channel_bindings_t chanBindings,
564 gss_buffer_t inputToken,
565 gss_buffer_t outputToken)
567 #ifdef GSSEAP_ENABLE_REAUTH
570 major = gssEapStoreReauthCreds(minor, ctx, cred, inputToken);
571 if (GSS_ERROR(major))
575 ctx->state = EAP_STATE_ESTABLISHED;
577 return GSS_S_COMPLETE;
581 eapGssSmInitEstablished(OM_uint32 *minor,
588 gss_channel_bindings_t chanBindings,
589 gss_buffer_t inputToken,
590 gss_buffer_t outputToken)
592 /* Called with already established context */
594 return GSS_S_BAD_STATUS;
597 static struct gss_eap_initiator_sm {
598 enum gss_eap_token_type inputTokenType;
599 enum gss_eap_token_type outputTokenType;
600 OM_uint32 (*processToken)(OM_uint32 *,
607 gss_channel_bindings_t,
610 } eapGssInitiatorSm[] = {
611 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
612 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
613 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
614 { TOK_TYPE_EXT_RESP,TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
615 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
616 #ifdef GSSEAP_ENABLE_REAUTH
617 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
622 gss_init_sec_context(OM_uint32 *minor,
624 gss_ctx_id_t *context_handle,
625 gss_name_t target_name,
629 gss_channel_bindings_t input_chan_bindings,
630 gss_buffer_t input_token,
631 gss_OID *actual_mech_type,
632 gss_buffer_t output_token,
633 OM_uint32 *ret_flags,
637 OM_uint32 tmpMajor, tmpMinor;
638 gss_ctx_id_t ctx = *context_handle;
639 struct gss_eap_initiator_sm *sm = NULL;
640 gss_buffer_desc innerInputToken;
641 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
642 enum gss_eap_token_type tokType;
643 gss_cred_id_t defaultCred = GSS_C_NO_CREDENTIAL;
644 int initialContextToken = 0;
648 output_token->length = 0;
649 output_token->value = NULL;
651 if (ctx == GSS_C_NO_CONTEXT) {
652 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
653 return GSS_S_DEFECTIVE_TOKEN;
656 major = gssEapAllocContext(minor, &ctx);
657 if (GSS_ERROR(major))
660 ctx->flags |= CTX_FLAG_INITIATOR;
662 initialContextToken = 1;
663 *context_handle = ctx;
666 GSSEAP_MUTEX_LOCK(&ctx->mutex);
668 if (cred == GSS_C_NO_CREDENTIAL) {
669 if (ctx->initiatorCtx.defaultCred == GSS_C_NO_CREDENTIAL) {
670 major = gssEapAcquireCred(minor,
679 if (GSS_ERROR(major))
683 cred = ctx->initiatorCtx.defaultCred;
686 GSSEAP_MUTEX_LOCK(&cred->mutex);
688 #ifdef GSSEAP_ENABLE_REAUTH
689 if (initialContextToken && gssEapCanReauthP(cred, target_name, time_req))
690 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
693 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
694 major = GSS_S_NO_CRED;
698 sm = &eapGssInitiatorSm[ctx->state];
700 if (input_token != GSS_C_NO_BUFFER) {
701 major = gssEapVerifyToken(minor, ctx, input_token,
702 &tokType, &innerInputToken);
703 if (GSS_ERROR(major))
706 if (tokType != sm->inputTokenType) {
707 major = GSS_S_DEFECTIVE_TOKEN;
711 innerInputToken.length = 0;
712 innerInputToken.value = NULL;
716 * Advance through state machine whilst empty tokens are emitted and
717 * the status is not GSS_S_COMPLETE or an error status.
720 sm = &eapGssInitiatorSm[ctx->state];
722 major = (sm->processToken)(minor,
732 if (GSS_ERROR(major))
734 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
736 if (actual_mech_type != NULL) {
737 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
738 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
740 if (innerOutputToken.value != NULL) {
741 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
742 sm->outputTokenType, output_token);
743 if (GSS_ERROR(tmpMajor)) {
749 if (ret_flags != NULL)
750 *ret_flags = ctx->gssFlags;
751 if (time_rec != NULL)
752 gssEapContextTime(&tmpMinor, ctx, time_rec);
754 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
757 if (cred != GSS_C_NO_CREDENTIAL)
758 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
759 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
761 if (GSS_ERROR(major))
762 gssEapReleaseContext(&tmpMinor, context_handle);
764 gss_release_buffer(&tmpMinor, &innerOutputToken);
769 #ifdef GSSEAP_ENABLE_REAUTH
771 eapGssSmInitGssReauth(OM_uint32 *minor,
778 gss_channel_bindings_t chanBindings,
779 gss_buffer_t inputToken,
780 gss_buffer_t outputToken)
782 OM_uint32 major, tmpMinor;
783 gss_name_t mechTarget = GSS_C_NO_NAME;
784 gss_OID actualMech = GSS_C_NO_OID;
785 OM_uint32 gssFlags, timeRec;
787 assert(cred != GSS_C_NO_CREDENTIAL);
789 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
791 if (inputToken->length == 0) {
792 major = initBegin(minor, cred, ctx, target, mech,
793 reqFlags, timeReq, chanBindings,
794 inputToken, outputToken);
795 if (GSS_ERROR(major))
799 major = gssEapMechToGlueName(minor, target, &mechTarget);
800 if (GSS_ERROR(major))
803 major = gssInitSecContext(minor,
807 (gss_OID)gss_mech_krb5,
808 reqFlags, /* | GSS_C_DCE_STYLE, */
816 if (GSS_ERROR(major))
819 ctx->gssFlags = gssFlags;
821 if (major == GSS_S_COMPLETE) {
822 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
823 if (GSS_ERROR(major))
825 ctx->state = EAP_STATE_ESTABLISHED;
829 gssReleaseName(&tmpMinor, &mechTarget);
833 #endif /* GSSEAP_ENABLE_REAUTH */