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 assert(cred->name != GSS_C_NO_NAME);
226 if ((cred->name->flags & (NAME_FLAG_NAI | NAME_FLAG_SERVICE)) == 0) {
227 *minor = GSSEAP_BAD_INITIATOR_NAME;
228 return GSS_S_BAD_NAME;
231 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
234 return GSS_S_FAILURE;
237 eapPeerConfig->identity = (unsigned char *)identity;
238 eapPeerConfig->identity_len = strlen(identity);
239 eapPeerConfig->password = (unsigned char *)cred->password.value;
240 eapPeerConfig->password_len = cred->password.length;
243 return GSS_S_COMPLETE;
247 peerConfigFree(OM_uint32 *minor,
250 krb5_context krbContext;
251 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
253 GSSEAP_KRB_INIT(&krbContext);
255 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
258 return GSS_S_COMPLETE;
262 * Mark an initiator context as ready for cryptographic operations
265 initReady(OM_uint32 *minor, gss_ctx_id_t ctx, OM_uint32 reqFlags)
268 const unsigned char *key;
272 /* XXX actually check for mutual auth */
273 if (reqFlags & GSS_C_MUTUAL_FLAG)
274 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
277 /* Cache encryption type derived from selected mechanism OID */
278 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &ctx->encryptionType);
279 if (GSS_ERROR(major))
282 if (!eap_key_available(ctx->initiatorCtx.eap)) {
283 *minor = GSSEAP_KEY_UNAVAILABLE;
284 return GSS_S_UNAVAILABLE;
287 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
289 if (keyLength < EAP_EMSK_LEN) {
290 *minor = GSSEAP_KEY_TOO_SHORT;
291 return GSS_S_UNAVAILABLE;
294 major = gssEapDeriveRfc3961Key(minor,
295 &key[EAP_EMSK_LEN / 2],
299 if (GSS_ERROR(major))
302 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
304 if (GSS_ERROR(major))
307 major = sequenceInit(minor,
310 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
311 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
313 if (GSS_ERROR(major))
317 return GSS_S_COMPLETE;
321 initBegin(OM_uint32 *minor,
328 gss_channel_bindings_t chanBindings,
329 gss_buffer_t inputToken,
330 gss_buffer_t outputToken)
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 eapGssSmInitIdentity(OM_uint32 *minor,
392 gss_channel_bindings_t chanBindings,
393 gss_buffer_t inputToken,
394 gss_buffer_t outputToken)
397 int initialContextToken;
399 initialContextToken = (inputToken->length == 0);
400 if (!initialContextToken) {
401 *minor = GSSEAP_WRONG_SIZE;
402 return GSS_S_DEFECTIVE_TOKEN;
405 major = initBegin(minor, cred, ctx, target, mech,
406 reqFlags, timeReq, chanBindings,
407 inputToken, outputToken);
408 if (GSS_ERROR(major))
411 ctx->state = EAP_STATE_AUTHENTICATE;
414 return GSS_S_CONTINUE_NEEDED;
417 static struct wpabuf emptyWpaBuffer;
420 eapGssSmInitAuthenticate(OM_uint32 *minor,
427 gss_channel_bindings_t chanBindings,
428 gss_buffer_t inputToken,
429 gss_buffer_t outputToken)
434 struct wpabuf *resp = NULL;
435 int initialContextToken;
439 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
440 inputToken->length == 0);
442 major = peerConfigInit(minor, cred, ctx);
443 if (GSS_ERROR(major))
446 if (ctx->initiatorCtx.eap == NULL) {
447 struct eap_config eapConfig;
449 memset(&eapConfig, 0, sizeof(eapConfig));
451 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
452 &gssEapPolicyCallbacks,
455 if (ctx->initiatorCtx.eap == NULL) {
456 major = GSS_S_FAILURE;
457 *minor = GSSEAP_PEER_SM_INIT_FAILURE;
461 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
464 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
466 wpabuf_set(&ctx->initiatorCtx.reqData,
467 inputToken->value, inputToken->length);
469 major = GSS_S_CONTINUE_NEEDED;
471 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
472 if (ctx->flags & CTX_FLAG_EAP_RESP) {
473 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
475 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
476 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
477 major = initReady(minor, ctx, reqFlags);
478 if (GSS_ERROR(major))
481 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
482 major = GSS_S_CONTINUE_NEEDED;
483 ctx->state = EAP_STATE_EXTENSIONS_REQ;
484 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
485 major = GSS_S_DEFECTIVE_CREDENTIAL;
486 *minor = GSSEAP_PEER_AUTH_FAILURE;
487 } else if (code == 0 && initialContextToken) {
488 resp = &emptyWpaBuffer;
489 major = GSS_S_CONTINUE_NEEDED;
491 major = GSS_S_DEFECTIVE_TOKEN;
492 *minor = GSSEAP_PEER_BAD_MESSAGE;
498 gss_buffer_desc respBuf;
500 assert(major == GSS_S_CONTINUE_NEEDED);
502 respBuf.length = wpabuf_len(resp);
503 respBuf.value = (void *)wpabuf_head(resp);
505 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
506 if (GSS_ERROR(tmpMajor)) {
512 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
513 peerConfigFree(&tmpMinor, ctx);
519 eapGssSmInitExtensionsReq(OM_uint32 *minor,
526 gss_channel_bindings_t chanBindings,
527 gss_buffer_t inputToken,
528 gss_buffer_t outputToken)
532 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
533 if (GSS_ERROR(major))
536 assert(outputToken->value != NULL);
538 ctx->state = EAP_STATE_EXTENSIONS_RESP;
541 return GSS_S_CONTINUE_NEEDED;
545 eapGssSmInitExtensionsResp(OM_uint32 *minor,
552 gss_channel_bindings_t chanBindings,
553 gss_buffer_t inputToken,
554 gss_buffer_t outputToken)
558 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
559 if (GSS_ERROR(major))
562 ctx->state = EAP_STATE_ESTABLISHED;
565 return GSS_S_COMPLETE;
569 eapGssSmInitEstablished(OM_uint32 *minor,
576 gss_channel_bindings_t chanBindings,
577 gss_buffer_t inputToken,
578 gss_buffer_t outputToken)
580 /* Called with already established context */
581 *minor = GSSEAP_CONTEXT_ESTABLISHED;
582 return GSS_S_BAD_STATUS;
586 eapGssSmInitError(OM_uint32 *minor,
593 gss_channel_bindings_t chanBindings,
594 gss_buffer_t inputToken,
595 gss_buffer_t outputToken)
600 if (inputToken->length < 8) {
601 *minor = GSSEAP_TOK_TRUNC;
602 return GSS_S_DEFECTIVE_TOKEN;
605 p = (unsigned char *)inputToken->value;
607 major = load_uint32_be(&p[0]);
608 *minor = ERROR_TABLE_BASE_eapg + load_uint32_be(&p[4]);
610 if (!GSS_ERROR(major)) {
611 major = GSS_S_FAILURE;
612 *minor = GSSEAP_BAD_ERROR_TOKEN;
618 static struct gss_eap_initiator_sm {
619 enum gss_eap_token_type inputTokenType;
620 enum gss_eap_token_type outputTokenType;
621 OM_uint32 (*processToken)(OM_uint32 *,
628 gss_channel_bindings_t,
631 } eapGssInitiatorSm[] = {
632 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
633 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
634 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
635 { TOK_TYPE_EXT_RESP, TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
636 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
637 { TOK_TYPE_CONTEXT_ERR, TOK_TYPE_NONE, eapGssSmInitError },
638 #ifdef GSSEAP_ENABLE_REAUTH
639 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
644 gss_init_sec_context(OM_uint32 *minor,
646 gss_ctx_id_t *context_handle,
647 gss_name_t target_name,
651 gss_channel_bindings_t input_chan_bindings,
652 gss_buffer_t input_token,
653 gss_OID *actual_mech_type,
654 gss_buffer_t output_token,
655 OM_uint32 *ret_flags,
659 OM_uint32 tmpMajor, tmpMinor;
660 gss_ctx_id_t ctx = *context_handle;
661 struct gss_eap_initiator_sm *sm = NULL;
662 gss_buffer_desc innerInputToken;
663 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
664 enum gss_eap_token_type tokType;
665 gss_cred_id_t defaultCred = GSS_C_NO_CREDENTIAL;
666 int initialContextToken = 0;
670 output_token->length = 0;
671 output_token->value = NULL;
673 if (ctx == GSS_C_NO_CONTEXT) {
674 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
675 *minor = GSSEAP_WRONG_SIZE;
676 return GSS_S_DEFECTIVE_TOKEN;
679 major = gssEapAllocContext(minor, &ctx);
680 if (GSS_ERROR(major))
683 ctx->flags |= CTX_FLAG_INITIATOR;
685 initialContextToken = 1;
686 *context_handle = ctx;
689 GSSEAP_MUTEX_LOCK(&ctx->mutex);
691 if (cred == GSS_C_NO_CREDENTIAL) {
692 if (ctx->initiatorCtx.defaultCred == GSS_C_NO_CREDENTIAL) {
693 major = gssEapAcquireCred(minor,
702 if (GSS_ERROR(major))
706 cred = ctx->initiatorCtx.defaultCred;
709 GSSEAP_MUTEX_LOCK(&cred->mutex);
711 #ifdef GSSEAP_ENABLE_REAUTH
712 if (initialContextToken && gssEapCanReauthP(cred, target_name, time_req))
713 ctx->state = EAP_STATE_KRB_REAUTH_GSS;
716 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
717 major = GSS_S_NO_CRED;
718 *minor = GSSEAP_CRED_USAGE_MISMATCH;
722 sm = &eapGssInitiatorSm[ctx->state];
724 if (input_token != GSS_C_NO_BUFFER) {
725 major = gssEapVerifyToken(minor, ctx, input_token,
726 &tokType, &innerInputToken);
727 if (GSS_ERROR(major))
730 if (tokType == TOK_TYPE_CONTEXT_ERR) {
731 ctx->state = EAP_STATE_ERROR;
732 } else if (tokType != sm->inputTokenType) {
733 major = GSS_S_DEFECTIVE_TOKEN;
734 *minor = GSSEAP_WRONG_TOK_ID;
738 innerInputToken.length = 0;
739 innerInputToken.value = NULL;
743 * Advance through state machine whilst empty tokens are emitted and
744 * the status is not GSS_S_COMPLETE or an error status.
747 sm = &eapGssInitiatorSm[ctx->state];
749 major = (sm->processToken)(minor,
759 if (GSS_ERROR(major))
761 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
763 if (actual_mech_type != NULL) {
764 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
765 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
767 if (innerOutputToken.value != NULL) {
768 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
769 sm->outputTokenType, output_token);
770 if (GSS_ERROR(tmpMajor)) {
776 if (ret_flags != NULL)
777 *ret_flags = ctx->gssFlags;
778 if (time_rec != NULL)
779 gssEapContextTime(&tmpMinor, ctx, time_rec);
781 assert(ctx->state == EAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
784 if (cred != GSS_C_NO_CREDENTIAL)
785 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
786 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
788 if (GSS_ERROR(major))
789 gssEapReleaseContext(&tmpMinor, context_handle);
791 gss_release_buffer(&tmpMinor, &innerOutputToken);
796 #ifdef GSSEAP_ENABLE_REAUTH
798 eapGssSmInitGssReauth(OM_uint32 *minor,
805 gss_channel_bindings_t chanBindings,
806 gss_buffer_t inputToken,
807 gss_buffer_t outputToken)
809 OM_uint32 major, tmpMinor;
810 gss_name_t mechTarget = GSS_C_NO_NAME;
811 gss_OID actualMech = GSS_C_NO_OID;
812 OM_uint32 gssFlags, timeRec;
814 assert(cred != GSS_C_NO_CREDENTIAL);
816 ctx->flags |= CTX_FLAG_KRB_REAUTH_GSS;
818 if (inputToken->length == 0) {
819 major = initBegin(minor, cred, ctx, target, mech,
820 reqFlags, timeReq, chanBindings,
821 inputToken, outputToken);
822 if (GSS_ERROR(major))
826 major = gssEapMechToGlueName(minor, target, &mechTarget);
827 if (GSS_ERROR(major))
830 major = gssInitSecContext(minor,
834 (gss_OID)gss_mech_krb5,
835 reqFlags, /* | GSS_C_DCE_STYLE, */
843 if (GSS_ERROR(major))
846 ctx->gssFlags = gssFlags;
848 if (major == GSS_S_COMPLETE) {
849 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
850 if (GSS_ERROR(major))
852 ctx->state = EAP_STATE_ESTABLISHED;
856 gssReleaseName(&tmpMinor, &mechTarget);
860 #endif /* GSSEAP_ENABLE_REAUTH */