Merge branch 'master' of ssh://lhoward@moonshot.suchdamage.org:822/srv/git/moonshot
[mech_eap.orig] / util_attr.cpp
index c564c62..56a0088 100644 (file)
 #include <exception>
 #include <new>
 
-static gss_eap_attr_create_provider gssEapAttrFactories[ATTR_TYPE_MAX];
-static gss_buffer_desc gssEapAttrPrefixes[ATTR_TYPE_MAX];
+static gss_eap_attr_create_provider gssEapAttrFactories[ATTR_TYPE_MAX + 1];
+static gss_buffer_desc gssEapAttrPrefixes[ATTR_TYPE_MAX + 1];
 
+/*
+ * Register a provider for a particular type and prefix
+ */
 void
 gss_eap_attr_ctx::registerProvider(unsigned int type,
                                    const char *prefix,
                                    gss_eap_attr_create_provider factory)
 {
-    assert(type < ATTR_TYPE_MAX);
+    assert(type <= ATTR_TYPE_MAX);
 
     assert(gssEapAttrFactories[type] == NULL);
 
@@ -59,36 +62,48 @@ gss_eap_attr_ctx::registerProvider(unsigned int type,
     }
 }
 
+/*
+ * Unregister a provider
+ */
 void
 gss_eap_attr_ctx::unregisterProvider(unsigned int type)
 {
-    assert(type < ATTR_TYPE_MAX);
+    assert(type <= ATTR_TYPE_MAX);
 
     gssEapAttrFactories[type] = NULL;
     gssEapAttrPrefixes[type].value = NULL;
     gssEapAttrPrefixes[type].length = 0;
 }
 
+/*
+ * Create an attribute context, that manages instances of providers
+ */
 gss_eap_attr_ctx::gss_eap_attr_ctx(void)
 {
-    for (unsigned int i = 0; i < ATTR_TYPE_MAX; i++) {
+    m_flags = 0;
+
+    for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
         gss_eap_attr_provider *provider;
 
-        provider = (gssEapAttrFactories[i])();
+        if (gssEapAttrFactories[i] != NULL) {
+            provider = (gssEapAttrFactories[i])();
+        } else {
+            provider = NULL;
+        }
 
         m_providers[i] = provider;
-
-        /* providers should fail in constructor */
-        assert(m_providers[i] != NULL);
     }
 }
 
+/*
+ * Convert an attribute prefix to a type
+ */
 unsigned int
 gss_eap_attr_ctx::attributePrefixToType(const gss_buffer_t prefix)
 {
     unsigned int i;
 
-    for (i = ATTR_TYPE_MIN; i < ATTR_TYPE_LOCAL; i++) {
+    for (i = ATTR_TYPE_MIN; i < ATTR_TYPE_MAX; i++) {
         if (bufferEqual(&gssEapAttrPrefixes[i], prefix))
             return i;
     }
@@ -96,15 +111,38 @@ gss_eap_attr_ctx::attributePrefixToType(const gss_buffer_t prefix)
     return ATTR_TYPE_LOCAL;
 }
 
+/*
+ * Convert a type to an attribute prefix
+ */
 const gss_buffer_t
 gss_eap_attr_ctx::attributeTypeToPrefix(unsigned int type)
 {
-    if (type < ATTR_TYPE_MIN || type >= ATTR_TYPE_LOCAL)
+    if (type < ATTR_TYPE_MIN || type >= ATTR_TYPE_MAX)
         return GSS_C_NO_BUFFER;
 
     return &gssEapAttrPrefixes[type];
 }
 
+bool
+gss_eap_attr_ctx::providerEnabled(unsigned int type) const
+{
+    if (type == ATTR_TYPE_LOCAL &&
+        (m_flags & ATTR_FLAG_DISABLE_LOCAL))
+        return false;
+
+    if (m_providers[type] == NULL)
+        return false;
+
+    return true;
+}
+
+void
+gss_eap_attr_ctx::releaseProvider(unsigned int type)
+{
+    delete m_providers[type];
+    m_providers[type] = NULL;
+}
+
 /*
  * Initialize a context from an existing context.
  */
@@ -113,12 +151,24 @@ gss_eap_attr_ctx::initFromExistingContext(const gss_eap_attr_ctx *manager)
 {
     bool ret = true;
 
-    for (unsigned int i = 0; i < ATTR_TYPE_MAX; i++) {
-        gss_eap_attr_provider *provider = m_providers[i];
+    m_flags = manager->m_flags;
 
-        ret = provider->initFromExistingContext(this, manager->m_providers[i]);
-        if (ret == false)
+    for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
+        gss_eap_attr_provider *provider;
+
+        if (!providerEnabled(i)) {
+            releaseProvider(i);
+            continue;
+        }
+
+        provider = m_providers[i];
+
+        ret = provider->initFromExistingContext(this,
+                                                manager->m_providers[i]);
+        if (ret == false) {
+            releaseProvider(i);
             break;
+        }
     }
 
     return ret;
@@ -133,12 +183,26 @@ gss_eap_attr_ctx::initFromGssContext(const gss_cred_id_t cred,
 {
     bool ret = true;
 
-    for (unsigned int i = 0; i < ATTR_TYPE_MAX; i++) {
-        gss_eap_attr_provider *provider = m_providers[i];
+    if (cred != GSS_C_NO_CREDENTIAL &&
+        (cred->flags & GSS_EAP_DISABLE_LOCAL_ATTRS_FLAG)) {
+        m_flags |= ATTR_FLAG_DISABLE_LOCAL;
+    }
+
+    for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
+        gss_eap_attr_provider *provider;
+
+        if (!providerEnabled(i)) {
+            releaseProvider(i);
+            continue;
+        }
+
+        provider = m_providers[i];
 
         ret = provider->initFromGssContext(this, cred, ctx);
-        if (ret == false)
+        if (ret == false) {
+            releaseProvider(i);
             break;
+        }
     }
 
     return ret;
@@ -152,22 +216,39 @@ gss_eap_attr_ctx::initFromBuffer(const gss_buffer_t buffer)
 {
     bool ret;
     gss_eap_attr_provider *primaryProvider = getPrimaryProvider();
+    gss_buffer_desc primaryBuf;
+
+    if (buffer->length < 4)
+        return false;
+
+    m_flags = load_uint32_be(buffer->value);
+
+    primaryBuf.length = buffer->length - 4;
+    primaryBuf.value = (char *)buffer->value + 4;
 
-    ret = primaryProvider->initFromBuffer(this, buffer);
+    ret = primaryProvider->initFromBuffer(this, &primaryBuf);
     if (ret == false)
         return ret;
 
-    for (unsigned int i = ATTR_TYPE_MIN; i < ATTR_TYPE_MAX; i++) {
-        gss_eap_attr_provider *provider = m_providers[i];
+    for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
+        gss_eap_attr_provider *provider;
 
+        if (!providerEnabled(i)) {
+            releaseProvider(i);
+            continue;
+        }
+
+        provider = m_providers[i];
         if (provider == primaryProvider)
             continue;
 
         ret = provider->initFromGssContext(this,
                                            GSS_C_NO_CREDENTIAL,
                                            GSS_C_NO_CONTEXT);
-        if (ret == false)
+        if (ret == false) {
+            releaseProvider(i);
             break;
+        }
     }
 
     return ret;
@@ -175,16 +256,23 @@ gss_eap_attr_ctx::initFromBuffer(const gss_buffer_t buffer)
 
 gss_eap_attr_ctx::~gss_eap_attr_ctx(void)
 {
-    for (unsigned int i = ATTR_TYPE_MIN; i < ATTR_TYPE_MAX; i++)
+    for (unsigned int i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++)
         delete m_providers[i];
 }
 
+/*
+ * Locate provider for a given type
+ */
 gss_eap_attr_provider *
 gss_eap_attr_ctx::getProvider(unsigned int type) const
 {
+    assert(type >= ATTR_TYPE_MIN && type <= ATTR_TYPE_MAX);
     return m_providers[type];
 }
 
+/*
+ * Locate provider for a given prefix
+ */
 gss_eap_attr_provider *
 gss_eap_attr_ctx::getProvider(const gss_buffer_t prefix) const
 {
@@ -195,12 +283,19 @@ gss_eap_attr_ctx::getProvider(const gss_buffer_t prefix) const
     return m_providers[type];
 }
 
+/*
+ * Get primary provider. Only the primary provider is serialised when
+ * gss_export_sec_context() or gss_export_name_composite() is called.
+ */
 gss_eap_attr_provider *
 gss_eap_attr_ctx::getPrimaryProvider(void) const
 {
-    return m_providers[ATTR_TYPE_RADIUS];
+    return m_providers[ATTR_TYPE_MIN];
 }
 
+/*
+ * Set an attribute
+ */
 void
 gss_eap_attr_ctx::setAttribute(int complete,
                                const gss_buffer_t attr,
@@ -217,10 +312,14 @@ gss_eap_attr_ctx::setAttribute(int complete,
         provider->setAttribute(complete,
                                (type == ATTR_TYPE_LOCAL) ? attr : &suffix,
                                value);
-                               
+    } else {
+        /* XXX TODO throw exception */
     }
 }
 
+/*
+ * Delete an attrbiute
+ */
 void
 gss_eap_attr_ctx::deleteAttribute(const gss_buffer_t attr)
 {
@@ -231,19 +330,26 @@ gss_eap_attr_ctx::deleteAttribute(const gss_buffer_t attr)
     decomposeAttributeName(attr, &type, &suffix);
 
     provider = m_providers[type];
-    if (provider != NULL) {
+    if (provider != NULL)
         provider->deleteAttribute(type == ATTR_TYPE_LOCAL ? attr : &suffix);
-    }
 }
 
+/*
+ * Enumerate attribute types with callback
+ */
 bool
 gss_eap_attr_ctx::getAttributeTypes(gss_eap_attr_enumeration_cb cb, void *data) const
 {
     bool ret = false;
     size_t i;
 
-    for (i = 0; i < ATTR_TYPE_MAX; i++) {
-        ret = m_providers[i]->getAttributeTypes(cb, data);
+    for (i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
+        gss_eap_attr_provider *provider = m_providers[i];
+
+        if (provider == NULL)
+            continue;
+
+        ret = provider->getAttributeTypes(cb, data);
         if (ret == false)
             break;
     }
@@ -276,6 +382,9 @@ addAttribute(const gss_eap_attr_provider *provider,
     return GSS_ERROR(major) == false;
 }
 
+/*
+ * Enumerate attribute types, output is buffer set
+ */
 bool
 gss_eap_attr_ctx::getAttributeTypes(gss_buffer_set_t *attrs)
 {
@@ -292,10 +401,15 @@ gss_eap_attr_ctx::getAttributeTypes(gss_buffer_set_t *attrs)
 
     args.attrs = *attrs;
 
-    for (i = 0; i < ATTR_TYPE_MAX; i++) {
+    for (i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
+        gss_eap_attr_provider *provider = m_providers[i];
+
         args.type = i;
 
-        ret = m_providers[i]->getAttributeTypes(addAttribute, (void *)&args);
+        if (provider == NULL)
+            continue;
+
+        ret = provider->getAttributeTypes(addAttribute, (void *)&args);
         if (ret == false)
             break;
     }
@@ -306,6 +420,9 @@ gss_eap_attr_ctx::getAttributeTypes(gss_buffer_set_t *attrs)
     return ret;
 }
 
+/*
+ * Get attribute with given name
+ */
 bool
 gss_eap_attr_ctx::getAttribute(const gss_buffer_t attr,
                                int *authenticated,
@@ -322,6 +439,8 @@ gss_eap_attr_ctx::getAttribute(const gss_buffer_t attr,
     decomposeAttributeName(attr, &type, &suffix);
 
     provider = m_providers[type];
+    if (provider == NULL)
+        return false;
 
     ret = provider->getAttribute(type == ATTR_TYPE_LOCAL ? attr : &suffix,
                                  authenticated, complete,
@@ -330,49 +449,86 @@ gss_eap_attr_ctx::getAttribute(const gss_buffer_t attr,
     return ret;
 }
 
+/*
+ * Map attribute context to C++ object
+ */
 gss_any_t
 gss_eap_attr_ctx::mapToAny(int authenticated,
                            gss_buffer_t type_id) const
 {
     unsigned int type;
     gss_eap_attr_provider *provider;
+    gss_buffer_desc suffix;
 
-    type = attributePrefixToType(type_id);
+    decomposeAttributeName(type_id, &type, &suffix);
 
     provider = m_providers[type];
+    if (provider == NULL)
+        return (gss_any_t)NULL;
 
-    return provider->mapToAny(authenticated, type_id);
+    return provider->mapToAny(authenticated, &suffix);
 }
 
+/*
+ * Release mapped context
+ */
 void
 gss_eap_attr_ctx::releaseAnyNameMapping(gss_buffer_t type_id,
                                         gss_any_t input) const
 {
     unsigned int type;
     gss_eap_attr_provider *provider;
+    gss_buffer_desc suffix;
 
-    type = attributePrefixToType(type_id);
+    decomposeAttributeName(type_id, &type, &suffix);
 
     provider = m_providers[type];
-
-    provider->releaseAnyNameMapping(type_id, input);
+    if (provider != NULL)
+        provider->releaseAnyNameMapping(&suffix, input);
 }
 
+/*
+ * Export attribute context to buffer
+ */
 void
 gss_eap_attr_ctx::exportToBuffer(gss_buffer_t buffer) const
 {
-    getPrimaryProvider()->exportToBuffer(buffer);
+    const gss_eap_attr_provider *primaryProvider = getPrimaryProvider();
+    gss_buffer_desc tmp;
+    unsigned char *p;
+    OM_uint32 tmpMinor;
+
+    primaryProvider->exportToBuffer(&tmp);
+
+    buffer->length = 4 + tmp.length;
+    buffer->value = GSSEAP_MALLOC(buffer->length);
+    if (buffer->value == NULL)
+        throw new std::bad_alloc;
+
+    p = (unsigned char *)buffer->value;
+    store_uint32_be(m_flags, p);
+    memcpy(p + 4, tmp.value, tmp.length);
+
+    gss_release_buffer(&tmpMinor, &tmp);
 }
 
+/*
+ * Return soonest expiry time of providers
+ */
 time_t
 gss_eap_attr_ctx::getExpiryTime(void) const
 {
     unsigned int i;
     time_t expiryTime = 0;
 
-    for (i = ATTR_TYPE_MIN; i < ATTR_TYPE_MAX; i++) {
-        time_t providerExpiryTime = m_providers[i]->getExpiryTime();
+    for (i = ATTR_TYPE_MIN; i <= ATTR_TYPE_MAX; i++) {
+        gss_eap_attr_provider *provider = m_providers[i];
+        time_t providerExpiryTime;
+
+        if (provider == NULL)
+            continue;
 
+        providerExpiryTime = provider->getExpiryTime();
         if (providerExpiryTime == 0)
             continue;
 
@@ -384,9 +540,8 @@ gss_eap_attr_ctx::getExpiryTime(void) const
 }
 
 /*
- * C wrappers
+ * Map C++ exception to GSS status
  */
-
 static OM_uint32
 mapException(OM_uint32 *minor, std::exception &e)
 {
@@ -406,6 +561,9 @@ mapException(OM_uint32 *minor, std::exception &e)
     return major;
 }
 
+/*
+ * Decompose attribute name into prefix and suffix
+ */
 void
 gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
                                          gss_buffer_t prefix,
@@ -433,6 +591,23 @@ gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
     }
 }
 
+/*
+ * Decompose attribute name into type and suffix
+ */
+void
+gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
+                                         unsigned int *type,
+                                         gss_buffer_t suffix)
+{
+    gss_buffer_desc prefix = GSS_C_EMPTY_BUFFER;
+
+    decomposeAttributeName(attribute, &prefix, suffix);
+    *type = attributePrefixToType(&prefix);
+}
+
+/*
+ * Compose attribute name from prefix, suffix; returns C++ string
+ */
 std::string
 gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
                                        const gss_buffer_t suffix)
@@ -452,6 +627,9 @@ gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
     return str;
 }
 
+/*
+ * Compose attribute name from type, suffix; returns C++ string
+ */
 std::string
 gss_eap_attr_ctx::composeAttributeName(unsigned int type,
                                        const gss_buffer_t suffix)
@@ -461,6 +639,9 @@ gss_eap_attr_ctx::composeAttributeName(unsigned int type,
     return composeAttributeName(prefix, suffix);
 }
 
+/*
+ * Compose attribute name from prefix, suffix; returns GSS buffer
+ */
 void
 gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
                                        const gss_buffer_t suffix,
@@ -476,17 +657,9 @@ gss_eap_attr_ctx::composeAttributeName(const gss_buffer_t prefix,
     }
 }
 
-void
-gss_eap_attr_ctx::decomposeAttributeName(const gss_buffer_t attribute,
-                                         unsigned int *type,
-                                         gss_buffer_t suffix)
-{
-    gss_buffer_desc prefix = GSS_C_EMPTY_BUFFER;
-
-    decomposeAttributeName(attribute, &prefix, suffix);
-    *type = attributePrefixToType(&prefix);
-}
-
+/*
+ * Compose attribute name from type, suffix; returns GSS buffer
+ */
 void
 gss_eap_attr_ctx::composeAttributeName(unsigned int type,
                                        const gss_buffer_t suffix,
@@ -497,6 +670,9 @@ gss_eap_attr_ctx::composeAttributeName(unsigned int type,
     return composeAttributeName(prefix, suffix, attribute);
 }
 
+/*
+ * C wrappers
+ */
 OM_uint32
 gssEapInquireName(OM_uint32 *minor,
                   gss_name_t name,
@@ -713,37 +889,10 @@ gssEapReleaseAttrContext(OM_uint32 *minor,
     return GSS_S_COMPLETE;
 }
 
-OM_uint32
-gssEapAttrProvidersInit(OM_uint32 *minor)
-{
-    try {
-        if (gss_eap_radius_attr_provider::init()    &&
-            gss_eap_saml_assertion_provider::init() &&
-            gss_eap_saml_attr_provider::init()      &&
-            gss_eap_shib_attr_provider::init())
-            return GSS_S_COMPLETE;
-    } catch (std::exception &e) {
-        return mapException(minor, e);
-    }
-
-    return GSS_S_FAILURE;
-}
-
-OM_uint32
-gssEapAttrProvidersFinalize(OM_uint32 *minor)
-{
-    try {
-        gss_eap_shib_attr_provider::finalize();
-        gss_eap_saml_attr_provider::finalize();
-        gss_eap_saml_assertion_provider::finalize();
-        gss_eap_radius_attr_provider::finalize();
-    } catch (std::exception &e) {
-        return mapException(minor, e);
-    }
-
-    return GSS_S_COMPLETE;
-}
-
+/*
+ * Public accessor for initialisng a context from a GSS context. Also
+ * sets expiry time on GSS context as a side-effect.
+ */
 struct gss_eap_attr_ctx *
 gssEapCreateAttrContext(gss_cred_id_t gssCred,
                         gss_ctx_id_t gssCtx)