2 * Copyright 2001-2010 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 * DynamicMetadataProvider.cpp
20 * Simple implementation of a dynamic caching MetadataProvider.
24 #include "binding/SAMLArtifact.h"
25 #include "saml2/metadata/Metadata.h"
26 #include "saml2/metadata/DynamicMetadataProvider.h"
28 #include <xercesc/framework/Wrapper4InputSource.hpp>
29 #include <xercesc/util/XMLUniDefs.hpp>
30 #include <xmltooling/logging.h>
31 #include <xmltooling/XMLToolingConfig.h>
32 #include <xmltooling/util/ParserPool.h>
33 #include <xmltooling/util/Threads.h>
34 #include <xmltooling/util/XMLHelper.h>
35 #include <xmltooling/validation/ValidatorSuite.h>
37 using namespace opensaml::saml2md;
38 using namespace xmltooling::logging;
39 using namespace xmltooling;
43 # define min(a,b) (((a) < (b)) ? (a) : (b))
46 static const XMLCh maxCacheDuration[] = UNICODE_LITERAL_16(m,a,x,C,a,c,h,e,D,u,r,a,t,i,o,n);
47 static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
51 MetadataProvider* SAML_DLLLOCAL DynamicMetadataProviderFactory(const DOMElement* const & e)
53 return new DynamicMetadataProvider(e);
58 DynamicMetadataProvider::DynamicMetadataProvider(const DOMElement* e)
59 : AbstractMetadataProvider(e), m_maxCacheDuration(28800), m_lock(RWLock::create())
61 const XMLCh* flag=e ? e->getAttributeNS(NULL,validate) : NULL;
62 m_validate=(XMLString::equals(flag,xmlconstants::XML_TRUE) || XMLString::equals(flag,xmlconstants::XML_ONE));
63 flag = e ? e->getAttributeNS(NULL,maxCacheDuration) : NULL;
65 m_maxCacheDuration = XMLString::parseInt(flag);
66 if (m_maxCacheDuration == 0)
67 m_maxCacheDuration = 28800;
71 DynamicMetadataProvider::~DynamicMetadataProvider()
73 // Each entity in the map is unique (no multimap semantics), so this is safe.
74 clearDescriptorIndex(true);
78 const XMLObject* DynamicMetadataProvider::getMetadata() const
80 throw MetadataException("getMetadata operation not implemented on this provider.");
83 Lockable* DynamicMetadataProvider::lock()
89 void DynamicMetadataProvider::unlock()
94 void DynamicMetadataProvider::init()
98 pair<const EntityDescriptor*,const RoleDescriptor*> DynamicMetadataProvider::getEntityDescriptor(const Criteria& criteria) const
100 pair<const EntityDescriptor*,const RoleDescriptor*> entity = AbstractMetadataProvider::getEntityDescriptor(criteria);
102 // Check to see if we're within the caching interval.
103 cachemap_t::iterator cit = m_cacheMap.find(entity.first->getEntityID());
104 if (cit != m_cacheMap.end()) {
105 if (time(NULL) <= cit->second)
107 m_cacheMap.erase(cit);
112 if (criteria.entityID_ascii)
113 name = criteria.entityID_ascii;
114 else if (criteria.entityID_unicode) {
115 auto_ptr_char temp(criteria.entityID_unicode);
118 else if (criteria.artifact) {
119 name = criteria.artifact->getSource();
124 Category& log = Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic");
126 log.info("metadata for (%s) is beyond caching interval, attempting to refresh", name.c_str());
128 log.info("resolving metadata for (%s)", name.c_str());
132 auto_ptr<EntityDescriptor> entity2(resolve(criteria));
134 // Verify the entityID.
135 if (criteria.entityID_unicode && !XMLString::equals(criteria.entityID_unicode, entity2->getEntityID())) {
136 log.error("metadata instance did not match expected entityID");
140 auto_ptr_XMLCh temp2(name.c_str());
141 if (!XMLString::equals(temp2.get(), entity2->getEntityID())) {
142 log.error("metadata instance did not match expected entityID");
147 // Preprocess the metadata (even if we schema-validated).
149 SchemaValidators.validate(entity2.get());
151 catch (exception& ex) {
152 log.error("metadata intance failed manual validation checking: %s", ex.what());
153 throw MetadataException("Metadata instance failed manual validation checking.");
156 // Filter it, which may throw.
157 doFilters(*entity2.get());
159 time_t now = time(NULL);
160 if (entity2->getValidUntil() && entity2->getValidUntilEpoch() < now + 60)
161 throw MetadataException("Metadata was already invalid at the time of retrieval.");
163 log.info("caching resolved metadata for (%s)", name.c_str());
165 // Upgrade our lock so we can cache the new metadata.
172 // Note the cache duration.
173 time_t cacheExp = m_maxCacheDuration;
174 if (entity2->getCacheDuration())
175 cacheExp = min(m_maxCacheDuration, entity2->getCacheDurationEpoch());
176 cacheExp = max(cacheExp, 60);
177 m_cacheMap[entity2->getEntityID()] = time(NULL) + cacheExp;
179 // Make sure we clear out any existing copies, including stale metadata or if somebody snuck in.
180 index(entity2.release(), SAMLTIME_MAX, true);
182 // Downgrade back to a read lock.
186 catch (exception& e) {
187 log.error("error while resolving entityID (%s): %s", name.c_str(), e.what());
188 // This will return entries that are beyond their cache period,
189 // but not beyond their validity unless that criteria option was set.
190 // If it is a cache-expired entry, bump the cache period to prevent retries.
192 time_t cacheExp = 600;
193 if (entity.first->getCacheDuration())
194 cacheExp = min(m_maxCacheDuration, entity.first->getCacheDurationEpoch());
195 cacheExp = max(cacheExp, 60);
196 m_cacheMap[entity.first->getEntityID()] = time(NULL) + cacheExp;
202 return getEntityDescriptor(criteria);
205 EntityDescriptor* DynamicMetadataProvider::resolve(const Criteria& criteria) const
208 if (criteria.entityID_ascii) {
209 name = criteria.entityID_ascii;
211 else if (criteria.entityID_unicode) {
212 auto_ptr_char temp(criteria.entityID_unicode);
215 else if (criteria.artifact) {
216 throw MetadataException("Unable to resolve metadata dynamically from an artifact.");
220 DOMDocument* doc=NULL;
221 auto_ptr_XMLCh widenit(name.c_str());
222 URLInputSource src(widenit.get());
223 Wrapper4InputSource dsrc(&src,false);
225 doc=XMLToolingConfig::getConfig().getValidatingParser().parse(dsrc);
227 doc=XMLToolingConfig::getConfig().getParser().parse(dsrc);
229 // Wrap the document for now.
230 XercesJanitor<DOMDocument> docjanitor(doc);
232 // Unmarshall objects, binding the document.
233 auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
234 docjanitor.release();
236 // Make sure it's metadata.
237 EntityDescriptor* entity = dynamic_cast<EntityDescriptor*>(xmlObject.get());
239 throw MetadataException(
240 "Root of metadata instance not recognized: $1", params(1,xmlObject->getElementQName().toString().c_str())
246 catch (XMLException& e) {
247 auto_ptr_char msg(e.getMessage());
248 Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic").error(
249 "Xerces error while resolving entityID (%s): %s", name.c_str(), msg.get()
251 throw MetadataException(msg.get());