fa5b108d2dc9d47b74940cbf94c89218ae8bb5bf
[mech_eap.orig] / 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;
200
201     GSSEAP_KRB_INIT(&krbContext);
202
203     if (nameBuffer == GSS_C_NO_BUFFER) {
204         *minor = krb5_copy_principal(krbContext,
205                                      krbAnonymousPrincipal(), &krbPrinc);
206         if (*minor != 0)
207             return GSS_S_FAILURE;
208     } else {
209         major = bufferToString(minor, nameBuffer, &nameString);
210         if (GSS_ERROR(major))
211             return major;
212
213         *minor = krb5_parse_name_flags(krbContext, nameString,
214                                        KRB5_PRINCIPAL_PARSE_REQUIRE_REALM,
215                                        &krbPrinc);
216         if (*minor != 0) {
217             GSSEAP_FREE(nameString);
218             return GSS_S_FAILURE;
219         }
220     }
221
222     major = krbPrincipalToName(minor, &krbPrinc, pName);
223     if (GSS_ERROR(major)) {
224         krb5_free_principal(krbContext, krbPrinc);
225     }
226
227     GSSEAP_FREE(nameString);
228     return major;
229 }
230
231 static OM_uint32
232 importAnonymousName(OM_uint32 *minor,
233                     const gss_buffer_t nameBuffer GSSEAP_UNUSED,
234                     gss_name_t *pName)
235 {
236     OM_uint32 major;
237     krb5_context krbContext;
238     krb5_principal krbPrinc;
239
240     GSSEAP_KRB_INIT(&krbContext);
241
242     *minor = krb5_copy_principal(krbContext, krbAnonymousPrincipal(),
243                                  &krbPrinc);
244     if (*minor != 0)
245         return GSS_S_FAILURE;
246
247     major = krbPrincipalToName(minor, &krbPrinc, pName);
248     if (GSS_ERROR(major)) {
249         krb5_free_principal(krbContext, krbPrinc);
250     }
251
252     return major;
253 }
254
255 #define UPDATE_REMAIN(n)    do {            \
256         p += (n);                           \
257         remain -= (n);                      \
258     } while (0)
259
260 #define CHECK_REMAIN(n)     do {        \
261         if (remain < (n)) {             \
262             major = GSS_S_BAD_NAME;     \
263             *minor = GSSEAP_TOK_TRUNC;  \
264             goto cleanup;               \
265         }                               \
266     } while (0)
267
268 OM_uint32
269 gssEapImportNameInternal(OM_uint32 *minor,
270                          const gss_buffer_t nameBuffer,
271                          gss_name_t *pName,
272                          unsigned int flags)
273 {
274     OM_uint32 major, tmpMinor;
275     krb5_context krbContext;
276     unsigned char *p;
277     size_t len, remain;
278     gss_buffer_desc buf;
279     enum gss_eap_token_type tokType;
280     gss_name_t name = GSS_C_NO_NAME;
281     gss_OID mechanismUsed = GSS_C_NO_OID;
282
283     GSSEAP_KRB_INIT(&krbContext);
284
285     p = (unsigned char *)nameBuffer->value;
286     remain = nameBuffer->length;
287
288     if (flags & EXPORT_NAME_FLAG_OID) {
289         gss_OID_desc mech;
290
291         /* TOK_ID || MECH_OID_LEN || MECH_OID */
292         if (remain < 6)
293             return GSS_S_BAD_NAME;
294
295         if (flags & EXPORT_NAME_FLAG_COMPOSITE)
296             tokType = TOK_TYPE_EXPORT_NAME_COMPOSITE;
297         else
298             tokType = TOK_TYPE_EXPORT_NAME;
299
300         /* TOK_ID */
301         if (load_uint16_be(p) != tokType)
302             return GSS_S_BAD_NAME;
303         UPDATE_REMAIN(2);
304
305         /* MECH_OID_LEN */
306         len = load_uint16_be(p);
307         if (len < 2)
308             return GSS_S_BAD_NAME;
309         UPDATE_REMAIN(2);
310
311         /* MECH_OID */
312         if (p[0] != 0x06)
313             return GSS_S_BAD_NAME;
314
315         mech.length = p[1];
316         mech.elements = &p[2];
317
318         CHECK_REMAIN(mech.length);
319
320         major = gssEapCanonicalizeOid(minor,
321                                       &mech,
322                                       OID_FLAG_FAMILY_MECH_VALID |
323                                         OID_FLAG_MAP_FAMILY_MECH_TO_NULL,
324                                       &mechanismUsed);
325         if (GSS_ERROR(major))
326             goto cleanup;
327
328         UPDATE_REMAIN(2 + mech.length);
329     }
330
331     /* NAME_LEN */
332     CHECK_REMAIN(4);
333     len = load_uint32_be(p);
334     UPDATE_REMAIN(4);
335
336     /* NAME */
337     CHECK_REMAIN(len);
338     buf.length = len;
339     buf.value = p;
340     UPDATE_REMAIN(len);
341
342     major = importUserName(minor, &buf, &name);
343     if (GSS_ERROR(major))
344         goto cleanup;
345
346     name->mechanismUsed = mechanismUsed;
347     mechanismUsed = GSS_C_NO_OID;
348
349     if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
350         gss_buffer_desc buf;
351
352         buf.length = remain;
353         buf.value = p;
354
355         major = gssEapImportAttrContext(minor, &buf, name);
356         if (GSS_ERROR(major))
357             goto cleanup;
358     }
359
360     major = GSS_S_COMPLETE;
361     *minor = 0;
362
363 cleanup:
364     if (GSS_ERROR(major)) {
365         gssEapReleaseOid(&tmpMinor, &mechanismUsed);
366         gssEapReleaseName(&tmpMinor, &name);
367     } else {
368         *pName = name;
369     }
370
371     return major;
372 }
373
374 static OM_uint32
375 importExportName(OM_uint32 *minor,
376                  const gss_buffer_t nameBuffer,
377                  gss_name_t *name)
378 {
379     return gssEapImportNameInternal(minor, nameBuffer, name,
380                                     EXPORT_NAME_FLAG_OID);
381 }
382
383 #ifdef HAVE_GSS_C_NT_COMPOSITE_EXPORT
384 static OM_uint32
385 importCompositeExportName(OM_uint32 *minor,
386                           const gss_buffer_t nameBuffer,
387                           gss_name_t *name)
388 {
389     return gssEapImportNameInternal(minor, nameBuffer, name,
390                                     EXPORT_NAME_FLAG_OID |
391                                     EXPORT_NAME_FLAG_COMPOSITE);
392 }
393 #endif
394
395 struct gss_eap_name_import_provider {
396     gss_OID oid;
397     OM_uint32 (*import)(OM_uint32 *, const gss_buffer_t, gss_name_t *);
398 };
399
400 OM_uint32
401 gssEapImportName(OM_uint32 *minor,
402                  const gss_buffer_t nameBuffer,
403                  gss_OID nameType,
404                  gss_OID mechType,
405                  gss_name_t *pName)
406 {
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   },
416 #endif
417     };
418     size_t i;
419     OM_uint32 major = GSS_S_BAD_NAMETYPE;
420     OM_uint32 tmpMinor;
421     gss_name_t name = GSS_C_NO_NAME;
422
423     if (nameType == GSS_C_NO_OID)
424         nameType = nameTypes[0].oid;
425
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);
429             break;
430         }
431     }
432
433     if (major == GSS_S_COMPLETE &&
434         mechType != GSS_C_NO_OID) {
435         assert(gssEapIsConcreteMechanismOid(mechType));
436         assert(name->mechanismUsed == GSS_C_NO_OID);
437
438         major = gssEapCanonicalizeOid(minor, mechType, 0, &name->mechanismUsed);
439     }
440
441     if (GSS_ERROR(major))
442         gssEapReleaseName(&tmpMinor, &name);
443     else
444         *pName = name;
445
446     return major;
447 }
448
449 OM_uint32
450 gssEapExportName(OM_uint32 *minor,
451                  const gss_name_t name,
452                  gss_buffer_t exportedName)
453 {
454     return gssEapExportNameInternal(minor, name, exportedName,
455                                     EXPORT_NAME_FLAG_OID);
456 }
457
458 OM_uint32
459 gssEapExportNameInternal(OM_uint32 *minor,
460                          const gss_name_t name,
461                          gss_buffer_t exportedName,
462                          unsigned int flags)
463 {
464     OM_uint32 major = GSS_S_FAILURE, tmpMinor;
465     krb5_context krbContext;
466     char *krbName = NULL;
467     size_t krbNameLen, exportedNameLen;
468     unsigned char *p;
469     gss_buffer_desc attrs = GSS_C_EMPTY_BUFFER;
470     gss_OID mech;
471
472     exportedName->length = 0;
473     exportedName->value = NULL;
474
475     if (name->mechanismUsed != GSS_C_NO_OID)
476         mech = name->mechanismUsed;
477     else
478         mech = GSS_EAP_MECHANISM;
479
480     GSSEAP_KRB_INIT(&krbContext);
481
482     *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
483     if (*minor != 0) {
484         major = GSS_S_FAILURE;
485         goto cleanup;
486     }
487     krbNameLen = strlen(krbName);
488
489     exportedNameLen = 0;
490     if (flags & EXPORT_NAME_FLAG_OID) {
491         exportedNameLen += 6 + mech->length;
492     }
493     exportedNameLen += 4 + krbNameLen;
494     if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
495         major = gssEapExportAttrContext(minor, name, &attrs);
496         if (GSS_ERROR(major))
497             goto cleanup;
498         exportedNameLen += attrs.length;
499     }
500
501     exportedName->value = GSSEAP_MALLOC(exportedNameLen);
502     if (exportedName->value == NULL) {
503         major = GSS_S_FAILURE;
504         *minor = ENOMEM;
505         goto cleanup;
506     }
507     exportedName->length = exportedNameLen;
508
509     p = (unsigned char *)exportedName->value;
510
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,
516                         p);
517         p += 2;
518         store_uint16_be(mech->length + 2, p);
519         p += 2;
520
521         /* MECH_OID */
522         *p++ = 0x06;
523         *p++ = mech->length & 0xff;
524         memcpy(p, mech->elements, mech->length);
525         p += mech->length;
526     }
527
528     /* NAME_LEN */
529     store_uint32_be(krbNameLen, p);
530     p += 4;
531
532     /* NAME */
533     memcpy(p, krbName, krbNameLen);
534     p += krbNameLen;
535
536     if (flags & EXPORT_NAME_FLAG_COMPOSITE) {
537         memcpy(p, attrs.value, attrs.length);
538         p += attrs.length;
539     }
540
541     assert(p == (unsigned char *)exportedName->value + exportedNameLen);
542
543     major = GSS_S_COMPLETE;
544     *minor = 0;
545
546 cleanup:
547     gss_release_buffer(&tmpMinor, &attrs);
548     if (GSS_ERROR(major))
549         gss_release_buffer(&tmpMinor, exportedName);
550     krb5_free_unparsed_name(krbContext, krbName);
551
552     return major;
553 }
554
555 OM_uint32
556 gssEapCanonicalizeName(OM_uint32 *minor,
557                        const gss_name_t input_name,
558                        const gss_OID mech_type,
559                        gss_name_t *dest_name)
560 {
561     OM_uint32 major, tmpMinor;
562     krb5_context krbContext;
563     gss_name_t name;
564     gss_OID mech_used;
565
566     if (input_name == GSS_C_NO_NAME) {
567         *minor = EINVAL;
568         return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
569     }
570
571     GSSEAP_KRB_INIT(&krbContext);
572
573     major = gssEapAllocName(minor, &name);
574     if (GSS_ERROR(major)) {
575         return major;
576     }
577
578     if (mech_type != GSS_C_NO_OID)
579         mech_used = mech_type;
580     else
581         mech_used = input_name->mechanismUsed;
582
583     major = gssEapCanonicalizeOid(minor,
584                                   mech_used,
585                                   OID_FLAG_NULL_VALID,
586                                   &name->mechanismUsed);
587     if (GSS_ERROR(major))
588         goto cleanup;
589
590     name->flags = input_name->flags;
591
592     *minor = krb5_copy_principal(krbContext, input_name->krbPrincipal,
593                                  &name->krbPrincipal);
594     if (*minor != 0) {
595         major = GSS_S_FAILURE;
596         goto cleanup;
597     }
598
599     if (input_name->attrCtx != NULL) {
600         major = gssEapDuplicateAttrContext(minor, input_name, name);
601         if (GSS_ERROR(major))
602             goto cleanup;
603     }
604
605     *dest_name = name;
606
607 cleanup:
608     if (GSS_ERROR(major)) {
609         gssEapReleaseName(&tmpMinor, &name);
610     }
611
612     return major;
613 }
614
615 OM_uint32
616 gssEapDuplicateName(OM_uint32 *minor,
617                     const gss_name_t input_name,
618                     gss_name_t *dest_name)
619 {
620     return gssEapCanonicalizeName(minor, input_name,
621                                   GSS_C_NO_OID, dest_name);
622 }
623
624 OM_uint32
625 gssEapDisplayName(OM_uint32 *minor,
626                   gss_name_t name,
627                   gss_buffer_t output_name_buffer,
628                   gss_OID *output_name_type)
629 {
630     OM_uint32 major;
631     krb5_context krbContext;
632     char *krbName;
633     gss_OID name_type;
634
635     GSSEAP_KRB_INIT(&krbContext);
636
637     output_name_buffer->length = 0;
638     output_name_buffer->value = NULL;
639
640     if (name == GSS_C_NO_NAME) {
641         *minor = EINVAL;
642         return GSS_S_CALL_INACCESSIBLE_READ | GSS_S_BAD_NAME;
643     }
644
645     *minor = krb5_unparse_name(krbContext, name->krbPrincipal, &krbName);
646     if (*minor != 0) {
647         return GSS_S_FAILURE;
648     }
649
650     major = makeStringBuffer(minor, krbName, output_name_buffer);
651     if (GSS_ERROR(major)) {
652         krb5_free_unparsed_name(krbContext, krbName);
653         return major;
654     }
655
656     krb5_free_unparsed_name(krbContext, krbName);
657
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;
662     } else {
663         name_type = GSS_EAP_NT_PRINCIPAL_NAME;
664     }
665
666     if (output_name_type != NULL)
667         *output_name_type = name_type;
668
669     return GSS_S_COMPLETE;
670 }