https://issues.shibboleth.net/jira/browse/CPPOST-44
[shibboleth/cpp-opensaml.git] / saml / saml2 / metadata / impl / DynamicMetadataProvider.cpp
index b7b53f1..18227e5 100644 (file)
@@ -1,5 +1,5 @@
 /*
- *  Copyright 2001-2007 Internet2
+ *  Copyright 2001-2010 Internet2
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
 #include "saml2/metadata/DynamicMetadataProvider.h"
 
 #include <xercesc/framework/Wrapper4InputSource.hpp>
-#include <xercesc/framework/URLInputSource.hpp>
 #include <xercesc/util/XMLUniDefs.hpp>
 #include <xmltooling/logging.h>
+#include <xmltooling/XMLToolingConfig.h>
+#include <xmltooling/util/ParserPool.h>
+#include <xmltooling/util/Threads.h>
 #include <xmltooling/util/XMLHelper.h>
+#include <xmltooling/validation/ValidatorSuite.h>
 
 using namespace opensaml::saml2md;
 using namespace xmltooling::logging;
@@ -72,12 +75,38 @@ DynamicMetadataProvider::~DynamicMetadataProvider()
     delete m_lock;
 }
 
+const XMLObject* DynamicMetadataProvider::getMetadata() const
+{
+    throw MetadataException("getMetadata operation not implemented on this provider.");
+}
+
+Lockable* DynamicMetadataProvider::lock()
+{
+    m_lock->rdlock();
+    return this;
+}
+
+void DynamicMetadataProvider::unlock()
+{
+    m_lock->unlock();
+}
+
+void DynamicMetadataProvider::init()
+{
+}
+
 pair<const EntityDescriptor*,const RoleDescriptor*> DynamicMetadataProvider::getEntityDescriptor(const Criteria& criteria) const
 {
-    // Check cache while holding the read lock.
     pair<const EntityDescriptor*,const RoleDescriptor*> entity = AbstractMetadataProvider::getEntityDescriptor(criteria);
-    if (entity.first)   // even if the role isn't found, we're done
-        return entity;
+    if (entity.first) {
+        // Check to see if we're within the caching interval.
+        cachemap_t::iterator cit = m_cacheMap.find(entity.first->getEntityID());
+        if (cit != m_cacheMap.end()) {
+            if (time(NULL) <= cit->second)
+                return entity;
+            m_cacheMap.erase(cit);
+        }
+    }
 
     string name;
     if (criteria.entityID_ascii)
@@ -86,13 +115,17 @@ pair<const EntityDescriptor*,const RoleDescriptor*> DynamicMetadataProvider::get
         auto_ptr_char temp(criteria.entityID_unicode);
         name = temp.get();
     }
-    else if (criteria.artifact)
+    else if (criteria.artifact) {
         name = criteria.artifact->getSource();
+    }
     else
         return entity;
 
     Category& log = Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic");
-    log.info("resolving metadata for (%s)", name.c_str());
+    if (entity.first)
+        log.info("metadata for (%s) is beyond caching interval, attempting to refresh", name.c_str());
+    else
+        log.info("resolving metadata for (%s)", name.c_str());
 
     try {
         // Try resolving it.
@@ -100,22 +133,30 @@ pair<const EntityDescriptor*,const RoleDescriptor*> DynamicMetadataProvider::get
 
         // Verify the entityID.
         if (criteria.entityID_unicode && !XMLString::equals(criteria.entityID_unicode, entity2->getEntityID())) {
-            Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic").error("metadata instance did not match expected entityID");
+            log.error("metadata instance did not match expected entityID");
             return entity;
         }
         else {
             auto_ptr_XMLCh temp2(name.c_str());
             if (!XMLString::equals(temp2.get(), entity2->getEntityID())) {
-                Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic").error("metadata instance did not match expected entityID");
+                log.error("metadata instance did not match expected entityID");
                 return entity;
             }
         }
 
+        // Preprocess the metadata (even if we schema-validated).
+        try {
+            SchemaValidators.validate(entity2.get());
+        }
+        catch (exception& ex) {
+            log.error("metadata intance failed manual validation checking: %s", ex.what());
+            throw MetadataException("Metadata instance failed manual validation checking.");
+        }
+
         // Filter it, which may throw.
         doFilters(*entity2.get());
 
         time_t now = time(NULL);
-
         if (entity2->getValidUntil() && entity2->getValidUntilEpoch() < now + 60)
             throw MetadataException("Metadata was already invalid at the time of retrieval.");
 
@@ -128,21 +169,32 @@ pair<const EntityDescriptor*,const RoleDescriptor*> DynamicMetadataProvider::get
         // Notify observers.
         emitChangeEvent();
 
-        // Make sure we clear out any existing copies, including stale metadata or if somebody snuck in.
-        time_t exp = m_maxCacheDuration;
+        // Note the cache duration.
+        time_t cacheExp = m_maxCacheDuration;
         if (entity2->getCacheDuration())
-            exp = min(m_maxCacheDuration, entity2->getCacheDurationEpoch());
-        exp += now;
-        index(entity2.release(), exp, true);
+            cacheExp = min(m_maxCacheDuration, entity2->getCacheDurationEpoch());
+        cacheExp = max(cacheExp, 60);
+        m_cacheMap[entity2->getEntityID()] = time(NULL) + cacheExp;
+
+        // Make sure we clear out any existing copies, including stale metadata or if somebody snuck in.
+        index(entity2.release(), SAMLTIME_MAX, true);
 
         // Downgrade back to a read lock.
         m_lock->unlock();
         m_lock->rdlock();
     }
     catch (exception& e) {
-        Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic").error(
-            "error while resolving entityID (%s): %s", name.c_str(), e.what()
-            );
+        log.error("error while resolving entityID (%s): %s", name.c_str(), e.what());
+        // This will return entries that are beyond their cache period,
+        // but not beyond their validity unless that criteria option was set.
+        // If it is a cache-expired entry, bump the cache period to prevent retries.
+        if (entity.first) {
+            time_t cacheExp = 600;
+            if (entity.first->getCacheDuration())
+                cacheExp = min(m_maxCacheDuration, entity.first->getCacheDurationEpoch());
+            cacheExp = max(cacheExp, 60);
+            m_cacheMap[entity.first->getEntityID()] = time(NULL) + cacheExp;
+        }
         return entity;
     }
 
@@ -153,14 +205,16 @@ pair<const EntityDescriptor*,const RoleDescriptor*> DynamicMetadataProvider::get
 EntityDescriptor* DynamicMetadataProvider::resolve(const Criteria& criteria) const
 {
     string name;
-    if (criteria.entityID_ascii)
+    if (criteria.entityID_ascii) {
         name = criteria.entityID_ascii;
+    }
     else if (criteria.entityID_unicode) {
         auto_ptr_char temp(criteria.entityID_unicode);
         name = temp.get();
     }
-    else if (criteria.artifact)
-        name = criteria.artifact->getSource();
+    else if (criteria.artifact) {
+        throw MetadataException("Unable to resolve metadata dynamically from an artifact.");
+    }
 
     try {
         DOMDocument* doc=NULL;