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 * 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/framework/URLInputSource.hpp>
30 #include <xercesc/util/XMLUniDefs.hpp>
31 #include <xmltooling/logging.h>
32 #include <xmltooling/util/XMLHelper.h>
34 using namespace opensaml::saml2md;
35 using namespace xmltooling::logging;
36 using namespace xmltooling;
40 # define min(a,b) (((a) < (b)) ? (a) : (b))
43 static const XMLCh maxCacheDuration[] = UNICODE_LITERAL_16(m,a,x,C,a,c,h,e,D,u,r,a,t,i,o,n);
44 static const XMLCh validate[] = UNICODE_LITERAL_8(v,a,l,i,d,a,t,e);
48 MetadataProvider* SAML_DLLLOCAL DynamicMetadataProviderFactory(const DOMElement* const & e)
50 return new DynamicMetadataProvider(e);
55 DynamicMetadataProvider::DynamicMetadataProvider(const DOMElement* e)
56 : AbstractMetadataProvider(e), m_maxCacheDuration(0), m_lock(RWLock::create())
58 const XMLCh* flag=e ? e->getAttributeNS(NULL,validate) : NULL;
59 m_validate=(XMLString::equals(flag,xmlconstants::XML_TRUE) || XMLString::equals(flag,xmlconstants::XML_ONE));
60 flag = e ? e->getAttributeNS(NULL,maxCacheDuration) : NULL;
62 m_maxCacheDuration = XMLString::parseInt(flag);
65 DynamicMetadataProvider::~DynamicMetadataProvider()
67 // Each entity in the map is unique (no multimap semantics), so this is safe.
68 clearDescriptorIndex(true);
72 pair<const EntityDescriptor*,const RoleDescriptor*> DynamicMetadataProvider::getEntityDescriptor(const Criteria& criteria) const
74 // Check cache while holding the read lock.
75 pair<const EntityDescriptor*,const RoleDescriptor*> entity = AbstractMetadataProvider::getEntityDescriptor(criteria);
76 if (entity.first) // even if the role isn't found, we're done
80 if (criteria.entityID_ascii)
81 name = criteria.entityID_ascii;
82 else if (criteria.entityID_unicode) {
83 auto_ptr_char temp(criteria.entityID_unicode);
86 else if (criteria.artifact)
87 name = criteria.artifact->getSource();
91 Category& log = Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic");
92 log.info("resolving metadata for (%s)", name.c_str());
95 auto_ptr<EntityDescriptor> entity2(resolve(name.c_str()));
97 // Filter it, which may throw.
98 doFilters(*entity2.get());
100 log.info("caching resolved metadata for (%s)", name.c_str());
102 // Translate cacheDuration into validUntil.
103 if (entity2->getCacheDuration())
104 entity2->setValidUntil(time(NULL) + min(m_maxCacheDuration, entity2->getCacheDurationEpoch()));
106 // Upgrade our lock so we can cache the new metadata.
113 // Make sure we clear out any existing copies, including stale metadata or if somebody snuck in.
114 index(entity2.release(), SAMLTIME_MAX, true);
116 // Downgrade back to a read lock.
121 return getEntityDescriptor(criteria);
124 EntityDescriptor* DynamicMetadataProvider::resolve(const char* entityID) const
127 DOMDocument* doc=NULL;
128 auto_ptr_XMLCh widenit(entityID);
129 URLInputSource src(widenit.get());
130 Wrapper4InputSource dsrc(&src,false);
132 doc=XMLToolingConfig::getConfig().getValidatingParser().parse(dsrc);
134 doc=XMLToolingConfig::getConfig().getParser().parse(dsrc);
136 // Wrap the document for now.
137 XercesJanitor<DOMDocument> docjanitor(doc);
139 // Unmarshall objects, binding the document.
140 auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
141 docjanitor.release();
143 // Make sure it's metadata.
144 EntityDescriptor* entity = dynamic_cast<EntityDescriptor*>(xmlObject.get());
146 throw MetadataException(
147 "Root of metadata instance not recognized: $1", params(1,xmlObject->getElementQName().toString().c_str())
153 catch (XMLException& e) {
154 auto_ptr_char msg(e.getMessage());
155 Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic").error(
156 "Xerces error while resolving entityID (%s): %s", entityID, msg.get()
158 throw MetadataException(msg.get());
160 catch (exception& e) {
161 Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic").error(
162 "error while resolving entityID (%s): %s", entityID, e.what()