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 return GSS_S_UNAVAILABLE;
273 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
275 if (keyLength < EAP_EMSK_LEN)
276 return GSS_S_UNAVAILABLE;
278 major = gssEapDeriveRfc3961Key(minor,
279 &key[EAP_EMSK_LEN / 2],
283 if (GSS_ERROR(major))
286 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
288 if (GSS_ERROR(major))
291 major = sequenceInit(minor,
294 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
295 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
297 if (GSS_ERROR(major))
300 return GSS_S_COMPLETE;
304 initBegin(OM_uint32 *minor,
311 gss_channel_bindings_t chanBindings,
312 gss_buffer_t inputToken,
313 gss_buffer_t outputToken)
317 assert(cred != GSS_C_NO_CREDENTIAL);
319 if (cred->expiryTime)
320 ctx->expiryTime = cred->expiryTime;
321 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
324 ctx->expiryTime = time(NULL) + timeReq;
327 * The credential mutex protects its name, however we need to
328 * explicitly lock the acceptor name (unlikely as it may be
329 * that it has attributes set on it).
331 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
332 if (GSS_ERROR(major))
335 GSSEAP_MUTEX_LOCK(&target->mutex);
337 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
338 if (GSS_ERROR(major)) {
339 GSSEAP_MUTEX_UNLOCK(&target->mutex);
343 GSSEAP_MUTEX_UNLOCK(&target->mutex);
345 if (mech == GSS_C_NULL_OID) {
346 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
347 } else if (gssEapIsConcreteMechanismOid(mech)) {
348 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
349 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
351 major = GSS_S_BAD_MECH;
353 if (GSS_ERROR(major))
356 /* If credentials were provided, check they're usable with this mech */
357 if (!gssEapCredAvailable(cred, ctx->mechanismUsed))
358 return GSS_S_BAD_MECH;
360 return GSS_S_COMPLETE;
364 eapGssSmInitIdentity(OM_uint32 *minor,
371 gss_channel_bindings_t chanBindings,
372 gss_buffer_t inputToken,
373 gss_buffer_t outputToken)
376 int initialContextToken;
378 initialContextToken = (inputToken->length == 0);
379 if (!initialContextToken)
380 return GSS_S_DEFECTIVE_TOKEN;
382 major = initBegin(minor, cred, ctx, target, mech,
383 reqFlags, timeReq, chanBindings,
384 inputToken, outputToken);
385 if (GSS_ERROR(major))
388 ctx->state = EAP_STATE_AUTHENTICATE;
390 return GSS_S_CONTINUE_NEEDED;
393 static struct wpabuf emptyWpaBuffer;
396 eapGssSmInitAuthenticate(OM_uint32 *minor,
403 gss_channel_bindings_t chanBindings,
404 gss_buffer_t inputToken,
405 gss_buffer_t outputToken)
410 struct wpabuf *resp = NULL;
411 int initialContextToken;
413 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
414 inputToken->length == 0);
416 major = peerConfigInit(minor, cred, ctx);
417 if (GSS_ERROR(major))
420 if (ctx->initiatorCtx.eap == NULL) {
421 struct eap_config eapConfig;
423 memset(&eapConfig, 0, sizeof(eapConfig));
425 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
426 &gssEapPolicyCallbacks,
429 if (ctx->initiatorCtx.eap == NULL) {
430 major = GSS_S_FAILURE;
434 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
437 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
439 wpabuf_set(&ctx->initiatorCtx.reqData,
440 inputToken->value, inputToken->length);
442 major = GSS_S_CONTINUE_NEEDED;
444 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
445 if (ctx->flags & CTX_FLAG_EAP_RESP) {
446 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
448 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
449 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
450 major = initReady(minor, ctx, reqFlags);
451 if (GSS_ERROR(major))
454 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
455 major = GSS_S_CONTINUE_NEEDED;
456 ctx->state = EAP_STATE_EXTENSIONS_REQ;
457 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
458 major = GSS_S_DEFECTIVE_CREDENTIAL;
459 } else if (code == 0 && initialContextToken) {
460 resp = &emptyWpaBuffer;
461 major = GSS_S_CONTINUE_NEEDED;
463 major = GSS_S_DEFECTIVE_TOKEN;
469 gss_buffer_desc respBuf;
471 assert(major == GSS_S_CONTINUE_NEEDED);
473 respBuf.length = wpabuf_len(resp);
474 respBuf.value = (void *)wpabuf_head(resp);
476 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
477 if (GSS_ERROR(tmpMajor)) {
483 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
484 peerConfigFree(&tmpMinor, ctx);
490 eapGssSmInitExtensionsReq(OM_uint32 *minor,
497 gss_channel_bindings_t chanBindings,
498 gss_buffer_t inputToken,
499 gss_buffer_t outputToken)
503 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
504 if (GSS_ERROR(major))
507 assert(outputToken->value != NULL);
509 ctx->state = EAP_STATE_EXTENSIONS_RESP;
511 return GSS_S_CONTINUE_NEEDED;
515 eapGssSmInitExtensionsResp(OM_uint32 *minor,
522 gss_channel_bindings_t chanBindings,
523 gss_buffer_t inputToken,
524 gss_buffer_t outputToken)
528 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
529 if (GSS_ERROR(major))
532 ctx->state = EAP_STATE_ESTABLISHED;
534 return GSS_S_COMPLETE;
538 eapGssSmInitEstablished(OM_uint32 *minor,
545 gss_channel_bindings_t chanBindings,
546 gss_buffer_t inputToken,
547 gss_buffer_t outputToken)
549 /* Called with already established context */
551 return GSS_S_BAD_STATUS;
554 static struct gss_eap_initiator_sm {
555 enum gss_eap_token_type inputTokenType;
556 enum gss_eap_token_type outputTokenType;
557 OM_uint32 (*processToken)(OM_uint32 *,
564 gss_channel_bindings_t,
567 } eapGssInitiatorSm[] = {
568 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
569 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
570 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
571 { TOK_TYPE_EXT_RESP,TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
572 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
573 #ifdef GSSEAP_ENABLE_REAUTH
574 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
579 gss_init_sec_context(OM_uint32 *minor,
581 gss_ctx_id_t *context_handle,
582 gss_name_t target_name,
586 gss_channel_bindings_t input_chan_bindings,
587 gss_buffer_t input_token,
588 gss_OID *actual_mech_type,
589 gss_buffer_t output_token,
590 OM_uint32 *ret_flags,
594 OM_uint32 tmpMajor, tmpMinor;
595 gss_ctx_id_t ctx = *context_handle;
596 struct gss_eap_initiator_sm *sm = NULL;
597 gss_buffer_desc innerInputToken;
598 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
599 enum gss_eap_token_type tokType;
600 gss_cred_id_t defaultCred = GSS_C_NO_CREDENTIAL;
601 int initialContextToken = 0;
605 output_token->length = 0;
606 output_token->value = NULL;
608 if (ctx == GSS_C_NO_CONTEXT) {
609 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
610 return GSS_S_DEFECTIVE_TOKEN;
613 major = gssEapAllocContext(minor, &ctx);
614 if (GSS_ERROR(major))
617 ctx->flags |= CTX_FLAG_INITIATOR;
619 initialContextToken = 1;
620 *context_handle = ctx;
623 GSSEAP_MUTEX_LOCK(&ctx->mutex);
625 if (cred == GSS_C_NO_CREDENTIAL) {
626 if (ctx->initiatorCtx.defaultCred == GSS_C_NO_CREDENTIAL) {
627 major = gssEapAcquireCred(minor,
636 if (GSS_ERROR(major))
640 cred = ctx->initiatorCtx.defaultCred;
643 GSSEAP_MUTEX_LOCK(&cred->mutex);
645 #ifdef GSSEAP_ENABLE_REAUTH
646 if (initialContextToken && gssEapCanReauthP(cred, target_name, time_req))
647 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
650 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
651 major = GSS_S_NO_CRED;
655 sm = &eapGssInitiatorSm[ctx->state];
657 if (input_token != GSS_C_NO_BUFFER) {
658 major = gssEapVerifyToken(minor, ctx, input_token,
659 &tokType, &innerInputToken);
660 if (GSS_ERROR(major))
663 if (tokType != sm->inputTokenType) {
664 major = GSS_S_DEFECTIVE_TOKEN;
668 innerInputToken.length = 0;
669 innerInputToken.value = NULL;
673 * Advance through state machine whilst empty tokens are emitted and
674 * the status is not GSS_S_COMPLETE or an error status.
677 sm = &eapGssInitiatorSm[ctx->state];
679 major = (sm->processToken)(minor,
689 if (GSS_ERROR(major))
691 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
693 if (actual_mech_type != NULL) {
694 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
695 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
697 if (innerOutputToken.value != NULL) {
698 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
699 sm->outputTokenType, output_token);
700 if (GSS_ERROR(tmpMajor)) {
706 if (ret_flags != NULL)
707 *ret_flags = ctx->gssFlags;
708 if (time_rec != NULL)
709 gssEapContextTime(&tmpMinor, ctx, time_rec);
711 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
714 if (cred != GSS_C_NO_CREDENTIAL)
715 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
716 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
718 if (GSS_ERROR(major))
719 gssEapReleaseContext(&tmpMinor, context_handle);
721 gss_release_buffer(&tmpMinor, &innerOutputToken);
726 #ifdef GSSEAP_ENABLE_REAUTH
728 eapGssSmInitGssReauth(OM_uint32 *minor,
735 gss_channel_bindings_t chanBindings,
736 gss_buffer_t inputToken,
737 gss_buffer_t outputToken)
739 OM_uint32 major, tmpMinor;
740 gss_name_t mechTarget = GSS_C_NO_NAME;
741 gss_OID actualMech = GSS_C_NO_OID;
742 OM_uint32 gssFlags, timeRec;
744 assert(cred != GSS_C_NO_CREDENTIAL);
746 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
748 if (inputToken->length == 0) {
749 major = initBegin(minor, cred, ctx, target, mech,
750 reqFlags, timeReq, chanBindings,
751 inputToken, outputToken);
752 if (GSS_ERROR(major))
756 major = gssEapMechToGlueName(minor, target, &mechTarget);
757 if (GSS_ERROR(major))
760 major = gssInitSecContext(minor,
764 (gss_OID)gss_mech_krb5,
765 reqFlags, /* | GSS_C_DCE_STYLE, */
773 if (GSS_ERROR(major))
776 ctx->gssFlags = gssFlags;
778 if (major == GSS_S_COMPLETE) {
779 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
780 if (GSS_ERROR(major))
782 ctx->state = EAP_STATE_ESTABLISHED;
786 gssReleaseName(&tmpMinor, &mechTarget);
790 #endif /* GSSEAP_ENABLE_REAUTH */