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