Skip to content
Snippets Groups Projects
Commit 5d3e4cce authored by Jaime Perez Crespo's avatar Jaime Perez Crespo
Browse files

Fix phpdoc comments in SimpleSAML_SessionHandlerCookie plus a couple other minor fixes.

parent 701009c2
No related branches found
No related tags found
No related merge requests found
...@@ -7,7 +7,7 @@ ...@@ -7,7 +7,7 @@
* An authentication source is any system which somehow authenticate the user. * An authentication source is any system which somehow authenticate the user.
* *
* @author Olav Morken, UNINETT AS. * @author Olav Morken, UNINETT AS.
* @package simpleSAMLphp * @package SimpleSAMLphp
*/ */
abstract class SimpleSAML_Auth_Source abstract class SimpleSAML_Auth_Source
{ {
......
...@@ -170,5 +170,4 @@ abstract class SimpleSAML_SessionHandler ...@@ -170,5 +170,4 @@ abstract class SimpleSAML_SessionHandler
\SimpleSAML\Utils\HTTP::setCookie($name, $value, $params); \SimpleSAML\Utils\HTTP::setCookie($name, $value, $params);
} }
} }
...@@ -9,23 +9,31 @@ ...@@ -9,23 +9,31 @@
* session id. * session id.
* *
* @author Olav Morken, UNINETT AS. <andreas.solberg@uninett.no> * @author Olav Morken, UNINETT AS. <andreas.solberg@uninett.no>
* @package simpleSAMLphp * @package SimpleSAMLphp
* @abstract * @abstract
*/ */
abstract class SimpleSAML_SessionHandlerCookie abstract class SimpleSAML_SessionHandlerCookie
extends SimpleSAML_SessionHandler { extends SimpleSAML_SessionHandler {
/* This variable contains the current session id. */ /**
* This variable contains the current session id.
*
* @var string|null
*/
private $session_id = NULL; private $session_id = NULL;
/* This variable contains the session cookie name. */ /**
* This variable contains the session cookie name.
*
* @var string
*/
protected $cookie_name; protected $cookie_name;
/* This constructor initializes the session id based on what /**
* we receive in a cookie. We create a new session id and set * This constructor initializes the session id based on what we receive in a cookie. We create a new session id and
* a cookie with this id if we don't have a session id. * set a cookie with this id if we don't have a session id.
*/ */
protected function __construct() { protected function __construct() {
/* Call the constructor in the base class in case it should /* Call the constructor in the base class in case it should
...@@ -41,7 +49,7 @@ extends SimpleSAML_SessionHandler { ...@@ -41,7 +49,7 @@ extends SimpleSAML_SessionHandler {
/** /**
* Create and set new session id. * Create and set new session id.
* *
* @return string The new session id. * @return string The new session id.
*/ */
public function newSessionId() { public function newSessionId() {
$this->session_id = self::createSessionID(); $this->session_id = self::createSessionID();
...@@ -55,7 +63,7 @@ extends SimpleSAML_SessionHandler { ...@@ -55,7 +63,7 @@ extends SimpleSAML_SessionHandler {
/** /**
* Retrieve the session id of saved in the session cookie. * Retrieve the session id of saved in the session cookie.
* *
* @return string The session id saved in the cookie. * @return string The session id saved in the cookie.
*/ */
public function getCookieSessionId() { public function getCookieSessionId() {
if ($this->session_id === NULL) { if ($this->session_id === NULL) {
...@@ -78,7 +86,7 @@ extends SimpleSAML_SessionHandler { ...@@ -78,7 +86,7 @@ extends SimpleSAML_SessionHandler {
/** /**
* Retrieve the session cookie name. * Retrieve the session cookie name.
* *
* @return string The session cookie name. * @return string The session cookie name.
*/ */
public function getSessionCookieName() { public function getSessionCookieName() {
...@@ -86,26 +94,23 @@ extends SimpleSAML_SessionHandler { ...@@ -86,26 +94,23 @@ extends SimpleSAML_SessionHandler {
} }
/* This static function creates a session id. A session id consists /**
* of 32 random hexadecimal characters. * This static function creates a session id. A session id consists of 32 random hexadecimal characters.
* *
* Returns: * @return string A random session id.
* A random session id.
*/ */
private static function createSessionID() { private static function createSessionID() {
return bin2hex(openssl_random_pseudo_bytes(16)); return bin2hex(openssl_random_pseudo_bytes(16));
} }
/* 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 * This static function validates a session id. A session id is valid if it only consists of characters which are
* and it is the correct length. * allowed in a session id and it is the correct length.
* *
* Parameters: * @param string $session_id The session ID we should validate.
* $session_id The session id we should validate.
* *
* Returns: * @return boolean True if this session ID is valid, false otherwise.
* TRUE if this session id is valid, FALSE if not.
*/ */
private static function isValidSessionID($session_id) { private static function isValidSessionID($session_id) {
if(!is_string($session_id)) { if(!is_string($session_id)) {
...@@ -127,9 +132,9 @@ extends SimpleSAML_SessionHandler { ...@@ -127,9 +132,9 @@ extends SimpleSAML_SessionHandler {
/** /**
* Check whether the session cookie is set. * Check whether the session cookie is set.
* *
* This function will only return FALSE if is is certain that the cookie isn't set. * This function will only return false if is is certain that the cookie isn't set.
* *
* @return bool TRUE if it was set, FALSE if not. * @return boolean True if it was set, false otherwise.
*/ */
public function hasSessionCookie() { public function hasSessionCookie() {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment