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,
244 return importUserName(minor, GSS_C_NO_BUFFER, pName);
247 #define UPDATE_REMAIN(n) do { \
252 #define CHECK_REMAIN(n) do { \
253 if (remain < (n)) { \
254 major = GSS_S_BAD_NAME; \
255 *minor = GSSEAP_TOK_TRUNC; \
261 gssEapImportNameInternal(OM_uint32 *minor,
262 const gss_buffer_t nameBuffer,
266 OM_uint32 major, tmpMinor;
267 krb5_context krbContext;
271 enum gss_eap_token_type tokType;
272 gss_name_t name = GSS_C_NO_NAME;
273 gss_OID mechanismUsed = GSS_C_NO_OID;
275 GSSEAP_KRB_INIT(&krbContext);
277 p = (unsigned char *)nameBuffer->value;
278 remain = nameBuffer->length;
280 if (flags & EXPORT_NAME_FLAG_OID) {
283 /* TOK_ID || MECH_OID_LEN || MECH_OID */
285 return GSS_S_BAD_NAME;
287 if (flags & EXPORT_NAME_FLAG_COMPOSITE)
288 tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
290 tokType = TOK_TYPE_EXPORT_NAME;
293 if (load_uint16_be(p) != tokType)
294 return GSS_S_BAD_NAME;
298 len = load_uint16_be(p);
300 return GSS_S_BAD_NAME;
305 return GSS_S_BAD_NAME;
308 mech.elements = &p[2];
310 CHECK_REMAIN(mech.length);
312 major = gssEapCanonicalizeOid(minor,
314 OID_FLAG_FAMILY_MECH_VALID |
315 OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
317 if (GSS_ERROR(major))
320 UPDATE_REMAIN(2 + mech.length);
325 len = load_uint32_be(p);
334 major = importUserName(minor, &buf, &name);
335 if (GSS_ERROR(major))
338 name->mechanismUsed = mechanismUsed;
339 mechanismUsed = GSS_C_NO_OID;
341 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
347 major = gssEapImportAttrContext(minor, &buf, name);
348 if (GSS_ERROR(major))
352 major = GSS_S_COMPLETE;
356 if (GSS_ERROR(major)) {
357 gssEapReleaseOid(&tmpMinor, &mechanismUsed);
358 gssEapReleaseName(&tmpMinor, &name);
367 importExportName(OM_uint32 *minor,
368 const gss_buffer_t nameBuffer,
371 return gssEapImportNameInternal(minor, nameBuffer, name,
372 EXPORT_NAME_FLAG_OID);
375 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
377 importCompositeExportName(OM_uint32 *minor,
378 const gss_buffer_t nameBuffer,
381 return gssEapImportNameInternal(minor, nameBuffer, name,
382 EXPORT_NAME_FLAG_OID |
383 EXPORT_NAME_FLAG_COMPOSITE);
387 struct gss_eap_name_import_provider {
389 OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
393 gssEapImportName(OM_uint32 *minor,
394 const gss_buffer_t nameBuffer,
399 struct gss_eap_name_import_provider nameTypes[] = {
400 { GSS_C_NT_USER_NAME, importUserName },
401 { GSS_EAP_NT_PRINCIPAL_NAME, importUserName },
402 { GSS_C_NT_HOSTBASED_SERVICE, importServiceName },
403 { GSS_C_NT_HOSTBASED_SERVICE_X, importServiceName },
404 { GSS_C_NT_ANONYMOUS, importAnonymousName },
405 { GSS_C_NT_EXPORT_NAME, importExportName },
406 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
407 { GSS_C_NT_COMPOSITE_EXPORT, importCompositeExportName },
411 OM_uint32 major = GSS_S_BAD_NAMETYPE;
413 gss_name_t name = GSS_C_NO_NAME;
415 if (nameType == GSS_C_NO_OID)
416 nameType = nameTypes[0].oid;
418 for (i = 0; i < sizeof(nameTypes) / sizeof(nameTypes[0]); i++) {
419 if (oidEqual(nameTypes[i].oid, nameType)) {
420 major = nameTypes[i].import(minor, nameBuffer, &name);
425 if (major == GSS_S_COMPLETE &&
426 mechType != GSS_C_NO_OID) {
427 assert(gssEapIsConcreteMechanismOid(mechType));
428 assert(name->mechanismUsed == GSS_C_NO_OID);
430 major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
433 if (GSS_ERROR(major))
434 gssEapReleaseName(&tmpMinor, &name);
442 gssEapExportName(OM_uint32 *minor,
443 const gss_name_t name,
444 gss_buffer_t exportedName)
446 return gssEapExportNameInternal(minor, name, exportedName,
447 EXPORT_NAME_FLAG_OID);
451 gssEapExportNameInternal(OM_uint32 *minor,
452 const gss_name_t name,
453 gss_buffer_t exportedName,
456 OM_uint32 major = GSS_S_FAILURE, tmpMinor;
457 krb5_context krbContext;
458 char *krbName = NULL;
459 size_t krbNameLen, exportedNameLen;
461 gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
464 exportedName->length = 0;
465 exportedName->value = NULL;
467 if (name->mechanismUsed != GSS_C_NO_OID)
468 mech = name->mechanismUsed;
470 mech = GSS_EAP_MECHANISM;
472 GSSEAP_KRB_INIT(&krbContext);
474 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
476 major = GSS_S_FAILURE;
479 krbNameLen = strlen(krbName);
482 if (flags & EXPORT_NAME_FLAG_OID) {
483 exportedNameLen += 6 + mech->length;
485 exportedNameLen += 4 + krbNameLen;
486 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
487 major = gssEapExportAttrContext(minor, name, &attrs);
488 if (GSS_ERROR(major))
490 exportedNameLen += attrs.length;
493 exportedName->value = GSSEAP_MALLOC(exportedNameLen);
494 if (exportedName->value == NULL) {
495 major = GSS_S_FAILURE;
499 exportedName->length = exportedNameLen;
501 p = (unsigned char *)exportedName->value;
503 if (flags & EXPORT_NAME_FLAG_OID) {
504 /* TOK | MECH_OID_LEN */
505 store_uint16_be((flags & EXPORT_NAME_FLAG_COMPOSITE)
506 ? TOK_TYPE_EXPORT_NAME_COMPOSITE
507 : TOK_TYPE_EXPORT_NAME,
510 store_uint16_be(mech->length + 2, p);
515 *p++ = mech->length & 0xff;
516 memcpy(p, mech->elements, mech->length);
521 store_uint32_be(krbNameLen, p);
525 memcpy(p, krbName, krbNameLen);
528 if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
529 memcpy(p, attrs.value, attrs.length);
533 assert(p == (unsigned char *)exportedName->value + exportedNameLen);
535 major = GSS_S_COMPLETE;
539 gss_release_buffer(&tmpMinor, &attrs);
540 if (GSS_ERROR(major))
541 gss_release_buffer(&tmpMinor, exportedName);
542 krb5_free_unparsed_name(krbContext, krbName);
548 gssEapCanonicalizeName(OM_uint32 *minor,
549 const gss_name_t input_name,
550 const gss_OID mech_type,
551 gss_name_t *dest_name)
553 OM_uint32 major, tmpMinor;
554 krb5_context krbContext;
558 if (input_name == GSS_C_NO_NAME) {
560 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
563 GSSEAP_KRB_INIT(&krbContext);
565 major = gssEapAllocName(minor, &name);
566 if (GSS_ERROR(major)) {
570 if (mech_type != GSS_C_NO_OID)
571 mech_used = mech_type;
573 mech_used = input_name->mechanismUsed;
575 major = gssEapCanonicalizeOid(minor,
578 &name->mechanismUsed);
579 if (GSS_ERROR(major))
582 name->flags = input_name->flags;
584 *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
585 &name->krbPrincipal);
587 major = GSS_S_FAILURE;
591 if (input_name->attrCtx != NULL) {
592 major = gssEapDuplicateAttrContext(minor, input_name, name);
593 if (GSS_ERROR(major))
600 if (GSS_ERROR(major)) {
601 gssEapReleaseName(&tmpMinor, &name);
608 gssEapDuplicateName(OM_uint32 *minor,
609 const gss_name_t input_name,
610 gss_name_t *dest_name)
612 return gssEapCanonicalizeName(minor, input_name,
613 GSS_C_NO_OID, dest_name);
617 gssEapDisplayName(OM_uint32 *minor,
619 gss_buffer_t output_name_buffer,
620 gss_OID *output_name_type)
623 krb5_context krbContext;
627 GSSEAP_KRB_INIT(&krbContext);
629 output_name_buffer->length = 0;
630 output_name_buffer->value = NULL;
632 if (name == GSS_C_NO_NAME) {
634 return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
637 *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
639 return GSS_S_FAILURE;
642 major = makeStringBuffer(minor, krbName, output_name_buffer);
643 if (GSS_ERROR(major)) {
644 krb5_free_unparsed_name(krbContext, krbName);
648 krb5_free_unparsed_name(krbContext, krbName);
650 if (KRB_PRINC_TYPE(name->krbPrincipal) == KRB5_NT_WELLKNOWN &&
651 krb5_principal_compare(krbContext,
652 name->krbPrincipal, krbAnonymousPrincipal())) {
653 name_type = GSS_C_NT_ANONYMOUS;
655 name_type = GSS_EAP_NT_PRINCIPAL_NAME;
658 if (output_name_type != NULL)
659 *output_name_type = name_type;
661 return GSS_S_COMPLETE;