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