shibsp/SessionCache.h

   1 /*
   2  *  Copyright 2001-2007 Internet2
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 /**
  18  * @file shibsp/SessionCache.h
  19  *
  20  * Caches and manages user sessions
  21  */
  22
  23 #ifndef __shibsp_sessioncache_h__
  24 #define __shibsp_sessioncache_h__
  25
  26 #include <shibsp/base.h>
  27
  28 #ifndef SHIBSP_LITE
  29 # include <saml/saml1/core/Assertions.h>
  30 # include <saml/saml2/metadata/Metadata.h>
  31 #endif
  32 #include <xmltooling/Lockable.h>
  33
  34 namespace shibsp {
  35
  36     class SHIBSP_API Application;
  37     class SHIBSP_API Attribute;
  38
  39     class SHIBSP_API Session : public virtual xmltooling::Lockable
  40     {
  41         MAKE_NONCOPYABLE(Session);
  42     protected:
  43         Session() {}
  44         virtual ~Session() {}
  45     public:
  46         /**
  47          * Returns the session key.
  48          *
  49          * @return unique ID of session
  50          */
  51         virtual const char* getID() const=0;
  52
  53         /**
  54          * Returns the address of the client associated with the session.
  55          *
  56          * @return  the client's network address
  57          */
  58         virtual const char* getClientAddress() const=0;
  59
  60         /**
  61          * Returns the entityID of the IdP that initiated the session.
  62          *
  63          * @return the IdP's entityID
  64          */
  65         virtual const char* getEntityID() const=0;
  66
  67         /**
  68          * Returns the UTC timestamp on the authentication event at the IdP.
  69          *
  70          * @return  the UTC authentication timestamp
  71          */
  72         virtual const char* getAuthnInstant() const=0;
  73
  74 #ifndef SHIBSP_LITE
  75         /**
  76          * Returns the NameID associated with a session.
  77          *
  78          * <p>SAML 1.x identifiers will be promoted to the 2.0 type.
  79          *
  80          * @return a SAML 2.0 NameID associated with the session, if any
  81          */
  82         virtual const opensaml::saml2::NameID* getNameID() const=0;
  83 #endif
  84
  85         /**
  86          * Returns the SessionIndex provided with the session.
  87          *
  88          * @return the SessionIndex from the original SSO assertion, if any
  89          */
  90         virtual const char* getSessionIndex() const=0;
  91
  92         /**
  93          * Returns a URI containing an AuthnContextClassRef provided with the session.
  94          *
  95          * <p>SAML 1.x AuthenticationMethods will be returned as class references.
  96          *
  97          * @return  a URI identifying the authentication context class
  98          */
  99         virtual const char* getAuthnContextClassRef() const=0;
 100
 101         /**
 102          * Returns a URI containing an AuthnContextDeclRef provided with the session.
 103          *
 104          * @return  a URI identifying the authentication context declaration
 105          */
 106         virtual const char* getAuthnContextDeclRef() const=0;
 107
 108         /**
 109          * Returns the resolved attributes associated with the session.
 110          *
 111          * @return an immutable map of attributes keyed by attribute ID
 112          */
 113         virtual const std::multimap<std::string,Attribute*>& getAttributes() const=0;
 114
 115         /**
 116          * Returns the identifiers of the assertion(s) cached by the session.
 117          *
 118          * <p>The SSO assertion is guaranteed to be first in the set.
 119          *
 120          * @return  an immutable array of AssertionID values
 121          */
 122         virtual const std::vector<const char*>& getAssertionIDs() const=0;
 123
 124 #ifndef SHIBSP_LITE
 125         /**
 126          * Adds additional attributes to the session.
 127          *
 128          * @param attributes    reference to an array of Attributes to cache (will be freed by cache)
 129          */
 130         virtual void addAttributes(const std::vector<Attribute*>& attributes)=0;
 131
 132         /**
 133          * Returns an assertion cached by the session.
 134          *
 135          * @param id    identifier of the assertion to retrieve
 136          * @return pointer to assertion, or NULL
 137          */
 138         virtual const opensaml::Assertion* getAssertion(const char* id) const=0;
 139
 140         /**
 141          * Stores an assertion in the session.
 142          *
 143          * @param assertion pointer to an assertion to cache (will be freed by cache)
 144          */
 145         virtual void addAssertion(opensaml::Assertion* assertion)=0;
 146 #endif
 147     };
 148
 149     /**
 150      * Creates and manages user sessions
 151      *
 152      * The cache abstracts a persistent (meaning across requests) cache of
 153      * instances of the Session interface. Creation of new entries and entry
 154      * lookup are confined to this interface to enable the implementation to
 155      * remote and/or optimize calls by implementing custom versions of the
 156      * Session interface as required.
 157      */
 158     class SHIBSP_API SessionCache
 159     {
 160         MAKE_NONCOPYABLE(SessionCache);
 161     protected:
 162
 163         /**
 164          * Constructor
 165          *
 166          * <p>The following XML content is supported to configure the cache:
 167          * <dl>
 168          *  <dt>cacheTimeout</dt>
 169          *  <dd>attribute containing maximum lifetime in seconds for unused sessions to remain in cache</dd>
 170          * </dl>
 171          *
 172          * @param e root of DOM tree to configure the cache
 173          */
 174         SessionCache(const xercesc::DOMElement* e);
 175
 176         /** maximum lifetime in seconds for unused sessions to be cached */
 177         unsigned long m_cacheTimeout;
 178
 179     public:
 180         virtual ~SessionCache() {}
 181
 182 #ifndef SHIBSP_LITE
 183         /**
 184          * Inserts a new session into the cache.
 185          *
 186          * <p>The SSO tokens and Attributes remain owned by the caller and are copied by the cache.
 187          *
 188          * @param expires           expiration time of session
 189          * @param application       reference to Application that owns the Session
 190          * @param client_addr       network address of client
 191          * @param issuer            issuing metadata of assertion issuer, if known
 192          * @param nameid            principal identifier, normalized to SAML 2, if any
 193          * @param authn_instant     UTC timestamp of authentication at IdP, if known
 194          * @param session_index     index of session between principal and IdP, if any
 195          * @param authncontext_class    method/category of authentication event, if known
 196          * @param authncontext_decl specifics of authentication event, if known
 197          * @param tokens            assertions to cache with session, if any
 198          * @param attributes        optional map of resolved Attributes to cache with session
 199          * @return  newly created session's key
 200          */
 201         virtual std::string insert(
 202             time_t expires,
 203             const Application& application,
 204             const char* client_addr=NULL,
 205             const opensaml::saml2md::EntityDescriptor* issuer=NULL,
 206             const opensaml::saml2::NameID* nameid=NULL,
 207             const char* authn_instant=NULL,
 208             const char* session_index=NULL,
 209             const char* authncontext_class=NULL,
 210             const char* authncontext_decl=NULL,
 211             const std::vector<const opensaml::Assertion*>* tokens=NULL,
 212             const std::multimap<std::string,Attribute*>* attributes=NULL
 213             )=0;
 214
 215         /**
 216          * Locates an existing session or sessions by subject identifier.
 217          *
 218          * @param issuer        source of session(s)
 219          * @param nameid        name identifier associated with the session(s) to locate
 220          * @param index         index of session, or NULL for all sessions associated with other parameters
 221          * @param application   reference to Application that owns the session(s)
 222          * @param sessions      on exit, contains the IDs of the matching sessions
 223          */
 224         virtual void find(
 225             const opensaml::saml2md::EntityDescriptor& issuer,
 226             const opensaml::saml2::NameID& nameid,
 227             const char* index,
 228             const Application& application,
 229             std::vector<std::string>& sessions
 230             )=0;
 231
 232         /**
 233          * Deletes an existing session or sessions.
 234          *
 235          * @param issuer        source of session(s)
 236          * @param nameid        name identifier associated with the session(s) to terminate
 237          * @param index         index of session, or NULL for all sessions associated with other parameters
 238          * @param application   reference to Application that owns the session(s)
 239          * @param sessions      on exit, contains the IDs of the matching sessions removed
 240          */
 241         virtual void remove(
 242             const opensaml::saml2md::EntityDescriptor& issuer,
 243             const opensaml::saml2::NameID& nameid,
 244             const char* index,
 245             const Application& application,
 246             std::vector<std::string>& sessions
 247             )=0;
 248 #endif
 249
 250         /**
 251          * Locates an existing session.
 252          *
 253          * <p>If the client address is supplied, then a check will be performed against
 254          * the address recorded in the record.
 255          *
 256          * @param key           session key
 257          * @param application   reference to Application that owns the Session
 258          * @param client_addr   network address of client (if known)
 259          * @param timeout       inactivity timeout to enforce (0 for none, NULL to bypass check/update of last access)
 260          * @return  pointer to locked Session, or NULL
 261          */
 262         virtual Session* find(
 263             const char* key, const Application& application, const char* client_addr=NULL, time_t* timeout=NULL
 264             )=0;
 265
 266         /**
 267          * Deletes an existing session.
 268          *
 269          * @param key           session key
 270          * @param application   reference to Application that owns the Session
 271          */
 272         virtual void remove(const char* key, const Application& application)=0;
 273     };
 274
 275 #ifndef SHIBSP_LITE
 276     /** SessionCache implementation backed by a StorageService. */
 277     #define STORAGESERVICE_SESSION_CACHE    "StorageService"
 278 #endif
 279
 280     /** SessionCache implementation for lite builds that delegates to a remoted version. */
 281     #define REMOTED_SESSION_CACHE    "Remoted"
 282
 283     /**
 284      * Registers SessionCache classes into the runtime.
 285      */
 286     void SHIBSP_API registerSessionCaches();
 287 };
 288
 289 #endif /* __shibsp_sessioncache_h__ */