2 * Copyright (c) 2010, JANET(UK)
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
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.
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.
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
33 #include "gssapiP_eap.h"
40 /* lazy initialisation */
41 static GSSEAP_THREAD_ONCE gssEapAttrProvidersInitOnce = GSSEAP_ONCE_INITIALIZER;
42 static OM_uint32 gssEapAttrProvidersInitStatus = GSS_S_UNAVAILABLE;
45 gssEapAttrProvidersInitInternal(void)
47 OM_uint32 major, minor;
49 assert(gssEapAttrProvidersInitStatus == GSS_S_UNAVAILABLE);
51 major = gssEapRadiusAttrProviderInit(&minor);
52 if (major == GSS_S_COMPLETE)
53 major = gssEapSamlAttrProvidersInit(&minor);
54 if (major == GSS_S_COMPLETE)
55 major = gssEapLocalAttrProviderInit(&minor);
58 assert(major == GSS_S_COMPLETE);
61 gssEapAttrProvidersInitStatus = major;
65 gssEapAttrProvidersInit(OM_uint32 *minor)
67 GSSEAP_ONCE(&gssEapAttrProvidersInitOnce, gssEapAttrProvidersInitInternal);
69 if (GSS_ERROR(gssEapAttrProvidersInitStatus))
70 *minor = GSSEAP_NO_ATTR_PROVIDERS;
72 return gssEapAttrProvidersInitStatus;
76 gssEapAttrProvidersFinalize(OM_uint32 *minor)
78 OM_uint32 major = GSS_S_COMPLETE;
80 if (gssEapAttrProvidersInitStatus == GSS_S_COMPLETE) {
81 major = gssEapLocalAttrProviderFinalize(minor);
82 if (major == GSS_S_COMPLETE)
83 major = gssEapSamlAttrProvidersFinalize(minor);
84 if (major == GSS_S_COMPLETE)
85 major = gssEapRadiusAttrProviderFinalize(minor);
87 gssEapAttrProvidersInitStatus = GSS_S_UNAVAILABLE;
93 static gss_eap_attr_create_provider gssEapAttrFactories[ATTR_TYPE_MAX + 1];
94 static gss_buffer_desc gssEapAttrPrefixes[ATTR_TYPE_MAX + 1];
97 * Register a provider for a particular type and prefix
100 gss_eap_attr_ctx::registerProvider(unsigned int type,
102 gss_eap_attr_create_provider factory)
104 assert(type <= ATTR_TYPE_MAX);
106 assert(gssEapAttrFactories[type] == NULL);
108 gssEapAttrFactories[type] = factory;
109 if (prefix != NULL) {
110 gssEapAttrPrefixes[type].value = (void *)prefix;
111 gssEapAttrPrefixes[type].length = strlen(prefix);
113 gssEapAttrPrefixes[type].value = NULL;
114 gssEapAttrPrefixes[type].length = 0;
119 * Unregister a provider
122 gss_eap_attr_ctx::unregisterProvider(unsigned int type)
124 assert(type <= ATTR_TYPE_MAX);
126 gssEapAttrFactories[type] = NULL;
127 gssEapAttrPrefixes[type].value = NULL;
128 gssEapAttrPrefixes[type].length = 0;
132 * Create an attribute context, that manages instances of providers
134 gss_eap_attr_ctx::gss_eap_attr_ctx(void)
138 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
139 gss_eap_attr_provider *provider;
141 if (gssEapAttrFactories[i] != NULL) {
142 provider = (gssEapAttrFactories[i])();
147 m_providers[i] = provider;
152 * Convert an attribute prefix to a type
155 gss_eap_attr_ctx::attributePrefixToType(const gss_buffer_t prefix)
159 for (i = ATTR_TYPE_MIN; i < ATTR_TYPE_MAX; i++) {
160 if (bufferEqual(&gssEapAttrPrefixes[i], prefix))
164 return ATTR_TYPE_LOCAL;
168 * Convert a type to an attribute prefix
171 gss_eap_attr_ctx::attributeTypeToPrefix(unsigned int type)
173 if (type < ATTR_TYPE_MIN || type >= ATTR_TYPE_MAX)
174 return GSS_C_NO_BUFFER;
176 return &gssEapAttrPrefixes[type];
180 gss_eap_attr_ctx::providerEnabled(unsigned int type) const
182 if (type == ATTR_TYPE_LOCAL &&
183 (m_flags & ATTR_FLAG_DISABLE_LOCAL))
186 if (m_providers[type] == NULL)
193 gss_eap_attr_ctx::releaseProvider(unsigned int type)
195 delete m_providers[type];
196 m_providers[type] = NULL;
200 * Initialize a context from an existing context.
203 gss_eap_attr_ctx::initFromExistingContext(const gss_eap_attr_ctx *manager)
207 m_flags = manager->m_flags;
209 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
210 gss_eap_attr_provider *provider;
212 if (!providerEnabled(i)) {
217 provider = m_providers[i];
219 ret = provider->initFromExistingContext(this,
220 manager->m_providers[i]);
231 * Initialize a context from a GSS credential and context.
234 gss_eap_attr_ctx::initFromGssContext(const gss_cred_id_t cred,
235 const gss_ctx_id_t ctx)
239 if (cred != GSS_C_NO_CREDENTIAL &&
240 (cred->flags & GSS_EAP_DISABLE_LOCAL_ATTRS_FLAG)) {
241 m_flags |= ATTR_FLAG_DISABLE_LOCAL;
244 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
245 gss_eap_attr_provider *provider;
247 if (!providerEnabled(i)) {
252 provider = m_providers[i];
254 ret = provider->initFromGssContext(this, cred, ctx);
265 * Initialize a context from an exported context or name token
268 gss_eap_attr_ctx::initFromBuffer(const gss_buffer_t buffer)
271 gss_eap_attr_provider *primaryProvider = getPrimaryProvider();
272 gss_buffer_desc primaryBuf;
274 if (buffer->length < 4)
277 m_flags = load_uint32_be(buffer->value);
279 primaryBuf.length = buffer->length - 4;
280 primaryBuf.value = (char *)buffer->value + 4;
282 ret = primaryProvider->initFromBuffer(this, &primaryBuf);
286 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
287 gss_eap_attr_provider *provider;
289 if (!providerEnabled(i)) {
294 provider = m_providers[i];
295 if (provider == primaryProvider)
298 ret = provider->initFromGssContext(this,
310 gss_eap_attr_ctx::~gss_eap_attr_ctx(void)
312 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++)
313 delete m_providers[i];
317 * Locate provider for a given type
319 gss_eap_attr_provider *
320 gss_eap_attr_ctx::getProvider(unsigned int type) const
322 assert(type >= ATTR_TYPE_MIN && type <= ATTR_TYPE_MAX);
323 return m_providers[type];
327 * Locate provider for a given prefix
329 gss_eap_attr_provider *
330 gss_eap_attr_ctx::getProvider(const gss_buffer_t prefix) const
334 type = attributePrefixToType(prefix);
336 return m_providers[type];
340 * Get primary provider. Only the primary provider is serialised when
341 * gss_export_sec_context() or gss_export_name_composite() is called.
343 gss_eap_attr_provider *
344 gss_eap_attr_ctx::getPrimaryProvider(void) const
346 return m_providers[ATTR_TYPE_MIN];
353 gss_eap_attr_ctx::setAttribute(int complete,
354 const gss_buffer_t attr,
355 const gss_buffer_t value)
357 gss_buffer_desc suffix = GSS_C_EMPTY_BUFFER;
359 gss_eap_attr_provider *provider;
361 decomposeAttributeName(attr, &type, &suffix);
363 provider = m_providers[type];
364 if (provider != NULL) {
365 provider->setAttribute(complete,
366 (type == ATTR_TYPE_LOCAL) ? attr : &suffix,
369 /* XXX TODO throw exception */
374 * Delete an attrbiute
377 gss_eap_attr_ctx::deleteAttribute(const gss_buffer_t attr)
379 gss_buffer_desc suffix = GSS_C_EMPTY_BUFFER;
381 gss_eap_attr_provider *provider;
383 decomposeAttributeName(attr, &type, &suffix);
385 provider = m_providers[type];
386 if (provider != NULL)
387 provider->deleteAttribute(type == ATTR_TYPE_LOCAL ? attr : &suffix);
391 * Enumerate attribute types with callback
394 gss_eap_attr_ctx::getAttributeTypes(gss_eap_attr_enumeration_cb cb, void *data) const
399 for (i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
400 gss_eap_attr_provider *provider = m_providers[i];
402 if (provider == NULL)
405 ret = provider->getAttributeTypes(cb, data);
413 struct eap_gss_get_attr_types_args {
415 gss_buffer_set_t attrs;
419 addAttribute(const gss_eap_attr_provider *provider,
420 const gss_buffer_t attribute,
423 eap_gss_get_attr_types_args *args = (eap_gss_get_attr_types_args *)data;
424 gss_buffer_desc qualified;
425 OM_uint32 major, minor;
427 if (args->type != ATTR_TYPE_LOCAL) {
428 gss_eap_attr_ctx::composeAttributeName(args->type, attribute, &qualified);
429 major = gss_add_buffer_set_member(&minor, &qualified, &args->attrs);
430 gss_release_buffer(&minor, &qualified);
432 major = gss_add_buffer_set_member(&minor, attribute, &args->attrs);
435 return GSS_ERROR(major) == false;
439 * Enumerate attribute types, output is buffer set
442 gss_eap_attr_ctx::getAttributeTypes(gss_buffer_set_t *attrs)
444 eap_gss_get_attr_types_args args;
445 OM_uint32 major, minor;
449 major = gss_create_empty_buffer_set(&minor, attrs);
450 if (GSS_ERROR(major)) {
451 throw new std::bad_alloc;
457 for (i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
458 gss_eap_attr_provider *provider = m_providers[i];
462 if (provider == NULL)
465 ret = provider->getAttributeTypes(addAttribute, (void *)&args);
471 gss_release_buffer_set(&minor, attrs);
477 * Get attribute with given name
480 gss_eap_attr_ctx::getAttribute(const gss_buffer_t attr,
484 gss_buffer_t display_value,
487 gss_buffer_desc suffix = GSS_C_EMPTY_BUFFER;
489 gss_eap_attr_provider *provider;
492 decomposeAttributeName(attr, &type, &suffix);
494 provider = m_providers[type];
495 if (provider == NULL)
498 ret = provider->getAttribute(type == ATTR_TYPE_LOCAL ? attr : &suffix,
499 authenticated, complete,
500 value, display_value, more);
506 * Map attribute context to C++ object
509 gss_eap_attr_ctx::mapToAny(int authenticated,
510 gss_buffer_t type_id) const
513 gss_eap_attr_provider *provider;
514 gss_buffer_desc suffix;
516 decomposeAttributeName(type_id, &type, &suffix);
518 provider = m_providers[type];
519 if (provider == NULL)
520 return (gss_any_t)NULL;
522 return provider->mapToAny(authenticated, &suffix);
526 * Release mapped context
529 gss_eap_attr_ctx::releaseAnyNameMapping(gss_buffer_t type_id,
530 gss_any_t input) const
533 gss_eap_attr_provider *provider;
534 gss_buffer_desc suffix;
536 decomposeAttributeName(type_id, &type, &suffix);
538 provider = m_providers[type];
539 if (provider != NULL)
540 provider->releaseAnyNameMapping(&suffix, input);
544 * Export attribute context to buffer
547 gss_eap_attr_ctx::exportToBuffer(gss_buffer_t buffer) const
549 const gss_eap_attr_provider *primaryProvider = getPrimaryProvider();
554 primaryProvider->exportToBuffer(&tmp);
556 buffer->length = 4 + tmp.length;
557 buffer->value = GSSEAP_MALLOC(buffer->length);
558 if (buffer->value == NULL)
559 throw new std::bad_alloc;
561 p = (unsigned char *)buffer->value;
562 store_uint32_be(m_flags, p);
563 memcpy(p + 4, tmp.value, tmp.length);
565 gss_release_buffer(&tmpMinor, &tmp);
569 * Return soonest expiry time of providers
572 gss_eap_attr_ctx::getExpiryTime(void) const
575 time_t expiryTime = 0;
577 for (i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
578 gss_eap_attr_provider *provider = m_providers[i];
579 time_t providerExpiryTime;
581 if (provider == NULL)
584 providerExpiryTime = provider->getExpiryTime();
585 if (providerExpiryTime == 0)
588 if (expiryTime == 0 || providerExpiryTime < expiryTime)
589 expiryTime = providerExpiryTime;
596 * Map C++ exception to GSS status
599 mapException(OM_uint32 *minor, std::exception &e)
601 OM_uint32 major = GSS_S_FAILURE;
603 /* XXX TODO implement other mappings */
604 if (typeid(e) == typeid(std::bad_alloc))
610 /* rethrow for now for debugging */
618 * Decompose attribute name into prefix and suffix
621 gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
628 for (i = 0; i < attribute->length; i++) {
629 if (((char *)attribute->value)[i] == ' ') {
630 p = (char *)attribute->value + i + 1;
635 prefix->value = attribute->value;
638 if (p != NULL && *p != '\0') {
639 suffix->length = attribute->length - 1 - prefix->length;
643 suffix->value = NULL;
648 * Decompose attribute name into type and suffix
651 gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
655 gss_buffer_desc prefix = GSS_C_EMPTY_BUFFER;
657 decomposeAttributeName(attribute, &prefix, suffix);
658 *type = attributePrefixToType(&prefix);
662 * Compose attribute name from prefix, suffix; returns C++ string
665 gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
666 const gss_buffer_t suffix)
670 if (prefix == GSS_C_NO_BUFFER || prefix->length == 0)
673 str.append((const char *)prefix->value, prefix->length);
675 if (suffix != GSS_C_NO_BUFFER) {
677 str.append((const char *)suffix->value, suffix->length);
684 * Compose attribute name from type, suffix; returns C++ string
687 gss_eap_attr_ctx::composeAttributeName(unsigned int type,
688 const gss_buffer_t suffix)
690 const gss_buffer_t prefix = attributeTypeToPrefix(type);
692 return composeAttributeName(prefix, suffix);
696 * Compose attribute name from prefix, suffix; returns GSS buffer
699 gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
700 const gss_buffer_t suffix,
701 gss_buffer_t attribute)
703 std::string str = composeAttributeName(prefix, suffix);
705 if (str.length() != 0) {
706 return duplicateBuffer(str, attribute);
708 attribute->length = 0;
709 attribute->value = NULL;
714 * Compose attribute name from type, suffix; returns GSS buffer
717 gss_eap_attr_ctx::composeAttributeName(unsigned int type,
718 const gss_buffer_t suffix,
719 gss_buffer_t attribute)
721 gss_buffer_t prefix = attributeTypeToPrefix(type);
723 return composeAttributeName(prefix, suffix, attribute);
730 gssEapInquireName(OM_uint32 *minor,
734 gss_buffer_set_t *attrs)
736 if (name->attrCtx == NULL) {
737 *minor = GSSEAP_NO_ATTR_CONTEXT;
738 return GSS_S_UNAVAILABLE;
741 if (GSS_ERROR(gssEapAttrProvidersInit(minor))) {
742 return GSS_S_UNAVAILABLE;
746 if (!name->attrCtx->getAttributeTypes(attrs)) {
747 *minor = GSSEAP_NO_ATTR_CONTEXT;
748 return GSS_S_UNAVAILABLE;
750 } catch (std::exception &e) {
751 return mapException(minor, e);
754 return GSS_S_COMPLETE;
758 gssEapGetNameAttribute(OM_uint32 *minor,
764 gss_buffer_t display_value,
775 if (display_value != NULL) {
776 display_value->length = 0;
777 display_value->value = NULL;
780 if (name->attrCtx == NULL) {
781 *minor = GSSEAP_NO_ATTR_CONTEXT;
782 return GSS_S_UNAVAILABLE;
785 if (GSS_ERROR(gssEapAttrProvidersInit(minor))) {
786 return GSS_S_UNAVAILABLE;
790 if (!name->attrCtx->getAttribute(attr, authenticated, complete,
791 value, display_value, more)) {
792 *minor = GSSEAP_NO_SUCH_ATTR;
793 gssEapSaveStatusInfo(*minor, "Unknown naming attribute %.*s",
794 (int)attr->length, (char *)attr->value);
795 return GSS_S_UNAVAILABLE;
797 } catch (std::exception &e) {
798 return mapException(minor, e);
801 return GSS_S_COMPLETE;
805 gssEapDeleteNameAttribute(OM_uint32 *minor,
809 if (name->attrCtx == NULL) {
810 *minor = GSSEAP_NO_ATTR_CONTEXT;
811 return GSS_S_UNAVAILABLE;
814 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
815 return GSS_S_UNAVAILABLE;
818 name->attrCtx->deleteAttribute(attr);
819 } catch (std::exception &ex) {
820 return mapException(minor, ex);
823 return GSS_S_COMPLETE;
827 gssEapSetNameAttribute(OM_uint32 *minor,
833 if (name->attrCtx == NULL) {
834 *minor = GSSEAP_NO_ATTR_CONTEXT;
835 return GSS_S_UNAVAILABLE;
838 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
839 return GSS_S_UNAVAILABLE;
842 name->attrCtx->setAttribute(complete, attr, value);
843 } catch (std::exception &ex) {
844 return mapException(minor, ex);
847 return GSS_S_COMPLETE;
851 gssEapExportAttrContext(OM_uint32 *minor,
855 if (name->attrCtx == NULL) {
857 buffer->value = NULL;
859 return GSS_S_COMPLETE;
862 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
863 return GSS_S_UNAVAILABLE;
866 name->attrCtx->exportToBuffer(buffer);
867 } catch (std::exception &e) {
868 return mapException(minor, e);
871 return GSS_S_COMPLETE;
875 gssEapImportAttrContext(OM_uint32 *minor,
879 gss_eap_attr_ctx *ctx = NULL;
881 assert(name->attrCtx == NULL);
883 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
884 return GSS_S_UNAVAILABLE;
886 if (buffer->length != 0) {
888 ctx = new gss_eap_attr_ctx();
890 if (!ctx->initFromBuffer(buffer)) {
892 *minor = GSSEAP_BAD_ATTR_TOKEN;
893 return GSS_S_DEFECTIVE_TOKEN;
896 } catch (std::exception &e) {
898 return mapException(minor, e);
902 return GSS_S_COMPLETE;
906 gssEapDuplicateAttrContext(OM_uint32 *minor,
910 gss_eap_attr_ctx *ctx = NULL;
912 assert(out->attrCtx == NULL);
914 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
915 return GSS_S_UNAVAILABLE;
918 if (in->attrCtx != NULL) {
919 ctx = new gss_eap_attr_ctx();
920 if (!ctx->initFromExistingContext(in->attrCtx)) {
922 *minor = GSSEAP_ATTR_CONTEXT_FAILURE;
923 return GSS_S_FAILURE;
927 } catch (std::exception &e) {
929 return mapException(minor, e);
932 return GSS_S_COMPLETE;
936 gssEapMapNameToAny(OM_uint32 *minor,
939 gss_buffer_t type_id,
942 if (name->attrCtx == NULL) {
943 *minor = GSSEAP_NO_ATTR_CONTEXT;
944 return GSS_S_UNAVAILABLE;
947 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
948 return GSS_S_UNAVAILABLE;
951 *output = name->attrCtx->mapToAny(authenticated, type_id);
952 } catch (std::exception &e) {
953 return mapException(minor, e);
956 return GSS_S_COMPLETE;
960 gssEapReleaseAnyNameMapping(OM_uint32 *minor,
962 gss_buffer_t type_id,
965 if (name->attrCtx == NULL) {
966 *minor = GSSEAP_NO_ATTR_CONTEXT;
967 return GSS_S_UNAVAILABLE;
970 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
971 return GSS_S_UNAVAILABLE;
975 name->attrCtx->releaseAnyNameMapping(type_id, *input);
977 } catch (std::exception &e) {
978 return mapException(minor, e);
981 return GSS_S_COMPLETE;
985 gssEapReleaseAttrContext(OM_uint32 *minor,
988 if (name->attrCtx != NULL)
989 delete name->attrCtx;
991 return GSS_S_COMPLETE;
995 * Public accessor for initialisng a context from a GSS context. Also
996 * sets expiry time on GSS context as a side-effect.
998 struct gss_eap_attr_ctx *
999 gssEapCreateAttrContext(gss_cred_id_t gssCred,
1000 gss_ctx_id_t gssCtx)
1002 gss_eap_attr_ctx *ctx;
1005 assert(gssCtx != GSS_C_NO_CONTEXT);
1007 if (GSS_ERROR(gssEapAttrProvidersInit(&tmpMinor)))
1010 ctx = new gss_eap_attr_ctx();
1011 if (!ctx->initFromGssContext(gssCred, gssCtx)) {
1016 gssCtx->expiryTime = ctx->getExpiryTime();