simplify importAnonymousName
[moonshot.git] / mech_eap / util_name.c
1 /*
2  * Copyright (c) 2011, JANET(UK)
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  *
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.
15  *
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.
19  *
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
30  * SUCH DAMAGE.
31  */
32 /*
33  * Portions Copyright 2009 by the Massachusetts Institute of Technology.
34  * All Rights Reserved.
35  *
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.
40  *
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.
54  */
55
56 /*
57  * Name utility routines.
58  */
59
60 #include "gssapiP_eap.h"
61
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"
65 };
66
67 gss_OID GSS_EAP_NT_PRINCIPAL_NAME = &gssEapNtPrincipalName;
68
69 OM_uint32
70 gssEapAllocName(OM_uint32 *minor, gss_name_t *pName)
71 {
72     OM_uint32 tmpMinor;
73     gss_name_t name;
74
75     *pName = GSS_C_NO_NAME;
76
77     name = (gss_name_t)GSSEAP_CALLOC(1, sizeof(*name));
78     if (name == NULL) {
79         *minor = ENOMEM;
80         return GSS_S_FAILURE;
81     }
82
83     if (GSSEAP_MUTEX_INIT(&name->mutex) != 0) {
84         *minor = errno;
85         gssEapReleaseName(&tmpMinor, &name);
86         return GSS_S_FAILURE;
87     }
88
89     *pName = name;
90
91     return GSS_S_COMPLETE;
92 }
93
94 OM_uint32
95 gssEapReleaseName(OM_uint32 *minor, gss_name_t *pName)
96 {
97     gss_name_t name;
98     krb5_context krbContext = NULL;
99     OM_uint32 tmpMinor;
100
101     *minor = 0;
102
103     if (pName == NULL) {
104         return GSS_S_COMPLETE;
105     }
106
107     name = *pName;
108     if (name == GSS_C_NO_NAME) {
109         return GSS_S_COMPLETE;
110     }
111
112     GSSEAP_KRB_INIT(&krbContext);
113     krb5_free_principal(krbContext, name->krbPrincipal);
114     gssEapReleaseOid(&tmpMinor, &name->mechanismUsed);
115
116     gssEapReleaseAttrContext(&tmpMinor, name);
117
118     GSSEAP_MUTEX_DESTROY(&name->mutex);
119     GSSEAP_FREE(name);
120     *pName = NULL;
121
122     return GSS_S_COMPLETE;
123 }
124
125 static OM_uint32
126 krbPrincipalToName(OM_uint32 *minor,
127                    krb5_principal *principal,
128                    gss_name_t *pName)
129 {
130     OM_uint32 major;
131     gss_name_t name;
132
133     major = gssEapAllocName(minor, &name);
134     if (GSS_ERROR(major))
135         return major;
136
137     name->krbPrincipal = *principal;
138     *principal = NULL;
139
140     if (KRB_PRINC_LENGTH(name->krbPrincipal) > 1) {
141         name->flags |= NAME_FLAG_SERVICE;
142     } else {
143         name->flags |= NAME_FLAG_NAI;
144     }
145
146     *pName = name;
147     *minor = 0;
148
149     return GSS_S_COMPLETE;
150 }
151
152 static OM_uint32
153 importServiceName(OM_uint32 *minor,
154                   const gss_buffer_t nameBuffer,
155                   gss_name_t *pName)
156 {
157     OM_uint32 major;
158     krb5_context krbContext;
159     krb5_principal krbPrinc;
160     char *service, *host;
161
162     GSSEAP_KRB_INIT(&krbContext);
163
164     major = bufferToString(minor, nameBuffer, &service);
165     if (GSS_ERROR(major))
166         return major;
167
168     host = strchr(service, '@');
169     if (host != NULL) {
170         *host = '\0';
171         host++;
172     }
173
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;
180     }
181
182     major = krbPrincipalToName(minor, &krbPrinc, pName);
183     if (GSS_ERROR(major)) {
184         krb5_free_principal(krbContext, krbPrinc);
185     }
186
187     GSSEAP_FREE(service);
188     return major;
189 }
190
191 static OM_uint32
192 importUserName(OM_uint32 *minor,
193                const gss_buffer_t nameBuffer,
194                gss_name_t *pName)
195 {
196     OM_uint32 major;
197     krb5_context krbContext;
198     krb5_principal krbPrinc;
199     char *nameString, *realm;
200     int flags = 0;
201
202     GSSEAP_KRB_INIT(&krbContext);
203
204     realm = getenv("GSSEAP_DEFAULT_REALM");
205     if (realm != NULL) {
206         *minor = krb5_set_default_realm(krbContext, realm);
207         if (*minor != 0)
208             return GSS_S_FAILURE;
209     } else {
210         flags |= KRB5_PRINCIPAL_PARSE_REQUIRE_REALM;
211     }
212
213     if (nameBuffer == GSS_C_NO_BUFFER) {
214         *minor = krb5_copy_principal(krbContext,
215                                      krbAnonymousPrincipal(), &krbPrinc);
216         if (*minor != 0)
217             return GSS_S_FAILURE;
218     } else {
219         major = bufferToString(minor, nameBuffer, &nameString);
220         if (GSS_ERROR(major))
221             return major;
222
223         *minor = krb5_parse_name_flags(krbContext, nameString, flags, &krbPrinc);
224         if (*minor != 0) {
225             GSSEAP_FREE(nameString);
226             return GSS_S_FAILURE;
227         }
228     }
229
230     major = krbPrincipalToName(minor, &krbPrinc, pName);
231     if (GSS_ERROR(major)) {
232         krb5_free_principal(krbContext, krbPrinc);
233     }
234
235     GSSEAP_FREE(nameString);
236     return major;
237 }
238
239 static OM_uint32
240 importAnonymousName(OM_uint32 *minor,
241                     const gss_buffer_t nameBuffer GSSEAP_UNUSED,
242                     gss_name_t *pName)
243 {
244     return importUserName(minor, GSS_C_NO_BUFFER, pName);
245 }
246
247 #define UPDATE_REMAIN(n)    do {            \
248         p += (n);                           \
249         remain -= (n);                      \
250     } while (0)
251
252 #define CHECK_REMAIN(n)     do {        \
253         if (remain < (n)) {             \
254             major = GSS_S_BAD_NAME;     \
255             *minor = GSSEAP_TOK_TRUNC;  \
256             goto cleanup;               \
257         }                               \
258     } while (0)
259
260 OM_uint32
261 gssEapImportNameInternal(OM_uint32 *minor,
262                          const gss_buffer_t nameBuffer,
263                          gss_name_t *pName,
264                          unsigned int flags)
265 {
266     OM_uint32 major, tmpMinor;
267     krb5_context krbContext;
268     unsigned char *p;
269     size_t len, remain;
270     gss_buffer_desc buf;
271     enum gss_eap_token_type tokType;
272     gss_name_t name = GSS_C_NO_NAME;
273     gss_OID mechanismUsed = GSS_C_NO_OID;
274
275     GSSEAP_KRB_INIT(&krbContext);
276
277     p = (unsigned char *)nameBuffer->value;
278     remain = nameBuffer->length;
279
280     if (flags & EXPORT_NAME_FLAG_OID) {
281         gss_OID_desc mech;
282
283         /* TOK_ID || MECH_OID_LEN || MECH_OID */
284         if (remain < 6)
285             return GSS_S_BAD_NAME;
286
287         if (flags & EXPORT_NAME_FLAG_COMPOSITE)
288             tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
289         else
290             tokType = TOK_TYPE_EXPORT_NAME;
291
292         /* TOK_ID */
293         if (load_uint16_be(p) != tokType)
294             return GSS_S_BAD_NAME;
295         UPDATE_REMAIN(2);
296
297         /* MECH_OID_LEN */
298         len = load_uint16_be(p);
299         if (len < 2)
300             return GSS_S_BAD_NAME;
301         UPDATE_REMAIN(2);
302
303         /* MECH_OID */
304         if (p[0] != 0x06)
305             return GSS_S_BAD_NAME;
306
307         mech.length = p[1];
308         mech.elements = &p[2];
309
310         CHECK_REMAIN(mech.length);
311
312         major = gssEapCanonicalizeOid(minor,
313                                       &mech,
314                                       OID_FLAG_FAMILY_MECH_VALID |
315                                         OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
316                                       &mechanismUsed);
317         if (GSS_ERROR(major))
318             goto cleanup;
319
320         UPDATE_REMAIN(2 + mech.length);
321     }
322
323     /* NAME_LEN */
324     CHECK_REMAIN(4);
325     len = load_uint32_be(p);
326     UPDATE_REMAIN(4);
327
328     /* NAME */
329     CHECK_REMAIN(len);
330     buf.length = len;
331     buf.value = p;
332     UPDATE_REMAIN(len);
333
334     major = importUserName(minor, &buf, &name);
335     if (GSS_ERROR(major))
336         goto cleanup;
337
338     name->mechanismUsed = mechanismUsed;
339     mechanismUsed = GSS_C_NO_OID;
340
341     if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
342         gss_buffer_desc buf;
343
344         buf.length = remain;
345         buf.value = p;
346
347         major = gssEapImportAttrContext(minor, &buf, name);
348         if (GSS_ERROR(major))
349             goto cleanup;
350     }
351
352     major = GSS_S_COMPLETE;
353     *minor = 0;
354
355 cleanup:
356     if (GSS_ERROR(major)) {
357         gssEapReleaseOid(&tmpMinor, &mechanismUsed);
358         gssEapReleaseName(&tmpMinor, &name);
359     } else {
360         *pName = name;
361     }
362
363     return major;
364 }
365
366 static OM_uint32
367 importExportName(OM_uint32 *minor,
368                  const gss_buffer_t nameBuffer,
369                  gss_name_t *name)
370 {
371     return gssEapImportNameInternal(minor, nameBuffer, name,
372                                     EXPORT_NAME_FLAG_OID);
373 }
374
375 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
376 static OM_uint32
377 importCompositeExportName(OM_uint32 *minor,
378                           const gss_buffer_t nameBuffer,
379                           gss_name_t *name)
380 {
381     return gssEapImportNameInternal(minor, nameBuffer, name,
382                                     EXPORT_NAME_FLAG_OID |
383                                     EXPORT_NAME_FLAG_COMPOSITE);
384 }
385 #endif
386
387 struct gss_eap_name_import_provider {
388     gss_OID oid;
389     OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
390 };
391
392 OM_uint32
393 gssEapImportName(OM_uint32 *minor,
394                  const gss_buffer_t nameBuffer,
395                  gss_OID nameType,
396                  gss_OID mechType,
397                  gss_name_t *pName)
398 {
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   },
408 #endif
409     };
410     size_t i;
411     OM_uint32 major = GSS_S_BAD_NAMETYPE;
412     OM_uint32 tmpMinor;
413     gss_name_t name = GSS_C_NO_NAME;
414
415     if (nameType == GSS_C_NO_OID)
416         nameType = nameTypes[0].oid;
417
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);
421             break;
422         }
423     }
424
425     if (major == GSS_S_COMPLETE &&
426         mechType != GSS_C_NO_OID) {
427         assert(gssEapIsConcreteMechanismOid(mechType));
428         assert(name->mechanismUsed == GSS_C_NO_OID);
429
430         major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
431     }
432
433     if (GSS_ERROR(major))
434         gssEapReleaseName(&tmpMinor, &name);
435     else
436         *pName = name;
437
438     return major;
439 }
440
441 OM_uint32
442 gssEapExportName(OM_uint32 *minor,
443                  const gss_name_t name,
444                  gss_buffer_t exportedName)
445 {
446     return gssEapExportNameInternal(minor, name, exportedName,
447                                     EXPORT_NAME_FLAG_OID);
448 }
449
450 OM_uint32
451 gssEapExportNameInternal(OM_uint32 *minor,
452                          const gss_name_t name,
453                          gss_buffer_t exportedName,
454                          unsigned int flags)
455 {
456     OM_uint32 major = GSS_S_FAILURE, tmpMinor;
457     krb5_context krbContext;
458     char *krbName = NULL;
459     size_t krbNameLen, exportedNameLen;
460     unsigned char *p;
461     gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
462     gss_OID mech;
463
464     exportedName->length = 0;
465     exportedName->value = NULL;
466
467     if (name->mechanismUsed != GSS_C_NO_OID)
468         mech = name->mechanismUsed;
469     else
470         mech = GSS_EAP_MECHANISM;
471
472     GSSEAP_KRB_INIT(&krbContext);
473
474     *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
475     if (*minor != 0) {
476         major = GSS_S_FAILURE;
477         goto cleanup;
478     }
479     krbNameLen = strlen(krbName);
480
481     exportedNameLen = 0;
482     if (flags & EXPORT_NAME_FLAG_OID) {
483         exportedNameLen += 6 + mech->length;
484     }
485     exportedNameLen += 4 + krbNameLen;
486     if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
487         major = gssEapExportAttrContext(minor, name, &attrs);
488         if (GSS_ERROR(major))
489             goto cleanup;
490         exportedNameLen += attrs.length;
491     }
492
493     exportedName->value = GSSEAP_MALLOC(exportedNameLen);
494     if (exportedName->value == NULL) {
495         major = GSS_S_FAILURE;
496         *minor = ENOMEM;
497         goto cleanup;
498     }
499     exportedName->length = exportedNameLen;
500
501     p = (unsigned char *)exportedName->value;
502
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,
508                         p);
509         p += 2;
510         store_uint16_be(mech->length + 2, p);
511         p += 2;
512
513         /* MECH_OID */
514         *p++ = 0x06;
515         *p++ = mech->length & 0xff;
516         memcpy(p, mech->elements, mech->length);
517         p += mech->length;
518     }
519
520     /* NAME_LEN */
521     store_uint32_be(krbNameLen, p);
522     p += 4;
523
524     /* NAME */
525     memcpy(p, krbName, krbNameLen);
526     p += krbNameLen;
527
528     if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
529         memcpy(p, attrs.value, attrs.length);
530         p += attrs.length;
531     }
532
533     assert(p == (unsigned char *)exportedName->value + exportedNameLen);
534
535     major = GSS_S_COMPLETE;
536     *minor = 0;
537
538 cleanup:
539     gss_release_buffer(&tmpMinor, &attrs);
540     if (GSS_ERROR(major))
541         gss_release_buffer(&tmpMinor, exportedName);
542     krb5_free_unparsed_name(krbContext, krbName);
543
544     return major;
545 }
546
547 OM_uint32
548 gssEapCanonicalizeName(OM_uint32 *minor,
549                        const gss_name_t input_name,
550                        const gss_OID mech_type,
551                        gss_name_t *dest_name)
552 {
553     OM_uint32 major, tmpMinor;
554     krb5_context krbContext;
555     gss_name_t name;
556     gss_OID mech_used;
557
558     if (input_name == GSS_C_NO_NAME) {
559         *minor = EINVAL;
560         return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
561     }
562
563     GSSEAP_KRB_INIT(&krbContext);
564
565     major = gssEapAllocName(minor, &name);
566     if (GSS_ERROR(major)) {
567         return major;
568     }
569
570     if (mech_type != GSS_C_NO_OID)
571         mech_used = mech_type;
572     else
573         mech_used = input_name->mechanismUsed;
574
575     major = gssEapCanonicalizeOid(minor,
576                                   mech_used,
577                                   OID_FLAG_NULL_VALID,
578                                   &name->mechanismUsed);
579     if (GSS_ERROR(major))
580         goto cleanup;
581
582     name->flags = input_name->flags;
583
584     *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
585                                  &name->krbPrincipal);
586     if (*minor != 0) {
587         major = GSS_S_FAILURE;
588         goto cleanup;
589     }
590
591     if (input_name->attrCtx != NULL) {
592         major = gssEapDuplicateAttrContext(minor, input_name, name);
593         if (GSS_ERROR(major))
594             goto cleanup;
595     }
596
597     *dest_name = name;
598
599 cleanup:
600     if (GSS_ERROR(major)) {
601         gssEapReleaseName(&tmpMinor, &name);
602     }
603
604     return major;
605 }
606
607 OM_uint32
608 gssEapDuplicateName(OM_uint32 *minor,
609                     const gss_name_t input_name,
610                     gss_name_t *dest_name)
611 {
612     return gssEapCanonicalizeName(minor, input_name,
613                                   GSS_C_NO_OID, dest_name);
614 }
615
616 OM_uint32
617 gssEapDisplayName(OM_uint32 *minor,
618                   gss_name_t name,
619                   gss_buffer_t output_name_buffer,
620                   gss_OID *output_name_type)
621 {
622     OM_uint32 major;
623     krb5_context krbContext;
624     char *krbName;
625     gss_OID name_type;
626
627     GSSEAP_KRB_INIT(&krbContext);
628
629     output_name_buffer->length = 0;
630     output_name_buffer->value = NULL;
631
632     if (name == GSS_C_NO_NAME) {
633         *minor = EINVAL;
634         return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
635     }
636
637     *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
638     if (*minor != 0) {
639         return GSS_S_FAILURE;
640     }
641
642     major = makeStringBuffer(minor, krbName, output_name_buffer);
643     if (GSS_ERROR(major)) {
644         krb5_free_unparsed_name(krbContext, krbName);
645         return major;
646     }
647
648     krb5_free_unparsed_name(krbContext, krbName);
649
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;
654     } else {
655         name_type = GSS_EAP_NT_PRINCIPAL_NAME;
656     }
657
658     if (output_name_type != NULL)
659         *output_name_type = name_type;
660
661     return GSS_S_COMPLETE;
662 }