saml/binding/impl/ArtifactMap.cpp

   1 /**
   2  * Licensed to the University Corporation for Advanced Internet
   3  * Development, Inc. (UCAID) under one or more contributor license
   4  * agreements. See the NOTICE file distributed with this work for
   5  * additional information regarding copyright ownership.
   6  *
   7  * UCAID licenses this file to you under the Apache License,
   8  * Version 2.0 (the "License"); you may not use this file except
   9  * in compliance with the License. You may obtain a copy of the
  10  * License at
  11  *
  12  * http://www.apache.org/licenses/LICENSE-2.0
  13  *
  14  * Unless required by applicable law or agreed to in writing,
  15  * software distributed under the License is distributed on an
  16  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
  17  * either express or implied. See the License for the specific
  18  * language governing permissions and limitations under the License.
  19  */
  20
  21 /**
  22  * ArtifactMap.cpp
  23  *
  24  * Helper class for SAMLArtifact mapping and retrieval.
  25  */
  26
  27 #include "internal.h"
  28 #include "exceptions.h"
  29 #include "binding/ArtifactMap.h"
  30 #include "binding/SAMLArtifact.h"
  31
  32 #include <ctime>
  33 #include <boost/lambda/bind.hpp>
  34 #include <boost/lambda/lambda.hpp>
  35 #include <xercesc/util/XMLUniDefs.hpp>
  36 #include <xmltooling/logging.h>
  37 #include <xmltooling/XMLObjectBuilder.h>
  38 #include <xmltooling/XMLToolingConfig.h>
  39 #include <xmltooling/security/SecurityHelper.h>
  40 #include <xmltooling/util/NDC.h>
  41 #include <xmltooling/util/ParserPool.h>
  42 #include <xmltooling/util/StorageService.h>
  43 #include <xmltooling/util/XMLHelper.h>
  44 #include <xmltooling/util/Threads.h>
  45
  46 using namespace opensaml;
  47 using namespace xmltooling::logging;
  48 using namespace xmltooling;
  49 using namespace boost::lambda;
  50 using namespace boost;
  51 using namespace std;
  52
  53 namespace opensaml {
  54     // In-memory storage of mappings instead of using storage API.
  55     class SAML_DLLLOCAL ArtifactMappings
  56     {
  57     public:
  58         ArtifactMappings() : m_lock(Mutex::create()) {}
  59         ~ArtifactMappings() {}
  60
  61         void storeContent(XMLObject* content, const SAMLArtifact* artifact, const char* relyingParty, int TTL);
  62         XMLObject* retrieveContent(const SAMLArtifact* artifact, const char* relyingParty);
  63         string getRelyingParty(const SAMLArtifact* artifact);
  64
  65     private:
  66         struct SAML_DLLLOCAL Mapping {
  67             Mapping() : m_xml(nullptr), m_expires(0) {}
  68             ~Mapping() {
  69                 delete m_xml;
  70             }
  71             XMLObject* m_xml;
  72             string m_relying;
  73             time_t m_expires;
  74         };
  75
  76         void removeMapping(const map<string,Mapping>::iterator& i);
  77
  78         auto_ptr<Mutex> m_lock;
  79         map<string,Mapping> m_artMap;
  80         multimap<time_t,string> m_expMap;
  81     };
  82
  83     static const XMLCh artifactTTL[] =  UNICODE_LITERAL_11(a,r,t,i,f,a,c,t,T,T,L);
  84     static const XMLCh context[] =      UNICODE_LITERAL_7(c,o,n,t,e,x,t);
  85     static const XMLCh Mapping[] =      UNICODE_LITERAL_7(M,a,p,p,i,n,g);
  86     static const XMLCh _relyingParty[] = UNICODE_LITERAL_12(r,e,l,y,i,n,g,P,a,r,t,y);
  87 };
  88
  89 void ArtifactMappings::removeMapping(const map<string,Mapping>::iterator& i)
  90 {
  91     // All elements in the secondary map whose key matches the expiration of the removed mapping.
  92     pair<multimap<time_t,string>::iterator,multimap<time_t,string>::iterator> range =
  93         m_expMap.equal_range(i->second.m_expires);
  94
  95     // Find an element in the matching range whose value matches the input key.
  96     multimap<time_t,string>::iterator el = find_if(
  97         range.first, range.second,
  98         (lambda::bind(&multimap<time_t,string>::value_type::second, _1) == boost::ref(i->first))
  99         );
 100     if (el != range.second) {
 101         m_expMap.erase(el);
 102     }
 103
 104     m_artMap.erase(i);
 105 }
 106
 107 void ArtifactMappings::storeContent(XMLObject* content, const SAMLArtifact* artifact, const char* relyingParty, int TTL)
 108 {
 109     Lock wrapper(m_lock);
 110
 111     // Garbage collect any expired artifacts.
 112     time_t now = time(nullptr);
 113     multimap<time_t,string>::iterator stop = m_expMap.upper_bound(now);
 114     for (multimap<time_t,string>::iterator i = m_expMap.begin(); i != stop; m_expMap.erase(i++)) {
 115         delete m_artMap[i->second].m_xml;
 116         m_artMap.erase(i->second);
 117     }
 118
 119     // Key is the hexed handle.
 120     string hexed = SAMLArtifact::toHex(artifact->getMessageHandle());
 121     Mapping& m = m_artMap[hexed];
 122     m.m_xml = content;
 123     if (relyingParty)
 124         m.m_relying = relyingParty;
 125     m.m_expires = now + TTL;
 126     m_expMap.insert(pair<const time_t, string>(m.m_expires, hexed));
 127 }
 128
 129 XMLObject* ArtifactMappings::retrieveContent(const SAMLArtifact* artifact, const char* relyingParty)
 130 {
 131     Category& log=Category::getInstance(SAML_LOGCAT ".ArtifactMap");
 132     Lock wrapper(m_lock);
 133
 134     map<string,Mapping>::iterator i = m_artMap.find(SAMLArtifact::toHex(artifact->getMessageHandle()));
 135     if (i == m_artMap.end())
 136         throw BindingException("Requested artifact not in map or may have expired.");
 137
 138     if (!(i->second.m_relying.empty())) {
 139         if (!relyingParty || i->second.m_relying != relyingParty) {
 140             log.warn(
 141                 "request from (%s) for artifact issued to (%s)",
 142                 relyingParty ? relyingParty : "unknown", i->second.m_relying.c_str()
 143                 );
 144             removeMapping(i);
 145             throw BindingException("Unauthorized artifact mapping request.");
 146         }
 147     }
 148
 149     if (time(nullptr) >= i->second.m_expires) {
 150         removeMapping(i);
 151         throw BindingException("Requested artifact has expired.");
 152     }
 153
 154     log.debug("resolved artifact for (%s)", relyingParty ? relyingParty : "unknown");
 155     XMLObject* ret = i->second.m_xml;
 156     i->second.m_xml = nullptr;  // clear member so it doesn't get deleted
 157     removeMapping(i);
 158     return ret;
 159 }
 160
 161 string ArtifactMappings::getRelyingParty(const SAMLArtifact* artifact)
 162 {
 163     map<string,Mapping>::iterator i = m_artMap.find(SAMLArtifact::toHex(artifact->getMessageHandle()));
 164     if (i == m_artMap.end())
 165         throw BindingException("Requested artifact not in map or may have expired.");
 166     return i->second.m_relying;
 167 }
 168
 169 ArtifactMap::ArtifactMap(xmltooling::StorageService* storage, const char* context, unsigned int artifactTTL)
 170     : m_storage(storage), m_context((context && *context) ? context : "opensaml::ArtifactMap"), m_artifactTTL(artifactTTL)
 171 {
 172     if (!m_storage)
 173         m_mappings.reset(new ArtifactMappings());
 174 }
 175
 176 ArtifactMap::ArtifactMap(const DOMElement* e, xmltooling::StorageService* storage)
 177     : m_storage(storage), m_artifactTTL(180)
 178 {
 179     if (e) {
 180         auto_ptr_char c(e->getAttributeNS(nullptr, context));
 181         if (c.get() && *c.get()) {
 182             m_context = c.get();
 183             if (storage && m_context.length() > m_storage->getCapabilities().getContextSize()) {
 184                 throw IOException("ArtifactMap context length exceeds capacity of storage service.");
 185             }
 186         }
 187         else {
 188             m_context = "opensaml::ArtifactMap";
 189         }
 190
 191         const XMLCh* TTL = e->getAttributeNS(nullptr, artifactTTL);
 192         if (TTL) {
 193             m_artifactTTL = XMLString::parseInt(TTL);
 194             if (!m_artifactTTL)
 195                 m_artifactTTL = 180;
 196         }
 197     }
 198
 199     if (!m_storage)
 200         m_mappings.reset(new ArtifactMappings());
 201 }
 202
 203 ArtifactMap::~ArtifactMap()
 204 {
 205 }
 206
 207 void ArtifactMap::storeContent(XMLObject* content, const SAMLArtifact* artifact, const char* relyingParty)
 208 {
 209     if (content->getParent())
 210         throw BindingException("Cannot store artifact mapping for XML content with parent.");
 211     else if (!m_storage)
 212         return m_mappings->storeContent(content, artifact, relyingParty, m_artifactTTL);
 213
 214     // Marshall with defaulted document, to reuse existing DOM and/or create a bound Document.
 215     DOMElement* root = content->marshall();
 216
 217     // Build a DOM with the same document to store the relyingParty mapping.
 218     if (relyingParty) {
 219         auto_ptr_XMLCh temp(relyingParty);
 220         root = root->getOwnerDocument()->createElementNS(nullptr,Mapping);
 221         root->setAttributeNS(nullptr,_relyingParty,temp.get());
 222         root->appendChild(content->getDOM());
 223     }
 224
 225     // Serialize the root element, whatever it is, for storage.
 226     string xmlbuf;
 227     XMLHelper::serialize(root, xmlbuf);
 228
 229     // Use hex form of message handler as storage key unless it's too big.
 230     string key = artifact->getMessageHandle();
 231     if (key.length() > m_storage->getCapabilities().getKeySize())
 232         key = SecurityHelper::doHash("SHA1", key.data(), key.length());
 233     else
 234         key = SAMLArtifact::toHex(key);
 235
 236     if (!m_storage->createText(
 237         m_context.c_str(),
 238         key.c_str(),
 239         xmlbuf.c_str(),
 240         time(nullptr) + m_artifactTTL
 241         )) {
 242         throw IOException("Attempt to insert duplicate artifact into map.");
 243     }
 244
 245     // Cleanup by destroying XML.
 246     delete content;
 247 }
 248
 249 XMLObject* ArtifactMap::retrieveContent(const SAMLArtifact* artifact, const char* relyingParty)
 250 {
 251 #ifdef _DEBUG
 252     xmltooling::NDC ndc("retrieveContent");
 253 #endif
 254     Category& log=Category::getInstance(SAML_LOGCAT ".ArtifactMap");
 255
 256     if (!m_storage)
 257         return m_mappings->retrieveContent(artifact, relyingParty);
 258
 259     // Use hex form of message handler as storage key unless it's too big.
 260     string key = artifact->getMessageHandle();
 261     if (key.length() > m_storage->getCapabilities().getKeySize())
 262         key = SecurityHelper::doHash("SHA1", key.data(), key.length());
 263     else
 264         key = SAMLArtifact::toHex(key);
 265
 266     // Read the mapping and then delete it.
 267     string xmlbuf;
 268     if (!m_storage->readText(m_context.c_str(), key.c_str(), &xmlbuf))
 269         throw BindingException("Artifact not found in mapping database.");
 270     m_storage->deleteText(m_context.c_str(), key.c_str());
 271
 272     // Parse the data back into XML.
 273     istringstream is(xmlbuf);
 274     DOMDocument* doc=XMLToolingConfig::getConfig().getParser().parse(is);
 275     XercesJanitor<DOMDocument> janitor(doc);
 276
 277     // Check the root element.
 278     DOMElement* messageRoot = doc->getDocumentElement();
 279     if (XMLHelper::isNodeNamed(messageRoot, nullptr, Mapping)) {
 280         auto_ptr_char temp(messageRoot->getAttributeNS(nullptr,_relyingParty));
 281         if (!relyingParty || strcmp(temp.get(),relyingParty)) {
 282             log.warn("request from (%s) for artifact issued to (%s)", relyingParty ? relyingParty : "unknown", temp.get());
 283             throw BindingException("Unauthorized artifact mapping request.");
 284         }
 285         messageRoot = XMLHelper::getFirstChildElement(messageRoot);
 286     }
 287
 288     // Unmarshall...
 289     XMLObject* xmlObject = XMLObjectBuilder::buildOneFromElement(messageRoot, true);    // bind document
 290     janitor.release();
 291
 292     log.debug("resolved artifact for (%s)", relyingParty ? relyingParty : "unknown");
 293     return xmlObject;
 294 }
 295
 296 string ArtifactMap::getRelyingParty(const SAMLArtifact* artifact)
 297 {
 298     if (!m_storage)
 299         return m_mappings->getRelyingParty(artifact);
 300
 301     // Use hex form of message handler as storage key unless it's too big.
 302     string key = artifact->getMessageHandle();
 303     if (key.length() > m_storage->getCapabilities().getKeySize())
 304         key = SecurityHelper::doHash("SHA1", key.data(), key.length());
 305     else
 306         key = SAMLArtifact::toHex(key);
 307
 308     string xmlbuf;
 309     if (!m_storage->readText(m_context.c_str(), key.c_str(), &xmlbuf))
 310         throw BindingException("Artifact not found in mapping database.");
 311
 312     // Parse the data back into XML.
 313     istringstream is(xmlbuf);
 314     DOMDocument* doc=XMLToolingConfig::getConfig().getParser().parse(is);
 315     XercesJanitor<DOMDocument> janitor(doc);
 316
 317     // Check the root element.
 318     DOMElement* messageRoot = doc->getDocumentElement();
 319     if (XMLHelper::isNodeNamed(messageRoot, nullptr, Mapping)) {
 320         auto_ptr_char temp(messageRoot->getAttributeNS(nullptr,_relyingParty));
 321         return temp.get();
 322     }
 323     return string();
 324 }