saml/saml2/metadata/impl/AbstractMetadataProvider.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  * AbstractMetadataProvider.cpp
  19  *
  20  * Base class for caching metadata providers.
  21  */
  22
  23 #include "internal.h"
  24 #include "binding/SAMLArtifact.h"
  25 #include "saml2/metadata/Metadata.h"
  26 #include "saml2/metadata/AbstractMetadataProvider.h"
  27 #include "saml2/metadata/MetadataCredentialContext.h"
  28 #include "saml2/metadata/MetadataCredentialCriteria.h"
  29
  30 #include <xercesc/util/XMLUniDefs.hpp>
  31 #include <xmltooling/logging.h>
  32 #include <xmltooling/XMLToolingConfig.h>
  33 #include <xmltooling/security/Credential.h>
  34 #include <xmltooling/security/KeyInfoResolver.h>
  35 #include <xmltooling/security/SecurityHelper.h>
  36 #include <xmltooling/util/Threads.h>
  37 #include <xmltooling/util/XMLHelper.h>
  38
  39 using namespace opensaml::saml2md;
  40 using namespace xmltooling::logging;
  41 using namespace xmltooling;
  42 using namespace std;
  43 using opensaml::SAMLArtifact;
  44
  45 static const XMLCh _KeyInfoResolver[] = UNICODE_LITERAL_15(K,e,y,I,n,f,o,R,e,s,o,l,v,e,r);
  46 static const XMLCh type[] =             UNICODE_LITERAL_4(t,y,p,e);
  47
  48 AbstractMetadataProvider::AbstractMetadataProvider(const DOMElement* e)
  49     : ObservableMetadataProvider(e), m_resolver(NULL), m_credentialLock(NULL)
  50 {
  51     e = e ? XMLHelper::getFirstChildElement(e, _KeyInfoResolver) : NULL;
  52     if (e) {
  53         auto_ptr_char t(e->getAttributeNS(NULL,type));
  54         if (t.get())
  55             m_resolver = XMLToolingConfig::getConfig().KeyInfoResolverManager.newPlugin(t.get(),e);
  56         else
  57             throw UnknownExtensionException("<KeyInfoResolver> element found with no type attribute");
  58     }
  59     m_credentialLock = Mutex::create();
  60 }
  61
  62 AbstractMetadataProvider::~AbstractMetadataProvider()
  63 {
  64     for (credmap_t::iterator c = m_credentialMap.begin(); c!=m_credentialMap.end(); ++c)
  65         for_each(c->second.begin(), c->second.end(), xmltooling::cleanup<Credential>());
  66     delete m_credentialLock;
  67     delete m_resolver;
  68 }
  69
  70 void AbstractMetadataProvider::emitChangeEvent() const
  71 {
  72     for (credmap_t::iterator c = m_credentialMap.begin(); c!=m_credentialMap.end(); ++c)
  73         for_each(c->second.begin(), c->second.end(), xmltooling::cleanup<Credential>());
  74     m_credentialMap.clear();
  75     ObservableMetadataProvider::emitChangeEvent();
  76 }
  77
  78 void AbstractMetadataProvider::index(EntityDescriptor* site, time_t validUntil, bool replace) const
  79 {
  80     if (validUntil < site->getValidUntilEpoch())
  81         site->setValidUntil(validUntil);
  82
  83     auto_ptr_char id(site->getEntityID());
  84     if (id.get()) {
  85         if (replace) {
  86             m_sites.erase(id.get());
  87             for (sitemap_t::iterator s = m_sources.begin(); s != m_sources.end();) {
  88                 if (s->second == site) {
  89                     sitemap_t::iterator temp = s;
  90                     ++s;
  91                     m_sources.erase(temp);
  92                 }
  93                 else {
  94                     ++s;
  95                 }
  96             }
  97         }
  98         m_sites.insert(sitemap_t::value_type(id.get(),site));
  99     }
 100
 101     // Process each IdP role.
 102     const vector<IDPSSODescriptor*>& roles=const_cast<const EntityDescriptor*>(site)->getIDPSSODescriptors();
 103     for (vector<IDPSSODescriptor*>::const_iterator i=roles.begin(); i!=roles.end(); i++) {
 104         // SAML 1.x?
 105         if ((*i)->hasSupport(samlconstants::SAML10_PROTOCOL_ENUM) || (*i)->hasSupport(samlconstants::SAML11_PROTOCOL_ENUM)) {
 106             // Check for SourceID extension element.
 107             const Extensions* exts=(*i)->getExtensions();
 108             if (exts && exts->hasChildren()) {
 109                 const vector<XMLObject*>& children=exts->getUnknownXMLObjects();
 110                 for (vector<XMLObject*>::const_iterator ext=children.begin(); ext!=children.end(); ++ext) {
 111                     SourceID* sid=dynamic_cast<SourceID*>(*ext);
 112                     if (sid) {
 113                         auto_ptr_char sourceid(sid->getID());
 114                         if (sourceid.get()) {
 115                             m_sources.insert(sitemap_t::value_type(sourceid.get(),site));
 116                             break;
 117                         }
 118                     }
 119                 }
 120             }
 121
 122             // Hash the ID.
 123             m_sources.insert(sitemap_t::value_type(SecurityHelper::doHash("SHA1", id.get(), strlen(id.get())),site));
 124
 125             // Load endpoints for type 0x0002 artifacts.
 126             const vector<ArtifactResolutionService*>& locs=const_cast<const IDPSSODescriptor*>(*i)->getArtifactResolutionServices();
 127             for (vector<ArtifactResolutionService*>::const_iterator loc=locs.begin(); loc!=locs.end(); loc++) {
 128                 auto_ptr_char location((*loc)->getLocation());
 129                 if (location.get())
 130                     m_sources.insert(sitemap_t::value_type(location.get(),site));
 131             }
 132         }
 133
 134         // SAML 2.0?
 135         if ((*i)->hasSupport(samlconstants::SAML20P_NS)) {
 136             // Hash the ID.
 137             m_sources.insert(sitemap_t::value_type(SecurityHelper::doHash("SHA1", id.get(), strlen(id.get())),site));
 138         }
 139     }
 140 }
 141
 142 void AbstractMetadataProvider::index(EntitiesDescriptor* group, time_t validUntil) const
 143 {
 144     if (validUntil < group->getValidUntilEpoch())
 145         group->setValidUntil(validUntil);
 146
 147     auto_ptr_char name(group->getName());
 148     if (name.get()) {
 149         m_groups.insert(groupmap_t::value_type(name.get(),group));
 150     }
 151
 152     const vector<EntitiesDescriptor*>& groups=const_cast<const EntitiesDescriptor*>(group)->getEntitiesDescriptors();
 153     for (vector<EntitiesDescriptor*>::const_iterator i=groups.begin(); i!=groups.end(); i++)
 154         index(*i,group->getValidUntilEpoch());
 155
 156     const vector<EntityDescriptor*>& sites=const_cast<const EntitiesDescriptor*>(group)->getEntityDescriptors();
 157     for (vector<EntityDescriptor*>::const_iterator j=sites.begin(); j!=sites.end(); j++)
 158         index(*j,group->getValidUntilEpoch());
 159 }
 160
 161 void AbstractMetadataProvider::clearDescriptorIndex(bool freeSites)
 162 {
 163     if (freeSites)
 164         for_each(m_sites.begin(), m_sites.end(), cleanup_const_pair<string,EntityDescriptor>());
 165     m_sites.clear();
 166     m_groups.clear();
 167     m_sources.clear();
 168 }
 169
 170 const EntitiesDescriptor* AbstractMetadataProvider::getEntitiesDescriptor(const char* name, bool strict) const
 171 {
 172     pair<groupmap_t::const_iterator,groupmap_t::const_iterator> range=const_cast<const groupmap_t&>(m_groups).equal_range(name);
 173
 174     time_t now=time(NULL);
 175     for (groupmap_t::const_iterator i=range.first; i!=range.second; i++)
 176         if (now < i->second->getValidUntilEpoch())
 177             return i->second;
 178
 179     if (range.first != range.second) {
 180         Category& log = Category::getInstance(SAML_LOGCAT".MetadataProvider");
 181         if (strict) {
 182             log.warn("ignored expired metadata group (%s)", range.first->first.c_str());
 183         }
 184         else {
 185             log.info("no valid metadata found, returning expired metadata group (%s)", range.first->first.c_str());
 186             return range.first->second;
 187         }
 188     }
 189
 190     return NULL;
 191 }
 192
 193 pair<const EntityDescriptor*,const RoleDescriptor*> AbstractMetadataProvider::getEntityDescriptor(const Criteria& criteria) const
 194 {
 195     pair<sitemap_t::const_iterator,sitemap_t::const_iterator> range;
 196     if (criteria.entityID_ascii)
 197         range = const_cast<const sitemap_t&>(m_sites).equal_range(criteria.entityID_ascii);
 198     else if (criteria.entityID_unicode) {
 199         auto_ptr_char id(criteria.entityID_unicode);
 200         range = const_cast<const sitemap_t&>(m_sites).equal_range(id.get());
 201     }
 202     else if (criteria.artifact)
 203         range = const_cast<const sitemap_t&>(m_sources).equal_range(criteria.artifact->getSource());
 204     else
 205         return pair<const EntityDescriptor*,const RoleDescriptor*>(NULL,NULL);
 206
 207     pair<const EntityDescriptor*,const RoleDescriptor*> result;
 208     result.first = NULL;
 209     result.second = NULL;
 210
 211     time_t now=time(NULL);
 212     for (sitemap_t::const_iterator i=range.first; i!=range.second; i++) {
 213         if (now < i->second->getValidUntilEpoch()) {
 214             result.first = i->second;
 215             break;
 216         }
 217     }
 218
 219     if (!result.first && range.first!=range.second) {
 220         Category& log = Category::getInstance(SAML_LOGCAT".MetadataProvider");
 221         if (criteria.validOnly) {
 222             log.warn("ignored expired metadata instance for (%s)", range.first->first.c_str());
 223         }
 224         else {
 225             log.info("no valid metadata found, returning expired instance for (%s)", range.first->first.c_str());
 226             result.first = range.first->second;
 227         }
 228     }
 229
 230     if (result.first && criteria.role) {
 231         result.second = result.first->getRoleDescriptor(*criteria.role, criteria.protocol);
 232         if (!result.second && criteria.protocol2)
 233             result.second = result.first->getRoleDescriptor(*criteria.role, criteria.protocol2);
 234     }
 235
 236     return result;
 237 }
 238
 239 const Credential* AbstractMetadataProvider::resolve(const CredentialCriteria* criteria) const
 240 {
 241     const MetadataCredentialCriteria* metacrit = dynamic_cast<const MetadataCredentialCriteria*>(criteria);
 242     if (!metacrit)
 243         throw MetadataException("Cannot resolve credentials without a MetadataCredentialCriteria object.");
 244
 245     Lock lock(m_credentialLock);
 246     const credmap_t::mapped_type& creds = resolveCredentials(metacrit->getRole());
 247
 248     for (credmap_t::mapped_type::const_iterator c = creds.begin(); c!=creds.end(); ++c)
 249         if (metacrit->matches(*(*c)))
 250             return *c;
 251     return NULL;
 252 }
 253
 254 vector<const Credential*>::size_type AbstractMetadataProvider::resolve(
 255     vector<const Credential*>& results, const CredentialCriteria* criteria
 256     ) const
 257 {
 258     const MetadataCredentialCriteria* metacrit = dynamic_cast<const MetadataCredentialCriteria*>(criteria);
 259     if (!metacrit)
 260         throw MetadataException("Cannot resolve credentials without a MetadataCredentialCriteria object.");
 261
 262     Lock lock(m_credentialLock);
 263     const credmap_t::mapped_type& creds = resolveCredentials(metacrit->getRole());
 264
 265     for (credmap_t::mapped_type::const_iterator c = creds.begin(); c!=creds.end(); ++c)
 266         if (metacrit->matches(*(*c)))
 267             results.push_back(*c);
 268     return results.size();
 269 }
 270
 271 const AbstractMetadataProvider::credmap_t::mapped_type& AbstractMetadataProvider::resolveCredentials(const RoleDescriptor& role) const
 272 {
 273     credmap_t::const_iterator i = m_credentialMap.find(&role);
 274     if (i!=m_credentialMap.end())
 275         return i->second;
 276
 277     const KeyInfoResolver* resolver = m_resolver ? m_resolver : XMLToolingConfig::getConfig().getKeyInfoResolver();
 278     const vector<KeyDescriptor*>& keys = role.getKeyDescriptors();
 279     AbstractMetadataProvider::credmap_t::mapped_type& resolved = m_credentialMap[&role];
 280     for (vector<KeyDescriptor*>::const_iterator k = keys.begin(); k!=keys.end(); ++k) {
 281         if ((*k)->getKeyInfo()) {
 282             auto_ptr<MetadataCredentialContext> mcc(new MetadataCredentialContext(*(*k)));
 283             Credential* c = resolver->resolve(mcc.get());
 284             mcc.release();
 285             resolved.push_back(c);
 286         }
 287     }
 288     return resolved;
 289 }