-/*
- * Copyright 2001-2007 Internet2
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-/**
- * StorageServiceSessionCache.cpp
- *
- * StorageService-based SessionCache implementation.
- *
- * Instead of optimizing this plugin with a buffering scheme that keeps objects around
- * and avoids extra parsing steps, I'm assuming that systems that require such can
- * layer their own cache plugin on top of this version either by delegating to it
- * or using the remoting support. So this version will load sessions directly
- * from the StorageService, instantiate enough to expose the Session API,
- * and then delete everything when they're unlocked. All data in memory is always
- * kept in sync with the StorageService (no lazy updates).
- */
-
-#include "internal.h"
-#include "Application.h"
-#include "exceptions.h"
-#include "ServiceProvider.h"
-#include "SessionCacheEx.h"
-#include "TransactionLog.h"
-#include "attribute/Attribute.h"
-#include "remoting/ListenerService.h"
-#include "util/SPConstants.h"
-
-#include <xmltooling/util/NDC.h>
-#include <xmltooling/util/XMLHelper.h>
-#include <xercesc/util/XMLUniDefs.hpp>
-
-#ifndef SHIBSP_LITE
-# include <saml/SAMLConfig.h>
-# include <xmltooling/util/StorageService.h>
-using namespace opensaml::saml2md;
-#else
-# include <ctime>
-# include <xmltooling/util/DateTime.h>
-#endif
-
-using namespace shibsp;
-using namespace opensaml;
-using namespace xmltooling;
-using namespace std;
-
-namespace shibsp {
-
- class StoredSession;
- class SSCache : public SessionCacheEx
-#ifndef SHIBSP_LITE
- ,public virtual Remoted
-#endif
- {
- public:
- SSCache(const DOMElement* e);
- ~SSCache();
-
-#ifndef SHIBSP_LITE
- void receive(DDF& in, ostream& out);
-
- void insert(
- const Application& application,
- const HTTPRequest& httpRequest,
- HTTPResponse& httpResponse,
- time_t expires,
- const saml2md::EntityDescriptor* issuer=NULL,
- const XMLCh* protocol=NULL,
- const saml2::NameID* nameid=NULL,
- const XMLCh* authn_instant=NULL,
- const XMLCh* session_index=NULL,
- const XMLCh* authncontext_class=NULL,
- const XMLCh* authncontext_decl=NULL,
- const vector<const Assertion*>* tokens=NULL,
- const vector<Attribute*>* attributes=NULL
- );
- vector<string>::size_type logout(
- const Application& application,
- const saml2md::EntityDescriptor* issuer,
- const saml2::NameID& nameid,
- const set<string>* indexes,
- time_t expires,
- vector<string>& sessions
- );
- bool matches(
- const Application& application,
- const xmltooling::HTTPRequest& request,
- const saml2md::EntityDescriptor* issuer,
- const saml2::NameID& nameid,
- const set<string>* indexes
- );
-#endif
- Session* find(const Application& application, const char* key, const char* client_addr=NULL, time_t* timeout=NULL);
- void remove(const Application& application, const char* key);
- void test();
-
- string active(const Application& application, const xmltooling::HTTPRequest& request) {
- pair<string,const char*> shib_cookie = application.getCookieNameProps("_shibsession_");
- const char* session_id = request.getCookie(shib_cookie.first.c_str());
- return (session_id ? session_id : "");
- }
-
- Session* find(const Application& application, const HTTPRequest& request, const char* client_addr=NULL, time_t* timeout=NULL) {
- string id = active(application, request);
- if (!id.empty())
- return find(application, id.c_str(), client_addr, timeout);
- return NULL;
- }
-
- void remove(const Application& application, const HTTPRequest& request, HTTPResponse* response=NULL) {
- pair<string,const char*> shib_cookie = application.getCookieNameProps("_shibsession_");
- const char* session_id = request.getCookie(shib_cookie.first.c_str());
- if (session_id && *session_id) {
- if (response)
- response->setCookie(shib_cookie.first.c_str(), shib_cookie.second);
- remove(application, session_id);
- }
- }
-
- void cleanup();
-
- Category& m_log;
- bool inproc;
- unsigned long m_cacheTimeout;
-#ifndef SHIBSP_LITE
- StorageService* m_storage;
-#endif
-
- private:
-#ifndef SHIBSP_LITE
- // maintain back-mappings of NameID/SessionIndex -> session key
- void insert(const char* key, time_t expires, const char* name, const char* index);
- bool stronglyMatches(const XMLCh* idp, const XMLCh* sp, const saml2::NameID& n1, const saml2::NameID& n2) const;
-#endif
-
- const DOMElement* m_root; // Only valid during initialization
- unsigned long m_inprocTimeout;
-
- // inproc means we buffer sessions in memory
- RWLock* m_lock;
- map<string,StoredSession*> m_hashtable;
-
- // management of buffered sessions
- void dormant(const char* key);
- static void* cleanup_fn(void*);
- bool shutdown;
- CondWait* shutdown_wait;
- Thread* cleanup_thread;
- };
-
- class StoredSession : public virtual Session
- {
- public:
- StoredSession(SSCache* cache, DDF& obj) : m_obj(obj),
-#ifndef SHIBSP_LITE
- m_nameid(NULL),
-#endif
- m_cache(cache), m_expires(0), m_lastAccess(time(NULL)), m_lock(NULL) {
- auto_ptr_XMLCh exp(m_obj["expires"].string());
- if (exp.get()) {
- DateTime iso(exp.get());
- iso.parseDateTime();
- m_expires = iso.getEpoch();
- }
-
-#ifndef SHIBSP_LITE
- const char* nameid = obj["nameid"].string();
- if (nameid) {
- // Parse and bind the document into an XMLObject.
- istringstream instr(nameid);
- DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(instr);
- XercesJanitor<DOMDocument> janitor(doc);
- auto_ptr<saml2::NameID> n(saml2::NameIDBuilder::buildNameID());
- n->unmarshall(doc->getDocumentElement(), true);
- janitor.release();
- m_nameid = n.release();
- }
-#endif
- if (cache->inproc)
- m_lock = Mutex::create();
- }
-
- ~StoredSession() {
- delete m_lock;
- m_obj.destroy();
- for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
-#ifndef SHIBSP_LITE
- delete m_nameid;
- for_each(m_tokens.begin(), m_tokens.end(), cleanup_pair<string,Assertion>());
-#endif
- }
-
- Lockable* lock() {
- if (m_lock)
- m_lock->lock();
- return this;
- }
- void unlock() {
- if (m_lock)
- m_lock->unlock();
- else
- delete this;
- }
-
- const char* getID() const {
- return m_obj.name();
- }
- const char* getApplicationID() const {
- return m_obj["application_id"].string();
- }
- const char* getClientAddress() const {
- return m_obj["client_addr"].string();
- }
- const char* getEntityID() const {
- return m_obj["entity_id"].string();
- }
- const char* getProtocol() const {
- return m_obj["protocol"].string();
- }
- const char* getAuthnInstant() const {
- return m_obj["authn_instant"].string();
- }
-#ifndef SHIBSP_LITE
- const saml2::NameID* getNameID() const {
- return m_nameid;
- }
-#endif
- const char* getSessionIndex() const {
- return m_obj["session_index"].string();
- }
- const char* getAuthnContextClassRef() const {
- return m_obj["authncontext_class"].string();
- }
- const char* getAuthnContextDeclRef() const {
- return m_obj["authncontext_decl"].string();
- }
- const vector<Attribute*>& getAttributes() const {
- if (m_attributes.empty())
- unmarshallAttributes();
- return m_attributes;
- }
- const multimap<string,const Attribute*>& getIndexedAttributes() const {
- if (m_attributeIndex.empty()) {
- if (m_attributes.empty())
- unmarshallAttributes();
- for (vector<Attribute*>::const_iterator a = m_attributes.begin(); a != m_attributes.end(); ++a) {
- const vector<string>& aliases = (*a)->getAliases();
- for (vector<string>::const_iterator alias = aliases.begin(); alias != aliases.end(); ++alias)
- m_attributeIndex.insert(multimap<string,const Attribute*>::value_type(*alias, *a));
- }
- }
- return m_attributeIndex;
- }
- const vector<const char*>& getAssertionIDs() const {
- if (m_ids.empty()) {
- DDF ids = m_obj["assertions"];
- DDF id = ids.first();
- while (id.isstring()) {
- m_ids.push_back(id.string());
- id = ids.next();
- }
- }
- return m_ids;
- }
-
- void validate(const Application& application, const char* client_addr, time_t* timeout);
-
-#ifndef SHIBSP_LITE
- void addAttributes(const vector<Attribute*>& attributes);
- const Assertion* getAssertion(const char* id) const;
- void addAssertion(Assertion* assertion);
-#endif
-
- time_t getExpiration() const { return m_expires; }
- time_t getLastAccess() const { return m_lastAccess; }
-
- private:
- void unmarshallAttributes() const;
-
- DDF m_obj;
-#ifndef SHIBSP_LITE
- saml2::NameID* m_nameid;
- mutable map<string,Assertion*> m_tokens;
-#endif
- mutable vector<Attribute*> m_attributes;
- mutable multimap<string,const Attribute*> m_attributeIndex;
- mutable vector<const char*> m_ids;
-
- SSCache* m_cache;
- time_t m_expires,m_lastAccess;
- Mutex* m_lock;
- };
-
- SessionCache* SHIBSP_DLLLOCAL StorageServiceCacheFactory(const DOMElement* const & e)
- {
- return new SSCache(e);
- }
-}
-
-void SHIBSP_API shibsp::registerSessionCaches()
-{
- SPConfig::getConfig().SessionCacheManager.registerFactory(STORAGESERVICE_SESSION_CACHE, StorageServiceCacheFactory);
-}
-
-void StoredSession::unmarshallAttributes() const
-{
- Attribute* attribute;
- DDF attrs = m_obj["attributes"];
- DDF attr = attrs.first();
- while (!attr.isnull()) {
- try {
- attribute = Attribute::unmarshall(attr);
- m_attributes.push_back(attribute);
- if (m_cache->m_log.isDebugEnabled())
- m_cache->m_log.debug("unmarshalled attribute (ID: %s) with %d value%s",
- attribute->getId(), attr.first().integer(), attr.first().integer()!=1 ? "s" : "");
- }
- catch (AttributeException& ex) {
- const char* id = attr.first().name();
- m_cache->m_log.error("error unmarshalling attribute (ID: %s): %s", id ? id : "none", ex.what());
- }
- attr = attrs.next();
- }
-}
-
-void StoredSession::validate(const Application& application, const char* client_addr, time_t* timeout)
-{
- time_t now = time(NULL);
-
- // Basic expiration?
- if (m_expires > 0) {
- if (now > m_expires) {
- m_cache->m_log.info("session expired (ID: %s)", getID());
- throw RetryableProfileException("Your session has expired, and you must re-authenticate.");
- }
- }
-
- // Address check?
- if (client_addr) {
- if (m_cache->m_log.isDebugEnabled())
- m_cache->m_log.debug("comparing client address %s against %s", client_addr, getClientAddress());
- if (!XMLString::equals(getClientAddress(),client_addr)) {
- m_cache->m_log.warn("client address mismatch");
- throw RetryableProfileException(
- "Your IP address ($1) does not match the address recorded at the time the session was established.",
- params(1,client_addr)
- );
- }
- }
-
- if (!timeout)
- return;
-
- if (!SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
- DDF in("touch::"STORAGESERVICE_SESSION_CACHE"::SessionCache"), out;
- DDFJanitor jin(in);
- in.structure();
- in.addmember("key").string(getID());
- in.addmember("version").integer(m_obj["version"].integer());
- if (*timeout) {
- // On 64-bit Windows, time_t doesn't fit in a long, so I'm using ISO timestamps.
-#ifndef HAVE_GMTIME_R
- struct tm* ptime=gmtime(timeout);
-#else
- struct tm res;
- struct tm* ptime=gmtime_r(timeout,&res);
-#endif
- char timebuf[32];
- strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);
- in.addmember("timeout").string(timebuf);
- }
-
- try {
- out=application.getServiceProvider().getListenerService()->send(in);
- }
- catch (...) {
- out.destroy();
- throw;
- }
-
- if (out.isstruct()) {
- // We got an updated record back.
- m_ids.clear();
- for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
- m_attributes.clear();
- m_attributeIndex.clear();
- m_obj.destroy();
- m_obj = out;
- }
- }
- else {
-#ifndef SHIBSP_LITE
- if (!m_cache->m_storage)
- throw ConfigurationException("Session touch requires a StorageService.");
-
- // Do a versioned read.
- string record;
- time_t lastAccess;
- int curver = m_obj["version"].integer();
- int ver = m_cache->m_storage->readText(getID(), "session", &record, &lastAccess, curver);
- if (ver == 0) {
- m_cache->m_log.warn("unsuccessful versioned read of session (ID: %s), cache out of sync?", getID());
- throw RetryableProfileException("Your session has expired, and you must re-authenticate.");
- }
-
- // Adjust for expiration to recover last access time and check timeout.
- lastAccess -= m_cache->m_cacheTimeout;
- if (*timeout > 0 && now - lastAccess >= *timeout) {
- m_cache->m_log.info("session timed out (ID: %s)", getID());
- throw RetryableProfileException("Your session has expired, and you must re-authenticate.");
- }
-
- // Update storage expiration, if possible.
- try {
- m_cache->m_storage->updateContext(getID(), now + m_cache->m_cacheTimeout);
- }
- catch (exception& ex) {
- m_cache->m_log.error("failed to update session expiration: %s", ex.what());
- }
-
- if (ver > curver) {
- // We got an updated record back.
- DDF newobj;
- istringstream in(record);
- in >> newobj;
- m_ids.clear();
- for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
- m_attributes.clear();
- m_attributeIndex.clear();
- m_obj.destroy();
- m_obj = newobj;
- }
-#else
- throw ConfigurationException("Session touch requires a StorageService.");
-#endif
- }
-
- m_lastAccess = now;
-}
-
-#ifndef SHIBSP_LITE
-
-void StoredSession::addAttributes(const vector<Attribute*>& attributes)
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("addAttributes");
-#endif
-
- if (!m_cache->m_storage)
- throw ConfigurationException("Session modification requires a StorageService.");
-
- m_cache->m_log.debug("adding attributes to session (%s)", getID());
-
- int ver;
- do {
- DDF attr;
- DDF attrs = m_obj["attributes"];
- if (!attrs.islist())
- attrs = m_obj.addmember("attributes").list();
- for (vector<Attribute*>::const_iterator a=attributes.begin(); a!=attributes.end(); ++a) {
- attr = (*a)->marshall();
- attrs.add(attr);
- }
-
- // Tentatively increment the version.
- m_obj["version"].integer(m_obj["version"].integer()+1);
-
- ostringstream str;
- str << m_obj;
- string record(str.str());
-
- try {
- ver = m_cache->m_storage->updateText(getID(), "session", record.c_str(), 0, m_obj["version"].integer()-1);
- }
- catch (exception&) {
- // Roll back modification to record.
- m_obj["version"].integer(m_obj["version"].integer()-1);
- vector<Attribute*>::size_type count = attributes.size();
- while (count--)
- attrs.last().destroy();
- throw;
- }
-
- if (ver <= 0) {
- // Roll back modification to record.
- m_obj["version"].integer(m_obj["version"].integer()-1);
- vector<Attribute*>::size_type count = attributes.size();
- while (count--)
- attrs.last().destroy();
- }
- if (!ver) {
- // Fatal problem with update.
- throw IOException("Unable to update stored session.");
- }
- else if (ver < 0) {
- // Out of sync.
- m_cache->m_log.warn("storage service indicates the record is out of sync, updating with a fresh copy...");
- ver = m_cache->m_storage->readText(getID(), "session", &record, NULL);
- if (!ver) {
- m_cache->m_log.error("readText failed on StorageService for session (%s)", getID());
- throw IOException("Unable to read back stored session.");
- }
-
- // Reset object.
- DDF newobj;
- istringstream in(record);
- in >> newobj;
-
- m_ids.clear();
- for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
- m_attributes.clear();
- m_attributeIndex.clear();
- newobj["version"].integer(ver);
- m_obj.destroy();
- m_obj = newobj;
-
- ver = -1;
- }
- } while (ver < 0); // negative indicates a sync issue so we retry
-
- TransactionLog* xlog = SPConfig::getConfig().getServiceProvider()->getTransactionLog();
- Locker locker(xlog);
- xlog->log.infoStream() <<
- "Added the following attributes to session (ID: " <<
- getID() <<
- ") for (applicationId: " <<
- m_obj["application_id"].string() <<
- ") {";
- for (vector<Attribute*>::const_iterator a=attributes.begin(); a!=attributes.end(); ++a)
- xlog->log.infoStream() << "\t" << (*a)->getId() << " (" << (*a)->valueCount() << " values)";
- xlog->log.info("}");
-
- // We own them now, so clean them up.
- for_each(attributes.begin(), attributes.end(), xmltooling::cleanup<Attribute>());
-}
-
-const Assertion* StoredSession::getAssertion(const char* id) const
-{
- if (!m_cache->m_storage)
- throw ConfigurationException("Assertion retrieval requires a StorageService.");
-
- map<string,Assertion*>::const_iterator i = m_tokens.find(id);
- if (i!=m_tokens.end())
- return i->second;
-
- string tokenstr;
- if (!m_cache->m_storage->readText(getID(), id, &tokenstr, NULL))
- throw FatalProfileException("Assertion not found in cache.");
-
- // Parse and bind the document into an XMLObject.
- istringstream instr(tokenstr);
- DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(instr);
- XercesJanitor<DOMDocument> janitor(doc);
- auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));
- janitor.release();
-
- Assertion* token = dynamic_cast<Assertion*>(xmlObject.get());
- if (!token)
- throw FatalProfileException("Request for cached assertion returned an unknown object type.");
-
- // Transfer ownership to us.
- xmlObject.release();
- m_tokens[id]=token;
- return token;
-}
-
-void StoredSession::addAssertion(Assertion* assertion)
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("addAssertion");
-#endif
-
- if (!m_cache->m_storage)
- throw ConfigurationException("Session modification requires a StorageService.");
-
- if (!assertion)
- throw FatalProfileException("Unknown object type passed to session for storage.");
-
- auto_ptr_char id(assertion->getID());
-
- m_cache->m_log.debug("adding assertion (%s) to session (%s)", id.get(), getID());
-
- time_t exp;
- if (!m_cache->m_storage->readText(getID(), "session", NULL, &exp))
- throw IOException("Unable to load expiration time for stored session.");
-
- ostringstream tokenstr;
- tokenstr << *assertion;
- if (!m_cache->m_storage->createText(getID(), id.get(), tokenstr.str().c_str(), exp))
- throw IOException("Attempted to insert duplicate assertion ID into session.");
-
- int ver;
- do {
- DDF token = DDF(NULL).string(id.get());
- m_obj["assertions"].add(token);
-
- // Tentatively increment the version.
- m_obj["version"].integer(m_obj["version"].integer()+1);
-
- ostringstream str;
- str << m_obj;
- string record(str.str());
-
- try {
- ver = m_cache->m_storage->updateText(getID(), "session", record.c_str(), 0, m_obj["version"].integer()-1);
- }
- catch (exception&) {
- token.destroy();
- m_obj["version"].integer(m_obj["version"].integer()-1);
- m_cache->m_storage->deleteText(getID(), id.get());
- throw;
- }
-
- if (ver <= 0) {
- token.destroy();
- m_obj["version"].integer(m_obj["version"].integer()-1);
- }
- if (!ver) {
- // Fatal problem with update.
- m_cache->m_log.error("updateText failed on StorageService for session (%s)", getID());
- m_cache->m_storage->deleteText(getID(), id.get());
- throw IOException("Unable to update stored session.");
- }
- else if (ver < 0) {
- // Out of sync.
- m_cache->m_log.warn("storage service indicates the record is out of sync, updating with a fresh copy...");
- ver = m_cache->m_storage->readText(getID(), "session", &record, NULL);
- if (!ver) {
- m_cache->m_log.error("readText failed on StorageService for session (%s)", getID());
- m_cache->m_storage->deleteText(getID(), id.get());
- throw IOException("Unable to read back stored session.");
- }
-
- // Reset object.
- DDF newobj;
- istringstream in(record);
- in >> newobj;
-
- m_ids.clear();
- for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
- m_attributes.clear();
- m_attributeIndex.clear();
- newobj["version"].integer(ver);
- m_obj.destroy();
- m_obj = newobj;
-
- ver = -1;
- }
- } while (ver < 0); // negative indicates a sync issue so we retry
-
- m_ids.clear();
- delete assertion;
-
- TransactionLog* xlog = SPConfig::getConfig().getServiceProvider()->getTransactionLog();
- Locker locker(xlog);
- xlog->log.info(
- "Added assertion (ID: %s) to session for (applicationId: %s) with (ID: %s)",
- id.get(), m_obj["application_id"].string(), getID()
- );
-}
-
-#endif
-
-SSCache::SSCache(const DOMElement* e)
- : m_log(Category::getInstance(SHIBSP_LOGCAT".SessionCache")), inproc(true), m_cacheTimeout(3600),
-#ifndef SHIBSP_LITE
- m_storage(NULL),
-#endif
- m_root(e), m_inprocTimeout(900), m_lock(NULL), shutdown(false), shutdown_wait(NULL), cleanup_thread(NULL)
-{
- static const XMLCh cacheTimeout[] = UNICODE_LITERAL_12(c,a,c,h,e,T,i,m,e,o,u,t);
- static const XMLCh inprocTimeout[] = UNICODE_LITERAL_13(i,n,p,r,o,c,T,i,m,e,o,u,t);
- static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);
-
- SPConfig& conf = SPConfig::getConfig();
- inproc = conf.isEnabled(SPConfig::InProcess);
-
- if (e) {
- const XMLCh* tag=e->getAttributeNS(NULL,cacheTimeout);
- if (tag && *tag) {
- m_cacheTimeout = XMLString::parseInt(tag);
- if (!m_cacheTimeout)
- m_cacheTimeout=3600;
- }
- if (inproc) {
- const XMLCh* tag=e->getAttributeNS(NULL,inprocTimeout);
- if (tag && *tag) {
- m_inprocTimeout = XMLString::parseInt(tag);
- if (!m_inprocTimeout)
- m_inprocTimeout=900;
- }
- }
- }
-
-#ifndef SHIBSP_LITE
- if (conf.isEnabled(SPConfig::OutOfProcess)) {
- const XMLCh* tag = e ? e->getAttributeNS(NULL,_StorageService) : NULL;
- if (tag && *tag) {
- auto_ptr_char ssid(tag);
- m_storage = conf.getServiceProvider()->getStorageService(ssid.get());
- if (m_storage)
- m_log.info("bound to StorageService (%s)", ssid.get());
- }
- if (!m_storage)
- throw ConfigurationException("SessionCache unable to locate StorageService, check configuration.");
- }
-#endif
-
- ListenerService* listener=conf.getServiceProvider()->getListenerService(false);
- if (inproc ) {
- if (!conf.isEnabled(SPConfig::OutOfProcess) && !listener)
- throw ConfigurationException("SessionCache requires a ListenerService, but none available.");
- m_lock = RWLock::create();
- shutdown_wait = CondWait::create();
- cleanup_thread = Thread::create(&cleanup_fn, (void*)this);
- }
-#ifndef SHIBSP_LITE
- else {
- if (listener && conf.isEnabled(SPConfig::OutOfProcess)) {
- listener->regListener("find::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);
- listener->regListener("remove::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);
- listener->regListener("touch::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);
- }
- else {
- m_log.info("no ListenerService available, cache remoting disabled");
- }
- }
-#endif
-}
-
-SSCache::~SSCache()
-{
- if (inproc) {
- // Shut down the cleanup thread and let it know...
- shutdown = true;
- shutdown_wait->signal();
- cleanup_thread->join(NULL);
-
- for_each(m_hashtable.begin(),m_hashtable.end(),cleanup_pair<string,StoredSession>());
- delete m_lock;
- delete shutdown_wait;
- }
-#ifndef SHIBSP_LITE
- else {
- SPConfig& conf = SPConfig::getConfig();
- ListenerService* listener=conf.getServiceProvider()->getListenerService(false);
- if (listener && conf.isEnabled(SPConfig::OutOfProcess)) {
- listener->unregListener("find::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);
- listener->unregListener("remove::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);
- listener->unregListener("touch::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);
- }
- }
-#endif
-}
-
-#ifndef SHIBSP_LITE
-
-void SSCache::test()
-{
- auto_ptr_char temp(SAMLConfig::getConfig().generateIdentifier());
- m_storage->createString("SessionCacheTest", temp.get(), "Test", time(NULL) + 60);
- m_storage->deleteString("SessionCacheTest", temp.get());
-}
-
-void SSCache::insert(const char* key, time_t expires, const char* name, const char* index)
-{
- string dup;
- if (strlen(name) > 255) {
- dup = string(name).substr(0,255);
- name = dup.c_str();
- }
-
- DDF obj;
- DDFJanitor jobj(obj);
-
- // Since we can't guarantee uniqueness, check for an existing record.
- string record;
- time_t recordexp;
- int ver = m_storage->readText("NameID", name, &record, &recordexp);
- if (ver > 0) {
- // Existing record, so we need to unmarshall it.
- istringstream in(record);
- in >> obj;
- }
- else {
- // New record.
- obj.structure();
- }
-
- if (!index || !*index)
- index = "_shibnull";
- DDF sessions = obj.addmember(index);
- if (!sessions.islist())
- sessions.list();
- DDF session = DDF(NULL).string(key);
- sessions.add(session);
-
- // Remarshall the record.
- ostringstream out;
- out << obj;
-
- // Try and store it back...
- if (ver > 0) {
- ver = m_storage->updateText("NameID", name, out.str().c_str(), max(expires, recordexp), ver);
- if (ver <= 0) {
- // Out of sync, or went missing, so retry.
- return insert(key, expires, name, index);
- }
- }
- else if (!m_storage->createText("NameID", name, out.str().c_str(), expires)) {
- // Hit a dup, so just retry, hopefully hitting the other branch.
- return insert(key, expires, name, index);
- }
-}
-
-void SSCache::insert(
- const Application& application,
- const HTTPRequest& httpRequest,
- HTTPResponse& httpResponse,
- time_t expires,
- const saml2md::EntityDescriptor* issuer,
- const XMLCh* protocol,
- const saml2::NameID* nameid,
- const XMLCh* authn_instant,
- const XMLCh* session_index,
- const XMLCh* authncontext_class,
- const XMLCh* authncontext_decl,
- const vector<const Assertion*>* tokens,
- const vector<Attribute*>* attributes
- )
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("insert");
-#endif
- if (!m_storage)
- throw ConfigurationException("SessionCache insertion requires a StorageService.");
-
- m_log.debug("creating new session");
-
- time_t now = time(NULL);
- auto_ptr_char index(session_index);
- auto_ptr_char entity_id(issuer ? issuer->getEntityID() : NULL);
- auto_ptr_char name(nameid ? nameid->getName() : NULL);
-
- if (nameid) {
- // Check for a pending logout.
- if (strlen(name.get()) > 255)
- const_cast<char*>(name.get())[255] = 0;
- string pending;
- int ver = m_storage->readText("Logout", name.get(), &pending);
- if (ver > 0) {
- DDF pendobj;
- DDFJanitor jpend(pendobj);
- istringstream pstr(pending);
- pstr >> pendobj;
- // IdP.SP.index contains logout expiration, if any.
- DDF deadmenwalking = pendobj[issuer ? entity_id.get() : "_shibnull"][application.getRelyingParty(issuer)->getString("entityID").second];
- const char* logexpstr = deadmenwalking[session_index ? index.get() : "_shibnull"].string();
- if (!logexpstr && session_index) // we tried an exact session match, now try for NULL
- logexpstr = deadmenwalking["_shibnull"].string();
- if (logexpstr) {
- auto_ptr_XMLCh dt(logexpstr);
- DateTime dtobj(dt.get());
- dtobj.parseDateTime();
- time_t logexp = dtobj.getEpoch();
- if (now - XMLToolingConfig::getConfig().clock_skew_secs < logexp)
- throw FatalProfileException("A logout message from your identity provider has blocked your login attempt.");
- }
- }
- }
-
- auto_ptr_char key(SAMLConfig::getConfig().generateIdentifier());
-
- // Store session properties in DDF.
- DDF obj = DDF(key.get()).structure();
- obj.addmember("version").integer(1);
- obj.addmember("application_id").string(application.getId());
-
- // On 64-bit Windows, time_t doesn't fit in a long, so I'm using ISO timestamps.
-#ifndef HAVE_GMTIME_R
- struct tm* ptime=gmtime(&expires);
-#else
- struct tm res;
- struct tm* ptime=gmtime_r(&expires,&res);
-#endif
- char timebuf[32];
- strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);
- obj.addmember("expires").string(timebuf);
-
- obj.addmember("client_addr").string(httpRequest.getRemoteAddr().c_str());
- if (issuer)
- obj.addmember("entity_id").string(entity_id.get());
- if (protocol) {
- auto_ptr_char prot(protocol);
- obj.addmember("protocol").string(prot.get());
- }
- if (authn_instant) {
- auto_ptr_char instant(authn_instant);
- obj.addmember("authn_instant").string(instant.get());
- }
- if (session_index)
- obj.addmember("session_index").string(index.get());
- if (authncontext_class) {
- auto_ptr_char ac(authncontext_class);
- obj.addmember("authncontext_class").string(ac.get());
- }
- if (authncontext_decl) {
- auto_ptr_char ad(authncontext_decl);
- obj.addmember("authncontext_decl").string(ad.get());
- }
-
- if (nameid) {
- ostringstream namestr;
- namestr << *nameid;
- obj.addmember("nameid").string(namestr.str().c_str());
- }
-
- if (tokens) {
- obj.addmember("assertions").list();
- for (vector<const Assertion*>::const_iterator t = tokens->begin(); t!=tokens->end(); ++t) {
- auto_ptr_char tokenid((*t)->getID());
- DDF tokid = DDF(NULL).string(tokenid.get());
- obj["assertions"].add(tokid);
- }
- }
-
- if (attributes) {
- DDF attr;
- DDF attrlist = obj.addmember("attributes").list();
- for (vector<Attribute*>::const_iterator a=attributes->begin(); a!=attributes->end(); ++a) {
- attr = (*a)->marshall();
- attrlist.add(attr);
- }
- }
-
- ostringstream record;
- record << obj;
-
- m_log.debug("storing new session...");
- if (!m_storage->createText(key.get(), "session", record.str().c_str(), now + m_cacheTimeout))
- throw FatalProfileException("Attempted to create a session with a duplicate key.");
-
- // Store the reverse mapping for logout.
- try {
- if (nameid)
- insert(key.get(), expires, name.get(), index.get());
- }
- catch (exception& ex) {
- m_log.error("error storing back mapping of NameID for logout: %s", ex.what());
- }
-
- if (tokens) {
- try {
- for (vector<const Assertion*>::const_iterator t = tokens->begin(); t!=tokens->end(); ++t) {
- ostringstream tokenstr;
- tokenstr << *(*t);
- auto_ptr_char tokenid((*t)->getID());
- if (!m_storage->createText(key.get(), tokenid.get(), tokenstr.str().c_str(), now + m_cacheTimeout))
- throw IOException("duplicate assertion ID ($1)", params(1, tokenid.get()));
- }
- }
- catch (exception& ex) {
- m_log.error("error storing assertion along with session: %s", ex.what());
- }
- }
-
- const char* pid = obj["entity_id"].string();
- const char* prot = obj["protocol"].string();
- m_log.info("new session created: ID (%s) IdP (%s) Protocol(%s) Address (%s)",
- key.get(), pid ? pid : "none", prot ? prot : "none", httpRequest.getRemoteAddr().c_str());
-
- // Transaction Logging
- TransactionLog* xlog = application.getServiceProvider().getTransactionLog();
- Locker locker(xlog);
- xlog->log.infoStream() <<
- "New session (ID: " <<
- key.get() <<
- ") with (applicationId: " <<
- application.getId() <<
- ") for principal from (IdP: " <<
- (pid ? pid : "none") <<
- ") at (ClientAddress: " <<
- httpRequest.getRemoteAddr() <<
- ") with (NameIdentifier: " <<
- (nameid ? name.get() : "none") <<
- ") using (Protocol: " <<
- (prot ? prot : "none") <<
- ")";
-
- if (attributes) {
- xlog->log.infoStream() <<
- "Cached the following attributes with session (ID: " <<
- key.get() <<
- ") for (applicationId: " <<
- application.getId() <<
- ") {";
- for (vector<Attribute*>::const_iterator a=attributes->begin(); a!=attributes->end(); ++a)
- xlog->log.infoStream() << "\t" << (*a)->getId() << " (" << (*a)->valueCount() << " values)";
- xlog->log.info("}");
- }
-
- pair<string,const char*> shib_cookie = application.getCookieNameProps("_shibsession_");
- string k(key.get());
- k += shib_cookie.second;
- httpResponse.setCookie(shib_cookie.first.c_str(), k.c_str());
-}
-
-bool SSCache::matches(
- const Application& application,
- const xmltooling::HTTPRequest& request,
- const saml2md::EntityDescriptor* issuer,
- const saml2::NameID& nameid,
- const set<string>* indexes
- )
-{
- auto_ptr_char entityID(issuer ? issuer->getEntityID() : NULL);
- try {
- Session* session = find(application, request);
- if (session) {
- Locker locker(session, false);
- if (XMLString::equals(session->getEntityID(), entityID.get()) && session->getNameID() &&
- stronglyMatches(issuer->getEntityID(), application.getRelyingParty(issuer)->getXMLString("entityID").second, nameid, *session->getNameID())) {
- return (!indexes || indexes->empty() || (session->getSessionIndex() ? (indexes->count(session->getSessionIndex())>0) : false));
- }
- }
- }
- catch (exception& ex) {
- m_log.error("error while matching session: %s", ex.what());
- }
- return false;
-}
-
-vector<string>::size_type SSCache::logout(
- const Application& application,
- const saml2md::EntityDescriptor* issuer,
- const saml2::NameID& nameid,
- const set<string>* indexes,
- time_t expires,
- vector<string>& sessionsKilled
- )
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("logout");
-#endif
-
- if (!m_storage)
- throw ConfigurationException("SessionCache insertion requires a StorageService.");
-
- auto_ptr_char entityID(issuer ? issuer->getEntityID() : NULL);
- auto_ptr_char name(nameid.getName());
-
- m_log.info("request to logout sessions from (%s) for (%s)", entityID.get() ? entityID.get() : "unknown", name.get());
-
- if (strlen(name.get()) > 255)
- const_cast<char*>(name.get())[255] = 0;
-
- DDF obj;
- DDFJanitor jobj(obj);
- string record;
- int ver;
-
- if (expires) {
- // Record the logout to prevent post-delivered assertions.
- // On 64-bit Windows, time_t doesn't fit in a long, so I'm using ISO timestamps.
-#ifndef HAVE_GMTIME_R
- struct tm* ptime=gmtime(&expires);
-#else
- struct tm res;
- struct tm* ptime=gmtime_r(&expires,&res);
-#endif
- char timebuf[32];
- strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);
-
- time_t oldexp = 0;
- ver = m_storage->readText("Logout", name.get(), &record, &oldexp);
- if (ver > 0) {
- istringstream lin(record);
- lin >> obj;
- }
- else {
- obj = DDF(NULL).structure();
- }
-
- // Structure is keyed by the IdP and SP, with a member per session index containing the expiration.
- DDF root = obj.addmember(issuer ? entityID.get() : "_shibnull").addmember(application.getRelyingParty(issuer)->getString("entityID").second);
- if (indexes) {
- for (set<string>::const_iterator x = indexes->begin(); x!=indexes->end(); ++x)
- root.addmember(x->c_str()).string(timebuf);
- }
- else {
- root.addmember("_shibnull").string(timebuf);
- }
-
- // Write it back.
- ostringstream lout;
- lout << obj;
-
- if (ver > 0) {
- ver = m_storage->updateText("Logout", name.get(), lout.str().c_str(), max(expires, oldexp), ver);
- if (ver <= 0) {
- // Out of sync, or went missing, so retry.
- return logout(application, issuer, nameid, indexes, expires, sessionsKilled);
- }
- }
- else if (!m_storage->createText("Logout", name.get(), lout.str().c_str(), expires)) {
- // Hit a dup, so just retry, hopefully hitting the other branch.
- return logout(application, issuer, nameid, indexes, expires, sessionsKilled);
- }
-
- obj.destroy();
- record.erase();
- }
-
- // Read in potentially matching sessions.
- ver = m_storage->readText("NameID", name.get(), &record);
- if (ver == 0) {
- m_log.debug("no active sessions to logout for supplied issuer and subject");
- return 0;
- }
-
- istringstream in(record);
- in >> obj;
-
- // The record contains child lists for each known session index.
- DDF key;
- DDF sessions = obj.first();
- while (sessions.islist()) {
- if (!indexes || indexes->empty() || indexes->count(sessions.name())) {
- key = sessions.first();
- while (key.isstring()) {
- // Fetch the session for comparison.
- Session* session = NULL;
- try {
- session = find(application, key.string());
- }
- catch (exception& ex) {
- m_log.error("error locating session (%s): %s", key.string(), ex.what());
- }
-
- if (session) {
- Locker locker(session, false);
- // Same issuer?
- if (XMLString::equals(session->getEntityID(), entityID.get())) {
- // Same NameID?
- if (stronglyMatches(issuer->getEntityID(), application.getRelyingParty(issuer)->getXMLString("entityID").second, nameid, *session->getNameID())) {
- sessionsKilled.push_back(key.string());
- key.destroy();
- }
- else {
- m_log.debug("session (%s) contained a non-matching NameID, leaving it alone", key.string());
- }
- }
- else {
- m_log.debug("session (%s) established by different IdP, leaving it alone", key.string());
- }
- }
- else {
- // Session's gone, so...
- sessionsKilled.push_back(key.string());
- key.destroy();
- }
- key = sessions.next();
- }
-
- // No sessions left for this index?
- if (sessions.first().isnull())
- sessions.destroy();
- }
- sessions = obj.next();
- }
-
- if (obj.first().isnull())
- obj.destroy();
-
- // If possible, write back the mapping record (this isn't crucial).
- try {
- if (obj.isnull()) {
- m_storage->deleteText("NameID", name.get());
- }
- else if (!sessionsKilled.empty()) {
- ostringstream out;
- out << obj;
- if (m_storage->updateText("NameID", name.get(), out.str().c_str(), 0, ver) <= 0)
- m_log.warn("logout mapping record changed behind us, leaving it alone");
- }
- }
- catch (exception& ex) {
- m_log.error("error updating logout mapping record: %s", ex.what());
- }
-
- return sessionsKilled.size();
-}
-
-bool SSCache::stronglyMatches(const XMLCh* idp, const XMLCh* sp, const saml2::NameID& n1, const saml2::NameID& n2) const
-{
- if (!XMLString::equals(n1.getName(), n2.getName()))
- return false;
-
- const XMLCh* s1 = n1.getFormat();
- const XMLCh* s2 = n2.getFormat();
- if (!s1 || !*s1)
- s1 = saml2::NameID::UNSPECIFIED;
- if (!s2 || !*s2)
- s2 = saml2::NameID::UNSPECIFIED;
- if (!XMLString::equals(s1,s2))
- return false;
-
- s1 = n1.getNameQualifier();
- s2 = n2.getNameQualifier();
- if (!s1 || !*s1)
- s1 = idp;
- if (!s2 || !*s2)
- s2 = idp;
- if (!XMLString::equals(s1,s2))
- return false;
-
- s1 = n1.getSPNameQualifier();
- s2 = n2.getSPNameQualifier();
- if (!s1 || !*s1)
- s1 = sp;
- if (!s2 || !*s2)
- s2 = sp;
- if (!XMLString::equals(s1,s2))
- return false;
-
- return true;
-}
-
-#endif
-
-Session* SSCache::find(const Application& application, const char* key, const char* client_addr, time_t* timeout)
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("find");
-#endif
- StoredSession* session=NULL;
-
- if (inproc) {
- m_log.debug("searching local cache for session (%s)", key);
- m_lock->rdlock();
- map<string,StoredSession*>::const_iterator i=m_hashtable.find(key);
- if (i!=m_hashtable.end()) {
- // Save off and lock the session.
- session = i->second;
- session->lock();
- m_lock->unlock();
- m_log.debug("session found locally, validating it for use");
- }
- else {
- m_lock->unlock();
- }
- }
-
- if (!session) {
- if (!SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
- m_log.debug("session not found locally, remoting the search");
- // Remote the request.
- DDF in("find::"STORAGESERVICE_SESSION_CACHE"::SessionCache"), out;
- DDFJanitor jin(in);
- in.structure();
- in.addmember("key").string(key);
- in.addmember("application_id").string(application.getId());
- if (timeout && *timeout) {
- // On 64-bit Windows, time_t doesn't fit in a long, so I'm using ISO timestamps.
-#ifndef HAVE_GMTIME_R
- struct tm* ptime=gmtime(timeout);
-#else
- struct tm res;
- struct tm* ptime=gmtime_r(timeout,&res);
-#endif
- char timebuf[32];
- strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);
- in.addmember("timeout").string(timebuf);
- }
-
- try {
- out=application.getServiceProvider().getListenerService()->send(in);
- if (!out.isstruct()) {
- out.destroy();
- m_log.debug("session not found in remote cache");
- return NULL;
- }
-
- // Wrap the results in a local entry and save it.
- session = new StoredSession(this, out);
- // The remote end has handled timeout issues, we handle address and expiration checks.
- timeout = NULL;
- }
- catch (...) {
- out.destroy();
- throw;
- }
- }
- else {
- // We're out of process, so we can search the storage service directly.
-#ifndef SHIBSP_LITE
- if (!m_storage)
- throw ConfigurationException("SessionCache lookup requires a StorageService.");
-
- m_log.debug("searching for session (%s)", key);
-
- DDF obj;
- time_t lastAccess;
- string record;
- int ver = m_storage->readText(key, "session", &record, &lastAccess);
- if (!ver)
- return NULL;
-
- m_log.debug("reconstituting session and checking validity");
-
- istringstream in(record);
- in >> obj;
-
- lastAccess -= m_cacheTimeout; // adjusts it back to the last time the record's timestamp was touched
- time_t now=time(NULL);
-
- if (timeout && *timeout > 0 && now - lastAccess >= *timeout) {
- m_log.info("session timed out (ID: %s)", key);
- remove(application, key);
- const char* eid = obj["entity_id"].string();
- if (!eid) {
- obj.destroy();
- throw RetryableProfileException("Your session has expired, and you must re-authenticate.");
- }
- string eid2(eid);
- obj.destroy();
- throw RetryableProfileException("Your session has expired, and you must re-authenticate.", namedparams(1, "entityID", eid2.c_str()));
- }
-
- if (timeout) {
- // Update storage expiration, if possible.
- try {
- m_storage->updateContext(key, now + m_cacheTimeout);
- }
- catch (exception& ex) {
- m_log.error("failed to update session expiration: %s", ex.what());
- }
- }
-
- // Wrap the results in a local entry and save it.
- session = new StoredSession(this, obj);
- // We handled timeout issues, still need to handle address and expiration checks.
- timeout = NULL;
-#else
- throw ConfigurationException("SessionCache search requires a StorageService.");
-#endif
- }
-
- if (inproc) {
- // Lock for writing and repeat the search to avoid duplication.
- m_lock->wrlock();
- SharedLock shared(m_lock, false);
- if (m_hashtable.count(key)) {
- // We're using an existing session entry.
- delete session;
- session = m_hashtable[key];
- session->lock();
- }
- else {
- m_hashtable[key]=session;
- session->lock();
- }
- }
- }
-
- if (!XMLString::equals(session->getApplicationID(), application.getId())) {
- m_log.error("an application (%s) tried to access another application's session", application.getId());
- session->unlock();
- return NULL;
- }
-
- // Verify currency and update the timestamp if indicated by caller.
- try {
- session->validate(application, client_addr, timeout);
- }
- catch (...) {
- session->unlock();
- remove(application, key);
- throw;
- }
-
- return session;
-}
-
-void SSCache::remove(const Application& application, const char* key)
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("remove");
-#endif
- // Take care of local copy.
- if (inproc)
- dormant(key);
-
- if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {
- // Remove the session from storage directly.
-#ifndef SHIBSP_LITE
- m_storage->deleteContext(key);
- m_log.info("removed session (%s)", key);
-
- TransactionLog* xlog = application.getServiceProvider().getTransactionLog();
- Locker locker(xlog);
- xlog->log.info("Destroyed session (applicationId: %s) (ID: %s)", application.getId(), key);
-#else
- throw ConfigurationException("SessionCache removal requires a StorageService.");
-#endif
- }
- else {
- // Remote the request.
- DDF in("remove::"STORAGESERVICE_SESSION_CACHE"::SessionCache");
- DDFJanitor jin(in);
- in.structure();
- in.addmember("key").string(key);
- in.addmember("application_id").string(application.getId());
-
- DDF out = application.getServiceProvider().getListenerService()->send(in);
- out.destroy();
- }
-}
-
-void SSCache::dormant(const char* key)
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("dormant");
-#endif
-
- m_log.debug("deleting local copy of session (%s)", key);
-
- // lock the cache for writing, which means we know nobody is sitting in find()
- m_lock->wrlock();
-
- // grab the entry from the table
- map<string,StoredSession*>::const_iterator i=m_hashtable.find(key);
- if (i==m_hashtable.end()) {
- m_lock->unlock();
- return;
- }
-
- // ok, remove the entry and lock it
- StoredSession* entry=i->second;
- m_hashtable.erase(key);
- entry->lock();
-
- // unlock the cache
- m_lock->unlock();
-
- // we can release the cache entry lock because we know we're not in the cache anymore
- entry->unlock();
-
- delete entry;
-}
-
-void SSCache::cleanup()
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("cleanup");
-#endif
-
- Mutex* mutex = Mutex::create();
-
- // Load our configuration details...
- static const XMLCh cleanupInterval[] = UNICODE_LITERAL_15(c,l,e,a,n,u,p,I,n,t,e,r,v,a,l);
- const XMLCh* tag=m_root ? m_root->getAttributeNS(NULL,cleanupInterval) : NULL;
- int rerun_timer = 900;
- if (tag && *tag)
- rerun_timer = XMLString::parseInt(tag);
- if (rerun_timer <= 0)
- rerun_timer = 900;
-
- mutex->lock();
-
- m_log.info("cleanup thread started...run every %d secs; timeout after %d secs", rerun_timer, m_inprocTimeout);
-
- while (!shutdown) {
- shutdown_wait->timedwait(mutex,rerun_timer);
- if (shutdown)
- break;
-
- // Ok, let's run through the cleanup process and clean out
- // really old sessions. This is a two-pass process. The
- // first pass is done holding a read-lock while we iterate over
- // the cache. The second pass doesn't need a lock because
- // the 'deletes' will lock the cache.
-
- // Pass 1: iterate over the map and find all entries that have not been
- // used in the allotted timeout.
- vector<string> stale_keys;
- time_t stale = time(NULL) - m_inprocTimeout;
-
- m_log.debug("cleanup thread running");
-
- m_lock->rdlock();
- for (map<string,StoredSession*>::const_iterator i=m_hashtable.begin(); i!=m_hashtable.end(); ++i) {
- // If the last access was BEFORE the stale timeout...
- i->second->lock();
- time_t last=i->second->getLastAccess();
- i->second->unlock();
- if (last < stale)
- stale_keys.push_back(i->first);
- }
- m_lock->unlock();
-
- if (!stale_keys.empty()) {
- m_log.info("purging %d old sessions", stale_keys.size());
-
- // Pass 2: walk through the list of stale entries and remove them from the cache
- for (vector<string>::const_iterator j = stale_keys.begin(); j != stale_keys.end(); ++j)
- dormant(j->c_str());
- }
-
- m_log.debug("cleanup thread completed");
- }
-
- m_log.info("cleanup thread exiting");
-
- mutex->unlock();
- delete mutex;
- Thread::exit(NULL);
-}
-
-void* SSCache::cleanup_fn(void* cache_p)
-{
-#ifndef WIN32
- // First, let's block all signals
- Thread::mask_all_signals();
-#endif
-
- // Now run the cleanup process.
- reinterpret_cast<SSCache*>(cache_p)->cleanup();
- return NULL;
-}
-
-#ifndef SHIBSP_LITE
-
-void SSCache::receive(DDF& in, ostream& out)
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("receive");
-#endif
-
- if (!strcmp(in.name(),"find::"STORAGESERVICE_SESSION_CACHE"::SessionCache")) {
- const char* key=in["key"].string();
- if (!key)
- throw ListenerException("Required parameters missing for session lookup.");
-
- const Application* app = SPConfig::getConfig().getServiceProvider()->getApplication(in["application_id"].string());
- if (!app)
- throw ListenerException("Application not found, check configuration?");
-
- // Do an unversioned read.
- string record;
- time_t lastAccess;
- if (!m_storage->readText(key, "session", &record, &lastAccess)) {
- DDF ret(NULL);
- DDFJanitor jan(ret);
- out << ret;
- return;
- }
-
- // Adjust for expiration to recover last access time and check timeout.
- lastAccess -= m_cacheTimeout;
- time_t now=time(NULL);
-
- // See if we need to check for a timeout.
- if (in["timeout"].string()) {
- time_t timeout = 0;
- auto_ptr_XMLCh dt(in["timeout"].string());
- DateTime dtobj(dt.get());
- dtobj.parseDateTime();
- timeout = dtobj.getEpoch();
-
- if (timeout > 0 && now - lastAccess >= timeout) {
- m_log.info("session timed out (ID: %s)", key);
- remove(*app, key);
- throw RetryableProfileException("Your session has expired, and you must re-authenticate.");
- }
-
- // Update storage expiration, if possible.
- try {
- m_storage->updateContext(key, now + m_cacheTimeout);
- }
- catch (exception& ex) {
- m_log.error("failed to update session expiration: %s", ex.what());
- }
- }
-
- // Send the record back.
- out << record;
- }
- else if (!strcmp(in.name(),"touch::"STORAGESERVICE_SESSION_CACHE"::SessionCache")) {
- const char* key=in["key"].string();
- if (!key)
- throw ListenerException("Required parameters missing for session check.");
-
- // Do a versioned read.
- string record;
- time_t lastAccess;
- int curver = in["version"].integer();
- int ver = m_storage->readText(key, "session", &record, &lastAccess, curver);
- if (ver == 0) {
- m_log.warn("unsuccessful versioned read of session (ID: %s), caches out of sync?", key);
- throw RetryableProfileException("Your session has expired, and you must re-authenticate.");
- }
-
- // Adjust for expiration to recover last access time and check timeout.
- lastAccess -= m_cacheTimeout;
- time_t now=time(NULL);
-
- // See if we need to check for a timeout.
- time_t timeout = 0;
- auto_ptr_XMLCh dt(in["timeout"].string());
- if (dt.get()) {
- DateTime dtobj(dt.get());
- dtobj.parseDateTime();
- timeout = dtobj.getEpoch();
- }
-
- if (timeout > 0 && now - lastAccess >= timeout) {
- m_log.info("session timed out (ID: %s)", key);
- throw RetryableProfileException("Your session has expired, and you must re-authenticate.");
- }
-
- // Update storage expiration, if possible.
- try {
- m_storage->updateContext(key, now + m_cacheTimeout);
- }
- catch (exception& ex) {
- m_log.error("failed to update session expiration: %s", ex.what());
- }
-
- if (ver > curver) {
- // Send the record back.
- out << record;
- }
- else {
- DDF ret(NULL);
- DDFJanitor jan(ret);
- out << ret;
- }
- }
- else if (!strcmp(in.name(),"remove::"STORAGESERVICE_SESSION_CACHE"::SessionCache")) {
- const char* key=in["key"].string();
- if (!key)
- throw ListenerException("Required parameter missing for session removal.");
-
- const Application* app = SPConfig::getConfig().getServiceProvider()->getApplication(in["application_id"].string());
- if (!app)
- throw ConfigurationException("Application not found, check configuration?");
-
- remove(*app, key);
- DDF ret(NULL);
- DDFJanitor jan(ret);
- out << ret;
- }
-}
-
-#endif
+/*\r
+ * Copyright 2001-2007 Internet2\r
+ * \r
+ * Licensed under the Apache License, Version 2.0 (the "License");\r
+ * you may not use this file except in compliance with the License.\r
+ * You may obtain a copy of the License at\r
+ *\r
+ * http://www.apache.org/licenses/LICENSE-2.0\r
+ *\r
+ * Unless required by applicable law or agreed to in writing, software\r
+ * distributed under the License is distributed on an "AS IS" BASIS,\r
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
+ * See the License for the specific language governing permissions and\r
+ * limitations under the License.\r
+ */\r
+\r
+/**\r
+ * StorageServiceSessionCache.cpp\r
+ * \r
+ * StorageService-based SessionCache implementation.\r
+ * \r
+ * Instead of optimizing this plugin with a buffering scheme that keeps objects around\r
+ * and avoids extra parsing steps, I'm assuming that systems that require such can\r
+ * layer their own cache plugin on top of this version either by delegating to it\r
+ * or using the remoting support. So this version will load sessions directly\r
+ * from the StorageService, instantiate enough to expose the Session API,\r
+ * and then delete everything when they're unlocked. All data in memory is always\r
+ * kept in sync with the StorageService (no lazy updates).\r
+ */\r
+\r
+#include "internal.h"\r
+#include "Application.h"\r
+#include "exceptions.h"\r
+#include "ServiceProvider.h"\r
+#include "SessionCacheEx.h"\r
+#include "TransactionLog.h"\r
+#include "attribute/Attribute.h"\r
+#include "remoting/ListenerService.h"\r
+#include "util/SPConstants.h"\r
+\r
+#include <xmltooling/util/NDC.h>\r
+#include <xmltooling/util/XMLHelper.h>\r
+#include <xercesc/util/XMLUniDefs.hpp>\r
+\r
+#ifndef SHIBSP_LITE\r
+# include <saml/SAMLConfig.h>\r
+# include <xmltooling/util/StorageService.h>\r
+using namespace opensaml::saml2md;\r
+#else\r
+# include <ctime>\r
+# include <xmltooling/util/DateTime.h>\r
+#endif\r
+\r
+using namespace shibsp;\r
+using namespace opensaml;\r
+using namespace xmltooling;\r
+using namespace std;\r
+\r
+namespace shibsp {\r
+\r
+ class StoredSession;\r
+ class SSCache : public SessionCacheEx\r
+#ifndef SHIBSP_LITE\r
+ ,public virtual Remoted\r
+#endif\r
+ {\r
+ public:\r
+ SSCache(const DOMElement* e);\r
+ ~SSCache();\r
+\r
+#ifndef SHIBSP_LITE\r
+ void receive(DDF& in, ostream& out);\r
+\r
+ void insert(\r
+ const Application& application,\r
+ const HTTPRequest& httpRequest,\r
+ HTTPResponse& httpResponse,\r
+ time_t expires,\r
+ const saml2md::EntityDescriptor* issuer=NULL,\r
+ const XMLCh* protocol=NULL,\r
+ const saml2::NameID* nameid=NULL,\r
+ const XMLCh* authn_instant=NULL,\r
+ const XMLCh* session_index=NULL,\r
+ const XMLCh* authncontext_class=NULL,\r
+ const XMLCh* authncontext_decl=NULL,\r
+ const vector<const Assertion*>* tokens=NULL,\r
+ const vector<Attribute*>* attributes=NULL\r
+ );\r
+ vector<string>::size_type logout(\r
+ const Application& application,\r
+ const saml2md::EntityDescriptor* issuer,\r
+ const saml2::NameID& nameid,\r
+ const set<string>* indexes,\r
+ time_t expires,\r
+ vector<string>& sessions\r
+ );\r
+ bool matches(\r
+ const Application& application,\r
+ const xmltooling::HTTPRequest& request,\r
+ const saml2md::EntityDescriptor* issuer,\r
+ const saml2::NameID& nameid,\r
+ const set<string>* indexes\r
+ );\r
+#endif\r
+ Session* find(const Application& application, const char* key, const char* client_addr=NULL, time_t* timeout=NULL);\r
+ void remove(const Application& application, const char* key);\r
+ void test();\r
+\r
+ string active(const Application& application, const xmltooling::HTTPRequest& request) {\r
+ pair<string,const char*> shib_cookie = application.getCookieNameProps("_shibsession_");\r
+ const char* session_id = request.getCookie(shib_cookie.first.c_str());\r
+ return (session_id ? session_id : "");\r
+ }\r
+\r
+ Session* find(const Application& application, const HTTPRequest& request, const char* client_addr=NULL, time_t* timeout=NULL) {\r
+ string id = active(application, request);\r
+ if (!id.empty())\r
+ return find(application, id.c_str(), client_addr, timeout);\r
+ return NULL;\r
+ }\r
+\r
+ void remove(const Application& application, const HTTPRequest& request, HTTPResponse* response=NULL) {\r
+ pair<string,const char*> shib_cookie = application.getCookieNameProps("_shibsession_");\r
+ const char* session_id = request.getCookie(shib_cookie.first.c_str());\r
+ if (session_id && *session_id) {\r
+ if (response)\r
+ response->setCookie(shib_cookie.first.c_str(), shib_cookie.second);\r
+ remove(application, session_id);\r
+ }\r
+ }\r
+\r
+ void cleanup();\r
+\r
+ Category& m_log;\r
+ bool inproc;\r
+ unsigned long m_cacheTimeout;\r
+#ifndef SHIBSP_LITE\r
+ StorageService* m_storage;\r
+ StorageService* m_storage_lite;\r
+#endif\r
+\r
+ private:\r
+#ifndef SHIBSP_LITE\r
+ // maintain back-mappings of NameID/SessionIndex -> session key\r
+ void insert(const char* key, time_t expires, const char* name, const char* index);\r
+ bool stronglyMatches(const XMLCh* idp, const XMLCh* sp, const saml2::NameID& n1, const saml2::NameID& n2) const;\r
+#endif\r
+\r
+ const DOMElement* m_root; // Only valid during initialization\r
+ unsigned long m_inprocTimeout;\r
+\r
+ // inproc means we buffer sessions in memory\r
+ RWLock* m_lock;\r
+ map<string,StoredSession*> m_hashtable;\r
+ \r
+ // management of buffered sessions\r
+ void dormant(const char* key);\r
+ static void* cleanup_fn(void*);\r
+ bool shutdown;\r
+ CondWait* shutdown_wait;\r
+ Thread* cleanup_thread;\r
+ };\r
+\r
+ class StoredSession : public virtual Session\r
+ {\r
+ public:\r
+ StoredSession(SSCache* cache, DDF& obj) : m_obj(obj),\r
+#ifndef SHIBSP_LITE\r
+ m_nameid(NULL),\r
+#endif\r
+ m_cache(cache), m_expires(0), m_lastAccess(time(NULL)), m_lock(NULL) {\r
+ auto_ptr_XMLCh exp(m_obj["expires"].string());\r
+ if (exp.get()) {\r
+ DateTime iso(exp.get());\r
+ iso.parseDateTime();\r
+ m_expires = iso.getEpoch();\r
+ }\r
+\r
+#ifndef SHIBSP_LITE\r
+ const char* nameid = obj["nameid"].string();\r
+ if (nameid) {\r
+ // Parse and bind the document into an XMLObject.\r
+ istringstream instr(nameid);\r
+ DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(instr); \r
+ XercesJanitor<DOMDocument> janitor(doc);\r
+ auto_ptr<saml2::NameID> n(saml2::NameIDBuilder::buildNameID());\r
+ n->unmarshall(doc->getDocumentElement(), true);\r
+ janitor.release();\r
+ m_nameid = n.release();\r
+ }\r
+#endif \r
+ if (cache->inproc)\r
+ m_lock = Mutex::create();\r
+ }\r
+ \r
+ ~StoredSession() {\r
+ delete m_lock;\r
+ m_obj.destroy();\r
+ for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());\r
+#ifndef SHIBSP_LITE\r
+ delete m_nameid;\r
+ for_each(m_tokens.begin(), m_tokens.end(), cleanup_pair<string,Assertion>());\r
+#endif\r
+ }\r
+ \r
+ Lockable* lock() {\r
+ if (m_lock)\r
+ m_lock->lock();\r
+ return this;\r
+ }\r
+ void unlock() {\r
+ if (m_lock)\r
+ m_lock->unlock();\r
+ else\r
+ delete this;\r
+ }\r
+\r
+ const char* getID() const {\r
+ return m_obj.name();\r
+ }\r
+ const char* getApplicationID() const {\r
+ return m_obj["application_id"].string();\r
+ }\r
+ const char* getClientAddress() const {\r
+ return m_obj["client_addr"].string();\r
+ }\r
+ const char* getEntityID() const {\r
+ return m_obj["entity_id"].string();\r
+ }\r
+ const char* getProtocol() const {\r
+ return m_obj["protocol"].string();\r
+ }\r
+ const char* getAuthnInstant() const {\r
+ return m_obj["authn_instant"].string();\r
+ }\r
+#ifndef SHIBSP_LITE\r
+ const saml2::NameID* getNameID() const {\r
+ return m_nameid;\r
+ }\r
+#endif\r
+ const char* getSessionIndex() const {\r
+ return m_obj["session_index"].string();\r
+ }\r
+ const char* getAuthnContextClassRef() const {\r
+ return m_obj["authncontext_class"].string();\r
+ }\r
+ const char* getAuthnContextDeclRef() const {\r
+ return m_obj["authncontext_decl"].string();\r
+ }\r
+ const vector<Attribute*>& getAttributes() const {\r
+ if (m_attributes.empty())\r
+ unmarshallAttributes();\r
+ return m_attributes;\r
+ }\r
+ const multimap<string,const Attribute*>& getIndexedAttributes() const {\r
+ if (m_attributeIndex.empty()) {\r
+ if (m_attributes.empty())\r
+ unmarshallAttributes();\r
+ for (vector<Attribute*>::const_iterator a = m_attributes.begin(); a != m_attributes.end(); ++a) {\r
+ const vector<string>& aliases = (*a)->getAliases();\r
+ for (vector<string>::const_iterator alias = aliases.begin(); alias != aliases.end(); ++alias)\r
+ m_attributeIndex.insert(multimap<string,const Attribute*>::value_type(*alias, *a));\r
+ }\r
+ }\r
+ return m_attributeIndex;\r
+ }\r
+ const vector<const char*>& getAssertionIDs() const {\r
+ if (m_ids.empty()) {\r
+ DDF ids = m_obj["assertions"];\r
+ DDF id = ids.first();\r
+ while (id.isstring()) {\r
+ m_ids.push_back(id.string());\r
+ id = ids.next();\r
+ }\r
+ }\r
+ return m_ids;\r
+ }\r
+ \r
+ void validate(const Application& application, const char* client_addr, time_t* timeout);\r
+\r
+#ifndef SHIBSP_LITE\r
+ void addAttributes(const vector<Attribute*>& attributes);\r
+ const Assertion* getAssertion(const char* id) const;\r
+ void addAssertion(Assertion* assertion);\r
+#endif\r
+\r
+ time_t getExpiration() const { return m_expires; }\r
+ time_t getLastAccess() const { return m_lastAccess; }\r
+\r
+ private:\r
+ void unmarshallAttributes() const;\r
+\r
+ DDF m_obj;\r
+#ifndef SHIBSP_LITE\r
+ saml2::NameID* m_nameid;\r
+ mutable map<string,Assertion*> m_tokens;\r
+#endif\r
+ mutable vector<Attribute*> m_attributes;\r
+ mutable multimap<string,const Attribute*> m_attributeIndex;\r
+ mutable vector<const char*> m_ids;\r
+\r
+ SSCache* m_cache;\r
+ time_t m_expires,m_lastAccess;\r
+ Mutex* m_lock;\r
+ };\r
+ \r
+ SessionCache* SHIBSP_DLLLOCAL StorageServiceCacheFactory(const DOMElement* const & e)\r
+ {\r
+ return new SSCache(e);\r
+ }\r
+}\r
+\r
+void SHIBSP_API shibsp::registerSessionCaches()\r
+{\r
+ SPConfig::getConfig().SessionCacheManager.registerFactory(STORAGESERVICE_SESSION_CACHE, StorageServiceCacheFactory);\r
+}\r
+\r
+void StoredSession::unmarshallAttributes() const\r
+{\r
+ Attribute* attribute;\r
+ DDF attrs = m_obj["attributes"];\r
+ DDF attr = attrs.first();\r
+ while (!attr.isnull()) {\r
+ try {\r
+ attribute = Attribute::unmarshall(attr);\r
+ m_attributes.push_back(attribute);\r
+ if (m_cache->m_log.isDebugEnabled())\r
+ m_cache->m_log.debug("unmarshalled attribute (ID: %s) with %d value%s",\r
+ attribute->getId(), attr.first().integer(), attr.first().integer()!=1 ? "s" : "");\r
+ }\r
+ catch (AttributeException& ex) {\r
+ const char* id = attr.first().name();\r
+ m_cache->m_log.error("error unmarshalling attribute (ID: %s): %s", id ? id : "none", ex.what());\r
+ }\r
+ attr = attrs.next();\r
+ }\r
+}\r
+\r
+void StoredSession::validate(const Application& application, const char* client_addr, time_t* timeout)\r
+{\r
+ time_t now = time(NULL);\r
+\r
+ // Basic expiration?\r
+ if (m_expires > 0) {\r
+ if (now > m_expires) {\r
+ m_cache->m_log.info("session expired (ID: %s)", getID());\r
+ throw RetryableProfileException("Your session has expired, and you must re-authenticate.");\r
+ }\r
+ }\r
+\r
+ // Address check?\r
+ if (client_addr) {\r
+ if (m_cache->m_log.isDebugEnabled())\r
+ m_cache->m_log.debug("comparing client address %s against %s", client_addr, getClientAddress());\r
+ if (!XMLString::equals(getClientAddress(),client_addr)) {\r
+ m_cache->m_log.warn("client address mismatch");\r
+ throw RetryableProfileException(\r
+ "Your IP address ($1) does not match the address recorded at the time the session was established.",\r
+ params(1,client_addr)\r
+ );\r
+ }\r
+ }\r
+\r
+ if (!timeout)\r
+ return;\r
+ \r
+ if (!SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {\r
+ DDF in("touch::"STORAGESERVICE_SESSION_CACHE"::SessionCache"), out;\r
+ DDFJanitor jin(in);\r
+ in.structure();\r
+ in.addmember("key").string(getID());\r
+ in.addmember("version").integer(m_obj["version"].integer());\r
+ if (*timeout) {\r
+ // On 64-bit Windows, time_t doesn't fit in a long, so I'm using ISO timestamps. \r
+#ifndef HAVE_GMTIME_R\r
+ struct tm* ptime=gmtime(timeout);\r
+#else\r
+ struct tm res;\r
+ struct tm* ptime=gmtime_r(timeout,&res);\r
+#endif\r
+ char timebuf[32];\r
+ strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);\r
+ in.addmember("timeout").string(timebuf);\r
+ }\r
+\r
+ try {\r
+ out=application.getServiceProvider().getListenerService()->send(in);\r
+ }\r
+ catch (...) {\r
+ out.destroy();\r
+ throw;\r
+ }\r
+\r
+ if (out.isstruct()) {\r
+ // We got an updated record back.\r
+ m_ids.clear();\r
+ for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());\r
+ m_attributes.clear();\r
+ m_attributeIndex.clear();\r
+ m_obj.destroy();\r
+ m_obj = out;\r
+ }\r
+ }\r
+ else {\r
+#ifndef SHIBSP_LITE\r
+ if (!m_cache->m_storage)\r
+ throw ConfigurationException("Session touch requires a StorageService.");\r
+\r
+ // Do a versioned read.\r
+ string record;\r
+ time_t lastAccess;\r
+ int curver = m_obj["version"].integer();\r
+ int ver = m_cache->m_storage->readText(getID(), "session", &record, &lastAccess, curver);\r
+ if (ver == 0) {\r
+ m_cache->m_log.warn("unsuccessful versioned read of session (ID: %s), cache out of sync?", getID());\r
+ throw RetryableProfileException("Your session has expired, and you must re-authenticate.");\r
+ }\r
+\r
+ // Adjust for expiration to recover last access time and check timeout.\r
+ lastAccess -= m_cache->m_cacheTimeout;\r
+ if (*timeout > 0 && now - lastAccess >= *timeout) {\r
+ m_cache->m_log.info("session timed out (ID: %s)", getID());\r
+ throw RetryableProfileException("Your session has expired, and you must re-authenticate.");\r
+ } \r
+\r
+ // Update storage expiration, if possible.\r
+ try {\r
+ m_cache->m_storage->updateContext(getID(), now + m_cache->m_cacheTimeout);\r
+ }\r
+ catch (exception& ex) {\r
+ m_cache->m_log.error("failed to update session expiration: %s", ex.what());\r
+ }\r
+ \r
+ if (ver > curver) {\r
+ // We got an updated record back.\r
+ DDF newobj;\r
+ istringstream in(record);\r
+ in >> newobj;\r
+ m_ids.clear();\r
+ for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());\r
+ m_attributes.clear();\r
+ m_attributeIndex.clear();\r
+ m_obj.destroy();\r
+ m_obj = newobj;\r
+ }\r
+#else\r
+ throw ConfigurationException("Session touch requires a StorageService.");\r
+#endif\r
+ }\r
+\r
+ m_lastAccess = now;\r
+}\r
+\r
+#ifndef SHIBSP_LITE\r
+\r
+void StoredSession::addAttributes(const vector<Attribute*>& attributes)\r
+{\r
+#ifdef _DEBUG\r
+ xmltooling::NDC ndc("addAttributes");\r
+#endif\r
+\r
+ if (!m_cache->m_storage)\r
+ throw ConfigurationException("Session modification requires a StorageService.");\r
+\r
+ m_cache->m_log.debug("adding attributes to session (%s)", getID());\r
+ \r
+ int ver;\r
+ do {\r
+ DDF attr;\r
+ DDF attrs = m_obj["attributes"];\r
+ if (!attrs.islist())\r
+ attrs = m_obj.addmember("attributes").list();\r
+ for (vector<Attribute*>::const_iterator a=attributes.begin(); a!=attributes.end(); ++a) {\r
+ attr = (*a)->marshall();\r
+ attrs.add(attr);\r
+ }\r
+ \r
+ // Tentatively increment the version.\r
+ m_obj["version"].integer(m_obj["version"].integer()+1);\r
+ \r
+ ostringstream str;\r
+ str << m_obj;\r
+ string record(str.str()); \r
+\r
+ try {\r
+ ver = m_cache->m_storage->updateText(getID(), "session", record.c_str(), 0, m_obj["version"].integer()-1);\r
+ }\r
+ catch (exception&) {\r
+ // Roll back modification to record.\r
+ m_obj["version"].integer(m_obj["version"].integer()-1);\r
+ vector<Attribute*>::size_type count = attributes.size();\r
+ while (count--)\r
+ attrs.last().destroy(); \r
+ throw;\r
+ }\r
+\r
+ if (ver <= 0) {\r
+ // Roll back modification to record.\r
+ m_obj["version"].integer(m_obj["version"].integer()-1);\r
+ vector<Attribute*>::size_type count = attributes.size();\r
+ while (count--)\r
+ attrs.last().destroy(); \r
+ }\r
+ if (!ver) {\r
+ // Fatal problem with update.\r
+ throw IOException("Unable to update stored session.");\r
+ }\r
+ else if (ver < 0) {\r
+ // Out of sync.\r
+ m_cache->m_log.warn("storage service indicates the record is out of sync, updating with a fresh copy...");\r
+ ver = m_cache->m_storage->readText(getID(), "session", &record, NULL);\r
+ if (!ver) {\r
+ m_cache->m_log.error("readText failed on StorageService for session (%s)", getID());\r
+ throw IOException("Unable to read back stored session.");\r
+ }\r
+ \r
+ // Reset object.\r
+ DDF newobj;\r
+ istringstream in(record);\r
+ in >> newobj;\r
+\r
+ m_ids.clear();\r
+ for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());\r
+ m_attributes.clear();\r
+ m_attributeIndex.clear();\r
+ newobj["version"].integer(ver);\r
+ m_obj.destroy();\r
+ m_obj = newobj;\r
+\r
+ ver = -1;\r
+ }\r
+ } while (ver < 0); // negative indicates a sync issue so we retry\r
+\r
+ TransactionLog* xlog = SPConfig::getConfig().getServiceProvider()->getTransactionLog();\r
+ Locker locker(xlog);\r
+ xlog->log.infoStream() <<\r
+ "Added the following attributes to session (ID: " <<\r
+ getID() <<\r
+ ") for (applicationId: " <<\r
+ m_obj["application_id"].string() <<\r
+ ") {";\r
+ for (vector<Attribute*>::const_iterator a=attributes.begin(); a!=attributes.end(); ++a)\r
+ xlog->log.infoStream() << "\t" << (*a)->getId() << " (" << (*a)->valueCount() << " values)";\r
+ xlog->log.info("}");\r
+\r
+ // We own them now, so clean them up.\r
+ for_each(attributes.begin(), attributes.end(), xmltooling::cleanup<Attribute>());\r
+}\r
+\r
+const Assertion* StoredSession::getAssertion(const char* id) const\r
+{\r
+ if (!m_cache->m_storage)\r
+ throw ConfigurationException("Assertion retrieval requires a StorageService.");\r
+\r
+ map<string,Assertion*>::const_iterator i = m_tokens.find(id);\r
+ if (i!=m_tokens.end())\r
+ return i->second;\r
+ \r
+ string tokenstr;\r
+ if (!m_cache->m_storage->readText(getID(), id, &tokenstr, NULL))\r
+ throw FatalProfileException("Assertion not found in cache.");\r
+\r
+ // Parse and bind the document into an XMLObject.\r
+ istringstream instr(tokenstr);\r
+ DOMDocument* doc = XMLToolingConfig::getConfig().getParser().parse(instr); \r
+ XercesJanitor<DOMDocument> janitor(doc);\r
+ auto_ptr<XMLObject> xmlObject(XMLObjectBuilder::buildOneFromElement(doc->getDocumentElement(), true));\r
+ janitor.release();\r
+ \r
+ Assertion* token = dynamic_cast<Assertion*>(xmlObject.get());\r
+ if (!token)\r
+ throw FatalProfileException("Request for cached assertion returned an unknown object type.");\r
+\r
+ // Transfer ownership to us.\r
+ xmlObject.release();\r
+ m_tokens[id]=token;\r
+ return token;\r
+}\r
+\r
+void StoredSession::addAssertion(Assertion* assertion)\r
+{\r
+#ifdef _DEBUG\r
+ xmltooling::NDC ndc("addAssertion");\r
+#endif\r
+\r
+ if (!m_cache->m_storage)\r
+ throw ConfigurationException("Session modification requires a StorageService.");\r
+\r
+ if (!assertion)\r
+ throw FatalProfileException("Unknown object type passed to session for storage.");\r
+\r
+ auto_ptr_char id(assertion->getID());\r
+\r
+ m_cache->m_log.debug("adding assertion (%s) to session (%s)", id.get(), getID());\r
+\r
+ time_t exp;\r
+ if (!m_cache->m_storage->readText(getID(), "session", NULL, &exp))\r
+ throw IOException("Unable to load expiration time for stored session.");\r
+\r
+ ostringstream tokenstr;\r
+ tokenstr << *assertion;\r
+ if (!m_cache->m_storage->createText(getID(), id.get(), tokenstr.str().c_str(), exp))\r
+ throw IOException("Attempted to insert duplicate assertion ID into session.");\r
+ \r
+ int ver;\r
+ do {\r
+ DDF token = DDF(NULL).string(id.get());\r
+ m_obj["assertions"].add(token);\r
+\r
+ // Tentatively increment the version.\r
+ m_obj["version"].integer(m_obj["version"].integer()+1);\r
+ \r
+ ostringstream str;\r
+ str << m_obj;\r
+ string record(str.str()); \r
+\r
+ try {\r
+ ver = m_cache->m_storage->updateText(getID(), "session", record.c_str(), 0, m_obj["version"].integer()-1);\r
+ }\r
+ catch (exception&) {\r
+ token.destroy();\r
+ m_obj["version"].integer(m_obj["version"].integer()-1);\r
+ m_cache->m_storage->deleteText(getID(), id.get());\r
+ throw;\r
+ }\r
+\r
+ if (ver <= 0) {\r
+ token.destroy();\r
+ m_obj["version"].integer(m_obj["version"].integer()-1);\r
+ } \r
+ if (!ver) {\r
+ // Fatal problem with update.\r
+ m_cache->m_log.error("updateText failed on StorageService for session (%s)", getID());\r
+ m_cache->m_storage->deleteText(getID(), id.get());\r
+ throw IOException("Unable to update stored session.");\r
+ }\r
+ else if (ver < 0) {\r
+ // Out of sync.\r
+ m_cache->m_log.warn("storage service indicates the record is out of sync, updating with a fresh copy...");\r
+ ver = m_cache->m_storage->readText(getID(), "session", &record, NULL);\r
+ if (!ver) {\r
+ m_cache->m_log.error("readText failed on StorageService for session (%s)", getID());\r
+ m_cache->m_storage->deleteText(getID(), id.get());\r
+ throw IOException("Unable to read back stored session.");\r
+ }\r
+ \r
+ // Reset object.\r
+ DDF newobj;\r
+ istringstream in(record);\r
+ in >> newobj;\r
+\r
+ m_ids.clear();\r
+ for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());\r
+ m_attributes.clear();\r
+ m_attributeIndex.clear();\r
+ newobj["version"].integer(ver);\r
+ m_obj.destroy();\r
+ m_obj = newobj;\r
+ \r
+ ver = -1;\r
+ }\r
+ } while (ver < 0); // negative indicates a sync issue so we retry\r
+\r
+ m_ids.clear();\r
+ delete assertion;\r
+\r
+ TransactionLog* xlog = SPConfig::getConfig().getServiceProvider()->getTransactionLog();\r
+ Locker locker(xlog);\r
+ xlog->log.info(\r
+ "Added assertion (ID: %s) to session for (applicationId: %s) with (ID: %s)",\r
+ id.get(), m_obj["application_id"].string(), getID()\r
+ );\r
+}\r
+\r
+#endif\r
+\r
+SSCache::SSCache(const DOMElement* e)\r
+ : m_log(Category::getInstance(SHIBSP_LOGCAT".SessionCache")), inproc(true), m_cacheTimeout(3600),\r
+#ifndef SHIBSP_LITE\r
+ m_storage(NULL), m_storage_lite(NULL),\r
+#endif\r
+ m_root(e), m_inprocTimeout(900), m_lock(NULL), shutdown(false), shutdown_wait(NULL), cleanup_thread(NULL)\r
+{\r
+ static const XMLCh cacheTimeout[] = UNICODE_LITERAL_12(c,a,c,h,e,T,i,m,e,o,u,t);\r
+ static const XMLCh inprocTimeout[] = UNICODE_LITERAL_13(i,n,p,r,o,c,T,i,m,e,o,u,t);\r
+ static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);\r
+ static const XMLCh _StorageServiceLite[] = UNICODE_LITERAL_18(S,t,o,r,a,g,e,S,e,r,v,i,c,e,L,i,t,e);\r
+\r
+ SPConfig& conf = SPConfig::getConfig();\r
+ inproc = conf.isEnabled(SPConfig::InProcess);\r
+\r
+ if (e) {\r
+ const XMLCh* tag=e->getAttributeNS(NULL,cacheTimeout);\r
+ if (tag && *tag) {\r
+ m_cacheTimeout = XMLString::parseInt(tag);\r
+ if (!m_cacheTimeout)\r
+ m_cacheTimeout=3600;\r
+ }\r
+ if (inproc) {\r
+ const XMLCh* tag=e->getAttributeNS(NULL,inprocTimeout);\r
+ if (tag && *tag) {\r
+ m_inprocTimeout = XMLString::parseInt(tag);\r
+ if (!m_inprocTimeout)\r
+ m_inprocTimeout=900;\r
+ }\r
+ }\r
+ }\r
+\r
+#ifndef SHIBSP_LITE\r
+ if (conf.isEnabled(SPConfig::OutOfProcess)) {\r
+ const XMLCh* tag = e ? e->getAttributeNS(NULL,_StorageService) : NULL;\r
+ if (tag && *tag) {\r
+ auto_ptr_char ssid(tag);\r
+ m_storage = conf.getServiceProvider()->getStorageService(ssid.get());\r
+ if (m_storage)\r
+ m_log.info("bound to StorageService (%s)", ssid.get());\r
+ }\r
+ if (!m_storage)\r
+ throw ConfigurationException("SessionCache unable to locate StorageService, check configuration.");\r
+\r
+ tag = e ? e->getAttributeNS(NULL,_StorageServiceLite) : NULL;\r
+ if (tag && *tag) {\r
+ auto_ptr_char ssid(tag);\r
+ m_storage_lite = conf.getServiceProvider()->getStorageService(ssid.get());\r
+ if (m_storage_lite)\r
+ m_log.info("bound to StorageServiceLite (%s)", ssid.get());\r
+ }\r
+ if (!m_storage_lite) {\r
+ m_log.info("No StorageServiceLite specified. Using standard StorageService.");\r
+ m_storage_lite = m_storage;\r
+ }\r
+ }\r
+#endif\r
+\r
+ ListenerService* listener=conf.getServiceProvider()->getListenerService(false);\r
+ if (inproc ) {\r
+ if (!conf.isEnabled(SPConfig::OutOfProcess) && !listener)\r
+ throw ConfigurationException("SessionCache requires a ListenerService, but none available.");\r
+ m_lock = RWLock::create();\r
+ shutdown_wait = CondWait::create();\r
+ cleanup_thread = Thread::create(&cleanup_fn, (void*)this);\r
+ }\r
+#ifndef SHIBSP_LITE\r
+ else {\r
+ if (listener && conf.isEnabled(SPConfig::OutOfProcess)) {\r
+ listener->regListener("find::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);\r
+ listener->regListener("remove::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);\r
+ listener->regListener("touch::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);\r
+ }\r
+ else {\r
+ m_log.info("no ListenerService available, cache remoting disabled");\r
+ }\r
+ }\r
+#endif\r
+}\r
+\r
+SSCache::~SSCache()\r
+{\r
+ if (inproc) {\r
+ // Shut down the cleanup thread and let it know...\r
+ shutdown = true;\r
+ shutdown_wait->signal();\r
+ cleanup_thread->join(NULL);\r
+\r
+ for_each(m_hashtable.begin(),m_hashtable.end(),cleanup_pair<string,StoredSession>());\r
+ delete m_lock;\r
+ delete shutdown_wait;\r
+ }\r
+#ifndef SHIBSP_LITE\r
+ else {\r
+ SPConfig& conf = SPConfig::getConfig();\r
+ ListenerService* listener=conf.getServiceProvider()->getListenerService(false);\r
+ if (listener && conf.isEnabled(SPConfig::OutOfProcess)) {\r
+ listener->unregListener("find::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);\r
+ listener->unregListener("remove::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);\r
+ listener->unregListener("touch::"STORAGESERVICE_SESSION_CACHE"::SessionCache",this);\r
+ }\r
+ }\r
+#endif\r
+}\r
+\r
+#ifndef SHIBSP_LITE\r
+\r
+void SSCache::test()\r
+{\r
+ auto_ptr_char temp(SAMLConfig::getConfig().generateIdentifier());\r
+ m_storage->createString("SessionCacheTest", temp.get(), "Test", time(NULL) + 60);\r
+ m_storage->deleteString("SessionCacheTest", temp.get());\r
+}\r
+\r
+void SSCache::insert(const char* key, time_t expires, const char* name, const char* index)\r
+{\r
+ string dup;\r
+ if (strlen(name) > 255) {\r
+ dup = string(name).substr(0,255);\r
+ name = dup.c_str();\r
+ }\r
+\r
+ DDF obj;\r
+ DDFJanitor jobj(obj);\r
+\r
+ // Since we can't guarantee uniqueness, check for an existing record.\r
+ string record;\r
+ time_t recordexp;\r
+ int ver = m_storage_lite->readText("NameID", name, &record, &recordexp);\r
+ if (ver > 0) {\r
+ // Existing record, so we need to unmarshall it.\r
+ istringstream in(record);\r
+ in >> obj;\r
+ }\r
+ else {\r
+ // New record.\r
+ obj.structure();\r
+ }\r
+\r
+ if (!index || !*index)\r
+ index = "_shibnull";\r
+ DDF sessions = obj.addmember(index);\r
+ if (!sessions.islist())\r
+ sessions.list();\r
+ DDF session = DDF(NULL).string(key);\r
+ sessions.add(session);\r
+\r
+ // Remarshall the record.\r
+ ostringstream out;\r
+ out << obj;\r
+\r
+ // Try and store it back...\r
+ if (ver > 0) {\r
+ ver = m_storage_lite->updateText("NameID", name, out.str().c_str(), max(expires, recordexp), ver);\r
+ if (ver <= 0) {\r
+ // Out of sync, or went missing, so retry.\r
+ return insert(key, expires, name, index);\r
+ }\r
+ }\r
+ else if (!m_storage_lite->createText("NameID", name, out.str().c_str(), expires)) {\r
+ // Hit a dup, so just retry, hopefully hitting the other branch.\r
+ return insert(key, expires, name, index);\r
+ }\r
+}\r
+\r
+void SSCache::insert(\r
+ const Application& application,\r
+ const HTTPRequest& httpRequest,\r
+ HTTPResponse& httpResponse,\r
+ time_t expires,\r
+ const saml2md::EntityDescriptor* issuer,\r
+ const XMLCh* protocol,\r
+ const saml2::NameID* nameid,\r
+ const XMLCh* authn_instant,\r
+ const XMLCh* session_index,\r
+ const XMLCh* authncontext_class,\r
+ const XMLCh* authncontext_decl,\r
+ const vector<const Assertion*>* tokens,\r
+ const vector<Attribute*>* attributes\r
+ )\r
+{\r
+#ifdef _DEBUG\r
+ xmltooling::NDC ndc("insert");\r
+#endif\r
+ if (!m_storage)\r
+ throw ConfigurationException("SessionCache insertion requires a StorageService.");\r
+\r
+ m_log.debug("creating new session");\r
+\r
+ time_t now = time(NULL);\r
+ auto_ptr_char index(session_index);\r
+ auto_ptr_char entity_id(issuer ? issuer->getEntityID() : NULL);\r
+ auto_ptr_char name(nameid ? nameid->getName() : NULL);\r
+\r
+ if (nameid) {\r
+ // Check for a pending logout.\r
+ if (strlen(name.get()) > 255)\r
+ const_cast<char*>(name.get())[255] = 0;\r
+ string pending;\r
+ int ver = m_storage_lite->readText("Logout", name.get(), &pending);\r
+ if (ver > 0) {\r
+ DDF pendobj;\r
+ DDFJanitor jpend(pendobj);\r
+ istringstream pstr(pending);\r
+ pstr >> pendobj;\r
+ // IdP.SP.index contains logout expiration, if any.\r
+ DDF deadmenwalking = pendobj[issuer ? entity_id.get() : "_shibnull"][application.getRelyingParty(issuer)->getString("entityID").second];\r
+ const char* logexpstr = deadmenwalking[session_index ? index.get() : "_shibnull"].string();\r
+ if (!logexpstr && session_index) // we tried an exact session match, now try for NULL\r
+ logexpstr = deadmenwalking["_shibnull"].string();\r
+ if (logexpstr) {\r
+ auto_ptr_XMLCh dt(logexpstr);\r
+ DateTime dtobj(dt.get());\r
+ dtobj.parseDateTime();\r
+ time_t logexp = dtobj.getEpoch();\r
+ if (now - XMLToolingConfig::getConfig().clock_skew_secs < logexp)\r
+ throw FatalProfileException("A logout message from your identity provider has blocked your login attempt.");\r
+ }\r
+ }\r
+ }\r
+\r
+ auto_ptr_char key(SAMLConfig::getConfig().generateIdentifier());\r
+\r
+ // Store session properties in DDF.\r
+ DDF obj = DDF(key.get()).structure();\r
+ obj.addmember("version").integer(1);\r
+ obj.addmember("application_id").string(application.getId());\r
+\r
+ // On 64-bit Windows, time_t doesn't fit in a long, so I'm using ISO timestamps.\r
+#ifndef HAVE_GMTIME_R\r
+ struct tm* ptime=gmtime(&expires);\r
+#else\r
+ struct tm res;\r
+ struct tm* ptime=gmtime_r(&expires,&res);\r
+#endif\r
+ char timebuf[32];\r
+ strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);\r
+ obj.addmember("expires").string(timebuf);\r
+\r
+ obj.addmember("client_addr").string(httpRequest.getRemoteAddr().c_str());\r
+ if (issuer)\r
+ obj.addmember("entity_id").string(entity_id.get());\r
+ if (protocol) {\r
+ auto_ptr_char prot(protocol);\r
+ obj.addmember("protocol").string(prot.get());\r
+ }\r
+ if (authn_instant) {\r
+ auto_ptr_char instant(authn_instant);\r
+ obj.addmember("authn_instant").string(instant.get());\r
+ }\r
+ if (session_index)\r
+ obj.addmember("session_index").string(index.get());\r
+ if (authncontext_class) {\r
+ auto_ptr_char ac(authncontext_class);\r
+ obj.addmember("authncontext_class").string(ac.get());\r
+ }\r
+ if (authncontext_decl) {\r
+ auto_ptr_char ad(authncontext_decl);\r
+ obj.addmember("authncontext_decl").string(ad.get());\r
+ }\r
+\r
+ if (nameid) {\r
+ ostringstream namestr;\r
+ namestr << *nameid;\r
+ obj.addmember("nameid").string(namestr.str().c_str());\r
+ }\r
+\r
+ if (tokens) {\r
+ obj.addmember("assertions").list();\r
+ for (vector<const Assertion*>::const_iterator t = tokens->begin(); t!=tokens->end(); ++t) {\r
+ auto_ptr_char tokenid((*t)->getID());\r
+ DDF tokid = DDF(NULL).string(tokenid.get());\r
+ obj["assertions"].add(tokid);\r
+ }\r
+ }\r
+ \r
+ if (attributes) {\r
+ DDF attr;\r
+ DDF attrlist = obj.addmember("attributes").list();\r
+ for (vector<Attribute*>::const_iterator a=attributes->begin(); a!=attributes->end(); ++a) {\r
+ attr = (*a)->marshall();\r
+ attrlist.add(attr);\r
+ }\r
+ }\r
+ \r
+ ostringstream record;\r
+ record << obj;\r
+ \r
+ m_log.debug("storing new session...");\r
+ if (!m_storage->createText(key.get(), "session", record.str().c_str(), now + m_cacheTimeout))\r
+ throw FatalProfileException("Attempted to create a session with a duplicate key.");\r
+ \r
+ // Store the reverse mapping for logout.\r
+ try {\r
+ if (nameid)\r
+ insert(key.get(), expires, name.get(), index.get());\r
+ }\r
+ catch (exception& ex) {\r
+ m_log.error("error storing back mapping of NameID for logout: %s", ex.what());\r
+ }\r
+\r
+ if (tokens) {\r
+ try {\r
+ for (vector<const Assertion*>::const_iterator t = tokens->begin(); t!=tokens->end(); ++t) {\r
+ ostringstream tokenstr;\r
+ tokenstr << *(*t);\r
+ auto_ptr_char tokenid((*t)->getID());\r
+ if (!m_storage->createText(key.get(), tokenid.get(), tokenstr.str().c_str(), now + m_cacheTimeout))\r
+ throw IOException("duplicate assertion ID ($1)", params(1, tokenid.get()));\r
+ }\r
+ }\r
+ catch (exception& ex) {\r
+ m_log.error("error storing assertion along with session: %s", ex.what());\r
+ }\r
+ }\r
+\r
+ const char* pid = obj["entity_id"].string();\r
+ const char* prot = obj["protocol"].string();\r
+ m_log.info("new session created: ID (%s) IdP (%s) Protocol(%s) Address (%s)",\r
+ key.get(), pid ? pid : "none", prot ? prot : "none", httpRequest.getRemoteAddr().c_str());\r
+\r
+ // Transaction Logging\r
+ TransactionLog* xlog = application.getServiceProvider().getTransactionLog();\r
+ Locker locker(xlog);\r
+ xlog->log.infoStream() <<\r
+ "New session (ID: " <<\r
+ key.get() <<\r
+ ") with (applicationId: " <<\r
+ application.getId() <<\r
+ ") for principal from (IdP: " <<\r
+ (pid ? pid : "none") <<\r
+ ") at (ClientAddress: " <<\r
+ httpRequest.getRemoteAddr() <<\r
+ ") with (NameIdentifier: " <<\r
+ (nameid ? name.get() : "none") <<\r
+ ") using (Protocol: " <<\r
+ (prot ? prot : "none") <<\r
+ ")";\r
+ \r
+ if (attributes) {\r
+ xlog->log.infoStream() <<\r
+ "Cached the following attributes with session (ID: " <<\r
+ key.get() <<\r
+ ") for (applicationId: " <<\r
+ application.getId() <<\r
+ ") {";\r
+ for (vector<Attribute*>::const_iterator a=attributes->begin(); a!=attributes->end(); ++a)\r
+ xlog->log.infoStream() << "\t" << (*a)->getId() << " (" << (*a)->valueCount() << " values)";\r
+ xlog->log.info("}");\r
+ }\r
+\r
+ pair<string,const char*> shib_cookie = application.getCookieNameProps("_shibsession_");\r
+ string k(key.get());\r
+ k += shib_cookie.second;\r
+ httpResponse.setCookie(shib_cookie.first.c_str(), k.c_str());\r
+}\r
+\r
+bool SSCache::matches(\r
+ const Application& application,\r
+ const xmltooling::HTTPRequest& request,\r
+ const saml2md::EntityDescriptor* issuer,\r
+ const saml2::NameID& nameid,\r
+ const set<string>* indexes\r
+ )\r
+{\r
+ auto_ptr_char entityID(issuer ? issuer->getEntityID() : NULL);\r
+ try {\r
+ Session* session = find(application, request);\r
+ if (session) {\r
+ Locker locker(session, false);\r
+ if (XMLString::equals(session->getEntityID(), entityID.get()) && session->getNameID() &&\r
+ stronglyMatches(issuer->getEntityID(), application.getRelyingParty(issuer)->getXMLString("entityID").second, nameid, *session->getNameID())) {\r
+ return (!indexes || indexes->empty() || (session->getSessionIndex() ? (indexes->count(session->getSessionIndex())>0) : false));\r
+ }\r
+ }\r
+ }\r
+ catch (exception& ex) {\r
+ m_log.error("error while matching session: %s", ex.what());\r
+ }\r
+ return false;\r
+}\r
+\r
+vector<string>::size_type SSCache::logout(\r
+ const Application& application,\r
+ const saml2md::EntityDescriptor* issuer,\r
+ const saml2::NameID& nameid,\r
+ const set<string>* indexes,\r
+ time_t expires,\r
+ vector<string>& sessionsKilled\r
+ )\r
+{\r
+#ifdef _DEBUG\r
+ xmltooling::NDC ndc("logout");\r
+#endif\r
+\r
+ if (!m_storage)\r
+ throw ConfigurationException("SessionCache insertion requires a StorageService.");\r
+\r
+ auto_ptr_char entityID(issuer ? issuer->getEntityID() : NULL);\r
+ auto_ptr_char name(nameid.getName());\r
+\r
+ m_log.info("request to logout sessions from (%s) for (%s)", entityID.get() ? entityID.get() : "unknown", name.get());\r
+\r
+ if (strlen(name.get()) > 255)\r
+ const_cast<char*>(name.get())[255] = 0;\r
+\r
+ DDF obj;\r
+ DDFJanitor jobj(obj);\r
+ string record;\r
+ int ver;\r
+\r
+ if (expires) {\r
+ // Record the logout to prevent post-delivered assertions.\r
+ // On 64-bit Windows, time_t doesn't fit in a long, so I'm using ISO timestamps.\r
+#ifndef HAVE_GMTIME_R\r
+ struct tm* ptime=gmtime(&expires);\r
+#else\r
+ struct tm res;\r
+ struct tm* ptime=gmtime_r(&expires,&res);\r
+#endif\r
+ char timebuf[32];\r
+ strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);\r
+\r
+ time_t oldexp = 0;\r
+ ver = m_storage_lite->readText("Logout", name.get(), &record, &oldexp);\r
+ if (ver > 0) {\r
+ istringstream lin(record);\r
+ lin >> obj;\r
+ }\r
+ else {\r
+ obj = DDF(NULL).structure();\r
+ }\r
+\r
+ // Structure is keyed by the IdP and SP, with a member per session index containing the expiration.\r
+ DDF root = obj.addmember(issuer ? entityID.get() : "_shibnull").addmember(application.getRelyingParty(issuer)->getString("entityID").second);\r
+ if (indexes) {\r
+ for (set<string>::const_iterator x = indexes->begin(); x!=indexes->end(); ++x)\r
+ root.addmember(x->c_str()).string(timebuf);\r
+ }\r
+ else {\r
+ root.addmember("_shibnull").string(timebuf);\r
+ }\r
+\r
+ // Write it back.\r
+ ostringstream lout;\r
+ lout << obj;\r
+\r
+ if (ver > 0) {\r
+ ver = m_storage_lite->updateText("Logout", name.get(), lout.str().c_str(), max(expires, oldexp), ver);\r
+ if (ver <= 0) {\r
+ // Out of sync, or went missing, so retry.\r
+ return logout(application, issuer, nameid, indexes, expires, sessionsKilled);\r
+ }\r
+ }\r
+ else if (!m_storage_lite->createText("Logout", name.get(), lout.str().c_str(), expires)) {\r
+ // Hit a dup, so just retry, hopefully hitting the other branch.\r
+ return logout(application, issuer, nameid, indexes, expires, sessionsKilled);\r
+ }\r
+\r
+ obj.destroy();\r
+ record.erase();\r
+ }\r
+\r
+ // Read in potentially matching sessions.\r
+ ver = m_storage_lite->readText("NameID", name.get(), &record);\r
+ if (ver == 0) {\r
+ m_log.debug("no active sessions to logout for supplied issuer and subject");\r
+ return 0;\r
+ }\r
+\r
+ istringstream in(record);\r
+ in >> obj;\r
+\r
+ // The record contains child lists for each known session index.\r
+ DDF key;\r
+ DDF sessions = obj.first();\r
+ while (sessions.islist()) {\r
+ if (!indexes || indexes->empty() || indexes->count(sessions.name())) {\r
+ key = sessions.first();\r
+ while (key.isstring()) {\r
+ // Fetch the session for comparison.\r
+ Session* session = NULL;\r
+ try {\r
+ session = find(application, key.string());\r
+ }\r
+ catch (exception& ex) {\r
+ m_log.error("error locating session (%s): %s", key.string(), ex.what());\r
+ }\r
+\r
+ if (session) {\r
+ Locker locker(session, false);\r
+ // Same issuer?\r
+ if (XMLString::equals(session->getEntityID(), entityID.get())) {\r
+ // Same NameID?\r
+ if (stronglyMatches(issuer->getEntityID(), application.getRelyingParty(issuer)->getXMLString("entityID").second, nameid, *session->getNameID())) {\r
+ sessionsKilled.push_back(key.string());\r
+ key.destroy();\r
+ }\r
+ else {\r
+ m_log.debug("session (%s) contained a non-matching NameID, leaving it alone", key.string());\r
+ }\r
+ }\r
+ else {\r
+ m_log.debug("session (%s) established by different IdP, leaving it alone", key.string());\r
+ }\r
+ }\r
+ else {\r
+ // Session's gone, so...\r
+ sessionsKilled.push_back(key.string());\r
+ key.destroy();\r
+ }\r
+ key = sessions.next();\r
+ }\r
+\r
+ // No sessions left for this index?\r
+ if (sessions.first().isnull())\r
+ sessions.destroy();\r
+ }\r
+ sessions = obj.next();\r
+ }\r
+ \r
+ if (obj.first().isnull())\r
+ obj.destroy();\r
+\r
+ // If possible, write back the mapping record (this isn't crucial).\r
+ try {\r
+ if (obj.isnull()) {\r
+ m_storage_lite->deleteText("NameID", name.get());\r
+ }\r
+ else if (!sessionsKilled.empty()) {\r
+ ostringstream out;\r
+ out << obj;\r
+ if (m_storage_lite->updateText("NameID", name.get(), out.str().c_str(), 0, ver) <= 0)\r
+ m_log.warn("logout mapping record changed behind us, leaving it alone");\r
+ }\r
+ }\r
+ catch (exception& ex) {\r
+ m_log.error("error updating logout mapping record: %s", ex.what());\r
+ }\r
+\r
+ return sessionsKilled.size();\r
+}\r
+\r
+bool SSCache::stronglyMatches(const XMLCh* idp, const XMLCh* sp, const saml2::NameID& n1, const saml2::NameID& n2) const\r
+{\r
+ if (!XMLString::equals(n1.getName(), n2.getName()))\r
+ return false;\r
+ \r
+ const XMLCh* s1 = n1.getFormat();\r
+ const XMLCh* s2 = n2.getFormat();\r
+ if (!s1 || !*s1)\r
+ s1 = saml2::NameID::UNSPECIFIED;\r
+ if (!s2 || !*s2)\r
+ s2 = saml2::NameID::UNSPECIFIED;\r
+ if (!XMLString::equals(s1,s2))\r
+ return false;\r
+ \r
+ s1 = n1.getNameQualifier();\r
+ s2 = n2.getNameQualifier();\r
+ if (!s1 || !*s1)\r
+ s1 = idp;\r
+ if (!s2 || !*s2)\r
+ s2 = idp;\r
+ if (!XMLString::equals(s1,s2))\r
+ return false;\r
+\r
+ s1 = n1.getSPNameQualifier();\r
+ s2 = n2.getSPNameQualifier();\r
+ if (!s1 || !*s1)\r
+ s1 = sp;\r
+ if (!s2 || !*s2)\r
+ s2 = sp;\r
+ if (!XMLString::equals(s1,s2))\r
+ return false;\r
+\r
+ return true;\r
+}\r
+\r
+#endif\r
+\r
+Session* SSCache::find(const Application& application, const char* key, const char* client_addr, time_t* timeout)\r
+{\r
+#ifdef _DEBUG\r
+ xmltooling::NDC ndc("find");\r
+#endif\r
+ StoredSession* session=NULL;\r
+\r
+ if (inproc) {\r
+ m_log.debug("searching local cache for session (%s)", key);\r
+ m_lock->rdlock();\r
+ map<string,StoredSession*>::const_iterator i=m_hashtable.find(key);\r
+ if (i!=m_hashtable.end()) {\r
+ // Save off and lock the session.\r
+ session = i->second;\r
+ session->lock();\r
+ m_lock->unlock();\r
+ m_log.debug("session found locally, validating it for use");\r
+ }\r
+ else {\r
+ m_lock->unlock();\r
+ }\r
+ }\r
+\r
+ if (!session) {\r
+ if (!SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {\r
+ m_log.debug("session not found locally, remoting the search");\r
+ // Remote the request.\r
+ DDF in("find::"STORAGESERVICE_SESSION_CACHE"::SessionCache"), out;\r
+ DDFJanitor jin(in);\r
+ in.structure();\r
+ in.addmember("key").string(key);\r
+ in.addmember("application_id").string(application.getId());\r
+ if (timeout && *timeout) {\r
+ // On 64-bit Windows, time_t doesn't fit in a long, so I'm using ISO timestamps. \r
+#ifndef HAVE_GMTIME_R\r
+ struct tm* ptime=gmtime(timeout);\r
+#else\r
+ struct tm res;\r
+ struct tm* ptime=gmtime_r(timeout,&res);\r
+#endif\r
+ char timebuf[32];\r
+ strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);\r
+ in.addmember("timeout").string(timebuf);\r
+ }\r
+ \r
+ try {\r
+ out=application.getServiceProvider().getListenerService()->send(in);\r
+ if (!out.isstruct()) {\r
+ out.destroy();\r
+ m_log.debug("session not found in remote cache");\r
+ return NULL;\r
+ }\r
+ \r
+ // Wrap the results in a local entry and save it.\r
+ session = new StoredSession(this, out);\r
+ // The remote end has handled timeout issues, we handle address and expiration checks.\r
+ timeout = NULL;\r
+ }\r
+ catch (...) {\r
+ out.destroy();\r
+ throw;\r
+ }\r
+ }\r
+ else {\r
+ // We're out of process, so we can search the storage service directly.\r
+#ifndef SHIBSP_LITE\r
+ if (!m_storage)\r
+ throw ConfigurationException("SessionCache lookup requires a StorageService.");\r
+\r
+ m_log.debug("searching for session (%s)", key);\r
+ \r
+ DDF obj;\r
+ time_t lastAccess;\r
+ string record;\r
+ int ver = m_storage->readText(key, "session", &record, &lastAccess);\r
+ if (!ver)\r
+ return NULL;\r
+ \r
+ m_log.debug("reconstituting session and checking validity");\r
+ \r
+ istringstream in(record);\r
+ in >> obj;\r
+ \r
+ lastAccess -= m_cacheTimeout; // adjusts it back to the last time the record's timestamp was touched\r
+ time_t now=time(NULL);\r
+ \r
+ if (timeout && *timeout > 0 && now - lastAccess >= *timeout) {\r
+ m_log.info("session timed out (ID: %s)", key);\r
+ remove(application, key);\r
+ const char* eid = obj["entity_id"].string();\r
+ if (!eid) {\r
+ obj.destroy();\r
+ throw RetryableProfileException("Your session has expired, and you must re-authenticate.");\r
+ }\r
+ string eid2(eid);\r
+ obj.destroy();\r
+ throw RetryableProfileException("Your session has expired, and you must re-authenticate.", namedparams(1, "entityID", eid2.c_str()));\r
+ }\r
+ \r
+ if (timeout) {\r
+ // Update storage expiration, if possible.\r
+ try {\r
+ m_storage->updateContext(key, now + m_cacheTimeout);\r
+ }\r
+ catch (exception& ex) {\r
+ m_log.error("failed to update session expiration: %s", ex.what());\r
+ }\r
+ }\r
+\r
+ // Wrap the results in a local entry and save it.\r
+ session = new StoredSession(this, obj);\r
+ // We handled timeout issues, still need to handle address and expiration checks.\r
+ timeout = NULL;\r
+#else\r
+ throw ConfigurationException("SessionCache search requires a StorageService.");\r
+#endif\r
+ }\r
+\r
+ if (inproc) {\r
+ // Lock for writing and repeat the search to avoid duplication.\r
+ m_lock->wrlock();\r
+ SharedLock shared(m_lock, false);\r
+ if (m_hashtable.count(key)) {\r
+ // We're using an existing session entry.\r
+ delete session;\r
+ session = m_hashtable[key];\r
+ session->lock();\r
+ }\r
+ else {\r
+ m_hashtable[key]=session;\r
+ session->lock();\r
+ }\r
+ }\r
+ }\r
+\r
+ if (!XMLString::equals(session->getApplicationID(), application.getId())) {\r
+ m_log.error("an application (%s) tried to access another application's session", application.getId());\r
+ session->unlock();\r
+ return NULL;\r
+ }\r
+\r
+ // Verify currency and update the timestamp if indicated by caller.\r
+ try {\r
+ session->validate(application, client_addr, timeout);\r
+ }\r
+ catch (...) {\r
+ session->unlock();\r
+ remove(application, key);\r
+ throw;\r
+ }\r
+ \r
+ return session;\r
+}\r
+\r
+void SSCache::remove(const Application& application, const char* key)\r
+{\r
+#ifdef _DEBUG\r
+ xmltooling::NDC ndc("remove");\r
+#endif\r
+ // Take care of local copy.\r
+ if (inproc)\r
+ dormant(key);\r
+ \r
+ if (SPConfig::getConfig().isEnabled(SPConfig::OutOfProcess)) {\r
+ // Remove the session from storage directly.\r
+#ifndef SHIBSP_LITE\r
+ m_storage->deleteContext(key);\r
+ m_log.info("removed session (%s)", key);\r
+\r
+ TransactionLog* xlog = application.getServiceProvider().getTransactionLog();\r
+ Locker locker(xlog);\r
+ xlog->log.info("Destroyed session (applicationId: %s) (ID: %s)", application.getId(), key);\r
+#else\r
+ throw ConfigurationException("SessionCache removal requires a StorageService.");\r
+#endif\r
+ }\r
+ else {\r
+ // Remote the request.\r
+ DDF in("remove::"STORAGESERVICE_SESSION_CACHE"::SessionCache");\r
+ DDFJanitor jin(in);\r
+ in.structure();\r
+ in.addmember("key").string(key);\r
+ in.addmember("application_id").string(application.getId());\r
+ \r
+ DDF out = application.getServiceProvider().getListenerService()->send(in);\r
+ out.destroy();\r
+ }\r
+}\r
+\r
+void SSCache::dormant(const char* key)\r
+{\r
+#ifdef _DEBUG\r
+ xmltooling::NDC ndc("dormant");\r
+#endif\r
+\r
+ m_log.debug("deleting local copy of session (%s)", key);\r
+\r
+ // lock the cache for writing, which means we know nobody is sitting in find()\r
+ m_lock->wrlock();\r
+\r
+ // grab the entry from the table\r
+ map<string,StoredSession*>::const_iterator i=m_hashtable.find(key);\r
+ if (i==m_hashtable.end()) {\r
+ m_lock->unlock();\r
+ return;\r
+ }\r
+\r
+ // ok, remove the entry and lock it\r
+ StoredSession* entry=i->second;\r
+ m_hashtable.erase(key);\r
+ entry->lock();\r
+ \r
+ // unlock the cache\r
+ m_lock->unlock();\r
+\r
+ // we can release the cache entry lock because we know we're not in the cache anymore\r
+ entry->unlock();\r
+\r
+ delete entry;\r
+}\r
+\r
+void SSCache::cleanup()\r
+{\r
+#ifdef _DEBUG\r
+ xmltooling::NDC ndc("cleanup");\r
+#endif\r
+\r
+ Mutex* mutex = Mutex::create();\r
+ \r
+ // Load our configuration details...\r
+ static const XMLCh cleanupInterval[] = UNICODE_LITERAL_15(c,l,e,a,n,u,p,I,n,t,e,r,v,a,l);\r
+ const XMLCh* tag=m_root ? m_root->getAttributeNS(NULL,cleanupInterval) : NULL;\r
+ int rerun_timer = 900;\r
+ if (tag && *tag)\r
+ rerun_timer = XMLString::parseInt(tag);\r
+ if (rerun_timer <= 0)\r
+ rerun_timer = 900;\r
+\r
+ mutex->lock();\r
+\r
+ m_log.info("cleanup thread started...run every %d secs; timeout after %d secs", rerun_timer, m_inprocTimeout);\r
+\r
+ while (!shutdown) {\r
+ shutdown_wait->timedwait(mutex,rerun_timer);\r
+ if (shutdown)\r
+ break;\r
+\r
+ // Ok, let's run through the cleanup process and clean out\r
+ // really old sessions. This is a two-pass process. The\r
+ // first pass is done holding a read-lock while we iterate over\r
+ // the cache. The second pass doesn't need a lock because\r
+ // the 'deletes' will lock the cache.\r
+ \r
+ // Pass 1: iterate over the map and find all entries that have not been\r
+ // used in the allotted timeout.\r
+ vector<string> stale_keys;\r
+ time_t stale = time(NULL) - m_inprocTimeout;\r
+ \r
+ m_log.debug("cleanup thread running");\r
+\r
+ m_lock->rdlock();\r
+ for (map<string,StoredSession*>::const_iterator i=m_hashtable.begin(); i!=m_hashtable.end(); ++i) {\r
+ // If the last access was BEFORE the stale timeout...\r
+ i->second->lock();\r
+ time_t last=i->second->getLastAccess();\r
+ i->second->unlock();\r
+ if (last < stale)\r
+ stale_keys.push_back(i->first);\r
+ }\r
+ m_lock->unlock();\r
+ \r
+ if (!stale_keys.empty()) {\r
+ m_log.info("purging %d old sessions", stale_keys.size());\r
+ \r
+ // Pass 2: walk through the list of stale entries and remove them from the cache\r
+ for (vector<string>::const_iterator j = stale_keys.begin(); j != stale_keys.end(); ++j)\r
+ dormant(j->c_str());\r
+ }\r
+\r
+ m_log.debug("cleanup thread completed");\r
+ }\r
+\r
+ m_log.info("cleanup thread exiting");\r
+\r
+ mutex->unlock();\r
+ delete mutex;\r
+ Thread::exit(NULL);\r
+}\r
+\r
+void* SSCache::cleanup_fn(void* cache_p)\r
+{\r
+#ifndef WIN32\r
+ // First, let's block all signals \r
+ Thread::mask_all_signals();\r
+#endif\r
+\r
+ // Now run the cleanup process.\r
+ reinterpret_cast<SSCache*>(cache_p)->cleanup();\r
+ return NULL;\r
+}\r
+\r
+#ifndef SHIBSP_LITE\r
+\r
+void SSCache::receive(DDF& in, ostream& out)\r
+{\r
+#ifdef _DEBUG\r
+ xmltooling::NDC ndc("receive");\r
+#endif\r
+\r
+ if (!strcmp(in.name(),"find::"STORAGESERVICE_SESSION_CACHE"::SessionCache")) {\r
+ const char* key=in["key"].string();\r
+ if (!key)\r
+ throw ListenerException("Required parameters missing for session lookup.");\r
+\r
+ const Application* app = SPConfig::getConfig().getServiceProvider()->getApplication(in["application_id"].string());\r
+ if (!app)\r
+ throw ListenerException("Application not found, check configuration?");\r
+\r
+ // Do an unversioned read.\r
+ string record;\r
+ time_t lastAccess;\r
+ if (!m_storage->readText(key, "session", &record, &lastAccess)) {\r
+ DDF ret(NULL);\r
+ DDFJanitor jan(ret);\r
+ out << ret;\r
+ return;\r
+ }\r
+\r
+ // Adjust for expiration to recover last access time and check timeout.\r
+ lastAccess -= m_cacheTimeout;\r
+ time_t now=time(NULL);\r
+\r
+ // See if we need to check for a timeout.\r
+ if (in["timeout"].string()) {\r
+ time_t timeout = 0;\r
+ auto_ptr_XMLCh dt(in["timeout"].string());\r
+ DateTime dtobj(dt.get());\r
+ dtobj.parseDateTime();\r
+ timeout = dtobj.getEpoch();\r
+ \r
+ if (timeout > 0 && now - lastAccess >= timeout) {\r
+ m_log.info("session timed out (ID: %s)", key);\r
+ remove(*app, key);\r
+ throw RetryableProfileException("Your session has expired, and you must re-authenticate.");\r
+ } \r
+\r
+ // Update storage expiration, if possible.\r
+ try {\r
+ m_storage->updateContext(key, now + m_cacheTimeout);\r
+ }\r
+ catch (exception& ex) {\r
+ m_log.error("failed to update session expiration: %s", ex.what());\r
+ }\r
+ }\r
+ \r
+ // Send the record back.\r
+ out << record;\r
+ }\r
+ else if (!strcmp(in.name(),"touch::"STORAGESERVICE_SESSION_CACHE"::SessionCache")) {\r
+ const char* key=in["key"].string();\r
+ if (!key)\r
+ throw ListenerException("Required parameters missing for session check.");\r
+\r
+ // Do a versioned read.\r
+ string record;\r
+ time_t lastAccess;\r
+ int curver = in["version"].integer();\r
+ int ver = m_storage->readText(key, "session", &record, &lastAccess, curver);\r
+ if (ver == 0) {\r
+ m_log.warn("unsuccessful versioned read of session (ID: %s), caches out of sync?", key);\r
+ throw RetryableProfileException("Your session has expired, and you must re-authenticate.");\r
+ }\r
+\r
+ // Adjust for expiration to recover last access time and check timeout.\r
+ lastAccess -= m_cacheTimeout;\r
+ time_t now=time(NULL);\r
+\r
+ // See if we need to check for a timeout.\r
+ time_t timeout = 0;\r
+ auto_ptr_XMLCh dt(in["timeout"].string());\r
+ if (dt.get()) {\r
+ DateTime dtobj(dt.get());\r
+ dtobj.parseDateTime();\r
+ timeout = dtobj.getEpoch();\r
+ }\r
+ \r
+ if (timeout > 0 && now - lastAccess >= timeout) {\r
+ m_log.info("session timed out (ID: %s)", key);\r
+ throw RetryableProfileException("Your session has expired, and you must re-authenticate.");\r
+ } \r
+\r
+ // Update storage expiration, if possible.\r
+ try {\r
+ m_storage->updateContext(key, now + m_cacheTimeout);\r
+ }\r
+ catch (exception& ex) {\r
+ m_log.error("failed to update session expiration: %s", ex.what());\r
+ }\r
+ \r
+ if (ver > curver) {\r
+ // Send the record back.\r
+ out << record;\r
+ }\r
+ else {\r
+ DDF ret(NULL);\r
+ DDFJanitor jan(ret);\r
+ out << ret;\r
+ }\r
+ }\r
+ else if (!strcmp(in.name(),"remove::"STORAGESERVICE_SESSION_CACHE"::SessionCache")) {\r
+ const char* key=in["key"].string();\r
+ if (!key)\r
+ throw ListenerException("Required parameter missing for session removal.");\r
+\r
+ const Application* app = SPConfig::getConfig().getServiceProvider()->getApplication(in["application_id"].string());\r
+ if (!app)\r
+ throw ConfigurationException("Application not found, check configuration?");\r
+\r
+ remove(*app, key);\r
+ DDF ret(NULL);\r
+ DDFJanitor jan(ret);\r
+ out << ret;\r
+ }\r
+}\r
+\r
+#endif\r
projects / shibboleth / cpp-sp.git / commitdiff