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"
40 #ifdef GSSEAP_ENABLE_REAUTH
42 eapGssSmInitGssReauth(OM_uint32 *minor,
49 gss_channel_bindings_t chanBindings,
50 gss_buffer_t inputToken,
51 gss_buffer_t outputToken);
55 policyVariableToFlag(enum eapol_bool_var variable)
60 case EAPOL_eapSuccess:
61 flag = CTX_FLAG_EAP_SUCCESS;
63 case EAPOL_eapRestart:
64 flag = CTX_FLAG_EAP_RESTART;
67 flag = CTX_FLAG_EAP_FAIL;
70 flag = CTX_FLAG_EAP_RESP;
73 flag = CTX_FLAG_EAP_NO_RESP;
76 flag = CTX_FLAG_EAP_REQ;
78 case EAPOL_portEnabled:
79 flag = CTX_FLAG_EAP_PORT_ENABLED;
82 flag = CTX_FLAG_EAP_ALT_ACCEPT;
85 flag = CTX_FLAG_EAP_ALT_REJECT;
92 static struct eap_peer_config *
93 peerGetConfig(void *ctx)
95 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
97 return &gssCtx->initiatorCtx.eapPeerConfig;
101 peerGetBool(void *data, enum eapol_bool_var variable)
103 gss_ctx_id_t ctx = data;
106 if (ctx == GSS_C_NO_CONTEXT)
109 flag = policyVariableToFlag(variable);
111 return ((ctx->flags & flag) != 0);
115 peerSetBool(void *data, enum eapol_bool_var variable,
118 gss_ctx_id_t ctx = data;
121 if (ctx == GSS_C_NO_CONTEXT)
124 flag = policyVariableToFlag(variable);
129 ctx->flags &= ~(flag);
133 peerGetInt(void *data, enum eapol_int_var variable)
135 gss_ctx_id_t ctx = data;
137 if (ctx == GSS_C_NO_CONTEXT)
140 assert(CTX_IS_INITIATOR(ctx));
143 case EAPOL_idleWhile:
144 return ctx->initiatorCtx.idleWhile;
152 peerSetInt(void *data, enum eapol_int_var variable,
155 gss_ctx_id_t ctx = data;
157 if (ctx == GSS_C_NO_CONTEXT)
160 assert(CTX_IS_INITIATOR(ctx));
163 case EAPOL_idleWhile:
164 ctx->initiatorCtx.idleWhile = value;
169 static struct wpabuf *
170 peerGetEapReqData(void *ctx)
172 gss_ctx_id_t gssCtx = (gss_ctx_id_t)ctx;
174 return &gssCtx->initiatorCtx.reqData;
178 peerSetConfigBlob(void *ctx, struct wpa_config_blob *blob)
182 static const struct wpa_config_blob *
183 peerGetConfigBlob(void *ctx, const char *name)
189 peerNotifyPending(void *ctx)
193 static struct eapol_callbacks gssEapPolicyCallbacks = {
206 extern int wpa_debug_level;
210 peerConfigInit(OM_uint32 *minor,
214 krb5_context krbContext;
215 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
216 krb5_error_code code;
217 char *identity, *anonymousIdentity;
219 eapPeerConfig->identity = NULL;
220 eapPeerConfig->identity_len = 0;
221 eapPeerConfig->password = NULL;
222 eapPeerConfig->password_len = 0;
224 assert(cred != GSS_C_NO_CREDENTIAL);
226 GSSEAP_KRB_INIT(&krbContext);
228 eapPeerConfig->fragment_size = 1024;
233 assert(cred->name != GSS_C_NO_NAME);
235 if ((cred->name->flags & (NAME_FLAG_NAI | NAME_FLAG_SERVICE)) == 0) {
236 *minor = GSSEAP_BAD_INITIATOR_NAME;
237 return GSS_S_BAD_NAME;
240 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
243 return GSS_S_FAILURE;
246 anonymousIdentity = strchr(identity, '@');
247 if (anonymousIdentity == NULL)
248 anonymousIdentity = "";
250 eapPeerConfig->identity = (unsigned char *)identity;
251 eapPeerConfig->identity_len = strlen(identity);
252 eapPeerConfig->anonymous_identity = (unsigned char *)anonymousIdentity;
253 eapPeerConfig->anonymous_identity_len = strlen(anonymousIdentity);
254 eapPeerConfig->password = (unsigned char *)cred->password.value;
255 eapPeerConfig->password_len = cred->password.length;
258 return GSS_S_COMPLETE;
262 peerConfigFree(OM_uint32 *minor,
265 krb5_context krbContext;
266 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
268 GSSEAP_KRB_INIT(&krbContext);
270 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
273 return GSS_S_COMPLETE;
277 * Mark an initiator context as ready for cryptographic operations
280 initReady(OM_uint32 *minor, gss_ctx_id_t ctx, OM_uint32 reqFlags)
283 const unsigned char *key;
287 /* XXX actually check for mutual auth */
288 if (reqFlags & GSS_C_MUTUAL_FLAG)
289 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
292 /* Cache encryption type derived from selected mechanism OID */
293 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &ctx->encryptionType);
294 if (GSS_ERROR(major))
297 if (!eap_key_available(ctx->initiatorCtx.eap)) {
298 *minor = GSSEAP_KEY_UNAVAILABLE;
299 return GSS_S_UNAVAILABLE;
302 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
304 if (keyLength < EAP_EMSK_LEN) {
305 *minor = GSSEAP_KEY_TOO_SHORT;
306 return GSS_S_UNAVAILABLE;
309 major = gssEapDeriveRfc3961Key(minor,
310 &key[EAP_EMSK_LEN / 2],
314 if (GSS_ERROR(major))
317 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
319 if (GSS_ERROR(major))
322 major = sequenceInit(minor,
325 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
326 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
328 if (GSS_ERROR(major))
332 return GSS_S_COMPLETE;
336 initBegin(OM_uint32 *minor,
343 gss_channel_bindings_t chanBindings,
344 gss_buffer_t inputToken,
345 gss_buffer_t outputToken)
349 assert(cred != GSS_C_NO_CREDENTIAL);
351 if (cred->expiryTime)
352 ctx->expiryTime = cred->expiryTime;
353 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
356 ctx->expiryTime = time(NULL) + timeReq;
359 * The credential mutex protects its name, however we need to
360 * explicitly lock the acceptor name (unlikely as it may be
361 * that it has attributes set on it).
363 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
364 if (GSS_ERROR(major))
367 GSSEAP_MUTEX_LOCK(&target->mutex);
369 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
370 if (GSS_ERROR(major)) {
371 GSSEAP_MUTEX_UNLOCK(&target->mutex);
375 GSSEAP_MUTEX_UNLOCK(&target->mutex);
377 if (mech == GSS_C_NULL_OID) {
378 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
379 } else if (gssEapIsConcreteMechanismOid(mech)) {
380 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
381 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
383 major = GSS_S_BAD_MECH;
384 *minor = GSSEAP_WRONG_MECH;
386 if (GSS_ERROR(major))
389 /* If credentials were provided, check they're usable with this mech */
390 if (!gssEapCredAvailable(cred, ctx->mechanismUsed)) {
391 *minor = GSSEAP_CRED_MECH_MISMATCH;
392 return GSS_S_BAD_MECH;
396 return GSS_S_COMPLETE;
400 eapGssSmInitIdentity(OM_uint32 *minor,
407 gss_channel_bindings_t chanBindings,
408 gss_buffer_t inputToken,
409 gss_buffer_t outputToken)
412 int initialContextToken;
414 initialContextToken = (inputToken->length == 0);
415 if (!initialContextToken) {
416 *minor = GSSEAP_WRONG_SIZE;
417 return GSS_S_DEFECTIVE_TOKEN;
420 major = initBegin(minor, cred, ctx, target, mech,
421 reqFlags, timeReq, chanBindings,
422 inputToken, outputToken);
423 if (GSS_ERROR(major))
426 ctx->state = GSSEAP_STATE_AUTHENTICATE;
429 return GSS_S_CONTINUE_NEEDED;
432 static struct wpabuf emptyWpaBuffer;
435 eapGssSmInitAuthenticate(OM_uint32 *minor,
442 gss_channel_bindings_t chanBindings,
443 gss_buffer_t inputToken,
444 gss_buffer_t outputToken)
449 struct wpabuf *resp = NULL;
450 int initialContextToken;
454 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
455 inputToken->length == 0);
457 major = peerConfigInit(minor, cred, ctx);
458 if (GSS_ERROR(major))
461 if (ctx->initiatorCtx.eap == NULL) {
462 struct eap_config eapConfig;
464 memset(&eapConfig, 0, sizeof(eapConfig));
466 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
467 &gssEapPolicyCallbacks,
470 if (ctx->initiatorCtx.eap == NULL) {
471 major = GSS_S_FAILURE;
472 *minor = GSSEAP_PEER_SM_INIT_FAILURE;
476 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
479 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
481 wpabuf_set(&ctx->initiatorCtx.reqData,
482 inputToken->value, inputToken->length);
484 major = GSS_S_CONTINUE_NEEDED;
486 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
487 if (ctx->flags & CTX_FLAG_EAP_RESP) {
488 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
490 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
491 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
492 major = initReady(minor, ctx, reqFlags);
493 if (GSS_ERROR(major))
496 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
497 major = GSS_S_CONTINUE_NEEDED;
498 ctx->state = GSSEAP_STATE_EXTENSIONS_REQ;
499 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
500 major = GSS_S_DEFECTIVE_CREDENTIAL;
501 *minor = GSSEAP_PEER_AUTH_FAILURE;
502 } else if (code == 0 && initialContextToken) {
503 resp = &emptyWpaBuffer;
504 major = GSS_S_CONTINUE_NEEDED;
506 major = GSS_S_DEFECTIVE_TOKEN;
507 *minor = GSSEAP_PEER_BAD_MESSAGE;
513 gss_buffer_desc respBuf;
515 assert(major == GSS_S_CONTINUE_NEEDED);
517 respBuf.length = wpabuf_len(resp);
518 respBuf.value = (void *)wpabuf_head(resp);
520 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
521 if (GSS_ERROR(tmpMajor)) {
527 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
528 peerConfigFree(&tmpMinor, ctx);
534 eapGssSmInitExtensionsReq(OM_uint32 *minor,
541 gss_channel_bindings_t chanBindings,
542 gss_buffer_t inputToken,
543 gss_buffer_t outputToken)
547 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
548 if (GSS_ERROR(major))
551 assert(outputToken->value != NULL);
553 ctx->state = GSSEAP_STATE_EXTENSIONS_RESP;
556 return GSS_S_CONTINUE_NEEDED;
560 eapGssSmInitExtensionsResp(OM_uint32 *minor,
567 gss_channel_bindings_t chanBindings,
568 gss_buffer_t inputToken,
569 gss_buffer_t outputToken)
573 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
574 if (GSS_ERROR(major))
577 ctx->state = GSSEAP_STATE_ESTABLISHED;
580 return GSS_S_COMPLETE;
584 eapGssSmInitEstablished(OM_uint32 *minor,
591 gss_channel_bindings_t chanBindings,
592 gss_buffer_t inputToken,
593 gss_buffer_t outputToken)
595 /* Called with already established context */
596 *minor = GSSEAP_CONTEXT_ESTABLISHED;
597 return GSS_S_BAD_STATUS;
601 eapGssSmInitError(OM_uint32 *minor,
608 gss_channel_bindings_t chanBindings,
609 gss_buffer_t inputToken,
610 gss_buffer_t outputToken)
615 if (inputToken->length < 8) {
616 *minor = GSSEAP_TOK_TRUNC;
617 return GSS_S_DEFECTIVE_TOKEN;
620 p = (unsigned char *)inputToken->value;
622 major = load_uint32_be(&p[0]);
623 *minor = ERROR_TABLE_BASE_eapg + load_uint32_be(&p[4]);
625 if (!GSS_ERROR(major) || !IS_WIRE_ERROR(*minor)) {
626 major = GSS_S_FAILURE;
627 *minor = GSSEAP_BAD_ERROR_TOKEN;
633 static struct gss_eap_initiator_sm {
634 enum gss_eap_token_type inputTokenType;
635 enum gss_eap_token_type outputTokenType;
636 OM_uint32 (*processToken)(OM_uint32 *,
643 gss_channel_bindings_t,
646 } eapGssInitiatorSm[] = {
647 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
648 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
649 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
650 { TOK_TYPE_EXT_RESP, TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
651 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
652 { TOK_TYPE_CONTEXT_ERR, TOK_TYPE_NONE, eapGssSmInitError },
653 #ifdef GSSEAP_ENABLE_REAUTH
654 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
659 gss_init_sec_context(OM_uint32 *minor,
661 gss_ctx_id_t *context_handle,
662 gss_name_t target_name,
666 gss_channel_bindings_t input_chan_bindings,
667 gss_buffer_t input_token,
668 gss_OID *actual_mech_type,
669 gss_buffer_t output_token,
670 OM_uint32 *ret_flags,
674 OM_uint32 tmpMajor, tmpMinor;
675 gss_ctx_id_t ctx = *context_handle;
676 struct gss_eap_initiator_sm *sm = NULL;
677 gss_buffer_desc innerInputToken;
678 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
679 enum gss_eap_token_type tokType;
680 int initialContextToken = 0;
684 output_token->length = 0;
685 output_token->value = NULL;
687 if (ctx == GSS_C_NO_CONTEXT) {
688 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
689 *minor = GSSEAP_WRONG_SIZE;
690 return GSS_S_DEFECTIVE_TOKEN;
693 major = gssEapAllocContext(minor, &ctx);
694 if (GSS_ERROR(major))
697 ctx->flags |= CTX_FLAG_INITIATOR;
699 initialContextToken = 1;
700 *context_handle = ctx;
703 GSSEAP_MUTEX_LOCK(&ctx->mutex);
705 if (cred == GSS_C_NO_CREDENTIAL) {
706 if (ctx->defaultCred == GSS_C_NO_CREDENTIAL) {
707 major = gssEapAcquireCred(minor,
716 if (GSS_ERROR(major))
720 cred = ctx->defaultCred;
723 GSSEAP_MUTEX_LOCK(&cred->mutex);
725 #ifdef GSSEAP_ENABLE_REAUTH
726 if (initialContextToken && gssEapCanReauthP(cred, target_name, time_req))
727 ctx->state = GSSEAP_STATE_KRB_REAUTH;
730 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
731 major = GSS_S_NO_CRED;
732 *minor = GSSEAP_CRED_USAGE_MISMATCH;
736 sm = &eapGssInitiatorSm[ctx->state];
738 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
739 major = gssEapVerifyToken(minor, ctx, input_token,
740 &tokType, &innerInputToken);
741 if (GSS_ERROR(major))
744 if (tokType == TOK_TYPE_CONTEXT_ERR) {
745 ctx->state = GSSEAP_STATE_ERROR;
746 } else if (tokType != sm->inputTokenType) {
747 major = GSS_S_DEFECTIVE_TOKEN;
748 *minor = GSSEAP_WRONG_TOK_ID;
752 innerInputToken.length = 0;
753 innerInputToken.value = NULL;
757 * Advance through state machine whilst empty tokens are emitted and
758 * the status is not GSS_S_COMPLETE or an error status.
761 sm = &eapGssInitiatorSm[ctx->state];
763 major = (sm->processToken)(minor,
773 if (GSS_ERROR(major))
775 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
777 if (actual_mech_type != NULL) {
778 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
779 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
781 if (innerOutputToken.value != NULL) {
782 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
783 sm->outputTokenType, output_token);
784 if (GSS_ERROR(tmpMajor)) {
790 if (ret_flags != NULL)
791 *ret_flags = ctx->gssFlags;
792 if (time_rec != NULL)
793 gssEapContextTime(&tmpMinor, ctx, time_rec);
795 assert(ctx->state == GSSEAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
798 if (cred != GSS_C_NO_CREDENTIAL)
799 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
800 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
802 if (GSS_ERROR(major))
803 gssEapReleaseContext(&tmpMinor, context_handle);
805 gss_release_buffer(&tmpMinor, &innerOutputToken);
810 #ifdef GSSEAP_ENABLE_REAUTH
812 eapGssSmInitGssReauth(OM_uint32 *minor,
819 gss_channel_bindings_t chanBindings,
820 gss_buffer_t inputToken,
821 gss_buffer_t outputToken)
823 OM_uint32 major, tmpMinor;
824 gss_name_t mechTarget = GSS_C_NO_NAME;
825 gss_OID actualMech = GSS_C_NO_OID;
826 OM_uint32 gssFlags, timeRec;
828 assert(cred != GSS_C_NO_CREDENTIAL);
830 ctx->flags |= CTX_FLAG_KRB_REAUTH;
832 if (inputToken->length == 0) {
833 major = initBegin(minor, cred, ctx, target, mech,
834 reqFlags, timeReq, chanBindings,
835 inputToken, outputToken);
836 if (GSS_ERROR(major))
840 major = gssEapMechToGlueName(minor, target, &mechTarget);
841 if (GSS_ERROR(major))
844 major = gssInitSecContext(minor,
848 (gss_OID)gss_mech_krb5,
849 reqFlags, /* | GSS_C_DCE_STYLE, */
857 if (GSS_ERROR(major))
860 ctx->gssFlags = gssFlags;
862 if (major == GSS_S_COMPLETE) {
863 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
864 if (GSS_ERROR(major))
866 ctx->state = GSSEAP_STATE_ESTABLISHED;
870 gssReleaseName(&tmpMinor, &mechTarget);
874 #endif /* GSSEAP_ENABLE_REAUTH */