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.4.1.5322.22.2.1 */
64 10, "\x2B\x06\x01\x04\x01\xA9\x4A\x16\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) {
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);
116 gssEapReleaseAttrContext(&tmpMinor, name);
118 GSSEAP_MUTEX_DESTROY(&name->mutex);
122 return GSS_S_COMPLETE;
126 krbPrincipalToName(OM_uint32 *minor,
127 krb5_principal *principal,
133 major = gssEapAllocName(minor, &name);
134 if (GSS_ERROR(major))
137 name->krbPrincipal = *principal;
140 if (KRB_PRINC_LENGTH(name->krbPrincipal) > 1) {
141 name->flags |= NAME_FLAG_SERVICE;
143 name->flags |= NAME_FLAG_NAI;
149 return GSS_S_COMPLETE;
153 gssEapGetDefaultRealm(krb5_context krbContext)
155 char *defaultRealm = NULL;
157 krb5_appdefault_string(krbContext, "eap_gss",
158 NULL, "default_realm", "", &defaultRealm);
164 importServiceName(OM_uint32 *minor,
165 const gss_buffer_t nameBuffer,
169 krb5_error_code code;
170 krb5_context krbContext;
171 krb5_principal krbPrinc;
172 char *service, *host, *realm = NULL;
174 GSSEAP_KRB_INIT(&krbContext);
176 major = bufferToString(minor, nameBuffer, &service);
177 if (GSS_ERROR(major))
180 host = strchr(service, '@');
186 realm = gssEapGetDefaultRealm(krbContext);
188 code = krb5_build_principal(krbContext,
190 realm != NULL ? strlen(realm) : 0,
191 realm != NULL ? realm : "",
197 KRB_PRINC_TYPE(krbPrinc) = KRB5_NT_SRV_HST;
199 major = krbPrincipalToName(minor, &krbPrinc, pName);
200 if (GSS_ERROR(major))
201 krb5_free_principal(krbContext, krbPrinc);
203 major = GSS_S_FAILURE;
204 *minor = GSSEAP_BAD_SERVICE_NAME;
209 GSSEAP_FREE(service);
214 #define IMPORT_FLAG_DEFAULT_REALM 0x1
217 * Import an EAP name, possibly appending the default GSS EAP realm,
220 importEapNameFlags(OM_uint32 *minor,
221 const gss_buffer_t nameBuffer,
222 OM_uint32 importFlags,
226 krb5_context krbContext;
227 krb5_principal krbPrinc = NULL;
228 krb5_error_code code;
231 GSSEAP_KRB_INIT(&krbContext);
233 if (nameBuffer == GSS_C_NO_BUFFER) {
235 code = KRB5_PARSE_MALFORMED;
237 major = bufferToString(minor, nameBuffer, &nameString);
238 if (GSS_ERROR(major))
242 * First, attempt to parse the name on the assumption that it includes
243 * a qualifying realm. This allows us to avoid accidentally appending
244 * the default Kerberos realm to an unqualified name. (A bug in MIT
245 * Kerberos prevents the default realm being set to an empty value.)
247 code = krb5_parse_name_flags(krbContext, nameString,
248 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM, &krbPrinc);
251 if (code == KRB5_PARSE_MALFORMED) {
252 char *defaultRealm = NULL;
255 /* Possibly append the default EAP realm if required */
256 if (importFlags & IMPORT_FLAG_DEFAULT_REALM)
257 defaultRealm = gssEapGetDefaultRealm(krbContext);
259 /* If no default realm, leave the realm empty in the parsed name */
260 if (defaultRealm == NULL || defaultRealm[0] == '\0')
261 parseFlags |= KRB5_PRINCIPAL_PARSE_NO_REALM;
263 code = krb5_parse_name_flags(krbContext, nameString, parseFlags, &krbPrinc);
265 #ifdef HAVE_HEIMDAL_VERSION
266 if (code == 0 && KRB_PRINC_REALM(krbPrinc) == NULL) {
267 KRB_PRINC_REALM(krbPrinc) = GSSEAP_CALLOC(1, sizeof(char));
268 if (KRB_PRINC_REALM(krbPrinc) == NULL)
273 if (defaultRealm != NULL)
274 GSSEAP_FREE(defaultRealm);
277 if (nameBuffer != GSS_C_NO_BUFFER)
278 GSSEAP_FREE(nameString);
282 return GSS_S_FAILURE;
285 assert(krbPrinc != NULL);
287 major = krbPrincipalToName(minor, &krbPrinc, pName);
288 if (GSS_ERROR(major))
289 krb5_free_principal(krbContext, krbPrinc);
295 importEapName(OM_uint32 *minor,
296 const gss_buffer_t nameBuffer,
299 return importEapNameFlags(minor, nameBuffer, 0, pName);
303 importUserName(OM_uint32 *minor,
304 const gss_buffer_t nameBuffer,
307 return importEapNameFlags(minor, nameBuffer, IMPORT_FLAG_DEFAULT_REALM, pName);
311 importAnonymousName(OM_uint32 *minor,
312 const gss_buffer_t nameBuffer GSSEAP_UNUSED,
315 return importEapNameFlags(minor, GSS_C_NO_BUFFER, 0, pName);
318 #define UPDATE_REMAIN(n) do { \
323 #define CHECK_REMAIN(n) do { \
324 if (remain < (n)) { \
325 major = GSS_S_BAD_NAME; \
326 *minor = GSSEAP_TOK_TRUNC; \
332 gssEapImportNameInternal(OM_uint32 *minor,
333 const gss_buffer_t nameBuffer,
337 OM_uint32 major, tmpMinor;
338 krb5_context krbContext;
342 gss_name_t name = GSS_C_NO_NAME;
343 gss_OID mechanismUsed = GSS_C_NO_OID;
345 GSSEAP_KRB_INIT(&krbContext);
347 p = (unsigned char *)nameBuffer->value;
348 remain = nameBuffer->length;
350 if (flags & EXPORT_NAME_FLAG_OID) {
352 enum gss_eap_token_type tokType;
353 uint16_t wireTokType;
355 /* TOK_ID || MECH_OID_LEN || MECH_OID */
357 *minor = GSSEAP_BAD_NAME_TOKEN;
358 return GSS_S_BAD_NAME;
361 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
362 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
364 tokType = TOK_TYPE_EXPORT_NAME;
367 wireTokType = load_uint16_be(p);
369 if ((flags & EXPORT_NAME_FLAG_ALLOW_COMPOSITE) &&
370 wireTokType == TOK_TYPE_EXPORT_NAME_COMPOSITE) {
371 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
372 flags |= EXPORT_NAME_FLAG_COMPOSITE;
375 if (wireTokType != tokType) {
376 *minor = GSSEAP_WRONG_TOK_ID;
377 return GSS_S_BAD_NAME;
382 len = load_uint16_be(p);
384 *minor = GSSEAP_BAD_NAME_TOKEN;
385 return GSS_S_BAD_NAME;
391 *minor = GSSEAP_BAD_NAME_TOKEN;
392 return GSS_S_BAD_NAME;
396 mech.elements = &p[2];
398 CHECK_REMAIN(mech.length);
400 major = gssEapCanonicalizeOid(minor,
402 OID_FLAG_FAMILY_MECH_VALID |
403 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
405 if (GSS_ERROR(major))
408 UPDATE_REMAIN(2 + mech.length);
413 len = load_uint32_be(p);
422 major = importEapNameFlags(minor, &buf, 0, &name);
423 if (GSS_ERROR(major))
426 name->mechanismUsed = mechanismUsed;
427 mechanismUsed = GSS_C_NO_OID;
429 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
435 major = gssEapImportAttrContext(minor, &buf, name);
436 if (GSS_ERROR(major))
440 major = GSS_S_COMPLETE;
444 if (GSS_ERROR(major)) {
445 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
446 gssEapReleaseName(&tmpMinor, &name);
455 importExportName(OM_uint32 *minor,
456 const gss_buffer_t nameBuffer,
459 return gssEapImportNameInternal(minor, nameBuffer, name,
460 EXPORT_NAME_FLAG_OID |
461 EXPORT_NAME_FLAG_ALLOW_COMPOSITE);
464 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
466 importCompositeExportName(OM_uint32 *minor,
467 const gss_buffer_t nameBuffer,
470 return gssEapImportNameInternal(minor, nameBuffer, name,
471 EXPORT_NAME_FLAG_OID |
472 EXPORT_NAME_FLAG_COMPOSITE);
476 struct gss_eap_name_import_provider {
478 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
482 gssEapImportName(OM_uint32 *minor,
483 const gss_buffer_t nameBuffer,
484 const gss_OID nameType,
485 const gss_OID mechType,
488 struct gss_eap_name_import_provider nameTypes[] = {
489 { GSS_EAP_NT_EAP_NAME, importEapName },
490 { GSS_C_NT_USER_NAME, importUserName },
491 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
492 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
493 { GSS_C_NT_ANONYMOUS, importAnonymousName },
494 { GSS_C_NT_EXPORT_NAME, importExportName },
495 { GSS_KRB5_NT_PRINCIPAL_NAME, importUserName },
496 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
497 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
501 OM_uint32 major = GSS_S_BAD_NAMETYPE;
503 gss_name_t name = GSS_C_NO_NAME;
505 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
506 if (oidEqual(nameTypes[i].oid,
507 nameType == GSS_C_NO_OID ? GSS_EAP_NT_EAP_NAME : nameType)) {
508 major = nameTypes[i].import(minor, nameBuffer, &name);
513 if (major == GSS_S_COMPLETE &&
514 mechType != GSS_C_NO_OID) {
515 assert(gssEapIsConcreteMechanismOid(mechType));
516 assert(name->mechanismUsed == GSS_C_NO_OID);
518 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
521 if (GSS_ERROR(major))
522 gssEapReleaseName(&tmpMinor, &name);
530 gssEapExportName(OM_uint32 *minor,
531 const gss_name_t name,
532 gss_buffer_t exportedName)
534 return gssEapExportNameInternal(minor, name, exportedName,
535 EXPORT_NAME_FLAG_OID);
539 gssEapExportNameInternal(OM_uint32 *minor,
540 const gss_name_t name,
541 gss_buffer_t exportedName,
544 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
545 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
546 size_t exportedNameLen;
548 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
551 exportedName->length = 0;
552 exportedName->value = NULL;
554 if (name->mechanismUsed != GSS_C_NO_OID)
555 mech = name->mechanismUsed;
557 mech = GSS_EAP_MECHANISM;
559 major = gssEapDisplayName(minor, name, &nameBuf, NULL);
560 if (GSS_ERROR(major))
564 if (flags & EXPORT_NAME_FLAG_OID) {
565 exportedNameLen += 6 + mech->length;
567 exportedNameLen += 4 + nameBuf.length;
568 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
569 major = gssEapExportAttrContext(minor, name, &attrs);
570 if (GSS_ERROR(major))
572 exportedNameLen += attrs.length;
575 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
576 if (exportedName->value == NULL) {
577 major = GSS_S_FAILURE;
581 exportedName->length = exportedNameLen;
583 p = (unsigned char *)exportedName->value;
585 if (flags & EXPORT_NAME_FLAG_OID) {
586 /* TOK | MECH_OID_LEN */
587 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
588 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
589 : TOK_TYPE_EXPORT_NAME,
592 store_uint16_be(mech->length + 2, p);
597 *p++ = mech->length & 0xff;
598 memcpy(p, mech->elements, mech->length);
603 store_uint32_be(nameBuf.length, p);
607 memcpy(p, nameBuf.value, nameBuf.length);
610 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
611 memcpy(p, attrs.value, attrs.length);
615 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
617 major = GSS_S_COMPLETE;
621 gss_release_buffer(&tmpMinor, &attrs);
622 gss_release_buffer(&tmpMinor, &nameBuf);
623 if (GSS_ERROR(major))
624 gss_release_buffer(&tmpMinor, exportedName);
630 gssEapCanonicalizeName(OM_uint32 *minor,
631 const gss_name_t input_name,
632 const gss_OID mech_type,
633 gss_name_t *dest_name)
635 OM_uint32 major, tmpMinor;
636 krb5_context krbContext;
640 if (input_name == GSS_C_NO_NAME) {
642 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
645 GSSEAP_KRB_INIT(&krbContext);
647 major = gssEapAllocName(minor, &name);
648 if (GSS_ERROR(major)) {
652 if (mech_type != GSS_C_NO_OID)
653 mech_used = mech_type;
655 mech_used = input_name->mechanismUsed;
657 major = gssEapCanonicalizeOid(minor,
660 &name->mechanismUsed);
661 if (GSS_ERROR(major))
664 name->flags = input_name->flags;
666 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
667 &name->krbPrincipal);
669 major = GSS_S_FAILURE;
673 if (input_name->attrCtx != NULL) {
674 major = gssEapDuplicateAttrContext(minor, input_name, name);
675 if (GSS_ERROR(major))
682 if (GSS_ERROR(major)) {
683 gssEapReleaseName(&tmpMinor, &name);
690 gssEapDuplicateName(OM_uint32 *minor,
691 const gss_name_t input_name,
692 gss_name_t *dest_name)
694 return gssEapCanonicalizeName(minor, input_name,
695 GSS_C_NO_OID, dest_name);
699 gssEapDisplayName(OM_uint32 *minor,
701 gss_buffer_t output_name_buffer,
702 gss_OID *output_name_type)
705 krb5_context krbContext;
710 GSSEAP_KRB_INIT(&krbContext);
712 output_name_buffer->length = 0;
713 output_name_buffer->value = NULL;
715 if (name == GSS_C_NO_NAME) {
717 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
721 * According to draft-ietf-abfab-gss-eap-01, when the realm is
722 * absent the trailing '@' is not included.
724 #ifdef HAVE_HEIMDAL_VERSION
725 if (KRB_PRINC_REALM(name->krbPrincipal) == NULL ||
726 KRB_PRINC_REALM(name->krbPrincipal)[0] == '\0')
728 if (KRB_PRINC_REALM(name->krbPrincipal)->length == 0)
730 flags |= KRB5_PRINCIPAL_UNPARSE_NO_REALM;
732 *minor = krb5_unparse_name_flags(krbContext, name->krbPrincipal,
735 return GSS_S_FAILURE;
738 major = makeStringBuffer(minor, krbName, output_name_buffer);
739 if (GSS_ERROR(major)) {
740 krb5_free_unparsed_name(krbContext, krbName);
744 krb5_free_unparsed_name(krbContext, krbName);
746 if (output_name_buffer->length == 0) {
747 name_type = GSS_C_NT_ANONYMOUS;
748 } else if (name->flags & NAME_FLAG_NAI) {
749 name_type = GSS_C_NT_USER_NAME;
751 name_type = GSS_EAP_NT_EAP_NAME;
754 if (output_name_type != NULL)
755 *output_name_type = name_type;
757 return GSS_S_COMPLETE;
761 gssEapCompareName(OM_uint32 *minor,
766 krb5_context krbContext;
770 if (name1 == GSS_C_NO_NAME && name2 == GSS_C_NO_NAME) {
772 } else if (name1 != GSS_C_NO_NAME && name2 != GSS_C_NO_NAME) {
773 GSSEAP_KRB_INIT(&krbContext);
775 /* krbPrincipal is immutable, so lock not required */
776 *name_equal = krb5_principal_compare(krbContext,
778 name2->krbPrincipal);
781 return GSS_S_COMPLETE;