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 = NULL;
201 krb5_error_code code;
203 GSSEAP_KRB_INIT(&krbContext);
205 code = krb5_get_default_realm(krbContext, &realm);
206 if (code != 0 || realm == NULL)
207 flags |= KRB5_PRINCIPAL_PARSE_REQUIRE_REALM;
209 krb5_free_default_realm(krbContext, realm);
211 if (nameBuffer == GSS_C_NO_BUFFER) {
212 *minor = krb5_copy_principal(krbContext,
213 krbAnonymousPrincipal(), &krbPrinc);
215 return GSS_S_FAILURE;
217 major = bufferToString(minor, nameBuffer, &nameString);
218 if (GSS_ERROR(major))
221 *minor = krb5_parse_name_flags(krbContext, nameString, flags, &krbPrinc);
223 GSSEAP_FREE(nameString);
224 return GSS_S_FAILURE;
228 major = krbPrincipalToName(minor, &krbPrinc, pName);
229 if (GSS_ERROR(major)) {
230 krb5_free_principal(krbContext, krbPrinc);
233 GSSEAP_FREE(nameString);
238 importAnonymousName(OM_uint32 *minor,
239 const gss_buffer_t nameBuffer GSSEAP_UNUSED,
242 return importUserName(minor, GSS_C_NO_BUFFER, pName);
245 #define UPDATE_REMAIN(n) do { \
250 #define CHECK_REMAIN(n) do { \
251 if (remain < (n)) { \
252 major = GSS_S_BAD_NAME; \
253 *minor = GSSEAP_TOK_TRUNC; \
259 gssEapImportNameInternal(OM_uint32 *minor,
260 const gss_buffer_t nameBuffer,
264 OM_uint32 major, tmpMinor;
265 krb5_context krbContext;
269 enum gss_eap_token_type tokType;
270 gss_name_t name = GSS_C_NO_NAME;
271 gss_OID mechanismUsed = GSS_C_NO_OID;
273 GSSEAP_KRB_INIT(&krbContext);
275 p = (unsigned char *)nameBuffer->value;
276 remain = nameBuffer->length;
278 if (flags & EXPORT_NAME_FLAG_OID) {
281 /* TOK_ID || MECH_OID_LEN || MECH_OID */
283 return GSS_S_BAD_NAME;
285 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
286 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
288 tokType = TOK_TYPE_EXPORT_NAME;
291 if (load_uint16_be(p) != tokType)
292 return GSS_S_BAD_NAME;
296 len = load_uint16_be(p);
298 return GSS_S_BAD_NAME;
303 return GSS_S_BAD_NAME;
306 mech.elements = &p[2];
308 CHECK_REMAIN(mech.length);
310 major = gssEapCanonicalizeOid(minor,
312 OID_FLAG_FAMILY_MECH_VALID |
313 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
315 if (GSS_ERROR(major))
318 UPDATE_REMAIN(2 + mech.length);
323 len = load_uint32_be(p);
332 major = importUserName(minor, &buf, &name);
333 if (GSS_ERROR(major))
336 name->mechanismUsed = mechanismUsed;
337 mechanismUsed = GSS_C_NO_OID;
339 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
345 major = gssEapImportAttrContext(minor, &buf, name);
346 if (GSS_ERROR(major))
350 major = GSS_S_COMPLETE;
354 if (GSS_ERROR(major)) {
355 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
356 gssEapReleaseName(&tmpMinor, &name);
365 importExportName(OM_uint32 *minor,
366 const gss_buffer_t nameBuffer,
369 return gssEapImportNameInternal(minor, nameBuffer, name,
370 EXPORT_NAME_FLAG_OID);
373 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
375 importCompositeExportName(OM_uint32 *minor,
376 const gss_buffer_t nameBuffer,
379 return gssEapImportNameInternal(minor, nameBuffer, name,
380 EXPORT_NAME_FLAG_OID |
381 EXPORT_NAME_FLAG_COMPOSITE);
385 struct gss_eap_name_import_provider {
387 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
391 gssEapImportName(OM_uint32 *minor,
392 const gss_buffer_t nameBuffer,
397 struct gss_eap_name_import_provider nameTypes[] = {
398 { GSS_C_NT_USER_NAME, importUserName },
399 { GSS_EAP_NT_PRINCIPAL_NAME, importUserName },
400 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
401 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
402 { GSS_C_NT_ANONYMOUS, importAnonymousName },
403 { GSS_C_NT_EXPORT_NAME, importExportName },
404 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
405 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
409 OM_uint32 major = GSS_S_BAD_NAMETYPE;
411 gss_name_t name = GSS_C_NO_NAME;
413 if (nameType == GSS_C_NO_OID)
414 nameType = nameTypes[0].oid;
416 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
417 if (oidEqual(nameTypes[i].oid, nameType)) {
418 major = nameTypes[i].import(minor, nameBuffer, &name);
423 if (major == GSS_S_COMPLETE &&
424 mechType != GSS_C_NO_OID) {
425 assert(gssEapIsConcreteMechanismOid(mechType));
426 assert(name->mechanismUsed == GSS_C_NO_OID);
428 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
431 if (GSS_ERROR(major))
432 gssEapReleaseName(&tmpMinor, &name);
440 gssEapExportName(OM_uint32 *minor,
441 const gss_name_t name,
442 gss_buffer_t exportedName)
444 return gssEapExportNameInternal(minor, name, exportedName,
445 EXPORT_NAME_FLAG_OID);
449 gssEapExportNameInternal(OM_uint32 *minor,
450 const gss_name_t name,
451 gss_buffer_t exportedName,
454 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
455 krb5_context krbContext;
456 char *krbName = NULL;
457 size_t krbNameLen, exportedNameLen;
459 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
462 exportedName->length = 0;
463 exportedName->value = NULL;
465 if (name->mechanismUsed != GSS_C_NO_OID)
466 mech = name->mechanismUsed;
468 mech = GSS_EAP_MECHANISM;
470 GSSEAP_KRB_INIT(&krbContext);
472 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
474 major = GSS_S_FAILURE;
477 krbNameLen = strlen(krbName);
480 if (flags & EXPORT_NAME_FLAG_OID) {
481 exportedNameLen += 6 + mech->length;
483 exportedNameLen += 4 + krbNameLen;
484 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
485 major = gssEapExportAttrContext(minor, name, &attrs);
486 if (GSS_ERROR(major))
488 exportedNameLen += attrs.length;
491 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
492 if (exportedName->value == NULL) {
493 major = GSS_S_FAILURE;
497 exportedName->length = exportedNameLen;
499 p = (unsigned char *)exportedName->value;
501 if (flags & EXPORT_NAME_FLAG_OID) {
502 /* TOK | MECH_OID_LEN */
503 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
504 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
505 : TOK_TYPE_EXPORT_NAME,
508 store_uint16_be(mech->length + 2, p);
513 *p++ = mech->length & 0xff;
514 memcpy(p, mech->elements, mech->length);
519 store_uint32_be(krbNameLen, p);
523 memcpy(p, krbName, krbNameLen);
526 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
527 memcpy(p, attrs.value, attrs.length);
531 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
533 major = GSS_S_COMPLETE;
537 gss_release_buffer(&tmpMinor, &attrs);
538 if (GSS_ERROR(major))
539 gss_release_buffer(&tmpMinor, exportedName);
540 krb5_free_unparsed_name(krbContext, krbName);
546 gssEapCanonicalizeName(OM_uint32 *minor,
547 const gss_name_t input_name,
548 const gss_OID mech_type,
549 gss_name_t *dest_name)
551 OM_uint32 major, tmpMinor;
552 krb5_context krbContext;
556 if (input_name == GSS_C_NO_NAME) {
558 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
561 GSSEAP_KRB_INIT(&krbContext);
563 major = gssEapAllocName(minor, &name);
564 if (GSS_ERROR(major)) {
568 if (mech_type != GSS_C_NO_OID)
569 mech_used = mech_type;
571 mech_used = input_name->mechanismUsed;
573 major = gssEapCanonicalizeOid(minor,
576 &name->mechanismUsed);
577 if (GSS_ERROR(major))
580 name->flags = input_name->flags;
582 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
583 &name->krbPrincipal);
585 major = GSS_S_FAILURE;
589 if (input_name->attrCtx != NULL) {
590 major = gssEapDuplicateAttrContext(minor, input_name, name);
591 if (GSS_ERROR(major))
598 if (GSS_ERROR(major)) {
599 gssEapReleaseName(&tmpMinor, &name);
606 gssEapDuplicateName(OM_uint32 *minor,
607 const gss_name_t input_name,
608 gss_name_t *dest_name)
610 return gssEapCanonicalizeName(minor, input_name,
611 GSS_C_NO_OID, dest_name);
615 gssEapDisplayName(OM_uint32 *minor,
617 gss_buffer_t output_name_buffer,
618 gss_OID *output_name_type)
621 krb5_context krbContext;
625 GSSEAP_KRB_INIT(&krbContext);
627 output_name_buffer->length = 0;
628 output_name_buffer->value = NULL;
630 if (name == GSS_C_NO_NAME) {
632 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
635 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
637 return GSS_S_FAILURE;
640 major = makeStringBuffer(minor, krbName, output_name_buffer);
641 if (GSS_ERROR(major)) {
642 krb5_free_unparsed_name(krbContext, krbName);
646 krb5_free_unparsed_name(krbContext, krbName);
648 if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
649 krb5_principal_compare(krbContext,
650 name->krbPrincipal, krbAnonymousPrincipal())) {
651 name_type = GSS_C_NT_ANONYMOUS;
653 name_type = GSS_EAP_NT_PRINCIPAL_NAME;
656 if (output_name_type != NULL)
657 *output_name_type = name_type;
659 return GSS_S_COMPLETE;