Inheritance diagram for SimpleSAML\SessionHandlerCookie:

Collaboration diagram for SimpleSAML\SessionHandlerCookie:

Public Member Functions
	newSessionId ()
	Create a new session id. More...

	getCookieSessionId ()
	Retrieve the session ID saved in the session cookie, if there's one. More...

	getSessionCookieName ()
	Retrieve the session cookie name. More...

	hasSessionCookie ()
	Check whether the session cookie is set. More...

	setCookie ($sessionName, $sessionID, array $cookieParams=null)
	Set a session cookie. More...

Public Member Functions inherited from SimpleSAML\SessionHandler
	newSessionId ()
	Create a new session id. More...

	getCookieSessionId ()
	Retrieve the session ID saved in the session cookie, if there's one. More...

	getSessionCookieName ()
	Retrieve the session cookie name. More...

	saveSession (\SimpleSAML_Session $session)
	Save the session. More...

	loadSession ($sessionId=null)
	Load the session. More...

	setCookie ($sessionName, $sessionID, array $cookieParams=null)
	Set a session cookie. More...

	hasSessionCookie ()
	Check whether the session cookie is set. More...

	getCookieParams ()
	Get the cookie parameters that should be used for session cookies. More...

Protected Member Functions
	__construct ()
	This constructor initializes the session id based on what we receive in a cookie. More...

Protected Member Functions inherited from SimpleSAML\SessionHandler
	__construct ()
	This constructor is included in case it is needed in the future. More...

Protected Attributes
	$cookie_name

Static Private Member Functions
static	createSessionID ()
	This static function creates a session id. More...

static	isValidSessionID ($session_id)
	This static function validates a session id. More...

Private Attributes
	$session_id = null

Additional Inherited Members
Static Public Member Functions inherited from SimpleSAML\SessionHandler
static	getSessionHandler ()
	This function retrieves the current instance of the session handler. More...

Static Protected Attributes inherited from SimpleSAML\SessionHandler
static	$sessionHandler = null

Detailed Description

Definition at line 19 of file SessionHandlerCookie.php.

Constructor & Destructor Documentation

◆ __construct()

SimpleSAML\SessionHandlerCookie::__construct ( )

protected

This constructor initializes the session id based on what we receive in a cookie.

We create a new session id and set a cookie with this id if we don't have a session id.

Definition at line 42 of file SessionHandlerCookie.php.

References $config, and SimpleSAML_Configuration\getInstance().

     {
         // call the constructor in the base class in case it should become necessary in the future
         parent::__construct();
 
         $config = \SimpleSAML_Configuration::getInstance();
         $this->cookie_name = $config->getString('session.cookie.name', 'SimpleSAMLSessionID');
     }

Here is the call graph for this function:

Member Function Documentation

◆ createSessionID()

static SimpleSAML\SessionHandlerCookie::createSessionID ( )

staticprivate

This static function creates a session id.

A session id consists of 32 random hexadecimal characters.

Returns: string A random session id.

Definition at line 106 of file SessionHandlerCookie.php.

     {
         return bin2hex(openssl_random_pseudo_bytes(16));
     }

◆ getCookieSessionId()

SimpleSAML\SessionHandlerCookie::getCookieSessionId ( )

Retrieve the session ID saved in the session cookie, if there's one.

Returns: string|null The session id saved in the cookie or null if no session cookie was set.

Definition at line 71 of file SessionHandlerCookie.php.

References $_COOKIE.

     {
         if ($this->session_id === null) {
             if (self::hasSessionCookie()) {
                 // attempt to retrieve the session id from the cookie
                 $this->session_id = $_COOKIE[$this->cookie_name];
             }
 
             // check if we have a valid session id
             if (!self::isValidSessionID($this->session_id)) {
                 // invalid, disregard this session
                 return null;
             }
         }
 
         return $this->session_id;
     }

◆ getSessionCookieName()

SimpleSAML\SessionHandlerCookie::getSessionCookieName ( )

Retrieve the session cookie name.

Returns: string The session cookie name.

Definition at line 95 of file SessionHandlerCookie.php.

     {
         return $this->cookie_name;
     }

◆ hasSessionCookie()

SimpleSAML\SessionHandlerCookie::hasSessionCookie ( )

Check whether the session cookie is set.

This function will only return false if is is certain that the cookie isn't set.

Returns: boolean True if it was set, false otherwise.

Definition at line 145 of file SessionHandlerCookie.php.

References $_COOKIE.

     {
         return array_key_exists($this->cookie_name, $_COOKIE);
     }

◆ isValidSessionID()

static SimpleSAML\SessionHandlerCookie::isValidSessionID ( $session_id )

staticprivate

This static function validates a session id.

A session id is valid if it only consists of characters which are allowed in a session id and it is the correct length.

Parameters

string $session_id The session ID we should validate.

Returns: boolean True if this session ID is valid, false otherwise.

Definition at line 120 of file SessionHandlerCookie.php.

     {
         if (!is_string($session_id)) {
             return false;
         }
 
         if (strlen($session_id) != 32) {
             return false;
         }
 
         if (preg_match('/[^0-9a-f]/', $session_id)) {
             return false;
         }
 
         return true;
     }

◆ newSessionId()

SimpleSAML\SessionHandlerCookie::newSessionId ( )

Create a new session id.

Returns: string The new session id.

Definition at line 57 of file SessionHandlerCookie.php.

References SimpleSAML_Session\createSession().

     {
         $this->session_id = self::createSessionID();
         \SimpleSAML_Session::createSession($this->session_id);
 
         return $this->session_id;
     }

Here is the call graph for this function:

◆ setCookie()

SimpleSAML\SessionHandlerCookie::setCookie	(		$sessionName,
			$sessionID,
		array	$cookieParams = `null`
	)

Set a session cookie.

Parameters

string	$sessionName	The name of the session.
string \| null	$sessionID	The session ID to use. Set to null to delete the cookie.
array \| null	$cookieParams	Additional parameters to use for the session cookie.

Exceptions

Definition at line 160 of file SessionHandlerCookie.php.

References $params, and $sessionID.

     {
         assert('is_string($sessionName)');
         assert('is_string($sessionID) || is_null($sessionID)');
 
         if ($cookieParams !== null) {
             $params = array_merge($this->getCookieParams(), $cookieParams);
         } else {
             $params = $this->getCookieParams();
         }
 
         HTTP::setCookie($sessionName, $sessionID, $params, true);
     }

Field Documentation

◆ $cookie_name

SimpleSAML\SessionHandlerCookie::$cookie_name

protected

Definition at line 35 of file SessionHandlerCookie.php.

◆ $session_id

SimpleSAML\SessionHandlerCookie::$session_id = null

private

Definition at line 27 of file SessionHandlerCookie.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/simplesamlphp/simplesamlphp/lib/SimpleSAML/SessionHandlerCookie.php

Public Member Functions

Protected Member Functions

Protected Attributes

Static Private Member Functions

Private Attributes

Additional Inherited Members