Metadata filters, filter auto-registration, and unit tests.

[shibboleth/cpp-opensaml.git] / saml / saml2 / metadata / impl / MetadataProvider.cpp

diff --git a/saml/saml2/metadata/impl/MetadataProvider.cpp b/saml/saml2/metadata/impl/MetadataProvider.cpp
index 191a061..ad9818b 100644 (file)
--- a/saml/saml2/metadata/impl/MetadataProvider.cpp
+++ b/saml/saml2/metadata/impl/MetadataProvider.cpp
@@ -23,11 +23,81 @@
 #include "internal.h"
 #include "saml2/metadata/MetadataProvider.h"
 
+#include <log4cpp/Category.hh>
+#include <xmltooling/util/NDC.h>
+
+using namespace opensaml::saml2md;
 using namespace xmltooling;
+using namespace log4cpp;
+using namespace std;
+
+static const XMLCh Blacklist[] =                    UNICODE_LITERAL_23(B,l,a,c,k,l,i,s,t,M,e,t,a,d,a,t,a,F,i,l,t,e,r);
+static const XMLCh Exclude[] =                      UNICODE_LITERAL_7(E,x,c,l,u,d,e);
+static const XMLCh Include[] =                      UNICODE_LITERAL_7(I,n,c,l,u,d,e);
+static const XMLCh GenericMetadataFilter[] =        UNICODE_LITERAL_14(M,e,t,a,d,a,t,a,F,i,l,t,e,r);
+static const XMLCh type[] =                         UNICODE_LITERAL_4(t,y,p,e);
+static const XMLCh Whitelist[] =                    UNICODE_LITERAL_23(W,h,i,t,e,l,i,s,t,M,e,t,a,d,a,t,a,F,i,l,t,e,r);
+
+MetadataProvider::MetadataProvider(const DOMElement* e)
+{
+#ifdef _DEBUG
+    NDC ndc("MetadataProvider");
+#endif
+    Category& log=Category::getInstance(SAML_LOGCAT".Metadata");
+    SAMLConfig& conf=SAMLConfig::getConfig();
+    
+    // Locate any default recognized filters.
+    try {
+        DOMElement* child = e ? XMLHelper::getFirstChildElement(e) : NULL;
+        while (child) {
+            if (XMLString::equals(child->getLocalName(),GenericMetadataFilter)) {
+                auto_ptr_char t(child->getAttributeNS(NULL,type));
+                if (t.get())
+                    m_filters.push_back(conf.MetadataFilterManager.newPlugin(t.get(),child));
+            }
+            else if (XMLString::equals(child->getLocalName(),Whitelist)) {
+                m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER,child));
+            }
+            else if (XMLString::equals(child->getLocalName(),Blacklist)) {
+                m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER,child));
+            }
+            else if (XMLString::equals(child->getLocalName(),Include)) {
+                m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER,e));
+            }
+            else if (XMLString::equals(child->getLocalName(),Exclude)) {
+                m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER,e));
+            }
+            child = XMLHelper::getNextSiblingElement(child);
+        }
+    }
+    catch (XMLToolingException&) {
+        for_each(m_filters.begin(),m_filters.end(),xmltooling::cleanup<MetadataFilter>());
+        throw;
+    }
+}
+
+MetadataProvider::~MetadataProvider()
+{
+    for_each(m_filters.begin(),m_filters.end(),xmltooling::cleanup<MetadataFilter>());
+}
+
+void MetadataProvider::doFilters(XMLObject& xmlObject) const
+{
+#ifdef _DEBUG
+    NDC ndc("doFilters");
+#endif
+    Category& log=Category::getInstance(SAML_LOGCAT".Metadata");
+    for (std::vector<MetadataFilter*>::const_iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
+        log.info("applying metadata filter (%s)", (*i)->getId());
+        (*i)->doFilter(xmlObject);
+    }
+}
 
 namespace opensaml {
     namespace saml2md {
         SAML_DLLLOCAL PluginManager<MetadataProvider,const DOMElement*>::Factory FilesystemMetadataProviderFactory; 
+        SAML_DLLLOCAL PluginManager<MetadataFilter,const DOMElement*>::Factory BlacklistMetadataFilterFactory; 
+        SAML_DLLLOCAL PluginManager<MetadataFilter,const DOMElement*>::Factory WhitelistMetadataFilterFactory; 
     };
 };
 
@@ -35,3 +105,9 @@ void SAML_API opensaml::saml2md::registerMetadataProviders()
 {
     SAMLConfig::getConfig().MetadataProviderManager.registerFactory(FILESYSTEM_METADATA_PROVIDER, FilesystemMetadataProviderFactory);
 }
+
+void SAML_API opensaml::saml2md::registerMetadataFilters()
+{
+    SAMLConfig::getConfig().MetadataFilterManager.registerFactory(BLACKLIST_METADATA_FILTER, BlacklistMetadataFilterFactory);
+    SAMLConfig::getConfig().MetadataFilterManager.registerFactory(WHITELIST_METADATA_FILTER, WhitelistMetadataFilterFactory);
+}