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