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