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<MetadataProvider,string,const DOMElement*>::Factory NullMetadataProviderFactory;
  44         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory BlacklistMetadataFilterFactory;
  45         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory WhitelistMetadataFilterFactory;
  46         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory SignatureMetadataFilterFactory;
  47     };
  48 };
  49
  50 void SAML_API opensaml::saml2md::registerMetadataProviders()
  51 {
  52     SAMLConfig& conf=SAMLConfig::getConfig();
  53     conf.MetadataProviderManager.registerFactory(XML_METADATA_PROVIDER, XMLMetadataProviderFactory);
  54     conf.MetadataProviderManager.registerFactory(DYNAMIC_METADATA_PROVIDER, DynamicMetadataProviderFactory);
  55     conf.MetadataProviderManager.registerFactory(CHAINING_METADATA_PROVIDER, ChainingMetadataProviderFactory);
  56     conf.MetadataProviderManager.registerFactory(NULL_METADATA_PROVIDER, NullMetadataProviderFactory);
  57 }
  58
  59 void SAML_API opensaml::saml2md::registerMetadataFilters()
  60 {
  61     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(BLACKLIST_METADATA_FILTER, BlacklistMetadataFilterFactory);
  62     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(WHITELIST_METADATA_FILTER, WhitelistMetadataFilterFactory);
  63     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(SIGNATURE_METADATA_FILTER, SignatureMetadataFilterFactory);
  64 }
  65
  66 static const XMLCh _MetadataFilter[] =  UNICODE_LITERAL_14(M,e,t,a,d,a,t,a,F,i,l,t,e,r);
  67 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);
  68 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);
  69 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);
  70 static const XMLCh Exclude[] =          UNICODE_LITERAL_7(E,x,c,l,u,d,e);
  71 static const XMLCh Include[] =          UNICODE_LITERAL_7(I,n,c,l,u,d,e);
  72 static const XMLCh type[] =             UNICODE_LITERAL_4(t,y,p,e);
  73
  74 MetadataProvider::MetadataProvider(const DOMElement* e)
  75 {
  76 #ifdef _DEBUG
  77     NDC ndc("MetadataProvider");
  78 #endif
  79     Category& log = Category::getInstance(SAML_LOGCAT".Metadata");
  80     SAMLConfig& conf=SAMLConfig::getConfig();
  81
  82     // Locate any default recognized filters and plugins.
  83     try {
  84         DOMElement* child = e ? XMLHelper::getFirstChildElement(e) : NULL;
  85         while (child) {
  86             if (XMLString::equals(child->getLocalName(),_MetadataFilter)) {
  87                 auto_ptr_char t(child->getAttributeNS(NULL,type));
  88                 if (t.get() && *t.get()) {
  89                     log.info("building MetadataFilter of type %s", t.get());
  90                     m_filters.push_back(conf.MetadataFilterManager.newPlugin(t.get(),child));
  91                 }
  92             }
  93             else if (XMLString::equals(child->getLocalName(),SigFilter)) {
  94                 log.info("building MetadataFilter of type %s", SIGNATURE_METADATA_FILTER);
  95                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(SIGNATURE_METADATA_FILTER,child));
  96             }
  97             else if (XMLString::equals(child->getLocalName(),Whitelist)) {
  98                 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
  99                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER,child));
 100             }
 101             else if (XMLString::equals(child->getLocalName(),Blacklist)) {
 102                 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
 103                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER,child));
 104             }
 105             else if (XMLString::equals(child->getLocalName(),Include)) {
 106                 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
 107                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER,e));
 108             }
 109             else if (XMLString::equals(child->getLocalName(),Exclude)) {
 110                 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
 111                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER,e));
 112             }
 113             child = XMLHelper::getNextSiblingElement(child);
 114         }
 115     }
 116     catch (XMLToolingException& ex) {
 117         log.error("caught exception while installing filters: %s", ex.what());
 118         for_each(m_filters.begin(),m_filters.end(),xmltooling::cleanup<MetadataFilter>());
 119         throw;
 120     }
 121 }
 122
 123 MetadataProvider::~MetadataProvider()
 124 {
 125     for_each(m_filters.begin(),m_filters.end(),xmltooling::cleanup<MetadataFilter>());
 126 }
 127
 128 void MetadataProvider::doFilters(XMLObject& xmlObject) const
 129 {
 130 #ifdef _DEBUG
 131     NDC ndc("doFilters");
 132 #endif
 133     Category& log=Category::getInstance(SAML_LOGCAT".Metadata");
 134     for (std::vector<MetadataFilter*>::const_iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
 135         log.info("applying metadata filter (%s)", (*i)->getId());
 136         (*i)->doFilter(xmlObject);
 137     }
 138 }
 139
 140 const EntitiesDescriptor* MetadataProvider::getEntitiesDescriptor(const XMLCh* name, bool strict) const
 141 {
 142     auto_ptr_char temp(name);
 143     return getEntitiesDescriptor(temp.get(),strict);
 144 }