saml/saml2/metadata/impl/MetadataProvider.cpp

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * MetadataProvider.cpp
  19  *
  20  * Registration of factories for built-in providers
  21  */
  22
  23 #include "internal.h"
  24 #include "saml2/metadata/MetadataFilter.h"
  25 #include "saml2/metadata/MetadataProvider.h"
  26
  27 #include <xercesc/util/XMLUniDefs.hpp>
  28 #include <xmltooling/logging.h>
  29 #include <xmltooling/util/NDC.h>
  30 #include <xmltooling/util/XMLHelper.h>
  31
  32 using namespace opensaml::saml2md;
  33 using namespace opensaml;
  34 using namespace xmltooling::logging;
  35 using namespace xmltooling;
  36 using namespace std;
  37
  38 namespace opensaml {
  39     namespace saml2md {
  40         SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory XMLMetadataProviderFactory;
  41         SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory DynamicMetadataProviderFactory;
  42         SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory ChainingMetadataProviderFactory;
  43         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory BlacklistMetadataFilterFactory;
  44         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory WhitelistMetadataFilterFactory;
  45         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory SignatureMetadataFilterFactory;
  46     };
  47 };
  48
  49 void SAML_API opensaml::saml2md::registerMetadataProviders()
  50 {
  51     SAMLConfig& conf=SAMLConfig::getConfig();
  52     conf.MetadataProviderManager.registerFactory(XML_METADATA_PROVIDER, XMLMetadataProviderFactory);
  53     conf.MetadataProviderManager.registerFactory(DYNAMIC_METADATA_PROVIDER, DynamicMetadataProviderFactory);
  54     conf.MetadataProviderManager.registerFactory(CHAINING_METADATA_PROVIDER, ChainingMetadataProviderFactory);
  55 }
  56
  57 void SAML_API opensaml::saml2md::registerMetadataFilters()
  58 {
  59     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(BLACKLIST_METADATA_FILTER, BlacklistMetadataFilterFactory);
  60     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(WHITELIST_METADATA_FILTER, WhitelistMetadataFilterFactory);
  61     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(SIGNATURE_METADATA_FILTER, SignatureMetadataFilterFactory);
  62 }
  63
  64 static const XMLCh _MetadataFilter[] =  UNICODE_LITERAL_14(M,e,t,a,d,a,t,a,F,i,l,t,e,r);
  65 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);
  66 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);
  67 static const XMLCh SigFilter[] =        UNICODE_LITERAL_23(S,i,g,n,a,t,u,r,e,M,e,t,a,d,a,t,a,F,i,l,t,e,r);
  68 static const XMLCh Exclude[] =          UNICODE_LITERAL_7(E,x,c,l,u,d,e);
  69 static const XMLCh Include[] =          UNICODE_LITERAL_7(I,n,c,l,u,d,e);
  70 static const XMLCh type[] =             UNICODE_LITERAL_4(t,y,p,e);
  71
  72 MetadataProvider::MetadataProvider(const DOMElement* e)
  73 {
  74 #ifdef _DEBUG
  75     NDC ndc("MetadataProvider");
  76 #endif
  77     Category& log = Category::getInstance(SAML_LOGCAT".Metadata");
  78     SAMLConfig& conf=SAMLConfig::getConfig();
  79
  80     // Locate any default recognized filters and plugins.
  81     try {
  82         DOMElement* child = e ? XMLHelper::getFirstChildElement(e) : NULL;
  83         while (child) {
  84             if (XMLString::equals(child->getLocalName(),_MetadataFilter)) {
  85                 auto_ptr_char t(child->getAttributeNS(NULL,type));
  86                 if (t.get() && *t.get()) {
  87                     log.info("building MetadataFilter of type %s", t.get());
  88                     m_filters.push_back(conf.MetadataFilterManager.newPlugin(t.get(),child));
  89                 }
  90             }
  91             else if (XMLString::equals(child->getLocalName(),SigFilter)) {
  92                 log.info("building MetadataFilter of type %s", SIGNATURE_METADATA_FILTER);
  93                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(SIGNATURE_METADATA_FILTER,child));
  94             }
  95             else if (XMLString::equals(child->getLocalName(),Whitelist)) {
  96                 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
  97                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER,child));
  98             }
  99             else if (XMLString::equals(child->getLocalName(),Blacklist)) {
 100                 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
 101                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER,child));
 102             }
 103             else if (XMLString::equals(child->getLocalName(),Include)) {
 104                 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
 105                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER,e));
 106             }
 107             else if (XMLString::equals(child->getLocalName(),Exclude)) {
 108                 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
 109                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER,e));
 110             }
 111             child = XMLHelper::getNextSiblingElement(child);
 112         }
 113     }
 114     catch (XMLToolingException& ex) {
 115         log.error("caught exception while installing filters: %s", ex.what());
 116         for_each(m_filters.begin(),m_filters.end(),xmltooling::cleanup<MetadataFilter>());
 117         throw;
 118     }
 119 }
 120
 121 MetadataProvider::~MetadataProvider()
 122 {
 123     for_each(m_filters.begin(),m_filters.end(),xmltooling::cleanup<MetadataFilter>());
 124 }
 125
 126 void MetadataProvider::doFilters(XMLObject& xmlObject) const
 127 {
 128 #ifdef _DEBUG
 129     NDC ndc("doFilters");
 130 #endif
 131     Category& log=Category::getInstance(SAML_LOGCAT".Metadata");
 132     for (std::vector<MetadataFilter*>::const_iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
 133         log.info("applying metadata filter (%s)", (*i)->getId());
 134         (*i)->doFilter(xmlObject);
 135     }
 136 }
 137
 138 const EntitiesDescriptor* MetadataProvider::getEntitiesDescriptor(const XMLCh* name, bool strict) const
 139 {
 140     auto_ptr_char temp(name);
 141     return getEntitiesDescriptor(temp.get(),strict);
 142 }