saml/saml2/metadata/impl/AbstractMetadataProvider.cpp

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