2 * Copyright 2001-2007 Internet2
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
18 * @file shibsp/SessionCache.h
20 * Caches and manages user sessions
23 #ifndef __shibsp_sessioncache_h__
24 #define __shibsp_sessioncache_h__
26 #include <shibsp/base.h>
29 # include <saml/saml1/core/Assertions.h>
30 # include <saml/saml2/metadata/Metadata.h>
32 #include <xmltooling/Lockable.h>
36 class SHIBSP_API Application;
37 class SHIBSP_API Attribute;
39 class SHIBSP_API Session : public virtual xmltooling::Lockable
41 MAKE_NONCOPYABLE(Session);
47 * Returns the session key.
49 * @return unique ID of session
51 virtual const char* getID() const=0;
54 * Returns the address of the client associated with the session.
56 * @return the client's network address
58 virtual const char* getClientAddress() const=0;
61 * Returns the entityID of the IdP that initiated the session.
63 * @return the IdP's entityID
65 virtual const char* getEntityID() const=0;
68 * Returns the protocol family used to initiate the session.
70 * @return the protocol constant that represents the general SSO protocol used
72 virtual const char* getProtocol() const=0;
75 * Returns the UTC timestamp on the authentication event at the IdP.
77 * @return the UTC authentication timestamp
79 virtual const char* getAuthnInstant() const=0;
83 * Returns the NameID associated with a session.
85 * <p>SAML 1.x identifiers will be promoted to the 2.0 type.
87 * @return a SAML 2.0 NameID associated with the session, if any
89 virtual const opensaml::saml2::NameID* getNameID() const=0;
93 * Returns the SessionIndex provided with the session.
95 * @return the SessionIndex from the original SSO assertion, if any
97 virtual const char* getSessionIndex() const=0;
100 * Returns a URI containing an AuthnContextClassRef provided with the session.
102 * <p>SAML 1.x AuthenticationMethods will be returned as class references.
104 * @return a URI identifying the authentication context class
106 virtual const char* getAuthnContextClassRef() const=0;
109 * Returns a URI containing an AuthnContextDeclRef provided with the session.
111 * @return a URI identifying the authentication context declaration
113 virtual const char* getAuthnContextDeclRef() const=0;
116 * Returns the resolved attributes associated with the session.
118 * @return an immutable map of attributes keyed by attribute ID
120 virtual const std::multimap<std::string,Attribute*>& getAttributes() const=0;
123 * Returns the identifiers of the assertion(s) cached by the session.
125 * <p>The SSO assertion is guaranteed to be first in the set.
127 * @return an immutable array of AssertionID values
129 virtual const std::vector<const char*>& getAssertionIDs() const=0;
133 * Adds additional attributes to the session.
135 * @param attributes reference to an array of Attributes to cache (will be freed by cache)
137 virtual void addAttributes(const std::vector<Attribute*>& attributes)=0;
140 * Returns an assertion cached by the session.
142 * @param id identifier of the assertion to retrieve
143 * @return pointer to assertion, or NULL
145 virtual const opensaml::Assertion* getAssertion(const char* id) const=0;
148 * Stores an assertion in the session.
150 * @param assertion pointer to an assertion to cache (will be freed by cache)
152 virtual void addAssertion(opensaml::Assertion* assertion)=0;
157 * Creates and manages user sessions
159 * The cache abstracts a persistent (meaning across requests) cache of
160 * instances of the Session interface. Creation of new entries and entry
161 * lookup are confined to this interface to enable the implementation to
162 * remote and/or optimize calls by implementing custom versions of the
163 * Session interface as required.
165 class SHIBSP_API SessionCache
167 MAKE_NONCOPYABLE(SessionCache);
173 * <p>The following XML content is supported to configure the cache:
175 * <dt>cacheTimeout</dt>
176 * <dd>attribute containing maximum lifetime in seconds for unused sessions to remain in cache</dd>
179 * @param e root of DOM tree to configure the cache
181 SessionCache(const xercesc::DOMElement* e);
183 /** maximum lifetime in seconds for unused sessions to be cached */
184 unsigned long m_cacheTimeout;
187 virtual ~SessionCache() {}
191 * Inserts a new session into the cache.
193 * <p>The SSO tokens and Attributes remain owned by the caller and are copied by the cache.
195 * @param expires expiration time of session
196 * @param application reference to Application that owns the Session
197 * @param client_addr network address of client
198 * @param issuer issuing metadata of assertion issuer, if known
199 * @param protocol protocol family used to initiate the session
200 * @param nameid principal identifier, normalized to SAML 2, if any
201 * @param authn_instant UTC timestamp of authentication at IdP, if known
202 * @param session_index index of session between principal and IdP, if any
203 * @param authncontext_class method/category of authentication event, if known
204 * @param authncontext_decl specifics of authentication event, if known
205 * @param tokens assertions to cache with session, if any
206 * @param attributes optional map of resolved Attributes to cache with session
207 * @return newly created session's key
209 virtual std::string insert(
211 const Application& application,
212 const char* client_addr=NULL,
213 const opensaml::saml2md::EntityDescriptor* issuer=NULL,
214 const XMLCh* protocol=NULL,
215 const opensaml::saml2::NameID* nameid=NULL,
216 const XMLCh* authn_instant=NULL,
217 const XMLCh* session_index=NULL,
218 const XMLCh* authncontext_class=NULL,
219 const XMLCh* authncontext_decl=NULL,
220 const std::vector<const opensaml::Assertion*>* tokens=NULL,
221 const std::multimap<std::string,Attribute*>* attributes=NULL
225 * Deletes an existing session or sessions.
227 * @param issuer source of session(s)
228 * @param nameid name identifier associated with the session(s) to terminate
229 * @param index index of session, or NULL for all sessions associated with other parameters
230 * @param application reference to Application that owns the session(s)
231 * @param sessions on exit, contains the IDs of the matching sessions removed
234 const opensaml::saml2md::EntityDescriptor* issuer,
235 const opensaml::saml2::NameID& nameid,
237 const Application& application,
238 std::vector<std::string>& sessions
243 * Locates an existing session.
245 * <p>If the client address is supplied, then a check will be performed against
246 * the address recorded in the record.
248 * @param key session key
249 * @param application reference to Application that owns the Session
250 * @param client_addr network address of client (if known)
251 * @param timeout inactivity timeout to enforce (0 for none, NULL to bypass check/update of last access)
252 * @return pointer to locked Session, or NULL
254 virtual Session* find(
255 const char* key, const Application& application, const char* client_addr=NULL, time_t* timeout=NULL
259 * Deletes an existing session.
261 * @param key session key
262 * @param application reference to Application that owns the Session
264 virtual void remove(const char* key, const Application& application)=0;
268 /** SessionCache implementation backed by a StorageService. */
269 #define STORAGESERVICE_SESSION_CACHE "StorageService"
272 /** SessionCache implementation for lite builds that delegates to a remoted version. */
273 #define REMOTED_SESSION_CACHE "Remoted"
276 * Registers SessionCache classes into the runtime.
278 void SHIBSP_API registerSessionCaches();
281 #endif /* __shibsp_sessioncache_h__ */