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 acceptor (server). These functions
35 * wrap around libradsec and (thus) talk to a RADIUS server or proxy.
38 #include "gssapiP_eap.h"
40 #ifdef GSSEAP_ENABLE_REAUTH
42 eapGssSmAcceptGssReauth(OM_uint32 *minor,
45 gss_buffer_t inputToken,
46 gss_channel_bindings_t chanBindings,
47 gss_buffer_t outputToken);
51 * Mark an acceptor context as ready for cryptographic operations
54 acceptReadyEap(OM_uint32 *minor, gss_ctx_id_t ctx, gss_cred_id_t cred)
56 OM_uint32 major, tmpMinor;
58 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
60 /* Cache encryption type derived from selected mechanism OID */
61 major = gssEapOidToEnctype(minor, ctx->mechanismUsed,
62 &ctx->encryptionType);
66 gssEapReleaseName(&tmpMinor, &ctx->initiatorName);
68 major = gssEapRadiusGetRawAvp(minor, ctx->acceptorCtx.vps,
69 PW_USER_NAME, 0, &vp);
70 if (major == GSS_S_COMPLETE) {
71 nameBuf.length = vp->length;
72 nameBuf.value = vp->vp_strvalue;
74 ctx->gssFlags |= GSS_C_ANON_FLAG;
77 major = gssEapImportName(minor, &nameBuf, GSS_C_NT_USER_NAME,
82 major = gssEapRadiusGetRawAvp(minor, ctx->acceptorCtx.vps,
83 PW_MS_MPPE_SEND_KEY, VENDORPEC_MS, &vp);
84 if (GSS_ERROR(major)) {
85 *minor = GSSEAP_KEY_UNAVAILABLE;
86 return GSS_S_UNAVAILABLE;
89 major = gssEapDeriveRfc3961Key(minor,
97 major = rfc3961ChecksumTypeForKey(minor, &ctx->rfc3961Key,
102 major = sequenceInit(minor,
103 &ctx->seqState, ctx->recvSeq,
104 ((ctx->gssFlags & GSS_C_REPLAY_FLAG) != 0),
105 ((ctx->gssFlags & GSS_C_SEQUENCE_FLAG) != 0),
107 if (GSS_ERROR(major))
110 major = gssEapCreateAttrContext(minor, cred, ctx,
111 &ctx->initiatorName->attrCtx,
113 if (GSS_ERROR(major))
117 return GSS_S_COMPLETE;
121 * Emit a identity EAP request to force the initiator (peer) to identify
125 eapGssSmAcceptIdentity(OM_uint32 *minor,
128 gss_buffer_t inputToken,
129 gss_channel_bindings_t chanBindings,
130 gss_buffer_t outputToken)
135 unsigned char data[5];
137 gss_buffer_desc pktBuffer;
139 if (inputToken != GSS_C_NO_BUFFER && inputToken->length != 0) {
140 *minor = GSSEAP_WRONG_SIZE;
141 return GSS_S_DEFECTIVE_TOKEN;
144 assert(ctx->acceptorName == GSS_C_NO_NAME);
146 if (cred->name != GSS_C_NO_NAME) {
147 major = gssEapDuplicateName(minor, cred->name, &ctx->acceptorName);
148 if (GSS_ERROR(major))
152 pkt.pdu.code = EAP_CODE_REQUEST;
153 pkt.pdu.identifier = 0;
154 pkt.pdu.length = htons(sizeof(pkt.data));
155 pkt.data[4] = EAP_TYPE_IDENTITY;
157 pktBuffer.length = sizeof(pkt.data);
158 pktBuffer.value = pkt.data;
160 major = duplicateBuffer(minor, &pktBuffer, outputToken);
161 if (GSS_ERROR(major))
164 ctx->state = GSSEAP_STATE_AUTHENTICATE;
167 return GSS_S_CONTINUE_NEEDED;
171 * Pass the asserted acceptor identity to the authentication server.
174 setAcceptorIdentity(OM_uint32 *minor,
179 gss_buffer_desc nameBuf;
180 krb5_context krbContext = NULL;
181 krb5_principal krbPrinc;
182 struct rs_context *rc = ctx->acceptorCtx.radContext;
186 if (ctx->acceptorName == GSS_C_NO_NAME) {
188 return GSS_S_COMPLETE;
191 if ((ctx->acceptorName->flags & NAME_FLAG_SERVICE) == 0) {
192 *minor = GSSEAP_BAD_SERVICE_NAME;
193 return GSS_S_BAD_NAME;
196 GSSEAP_KRB_INIT(&krbContext);
198 krbPrinc = ctx->acceptorName->krbPrincipal;
199 assert(krbPrinc != NULL);
200 assert(KRB_PRINC_LENGTH(krbPrinc) >= 2);
202 /* Acceptor-Service-Name */
203 krbPrincComponentToGssBuffer(krbPrinc, 0, &nameBuf);
205 major = gssEapRadiusAddAvp(minor, vps,
206 PW_GSS_ACCEPTOR_SERVICE_NAME,
209 if (GSS_ERROR(major))
212 /* Acceptor-Host-Name */
213 krbPrincComponentToGssBuffer(krbPrinc, 1, &nameBuf);
215 major = gssEapRadiusAddAvp(minor, vps,
216 PW_GSS_ACCEPTOR_HOST_NAME,
219 if (GSS_ERROR(major))
222 if (KRB_PRINC_LENGTH(krbPrinc) > 2) {
223 /* Acceptor-Service-Specific */
224 krb5_principal_data ssiPrinc = *krbPrinc;
227 KRB_PRINC_LENGTH(&ssiPrinc) -= 2;
228 KRB_PRINC_NAME(&ssiPrinc) += 2;
230 *minor = krb5_unparse_name_flags(krbContext, &ssiPrinc,
231 KRB5_PRINCIPAL_UNPARSE_NO_REALM, &ssi);
233 return GSS_S_FAILURE;
236 nameBuf.length = strlen(ssi);
238 major = gssEapRadiusAddAvp(minor, vps,
239 PW_GSS_ACCEPTOR_SERVICE_SPECIFIC,
243 if (GSS_ERROR(major)) {
244 krb5_free_unparsed_name(krbContext, ssi);
247 krb5_free_unparsed_name(krbContext, ssi);
250 krbPrincRealmToGssBuffer(krbPrinc, &nameBuf);
251 if (nameBuf.length != 0) {
252 /* Acceptor-Realm-Name */
253 major = gssEapRadiusAddAvp(minor, vps,
254 PW_GSS_ACCEPTOR_REALM_NAME,
257 if (GSS_ERROR(major))
262 return GSS_S_COMPLETE;
266 * Allocate a RadSec handle
269 createRadiusHandle(OM_uint32 *minor,
273 struct gss_eap_acceptor_ctx *actx = &ctx->acceptorCtx;
274 const char *configFile = RS_CONFIG_FILE;
275 const char *configStanza = "gss-eap";
276 struct rs_alloc_scheme ralloc;
277 struct rs_error *err;
279 assert(actx->radContext == NULL);
280 assert(actx->radConn == NULL);
282 if (rs_context_create(&actx->radContext, RS_DICT_FILE) != 0) {
283 *minor = GSSEAP_RADSEC_CONTEXT_FAILURE;
284 return GSS_S_FAILURE;
287 if (cred->radiusConfigFile != NULL)
288 configFile = cred->radiusConfigFile;
289 if (cred->radiusConfigStanza != NULL)
290 configStanza = cred->radiusConfigStanza;
292 ralloc.calloc = GSSEAP_CALLOC;
293 ralloc.malloc = GSSEAP_MALLOC;
294 ralloc.free = GSSEAP_FREE;
295 ralloc.realloc = GSSEAP_REALLOC;
297 rs_context_set_alloc_scheme(actx->radContext, &ralloc);
299 if (rs_context_read_config(actx->radContext, configFile) != 0) {
300 err = rs_err_ctx_pop(actx->radContext);
304 if (rs_conn_create(actx->radContext, &actx->radConn, configStanza) != 0) {
305 err = rs_err_conn_pop(actx->radConn);
309 if (actx->radServer != NULL) {
310 if (rs_conn_select_peer(actx->radConn, actx->radServer) != 0) {
311 err = rs_err_conn_pop(actx->radConn);
317 return GSS_S_COMPLETE;
320 return gssEapRadiusMapError(minor, err);
324 * Process a EAP response from the initiator.
327 eapGssSmAcceptAuthenticate(OM_uint32 *minor,
330 gss_buffer_t inputToken,
331 gss_channel_bindings_t chanBindings,
332 gss_buffer_t outputToken)
334 OM_uint32 major, tmpMinor;
335 struct rs_connection *rconn;
336 struct rs_request *request = NULL;
337 struct rs_packet *req = NULL, *resp = NULL;
338 struct radius_packet *frreq, *frresp;
339 int sendAcceptorIdentity = 0;
341 if (ctx->acceptorCtx.radContext == NULL) {
342 /* May be NULL from an imported partial context */
343 major = createRadiusHandle(minor, cred, ctx);
344 if (GSS_ERROR(major))
347 sendAcceptorIdentity = 1;
350 rconn = ctx->acceptorCtx.radConn;
352 if (rs_packet_create_authn_request(rconn, &req, NULL, NULL) != 0) {
353 major = gssEapRadiusMapError(minor, rs_err_conn_pop(rconn));
356 frreq = rs_packet_frpkt(req);
358 if (sendAcceptorIdentity) {
359 major = setAcceptorIdentity(minor, ctx, &frreq->vps);
360 if (GSS_ERROR(major))
364 major = gssEapRadiusAddAvp(minor, &frreq->vps,
365 PW_EAP_MESSAGE, 0, inputToken);
366 if (GSS_ERROR(major))
369 if (ctx->acceptorCtx.state.length != 0) {
370 major = gssEapRadiusAddAvp(minor, &frreq->vps, PW_STATE, 0,
371 &ctx->acceptorCtx.state);
372 if (GSS_ERROR(major))
375 gss_release_buffer(&tmpMinor, &ctx->acceptorCtx.state);
378 if (rs_request_create(rconn, &request) != 0) {
379 major = gssEapRadiusMapError(minor, rs_err_conn_pop(rconn));
383 rs_request_add_reqpkt(request, req);
386 if (rs_request_send(request, &resp) != 0) {
387 major = gssEapRadiusMapError(minor, rs_err_conn_pop(rconn));
391 assert(resp != NULL);
393 frresp = rs_packet_frpkt(resp);
394 switch (frresp->code) {
395 case PW_AUTHENTICATION_ACK:
396 case PW_ACCESS_CHALLENGE:
397 major = GSS_S_CONTINUE_NEEDED;
399 case PW_AUTHENTICATION_REJECT:
400 *minor = GSSEAP_RADIUS_AUTH_FAILURE;
401 major = GSS_S_DEFECTIVE_CREDENTIAL;
405 *minor = GSSEAP_UNKNOWN_RADIUS_CODE;
406 major = GSS_S_FAILURE;
411 major = gssEapRadiusGetAvp(minor, frresp->vps, PW_EAP_MESSAGE, 0,
413 if (major == GSS_S_UNAVAILABLE && frresp->code == PW_ACCESS_CHALLENGE) {
414 *minor = GSSEAP_MISSING_EAP_REQUEST;
415 major = GSS_S_DEFECTIVE_TOKEN;
417 } else if (GSS_ERROR(major))
420 if (frresp->code == PW_ACCESS_CHALLENGE) {
421 major = gssEapRadiusGetAvp(minor, frresp->vps, PW_STATE, 0,
422 &ctx->acceptorCtx.state, TRUE);
423 if (GSS_ERROR(major) && *minor != GSSEAP_NO_SUCH_ATTR)
426 ctx->acceptorCtx.vps = frresp->vps;
429 rs_conn_destroy(ctx->acceptorCtx.radConn);
430 ctx->acceptorCtx.radConn = NULL;
432 major = acceptReadyEap(minor, ctx, cred);
433 if (GSS_ERROR(major))
436 ctx->state = GSSEAP_STATE_EXTENSIONS_REQ;
440 major = GSS_S_CONTINUE_NEEDED;
444 rs_request_destroy(request);
446 rs_packet_destroy(req);
452 eapGssSmAcceptExtensionsReq(OM_uint32 *minor,
455 gss_buffer_t inputToken,
456 gss_channel_bindings_t chanBindings,
457 gss_buffer_t outputToken)
461 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
462 if (GSS_ERROR(major))
465 outputToken->length = 0;
466 outputToken->value = NULL;
468 ctx->state = GSSEAP_STATE_EXTENSIONS_RESP;
471 return GSS_S_CONTINUE_NEEDED;
475 eapGssSmAcceptExtensionsResp(OM_uint32 *minor,
478 gss_buffer_t inputToken,
479 gss_channel_bindings_t chanBindings,
480 gss_buffer_t outputToken)
484 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
485 if (GSS_ERROR(major))
488 ctx->state = GSSEAP_STATE_ESTABLISHED;
491 return GSS_S_COMPLETE;
495 eapGssSmAcceptEstablished(OM_uint32 *minor,
498 gss_buffer_t inputToken,
499 gss_channel_bindings_t chanBindings,
500 gss_buffer_t outputToken)
502 /* Called with already established context */
503 *minor = GSSEAP_CONTEXT_ESTABLISHED;
504 return GSS_S_BAD_STATUS;
508 makeErrorToken(OM_uint32 *minor,
509 OM_uint32 majorStatus,
510 OM_uint32 minorStatus,
511 gss_buffer_t outputToken)
513 unsigned char errorData[8];
514 gss_buffer_desc errorBuffer;
516 assert(GSS_ERROR(majorStatus));
519 * Only return error codes that the initiator could have caused,
520 * to avoid information leakage.
522 if (IS_RADIUS_ERROR(minorStatus)) {
523 /* Squash RADIUS error codes */
524 minorStatus = GSSEAP_RADIUS_PROT_FAILURE;
525 } else if (!IS_WIRE_ERROR(minorStatus)) {
526 /* Don't return non-wire error codes */
527 return GSS_S_COMPLETE;
530 minorStatus -= ERROR_TABLE_BASE_eapg;
532 store_uint32_be(majorStatus, &errorData[0]);
533 store_uint32_be(minorStatus, &errorData[4]);
535 errorBuffer.length = sizeof(errorData);
536 errorBuffer.value = errorData;
538 return duplicateBuffer(minor, &errorBuffer, outputToken);
541 static struct gss_eap_acceptor_sm {
542 enum gss_eap_token_type inputTokenType;
543 enum gss_eap_token_type outputTokenType;
544 OM_uint32 (*processToken)(OM_uint32 *,
548 gss_channel_bindings_t,
550 } eapGssAcceptorSm[] = {
551 { TOK_TYPE_EAP_RESP, TOK_TYPE_EAP_REQ, eapGssSmAcceptIdentity },
552 { TOK_TYPE_EAP_RESP, TOK_TYPE_EAP_REQ, eapGssSmAcceptAuthenticate },
553 { TOK_TYPE_EXT_REQ, TOK_TYPE_NONE, eapGssSmAcceptExtensionsReq },
554 { TOK_TYPE_NONE, TOK_TYPE_EXT_RESP, eapGssSmAcceptExtensionsResp },
555 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmAcceptEstablished },
556 { TOK_TYPE_NONE, TOK_TYPE_CONTEXT_ERR, NULL },
557 #ifdef GSSEAP_ENABLE_REAUTH
558 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmAcceptGssReauth },
563 gss_accept_sec_context(OM_uint32 *minor,
564 gss_ctx_id_t *context_handle,
566 gss_buffer_t input_token,
567 gss_channel_bindings_t input_chan_bindings,
568 gss_name_t *src_name,
570 gss_buffer_t output_token,
571 OM_uint32 *ret_flags,
573 gss_cred_id_t *delegated_cred_handle)
576 OM_uint32 tmpMajor, tmpMinor;
577 gss_ctx_id_t ctx = *context_handle;
578 struct gss_eap_acceptor_sm *sm = NULL;
579 gss_buffer_desc innerInputToken = GSS_C_EMPTY_BUFFER;
580 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
581 enum gss_eap_token_type tokType;
582 int initialContextToken = 0;
586 output_token->length = 0;
587 output_token->value = NULL;
589 if (input_token == GSS_C_NO_BUFFER || input_token->length == 0) {
590 *minor = GSSEAP_TOK_TRUNC;
591 return GSS_S_DEFECTIVE_TOKEN;
594 if (ctx == GSS_C_NO_CONTEXT) {
595 major = gssEapAllocContext(minor, &ctx);
596 if (GSS_ERROR(major))
599 initialContextToken = 1;
600 *context_handle = ctx;
603 GSSEAP_MUTEX_LOCK(&ctx->mutex);
605 if (cred == GSS_C_NO_CREDENTIAL) {
606 if (ctx->defaultCred == GSS_C_NO_CREDENTIAL) {
607 major = gssEapAcquireCred(minor,
616 if (GSS_ERROR(major))
620 cred = ctx->defaultCred;
623 GSSEAP_MUTEX_LOCK(&cred->mutex);
625 sm = &eapGssAcceptorSm[ctx->state];
627 major = gssEapVerifyToken(minor, ctx, input_token,
628 &tokType, &innerInputToken);
629 if (GSS_ERROR(major))
632 if (!gssEapCredAvailable(cred, ctx->mechanismUsed)) {
633 *minor = GSSEAP_CRED_MECH_MISMATCH;
634 major = GSS_S_BAD_MECH;
638 #ifdef GSSEAP_ENABLE_REAUTH
640 * If we're built with fast reauthentication support, it's valid
641 * for an initiator to send a GSS reauthentication token as its
642 * initial context token, causing us to short-circuit the state
643 * machine and process Kerberos GSS messages instead.
645 if (tokType == TOK_TYPE_GSS_REAUTH && initialContextToken) {
646 ctx->state = GSSEAP_STATE_KRB_REAUTH;
649 if (tokType != sm->inputTokenType) {
650 *minor = GSSEAP_WRONG_TOK_ID;
651 major = GSS_S_DEFECTIVE_TOKEN;
656 sm = &eapGssAcceptorSm[ctx->state];
658 major = (sm->processToken)(minor,
664 if (GSS_ERROR(major)) {
665 /* Possibly generate an error token */
666 tmpMajor = makeErrorToken(&tmpMinor, major, *minor, &innerOutputToken);
667 if (GSS_ERROR(tmpMajor)) {
672 sm = &eapGssAcceptorSm[GSSEAP_STATE_ERROR];
675 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.length == 0);
677 if (mech_type != NULL) {
678 if (!gssEapInternalizeOid(ctx->mechanismUsed, mech_type))
679 duplicateOid(&tmpMinor, ctx->mechanismUsed, mech_type);
681 if (ret_flags != NULL)
682 *ret_flags = ctx->gssFlags;
683 if (delegated_cred_handle != NULL)
684 *delegated_cred_handle = GSS_C_NO_CREDENTIAL;
686 if (major == GSS_S_COMPLETE) {
687 if (src_name != NULL && ctx->initiatorName != GSS_C_NO_NAME) {
688 major = gssEapDuplicateName(&tmpMinor, ctx->initiatorName, src_name);
689 if (GSS_ERROR(major))
692 if (time_rec != NULL) {
693 major = gssEapContextTime(&tmpMinor, ctx, time_rec);
694 if (GSS_ERROR(major))
699 assert(ctx->state == GSSEAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
702 if (innerOutputToken.value != NULL) {
703 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
704 sm->outputTokenType, output_token);
705 if (GSS_ERROR(tmpMajor)) {
713 if (cred != GSS_C_NO_CREDENTIAL)
714 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
715 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
717 if (GSS_ERROR(major))
718 gssEapReleaseContext(&tmpMinor, context_handle);
720 gss_release_buffer(&tmpMinor, &innerOutputToken);
725 #ifdef GSSEAP_ENABLE_REAUTH
727 acceptReadyKrb(OM_uint32 *minor,
730 const gss_name_t initiator,
736 major = gssEapGlueToMechName(minor, ctx, initiator, &ctx->initiatorName);
737 if (GSS_ERROR(major))
740 if (cred->name != GSS_C_NO_NAME) {
741 major = gssEapDuplicateName(minor, cred->name, &ctx->acceptorName);
742 if (GSS_ERROR(major))
746 major = gssEapReauthComplete(minor, ctx, cred, mech, timeRec);
747 if (GSS_ERROR(major))
750 ctx->state = GSSEAP_STATE_ESTABLISHED;
753 return GSS_S_COMPLETE;
757 eapGssSmAcceptGssReauth(OM_uint32 *minor,
760 gss_buffer_t inputToken,
761 gss_channel_bindings_t chanBindings,
762 gss_buffer_t outputToken)
764 OM_uint32 major, tmpMinor;
765 gss_name_t krbInitiator = GSS_C_NO_NAME;
766 gss_OID mech = GSS_C_NO_OID;
767 OM_uint32 gssFlags, timeRec = GSS_C_INDEFINITE;
769 ctx->flags |= CTX_FLAG_KRB_REAUTH;
771 major = gssAcceptSecContext(minor,
782 if (major == GSS_S_COMPLETE) {
783 major = acceptReadyKrb(minor, ctx, cred,
784 krbInitiator, mech, timeRec);
787 ctx->gssFlags = gssFlags;
789 gssReleaseName(&tmpMinor, &krbInitiator);
793 #endif /* GSSEAP_ENABLE_REAUTH */