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.
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
12 * http://www.apache.org/licenses/LICENSE-2.0
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.
22 * MetadataProvider.cpp
24 * Supplies an individual source of metadata.
28 #include "saml2/metadata/MetadataFilter.h"
29 #include "saml2/metadata/MetadataProvider.h"
32 #include <boost/lambda/lambda.hpp>
33 #include <xercesc/util/XMLUniDefs.hpp>
34 #include <xmltooling/logging.h>
35 #include <xmltooling/unicode.h>
36 #include <xmltooling/util/NDC.h>
37 #include <xmltooling/util/XMLHelper.h>
39 using namespace opensaml::saml2md;
40 using namespace opensaml;
41 using namespace xmltooling::logging;
42 using namespace xmltooling;
43 using namespace boost::lambda;
44 using namespace boost;
49 SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory XMLMetadataProviderFactory;
50 SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory DynamicMetadataProviderFactory;
51 SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory ChainingMetadataProviderFactory;
52 SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory FolderMetadataProviderFactory;
53 SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory NullMetadataProviderFactory;
54 SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory BlacklistMetadataFilterFactory;
55 SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory WhitelistMetadataFilterFactory;
56 SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory SignatureMetadataFilterFactory;
57 SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory RequireValidUntilMetadataFilterFactory;
58 SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory EntityRoleMetadataFilterFactory;
59 SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory EntityAttributesMetadataFilterFactory;
63 void SAML_API opensaml::saml2md::registerMetadataProviders()
65 SAMLConfig& conf=SAMLConfig::getConfig();
66 conf.MetadataProviderManager.registerFactory(XML_METADATA_PROVIDER, XMLMetadataProviderFactory);
67 conf.MetadataProviderManager.registerFactory(DYNAMIC_METADATA_PROVIDER, DynamicMetadataProviderFactory);
68 conf.MetadataProviderManager.registerFactory(CHAINING_METADATA_PROVIDER, ChainingMetadataProviderFactory);
69 conf.MetadataProviderManager.registerFactory(FOLDER_METADATA_PROVIDER, FolderMetadataProviderFactory);
70 conf.MetadataProviderManager.registerFactory(NULL_METADATA_PROVIDER, NullMetadataProviderFactory);
73 void SAML_API opensaml::saml2md::registerMetadataFilters()
75 SAMLConfig::getConfig().MetadataFilterManager.registerFactory(BLACKLIST_METADATA_FILTER, BlacklistMetadataFilterFactory);
76 SAMLConfig::getConfig().MetadataFilterManager.registerFactory(WHITELIST_METADATA_FILTER, WhitelistMetadataFilterFactory);
77 SAMLConfig::getConfig().MetadataFilterManager.registerFactory(SIGNATURE_METADATA_FILTER, SignatureMetadataFilterFactory);
78 SAMLConfig::getConfig().MetadataFilterManager.registerFactory(REQUIREVALIDUNTIL_METADATA_FILTER, RequireValidUntilMetadataFilterFactory);
79 // additional name matching Java code
80 SAMLConfig::getConfig().MetadataFilterManager.registerFactory("RequiredValidUntil", RequireValidUntilMetadataFilterFactory);
81 SAMLConfig::getConfig().MetadataFilterManager.registerFactory(ENTITYROLE_METADATA_FILTER, EntityRoleMetadataFilterFactory);
82 SAMLConfig::getConfig().MetadataFilterManager.registerFactory(ENTITYATTR_METADATA_FILTER, EntityAttributesMetadataFilterFactory);
86 static const XMLCh _MetadataFilter[] = UNICODE_LITERAL_14(M,e,t,a,d,a,t,a,F,i,l,t,e,r);
87 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);
88 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);
89 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);
90 static const XMLCh Exclude[] = UNICODE_LITERAL_7(E,x,c,l,u,d,e);
91 static const XMLCh Include[] = UNICODE_LITERAL_7(I,n,c,l,u,d,e);
92 static const XMLCh _type[] = UNICODE_LITERAL_4(t,y,p,e);
94 MetadataProvider::MetadataProvider(const DOMElement* e) : m_filterContext(nullptr)
97 NDC ndc("MetadataProvider");
99 Category& log = Category::getInstance(SAML_LOGCAT ".Metadata");
100 SAMLConfig& conf = SAMLConfig::getConfig();
102 // Locate any default recognized filters and plugins.
104 DOMElement* child = XMLHelper::getFirstChildElement(e);
106 if (XMLString::equals(child->getLocalName(), _MetadataFilter)) {
107 string t = XMLHelper::getAttrString(child, nullptr, _type);
109 log.info("building MetadataFilter of type %s", t.c_str());
110 auto_ptr<MetadataFilter> np(conf.MetadataFilterManager.newPlugin(t.c_str(), child));
111 m_filters.push_back(np.get());
115 log.error("MetadataFilter element missing type attribute");
118 else if (XMLString::equals(child->getLocalName(), SigFilter)) {
119 log.info("building MetadataFilter of type %s", SIGNATURE_METADATA_FILTER);
120 m_filters.push_back(conf.MetadataFilterManager.newPlugin(SIGNATURE_METADATA_FILTER, child));
122 else if (XMLString::equals(child->getLocalName(), Whitelist)) {
123 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
124 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER, child));
126 else if (XMLString::equals(child->getLocalName(), Blacklist)) {
127 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
128 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER, child));
130 else if (XMLString::equals(child->getLocalName(), Include)) {
131 log.info("building MetadataFilter of type %s", WHITELIST_METADATA_FILTER);
132 m_filters.push_back(conf.MetadataFilterManager.newPlugin(WHITELIST_METADATA_FILTER, e));
134 else if (XMLString::equals(child->getLocalName(), Exclude)) {
135 log.info("building MetadataFilter of type %s", BLACKLIST_METADATA_FILTER);
136 m_filters.push_back(conf.MetadataFilterManager.newPlugin(BLACKLIST_METADATA_FILTER, e));
138 child = XMLHelper::getNextSiblingElement(child);
141 catch (XMLToolingException& ex) {
142 log.error("caught exception while installing filters: %s", ex.what());
147 MetadataProvider::~MetadataProvider()
151 const char* MetadataProvider::getId() const
156 void MetadataProvider::addMetadataFilter(MetadataFilter* newFilter)
158 m_filters.push_back(newFilter);
161 MetadataFilter* MetadataProvider::removeMetadataFilter(MetadataFilter* oldFilter)
163 ptr_vector<MetadataFilter>::iterator i = find_if(m_filters.begin(), m_filters.end(), (&_1 == oldFilter));
164 if (i != m_filters.end()) {
165 return m_filters.release(i).release();
170 void MetadataProvider::setContext(const MetadataFilterContext* ctx)
172 m_filterContext = ctx;
175 void MetadataProvider::doFilters(XMLObject& xmlObject) const
177 Category& log = Category::getInstance(SAML_LOGCAT ".Metadata");
178 for (ptr_vector<MetadataFilter>::const_iterator i = m_filters.begin(); i != m_filters.end(); i++) {
179 log.info("applying metadata filter (%s)", i->getId());
180 i->doFilter(m_filterContext, xmlObject);
184 void MetadataProvider::outputStatus(ostream& os) const
188 const EntitiesDescriptor* MetadataProvider::getEntitiesDescriptor(const XMLCh* name, bool strict) const
190 auto_ptr_char temp(name);
191 return getEntitiesDescriptor(temp.get(),strict);
194 MetadataProvider::Criteria::Criteria()
195 : entityID_unicode(nullptr), entityID_ascii(nullptr), artifact(nullptr), role(nullptr), protocol(nullptr), protocol2(nullptr), validOnly(true)
199 MetadataProvider::Criteria::Criteria(const XMLCh* id, const xmltooling::QName* q, const XMLCh* prot, bool valid)
200 : entityID_unicode(id), entityID_ascii(nullptr), artifact(nullptr), role(q), protocol(prot), protocol2(nullptr), validOnly(valid)
204 MetadataProvider::Criteria::Criteria(const char* id, const xmltooling::QName* q, const XMLCh* prot, bool valid)
205 : entityID_unicode(nullptr), entityID_ascii(id), artifact(nullptr), role(q), protocol(prot), protocol2(nullptr), validOnly(valid)
209 MetadataProvider::Criteria::Criteria(const SAMLArtifact* a, const xmltooling::QName* q, const XMLCh* prot, bool valid)
210 : entityID_unicode(nullptr), entityID_ascii(nullptr), artifact(a), role(q), protocol(prot), protocol2(nullptr), validOnly(valid)
214 MetadataProvider::Criteria::~Criteria()
218 void MetadataProvider::Criteria::reset()
220 entityID_unicode = nullptr;
221 entityID_ascii = nullptr;
229 MetadataFilter::MetadataFilter()
233 MetadataFilter::~MetadataFilter()
237 void MetadataFilter::doFilter(const MetadataFilterContext* ctx, xmltooling::XMLObject& xmlObject) const
239 // Default call into deprecated method.
243 void MetadataFilter::doFilter(xmltooling::XMLObject& xmlObject) const
245 // Empty default for deprecated method.
248 MetadataFilterContext::MetadataFilterContext()
252 MetadataFilterContext::~MetadataFilterContext()