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;
201 GSSEAP_KRB_INIT(&krbContext);
203 if (nameBuffer == GSS_C_NO_BUFFER) {
204 *minor = krb5_copy_principal(krbContext,
205 krbAnonymousPrincipal(), &krbPrinc);
207 return GSS_S_FAILURE;
209 major = bufferToString(minor, nameBuffer, &nameString);
210 if (GSS_ERROR(major))
213 *minor = krb5_parse_name_flags(krbContext, nameString,
214 KRB5_PRINCIPAL_PARSE_REQUIRE_REALM,
217 GSSEAP_FREE(nameString);
218 return GSS_S_FAILURE;
222 major = krbPrincipalToName(minor, &krbPrinc, pName);
223 if (GSS_ERROR(major)) {
224 krb5_free_principal(krbContext, krbPrinc);
227 GSSEAP_FREE(nameString);
232 importAnonymousName(OM_uint32 *minor,
233 const gss_buffer_t nameBuffer GSSEAP_UNUSED,
237 krb5_context krbContext;
238 krb5_principal krbPrinc;
240 GSSEAP_KRB_INIT(&krbContext);
242 *minor = krb5_copy_principal(krbContext, krbAnonymousPrincipal(),
245 return GSS_S_FAILURE;
247 major = krbPrincipalToName(minor, &krbPrinc, pName);
248 if (GSS_ERROR(major)) {
249 krb5_free_principal(krbContext, krbPrinc);
255 #define UPDATE_REMAIN(n) do { \
260 #define CHECK_REMAIN(n) do { \
261 if (remain < (n)) { \
262 major = GSS_S_BAD_NAME; \
263 *minor = GSSEAP_TOK_TRUNC; \
269 gssEapImportNameInternal(OM_uint32 *minor,
270 const gss_buffer_t nameBuffer,
274 OM_uint32 major, tmpMinor;
275 krb5_context krbContext;
279 enum gss_eap_token_type tokType;
280 gss_name_t name = GSS_C_NO_NAME;
281 gss_OID mechanismUsed = GSS_C_NO_OID;
283 GSSEAP_KRB_INIT(&krbContext);
285 p = (unsigned char *)nameBuffer->value;
286 remain = nameBuffer->length;
288 if (flags & EXPORT_NAME_FLAG_OID) {
291 /* TOK_ID || MECH_OID_LEN || MECH_OID */
293 return GSS_S_BAD_NAME;
295 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
296 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
298 tokType = TOK_TYPE_EXPORT_NAME;
301 if (load_uint16_be(p) != tokType)
302 return GSS_S_BAD_NAME;
306 len = load_uint16_be(p);
308 return GSS_S_BAD_NAME;
313 return GSS_S_BAD_NAME;
316 mech.elements = &p[2];
318 CHECK_REMAIN(mech.length);
320 major = gssEapCanonicalizeOid(minor,
322 OID_FLAG_FAMILY_MECH_VALID |
323 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
325 if (GSS_ERROR(major))
328 UPDATE_REMAIN(2 + mech.length);
333 len = load_uint32_be(p);
342 major = importUserName(minor, &buf, &name);
343 if (GSS_ERROR(major))
346 name->mechanismUsed = mechanismUsed;
347 mechanismUsed = GSS_C_NO_OID;
349 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
355 major = gssEapImportAttrContext(minor, &buf, name);
356 if (GSS_ERROR(major))
360 major = GSS_S_COMPLETE;
364 if (GSS_ERROR(major)) {
365 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
366 gssEapReleaseName(&tmpMinor, &name);
375 importExportName(OM_uint32 *minor,
376 const gss_buffer_t nameBuffer,
379 return gssEapImportNameInternal(minor, nameBuffer, name,
380 EXPORT_NAME_FLAG_OID);
383 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
385 importCompositeExportName(OM_uint32 *minor,
386 const gss_buffer_t nameBuffer,
389 return gssEapImportNameInternal(minor, nameBuffer, name,
390 EXPORT_NAME_FLAG_OID |
391 EXPORT_NAME_FLAG_COMPOSITE);
395 struct gss_eap_name_import_provider {
397 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
401 gssEapImportName(OM_uint32 *minor,
402 const gss_buffer_t nameBuffer,
407 struct gss_eap_name_import_provider nameTypes[] = {
408 { GSS_C_NT_USER_NAME, importUserName },
409 { GSS_EAP_NT_PRINCIPAL_NAME, importUserName },
410 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
411 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
412 { GSS_C_NT_ANONYMOUS, importAnonymousName },
413 { GSS_C_NT_EXPORT_NAME, importExportName },
414 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
415 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
419 OM_uint32 major = GSS_S_BAD_NAMETYPE;
421 gss_name_t name = GSS_C_NO_NAME;
423 if (nameType == GSS_C_NO_OID)
424 nameType = nameTypes[0].oid;
426 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
427 if (oidEqual(nameTypes[i].oid, nameType)) {
428 major = nameTypes[i].import(minor, nameBuffer, &name);
433 if (major == GSS_S_COMPLETE &&
434 mechType != GSS_C_NO_OID) {
435 assert(gssEapIsConcreteMechanismOid(mechType));
436 assert(name->mechanismUsed == GSS_C_NO_OID);
438 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
441 if (GSS_ERROR(major))
442 gssEapReleaseName(&tmpMinor, &name);
450 gssEapExportName(OM_uint32 *minor,
451 const gss_name_t name,
452 gss_buffer_t exportedName)
454 return gssEapExportNameInternal(minor, name, exportedName,
455 EXPORT_NAME_FLAG_OID);
459 gssEapExportNameInternal(OM_uint32 *minor,
460 const gss_name_t name,
461 gss_buffer_t exportedName,
464 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
465 krb5_context krbContext;
466 char *krbName = NULL;
467 size_t krbNameLen, exportedNameLen;
469 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
472 exportedName->length = 0;
473 exportedName->value = NULL;
475 if (name->mechanismUsed != GSS_C_NO_OID)
476 mech = name->mechanismUsed;
478 mech = GSS_EAP_MECHANISM;
480 GSSEAP_KRB_INIT(&krbContext);
482 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
484 major = GSS_S_FAILURE;
487 krbNameLen = strlen(krbName);
490 if (flags & EXPORT_NAME_FLAG_OID) {
491 exportedNameLen += 6 + mech->length;
493 exportedNameLen += 4 + krbNameLen;
494 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
495 major = gssEapExportAttrContext(minor, name, &attrs);
496 if (GSS_ERROR(major))
498 exportedNameLen += attrs.length;
501 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
502 if (exportedName->value == NULL) {
503 major = GSS_S_FAILURE;
507 exportedName->length = exportedNameLen;
509 p = (unsigned char *)exportedName->value;
511 if (flags & EXPORT_NAME_FLAG_OID) {
512 /* TOK | MECH_OID_LEN */
513 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
514 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
515 : TOK_TYPE_EXPORT_NAME,
518 store_uint16_be(mech->length + 2, p);
523 *p++ = mech->length & 0xff;
524 memcpy(p, mech->elements, mech->length);
529 store_uint32_be(krbNameLen, p);
533 memcpy(p, krbName, krbNameLen);
536 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
537 memcpy(p, attrs.value, attrs.length);
541 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
543 major = GSS_S_COMPLETE;
547 gss_release_buffer(&tmpMinor, &attrs);
548 if (GSS_ERROR(major))
549 gss_release_buffer(&tmpMinor, exportedName);
550 krb5_free_unparsed_name(krbContext, krbName);
556 gssEapCanonicalizeName(OM_uint32 *minor,
557 const gss_name_t input_name,
558 const gss_OID mech_type,
559 gss_name_t *dest_name)
561 OM_uint32 major, tmpMinor;
562 krb5_context krbContext;
566 if (input_name == GSS_C_NO_NAME) {
568 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
571 GSSEAP_KRB_INIT(&krbContext);
573 major = gssEapAllocName(minor, &name);
574 if (GSS_ERROR(major)) {
578 if (mech_type != GSS_C_NO_OID)
579 mech_used = mech_type;
581 mech_used = input_name->mechanismUsed;
583 major = gssEapCanonicalizeOid(minor,
586 &name->mechanismUsed);
587 if (GSS_ERROR(major))
590 name->flags = input_name->flags;
592 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
593 &name->krbPrincipal);
595 major = GSS_S_FAILURE;
599 if (input_name->attrCtx != NULL) {
600 major = gssEapDuplicateAttrContext(minor, input_name, name);
601 if (GSS_ERROR(major))
608 if (GSS_ERROR(major)) {
609 gssEapReleaseName(&tmpMinor, &name);
616 gssEapDuplicateName(OM_uint32 *minor,
617 const gss_name_t input_name,
618 gss_name_t *dest_name)
620 return gssEapCanonicalizeName(minor, input_name,
621 GSS_C_NO_OID, dest_name);
625 gssEapDisplayName(OM_uint32 *minor,
627 gss_buffer_t output_name_buffer,
628 gss_OID *output_name_type)
631 krb5_context krbContext;
635 GSSEAP_KRB_INIT(&krbContext);
637 output_name_buffer->length = 0;
638 output_name_buffer->value = NULL;
640 if (name == GSS_C_NO_NAME) {
642 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
645 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
647 return GSS_S_FAILURE;
650 major = makeStringBuffer(minor, krbName, output_name_buffer);
651 if (GSS_ERROR(major)) {
652 krb5_free_unparsed_name(krbContext, krbName);
656 krb5_free_unparsed_name(krbContext, krbName);
658 if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
659 krb5_principal_compare(krbContext,
660 name->krbPrincipal, krbAnonymousPrincipal())) {
661 name_type = GSS_C_NT_ANONYMOUS;
663 name_type = GSS_EAP_NT_PRINCIPAL_NAME;
666 if (output_name_type != NULL)
667 *output_name_type = name_type;
669 return GSS_S_COMPLETE;