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
33 * Portions Copyright 2009 by the Massachusetts Institute of Technology.
34 * All Rights Reserved.
36 * Export of this software from the United States of America may
37 * require a specific license from the United States Government.
38 * It is the responsibility of any person or organization contemplating
39 * export to obtain such a license before exporting.
41 * WITHIN THAT CONSTRAINT, permission to use, copy, modify, and
42 * distribute this software and its documentation for any purpose and
43 * without fee is hereby granted, provided that the above copyright
44 * notice appear in all copies and that both that copyright notice and
45 * this permission notice appear in supporting documentation, and that
46 * the name of M.I.T. not be used in advertising or publicity pertaining
47 * to distribution of the software without specific, written prior
48 * permission. Furthermore if you modify this software you must label
49 * your software as modified software and not distribute it in such a
50 * fashion that it might be confused with the original M.I.T. software.
51 * M.I.T. makes no representations about the suitability of
52 * this software for any purpose. It is provided "as is" without express
53 * or implied warranty.
57 * Name utility routines.
60 #include "gssapiP_eap.h"
62 static gss_OID_desc gssEapNtEapName = {
63 /* 1.3.6.1.5.5.15.2.1 */
64 8, "\x2B\x06\x01\x05\x05\x0f\x02\x01"
67 gss_OID GSS_EAP_NT_EAP_NAME = &gssEapNtEapName;
70 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName)
75 *pName = GSS_C_NO_NAME;
77 name = (gss_name_t)GSSEAP_CALLOC(1, sizeof(*name));
83 if (GSSEAP_MUTEX_INIT(&name->mutex) != 0) {
84 *minor = GSSEAP_GET_LAST_ERROR();
85 gssEapReleaseName(&tmpMinor, &name);
91 return GSS_S_COMPLETE;
95 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName)
98 krb5_context krbContext = NULL;
104 return GSS_S_COMPLETE;
108 if (name == GSS_C_NO_NAME) {
109 return GSS_S_COMPLETE;
112 GSSEAP_KRB_INIT(&krbContext);
113 krb5_free_principal(krbContext, name->krbPrincipal);
114 gssEapReleaseOid(&tmpMinor, &name->mechanismUsed);
115 #ifdef GSSEAP_ENABLE_ACCEPTOR
116 gssEapReleaseAttrContext(&tmpMinor, name);
119 GSSEAP_MUTEX_DESTROY(&name->mutex);
123 return GSS_S_COMPLETE;
127 krbPrincipalToName(OM_uint32 *minor,
128 krb5_principal *principal,
134 major = gssEapAllocName(minor, &name);
135 if (GSS_ERROR(major))
138 name->krbPrincipal = *principal;
141 if (KRB_PRINC_LENGTH(name->krbPrincipal) >= 1) {
142 name->flags |= NAME_FLAG_SERVICE;
144 if (KRB_PRINC_LENGTH(name->krbPrincipal) == 1) {
145 name->flags |= NAME_FLAG_NAI;
151 return GSS_S_COMPLETE;
155 gssEapGetDefaultRealm(krb5_context krbContext)
157 char *defaultRealm = NULL;
159 krb5_appdefault_string(krbContext, "eap_gss",
160 NULL, "default_realm", "", &defaultRealm);
166 importServiceName(OM_uint32 *minor,
167 const gss_buffer_t nameBuffer,
171 krb5_error_code code;
172 krb5_context krbContext;
173 krb5_principal krbPrinc;
174 char *service, *host, *realm = NULL;
176 GSSEAP_KRB_INIT(&krbContext);
178 major = bufferToString(minor, nameBuffer, &service);
179 if (GSS_ERROR(major))
182 host = strchr(service, '@');
188 realm = gssEapGetDefaultRealm(krbContext);
190 code = krb5_build_principal(krbContext,
192 realm != NULL ? strlen(realm) : 0,
193 realm != NULL ? realm : "",
199 KRB_PRINC_TYPE(krbPrinc) = KRB5_NT_SRV_HST;
201 major = krbPrincipalToName(minor, &krbPrinc, pName);
202 if (GSS_ERROR(major))
203 krb5_free_principal(krbContext, krbPrinc);
205 major = GSS_S_FAILURE;
206 *minor = GSSEAP_BAD_SERVICE_NAME;
210 krb5_free_default_realm(krbContext, realm);
211 GSSEAP_FREE(service);
216 #define IMPORT_FLAG_DEFAULT_REALM 0x1
219 * Import an EAP name, possibly appending the default GSS EAP realm,
222 importEapNameFlags(OM_uint32 *minor,
223 const gss_buffer_t nameBuffer,
224 OM_uint32 importFlags,
228 krb5_context krbContext;
229 krb5_principal krbPrinc = NULL;
230 krb5_error_code code;
233 GSSEAP_KRB_INIT(&krbContext);
235 if (nameBuffer == GSS_C_NO_BUFFER) {
237 code = KRB5_PARSE_MALFORMED;
239 major = bufferToString(minor, nameBuffer, &nameString);
240 if (GSS_ERROR(major))
244 * First, attempt to parse the name on the assumption that it includes
245 * a qualifying realm. This allows us to avoid accidentally appending
246 * the default Kerberos realm to an unqualified name. (A bug in MIT
247 * Kerberos prevents the default realm being set to an empty value.)
249 code = krb5_parse_name_flags(krbContext, nameString,
250 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM, &krbPrinc);
253 if (code == KRB5_PARSE_MALFORMED) {
254 char *defaultRealm = NULL;
257 /* Possibly append the default EAP realm if required */
258 if (importFlags & IMPORT_FLAG_DEFAULT_REALM)
259 defaultRealm = gssEapGetDefaultRealm(krbContext);
261 /* If no default realm, leave the realm empty in the parsed name */
262 if (defaultRealm == NULL || defaultRealm[0] == '\0')
263 parseFlags |= KRB5_PRINCIPAL_PARSE_NO_REALM;
265 code = krb5_parse_name_flags(krbContext, nameString, parseFlags, &krbPrinc);
267 #ifdef HAVE_HEIMDAL_VERSION
268 if (code == 0 && KRB_PRINC_REALM(krbPrinc) == NULL) {
269 KRB_PRINC_REALM(krbPrinc) = KRB_CALLOC(1, sizeof(char));
270 if (KRB_PRINC_REALM(krbPrinc) == NULL)
275 if (defaultRealm != NULL)
276 krb5_free_default_realm(krbContext, defaultRealm);
279 if (nameBuffer != GSS_C_NO_BUFFER)
280 GSSEAP_FREE(nameString);
284 return GSS_S_FAILURE;
287 GSSEAP_ASSERT(krbPrinc != NULL);
289 major = krbPrincipalToName(minor, &krbPrinc, pName);
290 if (GSS_ERROR(major))
291 krb5_free_principal(krbContext, krbPrinc);
297 importEapName(OM_uint32 *minor,
298 const gss_buffer_t nameBuffer,
301 return importEapNameFlags(minor, nameBuffer, 0, pName);
305 importUserName(OM_uint32 *minor,
306 const gss_buffer_t nameBuffer,
309 return importEapNameFlags(minor, nameBuffer, IMPORT_FLAG_DEFAULT_REALM, pName);
313 importAnonymousName(OM_uint32 *minor,
314 const gss_buffer_t nameBuffer GSSEAP_UNUSED,
317 return importEapNameFlags(minor, GSS_C_NO_BUFFER, 0, pName);
320 #define UPDATE_REMAIN(n) do { \
325 #define CHECK_REMAIN(n) do { \
326 if (remain < (n)) { \
327 major = GSS_S_BAD_NAME; \
328 *minor = GSSEAP_TOK_TRUNC; \
334 gssEapImportNameInternal(OM_uint32 *minor,
335 const gss_buffer_t nameBuffer,
339 OM_uint32 major, tmpMinor;
340 krb5_context krbContext;
344 gss_name_t name = GSS_C_NO_NAME;
345 gss_OID mechanismUsed = GSS_C_NO_OID;
347 GSSEAP_KRB_INIT(&krbContext);
349 p = (unsigned char *)nameBuffer->value;
350 remain = nameBuffer->length;
352 if (flags & EXPORT_NAME_FLAG_OID) {
354 enum gss_eap_token_type tokType;
355 uint16_t wireTokType;
357 /* TOK_ID || MECH_OID_LEN || MECH_OID */
359 *minor = GSSEAP_BAD_NAME_TOKEN;
360 return GSS_S_BAD_NAME;
363 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
364 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
366 tokType = TOK_TYPE_EXPORT_NAME;
369 wireTokType = load_uint16_be(p);
371 if ((flags & EXPORT_NAME_FLAG_ALLOW_COMPOSITE) &&
372 wireTokType == TOK_TYPE_EXPORT_NAME_COMPOSITE) {
373 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
374 flags |= EXPORT_NAME_FLAG_COMPOSITE;
377 if (wireTokType != tokType) {
378 *minor = GSSEAP_WRONG_TOK_ID;
379 return GSS_S_BAD_NAME;
384 len = load_uint16_be(p);
386 *minor = GSSEAP_BAD_NAME_TOKEN;
387 return GSS_S_BAD_NAME;
393 *minor = GSSEAP_BAD_NAME_TOKEN;
394 return GSS_S_BAD_NAME;
398 mech.elements = &p[2];
400 CHECK_REMAIN(mech.length);
402 major = gssEapCanonicalizeOid(minor,
404 OID_FLAG_FAMILY_MECH_VALID |
405 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
407 if (GSS_ERROR(major))
410 UPDATE_REMAIN(2 + mech.length);
415 len = load_uint32_be(p);
424 major = importEapNameFlags(minor, &buf, 0, &name);
425 if (GSS_ERROR(major))
428 name->mechanismUsed = mechanismUsed;
429 mechanismUsed = GSS_C_NO_OID;
431 #ifdef GSSEAP_ENABLE_ACCEPTOR
432 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
438 major = gssEapImportAttrContext(minor, &buf, name);
439 if (GSS_ERROR(major))
444 major = GSS_S_COMPLETE;
448 if (GSS_ERROR(major)) {
449 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
450 gssEapReleaseName(&tmpMinor, &name);
459 importExportName(OM_uint32 *minor,
460 const gss_buffer_t nameBuffer,
463 return gssEapImportNameInternal(minor, nameBuffer, name,
464 EXPORT_NAME_FLAG_OID |
465 EXPORT_NAME_FLAG_ALLOW_COMPOSITE);
468 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
470 importCompositeExportName(OM_uint32 *minor,
471 const gss_buffer_t nameBuffer,
474 return gssEapImportNameInternal(minor, nameBuffer, name,
475 EXPORT_NAME_FLAG_OID |
476 EXPORT_NAME_FLAG_COMPOSITE);
480 struct gss_eap_name_import_provider {
482 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
486 gssEapImportName(OM_uint32 *minor,
487 const gss_buffer_t nameBuffer,
488 const gss_OID nameType,
489 const gss_OID mechType,
492 struct gss_eap_name_import_provider nameTypes[] = {
493 { GSS_EAP_NT_EAP_NAME, importEapName },
494 { GSS_C_NT_USER_NAME, importUserName },
495 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
496 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
497 { GSS_C_NT_ANONYMOUS, importAnonymousName },
498 { GSS_C_NT_EXPORT_NAME, importExportName },
499 { GSS_KRB5_NT_PRINCIPAL_NAME, importUserName },
500 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
501 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
505 OM_uint32 major = GSS_S_BAD_NAMETYPE;
507 gss_name_t name = GSS_C_NO_NAME;
509 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
510 if (oidEqual(nameTypes[i].oid,
511 nameType == GSS_C_NO_OID ? GSS_EAP_NT_EAP_NAME : nameType)) {
512 major = nameTypes[i].import(minor, nameBuffer, &name);
517 if (major == GSS_S_COMPLETE &&
518 mechType != GSS_C_NO_OID) {
519 GSSEAP_ASSERT(gssEapIsConcreteMechanismOid(mechType));
520 GSSEAP_ASSERT(name != GSS_C_NO_NAME);
521 GSSEAP_ASSERT(name->mechanismUsed == GSS_C_NO_OID);
523 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
526 if (GSS_ERROR(major))
527 gssEapReleaseName(&tmpMinor, &name);
535 gssEapExportName(OM_uint32 *minor,
536 const gss_name_t name,
537 gss_buffer_t exportedName)
539 return gssEapExportNameInternal(minor, name, exportedName,
540 EXPORT_NAME_FLAG_OID);
544 gssEapExportNameInternal(OM_uint32 *minor,
545 const gss_name_t name,
546 gss_buffer_t exportedName,
549 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
550 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
551 size_t exportedNameLen;
553 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
556 exportedName->length = 0;
557 exportedName->value = NULL;
559 if (name->mechanismUsed != GSS_C_NO_OID)
560 mech = name->mechanismUsed;
562 mech = GSS_EAP_MECHANISM;
564 major = gssEapDisplayName(minor, name, &nameBuf, NULL);
565 if (GSS_ERROR(major))
569 if (flags & EXPORT_NAME_FLAG_OID) {
570 exportedNameLen += 6 + mech->length;
572 exportedNameLen += 4 + nameBuf.length;
573 #ifdef GSSEAP_ENABLE_ACCEPTOR
574 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
575 major = gssEapExportAttrContext(minor, name, &attrs);
576 if (GSS_ERROR(major))
578 exportedNameLen += attrs.length;
582 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
583 if (exportedName->value == NULL) {
584 major = GSS_S_FAILURE;
588 exportedName->length = exportedNameLen;
590 p = (unsigned char *)exportedName->value;
592 if (flags & EXPORT_NAME_FLAG_OID) {
593 /* TOK | MECH_OID_LEN */
594 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
595 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
596 : TOK_TYPE_EXPORT_NAME,
599 store_uint16_be(mech->length + 2, p);
604 *p++ = mech->length & 0xff;
605 memcpy(p, mech->elements, mech->length);
610 store_uint32_be(nameBuf.length, p);
614 memcpy(p, nameBuf.value, nameBuf.length);
617 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
618 memcpy(p, attrs.value, attrs.length);
622 GSSEAP_ASSERT(p == (unsigned char *)exportedName->value + exportedNameLen);
624 major = GSS_S_COMPLETE;
628 gss_release_buffer(&tmpMinor, &attrs);
629 gss_release_buffer(&tmpMinor, &nameBuf);
630 if (GSS_ERROR(major))
631 gss_release_buffer(&tmpMinor, exportedName);
637 gssEapCanonicalizeName(OM_uint32 *minor,
638 const gss_name_t input_name,
639 const gss_OID mech_type,
640 gss_name_t *dest_name)
642 OM_uint32 major, tmpMinor;
643 krb5_context krbContext;
647 if (input_name == GSS_C_NO_NAME) {
649 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
652 GSSEAP_KRB_INIT(&krbContext);
654 major = gssEapAllocName(minor, &name);
655 if (GSS_ERROR(major)) {
659 if (mech_type != GSS_C_NO_OID)
660 mech_used = mech_type;
662 mech_used = input_name->mechanismUsed;
664 major = gssEapCanonicalizeOid(minor,
667 &name->mechanismUsed);
668 if (GSS_ERROR(major))
671 name->flags = input_name->flags;
673 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
674 &name->krbPrincipal);
676 major = GSS_S_FAILURE;
680 #ifdef GSSEAP_ENABLE_ACCEPTOR
681 if (input_name->attrCtx != NULL) {
682 major = gssEapDuplicateAttrContext(minor, input_name, name);
683 if (GSS_ERROR(major))
691 if (GSS_ERROR(major)) {
692 gssEapReleaseName(&tmpMinor, &name);
699 gssEapDuplicateName(OM_uint32 *minor,
700 const gss_name_t input_name,
701 gss_name_t *dest_name)
703 return gssEapCanonicalizeName(minor, input_name,
704 GSS_C_NO_OID, dest_name);
708 hasRealmP(gss_name_t name)
710 #ifdef HAVE_HEIMDAL_VERSION
711 if (KRB_PRINC_REALM(name->krbPrincipal) != NULL &&
712 KRB_PRINC_REALM(name->krbPrincipal)[0] != '\0')
714 if (KRB_PRINC_REALM(name->krbPrincipal)->length != 0)
722 gssEapDisplayName(OM_uint32 *minor,
724 gss_buffer_t output_name_buffer,
725 gss_OID *output_name_type)
728 krb5_context krbContext;
733 GSSEAP_KRB_INIT(&krbContext);
735 output_name_buffer->length = 0;
736 output_name_buffer->value = NULL;
738 if (name == GSS_C_NO_NAME) {
740 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
744 * According to draft-ietf-abfab-gss-eap-01, when the realm is
745 * absent the trailing '@' is not included.
747 if (!hasRealmP(name))
748 flags |= KRB5_PRINCIPAL_UNPARSE_NO_REALM;
750 *minor = krb5_unparse_name_flags(krbContext, name->krbPrincipal,
753 return GSS_S_FAILURE;
756 major = makeStringBuffer(minor, krbName, output_name_buffer);
757 #ifdef HAVE_HEIMDAL_VERSION
760 krb5_free_unparsed_name(krbContext, krbName);
762 if (GSS_ERROR(major))
765 if (output_name_buffer->length == 0) {
766 name_type = GSS_C_NT_ANONYMOUS;
767 } else if (name->flags & NAME_FLAG_NAI) {
768 name_type = GSS_C_NT_USER_NAME;
770 name_type = GSS_EAP_NT_EAP_NAME;
773 if (output_name_type != NULL)
774 *output_name_type = name_type;
776 return GSS_S_COMPLETE;
780 gssEapCompareName(OM_uint32 *minor,
786 krb5_context krbContext;
790 if (name1 == GSS_C_NO_NAME && name2 == GSS_C_NO_NAME) {
792 } else if (name1 != GSS_C_NO_NAME && name2 != GSS_C_NO_NAME) {
793 GSSEAP_KRB_INIT(&krbContext);
795 /* krbPrincipal is immutable, so lock not required */
796 if ((flags & COMPARE_NAME_FLAG_IGNORE_EMPTY_REALMS) &&
797 (hasRealmP(name1) == FALSE || hasRealmP(name2) == FALSE)) {
798 *name_equal = krb5_principal_compare_any_realm(krbContext,
800 name2->krbPrincipal);
802 *name_equal = krb5_principal_compare(krbContext,
804 name2->krbPrincipal);
810 return GSS_S_COMPLETE;