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