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 * XMLMetadataProvider.cpp
20 * Supplies metadata from an XML file
24 #include "binding/SAMLArtifact.h"
25 #include "saml2/metadata/Metadata.h"
26 #include "saml2/metadata/MetadataFilter.h"
27 #include "saml2/metadata/AbstractMetadataProvider.h"
28 #include "saml2/metadata/DiscoverableMetadataProvider.h"
31 #include <xmltooling/XMLToolingConfig.h>
32 #include <xmltooling/io/HTTPResponse.h>
33 #include <xmltooling/util/NDC.h>
34 #include <xmltooling/util/PathResolver.h>
35 #include <xmltooling/util/ReloadableXMLFile.h>
36 #include <xmltooling/util/Threads.h>
37 #include <xmltooling/validation/ValidatorSuite.h>
39 using namespace opensaml::saml2md;
40 using namespace xmltooling::logging;
41 using namespace xmltooling;
44 #if defined (_MSC_VER)
45 #pragma warning( push )
46 #pragma warning( disable : 4250 )
52 class SAML_DLLLOCAL XMLMetadataProvider
53 : public AbstractMetadataProvider, public DiscoverableMetadataProvider, public ReloadableXMLFile
56 XMLMetadataProvider(const DOMElement* e);
58 virtual ~XMLMetadataProvider() {
74 const XMLObject* getMetadata() const {
79 pair<bool,DOMElement*> load(bool backup);
80 pair<bool,DOMElement*> background_load();
83 using AbstractMetadataProvider::index;
84 void index(time_t& validUntil);
85 time_t computeNextRefresh();
89 double m_refreshDelayFactor;
90 unsigned int m_backoffFactor;
91 time_t m_minRefreshDelay,m_maxRefreshDelay,m_lastValidUntil;
94 MetadataProvider* SAML_DLLLOCAL XMLMetadataProviderFactory(const DOMElement* const & e)
96 return new XMLMetadataProvider(e);
99 static const XMLCh discoveryFeed[] = UNICODE_LITERAL_13(d,i,s,c,o,v,e,r,y,F,e,e,d);
100 static const XMLCh minRefreshDelay[] = UNICODE_LITERAL_15(m,i,n,R,e,f,r,e,s,h,D,e,l,a,y);
101 static const XMLCh refreshDelayFactor[] = UNICODE_LITERAL_18(r,e,f,r,e,s,h,D,e,l,a,y,F,a,c,t,o,r);
105 #if defined (_MSC_VER)
106 #pragma warning( pop )
109 XMLMetadataProvider::XMLMetadataProvider(const DOMElement* e)
110 : MetadataProvider(e), AbstractMetadataProvider(e), DiscoverableMetadataProvider(e),
111 ReloadableXMLFile(e, Category::getInstance(SAML_LOGCAT".MetadataProvider.XML"), false),
112 m_object(nullptr), m_discoveryFeed(XMLHelper::getAttrBool(e, true, discoveryFeed)),
113 m_refreshDelayFactor(0.75), m_backoffFactor(1),
114 m_minRefreshDelay(XMLHelper::getAttrInt(e, 600, minRefreshDelay)),
115 m_maxRefreshDelay(m_reloadInterval), m_lastValidUntil(SAMLTIME_MAX)
117 if (!m_local && m_maxRefreshDelay) {
118 const XMLCh* setting = e->getAttributeNS(nullptr, refreshDelayFactor);
119 if (setting && *setting) {
120 auto_ptr_char delay(setting);
121 m_refreshDelayFactor = atof(delay.get());
122 if (m_refreshDelayFactor <= 0.0 || m_refreshDelayFactor >= 1.0) {
123 m_log.error("invalid refreshDelayFactor setting, using default");
124 m_refreshDelayFactor = 0.75;
128 if (m_minRefreshDelay > m_maxRefreshDelay) {
129 m_log.error("minRefreshDelay setting exceeds maxRefreshDelay/refreshInterval setting, lowering to match it");
130 m_minRefreshDelay = m_maxRefreshDelay;
135 pair<bool,DOMElement*> XMLMetadataProvider::load(bool backup)
137 // Lower the refresh rate in case of an error.
138 m_reloadInterval = m_minRefreshDelay;
140 // Call the base class to load/parse the appropriate XML resource.
141 pair<bool,DOMElement*> raw = ReloadableXMLFile::load(backup);
143 // If we own it, wrap it for now.
144 XercesJanitor<DOMDocument> docjanitor(raw.first ? raw.second->getOwnerDocument() : nullptr);
146 // Unmarshall objects, binding the document.
147 auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(raw.second, true));
148 docjanitor.release();
150 if (!dynamic_cast<const EntitiesDescriptor*>(xmlObject.get()) && !dynamic_cast<const EntityDescriptor*>(xmlObject.get()))
151 throw MetadataException(
152 "Root of metadata instance not recognized: $1", params(1,xmlObject->getElementQName().toString().c_str())
155 // Preprocess the metadata (even if we schema-validated).
157 SchemaValidators.validate(xmlObject.get());
159 catch (exception& ex) {
160 m_log.error("metadata intance failed manual validation checking: %s", ex.what());
161 throw MetadataException("Metadata instance failed manual validation checking.");
164 // This is the best place to take a backup, since it's superficially "correct" metadata.
166 if (!backup && !m_backing.empty()) {
167 // We compute a random filename extension to the "real" location.
168 SAMLConfig::getConfig().generateRandomBytes(backupKey, 2);
169 backupKey = m_backing + '.' + SAMLArtifact::toHex(backupKey);
170 m_log.debug("backing up remote metadata resource to (%s)", backupKey.c_str());
172 ofstream backer(backupKey.c_str());
173 backer << *(raw.second->getOwnerDocument());
175 catch (exception& ex) {
176 m_log.crit("exception while backing up metadata: %s", ex.what());
182 doFilters(*xmlObject.get());
185 if (!backupKey.empty())
186 remove(backupKey.c_str());
190 if (!backupKey.empty()) {
191 m_log.debug("committing backup file to permanent location (%s)", m_backing.c_str());
192 Locker locker(getBackupLock());
193 remove(m_backing.c_str());
194 if (rename(backupKey.c_str(), m_backing.c_str()) != 0)
195 m_log.crit("unable to rename metadata backup file");
199 xmlObject->releaseThisAndChildrenDOM();
200 xmlObject->setDocument(nullptr);
202 // Swap it in after acquiring write lock if necessary.
205 SharedLock locker(m_lock, false);
206 bool changed = m_object!=nullptr;
208 m_object = xmlObject.release();
209 m_lastValidUntil = SAMLTIME_MAX;
210 index(m_lastValidUntil);
216 // Tracking cacheUntil through the tree is TBD, but
217 // validUntil is the tightest interval amongst the children.
219 // If a remote resource, adjust the reload interval.
220 if (!backup && !m_local) {
222 m_reloadInterval = computeNextRefresh();
223 m_log.info("adjusted reload interval to %d seconds", m_reloadInterval);
227 return make_pair(false,(DOMElement*)nullptr);
230 pair<bool,DOMElement*> XMLMetadataProvider::background_load()
236 if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
237 // Unchanged document, so re-establish previous refresh interval.
238 m_reloadInterval = computeNextRefresh();
239 m_log.info("remote resource (%s) unchanged, adjusted reload interval to %u seconds", m_source.c_str(), m_reloadInterval);
242 // Any other status code, just treat as an error.
243 m_reloadInterval = m_minRefreshDelay * m_backoffFactor++;
244 if (m_reloadInterval > m_maxRefreshDelay)
245 m_reloadInterval = m_maxRefreshDelay;
246 m_log.warn("adjusted reload interval to %u seconds", m_reloadInterval);
248 if (!m_loaded && !m_backing.empty())
254 m_reloadInterval = m_minRefreshDelay * m_backoffFactor++;
255 if (m_reloadInterval > m_maxRefreshDelay)
256 m_reloadInterval = m_maxRefreshDelay;
257 m_log.warn("adjusted reload interval to %u seconds", m_reloadInterval);
258 if (!m_loaded && !m_backing.empty())
265 time_t XMLMetadataProvider::computeNextRefresh()
267 time_t now = time(nullptr);
269 // If some or all of the metadata is already expired, reload after the minimum.
270 if (m_lastValidUntil < now) {
271 return m_minRefreshDelay;
274 // Compute the smaller of the validUntil / cacheDuration constraints.
275 time_t ret = m_lastValidUntil - now;
276 const CacheableSAMLObject* cacheable = dynamic_cast<const CacheableSAMLObject*>(m_object);
277 if (cacheable && cacheable->getCacheDuration())
278 ret = min(ret, cacheable->getCacheDurationEpoch());
280 // Adjust for the delay factor.
281 ret *= m_refreshDelayFactor;
283 // Bound by max and min.
284 if (ret > m_maxRefreshDelay)
285 return m_maxRefreshDelay;
286 else if (ret < m_minRefreshDelay)
287 return m_minRefreshDelay;
293 void XMLMetadataProvider::index(time_t& validUntil)
295 clearDescriptorIndex();
296 EntitiesDescriptor* group=dynamic_cast<EntitiesDescriptor*>(m_object);
298 indexGroup(group, validUntil);
301 indexEntity(dynamic_cast<EntityDescriptor*>(m_object), validUntil);