virtual ~Session() {}
public:
/**
+ * Returns the session key.
+ *
+ * @return unique ID of session
+ */
+ virtual const char* getID() const=0;
+
+ /**
* Returns the address of the client associated with the session.
*
* @return the client's network address
* @return the IdP's entityID
*/
virtual const char* getEntityID() const=0;
-
+
+ /**
+ * Returns the protocol family used to initiate the session.
+ *
+ * @return the protocol constant that represents the general SSO protocol used
+ */
+ virtual const char* getProtocol() const=0;
+
/**
* Returns the UTC timestamp on the authentication event at the IdP.
*
/**
* Returns the resolved attributes associated with the session.
*
+ * @return an immutable array of attributes
+ */
+ virtual const std::vector<Attribute*>& getAttributes() const=0;
+
+ /**
+ * Returns the resolved attributes associated with the session, indexed by ID
+ *
* @return an immutable map of attributes keyed by attribute ID
*/
- virtual const std::multimap<std::string,Attribute*>& getAttributes() const=0;
+ virtual const std::multimap<std::string,const Attribute*>& getIndexedAttributes() const=0;
/**
* Returns the identifiers of the assertion(s) cached by the session.
* <dd>attribute containing maximum lifetime in seconds for unused sessions to remain in cache</dd>
* </dl>
*
- * @param e root of DOM tree to configure the cache
+ * @param e root of DOM tree to configure the cache
+ * @param defaultTimeout default cacheTimeout setting to use if none specified in DOM
*/
- SessionCache(const xercesc::DOMElement* e);
+ SessionCache(const xercesc::DOMElement* e, unsigned long defaultTimeout=3600);
- /** maximum lifetime in seconds for unused sessions to be cached */
+ /** Maximum lifetime in seconds for unused sessions to be cached. */
unsigned long m_cacheTimeout;
public:
/**
* Inserts a new session into the cache.
*
- * <p>The SSO token remains owned by the caller and is copied by the
- * cache. Any Attributes supplied become the property of the cache.
+ * <p>The SSO tokens and Attributes remain owned by the caller and are copied by the cache.
*
* @param expires expiration time of session
* @param application reference to Application that owns the Session
* @param client_addr network address of client
* @param issuer issuing metadata of assertion issuer, if known
+ * @param protocol protocol family used to initiate the session
* @param nameid principal identifier, normalized to SAML 2, if any
* @param authn_instant UTC timestamp of authentication at IdP, if known
* @param session_index index of session between principal and IdP, if any
* @param authncontext_class method/category of authentication event, if known
* @param authncontext_decl specifics of authentication event, if known
* @param tokens assertions to cache with session, if any
- * @param attributes optional map of resolved Attributes to cache with session
+ * @param attributes optional array of resolved Attributes to cache with session
* @return newly created session's key
*/
virtual std::string insert(
const Application& application,
const char* client_addr=NULL,
const opensaml::saml2md::EntityDescriptor* issuer=NULL,
+ const XMLCh* protocol=NULL,
const opensaml::saml2::NameID* nameid=NULL,
- const char* authn_instant=NULL,
- const char* session_index=NULL,
- const char* authncontext_class=NULL,
- const char* authncontext_decl=NULL,
+ const XMLCh* authn_instant=NULL,
+ const XMLCh* session_index=NULL,
+ const XMLCh* authncontext_class=NULL,
+ const XMLCh* authncontext_decl=NULL,
const std::vector<const opensaml::Assertion*>* tokens=NULL,
- const std::multimap<std::string,Attribute*>* attributes=NULL
+ const std::vector<Attribute*>* attributes=NULL
+ )=0;
+
+ /**
+ * Returns active sessions that match particular parameters and records the logout
+ * to prevent race conditions.
+ *
+ * <p>On exit, the mapping between these sessions and the associated information MAY be
+ * removed by the cache, so subsequent calls to this method may not return anything.
+ *
+ * <p>Until logout expiration, any attempt to create a session with the same parameters
+ * will be blocked by the cache.
+ *
+ * @param issuer source of session(s)
+ * @param nameid name identifier associated with the session(s) to terminate
+ * @param indexes indexes of sessions, or NULL for all sessions associated with other parameters
+ * @param expires logout expiration
+ * @param application reference to Application that owns the session(s)
+ * @param sessions on exit, contains the IDs of the matching sessions found
+ */
+ virtual std::vector<std::string>::size_type logout(
+ const opensaml::saml2md::EntityDescriptor* issuer,
+ const opensaml::saml2::NameID& nameid,
+ const std::set<std::string>* indexes,
+ time_t expires,
+ const Application& application,
+ std::vector<std::string>& sessions
+ )=0;
+
+ /**
+ * Determines whether a given session (based on its ID) matches a set of input
+ * criteria.
+ *
+ * @param key session key to check
+ * @param issuer required source of session(s)
+ * @param nameid required name identifier
+ * @param indexes session indexes
+ * @param application reference to Application that owns the Session
+ * @return true iff the session matches the input criteria
+ */
+ virtual bool matches(
+ const char* key,
+ const opensaml::saml2md::EntityDescriptor* issuer,
+ const opensaml::saml2::NameID& nameid,
+ const std::set<std::string>* indexes,
+ const Application& application
)=0;
#endif
* @param key session key
* @param application reference to Application that owns the Session
* @param client_addr network address of client (if known)
- * @param timeout inactivity timeout to enforce (0 for none)
+ * @param timeout inactivity timeout to enforce (0 for none, NULL to bypass check/update of last access)
* @return pointer to locked Session, or NULL
*/
- virtual Session* find(const char* key, const Application& application, const char* client_addr=NULL, time_t timeout=0)=0;
+ virtual Session* find(
+ const char* key, const Application& application, const char* client_addr=NULL, time_t* timeout=NULL
+ )=0;
/**
* Deletes an existing session.
*
* @param key session key
* @param application reference to Application that owns the Session
- * @param client_addr network address of client (if known)
*/
- virtual void remove(const char* key, const Application& application, const char* client_addr)=0;
+ virtual void remove(const char* key, const Application& application)=0;
};
#ifndef SHIBSP_LITE
projects / shibboleth / sp.git / blobdiff