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;
260 /* XXX actually check for mutual auth */
261 if (reqFlags & GSS_C_MUTUAL_FLAG)
262 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
265 /* Cache encryption type derived from selected mechanism OID */
266 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &ctx->encryptionType);
267 if (GSS_ERROR(major))
270 if (!eap_key_available(ctx->initiatorCtx.eap)) {
271 *minor = GSSEAP_KEY_UNAVAILABLE;
272 return GSS_S_UNAVAILABLE;
275 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
277 if (keyLength < EAP_EMSK_LEN) {
278 *minor = GSSEAP_KEY_TOO_SHORT;
279 return GSS_S_UNAVAILABLE;
282 major = gssEapDeriveRfc3961Key(minor,
283 &key[EAP_EMSK_LEN / 2],
287 if (GSS_ERROR(major))
290 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
292 if (GSS_ERROR(major))
295 major = sequenceInit(minor,
298 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
299 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
301 if (GSS_ERROR(major))
305 return GSS_S_COMPLETE;
309 initBegin(OM_uint32 *minor,
316 gss_channel_bindings_t chanBindings,
317 gss_buffer_t inputToken,
318 gss_buffer_t outputToken)
322 assert(cred != GSS_C_NO_CREDENTIAL);
324 if (cred->expiryTime)
325 ctx->expiryTime = cred->expiryTime;
326 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
329 ctx->expiryTime = time(NULL) + timeReq;
332 * The credential mutex protects its name, however we need to
333 * explicitly lock the acceptor name (unlikely as it may be
334 * that it has attributes set on it).
336 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
337 if (GSS_ERROR(major))
340 GSSEAP_MUTEX_LOCK(&target->mutex);
342 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
343 if (GSS_ERROR(major)) {
344 GSSEAP_MUTEX_UNLOCK(&target->mutex);
348 GSSEAP_MUTEX_UNLOCK(&target->mutex);
350 if (mech == GSS_C_NULL_OID) {
351 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
352 } else if (gssEapIsConcreteMechanismOid(mech)) {
353 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
354 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
356 *minor = GSSEAP_WRONG_MECH;
357 major = GSS_S_BAD_MECH;
359 if (GSS_ERROR(major))
362 /* If credentials were provided, check they're usable with this mech */
363 if (!gssEapCredAvailable(cred, ctx->mechanismUsed))
364 return GSS_S_BAD_MECH;
366 return GSS_S_COMPLETE;
370 eapGssSmInitIdentity(OM_uint32 *minor,
377 gss_channel_bindings_t chanBindings,
378 gss_buffer_t inputToken,
379 gss_buffer_t outputToken)
382 int initialContextToken;
384 initialContextToken = (inputToken->length == 0);
385 if (!initialContextToken) {
386 *minor = GSSEAP_WRONG_SIZE;
387 return GSS_S_DEFECTIVE_TOKEN;
390 major = initBegin(minor, cred, ctx, target, mech,
391 reqFlags, timeReq, chanBindings,
392 inputToken, outputToken);
393 if (GSS_ERROR(major))
396 ctx->state = EAP_STATE_AUTHENTICATE;
398 return GSS_S_CONTINUE_NEEDED;
401 static struct wpabuf emptyWpaBuffer;
404 eapGssSmInitAuthenticate(OM_uint32 *minor,
411 gss_channel_bindings_t chanBindings,
412 gss_buffer_t inputToken,
413 gss_buffer_t outputToken)
418 struct wpabuf *resp = NULL;
419 int initialContextToken;
421 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
422 inputToken->length == 0);
424 major = peerConfigInit(minor, cred, ctx);
425 if (GSS_ERROR(major))
428 if (ctx->initiatorCtx.eap == NULL) {
429 struct eap_config eapConfig;
431 memset(&eapConfig, 0, sizeof(eapConfig));
433 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
434 &gssEapPolicyCallbacks,
437 if (ctx->initiatorCtx.eap == NULL) {
438 *minor = GSSEAP_PEER_INIT_FAILURE;
439 major = GSS_S_FAILURE;
443 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
446 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
448 wpabuf_set(&ctx->initiatorCtx.reqData,
449 inputToken->value, inputToken->length);
451 major = GSS_S_CONTINUE_NEEDED;
453 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
454 if (ctx->flags & CTX_FLAG_EAP_RESP) {
455 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
457 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
458 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
459 major = initReady(minor, ctx, reqFlags);
460 if (GSS_ERROR(major))
463 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
464 major = GSS_S_CONTINUE_NEEDED;
465 ctx->state = EAP_STATE_EXTENSIONS_REQ;
466 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
467 *minor = GSSEAP_PEER_AUTH_FAILURE;
468 major = GSS_S_DEFECTIVE_CREDENTIAL;
469 } else if (code == 0 && initialContextToken) {
470 resp = &emptyWpaBuffer;
471 major = GSS_S_CONTINUE_NEEDED;
473 *minor = GSSEAP_PEER_BAD_MESSAGE;
474 major = GSS_S_DEFECTIVE_TOKEN;
480 gss_buffer_desc respBuf;
482 assert(major == GSS_S_CONTINUE_NEEDED);
484 respBuf.length = wpabuf_len(resp);
485 respBuf.value = (void *)wpabuf_head(resp);
487 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
488 if (GSS_ERROR(tmpMajor)) {
494 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
495 peerConfigFree(&tmpMinor, ctx);
501 eapGssSmInitExtensionsReq(OM_uint32 *minor,
508 gss_channel_bindings_t chanBindings,
509 gss_buffer_t inputToken,
510 gss_buffer_t outputToken)
514 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
515 if (GSS_ERROR(major))
518 assert(outputToken->value != NULL);
520 ctx->state = EAP_STATE_EXTENSIONS_RESP;
522 return GSS_S_CONTINUE_NEEDED;
526 eapGssSmInitExtensionsResp(OM_uint32 *minor,
533 gss_channel_bindings_t chanBindings,
534 gss_buffer_t inputToken,
535 gss_buffer_t outputToken)
539 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
540 if (GSS_ERROR(major))
543 ctx->state = EAP_STATE_ESTABLISHED;
545 return GSS_S_COMPLETE;
549 eapGssSmInitEstablished(OM_uint32 *minor,
556 gss_channel_bindings_t chanBindings,
557 gss_buffer_t inputToken,
558 gss_buffer_t outputToken)
560 /* Called with already established context */
561 *minor = GSSEAP_CONTEXT_ESTABLISHED;
562 return GSS_S_BAD_STATUS;
566 eapGssSmInitError(OM_uint32 *minor,
573 gss_channel_bindings_t chanBindings,
574 gss_buffer_t inputToken,
575 gss_buffer_t outputToken)
580 if (inputToken->length < 8) {
581 *minor = GSSEAP_WRONG_SIZE;
582 return GSS_S_DEFECTIVE_TOKEN;
585 p = (unsigned char *)inputToken->value;
587 major = load_uint32_be(&p[0]);
588 *minor = ERROR_TABLE_BASE_eapg + load_uint32_be(&p[4]);
590 if (!GSS_ERROR(major)) {
591 *minor = GSSEAP_BAD_ERROR_TOKEN;
592 major = GSS_S_FAILURE;
598 static struct gss_eap_initiator_sm {
599 enum gss_eap_token_type inputTokenType;
600 enum gss_eap_token_type outputTokenType;
601 OM_uint32 (*processToken)(OM_uint32 *,
608 gss_channel_bindings_t,
611 } eapGssInitiatorSm[] = {
612 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
613 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
614 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
615 { TOK_TYPE_EXT_RESP, TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
616 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
617 { TOK_TYPE_CONTEXT_ERR, TOK_TYPE_NONE, eapGssSmInitError },
618 #ifdef GSSEAP_ENABLE_REAUTH
619 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
624 gss_init_sec_context(OM_uint32 *minor,
626 gss_ctx_id_t *context_handle,
627 gss_name_t target_name,
631 gss_channel_bindings_t input_chan_bindings,
632 gss_buffer_t input_token,
633 gss_OID *actual_mech_type,
634 gss_buffer_t output_token,
635 OM_uint32 *ret_flags,
639 OM_uint32 tmpMajor, tmpMinor;
640 gss_ctx_id_t ctx = *context_handle;
641 struct gss_eap_initiator_sm *sm = NULL;
642 gss_buffer_desc innerInputToken;
643 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
644 enum gss_eap_token_type tokType;
645 gss_cred_id_t defaultCred = GSS_C_NO_CREDENTIAL;
646 int initialContextToken = 0;
650 output_token->length = 0;
651 output_token->value = NULL;
653 if (ctx == GSS_C_NO_CONTEXT) {
654 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
655 *minor = GSSEAP_WRONG_SIZE;
656 return GSS_S_DEFECTIVE_TOKEN;
659 major = gssEapAllocContext(minor, &ctx);
660 if (GSS_ERROR(major))
663 ctx->flags |= CTX_FLAG_INITIATOR;
665 initialContextToken = 1;
666 *context_handle = ctx;
669 GSSEAP_MUTEX_LOCK(&ctx->mutex);
671 if (cred == GSS_C_NO_CREDENTIAL) {
672 if (ctx->initiatorCtx.defaultCred == GSS_C_NO_CREDENTIAL) {
673 major = gssEapAcquireCred(minor,
682 if (GSS_ERROR(major))
686 cred = ctx->initiatorCtx.defaultCred;
689 GSSEAP_MUTEX_LOCK(&cred->mutex);
691 #ifdef GSSEAP_ENABLE_REAUTH
692 if (initialContextToken && gssEapCanReauthP(cred, target_name, time_req))
693 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
696 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
697 *minor = GSSEAP_CRED_USAGE_MISMATCH;
698 major = GSS_S_NO_CRED;
702 sm = &eapGssInitiatorSm[ctx->state];
704 if (input_token != GSS_C_NO_BUFFER) {
705 major = gssEapVerifyToken(minor, ctx, input_token,
706 &tokType, &innerInputToken);
707 if (GSS_ERROR(major))
710 if (tokType == TOK_TYPE_CONTEXT_ERR) {
711 ctx->state = EAP_STATE_ERROR;
712 } else if (tokType != sm->inputTokenType) {
713 *minor = GSSEAP_WRONG_TOK_ID;
714 major = GSS_S_DEFECTIVE_TOKEN;
718 innerInputToken.length = 0;
719 innerInputToken.value = NULL;
723 * Advance through state machine whilst empty tokens are emitted and
724 * the status is not GSS_S_COMPLETE or an error status.
727 sm = &eapGssInitiatorSm[ctx->state];
729 major = (sm->processToken)(minor,
739 if (GSS_ERROR(major))
741 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
743 if (actual_mech_type != NULL) {
744 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
745 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
747 if (innerOutputToken.value != NULL) {
748 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
749 sm->outputTokenType, output_token);
750 if (GSS_ERROR(tmpMajor)) {
756 if (ret_flags != NULL)
757 *ret_flags = ctx->gssFlags;
758 if (time_rec != NULL)
759 gssEapContextTime(&tmpMinor, ctx, time_rec);
761 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
764 if (cred != GSS_C_NO_CREDENTIAL)
765 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
766 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
768 if (GSS_ERROR(major))
769 gssEapReleaseContext(&tmpMinor, context_handle);
771 gss_release_buffer(&tmpMinor, &innerOutputToken);
776 #ifdef GSSEAP_ENABLE_REAUTH
778 eapGssSmInitGssReauth(OM_uint32 *minor,
785 gss_channel_bindings_t chanBindings,
786 gss_buffer_t inputToken,
787 gss_buffer_t outputToken)
789 OM_uint32 major, tmpMinor;
790 gss_name_t mechTarget = GSS_C_NO_NAME;
791 gss_OID actualMech = GSS_C_NO_OID;
792 OM_uint32 gssFlags, timeRec;
794 assert(cred != GSS_C_NO_CREDENTIAL);
796 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
798 if (inputToken->length == 0) {
799 major = initBegin(minor, cred, ctx, target, mech,
800 reqFlags, timeReq, chanBindings,
801 inputToken, outputToken);
802 if (GSS_ERROR(major))
806 major = gssEapMechToGlueName(minor, target, &mechTarget);
807 if (GSS_ERROR(major))
810 major = gssInitSecContext(minor,
814 (gss_OID)gss_mech_krb5,
815 reqFlags, /* | GSS_C_DCE_STYLE, */
823 if (GSS_ERROR(major))
826 ctx->gssFlags = gssFlags;
828 if (major == GSS_S_COMPLETE) {
829 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
830 if (GSS_ERROR(major))
832 ctx->state = EAP_STATE_ESTABLISHED;
836 gssReleaseName(&tmpMinor, &mechTarget);
840 #endif /* GSSEAP_ENABLE_REAUTH */