2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * MetadataProvider.cpp
20 * Registration of factories for built-in providers
24 #include "saml2/metadata/MetadataFilter.h"
25 #include "saml2/metadata/MetadataProvider.h"
27 #include <xercesc/util/XMLUniDefs.hpp>
28 #include <xmltooling/logging.h>
29 #include <xmltooling/util/NDC.h>
30 #include <xmltooling/util/XMLHelper.h>
32 using namespace opensaml::saml2md;
33 using namespace opensaml;
34 using namespace xmltooling::logging;
35 using namespace xmltooling;
40 SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory XMLMetadataProviderFactory;
41 SAML_DLLLOCAL PluginManager<MetadataProvider,string,const DOMElement*>::Factory ChainingMetadataProviderFactory;
42 SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory BlacklistMetadataFilterFactory;
43 SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory WhitelistMetadataFilterFactory;
44 SAML_DLLLOCAL PluginManager<MetadataFilter,string,const DOMElement*>::Factory SignatureMetadataFilterFactory;
48 void SAML_API opensaml::saml2md::registerMetadataProviders()
50 SAMLConfig& conf=SAMLConfig::getConfig();
51 conf.MetadataProviderManager.registerFactory(XML_METADATA_PROVIDER, XMLMetadataProviderFactory);
52 conf.MetadataProviderManager.registerFactory(CHAINING_METADATA_PROVIDER, ChainingMetadataProviderFactory);
53 conf.MetadataProviderManager.registerFactory("edu.internet2.middleware.shibboleth.metadata.provider.XMLMetadata", XMLMetadataProviderFactory);
54 conf.MetadataProviderManager.registerFactory("edu.internet2.middleware.shibboleth.common.provider.XMLMetadata", XMLMetadataProviderFactory);
57 void SAML_API opensaml::saml2md::registerMetadataFilters()
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);
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);
72 MetadataProvider::MetadataProvider(const DOMElement* e)
75 NDC ndc("MetadataProvider");
77 Category& log = Category::getInstance(SAML_LOGCAT".Metadata");
78 SAMLConfig& conf=SAMLConfig::getConfig();
80 // Locate any default recognized filters and plugins.
82 DOMElement* child = e ? XMLHelper::getFirstChildElement(e) : NULL;
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));
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));
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));
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));
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));
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));
111 child = XMLHelper::getNextSiblingElement(child);
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>());
121 MetadataProvider::~MetadataProvider()
123 for_each(m_filters.begin(),m_filters.end(),xmltooling::cleanup<MetadataFilter>());
126 void MetadataProvider::doFilters(XMLObject& xmlObject) const
129 NDC ndc("doFilters");
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);
138 const EntitiesDescriptor* MetadataProvider::getEntitiesDescriptor(const XMLCh* name, bool strict) const
140 auto_ptr_char temp(name);
141 return getEntitiesDescriptor(temp.get(),strict);
144 const EntityDescriptor* MetadataProvider::getEntityDescriptor(const XMLCh* name, bool strict) const
146 auto_ptr_char temp(name);
147 return getEntityDescriptor(temp.get(),strict);