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
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 = {
205 extern int wpa_debug_level;
208 peerConfigInit(OM_uint32 *minor,
212 krb5_context krbContext;
213 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
214 krb5_error_code code;
217 eapPeerConfig->identity = NULL;
218 eapPeerConfig->identity_len = 0;
219 eapPeerConfig->password = NULL;
220 eapPeerConfig->password_len = 0;
222 assert(cred != GSS_C_NO_CREDENTIAL);
224 GSSEAP_KRB_INIT(&krbContext);
226 eapPeerConfig->fragment_size = 1024;
229 assert(cred->name != GSS_C_NO_NAME);
231 if ((cred->name->flags & (NAME_FLAG_NAI | NAME_FLAG_SERVICE)) == 0) {
232 *minor = GSSEAP_BAD_INITIATOR_NAME;
233 return GSS_S_BAD_NAME;
236 code = krb5_unparse_name(krbContext, cred->name->krbPrincipal, &identity);
239 return GSS_S_FAILURE;
242 eapPeerConfig->identity = (unsigned char *)identity;
243 eapPeerConfig->identity_len = strlen(identity);
244 eapPeerConfig->password = (unsigned char *)cred->password.value;
245 eapPeerConfig->password_len = cred->password.length;
248 return GSS_S_COMPLETE;
252 peerConfigFree(OM_uint32 *minor,
255 krb5_context krbContext;
256 struct eap_peer_config *eapPeerConfig = &ctx->initiatorCtx.eapPeerConfig;
258 GSSEAP_KRB_INIT(&krbContext);
260 krb5_free_unparsed_name(krbContext, (char *)eapPeerConfig->identity);
263 return GSS_S_COMPLETE;
267 * Mark an initiator context as ready for cryptographic operations
270 initReady(OM_uint32 *minor, gss_ctx_id_t ctx, OM_uint32 reqFlags)
273 const unsigned char *key;
277 /* XXX actually check for mutual auth */
278 if (reqFlags & GSS_C_MUTUAL_FLAG)
279 ctx->gssFlags |= GSS_C_MUTUAL_FLAG;
282 /* Cache encryption type derived from selected mechanism OID */
283 major = gssEapOidToEnctype(minor, ctx->mechanismUsed, &ctx->encryptionType);
284 if (GSS_ERROR(major))
287 if (!eap_key_available(ctx->initiatorCtx.eap)) {
288 *minor = GSSEAP_KEY_UNAVAILABLE;
289 return GSS_S_UNAVAILABLE;
292 key = eap_get_eapKeyData(ctx->initiatorCtx.eap, &keyLength);
294 if (keyLength < EAP_EMSK_LEN) {
295 *minor = GSSEAP_KEY_TOO_SHORT;
296 return GSS_S_UNAVAILABLE;
299 major = gssEapDeriveRfc3961Key(minor,
300 &key[EAP_EMSK_LEN / 2],
304 if (GSS_ERROR(major))
307 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
309 if (GSS_ERROR(major))
312 major = sequenceInit(minor,
315 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
316 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
318 if (GSS_ERROR(major))
322 return GSS_S_COMPLETE;
326 initBegin(OM_uint32 *minor,
333 gss_channel_bindings_t chanBindings,
334 gss_buffer_t inputToken,
335 gss_buffer_t outputToken)
339 assert(cred != GSS_C_NO_CREDENTIAL);
341 if (cred->expiryTime)
342 ctx->expiryTime = cred->expiryTime;
343 else if (timeReq == 0 || timeReq == GSS_C_INDEFINITE)
346 ctx->expiryTime = time(NULL) + timeReq;
349 * The credential mutex protects its name, however we need to
350 * explicitly lock the acceptor name (unlikely as it may be
351 * that it has attributes set on it).
353 major = gssEapDuplicateName(minor, cred->name, &ctx->initiatorName);
354 if (GSS_ERROR(major))
357 GSSEAP_MUTEX_LOCK(&target->mutex);
359 major = gssEapDuplicateName(minor, target, &ctx->acceptorName);
360 if (GSS_ERROR(major)) {
361 GSSEAP_MUTEX_UNLOCK(&target->mutex);
365 GSSEAP_MUTEX_UNLOCK(&target->mutex);
367 if (mech == GSS_C_NULL_OID) {
368 major = gssEapDefaultMech(minor, &ctx->mechanismUsed);
369 } else if (gssEapIsConcreteMechanismOid(mech)) {
370 if (!gssEapInternalizeOid(mech, &ctx->mechanismUsed))
371 major = duplicateOid(minor, mech, &ctx->mechanismUsed);
373 major = GSS_S_BAD_MECH;
374 *minor = GSSEAP_WRONG_MECH;
376 if (GSS_ERROR(major))
379 /* If credentials were provided, check they're usable with this mech */
380 if (!gssEapCredAvailable(cred, ctx->mechanismUsed)) {
381 *minor = GSSEAP_CRED_MECH_MISMATCH;
382 return GSS_S_BAD_MECH;
386 return GSS_S_COMPLETE;
390 eapGssSmInitIdentity(OM_uint32 *minor,
397 gss_channel_bindings_t chanBindings,
398 gss_buffer_t inputToken,
399 gss_buffer_t outputToken)
402 int initialContextToken;
404 initialContextToken = (inputToken->length == 0);
405 if (!initialContextToken) {
406 *minor = GSSEAP_WRONG_SIZE;
407 return GSS_S_DEFECTIVE_TOKEN;
410 major = initBegin(minor, cred, ctx, target, mech,
411 reqFlags, timeReq, chanBindings,
412 inputToken, outputToken);
413 if (GSS_ERROR(major))
416 ctx->state = GSSEAP_STATE_AUTHENTICATE;
419 return GSS_S_CONTINUE_NEEDED;
422 static struct wpabuf emptyWpaBuffer;
425 eapGssSmInitAuthenticate(OM_uint32 *minor,
432 gss_channel_bindings_t chanBindings,
433 gss_buffer_t inputToken,
434 gss_buffer_t outputToken)
439 struct wpabuf *resp = NULL;
440 int initialContextToken;
444 initialContextToken = (inputToken == GSS_C_NO_BUFFER ||
445 inputToken->length == 0);
447 major = peerConfigInit(minor, cred, ctx);
448 if (GSS_ERROR(major))
451 if (ctx->initiatorCtx.eap == NULL) {
452 struct eap_config eapConfig;
454 memset(&eapConfig, 0, sizeof(eapConfig));
456 ctx->initiatorCtx.eap = eap_peer_sm_init(ctx,
457 &gssEapPolicyCallbacks,
460 if (ctx->initiatorCtx.eap == NULL) {
461 major = GSS_S_FAILURE;
462 *minor = GSSEAP_PEER_SM_INIT_FAILURE;
466 ctx->flags |= CTX_FLAG_EAP_RESTART | CTX_FLAG_EAP_PORT_ENABLED;
469 ctx->flags |= CTX_FLAG_EAP_REQ; /* we have a Request from the acceptor */
471 wpabuf_set(&ctx->initiatorCtx.reqData,
472 inputToken->value, inputToken->length);
474 major = GSS_S_CONTINUE_NEEDED;
476 code = eap_peer_sm_step(ctx->initiatorCtx.eap);
477 if (ctx->flags & CTX_FLAG_EAP_RESP) {
478 ctx->flags &= ~(CTX_FLAG_EAP_RESP);
480 resp = eap_get_eapRespData(ctx->initiatorCtx.eap);
481 } else if (ctx->flags & CTX_FLAG_EAP_SUCCESS) {
482 major = initReady(minor, ctx, reqFlags);
483 if (GSS_ERROR(major))
486 ctx->flags &= ~(CTX_FLAG_EAP_SUCCESS);
487 major = GSS_S_CONTINUE_NEEDED;
488 ctx->state = GSSEAP_STATE_EXTENSIONS_REQ;
489 } else if (ctx->flags & CTX_FLAG_EAP_FAIL) {
490 major = GSS_S_DEFECTIVE_CREDENTIAL;
491 *minor = GSSEAP_PEER_AUTH_FAILURE;
492 } else if (code == 0 && initialContextToken) {
493 resp = &emptyWpaBuffer;
494 major = GSS_S_CONTINUE_NEEDED;
496 major = GSS_S_DEFECTIVE_TOKEN;
497 *minor = GSSEAP_PEER_BAD_MESSAGE;
503 gss_buffer_desc respBuf;
505 assert(major == GSS_S_CONTINUE_NEEDED);
507 respBuf.length = wpabuf_len(resp);
508 respBuf.value = (void *)wpabuf_head(resp);
510 tmpMajor = duplicateBuffer(&tmpMinor, &respBuf, outputToken);
511 if (GSS_ERROR(tmpMajor)) {
517 wpabuf_set(&ctx->initiatorCtx.reqData, NULL, 0);
518 peerConfigFree(&tmpMinor, ctx);
524 eapGssSmInitExtensionsReq(OM_uint32 *minor,
531 gss_channel_bindings_t chanBindings,
532 gss_buffer_t inputToken,
533 gss_buffer_t outputToken)
537 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
538 if (GSS_ERROR(major))
541 assert(outputToken->value != NULL);
543 ctx->state = GSSEAP_STATE_EXTENSIONS_RESP;
546 return GSS_S_CONTINUE_NEEDED;
550 eapGssSmInitExtensionsResp(OM_uint32 *minor,
557 gss_channel_bindings_t chanBindings,
558 gss_buffer_t inputToken,
559 gss_buffer_t outputToken)
563 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
564 if (GSS_ERROR(major))
567 ctx->state = GSSEAP_STATE_ESTABLISHED;
570 return GSS_S_COMPLETE;
574 eapGssSmInitEstablished(OM_uint32 *minor,
581 gss_channel_bindings_t chanBindings,
582 gss_buffer_t inputToken,
583 gss_buffer_t outputToken)
585 /* Called with already established context */
586 *minor = GSSEAP_CONTEXT_ESTABLISHED;
587 return GSS_S_BAD_STATUS;
591 eapGssSmInitError(OM_uint32 *minor,
598 gss_channel_bindings_t chanBindings,
599 gss_buffer_t inputToken,
600 gss_buffer_t outputToken)
605 if (inputToken->length < 8) {
606 *minor = GSSEAP_TOK_TRUNC;
607 return GSS_S_DEFECTIVE_TOKEN;
610 p = (unsigned char *)inputToken->value;
612 major = load_uint32_be(&p[0]);
613 *minor = ERROR_TABLE_BASE_eapg + load_uint32_be(&p[4]);
615 if (!GSS_ERROR(major)) {
616 major = GSS_S_FAILURE;
617 *minor = GSSEAP_BAD_ERROR_TOKEN;
623 static struct gss_eap_initiator_sm {
624 enum gss_eap_token_type inputTokenType;
625 enum gss_eap_token_type outputTokenType;
626 OM_uint32 (*processToken)(OM_uint32 *,
633 gss_channel_bindings_t,
636 } eapGssInitiatorSm[] = {
637 { TOK_TYPE_NONE, TOK_TYPE_EAP_RESP, eapGssSmInitIdentity },
638 { TOK_TYPE_EAP_REQ, TOK_TYPE_EAP_RESP, eapGssSmInitAuthenticate },
639 { TOK_TYPE_NONE, TOK_TYPE_EXT_REQ, eapGssSmInitExtensionsReq },
640 { TOK_TYPE_EXT_RESP, TOK_TYPE_NONE, eapGssSmInitExtensionsResp },
641 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmInitEstablished },
642 { TOK_TYPE_CONTEXT_ERR, TOK_TYPE_NONE, eapGssSmInitError },
643 #ifdef GSSEAP_ENABLE_REAUTH
644 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmInitGssReauth },
649 gss_init_sec_context(OM_uint32 *minor,
651 gss_ctx_id_t *context_handle,
652 gss_name_t target_name,
656 gss_channel_bindings_t input_chan_bindings,
657 gss_buffer_t input_token,
658 gss_OID *actual_mech_type,
659 gss_buffer_t output_token,
660 OM_uint32 *ret_flags,
664 OM_uint32 tmpMajor, tmpMinor;
665 gss_ctx_id_t ctx = *context_handle;
666 struct gss_eap_initiator_sm *sm = NULL;
667 gss_buffer_desc innerInputToken;
668 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
669 enum gss_eap_token_type tokType;
670 gss_cred_id_t defaultCred = GSS_C_NO_CREDENTIAL;
671 int initialContextToken = 0;
675 output_token->length = 0;
676 output_token->value = NULL;
678 if (ctx == GSS_C_NO_CONTEXT) {
679 if (input_token != GSS_C_NO_BUFFER && input_token->length != 0) {
680 *minor = GSSEAP_WRONG_SIZE;
681 return GSS_S_DEFECTIVE_TOKEN;
684 major = gssEapAllocContext(minor, &ctx);
685 if (GSS_ERROR(major))
688 ctx->flags |= CTX_FLAG_INITIATOR;
690 initialContextToken = 1;
691 *context_handle = ctx;
694 GSSEAP_MUTEX_LOCK(&ctx->mutex);
696 if (cred == GSS_C_NO_CREDENTIAL) {
697 if (ctx->initiatorCtx.defaultCred == GSS_C_NO_CREDENTIAL) {
698 major = gssEapAcquireCred(minor,
707 if (GSS_ERROR(major))
711 cred = ctx->initiatorCtx.defaultCred;
714 GSSEAP_MUTEX_LOCK(&cred->mutex);
716 #ifdef GSSEAP_ENABLE_REAUTH
717 if (initialContextToken && gssEapCanReauthP(cred, target_name, time_req))
718 ctx->state = GSSEAP_STATE_KRB_REAUTH;
721 if ((cred->flags & CRED_FLAG_INITIATE) == 0) {
722 major = GSS_S_NO_CRED;
723 *minor = GSSEAP_CRED_USAGE_MISMATCH;
727 sm = &eapGssInitiatorSm[ctx->state];
729 if (input_token != GSS_C_NO_BUFFER) {
730 major = gssEapVerifyToken(minor, ctx, input_token,
731 &tokType, &innerInputToken);
732 if (GSS_ERROR(major))
735 if (tokType == TOK_TYPE_CONTEXT_ERR) {
736 ctx->state = GSSEAP_STATE_ERROR;
737 } else if (tokType != sm->inputTokenType) {
738 major = GSS_S_DEFECTIVE_TOKEN;
739 *minor = GSSEAP_WRONG_TOK_ID;
743 innerInputToken.length = 0;
744 innerInputToken.value = NULL;
748 * Advance through state machine whilst empty tokens are emitted and
749 * the status is not GSS_S_COMPLETE or an error status.
752 sm = &eapGssInitiatorSm[ctx->state];
754 major = (sm->processToken)(minor,
764 if (GSS_ERROR(major))
766 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.value == NULL);
768 if (actual_mech_type != NULL) {
769 if (!gssEapInternalizeOid(ctx->mechanismUsed, actual_mech_type))
770 duplicateOid(&tmpMinor, ctx->mechanismUsed, actual_mech_type);
772 if (innerOutputToken.value != NULL) {
773 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
774 sm->outputTokenType, output_token);
775 if (GSS_ERROR(tmpMajor)) {
781 if (ret_flags != NULL)
782 *ret_flags = ctx->gssFlags;
783 if (time_rec != NULL)
784 gssEapContextTime(&tmpMinor, ctx, time_rec);
786 assert(ctx->state == GSSEAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
789 if (cred != GSS_C_NO_CREDENTIAL)
790 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
791 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
793 if (GSS_ERROR(major))
794 gssEapReleaseContext(&tmpMinor, context_handle);
796 gss_release_buffer(&tmpMinor, &innerOutputToken);
801 #ifdef GSSEAP_ENABLE_REAUTH
803 eapGssSmInitGssReauth(OM_uint32 *minor,
810 gss_channel_bindings_t chanBindings,
811 gss_buffer_t inputToken,
812 gss_buffer_t outputToken)
814 OM_uint32 major, tmpMinor;
815 gss_name_t mechTarget = GSS_C_NO_NAME;
816 gss_OID actualMech = GSS_C_NO_OID;
817 OM_uint32 gssFlags, timeRec;
819 assert(cred != GSS_C_NO_CREDENTIAL);
821 ctx->flags |= CTX_FLAG_KRB_REAUTH;
823 if (inputToken->length == 0) {
824 major = initBegin(minor, cred, ctx, target, mech,
825 reqFlags, timeReq, chanBindings,
826 inputToken, outputToken);
827 if (GSS_ERROR(major))
831 major = gssEapMechToGlueName(minor, target, &mechTarget);
832 if (GSS_ERROR(major))
835 major = gssInitSecContext(minor,
839 (gss_OID)gss_mech_krb5,
840 reqFlags, /* | GSS_C_DCE_STYLE, */
848 if (GSS_ERROR(major))
851 ctx->gssFlags = gssFlags;
853 if (major == GSS_S_COMPLETE) {
854 major = gssEapReauthComplete(minor, ctx, cred, actualMech, timeRec);
855 if (GSS_ERROR(major))
857 ctx->state = GSSEAP_STATE_ESTABLISHED;
861 gssReleaseName(&tmpMinor, &mechTarget);
865 #endif /* GSSEAP_ENABLE_REAUTH */