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,
243 krb5_context krbContext;
244 krb5_principal krbPrinc;
246 GSSEAP_KRB_INIT(&krbContext);
248 *minor = krb5_copy_principal(krbContext, krbAnonymousPrincipal(),
251 return GSS_S_FAILURE;
253 major = krbPrincipalToName(minor, &krbPrinc, pName);
254 if (GSS_ERROR(major)) {
255 krb5_free_principal(krbContext, krbPrinc);
261 #define UPDATE_REMAIN(n) do { \
266 #define CHECK_REMAIN(n) do { \
267 if (remain < (n)) { \
268 major = GSS_S_BAD_NAME; \
269 *minor = GSSEAP_TOK_TRUNC; \
275 gssEapImportNameInternal(OM_uint32 *minor,
276 const gss_buffer_t nameBuffer,
280 OM_uint32 major, tmpMinor;
281 krb5_context krbContext;
285 enum gss_eap_token_type tokType;
286 gss_name_t name = GSS_C_NO_NAME;
287 gss_OID mechanismUsed = GSS_C_NO_OID;
289 GSSEAP_KRB_INIT(&krbContext);
291 p = (unsigned char *)nameBuffer->value;
292 remain = nameBuffer->length;
294 if (flags & EXPORT_NAME_FLAG_OID) {
297 /* TOK_ID || MECH_OID_LEN || MECH_OID */
299 return GSS_S_BAD_NAME;
301 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
302 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
304 tokType = TOK_TYPE_EXPORT_NAME;
307 if (load_uint16_be(p) != tokType)
308 return GSS_S_BAD_NAME;
312 len = load_uint16_be(p);
314 return GSS_S_BAD_NAME;
319 return GSS_S_BAD_NAME;
322 mech.elements = &p[2];
324 CHECK_REMAIN(mech.length);
326 major = gssEapCanonicalizeOid(minor,
328 OID_FLAG_FAMILY_MECH_VALID |
329 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
331 if (GSS_ERROR(major))
334 UPDATE_REMAIN(2 + mech.length);
339 len = load_uint32_be(p);
348 major = importUserName(minor, &buf, &name);
349 if (GSS_ERROR(major))
352 name->mechanismUsed = mechanismUsed;
353 mechanismUsed = GSS_C_NO_OID;
355 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
361 major = gssEapImportAttrContext(minor, &buf, name);
362 if (GSS_ERROR(major))
366 major = GSS_S_COMPLETE;
370 if (GSS_ERROR(major)) {
371 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
372 gssEapReleaseName(&tmpMinor, &name);
381 importExportName(OM_uint32 *minor,
382 const gss_buffer_t nameBuffer,
385 return gssEapImportNameInternal(minor, nameBuffer, name,
386 EXPORT_NAME_FLAG_OID);
389 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
391 importCompositeExportName(OM_uint32 *minor,
392 const gss_buffer_t nameBuffer,
395 return gssEapImportNameInternal(minor, nameBuffer, name,
396 EXPORT_NAME_FLAG_OID |
397 EXPORT_NAME_FLAG_COMPOSITE);
401 struct gss_eap_name_import_provider {
403 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
407 gssEapImportName(OM_uint32 *minor,
408 const gss_buffer_t nameBuffer,
413 struct gss_eap_name_import_provider nameTypes[] = {
414 { GSS_C_NT_USER_NAME, importUserName },
415 { GSS_EAP_NT_PRINCIPAL_NAME, importUserName },
416 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
417 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
418 { GSS_C_NT_ANONYMOUS, importAnonymousName },
419 { GSS_C_NT_EXPORT_NAME, importExportName },
420 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
421 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
425 OM_uint32 major = GSS_S_BAD_NAMETYPE;
427 gss_name_t name = GSS_C_NO_NAME;
429 if (nameType == GSS_C_NO_OID)
430 nameType = nameTypes[0].oid;
432 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
433 if (oidEqual(nameTypes[i].oid, nameType)) {
434 major = nameTypes[i].import(minor, nameBuffer, &name);
439 if (major == GSS_S_COMPLETE &&
440 mechType != GSS_C_NO_OID) {
441 assert(gssEapIsConcreteMechanismOid(mechType));
442 assert(name->mechanismUsed == GSS_C_NO_OID);
444 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
447 if (GSS_ERROR(major))
448 gssEapReleaseName(&tmpMinor, &name);
456 gssEapExportName(OM_uint32 *minor,
457 const gss_name_t name,
458 gss_buffer_t exportedName)
460 return gssEapExportNameInternal(minor, name, exportedName,
461 EXPORT_NAME_FLAG_OID);
465 gssEapExportNameInternal(OM_uint32 *minor,
466 const gss_name_t name,
467 gss_buffer_t exportedName,
470 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
471 krb5_context krbContext;
472 char *krbName = NULL;
473 size_t krbNameLen, exportedNameLen;
475 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
478 exportedName->length = 0;
479 exportedName->value = NULL;
481 if (name->mechanismUsed != GSS_C_NO_OID)
482 mech = name->mechanismUsed;
484 mech = GSS_EAP_MECHANISM;
486 GSSEAP_KRB_INIT(&krbContext);
488 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
490 major = GSS_S_FAILURE;
493 krbNameLen = strlen(krbName);
496 if (flags & EXPORT_NAME_FLAG_OID) {
497 exportedNameLen += 6 + mech->length;
499 exportedNameLen += 4 + krbNameLen;
500 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
501 major = gssEapExportAttrContext(minor, name, &attrs);
502 if (GSS_ERROR(major))
504 exportedNameLen += attrs.length;
507 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
508 if (exportedName->value == NULL) {
509 major = GSS_S_FAILURE;
513 exportedName->length = exportedNameLen;
515 p = (unsigned char *)exportedName->value;
517 if (flags & EXPORT_NAME_FLAG_OID) {
518 /* TOK | MECH_OID_LEN */
519 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
520 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
521 : TOK_TYPE_EXPORT_NAME,
524 store_uint16_be(mech->length + 2, p);
529 *p++ = mech->length & 0xff;
530 memcpy(p, mech->elements, mech->length);
535 store_uint32_be(krbNameLen, p);
539 memcpy(p, krbName, krbNameLen);
542 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
543 memcpy(p, attrs.value, attrs.length);
547 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
549 major = GSS_S_COMPLETE;
553 gss_release_buffer(&tmpMinor, &attrs);
554 if (GSS_ERROR(major))
555 gss_release_buffer(&tmpMinor, exportedName);
556 krb5_free_unparsed_name(krbContext, krbName);
562 gssEapCanonicalizeName(OM_uint32 *minor,
563 const gss_name_t input_name,
564 const gss_OID mech_type,
565 gss_name_t *dest_name)
567 OM_uint32 major, tmpMinor;
568 krb5_context krbContext;
572 if (input_name == GSS_C_NO_NAME) {
574 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
577 GSSEAP_KRB_INIT(&krbContext);
579 major = gssEapAllocName(minor, &name);
580 if (GSS_ERROR(major)) {
584 if (mech_type != GSS_C_NO_OID)
585 mech_used = mech_type;
587 mech_used = input_name->mechanismUsed;
589 major = gssEapCanonicalizeOid(minor,
592 &name->mechanismUsed);
593 if (GSS_ERROR(major))
596 name->flags = input_name->flags;
598 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
599 &name->krbPrincipal);
601 major = GSS_S_FAILURE;
605 if (input_name->attrCtx != NULL) {
606 major = gssEapDuplicateAttrContext(minor, input_name, name);
607 if (GSS_ERROR(major))
614 if (GSS_ERROR(major)) {
615 gssEapReleaseName(&tmpMinor, &name);
622 gssEapDuplicateName(OM_uint32 *minor,
623 const gss_name_t input_name,
624 gss_name_t *dest_name)
626 return gssEapCanonicalizeName(minor, input_name,
627 GSS_C_NO_OID, dest_name);
631 gssEapDisplayName(OM_uint32 *minor,
633 gss_buffer_t output_name_buffer,
634 gss_OID *output_name_type)
637 krb5_context krbContext;
641 GSSEAP_KRB_INIT(&krbContext);
643 output_name_buffer->length = 0;
644 output_name_buffer->value = NULL;
646 if (name == GSS_C_NO_NAME) {
648 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
651 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
653 return GSS_S_FAILURE;
656 major = makeStringBuffer(minor, krbName, output_name_buffer);
657 if (GSS_ERROR(major)) {
658 krb5_free_unparsed_name(krbContext, krbName);
662 krb5_free_unparsed_name(krbContext, krbName);
664 if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
665 krb5_principal_compare(krbContext,
666 name->krbPrincipal, krbAnonymousPrincipal())) {
667 name_type = GSS_C_NT_ANONYMOUS;
669 name_type = GSS_EAP_NT_PRINCIPAL_NAME;
672 if (output_name_type != NULL)
673 *output_name_type = name_type;
675 return GSS_S_COMPLETE;