#include "Application.h"
#include "exceptions.h"
#include "ServiceProvider.h"
-#include "SessionCache.h"
+#include "SessionCacheEx.h"
#include "TransactionLog.h"
#include "attribute/Attribute.h"
#include "remoting/ListenerService.h"
#include "util/SPConstants.h"
-#include <saml/SAMLConfig.h>
#include <xmltooling/util/NDC.h>
-#include <xmltooling/util/StorageService.h>
#include <xmltooling/util/XMLHelper.h>
#include <xercesc/util/XMLUniDefs.hpp>
-using namespace shibsp;
+#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 SSCache;
+ 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), m_nameid(NULL), m_cache(cache) {
+ 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.
janitor.release();
m_nameid = n.release();
}
+#endif
+ if (cache->inproc)
+ m_lock = Mutex::create();
}
- ~StoredSession();
+ ~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() {
- delete this;
+ 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* getAuthnInstant() const {
return m_obj["authn_instant"].string();
}
- const opensaml::saml2::NameID* getNameID() const {
+#ifndef SHIBSP_LITE
+ const saml2::NameID* getNameID() const {
return m_nameid;
}
+#endif
const char* getSessionIndex() const {
return m_obj["session_index"].string();
}
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(make_pair(*alias, *a));
+ m_attributeIndex.insert(multimap<string,const Attribute*>::value_type(*alias, *a));
}
}
return m_attributeIndex;
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;
- mutable map<string,Assertion*> m_tokens;
+
SSCache* m_cache;
+ time_t m_expires,m_lastAccess;
+ Mutex* m_lock;
};
- class SSCache : public SessionCache, public virtual Remoted
- {
- public:
- SSCache(const DOMElement* e);
- ~SSCache();
-
- void receive(DDF& in, ostream& out);
-
- string insert(
- time_t expires,
- const Application& application,
- const char* client_addr=NULL,
- 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
- );
- Session* find(const char* key, const Application& application, const char* client_addr=NULL, time_t* timeout=NULL);
- void remove(const char* key, const Application& application);
- bool matches(
- const char* key,
- const saml2md::EntityDescriptor* issuer,
- const saml2::NameID& nameid,
- const set<string>* indexes,
- const Application& application
- );
- vector<string>::size_type logout(
- const saml2md::EntityDescriptor* issuer,
- const saml2::NameID& nameid,
- const set<string>* indexes,
- time_t expires,
- const Application& application,
- vector<string>& sessions
- );
-
- Category& m_log;
- StorageService* m_storage;
-
- private:
- // 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;
- };
-
SessionCache* SHIBSP_DLLLOCAL StorageServiceCacheFactory(const DOMElement* const & e)
{
return new SSCache(e);
}
-
- static const XMLCh _StorageService[] = UNICODE_LITERAL_14(S,t,o,r,a,g,e,S,e,r,v,i,c,e);
}
-StoredSession::~StoredSession()
+void SHIBSP_API shibsp::registerSessionCaches()
{
- m_obj.destroy();
- delete m_nameid;
- for_each(m_attributes.begin(), m_attributes.end(), xmltooling::cleanup<Attribute>());
- for_each(m_tokens.begin(), m_tokens.end(), cleanup_pair<string,Assertion>());
+ SPConfig::getConfig().SessionCacheManager.registerFactory(STORAGESERVICE_SESSION_CACHE, StorageServiceCacheFactory);
}
void StoredSession::unmarshallAttributes() const
try {
attribute = Attribute::unmarshall(attr);
m_attributes.push_back(attribute);
- m_attributeIndex.insert(make_pair(attribute->getId(), 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" : "");
}
}
+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;
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;
#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.");
);
}
+#endif
+
SSCache::SSCache(const DOMElement* e)
- : SessionCache(e, 3600), m_log(Category::getInstance(SHIBSP_LOGCAT".SessionCache")), m_storage(NULL)
+ : 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();
- 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());
- else
+ 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 (listener && conf.isEnabled(SPConfig::OutOfProcess)) {
- listener->regListener("find::"REMOTED_SESSION_CACHE"::SessionCache",this);
- listener->regListener("remove::"REMOTED_SESSION_CACHE"::SessionCache",this);
- listener->regListener("touch::"REMOTED_SESSION_CACHE"::SessionCache",this);
- listener->regListener("getAssertion::"REMOTED_SESSION_CACHE"::SessionCache",this);
+ 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 {
- m_log.info("no ListenerService available, cache remoting disabled");
+ 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()
{
- SPConfig& conf = SPConfig::getConfig();
- ListenerService* listener=conf.getServiceProvider()->getListenerService(false);
- if (listener && conf.isEnabled(SPConfig::OutOfProcess)) {
- listener->unregListener("find::"REMOTED_SESSION_CACHE"::SessionCache",this);
- listener->unregListener("remove::"REMOTED_SESSION_CACHE"::SessionCache",this);
- listener->unregListener("touch::"REMOTED_SESSION_CACHE"::SessionCache",this);
- listener->unregListener("getAssertion::"REMOTED_SESSION_CACHE"::SessionCache",this);
+ 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 SSCache::insert(
- time_t expires,
+void SSCache::insert(
const Application& application,
- const char* client_addr,
+ const HTTPRequest& httpRequest,
+ HTTPResponse& httpResponse,
+ time_t expires,
const saml2md::EntityDescriptor* issuer,
const XMLCh* protocol,
const saml2::NameID* nameid,
#ifdef _DEBUG
xmltooling::NDC ndc("insert");
#endif
+ if (!m_storage)
+ throw ConfigurationException("SessionCache insertion requires a StorageService.");
m_log.debug("creating new session");
istringstream pstr(pending);
pstr >> pendobj;
// IdP.SP.index contains logout expiration, if any.
- DDF deadmenwalking = pendobj[issuer ? entity_id.get() : "_shibnull"][application.getString("entityID").second];
+ 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();
strftime(timebuf,32,"%Y-%m-%dT%H:%M:%SZ",ptime);
obj.addmember("expires").string(timebuf);
- if (client_addr)
- obj.addmember("client_addr").string(client_addr);
+ obj.addmember("client_addr").string(httpRequest.getRemoteAddr().c_str());
if (issuer)
obj.addmember("entity_id").string(entity_id.get());
if (protocol) {
}
const char* pid = obj["entity_id"].string();
- m_log.info("new session created: SessionID (%s) IdP (%s) Address (%s)", key.get(), pid ? pid : "none", client_addr);
+ m_log.info("new session created: SessionID (%s) IdP (%s) Address (%s)", key.get(), pid ? pid : "none", httpRequest.getRemoteAddr().c_str());
// Transaction Logging
TransactionLog* xlog = application.getServiceProvider().getTransactionLog();
") for principal from (IdP: " <<
(pid ? pid : "none") <<
") at (ClientAddress: " <<
- (client_addr ? client_addr : "none") <<
+ httpRequest.getRemoteAddr() <<
") with (NameIdentifier: " <<
(nameid ? name.get() : "none") <<
")";
xlog->log.info("}");
}
- return key.get();
-}
-
-Session* SSCache::find(const char* key, const Application& application, const char* client_addr, time_t* timeout)
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("find");
-#endif
-
- m_log.debug("searching for session (%s)", key);
-
- 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");
-
- DDF obj;
- istringstream in(record);
- in >> obj;
-
- if (!XMLString::equals(obj["application_id"].string(), application.getId())) {
- m_log.error("an application (%s) tried to access another application's session", application.getId());
- obj.destroy();
- return NULL;
- }
-
- if (client_addr) {
- if (m_log.isDebugEnabled())
- m_log.debug("comparing client address %s against %s", client_addr, obj["client_addr"].string());
- if (strcmp(obj["client_addr"].string(),client_addr)) {
- m_log.warn("client address mismatch");
- remove(key, application);
- RetryableProfileException ex(
- "Your IP address ($1) does not match the address recorded at the time the session was established.",
- params(1,client_addr)
- );
- string eid(obj["entity_id"].string());
- obj.destroy();
- if (eid.empty())
- throw ex;
- MetadataProvider* m=application.getMetadataProvider();
- Locker locker(m);
- annotateException(&ex,m->getEntityDescriptor(eid.c_str(),false)); // throws it
- }
- }
-
- 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(key, application);
- RetryableProfileException ex("Your session has expired, and you must re-authenticate.");
- string eid(obj["entity_id"].string());
- obj.destroy();
- if (eid.empty())
- throw ex;
- MetadataProvider* m=application.getMetadataProvider();
- Locker locker(m);
- annotateException(&ex,m->getEntityDescriptor(eid.c_str(),false)); // throws it
- }
-
- auto_ptr_XMLCh exp(obj["expires"].string());
- if (exp.get()) {
- DateTime iso(exp.get());
- iso.parseDateTime();
- if (now > iso.getEpoch()) {
- m_log.info("session expired (ID: %s)", key);
- remove(key, application);
- RetryableProfileException ex("Your session has expired, and you must re-authenticate.");
- string eid(obj["entity_id"].string());
- obj.destroy();
- if (eid.empty())
- throw ex;
- MetadataProvider* m=application.getMetadataProvider();
- Locker locker(m);
- annotateException(&ex,m->getEntityDescriptor(eid.c_str(),false)); // throws it
- }
- }
-
- 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());
- }
- }
-
- // Finally build the Session object.
- try {
- return new StoredSession(this, obj);
- }
- catch (exception&) {
- obj.destroy();
- throw;
- }
-}
-
-void SSCache::remove(const char* key, const Application& application)
-{
-#ifdef _DEBUG
- xmltooling::NDC ndc("remove");
-#endif
-
- 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);
+ 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 char* key,
+ const Application& application,
+ const xmltooling::HTTPRequest& request,
const saml2md::EntityDescriptor* issuer,
const saml2::NameID& nameid,
- const set<string>* indexes,
- const Application& application
+ const set<string>* indexes
)
{
auto_ptr_char entityID(issuer ? issuer->getEntityID() : NULL);
try {
- Session* session = find(key, application);
+ Session* session = find(application, request);
if (session) {
- Locker locker(session);
+ Locker locker(session, false);
if (XMLString::equals(session->getEntityID(), entityID.get()) && session->getNameID() &&
- stronglyMatches(issuer->getEntityID(), application.getXMLString("entityID").second, nameid, *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): %s", key, ex.what());
+ 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,
- const Application& application,
vector<string>& sessionsKilled
)
{
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());
}
// 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.getString("entityID").second);
+ 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);
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(issuer, nameid, indexes, expires, application, sessionsKilled);
+ 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(issuer, nameid, indexes, expires, application, sessionsKilled);
+ return logout(application, issuer, nameid, indexes, expires, sessionsKilled);
}
obj.destroy();
// Fetch the session for comparison.
Session* session = NULL;
try {
- session = find(key.string(), application);
+ 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);
+ Locker locker(session, false);
// Same issuer?
if (XMLString::equals(session->getEntityID(), entityID.get())) {
// Same NameID?
- if (stronglyMatches(issuer->getEntityID(), application.getXMLString("entityID").second, nameid, *session->getNameID())) {
+ if (stronglyMatches(issuer->getEntityID(), application.getRelyingParty(issuer)->getXMLString("entityID").second, nameid, *session->getNameID())) {
sessionsKilled.push_back(key.string());
key.destroy();
}
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::"REMOTED_SESSION_CACHE"::SessionCache")) {
+ if (!strcmp(in.name(),"find::"STORAGESERVICE_SESSION_CACHE"::SessionCache")) {
const char* key=in["key"].string();
if (!key)
- throw ListenerException("Required parameters missing for session removal.");
+ throw ListenerException("Required parameters missing for session lookup.");
const Application* app = SPConfig::getConfig().getServiceProvider()->getApplication(in["application_id"].string());
if (!app)
if (timeout > 0 && now - lastAccess >= timeout) {
m_log.info("session timed out (ID: %s)", key);
- remove(key,*app);
+ remove(*app, key);
throw RetryableProfileException("Your session has expired, and you must re-authenticate.");
}
// Send the record back.
out << record;
}
- else if (!strcmp(in.name(),"touch::"REMOTED_SESSION_CACHE"::SessionCache")) {
+ 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.");
out << ret;
}
}
- else if (!strcmp(in.name(),"remove::"REMOTED_SESSION_CACHE"::SessionCache")) {
+ 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 ListenerException("Application not found, check configuration?");
+ throw ConfigurationException("Application not found, check configuration?");
- remove(key,*app);
+ remove(*app, key);
DDF ret(NULL);
DDFJanitor jan(ret);
out << ret;
}
- else if (!strcmp(in.name(),"getAssertion::"REMOTED_SESSION_CACHE"::SessionCache")) {
- const char* key=in["key"].string();
- const char* id=in["id"].string();
- if (!key || !id)
- throw ListenerException("Required parameters missing for assertion retrieval.");
- string token;
- if (!m_storage->readText(key, id, &token, NULL))
- throw FatalProfileException("Assertion not found in cache.");
- out << token;
- }
}
+
+#endif
projects / shibboleth / sp.git / blobdiff