various fixes, add a sample attribute to exercise code
[mech_eap.git] / util_attr.cpp
1 /*
2  * Copyright (c) 2010, 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 #include "gssapiP_eap.h"
34
35 #include <typeinfo>
36 #include <string>
37 #include <exception>
38 #include <new>
39
40 static gss_eap_attr_create_provider gssEapAttrFactories[ATTR_TYPE_MAX];
41 static gss_buffer_desc gssEapAttrPrefixes[ATTR_TYPE_MAX];
42
43 void
44 gss_eap_attr_ctx::registerProvider(unsigned int type,
45                                    const char *prefix,
46                                    gss_eap_attr_create_provider factory)
47 {
48     assert(type < ATTR_TYPE_MAX);
49
50     assert(gssEapAttrFactories[type] == NULL);
51
52     gssEapAttrFactories[type] = factory;
53     if (prefix != NULL) {
54         gssEapAttrPrefixes[type].value = (void *)prefix;
55         gssEapAttrPrefixes[type].length = strlen(prefix);
56     } else {
57         gssEapAttrPrefixes[type].value = NULL;
58         gssEapAttrPrefixes[type].length = 0;
59     }
60 }
61
62 void
63 gss_eap_attr_ctx::unregisterProvider(unsigned int type)
64 {
65     assert(type < ATTR_TYPE_MAX);
66
67     gssEapAttrFactories[type] = NULL;
68     gssEapAttrPrefixes[type].value = NULL;
69     gssEapAttrPrefixes[type].length = 0;
70 }
71
72 gss_eap_attr_ctx::gss_eap_attr_ctx(void)
73 {
74     for (unsigned int i = 0; i < ATTR_TYPE_MAX; i++) {
75         gss_eap_attr_provider *provider;
76
77         provider = (gssEapAttrFactories[i])();
78
79         m_providers[i] = provider;
80
81         /* providers should fail in constructor */
82         assert(m_providers[i] != NULL);
83     }
84 }
85
86 unsigned int
87 gss_eap_attr_ctx::attributePrefixToType(const gss_buffer_t prefix)
88 {
89     unsigned int i;
90
91     for (i = ATTR_TYPE_MIN; i < ATTR_TYPE_LOCAL; i++) {
92         if (bufferEqual(&gssEapAttrPrefixes[i], prefix))
93             return i;
94     }
95
96     return ATTR_TYPE_LOCAL;
97 }
98
99 const gss_buffer_t
100 gss_eap_attr_ctx::attributeTypeToPrefix(unsigned int type)
101 {
102     if (type < ATTR_TYPE_MIN || type >= ATTR_TYPE_LOCAL)
103         return GSS_C_NO_BUFFER;
104
105     return &gssEapAttrPrefixes[type];
106 }
107
108 /*
109  * Initialize a context from an existing context.
110  */
111 bool
112 gss_eap_attr_ctx::initFromExistingContext(const gss_eap_attr_ctx *manager)
113 {
114     bool ret = true;
115
116     for (unsigned int i = 0; i < ATTR_TYPE_MAX; i++) {
117         gss_eap_attr_provider *provider = m_providers[i];
118
119         ret = provider->initFromExistingContext(this, manager->m_providers[i]);
120         if (ret == false)
121             break;
122     }
123
124     return ret;
125 }
126
127 /*
128  * Initialize a context from a GSS credential and context.
129  */
130 bool
131 gss_eap_attr_ctx::initFromGssContext(const gss_cred_id_t cred,
132                                      const gss_ctx_id_t ctx)
133 {
134     bool ret = true;
135
136     for (unsigned int i = 0; i < ATTR_TYPE_MAX; i++) {
137         gss_eap_attr_provider *provider = m_providers[i];
138
139         ret = provider->initFromGssContext(this, cred, ctx);
140         if (ret == false)
141             break;
142     }
143
144     return ret;
145 }
146
147 /*
148  * Initialize a context from an exported context or name token
149  */
150 bool
151 gss_eap_attr_ctx::initFromBuffer(const gss_buffer_t buffer)
152 {
153     bool ret;
154     gss_eap_attr_provider *primaryProvider = getPrimaryProvider();
155
156     ret = primaryProvider->initFromBuffer(this, buffer);
157     if (ret == false)
158         return ret;
159
160     for (unsigned int i = ATTR_TYPE_MIN; i < ATTR_TYPE_MAX; i++) {
161         gss_eap_attr_provider *provider = m_providers[i];
162
163         if (provider == primaryProvider)
164             continue;
165
166         ret = provider->initFromGssContext(this,
167                                            GSS_C_NO_CREDENTIAL,
168                                            GSS_C_NO_CONTEXT);
169         if (ret == false)
170             break;
171     }
172
173     return ret;
174 }
175
176 gss_eap_attr_ctx::~gss_eap_attr_ctx(void)
177 {
178     for (unsigned int i = ATTR_TYPE_MIN; i < ATTR_TYPE_MAX; i++)
179         delete m_providers[i];
180 }
181
182 gss_eap_attr_provider *
183 gss_eap_attr_ctx::getProvider(unsigned int type) const
184 {
185     return m_providers[type];
186 }
187
188 gss_eap_attr_provider *
189 gss_eap_attr_ctx::getProvider(const gss_buffer_t prefix) const
190 {
191     unsigned int type;
192
193     type = attributePrefixToType(prefix);
194
195     return m_providers[type];
196 }
197
198 gss_eap_attr_provider *
199 gss_eap_attr_ctx::getPrimaryProvider(void) const
200 {
201     return m_providers[ATTR_TYPE_RADIUS];
202 }
203
204 void
205 gss_eap_attr_ctx::setAttribute(int complete,
206                                const gss_buffer_t attr,
207                                const gss_buffer_t value)
208 {
209     gss_buffer_desc suffix = GSS_C_EMPTY_BUFFER;
210     unsigned int type;
211     gss_eap_attr_provider *provider;
212
213     decomposeAttributeName(attr, &type, &suffix);
214
215     provider = m_providers[type];
216     if (provider != NULL) {
217         provider->setAttribute(complete,
218                                (type == ATTR_TYPE_LOCAL) ? attr : &suffix,
219                                value);
220                                
221     }
222 }
223
224 void
225 gss_eap_attr_ctx::deleteAttribute(const gss_buffer_t attr)
226 {
227     gss_buffer_desc suffix = GSS_C_EMPTY_BUFFER;
228     unsigned int type;
229     gss_eap_attr_provider *provider;
230
231     decomposeAttributeName(attr, &type, &suffix);
232
233     provider = m_providers[type];
234     if (provider != NULL) {
235         provider->deleteAttribute(type == ATTR_TYPE_LOCAL ? attr : &suffix);
236     }
237 }
238
239 bool
240 gss_eap_attr_ctx::getAttributeTypes(gss_eap_attr_enumeration_cb cb, void *data) const
241 {
242     bool ret = false;
243     size_t i;
244
245     for (i = 0; i < ATTR_TYPE_MAX; i++) {
246         ret = m_providers[i]->getAttributeTypes(cb, data);
247         if (ret == false)
248             break;
249     }
250
251     return ret;
252 }
253
254 struct eap_gss_get_attr_types_args {
255     unsigned int type;
256     gss_buffer_set_t attrs;
257 };
258
259 static bool
260 addAttribute(const gss_eap_attr_provider *provider,
261              const gss_buffer_t attribute,
262              void *data)
263 {
264     eap_gss_get_attr_types_args *args = (eap_gss_get_attr_types_args *)data;
265     gss_buffer_desc qualified;
266     OM_uint32 major, minor;
267
268     if (args->type != ATTR_TYPE_LOCAL) {
269         gss_eap_attr_ctx::composeAttributeName(args->type, attribute, &qualified);
270         major = gss_add_buffer_set_member(&minor, &qualified, &args->attrs);
271         gss_release_buffer(&minor, &qualified);
272     } else {
273         major = gss_add_buffer_set_member(&minor, attribute, &args->attrs);
274     }
275
276     return GSS_ERROR(major) == false;
277 }
278
279 bool
280 gss_eap_attr_ctx::getAttributeTypes(gss_buffer_set_t *attrs)
281 {
282     eap_gss_get_attr_types_args args;
283     OM_uint32 major, minor;
284     bool ret = false;
285     unsigned int i;
286
287     major = gss_create_empty_buffer_set(&minor, attrs);
288     if (GSS_ERROR(major)) {
289         throw new std::bad_alloc;
290         return false;
291     }
292
293     args.attrs = *attrs;
294
295     for (i = 0; i < ATTR_TYPE_MAX; i++) {
296         args.type = i;
297
298         ret = m_providers[i]->getAttributeTypes(addAttribute, (void *)&args);
299         if (ret == false)
300             break;
301     }
302
303     if (ret == false)
304         gss_release_buffer_set(&minor, attrs);
305
306     return ret;
307 }
308
309 bool
310 gss_eap_attr_ctx::getAttribute(const gss_buffer_t attr,
311                                int *authenticated,
312                                int *complete,
313                                gss_buffer_t value,
314                                gss_buffer_t display_value,
315                                int *more) const
316 {
317     gss_buffer_desc suffix = GSS_C_EMPTY_BUFFER;
318     unsigned int type;
319     gss_eap_attr_provider *provider;
320     bool ret;
321
322     decomposeAttributeName(attr, &type, &suffix);
323
324     provider = m_providers[type];
325
326     ret = provider->getAttribute(type == ATTR_TYPE_LOCAL ? attr : &suffix,
327                                  authenticated, complete,
328                                  value, display_value, more);
329
330     return ret;
331 }
332
333 gss_any_t
334 gss_eap_attr_ctx::mapToAny(int authenticated,
335                            gss_buffer_t type_id) const
336 {
337     unsigned int type;
338     gss_eap_attr_provider *provider;
339
340     type = attributePrefixToType(type_id);
341
342     provider = m_providers[type];
343
344     return provider->mapToAny(authenticated, type_id);
345 }
346
347 void
348 gss_eap_attr_ctx::releaseAnyNameMapping(gss_buffer_t type_id,
349                                         gss_any_t input) const
350 {
351     unsigned int type;
352     gss_eap_attr_provider *provider;
353
354     type = attributePrefixToType(type_id);
355
356     provider = m_providers[type];
357
358     provider->releaseAnyNameMapping(type_id, input);
359 }
360
361 void
362 gss_eap_attr_ctx::exportToBuffer(gss_buffer_t buffer) const
363 {
364     getPrimaryProvider()->exportToBuffer(buffer);
365 }
366
367 time_t
368 gss_eap_attr_ctx::getExpiryTime(void) const
369 {
370     unsigned int i;
371     time_t expiryTime = 0;
372
373     for (i = ATTR_TYPE_MIN; i < ATTR_TYPE_MAX; i++) {
374         time_t providerExpiryTime = m_providers[i]->getExpiryTime();
375
376         if (providerExpiryTime == 0)
377             continue;
378
379         if (expiryTime == 0 || providerExpiryTime < expiryTime)
380             expiryTime = providerExpiryTime;
381     }
382
383     return expiryTime;
384 }
385
386 /*
387  * C wrappers
388  */
389
390 static OM_uint32
391 mapException(OM_uint32 *minor, std::exception &e)
392 {
393     OM_uint32 major = GSS_S_FAILURE;
394
395     /* XXX TODO implement other mappings */
396     if (typeid(e) == typeid(std::bad_alloc))
397         *minor = ENOMEM;
398     else
399         *minor = 0;
400
401 #ifdef GSSEAP_DEBUG
402     /* rethrow for now for debugging */
403     throw e;
404 #endif
405
406     return major;
407 }
408
409 void
410 gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
411                                          gss_buffer_t prefix,
412                                          gss_buffer_t suffix)
413 {
414     char *p = NULL;
415     size_t i;
416
417     for (i = 0; i < attribute->length; i++) {
418         if (((char *)attribute->value)[i] == ' ') {
419             p = (char *)attribute->value + i + 1;
420             break;
421         }
422     }
423
424     prefix->value = attribute->value;
425     prefix->length = i;
426
427     if (p != NULL && *p != '\0')  {
428         suffix->length = attribute->length - 1 - prefix->length;
429         suffix->value = p;
430     } else {
431         suffix->length = 0;
432         suffix->value = NULL;
433     }
434 }
435
436 std::string
437 gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
438                                        const gss_buffer_t suffix)
439 {
440     std::string str;
441
442     if (prefix == GSS_C_NO_BUFFER || prefix->length == 0)
443         return str;
444
445     str.append((const char *)prefix->value, prefix->length);
446
447     if (suffix != GSS_C_NO_BUFFER) {
448         str.append(" ");
449         str.append((const char *)suffix->value, suffix->length);
450     }
451
452     return str;
453 }
454
455 std::string
456 gss_eap_attr_ctx::composeAttributeName(unsigned int type,
457                                        const gss_buffer_t suffix)
458 {
459     const gss_buffer_t prefix = attributeTypeToPrefix(type);
460
461     return composeAttributeName(prefix, suffix);
462 }
463
464 void
465 gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
466                                        const gss_buffer_t suffix,
467                                        gss_buffer_t attribute)
468 {
469     std::string str = composeAttributeName(prefix, suffix);
470
471     if (str.length() != 0) {
472         return duplicateBuffer(str, attribute);
473     } else {
474         attribute->length = 0;
475         attribute->value = NULL;
476     }
477 }
478
479 void
480 gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
481                                          unsigned int *type,
482                                          gss_buffer_t suffix)
483 {
484     gss_buffer_desc prefix = GSS_C_EMPTY_BUFFER;
485
486     decomposeAttributeName(attribute, &prefix, suffix);
487     *type = attributePrefixToType(&prefix);
488 }
489
490 void
491 gss_eap_attr_ctx::composeAttributeName(unsigned int type,
492                                        const gss_buffer_t suffix,
493                                        gss_buffer_t attribute)
494 {
495     gss_buffer_t prefix = attributeTypeToPrefix(type);
496
497     return composeAttributeName(prefix, suffix, attribute);
498 }
499
500 OM_uint32
501 gssEapInquireName(OM_uint32 *minor,
502                   gss_name_t name,
503                   int *name_is_MN,
504                   gss_OID *MN_mech,
505                   gss_buffer_set_t *attrs)
506 {
507     if (name->attrCtx == NULL)
508         return GSS_S_UNAVAILABLE;
509
510     try {
511         if (!name->attrCtx->getAttributeTypes(attrs))
512             return GSS_S_UNAVAILABLE;
513     } catch (std::exception &e) {
514         return mapException(minor, e);
515     }
516
517     return GSS_S_COMPLETE;
518 }
519
520 OM_uint32
521 gssEapGetNameAttribute(OM_uint32 *minor,
522                        gss_name_t name,
523                        gss_buffer_t attr,
524                        int *authenticated,
525                        int *complete,
526                        gss_buffer_t value,
527                        gss_buffer_t display_value,
528                        int *more)
529 {
530     *authenticated = 0;
531     *complete = 0;
532
533     if (value != NULL) {
534         value->length = 0;
535         value->value = NULL;
536     }
537
538     if (display_value != NULL) {
539         display_value->length = 0;
540         display_value->value = NULL;
541     }
542
543     if (name->attrCtx == NULL)
544         return GSS_S_UNAVAILABLE;
545
546     try {
547         if (!name->attrCtx->getAttribute(attr, authenticated, complete,
548                                          value, display_value, more))
549             return GSS_S_UNAVAILABLE;
550     } catch (std::exception &e) {
551         return mapException(minor, e);
552     }
553
554     return GSS_S_COMPLETE;
555 }
556
557 OM_uint32
558 gssEapDeleteNameAttribute(OM_uint32 *minor,
559                           gss_name_t name,
560                           gss_buffer_t attr)
561 {
562     if (name->attrCtx == NULL)
563         return GSS_S_UNAVAILABLE;
564
565     try {
566         name->attrCtx->deleteAttribute(attr);
567     } catch (std::exception &ex) {
568         return mapException(minor, ex);
569     }
570
571     return GSS_S_COMPLETE;
572 }
573
574 OM_uint32
575 gssEapSetNameAttribute(OM_uint32 *minor,
576                        gss_name_t name,
577                        int complete,
578                        gss_buffer_t attr,
579                        gss_buffer_t value)
580 {
581     if (name->attrCtx == NULL)
582         return GSS_S_UNAVAILABLE;
583
584     try {
585         name->attrCtx->setAttribute(complete, attr, value);
586     } catch (std::exception &ex) {
587         return mapException(minor, ex);
588     }
589
590     return GSS_S_COMPLETE;
591 }
592
593 OM_uint32
594 gssEapExportAttrContext(OM_uint32 *minor,
595                         gss_name_t name,
596                         gss_buffer_t buffer)
597 {
598     if (name->attrCtx == NULL) {
599         buffer->length = 0;
600         buffer->value = NULL;
601
602         return GSS_S_COMPLETE;
603     }
604
605     try {
606         name->attrCtx->exportToBuffer(buffer);
607     } catch (std::exception &e) {
608         return mapException(minor, e);
609     }
610
611     return GSS_S_COMPLETE;
612 }
613
614 OM_uint32
615 gssEapImportAttrContext(OM_uint32 *minor,
616                         gss_buffer_t buffer,
617                         gss_name_t name)
618 {
619     gss_eap_attr_ctx *ctx = NULL;
620
621     assert(name->attrCtx == NULL);
622
623     if (buffer->length != 0) {
624         try {
625             ctx = new gss_eap_attr_ctx();
626
627             if (!ctx->initFromBuffer(buffer)) {
628                 delete ctx;
629                 return GSS_S_DEFECTIVE_TOKEN;
630             }
631             name->attrCtx = ctx;
632         } catch (std::exception &e) {
633             delete ctx;
634             return mapException(minor, e);
635         }
636     }
637
638     return GSS_S_COMPLETE;
639 }
640
641 OM_uint32
642 gssEapDuplicateAttrContext(OM_uint32 *minor,
643                            gss_name_t in,
644                            gss_name_t out)
645 {
646     gss_eap_attr_ctx *ctx = NULL;
647
648     assert(out->attrCtx == NULL);
649
650     try {
651         if (in->attrCtx != NULL) {
652             ctx = new gss_eap_attr_ctx();
653             if (!ctx->initFromExistingContext(in->attrCtx)) {
654                 delete ctx;
655                 return GSS_S_FAILURE;
656             }
657             out->attrCtx = ctx;
658         }
659     } catch (std::exception &e) {
660         delete ctx;
661         return mapException(minor, e);
662     }
663
664     return GSS_S_COMPLETE;
665 }
666
667 OM_uint32
668 gssEapMapNameToAny(OM_uint32 *minor,
669                    gss_name_t name,
670                    int authenticated,
671                    gss_buffer_t type_id,
672                    gss_any_t *output)
673 {
674     if (name->attrCtx == NULL)
675         return GSS_S_UNAVAILABLE;
676
677     try {
678         *output = name->attrCtx->mapToAny(authenticated, type_id);
679     } catch (std::exception &e) {
680         return mapException(minor, e);
681     }
682
683     return GSS_S_COMPLETE;
684 }
685
686 OM_uint32
687 gssEapReleaseAnyNameMapping(OM_uint32 *minor,
688                             gss_name_t name,
689                             gss_buffer_t type_id,
690                             gss_any_t *input)
691 {
692     if (name->attrCtx == NULL)
693         return GSS_S_UNAVAILABLE;
694
695     try {
696         if (*input != NULL)
697             name->attrCtx->releaseAnyNameMapping(type_id, *input);
698         *input = NULL;
699     } catch (std::exception &e) {
700         return mapException(minor, e);
701     }
702
703     return GSS_S_COMPLETE;
704 }
705
706 OM_uint32
707 gssEapReleaseAttrContext(OM_uint32 *minor,
708                          gss_name_t name)
709 {
710     if (name->attrCtx != NULL)
711         delete name->attrCtx;
712
713     return GSS_S_COMPLETE;
714 }
715
716 OM_uint32
717 gssEapAttrProvidersInit(OM_uint32 *minor)
718 {
719     try {
720         if (gss_eap_radius_attr_provider::init()    &&
721             gss_eap_saml_assertion_provider::init() &&
722             gss_eap_saml_attr_provider::init()      &&
723             gss_eap_shib_attr_provider::init())
724             return GSS_S_COMPLETE;
725     } catch (std::exception &e) {
726         return mapException(minor, e);
727     }
728
729     return GSS_S_FAILURE;
730 }
731
732 OM_uint32
733 gssEapAttrProvidersFinalize(OM_uint32 *minor)
734 {
735     try {
736         gss_eap_shib_attr_provider::finalize();
737         gss_eap_saml_attr_provider::finalize();
738         gss_eap_saml_assertion_provider::finalize();
739         gss_eap_radius_attr_provider::finalize();
740     } catch (std::exception &e) {
741         return mapException(minor, e);
742     }
743
744     return GSS_S_COMPLETE;
745 }
746
747 struct gss_eap_attr_ctx *
748 gssEapCreateAttrContext(gss_cred_id_t gssCred,
749                         gss_ctx_id_t gssCtx)
750 {
751     gss_eap_attr_ctx *ctx;
752
753     assert(gssCtx != GSS_C_NO_CONTEXT);
754
755     ctx = new gss_eap_attr_ctx();
756     if (!ctx->initFromGssContext(gssCred, gssCtx)) {
757         delete ctx;
758         return NULL;
759     }
760
761     gssCtx->expiryTime = ctx->getExpiryTime();
762
763     return ctx;
764 }