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);
220 importUserName(OM_uint32 *minor,
221 const gss_buffer_t nameBuffer,
225 krb5_context krbContext;
226 krb5_principal krbPrinc = NULL;
227 krb5_error_code code;
229 GSSEAP_KRB_INIT(&krbContext);
231 if (nameBuffer == GSS_C_NO_BUFFER) {
232 code = krb5_copy_principal(krbContext,
233 krbAnonymousPrincipal(), &krbPrinc);
236 return GSS_S_FAILURE;
241 major = bufferToString(minor, nameBuffer, &nameString);
242 if (GSS_ERROR(major))
246 * First, attempt to parse the name on the assumption that it includes
247 * a qualifying realm.
249 code = krb5_parse_name_flags(krbContext, nameString,
250 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM, &krbPrinc);
251 if (code == KRB5_PARSE_MALFORMED) {
252 char *defaultRealm = NULL;
256 * We need an explicit appdefaults check because, at least with MIT
257 * Kerberos, setting the context realm to NULL will reset it to the
258 * default Kerberos realm after the second call to get_default_realm.
259 * We want to make sure that the default Kerberos realm does not end
260 * up accidentally appended to an unqualified name.
262 gssEapGetDefaultRealm(krbContext, &defaultRealm);
264 if (defaultRealm == NULL)
265 flags |= KRB5_PRINCIPAL_PARSE_NO_REALM;
267 code = krb5_parse_name_flags(krbContext, nameString, flags, &krbPrinc);
269 if (defaultRealm != NULL)
270 GSSEAP_FREE(defaultRealm);
273 GSSEAP_FREE(nameString);
277 return GSS_S_FAILURE;
281 assert(krbPrinc != NULL);
283 major = krbPrincipalToName(minor, &krbPrinc, pName);
284 if (GSS_ERROR(major))
285 krb5_free_principal(krbContext, krbPrinc);
291 importAnonymousName(OM_uint32 *minor,
292 const gss_buffer_t nameBuffer GSSEAP_UNUSED,
295 return importUserName(minor, GSS_C_NO_BUFFER, pName);
298 #define UPDATE_REMAIN(n) do { \
303 #define CHECK_REMAIN(n) do { \
304 if (remain < (n)) { \
305 major = GSS_S_BAD_NAME; \
306 *minor = GSSEAP_TOK_TRUNC; \
312 gssEapImportNameInternal(OM_uint32 *minor,
313 const gss_buffer_t nameBuffer,
317 OM_uint32 major, tmpMinor;
318 krb5_context krbContext;
322 enum gss_eap_token_type tokType;
323 gss_name_t name = GSS_C_NO_NAME;
324 gss_OID mechanismUsed = GSS_C_NO_OID;
326 GSSEAP_KRB_INIT(&krbContext);
328 p = (unsigned char *)nameBuffer->value;
329 remain = nameBuffer->length;
331 if (flags & EXPORT_NAME_FLAG_OID) {
334 /* TOK_ID || MECH_OID_LEN || MECH_OID */
336 return GSS_S_BAD_NAME;
338 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
339 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
341 tokType = TOK_TYPE_EXPORT_NAME;
344 if (load_uint16_be(p) != tokType)
345 return GSS_S_BAD_NAME;
349 len = load_uint16_be(p);
351 return GSS_S_BAD_NAME;
356 return GSS_S_BAD_NAME;
359 mech.elements = &p[2];
361 CHECK_REMAIN(mech.length);
363 major = gssEapCanonicalizeOid(minor,
365 OID_FLAG_FAMILY_MECH_VALID |
366 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
368 if (GSS_ERROR(major))
371 UPDATE_REMAIN(2 + mech.length);
376 len = load_uint32_be(p);
385 major = importUserName(minor, &buf, &name);
386 if (GSS_ERROR(major))
389 name->mechanismUsed = mechanismUsed;
390 mechanismUsed = GSS_C_NO_OID;
392 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
398 major = gssEapImportAttrContext(minor, &buf, name);
399 if (GSS_ERROR(major))
403 major = GSS_S_COMPLETE;
407 if (GSS_ERROR(major)) {
408 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
409 gssEapReleaseName(&tmpMinor, &name);
418 importExportName(OM_uint32 *minor,
419 const gss_buffer_t nameBuffer,
422 return gssEapImportNameInternal(minor, nameBuffer, name,
423 EXPORT_NAME_FLAG_OID);
426 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
428 importCompositeExportName(OM_uint32 *minor,
429 const gss_buffer_t nameBuffer,
432 return gssEapImportNameInternal(minor, nameBuffer, name,
433 EXPORT_NAME_FLAG_OID |
434 EXPORT_NAME_FLAG_COMPOSITE);
438 struct gss_eap_name_import_provider {
440 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
444 gssEapImportName(OM_uint32 *minor,
445 const gss_buffer_t nameBuffer,
446 const gss_OID nameType,
447 const gss_OID mechType,
450 struct gss_eap_name_import_provider nameTypes[] = {
451 { GSS_EAP_NT_EAP_NAME, importUserName },
452 { GSS_C_NT_USER_NAME, importUserName },
453 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
454 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
455 { GSS_C_NT_ANONYMOUS, importAnonymousName },
456 { GSS_C_NT_EXPORT_NAME, importExportName },
457 { GSS_KRB5_NT_PRINCIPAL_NAME, importUserName },
458 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
459 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
463 OM_uint32 major = GSS_S_BAD_NAMETYPE;
465 gss_name_t name = GSS_C_NO_NAME;
467 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
468 if (oidEqual(nameTypes[i].oid,
469 nameType == GSS_C_NO_OID ? GSS_EAP_NT_EAP_NAME : nameType)) {
470 major = nameTypes[i].import(minor, nameBuffer, &name);
475 if (major == GSS_S_COMPLETE &&
476 mechType != GSS_C_NO_OID) {
477 assert(gssEapIsConcreteMechanismOid(mechType));
478 assert(name->mechanismUsed == GSS_C_NO_OID);
480 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
483 if (GSS_ERROR(major))
484 gssEapReleaseName(&tmpMinor, &name);
492 gssEapExportName(OM_uint32 *minor,
493 const gss_name_t name,
494 gss_buffer_t exportedName)
496 return gssEapExportNameInternal(minor, name, exportedName,
497 EXPORT_NAME_FLAG_OID);
501 gssEapExportNameInternal(OM_uint32 *minor,
502 const gss_name_t name,
503 gss_buffer_t exportedName,
506 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
507 krb5_context krbContext;
508 char *krbName = NULL;
509 size_t krbNameLen, exportedNameLen;
511 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
514 exportedName->length = 0;
515 exportedName->value = NULL;
517 if (name->mechanismUsed != GSS_C_NO_OID)
518 mech = name->mechanismUsed;
520 mech = GSS_EAP_MECHANISM;
522 GSSEAP_KRB_INIT(&krbContext);
524 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
526 major = GSS_S_FAILURE;
529 krbNameLen = strlen(krbName);
532 if (flags & EXPORT_NAME_FLAG_OID) {
533 exportedNameLen += 6 + mech->length;
535 exportedNameLen += 4 + krbNameLen;
536 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
537 major = gssEapExportAttrContext(minor, name, &attrs);
538 if (GSS_ERROR(major))
540 exportedNameLen += attrs.length;
543 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
544 if (exportedName->value == NULL) {
545 major = GSS_S_FAILURE;
549 exportedName->length = exportedNameLen;
551 p = (unsigned char *)exportedName->value;
553 if (flags & EXPORT_NAME_FLAG_OID) {
554 /* TOK | MECH_OID_LEN */
555 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
556 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
557 : TOK_TYPE_EXPORT_NAME,
560 store_uint16_be(mech->length + 2, p);
565 *p++ = mech->length & 0xff;
566 memcpy(p, mech->elements, mech->length);
571 store_uint32_be(krbNameLen, p);
575 memcpy(p, krbName, krbNameLen);
578 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
579 memcpy(p, attrs.value, attrs.length);
583 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
585 major = GSS_S_COMPLETE;
589 gss_release_buffer(&tmpMinor, &attrs);
590 if (GSS_ERROR(major))
591 gss_release_buffer(&tmpMinor, exportedName);
592 krb5_free_unparsed_name(krbContext, krbName);
598 gssEapCanonicalizeName(OM_uint32 *minor,
599 const gss_name_t input_name,
600 const gss_OID mech_type,
601 gss_name_t *dest_name)
603 OM_uint32 major, tmpMinor;
604 krb5_context krbContext;
608 if (input_name == GSS_C_NO_NAME) {
610 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
613 GSSEAP_KRB_INIT(&krbContext);
615 major = gssEapAllocName(minor, &name);
616 if (GSS_ERROR(major)) {
620 if (mech_type != GSS_C_NO_OID)
621 mech_used = mech_type;
623 mech_used = input_name->mechanismUsed;
625 major = gssEapCanonicalizeOid(minor,
628 &name->mechanismUsed);
629 if (GSS_ERROR(major))
632 name->flags = input_name->flags;
634 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
635 &name->krbPrincipal);
637 major = GSS_S_FAILURE;
641 if (input_name->attrCtx != NULL) {
642 major = gssEapDuplicateAttrContext(minor, input_name, name);
643 if (GSS_ERROR(major))
650 if (GSS_ERROR(major)) {
651 gssEapReleaseName(&tmpMinor, &name);
658 gssEapDuplicateName(OM_uint32 *minor,
659 const gss_name_t input_name,
660 gss_name_t *dest_name)
662 return gssEapCanonicalizeName(minor, input_name,
663 GSS_C_NO_OID, dest_name);
667 gssEapDisplayName(OM_uint32 *minor,
669 gss_buffer_t output_name_buffer,
670 gss_OID *output_name_type)
673 krb5_context krbContext;
678 GSSEAP_KRB_INIT(&krbContext);
680 output_name_buffer->length = 0;
681 output_name_buffer->value = NULL;
683 if (name == GSS_C_NO_NAME) {
685 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
689 * According to draft-ietf-abfab-gss-eap-01, when the realm is
690 * absent the trailing '@' is not included.
692 #ifdef HAVE_HEIMDAL_VERSION
693 if (KRB_PRINC_REALM(name->krbPrincipal) == NULL ||
694 KRB_PRINC_REALM(name->krBPrincipal)[0] == '\0')
696 if (KRB_PRINC_REALM(name->krbPrincipal)->length == 0)
698 flags |= KRB5_PRINCIPAL_UNPARSE_NO_REALM;
700 *minor = krb5_unparse_name_flags(krbContext, name->krbPrincipal,
703 return GSS_S_FAILURE;
706 major = makeStringBuffer(minor, krbName, output_name_buffer);
707 if (GSS_ERROR(major)) {
708 krb5_free_unparsed_name(krbContext, krbName);
712 krb5_free_unparsed_name(krbContext, krbName);
714 if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
715 krb5_principal_compare(krbContext,
716 name->krbPrincipal, krbAnonymousPrincipal())) {
717 name_type = GSS_C_NT_ANONYMOUS;
719 name_type = GSS_EAP_NT_EAP_NAME;
722 if (output_name_type != NULL)
723 *output_name_type = name_type;
725 return GSS_S_COMPLETE;