saml/saml2/metadata/impl/DynamicMetadataProvider.cpp

   1 /*
   2  *  Copyright 2001-2009 Internet2
   3  *
   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
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  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.
  15  */
  16
  17 /**
  18  * DynamicMetadataProvider.cpp
  19  *
  20  * Simple implementation of a dynamic caching MetadataProvider.
  21  */
  22
  23 #include "internal.h"
  24 #include "binding/SAMLArtifact.h"
  25 #include "saml2/metadata/Metadata.h"
  26 #include "saml2/metadata/DynamicMetadataProvider.h"
  27
  28 #include <xercesc/framework/Wrapper4InputSource.hpp>
  29 #include <xercesc/util/XMLUniDefs.hpp>
  30 #include <xmltooling/logging.h>
  31 #include <xmltooling/util/XMLHelper.h>
  32 #include <xmltooling/validation/ValidatorSuite.h>
  33
  34 using namespace opensaml::saml2md;
  35 using namespace xmltooling::logging;
  36 using namespace xmltooling;
  37 using namespace std;
  38
  39 # ifndef min
  40 #  define min(a,b)            (((a) < (b)) ? (a) : (b))
  41 # endif
  42
  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);
  45
  46 namespace opensaml {
  47     namespace saml2md {
  48         MetadataProvider* SAML_DLLLOCAL DynamicMetadataProviderFactory(const DOMElement* const & e)
  49         {
  50             return new DynamicMetadataProvider(e);
  51         }
  52     };
  53 };
  54
  55 DynamicMetadataProvider::DynamicMetadataProvider(const DOMElement* e)
  56     : AbstractMetadataProvider(e), m_maxCacheDuration(28800), m_lock(RWLock::create())
  57 {
  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;
  61     if (flag && *flag) {
  62         m_maxCacheDuration = XMLString::parseInt(flag);
  63         if (m_maxCacheDuration == 0)
  64             m_maxCacheDuration = 28800;
  65     }
  66 }
  67
  68 DynamicMetadataProvider::~DynamicMetadataProvider()
  69 {
  70     // Each entity in the map is unique (no multimap semantics), so this is safe.
  71     clearDescriptorIndex(true);
  72     delete m_lock;
  73 }
  74
  75 pair<const EntityDescriptor*,const RoleDescriptor*> DynamicMetadataProvider::getEntityDescriptor(const Criteria& criteria) const
  76 {
  77     // Check cache while holding the read lock.
  78     pair<const EntityDescriptor*,const RoleDescriptor*> entity = AbstractMetadataProvider::getEntityDescriptor(criteria);
  79     if (entity.first)   // even if the role isn't found, we're done
  80         return entity;
  81
  82     string name;
  83     if (criteria.entityID_ascii)
  84         name = criteria.entityID_ascii;
  85     else if (criteria.entityID_unicode) {
  86         auto_ptr_char temp(criteria.entityID_unicode);
  87         name = temp.get();
  88     }
  89     else if (criteria.artifact) {
  90         name = criteria.artifact->getSource();
  91     }
  92     else
  93         return entity;
  94
  95     Category& log = Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic");
  96     log.info("resolving metadata for (%s)", name.c_str());
  97
  98     try {
  99         // Try resolving it.
 100         auto_ptr<EntityDescriptor> entity2(resolve(criteria));
 101
 102         // Verify the entityID.
 103         if (criteria.entityID_unicode && !XMLString::equals(criteria.entityID_unicode, entity2->getEntityID())) {
 104             log.error("metadata instance did not match expected entityID");
 105             return entity;
 106         }
 107         else {
 108             auto_ptr_XMLCh temp2(name.c_str());
 109             if (!XMLString::equals(temp2.get(), entity2->getEntityID())) {
 110                 log.error("metadata instance did not match expected entityID");
 111                 return entity;
 112             }
 113         }
 114
 115         if (!m_validate) {
 116             try {
 117                 SchemaValidators.validate(entity2.get());
 118             }
 119             catch (exception& ex) {
 120                 log.error("metadata intance failed manual schema validation checking: ", ex.what());
 121                 throw MetadataException("Metadata instance failed manual schema validation checking.");
 122             }
 123         }
 124
 125         // Filter it, which may throw.
 126         doFilters(*entity2.get());
 127
 128         time_t now = time(NULL);
 129
 130         if (entity2->getValidUntil() && entity2->getValidUntilEpoch() < now + 60)
 131             throw MetadataException("Metadata was already invalid at the time of retrieval.");
 132
 133         log.info("caching resolved metadata for (%s)", name.c_str());
 134
 135         // Upgrade our lock so we can cache the new metadata.
 136         m_lock->unlock();
 137         m_lock->wrlock();
 138
 139         // Notify observers.
 140         emitChangeEvent();
 141
 142         // Make sure we clear out any existing copies, including stale metadata or if somebody snuck in.
 143         time_t exp = m_maxCacheDuration;
 144         if (entity2->getCacheDuration())
 145             exp = min(m_maxCacheDuration, entity2->getCacheDurationEpoch());
 146         exp += now;
 147         index(entity2.release(), exp, true);
 148
 149         // Downgrade back to a read lock.
 150         m_lock->unlock();
 151         m_lock->rdlock();
 152     }
 153     catch (exception& e) {
 154         log.error("error while resolving entityID (%s): %s", name.c_str(), e.what());
 155         return entity;
 156     }
 157
 158     // Rinse and repeat.
 159     return getEntityDescriptor(criteria);
 160 }
 161
 162 EntityDescriptor* DynamicMetadataProvider::resolve(const Criteria& criteria) const
 163 {
 164     string name;
 165     if (criteria.entityID_ascii) {
 166         name = criteria.entityID_ascii;
 167     }
 168     else if (criteria.entityID_unicode) {
 169         auto_ptr_char temp(criteria.entityID_unicode);
 170         name = temp.get();
 171     }
 172     else if (criteria.artifact) {
 173         throw MetadataException("Unable to resolve metadata dynamically from an artifact.");
 174     }
 175
 176     try {
 177         DOMDocument* doc=NULL;
 178         auto_ptr_XMLCh widenit(name.c_str());
 179         URLInputSource src(widenit.get());
 180         Wrapper4InputSource dsrc(&src,false);
 181         if (m_validate)
 182             doc=XMLToolingConfig::getConfig().getValidatingParser().parse(dsrc);
 183         else
 184             doc=XMLToolingConfig::getConfig().getParser().parse(dsrc);
 185
 186         // Wrap the document for now.
 187         XercesJanitor<DOMDocument> docjanitor(doc);
 188
 189         // Unmarshall objects, binding the document.
 190         auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
 191         docjanitor.release();
 192
 193         // Make sure it's metadata.
 194         EntityDescriptor* entity = dynamic_cast<EntityDescriptor*>(xmlObject.get());
 195         if (!entity) {
 196             throw MetadataException(
 197                 "Root of metadata instance not recognized: $1", params(1,xmlObject->getElementQName().toString().c_str())
 198                 );
 199         }
 200         xmlObject.release();
 201         return entity;
 202     }
 203     catch (XMLException& e) {
 204         auto_ptr_char msg(e.getMessage());
 205         Category::getInstance(SAML_LOGCAT".MetadataProvider.Dynamic").error(
 206             "Xerces error while resolving entityID (%s): %s", name.c_str(), msg.get()
 207             );
 208         throw MetadataException(msg.get());
 209     }
 210 }