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