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
34 * Attribute provider mechanism.
37 #include "gssapiP_eap.h"
44 /* lazy initialisation */
45 static GSSEAP_THREAD_ONCE gssEapAttrProvidersInitOnce = GSSEAP_ONCE_INITIALIZER;
46 static OM_uint32 gssEapAttrProvidersInitStatus = GSS_S_UNAVAILABLE;
49 gssEapAttrProvidersInitInternal(void)
51 OM_uint32 major, minor;
53 assert(gssEapAttrProvidersInitStatus == GSS_S_UNAVAILABLE);
55 major = gssEapRadiusAttrProviderInit(&minor);
56 if (major == GSS_S_COMPLETE)
57 major = gssEapSamlAttrProvidersInit(&minor);
58 if (major == GSS_S_COMPLETE)
59 major = gssEapLocalAttrProviderInit(&minor);
62 assert(major == GSS_S_COMPLETE);
65 gssEapAttrProvidersInitStatus = major;
69 gssEapAttrProvidersInit(OM_uint32 *minor)
71 GSSEAP_ONCE(&gssEapAttrProvidersInitOnce, gssEapAttrProvidersInitInternal);
73 if (GSS_ERROR(gssEapAttrProvidersInitStatus))
74 *minor = GSSEAP_NO_ATTR_PROVIDERS;
76 return gssEapAttrProvidersInitStatus;
80 gssEapAttrProvidersFinalize(OM_uint32 *minor)
82 OM_uint32 major = GSS_S_COMPLETE;
84 if (gssEapAttrProvidersInitStatus == GSS_S_COMPLETE) {
85 major = gssEapLocalAttrProviderFinalize(minor);
86 if (major == GSS_S_COMPLETE)
87 major = gssEapSamlAttrProvidersFinalize(minor);
88 if (major == GSS_S_COMPLETE)
89 major = gssEapRadiusAttrProviderFinalize(minor);
91 gssEapAttrProvidersInitStatus = GSS_S_UNAVAILABLE;
97 static gss_eap_attr_create_provider gssEapAttrFactories[ATTR_TYPE_MAX + 1];
98 static gss_buffer_desc gssEapAttrPrefixes[ATTR_TYPE_MAX + 1];
101 * Register a provider for a particular type and prefix
104 gss_eap_attr_ctx::registerProvider(unsigned int type,
106 gss_eap_attr_create_provider factory)
108 assert(type <= ATTR_TYPE_MAX);
110 assert(gssEapAttrFactories[type] == NULL);
112 gssEapAttrFactories[type] = factory;
113 if (prefix != NULL) {
114 gssEapAttrPrefixes[type].value = (void *)prefix;
115 gssEapAttrPrefixes[type].length = strlen(prefix);
117 gssEapAttrPrefixes[type].value = NULL;
118 gssEapAttrPrefixes[type].length = 0;
123 * Unregister a provider
126 gss_eap_attr_ctx::unregisterProvider(unsigned int type)
128 assert(type <= ATTR_TYPE_MAX);
130 gssEapAttrFactories[type] = NULL;
131 gssEapAttrPrefixes[type].value = NULL;
132 gssEapAttrPrefixes[type].length = 0;
136 * Create an attribute context, that manages instances of providers
138 gss_eap_attr_ctx::gss_eap_attr_ctx(void)
142 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
143 gss_eap_attr_provider *provider;
145 if (gssEapAttrFactories[i] != NULL) {
146 provider = (gssEapAttrFactories[i])();
151 m_providers[i] = provider;
156 * Convert an attribute prefix to a type
159 gss_eap_attr_ctx::attributePrefixToType(const gss_buffer_t prefix)
163 for (i = ATTR_TYPE_MIN; i < ATTR_TYPE_MAX; i++) {
164 if (bufferEqual(&gssEapAttrPrefixes[i], prefix))
168 return ATTR_TYPE_LOCAL;
172 * Convert a type to an attribute prefix
175 gss_eap_attr_ctx::attributeTypeToPrefix(unsigned int type)
177 if (type < ATTR_TYPE_MIN || type >= ATTR_TYPE_MAX)
178 return GSS_C_NO_BUFFER;
180 return &gssEapAttrPrefixes[type];
184 gss_eap_attr_ctx::providerEnabled(unsigned int type) const
186 if (type == ATTR_TYPE_LOCAL &&
187 (m_flags & ATTR_FLAG_DISABLE_LOCAL))
190 if (m_providers[type] == NULL)
197 gss_eap_attr_ctx::releaseProvider(unsigned int type)
199 delete m_providers[type];
200 m_providers[type] = NULL;
204 * Initialize a context from an existing context.
207 gss_eap_attr_ctx::initFromExistingContext(const gss_eap_attr_ctx *manager)
211 m_flags = manager->m_flags;
213 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
214 gss_eap_attr_provider *provider;
216 if (!providerEnabled(i)) {
221 provider = m_providers[i];
223 ret = provider->initFromExistingContext(this,
224 manager->m_providers[i]);
235 * Initialize a context from a GSS credential and context.
238 gss_eap_attr_ctx::initFromGssContext(const gss_cred_id_t cred,
239 const gss_ctx_id_t ctx)
243 if (cred != GSS_C_NO_CREDENTIAL &&
244 (cred->flags & GSS_EAP_DISABLE_LOCAL_ATTRS_FLAG)) {
245 m_flags |= ATTR_FLAG_DISABLE_LOCAL;
248 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
249 gss_eap_attr_provider *provider;
251 if (!providerEnabled(i)) {
256 provider = m_providers[i];
258 ret = provider->initFromGssContext(this, cred, ctx);
269 * Initialize a context from an exported context or name token
272 gss_eap_attr_ctx::initFromBuffer(const gss_buffer_t buffer)
275 gss_eap_attr_provider *primaryProvider = getPrimaryProvider();
276 gss_buffer_desc primaryBuf;
278 if (buffer->length < 4)
281 m_flags = load_uint32_be(buffer->value);
283 primaryBuf.length = buffer->length - 4;
284 primaryBuf.value = (char *)buffer->value + 4;
286 ret = primaryProvider->initFromBuffer(this, &primaryBuf);
290 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
291 gss_eap_attr_provider *provider;
293 if (!providerEnabled(i)) {
298 provider = m_providers[i];
299 if (provider == primaryProvider)
302 ret = provider->initFromGssContext(this,
314 gss_eap_attr_ctx::~gss_eap_attr_ctx(void)
316 for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++)
317 delete m_providers[i];
321 * Locate provider for a given type
323 gss_eap_attr_provider *
324 gss_eap_attr_ctx::getProvider(unsigned int type) const
326 assert(type >= ATTR_TYPE_MIN && type <= ATTR_TYPE_MAX);
327 return m_providers[type];
331 * Locate provider for a given prefix
333 gss_eap_attr_provider *
334 gss_eap_attr_ctx::getProvider(const gss_buffer_t prefix) const
338 type = attributePrefixToType(prefix);
340 return m_providers[type];
344 * Get primary provider. Only the primary provider is serialised when
345 * gss_export_sec_context() or gss_export_name_composite() is called.
347 gss_eap_attr_provider *
348 gss_eap_attr_ctx::getPrimaryProvider(void) const
350 return m_providers[ATTR_TYPE_MIN];
357 gss_eap_attr_ctx::setAttribute(int complete,
358 const gss_buffer_t attr,
359 const gss_buffer_t value)
361 gss_buffer_desc suffix = GSS_C_EMPTY_BUFFER;
363 gss_eap_attr_provider *provider;
366 decomposeAttributeName(attr, &type, &suffix);
368 provider = m_providers[type];
369 if (provider != NULL) {
370 ret = provider->setAttribute(complete,
371 (type == ATTR_TYPE_LOCAL) ? attr : &suffix,
379 * Delete an attrbiute
382 gss_eap_attr_ctx::deleteAttribute(const gss_buffer_t attr)
384 gss_buffer_desc suffix = GSS_C_EMPTY_BUFFER;
386 gss_eap_attr_provider *provider;
389 decomposeAttributeName(attr, &type, &suffix);
391 provider = m_providers[type];
392 if (provider != NULL) {
393 ret = provider->deleteAttribute(type == ATTR_TYPE_LOCAL ? attr : &suffix);
400 * Enumerate attribute types with callback
403 gss_eap_attr_ctx::getAttributeTypes(gss_eap_attr_enumeration_cb cb, void *data) const
408 for (i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
409 gss_eap_attr_provider *provider = m_providers[i];
411 if (provider == NULL)
414 ret = provider->getAttributeTypes(cb, data);
422 struct eap_gss_get_attr_types_args {
424 gss_buffer_set_t attrs;
428 addAttribute(const gss_eap_attr_provider *provider,
429 const gss_buffer_t attribute,
432 eap_gss_get_attr_types_args *args = (eap_gss_get_attr_types_args *)data;
433 gss_buffer_desc qualified;
434 OM_uint32 major, minor;
436 if (args->type != ATTR_TYPE_LOCAL) {
437 gss_eap_attr_ctx::composeAttributeName(args->type, attribute, &qualified);
438 major = gss_add_buffer_set_member(&minor, &qualified, &args->attrs);
439 gss_release_buffer(&minor, &qualified);
441 major = gss_add_buffer_set_member(&minor, attribute, &args->attrs);
444 return GSS_ERROR(major) == false;
448 * Enumerate attribute types, output is buffer set
451 gss_eap_attr_ctx::getAttributeTypes(gss_buffer_set_t *attrs)
453 eap_gss_get_attr_types_args args;
454 OM_uint32 major, minor;
458 major = gss_create_empty_buffer_set(&minor, attrs);
459 if (GSS_ERROR(major)) {
460 throw new std::bad_alloc;
466 for (i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
467 gss_eap_attr_provider *provider = m_providers[i];
471 if (provider == NULL)
474 ret = provider->getAttributeTypes(addAttribute, (void *)&args);
480 gss_release_buffer_set(&minor, attrs);
486 * Get attribute with given name
489 gss_eap_attr_ctx::getAttribute(const gss_buffer_t attr,
493 gss_buffer_t display_value,
496 gss_buffer_desc suffix = GSS_C_EMPTY_BUFFER;
498 gss_eap_attr_provider *provider;
501 decomposeAttributeName(attr, &type, &suffix);
503 provider = m_providers[type];
504 if (provider == NULL)
507 ret = provider->getAttribute(type == ATTR_TYPE_LOCAL ? attr : &suffix,
508 authenticated, complete,
509 value, display_value, more);
515 * Map attribute context to C++ object
518 gss_eap_attr_ctx::mapToAny(int authenticated,
519 gss_buffer_t type_id) const
522 gss_eap_attr_provider *provider;
523 gss_buffer_desc suffix;
525 decomposeAttributeName(type_id, &type, &suffix);
527 provider = m_providers[type];
528 if (provider == NULL)
529 return (gss_any_t)NULL;
531 return provider->mapToAny(authenticated, &suffix);
535 * Release mapped context
538 gss_eap_attr_ctx::releaseAnyNameMapping(gss_buffer_t type_id,
539 gss_any_t input) const
542 gss_eap_attr_provider *provider;
543 gss_buffer_desc suffix;
545 decomposeAttributeName(type_id, &type, &suffix);
547 provider = m_providers[type];
548 if (provider != NULL)
549 provider->releaseAnyNameMapping(&suffix, input);
553 * Export attribute context to buffer
556 gss_eap_attr_ctx::exportToBuffer(gss_buffer_t buffer) const
558 const gss_eap_attr_provider *primaryProvider = getPrimaryProvider();
563 primaryProvider->exportToBuffer(&tmp);
565 buffer->length = 4 + tmp.length;
566 buffer->value = GSSEAP_MALLOC(buffer->length);
567 if (buffer->value == NULL)
568 throw new std::bad_alloc;
570 p = (unsigned char *)buffer->value;
571 store_uint32_be(m_flags, p);
572 memcpy(p + 4, tmp.value, tmp.length);
574 gss_release_buffer(&tmpMinor, &tmp);
578 * Return soonest expiry time of providers
581 gss_eap_attr_ctx::getExpiryTime(void) const
584 time_t expiryTime = 0;
586 for (i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
587 gss_eap_attr_provider *provider = m_providers[i];
588 time_t providerExpiryTime;
590 if (provider == NULL)
593 providerExpiryTime = provider->getExpiryTime();
594 if (providerExpiryTime == 0)
597 if (expiryTime == 0 || providerExpiryTime < expiryTime)
598 expiryTime = providerExpiryTime;
605 * Map C++ exception to GSS status
608 mapException(OM_uint32 *minor, std::exception &e)
610 OM_uint32 major = GSS_S_FAILURE;
612 /* XXX TODO implement other mappings */
613 if (typeid(e) == typeid(std::bad_alloc))
619 /* rethrow for now for debugging */
627 * Decompose attribute name into prefix and suffix
630 gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
637 for (i = 0; i < attribute->length; i++) {
638 if (((char *)attribute->value)[i] == ' ') {
639 p = (char *)attribute->value + i + 1;
644 prefix->value = attribute->value;
647 if (p != NULL && *p != '\0') {
648 suffix->length = attribute->length - 1 - prefix->length;
652 suffix->value = NULL;
657 * Decompose attribute name into type and suffix
660 gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
664 gss_buffer_desc prefix = GSS_C_EMPTY_BUFFER;
666 decomposeAttributeName(attribute, &prefix, suffix);
667 *type = attributePrefixToType(&prefix);
671 * Compose attribute name from prefix, suffix; returns C++ string
674 gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
675 const gss_buffer_t suffix)
679 if (prefix == GSS_C_NO_BUFFER || prefix->length == 0)
682 str.append((const char *)prefix->value, prefix->length);
684 if (suffix != GSS_C_NO_BUFFER) {
686 str.append((const char *)suffix->value, suffix->length);
693 * Compose attribute name from type, suffix; returns C++ string
696 gss_eap_attr_ctx::composeAttributeName(unsigned int type,
697 const gss_buffer_t suffix)
699 const gss_buffer_t prefix = attributeTypeToPrefix(type);
701 return composeAttributeName(prefix, suffix);
705 * Compose attribute name from prefix, suffix; returns GSS buffer
708 gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
709 const gss_buffer_t suffix,
710 gss_buffer_t attribute)
712 std::string str = composeAttributeName(prefix, suffix);
714 if (str.length() != 0) {
715 return duplicateBuffer(str, attribute);
717 attribute->length = 0;
718 attribute->value = NULL;
723 * Compose attribute name from type, suffix; returns GSS buffer
726 gss_eap_attr_ctx::composeAttributeName(unsigned int type,
727 const gss_buffer_t suffix,
728 gss_buffer_t attribute)
730 gss_buffer_t prefix = attributeTypeToPrefix(type);
732 return composeAttributeName(prefix, suffix, attribute);
739 gssEapInquireName(OM_uint32 *minor,
743 gss_buffer_set_t *attrs)
745 if (name->attrCtx == NULL) {
746 *minor = GSSEAP_NO_ATTR_CONTEXT;
747 return GSS_S_UNAVAILABLE;
750 if (GSS_ERROR(gssEapAttrProvidersInit(minor))) {
751 return GSS_S_UNAVAILABLE;
755 if (!name->attrCtx->getAttributeTypes(attrs)) {
756 *minor = GSSEAP_NO_ATTR_CONTEXT;
757 return GSS_S_UNAVAILABLE;
759 } catch (std::exception &e) {
760 return mapException(minor, e);
763 return GSS_S_COMPLETE;
767 gssEapGetNameAttribute(OM_uint32 *minor,
773 gss_buffer_t display_value,
784 if (display_value != NULL) {
785 display_value->length = 0;
786 display_value->value = NULL;
789 if (name->attrCtx == NULL) {
790 *minor = GSSEAP_NO_ATTR_CONTEXT;
791 return GSS_S_UNAVAILABLE;
794 if (GSS_ERROR(gssEapAttrProvidersInit(minor))) {
795 return GSS_S_UNAVAILABLE;
799 if (!name->attrCtx->getAttribute(attr, authenticated, complete,
800 value, display_value, more)) {
801 *minor = GSSEAP_NO_SUCH_ATTR;
802 gssEapSaveStatusInfo(*minor, "Unknown naming attribute %.*s",
803 (int)attr->length, (char *)attr->value);
804 return GSS_S_UNAVAILABLE;
806 } catch (std::exception &e) {
807 return mapException(minor, e);
810 return GSS_S_COMPLETE;
814 gssEapDeleteNameAttribute(OM_uint32 *minor,
818 if (name->attrCtx == NULL) {
819 *minor = GSSEAP_NO_ATTR_CONTEXT;
820 return GSS_S_UNAVAILABLE;
823 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
824 return GSS_S_UNAVAILABLE;
827 if (!name->attrCtx->deleteAttribute(attr)) {
828 *minor = GSSEAP_NO_SUCH_ATTR;
829 gssEapSaveStatusInfo(*minor, "Unknown naming attribute %.*s",
830 (int)attr->length, (char *)attr->value);
831 return GSS_S_UNAVAILABLE;
833 } catch (std::exception &ex) {
834 return mapException(minor, ex);
837 return GSS_S_COMPLETE;
841 gssEapSetNameAttribute(OM_uint32 *minor,
847 if (name->attrCtx == NULL) {
848 *minor = GSSEAP_NO_ATTR_CONTEXT;
849 return GSS_S_UNAVAILABLE;
852 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
853 return GSS_S_UNAVAILABLE;
856 if (!name->attrCtx->setAttribute(complete, attr, value)) {
857 *minor = GSSEAP_NO_SUCH_ATTR;
858 gssEapSaveStatusInfo(*minor, "Unknown naming attribute %.*s",
859 (int)attr->length, (char *)attr->value);
860 return GSS_S_UNAVAILABLE;
862 } catch (std::exception &ex) {
863 return mapException(minor, ex);
866 return GSS_S_COMPLETE;
870 gssEapExportAttrContext(OM_uint32 *minor,
874 if (name->attrCtx == NULL) {
876 buffer->value = NULL;
878 return GSS_S_COMPLETE;
881 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
882 return GSS_S_UNAVAILABLE;
885 name->attrCtx->exportToBuffer(buffer);
886 } catch (std::exception &e) {
887 return mapException(minor, e);
890 return GSS_S_COMPLETE;
894 gssEapImportAttrContext(OM_uint32 *minor,
898 gss_eap_attr_ctx *ctx = NULL;
900 assert(name->attrCtx == NULL);
902 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
903 return GSS_S_UNAVAILABLE;
905 if (buffer->length != 0) {
907 ctx = new gss_eap_attr_ctx();
909 if (!ctx->initFromBuffer(buffer)) {
911 *minor = GSSEAP_BAD_ATTR_TOKEN;
912 return GSS_S_DEFECTIVE_TOKEN;
915 } catch (std::exception &e) {
917 return mapException(minor, e);
921 return GSS_S_COMPLETE;
925 gssEapDuplicateAttrContext(OM_uint32 *minor,
929 gss_eap_attr_ctx *ctx = NULL;
931 assert(out->attrCtx == NULL);
933 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
934 return GSS_S_UNAVAILABLE;
937 if (in->attrCtx != NULL) {
938 ctx = new gss_eap_attr_ctx();
939 if (!ctx->initFromExistingContext(in->attrCtx)) {
941 *minor = GSSEAP_ATTR_CONTEXT_FAILURE;
942 return GSS_S_FAILURE;
946 } catch (std::exception &e) {
948 return mapException(minor, e);
951 return GSS_S_COMPLETE;
955 gssEapMapNameToAny(OM_uint32 *minor,
958 gss_buffer_t type_id,
961 if (name->attrCtx == NULL) {
962 *minor = GSSEAP_NO_ATTR_CONTEXT;
963 return GSS_S_UNAVAILABLE;
966 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
967 return GSS_S_UNAVAILABLE;
970 *output = name->attrCtx->mapToAny(authenticated, type_id);
971 } catch (std::exception &e) {
972 return mapException(minor, e);
975 return GSS_S_COMPLETE;
979 gssEapReleaseAnyNameMapping(OM_uint32 *minor,
981 gss_buffer_t type_id,
984 if (name->attrCtx == NULL) {
985 *minor = GSSEAP_NO_ATTR_CONTEXT;
986 return GSS_S_UNAVAILABLE;
989 if (GSS_ERROR(gssEapAttrProvidersInit(minor)))
990 return GSS_S_UNAVAILABLE;
994 name->attrCtx->releaseAnyNameMapping(type_id, *input);
996 } catch (std::exception &e) {
997 return mapException(minor, e);
1000 return GSS_S_COMPLETE;
1004 gssEapReleaseAttrContext(OM_uint32 *minor,
1007 if (name->attrCtx != NULL)
1008 delete name->attrCtx;
1010 return GSS_S_COMPLETE;
1014 * Public accessor for initialisng a context from a GSS context. Also
1015 * sets expiry time on GSS context as a side-effect.
1017 struct gss_eap_attr_ctx *
1018 gssEapCreateAttrContext(gss_cred_id_t gssCred,
1019 gss_ctx_id_t gssCtx)
1021 gss_eap_attr_ctx *ctx;
1024 assert(gssCtx != GSS_C_NO_CONTEXT);
1026 if (GSS_ERROR(gssEapAttrProvidersInit(&tmpMinor)))
1029 ctx = new gss_eap_attr_ctx();
1030 if (!ctx->initFromGssContext(gssCred, gssCtx)) {
1035 gssCtx->expiryTime = ctx->getExpiryTime();