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;
230 GSSEAP_KRB_INIT(&krbContext);
232 if (nameBuffer == GSS_C_NO_BUFFER) {
233 code = krb5_copy_principal(krbContext,
234 krbAnonymousPrincipal(), &krbPrinc);
237 return GSS_S_FAILURE;
242 major = bufferToString(minor, nameBuffer, &nameString);
243 if (GSS_ERROR(major))
247 * First, attempt to parse the name on the assumption that it includes
248 * a qualifying realm. This allows us to avoid accidentally appending
249 * the default Kerberos realm to an unqualified name. (A bug in MIT
250 * Kerberos prevents the default realm being set to an empty value.)
252 code = krb5_parse_name_flags(krbContext, nameString,
253 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM, &krbPrinc);
254 if (code == KRB5_PARSE_MALFORMED) {
255 char *defaultRealm = NULL;
258 /* Possibly append the default EAP realm if required */
259 if (importFlags & IMPORT_FLAG_DEFAULT_REALM)
260 defaultRealm = gssEapGetDefaultRealm(krbContext);
262 /* If no default realm, leave the realm empty in the parsed name */
263 if (defaultRealm == NULL || defaultRealm[0] == '\0')
264 parseFlags |= KRB5_PRINCIPAL_PARSE_NO_REALM;
266 code = krb5_parse_name_flags(krbContext, nameString, parseFlags, &krbPrinc);
268 #ifdef HAVE_HEIMDAL_VERSION
269 if (code == 0 && KRB_PRINC_REALM(krbPrinc) == NULL) {
270 KRB_PRINC_REALM(krbPrinc) = GSSEAP_CALLOC(1, sizeof(char));
271 if (KRB_PRINC_REALM(krbPrinc) == NULL)
276 if (defaultRealm != NULL)
277 GSSEAP_FREE(defaultRealm);
280 GSSEAP_FREE(nameString);
284 return GSS_S_FAILURE;
288 assert(krbPrinc != NULL);
290 major = krbPrincipalToName(minor, &krbPrinc, pName);
291 if (GSS_ERROR(major))
292 krb5_free_principal(krbContext, krbPrinc);
298 importEapName(OM_uint32 *minor,
299 const gss_buffer_t nameBuffer,
302 return importEapNameFlags(minor, nameBuffer, 0, pName);
306 importUserName(OM_uint32 *minor,
307 const gss_buffer_t nameBuffer,
310 return importEapNameFlags(minor, nameBuffer, IMPORT_FLAG_DEFAULT_REALM, pName);
314 importAnonymousName(OM_uint32 *minor,
315 const gss_buffer_t nameBuffer GSSEAP_UNUSED,
318 return importEapNameFlags(minor, GSS_C_NO_BUFFER, 0, pName);
321 #define UPDATE_REMAIN(n) do { \
326 #define CHECK_REMAIN(n) do { \
327 if (remain < (n)) { \
328 major = GSS_S_BAD_NAME; \
329 *minor = GSSEAP_TOK_TRUNC; \
335 gssEapImportNameInternal(OM_uint32 *minor,
336 const gss_buffer_t nameBuffer,
340 OM_uint32 major, tmpMinor;
341 krb5_context krbContext;
345 enum gss_eap_token_type tokType;
346 gss_name_t name = GSS_C_NO_NAME;
347 gss_OID mechanismUsed = GSS_C_NO_OID;
349 GSSEAP_KRB_INIT(&krbContext);
351 p = (unsigned char *)nameBuffer->value;
352 remain = nameBuffer->length;
354 if (flags & EXPORT_NAME_FLAG_OID) {
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 if (load_uint16_be(p) != tokType) {
370 *minor = GSSEAP_WRONG_TOK_ID;
371 return GSS_S_BAD_NAME;
376 len = load_uint16_be(p);
378 *minor = GSSEAP_BAD_NAME_TOKEN;
379 return GSS_S_BAD_NAME;
385 *minor = GSSEAP_BAD_NAME_TOKEN;
386 return GSS_S_BAD_NAME;
390 mech.elements = &p[2];
392 CHECK_REMAIN(mech.length);
394 major = gssEapCanonicalizeOid(minor,
396 OID_FLAG_FAMILY_MECH_VALID |
397 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
399 if (GSS_ERROR(major))
402 UPDATE_REMAIN(2 + mech.length);
407 len = load_uint32_be(p);
416 major = importEapNameFlags(minor, &buf, 0, &name);
417 if (GSS_ERROR(major))
420 name->mechanismUsed = mechanismUsed;
421 mechanismUsed = GSS_C_NO_OID;
423 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
429 major = gssEapImportAttrContext(minor, &buf, name);
430 if (GSS_ERROR(major))
434 major = GSS_S_COMPLETE;
438 if (GSS_ERROR(major)) {
439 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
440 gssEapReleaseName(&tmpMinor, &name);
449 importExportName(OM_uint32 *minor,
450 const gss_buffer_t nameBuffer,
453 return gssEapImportNameInternal(minor, nameBuffer, name,
454 EXPORT_NAME_FLAG_OID);
457 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
459 importCompositeExportName(OM_uint32 *minor,
460 const gss_buffer_t nameBuffer,
463 return gssEapImportNameInternal(minor, nameBuffer, name,
464 EXPORT_NAME_FLAG_OID |
465 EXPORT_NAME_FLAG_COMPOSITE);
469 struct gss_eap_name_import_provider {
471 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
475 gssEapImportName(OM_uint32 *minor,
476 const gss_buffer_t nameBuffer,
477 const gss_OID nameType,
478 const gss_OID mechType,
481 struct gss_eap_name_import_provider nameTypes[] = {
482 { GSS_EAP_NT_EAP_NAME, importEapName },
483 { GSS_C_NT_USER_NAME, importUserName },
484 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
485 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
486 { GSS_C_NT_ANONYMOUS, importAnonymousName },
487 { GSS_C_NT_EXPORT_NAME, importExportName },
488 { GSS_KRB5_NT_PRINCIPAL_NAME, importUserName },
489 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
490 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
494 OM_uint32 major = GSS_S_BAD_NAMETYPE;
496 gss_name_t name = GSS_C_NO_NAME;
498 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
499 if (oidEqual(nameTypes[i].oid,
500 nameType == GSS_C_NO_OID ? GSS_EAP_NT_EAP_NAME : nameType)) {
501 major = nameTypes[i].import(minor, nameBuffer, &name);
506 if (major == GSS_S_COMPLETE &&
507 mechType != GSS_C_NO_OID) {
508 assert(gssEapIsConcreteMechanismOid(mechType));
509 assert(name->mechanismUsed == GSS_C_NO_OID);
511 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
514 if (GSS_ERROR(major))
515 gssEapReleaseName(&tmpMinor, &name);
523 gssEapExportName(OM_uint32 *minor,
524 const gss_name_t name,
525 gss_buffer_t exportedName)
527 return gssEapExportNameInternal(minor, name, exportedName,
528 EXPORT_NAME_FLAG_OID);
532 gssEapExportNameInternal(OM_uint32 *minor,
533 const gss_name_t name,
534 gss_buffer_t exportedName,
537 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
538 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
539 size_t exportedNameLen;
541 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
544 exportedName->length = 0;
545 exportedName->value = NULL;
547 if (name->mechanismUsed != GSS_C_NO_OID)
548 mech = name->mechanismUsed;
550 mech = GSS_EAP_MECHANISM;
552 major = gssEapDisplayName(minor, name, &nameBuf, NULL);
553 if (GSS_ERROR(major))
557 if (flags & EXPORT_NAME_FLAG_OID) {
558 exportedNameLen += 6 + mech->length;
560 exportedNameLen += 4 + nameBuf.length;
561 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
562 major = gssEapExportAttrContext(minor, name, &attrs);
563 if (GSS_ERROR(major))
565 exportedNameLen += attrs.length;
568 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
569 if (exportedName->value == NULL) {
570 major = GSS_S_FAILURE;
574 exportedName->length = exportedNameLen;
576 p = (unsigned char *)exportedName->value;
578 if (flags & EXPORT_NAME_FLAG_OID) {
579 /* TOK | MECH_OID_LEN */
580 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
581 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
582 : TOK_TYPE_EXPORT_NAME,
585 store_uint16_be(mech->length + 2, p);
590 *p++ = mech->length & 0xff;
591 memcpy(p, mech->elements, mech->length);
596 store_uint32_be(nameBuf.length, p);
600 memcpy(p, nameBuf.value, nameBuf.length);
603 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
604 memcpy(p, attrs.value, attrs.length);
608 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
610 major = GSS_S_COMPLETE;
614 gss_release_buffer(&tmpMinor, &attrs);
615 gss_release_buffer(&tmpMinor, &nameBuf);
616 if (GSS_ERROR(major))
617 gss_release_buffer(&tmpMinor, exportedName);
623 gssEapCanonicalizeName(OM_uint32 *minor,
624 const gss_name_t input_name,
625 const gss_OID mech_type,
626 gss_name_t *dest_name)
628 OM_uint32 major, tmpMinor;
629 krb5_context krbContext;
633 if (input_name == GSS_C_NO_NAME) {
635 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
638 GSSEAP_KRB_INIT(&krbContext);
640 major = gssEapAllocName(minor, &name);
641 if (GSS_ERROR(major)) {
645 if (mech_type != GSS_C_NO_OID)
646 mech_used = mech_type;
648 mech_used = input_name->mechanismUsed;
650 major = gssEapCanonicalizeOid(minor,
653 &name->mechanismUsed);
654 if (GSS_ERROR(major))
657 name->flags = input_name->flags;
659 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
660 &name->krbPrincipal);
662 major = GSS_S_FAILURE;
666 if (input_name->attrCtx != NULL) {
667 major = gssEapDuplicateAttrContext(minor, input_name, name);
668 if (GSS_ERROR(major))
675 if (GSS_ERROR(major)) {
676 gssEapReleaseName(&tmpMinor, &name);
683 gssEapDuplicateName(OM_uint32 *minor,
684 const gss_name_t input_name,
685 gss_name_t *dest_name)
687 return gssEapCanonicalizeName(minor, input_name,
688 GSS_C_NO_OID, dest_name);
692 gssEapDisplayName(OM_uint32 *minor,
694 gss_buffer_t output_name_buffer,
695 gss_OID *output_name_type)
698 krb5_context krbContext;
703 GSSEAP_KRB_INIT(&krbContext);
705 output_name_buffer->length = 0;
706 output_name_buffer->value = NULL;
708 if (name == GSS_C_NO_NAME) {
710 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
714 * According to draft-ietf-abfab-gss-eap-01, when the realm is
715 * absent the trailing '@' is not included.
717 #ifdef HAVE_HEIMDAL_VERSION
718 if (KRB_PRINC_REALM(name->krbPrincipal) == NULL ||
719 KRB_PRINC_REALM(name->krbPrincipal)[0] == '\0')
721 if (KRB_PRINC_REALM(name->krbPrincipal)->length == 0)
723 flags |= KRB5_PRINCIPAL_UNPARSE_NO_REALM;
725 *minor = krb5_unparse_name_flags(krbContext, name->krbPrincipal,
728 return GSS_S_FAILURE;
731 major = makeStringBuffer(minor, krbName, output_name_buffer);
732 if (GSS_ERROR(major)) {
733 krb5_free_unparsed_name(krbContext, krbName);
737 krb5_free_unparsed_name(krbContext, krbName);
739 if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
740 krb5_principal_compare(krbContext,
741 name->krbPrincipal, krbAnonymousPrincipal())) {
742 name_type = GSS_C_NT_ANONYMOUS;
744 name_type = GSS_EAP_NT_EAP_NAME;
747 if (output_name_type != NULL)
748 *output_name_type = name_type;
750 return GSS_S_COMPLETE;
754 gssEapCompareName(OM_uint32 *minor,
759 krb5_context krbContext;
763 if (name1 == GSS_C_NO_NAME && name2 == GSS_C_NO_NAME) {
765 } else if (name1 != GSS_C_NO_NAME && name2 != GSS_C_NO_NAME) {
766 GSSEAP_KRB_INIT(&krbContext);
768 /* krbPrincipal is immutable, so lock not required */
769 *name_equal = krb5_principal_compare(krbContext,
771 name2->krbPrincipal);
774 return GSS_S_COMPLETE;