saml/saml2/metadata/impl/MetadataProvider.cpp

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * MetadataProvider.cpp
  23  *
  24  * Supplies an individual source of metadata.
  25  */
  26
  27 #include "internal.h"
  28 #include "saml2/metadata/MetadataFilter.h"
  29 #include "saml2/metadata/MetadataProvider.h"
  30
  31 #include <algorithm>
  32 #include <xercesc/util/XMLUniDefs.hpp>
  33 #include <xmltooling/logging.h>
  34 #include <xmltooling/unicode.h>
  35 #include <xmltooling/util/NDC.h>
  36 #include <xmltooling/util/XMLHelper.h>
  37
  38 using namespace opensaml::saml2md;
  39 using namespace opensaml;
  40 using namespace xmltooling::logging;
  41 using namespace xmltooling;
  42 using namespace std;
  43
  44 namespace opensaml {
  45     namespace saml2md {
  46         SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory XMLMetadataProviderFactory;
  47         SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory DynamicMetadataProviderFactory;
  48         SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory ChainingMetadataProviderFactory;
  49         SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory FolderMetadataProviderFactory;
  50         SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory NullMetadataProviderFactory;
  51         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory BlacklistMetadataFilterFactory;
  52         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory WhitelistMetadataFilterFactory;
  53         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory SignatureMetadataFilterFactory;
  54         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory RequireValidUntilMetadataFilterFactory;
  55         SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory EntityRoleMetadataFilterFactory;
  56     };
  57 };
  58
  59 void SAML_API opensaml::saml2md::registerMetadataProviders()
  60 {
  61     SAMLConfig& conf=SAMLConfig::getConfig();
  62     conf.MetadataProviderManager.registerFactory(XML_METADATA_PROVIDER, XMLMetadataProviderFactory);
  63     conf.MetadataProviderManager.registerFactory(DYNAMIC_METADATA_PROVIDER, DynamicMetadataProviderFactory);
  64     conf.MetadataProviderManager.registerFactory(CHAINING_METADATA_PROVIDER, ChainingMetadataProviderFactory);
  65     conf.MetadataProviderManager.registerFactory(FOLDER_METADATA_PROVIDER, FolderMetadataProviderFactory);
  66     conf.MetadataProviderManager.registerFactory(NULL_METADATA_PROVIDER, NullMetadataProviderFactory);
  67 }
  68
  69 void SAML_API opensaml::saml2md::registerMetadataFilters()
  70 {
  71     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(BLACKLIST_METADATA_FILTER, BlacklistMetadataFilterFactory);
  72     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(WHITELIST_METADATA_FILTER, WhitelistMetadataFilterFactory);
  73     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(SIGNATURE_METADATA_FILTER, SignatureMetadataFilterFactory);
  74     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(REQUIREVALIDUNTIL_METADATA_FILTER, RequireValidUntilMetadataFilterFactory);
  75     // additional name matching Java code
  76     SAMLConfig::getConfig().MetadataFilterManager.registerFactory("RequiredValidUntil", RequireValidUntilMetadataFilterFactory);
  77     SAMLConfig::getConfig().MetadataFilterManager.registerFactory(ENTITYROLE_METADATA_FILTER, EntityRoleMetadataFilterFactory);
  78 }
  79
  80 static const XMLCh _MetadataFilter[] =  UNICODE_LITERAL_14(M,e,t,a,d,a,t,a,F,i,l,t,e,r);
  81 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);
  82 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);
  83 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);
  84 static const XMLCh Exclude[] =          UNICODE_LITERAL_7(E,x,c,l,u,d,e);
  85 static const XMLCh Include[] =          UNICODE_LITERAL_7(I,n,c,l,u,d,e);
  86 static const XMLCh type[] =             UNICODE_LITERAL_4(t,y,p,e);
  87
  88 MetadataProvider::MetadataProvider(const DOMElement* e)
  89 {
  90 #ifdef _DEBUG
  91     NDC ndc("MetadataProvider");
  92 #endif
  93     Category& log = Category::getInstance(SAML_LOGCAT".Metadata");
  94     SAMLConfig& conf = SAMLConfig::getConfig();
  95
  96     // Locate any default recognized filters and plugins.
  97     try {
  98         DOMElement* child = XMLHelper::getFirstChildElement(e);
  99         while (child) {
 100             if (XMLString::equals(child->getLocalName(), _MetadataFilter)) {
 101                 string t = XMLHelper::getAttrString(child, nullptr, type);
 102                 if (!t.empty()) {
 103                     log.info("building MetadataFilter of type %s", t.c_str());
 104                     m_filters.push_back(conf.MetadataFilterManager.newPlugin(t.c_str(), child));
 105                 }
 106             }
 107             else if (XMLString::equals(child->getLocalName(), SigFilter)) {
 108                 log.info("building MetadataFilter of type %s", SIGNATURE_METADATA_FILTER);
 109                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(SIGNATURE_METADATA_FILTER, child));
 110             }
 111             else if (XMLString::equals(child->getLocalName(), Whitelist)) {
 112                 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
 113                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER, child));
 114             }
 115             else if (XMLString::equals(child->getLocalName(), Blacklist)) {
 116                 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
 117                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER, child));
 118             }
 119             else if (XMLString::equals(child->getLocalName(), Include)) {
 120                 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
 121                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER, e));
 122             }
 123             else if (XMLString::equals(child->getLocalName(), Exclude)) {
 124                 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
 125                 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER, e));
 126             }
 127             child = XMLHelper::getNextSiblingElement(child);
 128         }
 129     }
 130     catch (XMLToolingException& ex) {
 131         log.error("caught exception while installing filters: %s", ex.what());
 132         for_each(m_filters.begin(),m_filters.end(),xmltooling::cleanup<MetadataFilter>());
 133         throw;
 134     }
 135 }
 136
 137 MetadataProvider::~MetadataProvider()
 138 {
 139     for_each(m_filters.begin(), m_filters.end(), xmltooling::cleanup<MetadataFilter>());
 140 }
 141
 142 const char* MetadataProvider::getId() const
 143 {
 144     return nullptr;
 145 }
 146
 147 void MetadataProvider::addMetadataFilter(MetadataFilter* newFilter)
 148 {
 149     m_filters.push_back(newFilter);
 150 }
 151
 152 MetadataFilter* MetadataProvider::removeMetadataFilter(MetadataFilter* oldFilter)
 153 {
 154     for (vector<MetadataFilter*>::iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
 155         if (oldFilter==(*i)) {
 156             m_filters.erase(i);
 157             return oldFilter;
 158         }
 159     }
 160     return nullptr;
 161 }
 162
 163 void MetadataProvider::doFilters(XMLObject& xmlObject) const
 164 {
 165 #ifdef _DEBUG
 166     NDC ndc("doFilters");
 167 #endif
 168     Category& log=Category::getInstance(SAML_LOGCAT".Metadata");
 169     for (std::vector<MetadataFilter*>::const_iterator i=m_filters.begin(); i!=m_filters.end(); i++) {
 170         log.info("applying metadata filter (%s)", (*i)->getId());
 171         (*i)->doFilter(xmlObject);
 172     }
 173 }
 174
 175 void MetadataProvider::outputStatus(ostream& os) const
 176 {
 177 }
 178
 179 const EntitiesDescriptor* MetadataProvider::getEntitiesDescriptor(const XMLCh* name, bool strict) const
 180 {
 181     auto_ptr_char temp(name);
 182     return getEntitiesDescriptor(temp.get(),strict);
 183 }
 184
 185 MetadataProvider::Criteria::Criteria()
 186     : entityID_unicode(nullptr), entityID_ascii(nullptr), artifact(nullptr), role(nullptr), protocol(nullptr), protocol2(nullptr), validOnly(true)
 187 {
 188 }
 189
 190 MetadataProvider::Criteria::Criteria(const XMLCh* id, const xmltooling::QName* q, const XMLCh* prot, bool valid)
 191     : entityID_unicode(id), entityID_ascii(nullptr), artifact(nullptr), role(q), protocol(prot), protocol2(nullptr), validOnly(valid)
 192 {
 193 }
 194
 195 MetadataProvider::Criteria::Criteria(const char* id, const xmltooling::QName* q, const XMLCh* prot, bool valid)
 196     : entityID_unicode(nullptr), entityID_ascii(id), artifact(nullptr), role(q), protocol(prot), protocol2(nullptr), validOnly(valid)
 197 {
 198 }
 199
 200 MetadataProvider::Criteria::Criteria(const SAMLArtifact* a, const xmltooling::QName* q, const XMLCh* prot, bool valid)
 201     : entityID_unicode(nullptr), entityID_ascii(nullptr), artifact(a), role(q), protocol(prot), protocol2(nullptr), validOnly(valid)
 202 {
 203 }
 204
 205 MetadataProvider::Criteria::~Criteria()
 206 {
 207 }
 208
 209 void MetadataProvider::Criteria::reset()
 210 {
 211     entityID_unicode=nullptr;
 212     entityID_ascii=nullptr;
 213     artifact=nullptr;
 214     role=nullptr;
 215     protocol=nullptr;
 216     protocol2=nullptr;
 217     validOnly=true;
 218 }
 219
 220 MetadataFilter::MetadataFilter()
 221 {
 222 }
 223
 224 MetadataFilter::~MetadataFilter()
 225 {
 226 }