silverstripe / silverstripe-hybridsessions

code/HybridSessionStore.php

Doc Comments +8 added lines, -5 removed lines

@@ -54,8 +54,8 @@ 
 	private $saltedKey;
 
 	/**
-	 * @param $key a per-site secret string which is used as the base encryption key.
-	 * @param $salt a per-session random string which is used as a salt to generate a per-session key
+	 * @param string $key a per-site secret string which is used as the base encryption key.
+	 * @param string $salt a per-session random string which is used as a salt to generate a per-session key
 	 *
 	 * The base encryption key needs to stay secret. If an attacker ever gets it, they can read their session,
 	 * and even modify & re-sign it.
@@ -79,7 +79,7 @@ 
 	/**
 	 * Encrypt and then sign some cleartext
 	 *
-	 * @param $cleartext - The cleartext to encrypt and sign
+	 * @param string $cleartext - The cleartext to encrypt and sign
 	 * @return string - The encrypted-and-signed message as base64 ASCII.
 	 */
 	public function encrypt($cleartext) {
@@ -101,8 +101,8 @@ 
 	/**
 	 * Check the signature on an encrypted-and-signed message, and if valid decrypt the content
 	 *
-	 * @param $data - The encrypted-and-signed message as base64 ASCII
-	 * @return bool|string - The decrypted cleartext or false if signature failed
+	 * @param string $data - The encrypted-and-signed message as base64 ASCII
+	 * @return string|false - The decrypted cleartext or false if signature failed
 	 */
 	public function decrypt($data) {
 		$data = base64_decode($data);
@@ -422,6 +422,9 @@ 
 		$this->setKey($this->getKey());
 	}
 
+	/**
+	 * @param string $key
+	 */
 	public function setKey($key) {
 		parent::setKey($key);
 		foreach($this->handlers as $handler) {

Spacing +20 added lines, -20 removed lines

@@ -7,7 +7,7 @@ 
  * Then, either way, add a new function "register_sessionhandler" which takes a SessionHandlerInterface and
  * registers it (including registering session_write_close as a shutdown function)
  */
-if(!interface_exists('SessionHandlerInterface')) {
+if (!interface_exists('SessionHandlerInterface')) {
 	interface SessionHandlerInterface {
 		/* Methods */
 		public function close();
@@ -19,7 +19,7 @@ 
 	}
 }
 
-if(version_compare(PHP_VERSION, '5.4.0', '<')) {
+if (version_compare(PHP_VERSION, '5.4.0', '<')) {
 	function register_sessionhandler($handler) {
 		session_set_save_handler(
 			array($handler, 'open'),
@@ -95,7 +95,7 @@ 
 
 		$hash = hash_hmac('sha256', $enc, $this->saltedKey);
 
-		return base64_encode($iv.$hash.$enc);
+		return base64_encode($iv . $hash . $enc);
 	}
 
 	/**
@@ -161,8 +161,8 @@ 
 	 */
 	protected function getLifetime() {
 		$params = session_get_cookie_params();
-		$cookieLifetime = (int)$params['lifetime'];
-		$gcLifetime = (int)ini_get('session.gc_maxlifetime');
+		$cookieLifetime = (int) $params['lifetime'];
+		$gcLifetime = (int) ini_get('session.gc_maxlifetime');
 		return $cookieLifetime ? min($cookieLifetime, $gcLifetime) : $gcLifetime;
 	}
 
@@ -172,7 +172,7 @@ 
 	 * @return int
 	 */
 	protected function getNow() {
-		return (int)SS_Datetime::now()->Format('U');
+		return (int) SS_Datetime::now()->Format('U');
 	}
 }
 
@@ -227,7 +227,7 @@ 
 	protected $currentCookieData;
 
 	public function open($save_path, $name) {
-		$this->cookie = $name.'_2';
+		$this->cookie = $name . '_2';
 		// Read the incoming value, then clear the cookie - we might not be able
 		// to do so later if write() is called after headers are sent
 		// This is intended to force a failover to the database store if the
@@ -247,7 +247,7 @@ 
 	 */
 	protected function getCrypto($session_id) {
 		$key = $this->getKey();
-		if(!$key) return null;
+		if (!$key) return null;
 		if (!$this->crypto || $this->crypto->salt != $session_id) {
 			$this->crypto = new HybridSessionStore_Crypto($key, $session_id);
 		}
@@ -256,7 +256,7 @@ 
 
 	public function read($session_id) {
 		// Check ability to safely decrypt content
-		if(!$this->currentCookieData
+		if (!$this->currentCookieData
 			|| !($crypto = $this->getCrypto($session_id))
 		) return;
 
@@ -266,7 +266,7 @@ 
 
 		// Verify expiration
 		if ($cookieData) {
-			$expiry = (int)substr($cookieData, 0, 10);
+			$expiry = (int) substr($cookieData, 0, 10);
 			$data = substr($cookieData, 10);
 
 			if ($expiry > $this->getNow()) return $data;
@@ -284,7 +284,7 @@ 
 
 	public function write($session_id, $session_data) {
 		// Check ability to safely encrypt and write content
-		if(!$this->canWrite()
+		if (!$this->canWrite()
 			|| (strlen($session_data) > Config::inst()->get(__CLASS__, 'max_length'))
 			|| !($crypto = $this->getCrypto($session_id))
 		) return false;
@@ -301,7 +301,7 @@ 
 		);
 
 		// Respect auto-expire on browser close for the session cookie (in case the cookie lifetime is zero)
-		$cookieLifetime = min((int)$params['lifetime'], $lifetime);
+		$cookieLifetime = min((int) $params['lifetime'], $lifetime);
 		Cookie::set(
 			$this->cookie,
 			$this->currentCookieData,
@@ -335,7 +335,7 @@ 
 	 */
 	protected function isDatabaseReady() {
 		// Such as during setup of testsession prior to DB connection.
-		if(!DB::isActive()) return false;
+		if (!DB::isActive()) return false;
 
 		// If we have a DB of the wrong type then complain
 		if (!(DB::getConn() instanceof MySQLDatabase)) {
@@ -353,7 +353,7 @@ 
 	}
 
 	public function read($session_id) {
-		if(!$this->isDatabaseReady()) return null;
+		if (!$this->isDatabaseReady()) return null;
 
 		$result = DB::query(sprintf(
 			'SELECT "Data" FROM "HybridSessionDataObject"
@@ -369,7 +369,7 @@ 
 	}
 
 	public function write($session_id, $session_data) {
-		if(!$this->isDatabaseReady()) return false;
+		if (!$this->isDatabaseReady()) return false;
 
 		$expiry = $this->getNow() + $this->getLifetime();
 		DB::query($str = sprintf(
@@ -389,7 +389,7 @@ 
 	}
 
 	public function gc($maxlifetime) {
-		if(!$this->isDatabaseReady()) return;
+		if (!$this->isDatabaseReady()) return;
 		DB::query(sprintf(
 			'DELETE FROM "HybridSessionDataObject" WHERE "Expiry" < %u',
 			$this->getNow()
@@ -424,7 +424,7 @@ 
 
 	public function setKey($key) {
 		parent::setKey($key);
-		foreach($this->handlers as $handler) {
+		foreach ($this->handlers as $handler) {
 			$handler->setKey($key);
 		}
 	}
@@ -444,7 +444,7 @@ 
 		return true;
 	}
 
-	public function close(){
+	public function close() {
 		foreach ($this->handlers as $handler) {
 			$handler->close();
 		}
@@ -485,7 +485,7 @@ 
 	 */
 	public static function init($key = null) {
 		$instance = Injector::inst()->get(__CLASS__);
-		if(empty($key)) {
+		if (empty($key)) {
 			user_error(
 				'HybridSessionStore::init() was not given a $key. Disabling cookie-based storage',
 				E_USER_WARNING
@@ -508,7 +508,7 @@ 
 	}
 
 	public function postRequest(SS_HTTPRequest $request, SS_HTTPResponse $response, DataModel $model) {
-		if(HybridSessionStore::is_enabled()) {
+		if (HybridSessionStore::is_enabled()) {
 			session_write_close();
 		}
 	}

Braces +37 added lines, -14 removed lines

@@ -32,8 +32,7 @@ 
 
 		register_shutdown_function('session_write_close');
 	}
-}
-else {
+} else {
 	function register_sessionhandler($handler) {
 		session_set_save_handler($handler, true);
 	}
@@ -122,7 +121,9 @@ 
 		// Needs to be after decrypt so it always runs, to avoid timing attack
 		$gen_hash = hash_hmac('sha256', $enc, $this->saltedKey);
 
-		if ($gen_hash == $hash) return $cleartext;
+		if ($gen_hash == $hash) {
+			return $cleartext;
+		}
 		return false;
 	}
 }
@@ -233,7 +234,9 @@ 
 		// This is intended to force a failover to the database store if the
 		// modified session cannot be emitted.
 		$this->currentCookieData = Cookie::get($this->cookie);
-		if ($this->currentCookieData) Cookie::set($this->cookie, '');
+		if ($this->currentCookieData) {
+			Cookie::set($this->cookie, '');
+		}
 	}
 
 	public function close() {
@@ -247,7 +250,9 @@ 
 	 */
 	protected function getCrypto($session_id) {
 		$key = $this->getKey();
-		if(!$key) return null;
+		if(!$key) {
+			return null;
+		}
 		if (!$this->crypto || $this->crypto->salt != $session_id) {
 			$this->crypto = new HybridSessionStore_Crypto($key, $session_id);
 		}
@@ -258,7 +263,9 @@ 
 		// Check ability to safely decrypt content
 		if(!$this->currentCookieData
 			|| !($crypto = $this->getCrypto($session_id))
-		) return;
+		) {
+			return;
+		}
 
 		// Decrypt and invalidate old data
 		$cookieData = $crypto->decrypt($this->currentCookieData);
@@ -269,7 +276,9 @@ 
 			$expiry = (int)substr($cookieData, 0, 10);
 			$data = substr($cookieData, 10);
 
-			if ($expiry > $this->getNow()) return $data;
+			if ($expiry > $this->getNow()) {
+				return $data;
+			}
 		}
 	}
 
@@ -287,7 +296,9 @@ 
 		if(!$this->canWrite()
 			|| (strlen($session_data) > Config::inst()->get(__CLASS__, 'max_length'))
 			|| !($crypto = $this->getCrypto($session_id))
-		) return false;
+		) {
+			return false;
+		}
 
 		// Prepare content for write
 		$params = session_get_cookie_params();
@@ -335,7 +346,9 @@ 
 	 */
 	protected function isDatabaseReady() {
 		// Such as during setup of testsession prior to DB connection.
-		if(!DB::isActive()) return false;
+		if(!DB::isActive()) {
+			return false;
+		}
 
 		// If we have a DB of the wrong type then complain
 		if (!(DB::getConn() instanceof MySQLDatabase)) {
@@ -353,7 +366,9 @@ 
 	}
 
 	public function read($session_id) {
-		if(!$this->isDatabaseReady()) return null;
+		if(!$this->isDatabaseReady()) {
+			return null;
+		}
 
 		$result = DB::query(sprintf(
 			'SELECT "Data" FROM "HybridSessionDataObject"
@@ -369,7 +384,9 @@ 
 	}
 
 	public function write($session_id, $session_data) {
-		if(!$this->isDatabaseReady()) return false;
+		if(!$this->isDatabaseReady()) {
+			return false;
+		}
 
 		$expiry = $this->getNow() + $this->getLifetime();
 		DB::query($str = sprintf(
@@ -389,7 +406,9 @@ 
 	}
 
 	public function gc($maxlifetime) {
-		if(!$this->isDatabaseReady()) return;
+		if(!$this->isDatabaseReady()) {
+			return;
+		}
 		DB::query(sprintf(
 			'DELETE FROM "HybridSessionDataObject" WHERE "Expiry" < %u',
 			$this->getNow()
@@ -454,7 +473,9 @@ 
 
 	public function read($session_id) {
 		foreach ($this->handlers as $handler) {
-			if ($data = $handler->read($session_id)) return $data;
+			if ($data = $handler->read($session_id)) {
+				return $data;
+			}
 		}
 
 		return '';
@@ -462,7 +483,9 @@ 
 
 	public function write($session_id, $session_data) {
 		foreach ($this->handlers as $handler) {
-			if ($handler->write($session_id, $session_data)) return;
+			if ($handler->write($session_id, $session_data)) {
+				return;
+			}
 		}
 	}