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 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 != GSS_C_NO_CREDENTIAL && 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 != GSS_C_NO_CREDENTIAL) {
288 if (cred->radiusConfigFile != NULL)
289 configFile = cred->radiusConfigFile;
290 if (cred->radiusConfigStanza != NULL)
291 configStanza = cred->radiusConfigStanza;
294 ralloc.calloc = GSSEAP_CALLOC;
295 ralloc.malloc = GSSEAP_MALLOC;
296 ralloc.free = GSSEAP_FREE;
297 ralloc.realloc = GSSEAP_REALLOC;
299 rs_context_set_alloc_scheme(actx->radContext, &ralloc);
301 if (rs_context_read_config(actx->radContext, configFile) != 0) {
302 err = rs_err_ctx_pop(actx->radContext);
306 if (rs_conn_create(actx->radContext, &actx->radConn, configStanza) != 0) {
307 err = rs_err_conn_pop(actx->radConn);
311 if (actx->radServer != NULL) {
312 if (rs_conn_select_server(actx->radConn, actx->radServer) != 0) {
313 err = rs_err_conn_pop(actx->radConn);
319 return GSS_S_COMPLETE;
322 return gssEapRadiusMapError(minor, err);
326 * Process a EAP response from the initiator.
329 eapGssSmAcceptAuthenticate(OM_uint32 *minor,
332 gss_buffer_t inputToken,
333 gss_channel_bindings_t chanBindings,
334 gss_buffer_t outputToken)
336 OM_uint32 major, tmpMinor;
337 struct rs_connection *rconn;
338 struct rs_request *request = NULL;
339 struct rs_packet *req = NULL, *resp = NULL;
340 struct radius_packet *frreq, *frresp;
341 int sendAcceptorIdentity = 0;
343 if (ctx->acceptorCtx.radContext == NULL) {
344 /* May be NULL from an imported partial context */
345 major = createRadiusHandle(minor, cred, ctx);
346 if (GSS_ERROR(major))
349 sendAcceptorIdentity = 1;
352 rconn = ctx->acceptorCtx.radConn;
354 if (rs_packet_create_acc_request(rconn, &req, NULL, NULL) != 0) {
355 major = gssEapRadiusMapError(minor, rs_err_conn_pop(rconn));
358 frreq = rs_packet_frpkt(req);
360 if (sendAcceptorIdentity) {
361 major = setAcceptorIdentity(minor, ctx, &frreq->vps);
362 if (GSS_ERROR(major))
366 major = gssEapRadiusAddAvp(minor, &frreq->vps,
367 PW_EAP_MESSAGE, 0, inputToken);
368 if (GSS_ERROR(major))
371 if (ctx->acceptorCtx.state.length != 0) {
372 major = gssEapRadiusAddAvp(minor, &frreq->vps, PW_STATE, 0,
373 &ctx->acceptorCtx.state);
374 if (GSS_ERROR(major))
377 gss_release_buffer(&tmpMinor, &ctx->acceptorCtx.state);
380 if (rs_request_create(rconn, &request) != 0 ||
381 rs_request_send(request, req, &resp) != 0) {
382 major = gssEapRadiusMapError(minor, rs_err_conn_pop(rconn));
386 assert(resp != NULL);
388 frresp = rs_packet_frpkt(resp);
389 switch (frresp->code) {
390 case PW_AUTHENTICATION_ACK:
391 case PW_ACCESS_CHALLENGE:
392 major = GSS_S_CONTINUE_NEEDED;
394 case PW_AUTHENTICATION_REJECT:
395 *minor = GSSEAP_RADIUS_AUTH_FAILURE;
396 major = GSS_S_DEFECTIVE_CREDENTIAL;
400 *minor = GSSEAP_UNKNOWN_RADIUS_CODE;
401 major = GSS_S_FAILURE;
406 major = gssEapRadiusGetAvp(minor, frresp->vps, PW_EAP_MESSAGE, 0,
408 if (major == GSS_S_UNAVAILABLE && frresp->code == PW_ACCESS_CHALLENGE) {
409 *minor = GSSEAP_MISSING_EAP_REQUEST;
410 major = GSS_S_DEFECTIVE_TOKEN;
412 } else if (GSS_ERROR(major))
415 if (frresp->code == PW_ACCESS_CHALLENGE) {
416 major = gssEapRadiusGetAvp(minor, frresp->vps, PW_STATE, 0,
417 &ctx->acceptorCtx.state, TRUE);
418 if (GSS_ERROR(major) && *minor != GSSEAP_NO_SUCH_ATTR)
421 ctx->acceptorCtx.vps = frresp->vps;
424 rs_conn_destroy(ctx->acceptorCtx.radConn);
425 ctx->acceptorCtx.radConn = NULL;
427 major = acceptReadyEap(minor, ctx, cred);
428 if (GSS_ERROR(major))
431 ctx->state = GSSEAP_STATE_EXTENSIONS_REQ;
435 major = GSS_S_CONTINUE_NEEDED;
438 rs_request_destroy(request);
444 eapGssSmAcceptExtensionsReq(OM_uint32 *minor,
447 gss_buffer_t inputToken,
448 gss_channel_bindings_t chanBindings,
449 gss_buffer_t outputToken)
453 major = gssEapVerifyExtensions(minor, cred, ctx, chanBindings, inputToken);
454 if (GSS_ERROR(major))
457 outputToken->length = 0;
458 outputToken->value = NULL;
460 ctx->state = GSSEAP_STATE_EXTENSIONS_RESP;
463 return GSS_S_CONTINUE_NEEDED;
467 eapGssSmAcceptExtensionsResp(OM_uint32 *minor,
470 gss_buffer_t inputToken,
471 gss_channel_bindings_t chanBindings,
472 gss_buffer_t outputToken)
476 major = gssEapMakeExtensions(minor, cred, ctx, chanBindings, outputToken);
477 if (GSS_ERROR(major))
480 ctx->state = GSSEAP_STATE_ESTABLISHED;
483 return GSS_S_COMPLETE;
487 eapGssSmAcceptEstablished(OM_uint32 *minor,
490 gss_buffer_t inputToken,
491 gss_channel_bindings_t chanBindings,
492 gss_buffer_t outputToken)
494 /* Called with already established context */
495 *minor = GSSEAP_CONTEXT_ESTABLISHED;
496 return GSS_S_BAD_STATUS;
500 makeErrorToken(OM_uint32 *minor,
501 OM_uint32 majorStatus,
502 OM_uint32 minorStatus,
503 gss_buffer_t outputToken)
505 unsigned char errorData[8];
506 gss_buffer_desc errorBuffer;
508 assert(GSS_ERROR(majorStatus));
511 * Only return error codes that the initiator could have caused,
512 * to avoid information leakage.
514 if (IS_RADIUS_ERROR(minorStatus)) {
515 /* Squash RADIUS error codes */
516 minorStatus = GSSEAP_RADIUS_PROT_FAILURE;
517 } else if (!IS_WIRE_ERROR(minorStatus)) {
518 /* Don't return non-wire error codes */
519 return GSS_S_COMPLETE;
522 minorStatus -= ERROR_TABLE_BASE_eapg;
524 store_uint32_be(majorStatus, &errorData[0]);
525 store_uint32_be(minorStatus, &errorData[4]);
527 errorBuffer.length = sizeof(errorData);
528 errorBuffer.value = errorData;
530 return duplicateBuffer(minor, &errorBuffer, outputToken);
533 static struct gss_eap_acceptor_sm {
534 enum gss_eap_token_type inputTokenType;
535 enum gss_eap_token_type outputTokenType;
536 OM_uint32 (*processToken)(OM_uint32 *,
540 gss_channel_bindings_t,
542 } eapGssAcceptorSm[] = {
543 { TOK_TYPE_EAP_RESP, TOK_TYPE_EAP_REQ, eapGssSmAcceptIdentity },
544 { TOK_TYPE_EAP_RESP, TOK_TYPE_EAP_REQ, eapGssSmAcceptAuthenticate },
545 { TOK_TYPE_EXT_REQ, TOK_TYPE_NONE, eapGssSmAcceptExtensionsReq },
546 { TOK_TYPE_NONE, TOK_TYPE_EXT_RESP, eapGssSmAcceptExtensionsResp },
547 { TOK_TYPE_NONE, TOK_TYPE_NONE, eapGssSmAcceptEstablished },
548 { TOK_TYPE_NONE, TOK_TYPE_CONTEXT_ERR, NULL },
549 #ifdef GSSEAP_ENABLE_REAUTH
550 { TOK_TYPE_GSS_REAUTH, TOK_TYPE_GSS_REAUTH, eapGssSmAcceptGssReauth },
555 gss_accept_sec_context(OM_uint32 *minor,
556 gss_ctx_id_t *context_handle,
558 gss_buffer_t input_token,
559 gss_channel_bindings_t input_chan_bindings,
560 gss_name_t *src_name,
562 gss_buffer_t output_token,
563 OM_uint32 *ret_flags,
565 gss_cred_id_t *delegated_cred_handle)
568 OM_uint32 tmpMajor, tmpMinor;
569 gss_ctx_id_t ctx = *context_handle;
570 struct gss_eap_acceptor_sm *sm = NULL;
571 gss_buffer_desc innerInputToken = GSS_C_EMPTY_BUFFER;
572 gss_buffer_desc innerOutputToken = GSS_C_EMPTY_BUFFER;
573 enum gss_eap_token_type tokType;
574 int initialContextToken = 0;
578 output_token->length = 0;
579 output_token->value = NULL;
581 if (input_token == GSS_C_NO_BUFFER || input_token->length == 0) {
582 *minor = GSSEAP_TOK_TRUNC;
583 return GSS_S_DEFECTIVE_TOKEN;
586 if (ctx == GSS_C_NO_CONTEXT) {
587 major = gssEapAllocContext(minor, &ctx);
588 if (GSS_ERROR(major))
591 initialContextToken = 1;
592 *context_handle = ctx;
595 GSSEAP_MUTEX_LOCK(&ctx->mutex);
597 /* Validate and lock credentials */
598 if (cred != GSS_C_NO_CREDENTIAL) {
599 GSSEAP_MUTEX_LOCK(&cred->mutex);
601 if ((cred->flags & CRED_FLAG_ACCEPT) == 0) {
602 *minor = GSSEAP_CRED_USAGE_MISMATCH;
603 major = GSS_S_NO_CRED;
608 sm = &eapGssAcceptorSm[ctx->state];
610 major = gssEapVerifyToken(minor, ctx, input_token,
611 &tokType, &innerInputToken);
612 if (GSS_ERROR(major))
615 if (!gssEapCredAvailable(cred, ctx->mechanismUsed)) {
616 *minor = GSSEAP_CRED_MECH_MISMATCH;
617 major = GSS_S_BAD_MECH;
621 #ifdef GSSEAP_ENABLE_REAUTH
623 * If we're built with fast reauthentication support, it's valid
624 * for an initiator to send a GSS reauthentication token as its
625 * initial context token, causing us to short-circuit the state
626 * machine and process Kerberos GSS messages instead.
628 if (tokType == TOK_TYPE_GSS_REAUTH && initialContextToken) {
629 ctx->state = GSSEAP_STATE_KRB_REAUTH;
632 if (tokType != sm->inputTokenType) {
633 *minor = GSSEAP_WRONG_TOK_ID;
634 major = GSS_S_DEFECTIVE_TOKEN;
639 sm = &eapGssAcceptorSm[ctx->state];
641 major = (sm->processToken)(minor,
647 if (GSS_ERROR(major)) {
648 /* Possibly generate an error token */
649 tmpMajor = makeErrorToken(&tmpMinor, major, *minor, &innerOutputToken);
650 if (GSS_ERROR(tmpMajor)) {
655 sm = &eapGssAcceptorSm[GSSEAP_STATE_ERROR];
658 } while (major == GSS_S_CONTINUE_NEEDED && innerOutputToken.length == 0);
660 if (mech_type != NULL) {
661 if (!gssEapInternalizeOid(ctx->mechanismUsed, mech_type))
662 duplicateOid(&tmpMinor, ctx->mechanismUsed, mech_type);
664 if (ret_flags != NULL)
665 *ret_flags = ctx->gssFlags;
666 if (delegated_cred_handle != NULL)
667 *delegated_cred_handle = GSS_C_NO_CREDENTIAL;
669 if (major == GSS_S_COMPLETE) {
670 if (src_name != NULL && ctx->initiatorName != GSS_C_NO_NAME) {
671 major = gssEapDuplicateName(&tmpMinor, ctx->initiatorName, src_name);
672 if (GSS_ERROR(major))
675 if (time_rec != NULL) {
676 major = gssEapContextTime(&tmpMinor, ctx, time_rec);
677 if (GSS_ERROR(major))
682 assert(ctx->state == GSSEAP_STATE_ESTABLISHED || major == GSS_S_CONTINUE_NEEDED);
685 if (innerOutputToken.value != NULL) {
686 tmpMajor = gssEapMakeToken(&tmpMinor, ctx, &innerOutputToken,
687 sm->outputTokenType, output_token);
688 if (GSS_ERROR(tmpMajor)) {
696 if (cred != GSS_C_NO_CREDENTIAL)
697 GSSEAP_MUTEX_UNLOCK(&cred->mutex);
698 GSSEAP_MUTEX_UNLOCK(&ctx->mutex);
700 if (GSS_ERROR(major))
701 gssEapReleaseContext(&tmpMinor, context_handle);
703 gss_release_buffer(&tmpMinor, &innerOutputToken);
708 #ifdef GSSEAP_ENABLE_REAUTH
710 acceptReadyKrb(OM_uint32 *minor,
713 const gss_name_t initiator,
719 major = gssEapGlueToMechName(minor, initiator, &ctx->initiatorName);
720 if (GSS_ERROR(major))
723 if (cred != GSS_C_NO_CREDENTIAL && cred->name != GSS_C_NO_NAME) {
724 major = gssEapDuplicateName(minor, cred->name, &ctx->acceptorName);
725 if (GSS_ERROR(major))
729 major = gssEapReauthComplete(minor, ctx, cred, mech, timeRec);
730 if (GSS_ERROR(major))
733 ctx->state = GSSEAP_STATE_ESTABLISHED;
736 return GSS_S_COMPLETE;
740 eapGssSmAcceptGssReauth(OM_uint32 *minor,
743 gss_buffer_t inputToken,
744 gss_channel_bindings_t chanBindings,
745 gss_buffer_t outputToken)
747 OM_uint32 major, tmpMinor;
748 gss_cred_id_t krbCred = GSS_C_NO_CREDENTIAL;
749 gss_name_t krbInitiator = GSS_C_NO_NAME;
750 gss_OID mech = GSS_C_NO_OID;
751 OM_uint32 gssFlags, timeRec = GSS_C_INDEFINITE;
753 ctx->flags |= CTX_FLAG_KRB_REAUTH;
755 if (cred != GSS_C_NO_CREDENTIAL)
756 krbCred = cred->krbCred;
758 major = gssAcceptSecContext(minor,
769 if (major == GSS_S_COMPLETE) {
770 major = acceptReadyKrb(minor, ctx, cred,
771 krbInitiator, mech, timeRec);
774 ctx->gssFlags = gssFlags;
776 gssReleaseName(&tmpMinor, &krbInitiator);
780 #endif /* GSSEAP_ENABLE_REAUTH */