chillerlan\Session\SessionHandlerAbstract

Complexity

Total Complexity

18

Size/Duplication

Total Lines	170
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	active()	0	2	1
A	end()	0	11	2
A	isset()	0	2	1
A	get()	0	2	1
A	unset()	0	4	1
A	set()	0	4	1
A	start()	0	20	2
A	setOptions()	0	29	3
A	decrypt()	0	7	2
A	encrypt()	0	11	2
A	id()	0	2	1

<?php
/**
 * Class SessionHandlerAbstract
 *
 * @filesource   SessionHandlerAbstract.php
 * @created      06.03.2017
 * @package      chillerlan\Session
 * @author       Smiley <smiley@chillerlan.net>
 * @copyright    2017 Smiley
 * @license      MIT
 */

namespace chillerlan\Session;

use chillerlan\Logger\Output\NullLogger;
use chillerlan\Settings\SettingsContainerInterface;
use Psr\Log\{LoggerAwareInterface, LoggerAwareTrait, LoggerInterface};

abstract class SessionHandlerAbstract implements SessionInterface, LoggerAwareInterface{
	use LoggerAwareTrait;

	/**
	 * @var bool
	 */
	protected $started = false;

	/**
	 * @var \chillerlan\Session\SessionHandlerOptions
	 */
	protected $options;

	/**
	 * SessionHandlerAbstract constructor.
	 *
	 * @param \chillerlan\Settings\SettingsContainerInterface $options
	 * @param \Psr\Log\LoggerInterface|null                  $logger
	 */
	public function __construct(SettingsContainerInterface $options = null, LoggerInterface $logger = null){
		$this->options = $options ?? new SessionHandlerOptions;
		$this->logger  = $logger ?? new NullLogger;

It seems like $logger ?? new chillerlan\Logger\Output\NullLogger() can also be of type chillerlan\Logger\Output\NullLogger. However, the property $logger is declared as type Psr\Log\LoggerInterface. Maybe add an additional type check?

		$this->setOptions($options);

It seems like $options can also be of type null; however, parameter $options of chillerlan\Session\SessionHandlerAbstract::setOptions() does only seem to accept chillerlan\Settings\SettingsContainerInterface, maybe add an additional type check?

		\session_set_save_handler($this, true);
	}

	/**
	 * @inheritdoc
	 * @throws \chillerlan\Session\SessionHandlerException
	 */
	public function start():SessionInterface{

		if($this->active()){
			throw new SessionHandlerException('session already running');
		}

		$cookie_params = \session_get_cookie_params();

		\session_start();
		\session_regenerate_id(true);

		\setcookie(
			\session_name(),
			\session_id(),
			\time() + $this->options->cookie_lifetime,
			$this->options->cookie_path,
			$cookie_params['domain']
		);

		return $this;
	}

	/** @inheritdoc */
	public function end():SessionInterface{

		if($this->active()){
			\session_regenerate_id(true);
			\setcookie(session_name(), '', 0, $this->options->cookie_path);
			\session_unset();
			\session_destroy();
			\session_write_close();
		}

		return $this;
	}

	/** @inheritdoc */
	public function active():bool{
		return \session_status() === \PHP_SESSION_ACTIVE;
	}

	/** @inheritdoc */
	public function get(string $name){
		return $_SESSION[$name] ?? null;
	}

	/** @inheritdoc */
	public function set(string $name, $value):SessionInterface{
		$_SESSION[$name] = $value;

		return $this;
	}

	/** @inheritdoc */
	public function unset(string $name):SessionInterface{
		unset($_SESSION[$name]);

		return $this;
	}

	/** @inheritdoc */
	public function isset(string $name):bool{
		return isset($_SESSION[$name]);
	}

	/** @inheritdoc */
	public function id(string $newID = null):string{
		return session_id($newID);
	}

	/**
	 * @param string $data
	 *
	 * @return string
	 * @throws \chillerlan\Session\SessionHandlerException
	 */
	protected function encrypt(string &$data):string {

		if(\function_exists('sodium_crypto_secretbox')){
			$box = \sodium_crypto_secretbox($data, $this::SESSION_NONCE, \sodium_hex2bin($this->options->sessionCryptoKey));

			\sodium_memzero($data);

The call to sodium_memzero() has too few arguments starting with length.

			return \sodium_bin2hex($box);
		}

		throw new SessionHandlerException('sodium not installed'); // @codeCoverageIgnore
	}

	/**
	 * @param string $box
	 *
	 * @return string
	 * @throws \chillerlan\Session\SessionHandlerException
	 */
	protected function decrypt(string $box):string {

		if(\function_exists('sodium_crypto_secretbox_open')){
			return \sodium_crypto_secretbox_open(\sodium_hex2bin($box), $this::SESSION_NONCE, \sodium_hex2bin($this->options->sessionCryptoKey));
		}

		throw new SessionHandlerException('sodium not installed'); // @codeCoverageIgnore
	}

	/**
	 * @param \chillerlan\Settings\SettingsContainerInterface $options
	 *
	 * @return \chillerlan\Session\SessionInterface
	 */
	public function setOptions(SettingsContainerInterface $options):SessionInterface{

		// end an active session before setting new options
		if($this->active()){
			$this->end();
		}

		if(\is_writable($options->save_path)){
			\ini_set('session.save_path', $options->save_path);
		}

		// @todo http://php.net/manual/session.configuration.php
		\ini_set('session.name', $options->session_name);

		\ini_set('session.gc_maxlifetime', $options->gc_maxlifetime);
		\ini_set('session.gc_probability', '1');
		\ini_set('session.gc_divisor', '100');

		\ini_set('session.use_strict_mode', 'true');
		\ini_set('session.use_only_cookies', 'true');
		\ini_set('session.cookie_secure', 'false'); // @todo
		\ini_set('session.cookie_httponly', 'true');
		\ini_set('session.cookie_lifetime', '0');
#		\ini_set('session.referer_check', '');

		\ini_set('session.sid_bits_per_character', '6');
		\ini_set('session.sid_length', '128');

		return $this;
	}

}