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;
152 static krb5_error_code
153 gssEapGetDefaultRealm(krb5_context krbContext, char **defaultRealm)
155 *defaultRealm = NULL;
157 krb5_appdefault_string(krbContext, "eap_gss",
158 NULL, "default_realm", "", defaultRealm);
160 if (*defaultRealm != NULL && (*defaultRealm)[0] == '\0') {
161 GSSEAP_FREE(*defaultRealm);
162 *defaultRealm = NULL;
165 return (*defaultRealm != NULL) ? 0 : KRB5_CONFIG_NODEFREALM;
169 importServiceName(OM_uint32 *minor,
170 const gss_buffer_t nameBuffer,
174 krb5_error_code code;
175 krb5_context krbContext;
176 krb5_principal krbPrinc;
177 char *service, *host, *realm = NULL;
179 GSSEAP_KRB_INIT(&krbContext);
181 major = bufferToString(minor, nameBuffer, &service);
182 if (GSS_ERROR(major))
185 host = strchr(service, '@');
191 gssEapGetDefaultRealm(krbContext, &realm);
193 code = krb5_build_principal(krbContext,
195 realm != NULL ? strlen(realm) : 0,
196 realm != NULL ? realm : "",
202 KRB_PRINC_TYPE(krbPrinc) = KRB5_NT_SRV_HST;
204 major = krbPrincipalToName(minor, &krbPrinc, pName);
205 if (GSS_ERROR(major))
206 krb5_free_principal(krbContext, krbPrinc);
208 major = GSS_S_FAILURE;
209 *minor = GSSEAP_BAD_SERVICE_NAME;
214 GSSEAP_FREE(service);
219 #define IMPORT_FLAG_DEFAULT_REALM 0x1
222 * Import an EAP name, possibly appending the default GSS EAP realm,
225 importEapNameFlags(OM_uint32 *minor,
226 const gss_buffer_t nameBuffer,
227 OM_uint32 importFlags,
231 krb5_context krbContext;
232 krb5_principal krbPrinc = NULL;
233 krb5_error_code code;
235 GSSEAP_KRB_INIT(&krbContext);
237 if (nameBuffer == GSS_C_NO_BUFFER) {
238 code = krb5_copy_principal(krbContext,
239 krbAnonymousPrincipal(), &krbPrinc);
242 return GSS_S_FAILURE;
247 major = bufferToString(minor, nameBuffer, &nameString);
248 if (GSS_ERROR(major))
252 * First, attempt to parse the name on the assumption that it includes
253 * a qualifying realm. This allows us to avoid accidentally appending
254 * the default Kerberos realm to an unqualified name. (A bug in MIT
255 * Kerberos prevents the default realm being set to an empty value.)
257 code = krb5_parse_name_flags(krbContext, nameString,
258 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM, &krbPrinc);
259 if (code == KRB5_PARSE_MALFORMED) {
260 char *defaultRealm = NULL;
263 /* Possibly append the default EAP realm if required */
264 if (importFlags & IMPORT_FLAG_DEFAULT_REALM)
265 gssEapGetDefaultRealm(krbContext, &defaultRealm);
267 /* If no default realm, leave the realm empty in the parsed name */
268 if (defaultRealm == NULL)
269 parseFlags |= KRB5_PRINCIPAL_PARSE_NO_REALM;
271 code = krb5_parse_name_flags(krbContext, nameString, parseFlags, &krbPrinc);
273 if (defaultRealm != NULL)
274 GSSEAP_FREE(defaultRealm);
277 GSSEAP_FREE(nameString);
281 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 enum gss_eap_token_type tokType;
343 gss_name_t name = GSS_C_NO_NAME;
344 gss_OID mechanismUsed = GSS_C_NO_OID;
346 GSSEAP_KRB_INIT(&krbContext);
348 p = (unsigned char *)nameBuffer->value;
349 remain = nameBuffer->length;
351 if (flags & EXPORT_NAME_FLAG_OID) {
354 /* TOK_ID || MECH_OID_LEN || MECH_OID */
356 return GSS_S_BAD_NAME;
358 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
359 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
361 tokType = TOK_TYPE_EXPORT_NAME;
364 if (load_uint16_be(p) != tokType)
365 return GSS_S_BAD_NAME;
369 len = load_uint16_be(p);
371 return GSS_S_BAD_NAME;
376 return GSS_S_BAD_NAME;
379 mech.elements = &p[2];
381 CHECK_REMAIN(mech.length);
383 major = gssEapCanonicalizeOid(minor,
385 OID_FLAG_FAMILY_MECH_VALID |
386 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
388 if (GSS_ERROR(major))
391 UPDATE_REMAIN(2 + mech.length);
396 len = load_uint32_be(p);
405 major = importEapNameFlags(minor, &buf, 0, &name);
406 if (GSS_ERROR(major))
409 name->mechanismUsed = mechanismUsed;
410 mechanismUsed = GSS_C_NO_OID;
412 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
418 major = gssEapImportAttrContext(minor, &buf, name);
419 if (GSS_ERROR(major))
423 major = GSS_S_COMPLETE;
427 if (GSS_ERROR(major)) {
428 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
429 gssEapReleaseName(&tmpMinor, &name);
438 importExportName(OM_uint32 *minor,
439 const gss_buffer_t nameBuffer,
442 return gssEapImportNameInternal(minor, nameBuffer, name,
443 EXPORT_NAME_FLAG_OID);
446 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
448 importCompositeExportName(OM_uint32 *minor,
449 const gss_buffer_t nameBuffer,
452 return gssEapImportNameInternal(minor, nameBuffer, name,
453 EXPORT_NAME_FLAG_OID |
454 EXPORT_NAME_FLAG_COMPOSITE);
458 struct gss_eap_name_import_provider {
460 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
464 gssEapImportName(OM_uint32 *minor,
465 const gss_buffer_t nameBuffer,
466 const gss_OID nameType,
467 const gss_OID mechType,
470 struct gss_eap_name_import_provider nameTypes[] = {
471 { GSS_EAP_NT_EAP_NAME, importEapName },
472 { GSS_C_NT_USER_NAME, importUserName },
473 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
474 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
475 { GSS_C_NT_ANONYMOUS, importAnonymousName },
476 { GSS_C_NT_EXPORT_NAME, importExportName },
477 { GSS_KRB5_NT_PRINCIPAL_NAME, importUserName },
478 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
479 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
483 OM_uint32 major = GSS_S_BAD_NAMETYPE;
485 gss_name_t name = GSS_C_NO_NAME;
487 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
488 if (oidEqual(nameTypes[i].oid,
489 nameType == GSS_C_NO_OID ? GSS_EAP_NT_EAP_NAME : nameType)) {
490 major = nameTypes[i].import(minor, nameBuffer, &name);
495 if (major == GSS_S_COMPLETE &&
496 mechType != GSS_C_NO_OID) {
497 assert(gssEapIsConcreteMechanismOid(mechType));
498 assert(name->mechanismUsed == GSS_C_NO_OID);
500 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
503 if (GSS_ERROR(major))
504 gssEapReleaseName(&tmpMinor, &name);
512 gssEapExportName(OM_uint32 *minor,
513 const gss_name_t name,
514 gss_buffer_t exportedName)
516 return gssEapExportNameInternal(minor, name, exportedName,
517 EXPORT_NAME_FLAG_OID);
521 gssEapExportNameInternal(OM_uint32 *minor,
522 const gss_name_t name,
523 gss_buffer_t exportedName,
526 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
527 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
528 size_t exportedNameLen;
530 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
533 exportedName->length = 0;
534 exportedName->value = NULL;
536 if (name->mechanismUsed != GSS_C_NO_OID)
537 mech = name->mechanismUsed;
539 mech = GSS_EAP_MECHANISM;
541 major = gssEapDisplayName(minor, name, &nameBuf, NULL);
542 if (GSS_ERROR(major))
546 if (flags & EXPORT_NAME_FLAG_OID) {
547 exportedNameLen += 6 + mech->length;
549 exportedNameLen += 4 + nameBuf.length;
550 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
551 major = gssEapExportAttrContext(minor, name, &attrs);
552 if (GSS_ERROR(major))
554 exportedNameLen += attrs.length;
557 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
558 if (exportedName->value == NULL) {
559 major = GSS_S_FAILURE;
563 exportedName->length = exportedNameLen;
565 p = (unsigned char *)exportedName->value;
567 if (flags & EXPORT_NAME_FLAG_OID) {
568 /* TOK | MECH_OID_LEN */
569 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
570 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
571 : TOK_TYPE_EXPORT_NAME,
574 store_uint16_be(mech->length + 2, p);
579 *p++ = mech->length & 0xff;
580 memcpy(p, mech->elements, mech->length);
585 store_uint32_be(nameBuf.length, p);
589 memcpy(p, nameBuf.value, nameBuf.length);
592 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
593 memcpy(p, attrs.value, attrs.length);
597 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
599 major = GSS_S_COMPLETE;
603 gss_release_buffer(&tmpMinor, &attrs);
604 gss_release_buffer(&tmpMinor, &nameBuf);
605 if (GSS_ERROR(major))
606 gss_release_buffer(&tmpMinor, exportedName);
612 gssEapCanonicalizeName(OM_uint32 *minor,
613 const gss_name_t input_name,
614 const gss_OID mech_type,
615 gss_name_t *dest_name)
617 OM_uint32 major, tmpMinor;
618 krb5_context krbContext;
622 if (input_name == GSS_C_NO_NAME) {
624 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
627 GSSEAP_KRB_INIT(&krbContext);
629 major = gssEapAllocName(minor, &name);
630 if (GSS_ERROR(major)) {
634 if (mech_type != GSS_C_NO_OID)
635 mech_used = mech_type;
637 mech_used = input_name->mechanismUsed;
639 major = gssEapCanonicalizeOid(minor,
642 &name->mechanismUsed);
643 if (GSS_ERROR(major))
646 name->flags = input_name->flags;
648 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
649 &name->krbPrincipal);
651 major = GSS_S_FAILURE;
655 if (input_name->attrCtx != NULL) {
656 major = gssEapDuplicateAttrContext(minor, input_name, name);
657 if (GSS_ERROR(major))
664 if (GSS_ERROR(major)) {
665 gssEapReleaseName(&tmpMinor, &name);
672 gssEapDuplicateName(OM_uint32 *minor,
673 const gss_name_t input_name,
674 gss_name_t *dest_name)
676 return gssEapCanonicalizeName(minor, input_name,
677 GSS_C_NO_OID, dest_name);
681 gssEapDisplayName(OM_uint32 *minor,
683 gss_buffer_t output_name_buffer,
684 gss_OID *output_name_type)
687 krb5_context krbContext;
692 GSSEAP_KRB_INIT(&krbContext);
694 output_name_buffer->length = 0;
695 output_name_buffer->value = NULL;
697 if (name == GSS_C_NO_NAME) {
699 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
703 * According to draft-ietf-abfab-gss-eap-01, when the realm is
704 * absent the trailing '@' is not included.
706 #ifdef HAVE_HEIMDAL_VERSION
707 if (KRB_PRINC_REALM(name->krbPrincipal) == NULL ||
708 KRB_PRINC_REALM(name->krbPrincipal)[0] == '\0')
710 if (KRB_PRINC_REALM(name->krbPrincipal)->length == 0)
712 flags |= KRB5_PRINCIPAL_UNPARSE_NO_REALM;
714 *minor = krb5_unparse_name_flags(krbContext, name->krbPrincipal,
717 return GSS_S_FAILURE;
720 major = makeStringBuffer(minor, krbName, output_name_buffer);
721 if (GSS_ERROR(major)) {
722 krb5_free_unparsed_name(krbContext, krbName);
726 krb5_free_unparsed_name(krbContext, krbName);
728 if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
729 krb5_principal_compare(krbContext,
730 name->krbPrincipal, krbAnonymousPrincipal())) {
731 name_type = GSS_C_NT_ANONYMOUS;
733 name_type = GSS_EAP_NT_EAP_NAME;
736 if (output_name_type != NULL)
737 *output_name_type = name_type;
739 return GSS_S_COMPLETE;