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 gssEapNtPrincipalName = {
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_PRINCIPAL_NAME = &gssEapNtPrincipalName;
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 importServiceName(OM_uint32 *minor,
154 const gss_buffer_t nameBuffer,
158 krb5_context krbContext;
159 krb5_principal krbPrinc;
160 char *service, *host;
162 GSSEAP_KRB_INIT(&krbContext);
164 major = bufferToString(minor, nameBuffer, &service);
165 if (GSS_ERROR(major))
168 host = strchr(service, '@');
174 /* XXX this is probably NOT what we want to be doing */
175 if (krb5_sname_to_principal(krbContext, host, service,
176 KRB5_NT_SRV_HST, &krbPrinc) != 0) {
177 GSSEAP_FREE(service);
178 *minor = GSSEAP_BAD_SERVICE_NAME;
179 return GSS_S_FAILURE;
182 major = krbPrincipalToName(minor, &krbPrinc, pName);
183 if (GSS_ERROR(major)) {
184 krb5_free_principal(krbContext, krbPrinc);
187 GSSEAP_FREE(service);
192 importUserName(OM_uint32 *minor,
193 const gss_buffer_t nameBuffer,
197 krb5_context krbContext;
198 krb5_principal krbPrinc;
199 char *nameString, *realm;
202 GSSEAP_KRB_INIT(&krbContext);
204 realm = getenv("GSSEAP_DEFAULT_REALM");
206 *minor = krb5_set_default_realm(krbContext, realm);
208 return GSS_S_FAILURE;
210 flags |= KRB5_PRINCIPAL_PARSE_REQUIRE_REALM;
213 if (nameBuffer == GSS_C_NO_BUFFER) {
214 *minor = krb5_copy_principal(krbContext,
215 krbAnonymousPrincipal(), &krbPrinc);
217 return GSS_S_FAILURE;
219 major = bufferToString(minor, nameBuffer, &nameString);
220 if (GSS_ERROR(major))
223 *minor = krb5_parse_name_flags(krbContext, nameString, flags, &krbPrinc);
225 GSSEAP_FREE(nameString);
226 return GSS_S_FAILURE;
230 major = krbPrincipalToName(minor, &krbPrinc, pName);
231 if (GSS_ERROR(major)) {
232 krb5_free_principal(krbContext, krbPrinc);
235 GSSEAP_FREE(nameString);
240 importAnonymousName(OM_uint32 *minor,
241 const gss_buffer_t nameBuffer GSSEAP_UNUSED,
245 krb5_context krbContext;
246 krb5_principal krbPrinc;
248 GSSEAP_KRB_INIT(&krbContext);
250 *minor = krb5_copy_principal(krbContext, krbAnonymousPrincipal(),
253 return GSS_S_FAILURE;
255 major = krbPrincipalToName(minor, &krbPrinc, pName);
256 if (GSS_ERROR(major)) {
257 krb5_free_principal(krbContext, krbPrinc);
263 #define UPDATE_REMAIN(n) do { \
268 #define CHECK_REMAIN(n) do { \
269 if (remain < (n)) { \
270 major = GSS_S_BAD_NAME; \
271 *minor = GSSEAP_TOK_TRUNC; \
277 gssEapImportNameInternal(OM_uint32 *minor,
278 const gss_buffer_t nameBuffer,
282 OM_uint32 major, tmpMinor;
283 krb5_context krbContext;
287 enum gss_eap_token_type tokType;
288 gss_name_t name = GSS_C_NO_NAME;
289 gss_OID mechanismUsed = GSS_C_NO_OID;
291 GSSEAP_KRB_INIT(&krbContext);
293 p = (unsigned char *)nameBuffer->value;
294 remain = nameBuffer->length;
296 if (flags & EXPORT_NAME_FLAG_OID) {
299 /* TOK_ID || MECH_OID_LEN || MECH_OID */
301 return GSS_S_BAD_NAME;
303 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
304 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
306 tokType = TOK_TYPE_EXPORT_NAME;
309 if (load_uint16_be(p) != tokType)
310 return GSS_S_BAD_NAME;
314 len = load_uint16_be(p);
316 return GSS_S_BAD_NAME;
321 return GSS_S_BAD_NAME;
324 mech.elements = &p[2];
326 CHECK_REMAIN(mech.length);
328 major = gssEapCanonicalizeOid(minor,
330 OID_FLAG_FAMILY_MECH_VALID |
331 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
333 if (GSS_ERROR(major))
336 UPDATE_REMAIN(2 + mech.length);
341 len = load_uint32_be(p);
350 major = importUserName(minor, &buf, &name);
351 if (GSS_ERROR(major))
354 name->mechanismUsed = mechanismUsed;
355 mechanismUsed = GSS_C_NO_OID;
357 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
363 major = gssEapImportAttrContext(minor, &buf, name);
364 if (GSS_ERROR(major))
368 major = GSS_S_COMPLETE;
372 if (GSS_ERROR(major)) {
373 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
374 gssEapReleaseName(&tmpMinor, &name);
383 importExportName(OM_uint32 *minor,
384 const gss_buffer_t nameBuffer,
387 return gssEapImportNameInternal(minor, nameBuffer, name,
388 EXPORT_NAME_FLAG_OID);
391 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
393 importCompositeExportName(OM_uint32 *minor,
394 const gss_buffer_t nameBuffer,
397 return gssEapImportNameInternal(minor, nameBuffer, name,
398 EXPORT_NAME_FLAG_OID |
399 EXPORT_NAME_FLAG_COMPOSITE);
403 struct gss_eap_name_import_provider {
405 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
409 gssEapImportName(OM_uint32 *minor,
410 const gss_buffer_t nameBuffer,
415 struct gss_eap_name_import_provider nameTypes[] = {
416 { GSS_C_NT_USER_NAME, importUserName },
417 { GSS_EAP_NT_PRINCIPAL_NAME, importUserName },
418 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
419 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
420 { GSS_C_NT_ANONYMOUS, importAnonymousName },
421 { GSS_C_NT_EXPORT_NAME, importExportName },
422 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
423 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
427 OM_uint32 major = GSS_S_BAD_NAMETYPE;
429 gss_name_t name = GSS_C_NO_NAME;
431 if (nameType == GSS_C_NO_OID)
432 nameType = nameTypes[0].oid;
434 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
435 if (oidEqual(nameTypes[i].oid, nameType)) {
436 major = nameTypes[i].import(minor, nameBuffer, &name);
441 if (major == GSS_S_COMPLETE &&
442 mechType != GSS_C_NO_OID) {
443 assert(gssEapIsConcreteMechanismOid(mechType));
444 assert(name->mechanismUsed == GSS_C_NO_OID);
446 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
449 if (GSS_ERROR(major))
450 gssEapReleaseName(&tmpMinor, &name);
458 gssEapExportName(OM_uint32 *minor,
459 const gss_name_t name,
460 gss_buffer_t exportedName)
462 return gssEapExportNameInternal(minor, name, exportedName,
463 EXPORT_NAME_FLAG_OID);
467 gssEapExportNameInternal(OM_uint32 *minor,
468 const gss_name_t name,
469 gss_buffer_t exportedName,
472 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
473 krb5_context krbContext;
474 char *krbName = NULL;
475 size_t krbNameLen, exportedNameLen;
477 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
480 exportedName->length = 0;
481 exportedName->value = NULL;
483 if (name->mechanismUsed != GSS_C_NO_OID)
484 mech = name->mechanismUsed;
486 mech = GSS_EAP_MECHANISM;
488 GSSEAP_KRB_INIT(&krbContext);
490 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
492 major = GSS_S_FAILURE;
495 krbNameLen = strlen(krbName);
498 if (flags & EXPORT_NAME_FLAG_OID) {
499 exportedNameLen += 6 + mech->length;
501 exportedNameLen += 4 + krbNameLen;
502 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
503 major = gssEapExportAttrContext(minor, name, &attrs);
504 if (GSS_ERROR(major))
506 exportedNameLen += attrs.length;
509 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
510 if (exportedName->value == NULL) {
511 major = GSS_S_FAILURE;
515 exportedName->length = exportedNameLen;
517 p = (unsigned char *)exportedName->value;
519 if (flags & EXPORT_NAME_FLAG_OID) {
520 /* TOK | MECH_OID_LEN */
521 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
522 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
523 : TOK_TYPE_EXPORT_NAME,
526 store_uint16_be(mech->length + 2, p);
531 *p++ = mech->length & 0xff;
532 memcpy(p, mech->elements, mech->length);
537 store_uint32_be(krbNameLen, p);
541 memcpy(p, krbName, krbNameLen);
544 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
545 memcpy(p, attrs.value, attrs.length);
549 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
551 major = GSS_S_COMPLETE;
555 gss_release_buffer(&tmpMinor, &attrs);
556 if (GSS_ERROR(major))
557 gss_release_buffer(&tmpMinor, exportedName);
558 krb5_free_unparsed_name(krbContext, krbName);
564 gssEapCanonicalizeName(OM_uint32 *minor,
565 const gss_name_t input_name,
566 const gss_OID mech_type,
567 gss_name_t *dest_name)
569 OM_uint32 major, tmpMinor;
570 krb5_context krbContext;
574 if (input_name == GSS_C_NO_NAME) {
576 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
579 GSSEAP_KRB_INIT(&krbContext);
581 major = gssEapAllocName(minor, &name);
582 if (GSS_ERROR(major)) {
586 if (mech_type != GSS_C_NO_OID)
587 mech_used = mech_type;
589 mech_used = input_name->mechanismUsed;
591 major = gssEapCanonicalizeOid(minor,
594 &name->mechanismUsed);
595 if (GSS_ERROR(major))
598 name->flags = input_name->flags;
600 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
601 &name->krbPrincipal);
603 major = GSS_S_FAILURE;
607 if (input_name->attrCtx != NULL) {
608 major = gssEapDuplicateAttrContext(minor, input_name, name);
609 if (GSS_ERROR(major))
616 if (GSS_ERROR(major)) {
617 gssEapReleaseName(&tmpMinor, &name);
624 gssEapDuplicateName(OM_uint32 *minor,
625 const gss_name_t input_name,
626 gss_name_t *dest_name)
628 return gssEapCanonicalizeName(minor, input_name,
629 GSS_C_NO_OID, dest_name);
633 gssEapDisplayName(OM_uint32 *minor,
635 gss_buffer_t output_name_buffer,
636 gss_OID *output_name_type)
639 krb5_context krbContext;
643 GSSEAP_KRB_INIT(&krbContext);
645 output_name_buffer->length = 0;
646 output_name_buffer->value = NULL;
648 if (name == GSS_C_NO_NAME) {
650 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
653 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
655 return GSS_S_FAILURE;
658 major = makeStringBuffer(minor, krbName, output_name_buffer);
659 if (GSS_ERROR(major)) {
660 krb5_free_unparsed_name(krbContext, krbName);
664 krb5_free_unparsed_name(krbContext, krbName);
666 if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
667 krb5_principal_compare(krbContext,
668 name->krbPrincipal, krbAnonymousPrincipal())) {
669 name_type = GSS_C_NT_ANONYMOUS;
671 name_type = GSS_EAP_NT_PRINCIPAL_NAME;
674 if (output_name_type != NULL)
675 *output_name_type = name_type;
677 return GSS_S_COMPLETE;