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) {
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 name->flags |= NAME_FLAG_NAI;
150 return GSS_S_COMPLETE;
154 gssEapGetDefaultRealm(krb5_context krbContext)
156 char *defaultRealm = NULL;
158 krb5_appdefault_string(krbContext, "eap_gss",
159 NULL, "default_realm", "", &defaultRealm);
165 importServiceName(OM_uint32 *minor,
166 const gss_buffer_t nameBuffer,
170 krb5_error_code code;
171 krb5_context krbContext;
172 krb5_principal krbPrinc;
173 char *service, *host, *realm = NULL;
175 GSSEAP_KRB_INIT(&krbContext);
177 major = bufferToString(minor, nameBuffer, &service);
178 if (GSS_ERROR(major))
181 host = strchr(service, '@');
187 realm = gssEapGetDefaultRealm(krbContext);
189 code = krb5_build_principal(krbContext,
191 realm != NULL ? strlen(realm) : 0,
192 realm != NULL ? realm : "",
198 KRB_PRINC_TYPE(krbPrinc) = KRB5_NT_SRV_HST;
200 major = krbPrincipalToName(minor, &krbPrinc, pName);
201 if (GSS_ERROR(major))
202 krb5_free_principal(krbContext, krbPrinc);
204 major = GSS_S_FAILURE;
205 *minor = GSSEAP_BAD_SERVICE_NAME;
209 krb5_free_default_realm(krbContext, realm);
210 GSSEAP_FREE(service);
215 #define IMPORT_FLAG_DEFAULT_REALM 0x1
218 * Import an EAP name, possibly appending the default GSS EAP realm,
221 importEapNameFlags(OM_uint32 *minor,
222 const gss_buffer_t nameBuffer,
223 OM_uint32 importFlags,
227 krb5_context krbContext;
228 krb5_principal krbPrinc = NULL;
229 krb5_error_code code;
232 GSSEAP_KRB_INIT(&krbContext);
234 if (nameBuffer == GSS_C_NO_BUFFER) {
236 code = KRB5_PARSE_MALFORMED;
238 major = bufferToString(minor, nameBuffer, &nameString);
239 if (GSS_ERROR(major))
243 * First, attempt to parse the name on the assumption that it includes
244 * a qualifying realm. This allows us to avoid accidentally appending
245 * the default Kerberos realm to an unqualified name. (A bug in MIT
246 * Kerberos prevents the default realm being set to an empty value.)
248 code = krb5_parse_name_flags(krbContext, nameString,
249 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM, &krbPrinc);
252 if (code == KRB5_PARSE_MALFORMED) {
253 char *defaultRealm = NULL;
256 /* Possibly append the default EAP realm if required */
257 if (importFlags & IMPORT_FLAG_DEFAULT_REALM)
258 defaultRealm = gssEapGetDefaultRealm(krbContext);
260 /* If no default realm, leave the realm empty in the parsed name */
261 if (defaultRealm == NULL || defaultRealm[0] == '\0')
262 parseFlags |= KRB5_PRINCIPAL_PARSE_NO_REALM;
264 code = krb5_parse_name_flags(krbContext, nameString, parseFlags, &krbPrinc);
266 #ifdef HAVE_HEIMDAL_VERSION
267 if (code == 0 && KRB_PRINC_REALM(krbPrinc) == NULL) {
268 KRB_PRINC_REALM(krbPrinc) = KRB_CALLOC(1, sizeof(char));
269 if (KRB_PRINC_REALM(krbPrinc) == NULL)
274 if (defaultRealm != NULL)
275 krb5_free_default_realm(krbContext, defaultRealm);
278 if (nameBuffer != GSS_C_NO_BUFFER)
279 GSSEAP_FREE(nameString);
283 return GSS_S_FAILURE;
286 GSSEAP_ASSERT(krbPrinc != NULL);
288 major = krbPrincipalToName(minor, &krbPrinc, pName);
289 if (GSS_ERROR(major))
290 krb5_free_principal(krbContext, krbPrinc);
296 importEapName(OM_uint32 *minor,
297 const gss_buffer_t nameBuffer,
300 return importEapNameFlags(minor, nameBuffer, 0, pName);
304 importUserName(OM_uint32 *minor,
305 const gss_buffer_t nameBuffer,
308 return importEapNameFlags(minor, nameBuffer, IMPORT_FLAG_DEFAULT_REALM, pName);
312 importAnonymousName(OM_uint32 *minor,
313 const gss_buffer_t nameBuffer GSSEAP_UNUSED,
316 return importEapNameFlags(minor, GSS_C_NO_BUFFER, 0, pName);
319 #define UPDATE_REMAIN(n) do { \
324 #define CHECK_REMAIN(n) do { \
325 if (remain < (n)) { \
326 major = GSS_S_BAD_NAME; \
327 *minor = GSSEAP_TOK_TRUNC; \
333 gssEapImportNameInternal(OM_uint32 *minor,
334 const gss_buffer_t nameBuffer,
338 OM_uint32 major, tmpMinor;
339 krb5_context krbContext;
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) {
353 enum gss_eap_token_type tokType;
354 uint16_t wireTokType;
356 /* TOK_ID || MECH_OID_LEN || MECH_OID */
358 *minor = GSSEAP_BAD_NAME_TOKEN;
359 return GSS_S_BAD_NAME;
362 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
363 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
365 tokType = TOK_TYPE_EXPORT_NAME;
368 wireTokType = load_uint16_be(p);
370 if ((flags & EXPORT_NAME_FLAG_ALLOW_COMPOSITE) &&
371 wireTokType == TOK_TYPE_EXPORT_NAME_COMPOSITE) {
372 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
373 flags |= EXPORT_NAME_FLAG_COMPOSITE;
376 if (wireTokType != tokType) {
377 *minor = GSSEAP_WRONG_TOK_ID;
378 return GSS_S_BAD_NAME;
383 len = load_uint16_be(p);
385 *minor = GSSEAP_BAD_NAME_TOKEN;
386 return GSS_S_BAD_NAME;
392 *minor = GSSEAP_BAD_NAME_TOKEN;
393 return GSS_S_BAD_NAME;
397 mech.elements = &p[2];
399 CHECK_REMAIN(mech.length);
401 major = gssEapCanonicalizeOid(minor,
403 OID_FLAG_FAMILY_MECH_VALID |
404 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
406 if (GSS_ERROR(major))
409 UPDATE_REMAIN(2 + mech.length);
414 len = load_uint32_be(p);
423 major = importEapNameFlags(minor, &buf, 0, &name);
424 if (GSS_ERROR(major))
427 name->mechanismUsed = mechanismUsed;
428 mechanismUsed = GSS_C_NO_OID;
430 #ifdef GSSEAP_ENABLE_ACCEPTOR
431 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
437 major = gssEapImportAttrContext(minor, &buf, name);
438 if (GSS_ERROR(major))
443 major = GSS_S_COMPLETE;
447 if (GSS_ERROR(major)) {
448 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
449 gssEapReleaseName(&tmpMinor, &name);
458 importExportName(OM_uint32 *minor,
459 const gss_buffer_t nameBuffer,
462 return gssEapImportNameInternal(minor, nameBuffer, name,
463 EXPORT_NAME_FLAG_OID |
464 EXPORT_NAME_FLAG_ALLOW_COMPOSITE);
467 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
469 importCompositeExportName(OM_uint32 *minor,
470 const gss_buffer_t nameBuffer,
473 return gssEapImportNameInternal(minor, nameBuffer, name,
474 EXPORT_NAME_FLAG_OID |
475 EXPORT_NAME_FLAG_COMPOSITE);
479 struct gss_eap_name_import_provider {
481 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
485 gssEapImportName(OM_uint32 *minor,
486 const gss_buffer_t nameBuffer,
487 const gss_OID nameType,
488 const gss_OID mechType,
491 struct gss_eap_name_import_provider nameTypes[] = {
492 { GSS_EAP_NT_EAP_NAME, importEapName },
493 { GSS_C_NT_USER_NAME, importUserName },
494 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
495 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
496 { GSS_C_NT_ANONYMOUS, importAnonymousName },
497 { GSS_C_NT_EXPORT_NAME, importExportName },
498 { GSS_KRB5_NT_PRINCIPAL_NAME, importUserName },
499 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
500 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
504 OM_uint32 major = GSS_S_BAD_NAMETYPE;
506 gss_name_t name = GSS_C_NO_NAME;
508 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
509 if (oidEqual(nameTypes[i].oid,
510 nameType == GSS_C_NO_OID ? GSS_EAP_NT_EAP_NAME : nameType)) {
511 major = nameTypes[i].import(minor, nameBuffer, &name);
516 if (major == GSS_S_COMPLETE &&
517 mechType != GSS_C_NO_OID) {
518 GSSEAP_ASSERT(gssEapIsConcreteMechanismOid(mechType));
519 GSSEAP_ASSERT(name->mechanismUsed == GSS_C_NO_OID);
521 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
524 if (GSS_ERROR(major))
525 gssEapReleaseName(&tmpMinor, &name);
533 gssEapExportName(OM_uint32 *minor,
534 const gss_name_t name,
535 gss_buffer_t exportedName)
537 return gssEapExportNameInternal(minor, name, exportedName,
538 EXPORT_NAME_FLAG_OID);
542 gssEapExportNameInternal(OM_uint32 *minor,
543 const gss_name_t name,
544 gss_buffer_t exportedName,
547 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
548 gss_buffer_desc nameBuf = GSS_C_EMPTY_BUFFER;
549 size_t exportedNameLen;
551 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
554 exportedName->length = 0;
555 exportedName->value = NULL;
557 if (name->mechanismUsed != GSS_C_NO_OID)
558 mech = name->mechanismUsed;
560 mech = GSS_EAP_MECHANISM;
562 major = gssEapDisplayName(minor, name, &nameBuf, NULL);
563 if (GSS_ERROR(major))
567 if (flags & EXPORT_NAME_FLAG_OID) {
568 exportedNameLen += 6 + mech->length;
570 exportedNameLen += 4 + nameBuf.length;
571 #ifdef GSSEAP_ENABLE_ACCEPTOR
572 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
573 major = gssEapExportAttrContext(minor, name, &attrs);
574 if (GSS_ERROR(major))
576 exportedNameLen += attrs.length;
580 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
581 if (exportedName->value == NULL) {
582 major = GSS_S_FAILURE;
586 exportedName->length = exportedNameLen;
588 p = (unsigned char *)exportedName->value;
590 if (flags & EXPORT_NAME_FLAG_OID) {
591 /* TOK | MECH_OID_LEN */
592 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
593 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
594 : TOK_TYPE_EXPORT_NAME,
597 store_uint16_be(mech->length + 2, p);
602 *p++ = mech->length & 0xff;
603 memcpy(p, mech->elements, mech->length);
608 store_uint32_be(nameBuf.length, p);
612 memcpy(p, nameBuf.value, nameBuf.length);
615 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
616 memcpy(p, attrs.value, attrs.length);
620 GSSEAP_ASSERT(p == (unsigned char *)exportedName->value + exportedNameLen);
622 major = GSS_S_COMPLETE;
626 gss_release_buffer(&tmpMinor, &attrs);
627 gss_release_buffer(&tmpMinor, &nameBuf);
628 if (GSS_ERROR(major))
629 gss_release_buffer(&tmpMinor, exportedName);
635 gssEapCanonicalizeName(OM_uint32 *minor,
636 const gss_name_t input_name,
637 const gss_OID mech_type,
638 gss_name_t *dest_name)
640 OM_uint32 major, tmpMinor;
641 krb5_context krbContext;
645 if (input_name == GSS_C_NO_NAME) {
647 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
650 GSSEAP_KRB_INIT(&krbContext);
652 major = gssEapAllocName(minor, &name);
653 if (GSS_ERROR(major)) {
657 if (mech_type != GSS_C_NO_OID)
658 mech_used = mech_type;
660 mech_used = input_name->mechanismUsed;
662 major = gssEapCanonicalizeOid(minor,
665 &name->mechanismUsed);
666 if (GSS_ERROR(major))
669 name->flags = input_name->flags;
671 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
672 &name->krbPrincipal);
674 major = GSS_S_FAILURE;
678 #ifdef GSSEAP_ENABLE_ACCEPTOR
679 if (input_name->attrCtx != NULL) {
680 major = gssEapDuplicateAttrContext(minor, input_name, name);
681 if (GSS_ERROR(major))
689 if (GSS_ERROR(major)) {
690 gssEapReleaseName(&tmpMinor, &name);
697 gssEapDuplicateName(OM_uint32 *minor,
698 const gss_name_t input_name,
699 gss_name_t *dest_name)
701 return gssEapCanonicalizeName(minor, input_name,
702 GSS_C_NO_OID, dest_name);
706 gssEapDisplayName(OM_uint32 *minor,
708 gss_buffer_t output_name_buffer,
709 gss_OID *output_name_type)
712 krb5_context krbContext;
717 GSSEAP_KRB_INIT(&krbContext);
719 output_name_buffer->length = 0;
720 output_name_buffer->value = NULL;
722 if (name == GSS_C_NO_NAME) {
724 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
728 * According to draft-ietf-abfab-gss-eap-01, when the realm is
729 * absent the trailing '@' is not included.
731 #ifdef HAVE_HEIMDAL_VERSION
732 if (KRB_PRINC_REALM(name->krbPrincipal) == NULL ||
733 KRB_PRINC_REALM(name->krbPrincipal)[0] == '\0')
735 if (KRB_PRINC_REALM(name->krbPrincipal)->length == 0)
737 flags |= KRB5_PRINCIPAL_UNPARSE_NO_REALM;
739 *minor = krb5_unparse_name_flags(krbContext, name->krbPrincipal,
742 return GSS_S_FAILURE;
745 major = makeStringBuffer(minor, krbName, output_name_buffer);
746 if (GSS_ERROR(major)) {
747 krb5_free_unparsed_name(krbContext, krbName);
751 krb5_free_unparsed_name(krbContext, krbName);
753 if (output_name_buffer->length == 0) {
754 name_type = GSS_C_NT_ANONYMOUS;
755 } else if (name->flags & NAME_FLAG_NAI) {
756 name_type = GSS_C_NT_USER_NAME;
758 name_type = GSS_EAP_NT_EAP_NAME;
761 if (output_name_type != NULL)
762 *output_name_type = name_type;
764 return GSS_S_COMPLETE;
768 gssEapCompareName(OM_uint32 *minor,
773 krb5_context krbContext;
777 if (name1 == GSS_C_NO_NAME && name2 == GSS_C_NO_NAME) {
779 } else if (name1 != GSS_C_NO_NAME && name2 != GSS_C_NO_NAME) {
780 GSSEAP_KRB_INIT(&krbContext);
782 /* krbPrincipal is immutable, so lock not required */
783 *name_equal = krb5_principal_compare(krbContext,
785 name2->krbPrincipal);
788 return GSS_S_COMPLETE;