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 return (*defaultRealm != NULL) ? 0 : KRB5_CONFIG_NODEFREALM;
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 gssEapGetDefaultRealm(krbContext, &realm);
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);
215 importUserName(OM_uint32 *minor,
216 const gss_buffer_t nameBuffer,
220 krb5_context krbContext;
221 krb5_principal krbPrinc = NULL;
222 krb5_error_code code;
224 GSSEAP_KRB_INIT(&krbContext);
226 if (nameBuffer == GSS_C_NO_BUFFER) {
227 code = krb5_copy_principal(krbContext,
228 krbAnonymousPrincipal(), &krbPrinc);
231 return GSS_S_FAILURE;
236 major = bufferToString(minor, nameBuffer, &nameString);
237 if (GSS_ERROR(major))
241 * First, attempt to parse the name on the assumption that it includes
242 * a qualifying realm.
244 code = krb5_parse_name_flags(krbContext, nameString,
245 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM, &krbPrinc);
246 if (code == KRB5_PARSE_MALFORMED) {
247 char *defaultRealm = NULL;
251 * We need an explicit appdefaults check because, at least with MIT
252 * Kerberos, setting the context realm to NULL will reset it to the
253 * default Kerberos realm after the second call to get_default_realm.
254 * We want to make sure that the default Kerberos realm does not end
255 * up accidentally appended to an unqualified name.
257 gssEapGetDefaultRealm(krbContext, &defaultRealm);
259 if (defaultRealm == NULL || defaultRealm[0] == '\0')
260 flags |= KRB5_PRINCIPAL_PARSE_NO_REALM;
262 code = krb5_parse_name_flags(krbContext, nameString, flags, &krbPrinc);
264 if (defaultRealm != NULL)
265 GSSEAP_FREE(defaultRealm);
268 GSSEAP_FREE(nameString);
272 return GSS_S_FAILURE;
276 assert(krbPrinc != NULL);
278 major = krbPrincipalToName(minor, &krbPrinc, pName);
279 if (GSS_ERROR(major))
280 krb5_free_principal(krbContext, krbPrinc);
286 importAnonymousName(OM_uint32 *minor,
287 const gss_buffer_t nameBuffer GSSEAP_UNUSED,
291 krb5_context krbContext;
292 krb5_principal krbPrinc;
294 GSSEAP_KRB_INIT(&krbContext);
296 *minor = krb5_copy_principal(krbContext, krbAnonymousPrincipal(),
299 return GSS_S_FAILURE;
301 major = krbPrincipalToName(minor, &krbPrinc, pName);
302 if (GSS_ERROR(major)) {
303 krb5_free_principal(krbContext, krbPrinc);
309 #define UPDATE_REMAIN(n) do { \
314 #define CHECK_REMAIN(n) do { \
315 if (remain < (n)) { \
316 major = GSS_S_BAD_NAME; \
317 *minor = GSSEAP_TOK_TRUNC; \
323 gssEapImportNameInternal(OM_uint32 *minor,
324 const gss_buffer_t nameBuffer,
328 OM_uint32 major, tmpMinor;
329 krb5_context krbContext;
333 enum gss_eap_token_type tokType;
334 gss_name_t name = GSS_C_NO_NAME;
335 gss_OID mechanismUsed = GSS_C_NO_OID;
337 GSSEAP_KRB_INIT(&krbContext);
339 p = (unsigned char *)nameBuffer->value;
340 remain = nameBuffer->length;
342 if (flags & EXPORT_NAME_FLAG_OID) {
345 /* TOK_ID || MECH_OID_LEN || MECH_OID */
347 return GSS_S_BAD_NAME;
349 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
350 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
352 tokType = TOK_TYPE_EXPORT_NAME;
355 if (load_uint16_be(p) != tokType)
356 return GSS_S_BAD_NAME;
360 len = load_uint16_be(p);
362 return GSS_S_BAD_NAME;
367 return GSS_S_BAD_NAME;
370 mech.elements = &p[2];
372 CHECK_REMAIN(mech.length);
374 major = gssEapCanonicalizeOid(minor,
376 OID_FLAG_FAMILY_MECH_VALID |
377 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
379 if (GSS_ERROR(major))
382 UPDATE_REMAIN(2 + mech.length);
387 len = load_uint32_be(p);
396 major = importUserName(minor, &buf, &name);
397 if (GSS_ERROR(major))
400 name->mechanismUsed = mechanismUsed;
401 mechanismUsed = GSS_C_NO_OID;
403 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
409 major = gssEapImportAttrContext(minor, &buf, name);
410 if (GSS_ERROR(major))
414 major = GSS_S_COMPLETE;
418 if (GSS_ERROR(major)) {
419 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
420 gssEapReleaseName(&tmpMinor, &name);
429 importExportName(OM_uint32 *minor,
430 const gss_buffer_t nameBuffer,
433 return gssEapImportNameInternal(minor, nameBuffer, name,
434 EXPORT_NAME_FLAG_OID);
437 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
439 importCompositeExportName(OM_uint32 *minor,
440 const gss_buffer_t nameBuffer,
443 return gssEapImportNameInternal(minor, nameBuffer, name,
444 EXPORT_NAME_FLAG_OID |
445 EXPORT_NAME_FLAG_COMPOSITE);
449 struct gss_eap_name_import_provider {
451 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
455 gssEapImportName(OM_uint32 *minor,
456 const gss_buffer_t nameBuffer,
457 const gss_OID nameType,
458 const gss_OID mechType,
461 struct gss_eap_name_import_provider nameTypes[] = {
462 { GSS_EAP_NT_EAP_NAME, importUserName },
463 { GSS_C_NT_USER_NAME, importUserName },
464 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
465 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
466 { GSS_C_NT_ANONYMOUS, importAnonymousName },
467 { GSS_C_NT_EXPORT_NAME, importExportName },
468 { GSS_KRB5_NT_PRINCIPAL_NAME, importUserName },
469 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
470 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
474 OM_uint32 major = GSS_S_BAD_NAMETYPE;
476 gss_name_t name = GSS_C_NO_NAME;
478 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
479 if (oidEqual(nameTypes[i].oid,
480 nameType == GSS_C_NO_OID ? GSS_EAP_NT_EAP_NAME : nameType)) {
481 major = nameTypes[i].import(minor, nameBuffer, &name);
486 if (major == GSS_S_COMPLETE &&
487 mechType != GSS_C_NO_OID) {
488 assert(gssEapIsConcreteMechanismOid(mechType));
489 assert(name->mechanismUsed == GSS_C_NO_OID);
491 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
494 if (GSS_ERROR(major))
495 gssEapReleaseName(&tmpMinor, &name);
503 gssEapExportName(OM_uint32 *minor,
504 const gss_name_t name,
505 gss_buffer_t exportedName)
507 return gssEapExportNameInternal(minor, name, exportedName,
508 EXPORT_NAME_FLAG_OID);
512 gssEapExportNameInternal(OM_uint32 *minor,
513 const gss_name_t name,
514 gss_buffer_t exportedName,
517 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
518 krb5_context krbContext;
519 char *krbName = NULL;
520 size_t krbNameLen, exportedNameLen;
522 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
525 exportedName->length = 0;
526 exportedName->value = NULL;
528 if (name->mechanismUsed != GSS_C_NO_OID)
529 mech = name->mechanismUsed;
531 mech = GSS_EAP_MECHANISM;
533 GSSEAP_KRB_INIT(&krbContext);
535 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
537 major = GSS_S_FAILURE;
540 krbNameLen = strlen(krbName);
543 if (flags & EXPORT_NAME_FLAG_OID) {
544 exportedNameLen += 6 + mech->length;
546 exportedNameLen += 4 + krbNameLen;
547 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
548 major = gssEapExportAttrContext(minor, name, &attrs);
549 if (GSS_ERROR(major))
551 exportedNameLen += attrs.length;
554 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
555 if (exportedName->value == NULL) {
556 major = GSS_S_FAILURE;
560 exportedName->length = exportedNameLen;
562 p = (unsigned char *)exportedName->value;
564 if (flags & EXPORT_NAME_FLAG_OID) {
565 /* TOK | MECH_OID_LEN */
566 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
567 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
568 : TOK_TYPE_EXPORT_NAME,
571 store_uint16_be(mech->length + 2, p);
576 *p++ = mech->length & 0xff;
577 memcpy(p, mech->elements, mech->length);
582 store_uint32_be(krbNameLen, p);
586 memcpy(p, krbName, krbNameLen);
589 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
590 memcpy(p, attrs.value, attrs.length);
594 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
596 major = GSS_S_COMPLETE;
600 gss_release_buffer(&tmpMinor, &attrs);
601 if (GSS_ERROR(major))
602 gss_release_buffer(&tmpMinor, exportedName);
603 krb5_free_unparsed_name(krbContext, krbName);
609 gssEapCanonicalizeName(OM_uint32 *minor,
610 const gss_name_t input_name,
611 const gss_OID mech_type,
612 gss_name_t *dest_name)
614 OM_uint32 major, tmpMinor;
615 krb5_context krbContext;
619 if (input_name == GSS_C_NO_NAME) {
621 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
624 GSSEAP_KRB_INIT(&krbContext);
626 major = gssEapAllocName(minor, &name);
627 if (GSS_ERROR(major)) {
631 if (mech_type != GSS_C_NO_OID)
632 mech_used = mech_type;
634 mech_used = input_name->mechanismUsed;
636 major = gssEapCanonicalizeOid(minor,
639 &name->mechanismUsed);
640 if (GSS_ERROR(major))
643 name->flags = input_name->flags;
645 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
646 &name->krbPrincipal);
648 major = GSS_S_FAILURE;
652 if (input_name->attrCtx != NULL) {
653 major = gssEapDuplicateAttrContext(minor, input_name, name);
654 if (GSS_ERROR(major))
661 if (GSS_ERROR(major)) {
662 gssEapReleaseName(&tmpMinor, &name);
669 gssEapDuplicateName(OM_uint32 *minor,
670 const gss_name_t input_name,
671 gss_name_t *dest_name)
673 return gssEapCanonicalizeName(minor, input_name,
674 GSS_C_NO_OID, dest_name);
678 gssEapDisplayName(OM_uint32 *minor,
680 gss_buffer_t output_name_buffer,
681 gss_OID *output_name_type)
684 krb5_context krbContext;
688 GSSEAP_KRB_INIT(&krbContext);
690 output_name_buffer->length = 0;
691 output_name_buffer->value = NULL;
693 if (name == GSS_C_NO_NAME) {
695 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
698 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
700 return GSS_S_FAILURE;
703 major = makeStringBuffer(minor, krbName, output_name_buffer);
704 if (GSS_ERROR(major)) {
705 krb5_free_unparsed_name(krbContext, krbName);
709 krb5_free_unparsed_name(krbContext, krbName);
711 if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
712 krb5_principal_compare(krbContext,
713 name->krbPrincipal, krbAnonymousPrincipal())) {
714 name_type = GSS_C_NT_ANONYMOUS;
716 name_type = GSS_EAP_NT_EAP_NAME;
719 if (output_name_type != NULL)
720 *output_name_type = name_type;
722 return GSS_S_COMPLETE;