https://issues.shibboleth.net/jira/browse/SSPCPP-254
[shibboleth/cpp-opensaml.git] / saml / saml2 / metadata / impl / XMLMetadataProvider.cpp
index bf359c9..3d88264 100644 (file)
 #include "saml2/metadata/Metadata.h"
 #include "saml2/metadata/MetadataFilter.h"
 #include "saml2/metadata/AbstractMetadataProvider.h"
+#include "saml2/metadata/DiscoverableMetadataProvider.h"
 
 #include <fstream>
+#include <xmltooling/XMLToolingConfig.h>
 #include <xmltooling/io/HTTPResponse.h>
 #include <xmltooling/util/NDC.h>
+#include <xmltooling/util/PathResolver.h>
 #include <xmltooling/util/ReloadableXMLFile.h>
 #include <xmltooling/util/Threads.h>
 #include <xmltooling/validation/ValidatorSuite.h>
@@ -46,10 +49,8 @@ using namespace std;
 namespace opensaml {
     namespace saml2md {
 
-        static const XMLCh minRefreshDelay[] =      UNICODE_LITERAL_15(m,i,n,R,e,f,r,e,s,h,D,e,l,a,y);
-        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);
-
-        class SAML_DLLLOCAL XMLMetadataProvider : public AbstractMetadataProvider, public ReloadableXMLFile
+        class SAML_DLLLOCAL XMLMetadataProvider
+            : public AbstractMetadataProvider, public DiscoverableMetadataProvider, public ReloadableXMLFile
         {
         public:
             XMLMetadataProvider(const DOMElement* e);
@@ -60,8 +61,14 @@ namespace opensaml {
             }
 
             void init() {
-                background_load();
-                startup();
+                try {
+                    background_load();
+                    startup();
+                }
+                catch (...) {
+                    startup();
+                    throw;
+                }
             }
 
             const XMLObject* getMetadata() const {
@@ -78,6 +85,7 @@ namespace opensaml {
             time_t computeNextRefresh();
 
             XMLObject* m_object;
+            bool m_discoveryFeed;
             double m_refreshDelayFactor;
             unsigned int m_backoffFactor;
             time_t m_minRefreshDelay,m_maxRefreshDelay,m_lastValidUntil;
@@ -88,6 +96,9 @@ namespace opensaml {
             return new XMLMetadataProvider(e);
         }
 
+        static const XMLCh discoveryFeed[] =        UNICODE_LITERAL_13(d,i,s,c,o,v,e,r,y,F,e,e,d);
+        static const XMLCh minRefreshDelay[] =      UNICODE_LITERAL_15(m,i,n,R,e,f,r,e,s,h,D,e,l,a,y);
+        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);
     };
 };
 
@@ -97,11 +108,13 @@ namespace opensaml {
 
 XMLMetadataProvider::XMLMetadataProvider(const DOMElement* e)
     : AbstractMetadataProvider(e), ReloadableXMLFile(e, Category::getInstance(SAML_LOGCAT".MetadataProvider.XML"), false),
-        m_object(nullptr), m_refreshDelayFactor(0.75), m_backoffFactor(1), m_minRefreshDelay(600),
+        m_object(nullptr), m_discoveryFeed(XMLHelper::getAttrBool(e, true, discoveryFeed)),
+        m_refreshDelayFactor(0.75), m_backoffFactor(1),
+        m_minRefreshDelay(XMLHelper::getAttrInt(e, 600, minRefreshDelay)),
         m_maxRefreshDelay(m_reloadInterval), m_lastValidUntil(SAMLTIME_MAX)
 {
     if (!m_local && m_maxRefreshDelay) {
-        const XMLCh* setting = e ? e->getAttributeNS(nullptr, refreshDelayFactor) : NULL;
+        const XMLCh* setting = e->getAttributeNS(nullptr, refreshDelayFactor);
         if (setting && *setting) {
             auto_ptr_char delay(setting);
             m_refreshDelayFactor = atof(delay.get());
@@ -110,17 +123,10 @@ XMLMetadataProvider::XMLMetadataProvider(const DOMElement* e)
                 m_refreshDelayFactor = 0.75;
             }
         }
-        setting = e ? e->getAttributeNS(nullptr, minRefreshDelay) : NULL;
-        if (setting && *setting) {
-            m_minRefreshDelay = XMLString::parseInt(setting);
-            if (m_minRefreshDelay == 0) {
-                m_log.error("invalid minRefreshDelay setting, using default");
-                m_minRefreshDelay = 600;
-            }
-            else if (m_minRefreshDelay > m_maxRefreshDelay) {
-                m_log.error("minRefreshDelay setting exceeds maxRefreshDelay/refreshInterval setting, lowering to match it");
-                m_minRefreshDelay = m_maxRefreshDelay;
-            }
+
+        if (m_minRefreshDelay > m_maxRefreshDelay) {
+            m_log.error("minRefreshDelay setting exceeds maxRefreshDelay/refreshInterval setting, lowering to match it");
+            m_minRefreshDelay = m_maxRefreshDelay;
         }
     }
 }
@@ -186,6 +192,7 @@ pair<bool,DOMElement*> XMLMetadataProvider::load(bool backup)
         remove(m_backing.c_str());
         if (rename(backupKey.c_str(), m_backing.c_str()) != 0)
             m_log.crit("unable to rename metadata backup file");
+        preserveCacheTag();
     }
 
     xmlObject->releaseThisAndChildrenDOM();
@@ -200,6 +207,8 @@ pair<bool,DOMElement*> XMLMetadataProvider::load(bool backup)
     m_object = xmlObject.release();
     m_lastValidUntil = SAMLTIME_MAX;
     index(m_lastValidUntil);
+    if (m_discoveryFeed)
+        generateFeed();
     if (changed)
         emitChangeEvent();
 
@@ -207,7 +216,7 @@ pair<bool,DOMElement*> XMLMetadataProvider::load(bool backup)
     // validUntil is the tightest interval amongst the children.
 
     // If a remote resource, adjust the reload interval.
-    if (!backup) {
+    if (!backup && !m_local) {
         m_backoffFactor = 1;
         m_reloadInterval = computeNextRefresh();
         m_log.info("adjusted reload interval to %d seconds", m_reloadInterval);
@@ -226,41 +235,32 @@ pair<bool,DOMElement*> XMLMetadataProvider::background_load()
         if (ex == HTTPResponse::XMLTOOLING_HTTP_STATUS_NOTMODIFIED) {
             // Unchanged document, so re-establish previous refresh interval.
             m_reloadInterval = computeNextRefresh();
-            m_log.info("adjusted reload interval to %d seconds", m_reloadInterval);
+            m_log.info("remote resource (%s) unchanged, adjusted reload interval to %u seconds", m_source.c_str(), m_reloadInterval);
         }
         else {
             // Any other status code, just treat as an error.
             m_reloadInterval = m_minRefreshDelay * m_backoffFactor++;
             if (m_reloadInterval > m_maxRefreshDelay)
                 m_reloadInterval = m_maxRefreshDelay;
-            m_log.warn("adjusted reload interval to %d seconds", m_reloadInterval);
+            m_log.warn("adjusted reload interval to %u seconds", m_reloadInterval);
         }
         if (!m_loaded && !m_backing.empty())
             return load(true);
         throw;
     }
     catch (exception&) {
-        m_reloadInterval = m_minRefreshDelay * m_backoffFactor++;
-        if (m_reloadInterval > m_maxRefreshDelay)
-            m_reloadInterval = m_maxRefreshDelay;
-        m_log.warn("adjusted reload interval to %d seconds", m_reloadInterval);
-        if (!m_loaded && !m_backing.empty())
-            return load(true);
+        if (!m_local) {
+            m_reloadInterval = m_minRefreshDelay * m_backoffFactor++;
+            if (m_reloadInterval > m_maxRefreshDelay)
+                m_reloadInterval = m_maxRefreshDelay;
+            m_log.warn("adjusted reload interval to %u seconds", m_reloadInterval);
+            if (!m_loaded && !m_backing.empty())
+                return load(true);
+        }
         throw;
     }
 }
 
-void XMLMetadataProvider::index(time_t& validUntil)
-{
-    clearDescriptorIndex();
-    EntitiesDescriptor* group=dynamic_cast<EntitiesDescriptor*>(m_object);
-    if (group) {
-        indexGroup(group, validUntil);
-        return;
-    }
-    indexEntity(dynamic_cast<EntityDescriptor*>(m_object), validUntil);
-}
-
 time_t XMLMetadataProvider::computeNextRefresh()
 {
     time_t now = time(nullptr);
@@ -288,3 +288,14 @@ time_t XMLMetadataProvider::computeNextRefresh()
         return ret;
     }
 }
+
+void XMLMetadataProvider::index(time_t& validUntil)
+{
+    clearDescriptorIndex();
+    EntitiesDescriptor* group=dynamic_cast<EntitiesDescriptor*>(m_object);
+    if (group) {
+        indexGroup(group, validUntil);
+        return;
+    }
+    indexEntity(dynamic_cast<EntityDescriptor*>(m_object), validUntil);
+}