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