<?php
+
namespace Shaarli\Security;
use Shaarli\Config\ConfigManager;
*/
class SessionManager
{
+ public const KEY_LINKS_PER_PAGE = 'LINKS_PER_PAGE';
+ public const KEY_VISIBILITY = 'visibility';
+ public const KEY_UNTAGGED_ONLY = 'untaggedonly';
+
+ public const KEY_SUCCESS_MESSAGES = 'successes';
+ public const KEY_WARNING_MESSAGES = 'warnings';
+ public const KEY_ERROR_MESSAGES = 'errors';
+
/** @var int Session expiration timeout, in seconds */
- public static $INACTIVITY_TIMEOUT = 3600;
+ public static $SHORT_TIMEOUT = 3600; // 1 hour
- /** @var string Name of the cookie set after logging in **/
- public static $LOGGED_IN_COOKIE = 'shaarli_staySignedIn';
+ /** @var int Session expiration timeout, in seconds */
+ public static $LONG_TIMEOUT = 31536000; // 1 year
/** @var array Local reference to the global $_SESSION array */
protected $session = [];
/** @var ConfigManager Configuration Manager instance **/
protected $conf = null;
+ /** @var bool Whether the user should stay signed in (LONG_TIMEOUT) */
+ protected $staySignedIn = false;
+
+ /** @var string */
+ protected $savePath;
+
/**
* Constructor
*
- * @param array $session The $_SESSION array (reference)
- * @param ConfigManager $conf ConfigManager instance
+ * @param array $session The $_SESSION array (reference)
+ * @param ConfigManager $conf ConfigManager instance
+ * @param string $savePath Session save path returned by builtin function session_save_path()
*/
- public function __construct(& $session, $conf)
+ public function __construct(&$session, $conf, string $savePath)
{
$this->session = &$session;
$this->conf = $conf;
+ $this->savePath = $savePath;
+ }
+
+ /**
+ * Initialize XSRF token and links per page session variables.
+ */
+ public function initialize(): void
+ {
+ if (!isset($this->session['tokens'])) {
+ $this->session['tokens'] = [];
+ }
+
+ if (!isset($this->session['LINKS_PER_PAGE'])) {
+ $this->session['LINKS_PER_PAGE'] = $this->conf->get('general.links_per_page', 20);
+ }
+ }
+
+ /**
+ * Define whether the user should stay signed in across browser sessions
+ *
+ * @param bool $staySignedIn Keep the user signed in
+ */
+ public function setStaySignedIn($staySignedIn)
+ {
+ $this->staySignedIn = $staySignedIn;
}
/**
*/
public function generateToken()
{
- $token = sha1(uniqid('', true) .'_'. mt_rand() . $this->conf->get('credentials.salt'));
+ $token = sha1(uniqid('', true) . '_' . mt_rand() . $this->conf->get('credentials.salt'));
$this->session['tokens'][$token] = 1;
return $token;
}
*/
public function storeLoginInfo($clientIpId)
{
- // Generate unique random number (different than phpsessionid)
- $this->session['uid'] = sha1(uniqid('', true) . '_' . mt_rand());
$this->session['ip'] = $clientIpId;
$this->session['username'] = $this->conf->get('credentials.login');
- $this->session['expires_on'] = time() + self::$INACTIVITY_TIMEOUT;
+ $this->extendTimeValidityBy(self::$SHORT_TIMEOUT);
}
/**
*/
public function extendSession()
{
- if (! empty($this->session['longlastingsession'])) {
- // "Stay signed in" is enabled
- $this->session['expires_on'] = time() + $this->session['longlastingsession'];
- return;
+ if ($this->staySignedIn) {
+ return $this->extendTimeValidityBy(self::$LONG_TIMEOUT);
}
- $this->session['expires_on'] = time() + self::$INACTIVITY_TIMEOUT;
+ return $this->extendTimeValidityBy(self::$SHORT_TIMEOUT);
+ }
+
+ /**
+ * Extend expiration time
+ *
+ * @param int $duration Expiration time extension (seconds)
+ *
+ * @return int New session expiration time
+ */
+ protected function extendTimeValidityBy($duration)
+ {
+ $expirationTime = time() + $duration;
+ $this->session['expires_on'] = $expirationTime;
+ return $expirationTime;
}
/**
*
* See:
* - https://secure.php.net/manual/en/function.setcookie.php
- *
- * @param string $webPath path on the server in which the cookie will be available on
*/
- public function logout($webPath)
+ public function logout()
{
if (isset($this->session)) {
- unset($this->session['uid']);
unset($this->session['ip']);
+ unset($this->session['expires_on']);
unset($this->session['username']);
unset($this->session['visibility']);
- unset($this->session['untaggedonly']);
}
- setcookie(self::$LOGGED_IN_COOKIE, 'false', 0, $webPath);
}
/**
*/
public function hasSessionExpired()
{
- if (empty($this->session['uid'])) {
+ if (empty($this->session['expires_on'])) {
return true;
}
if (time() >= $this->session['expires_on']) {
if ($this->conf->get('security.session_protection_disabled') === true) {
return false;
}
- if ($this->session['ip'] == $clientIpId) {
+ if (isset($this->session['ip']) && $this->session['ip'] === $clientIpId) {
return false;
}
return true;
}
+
+ /** @return array Local reference to the global $_SESSION array */
+ public function getSession(): array
+ {
+ return $this->session;
+ }
+
+ /**
+ * @param mixed $default value which will be returned if the $key is undefined
+ *
+ * @return mixed Content stored in session
+ */
+ public function getSessionParameter(string $key, $default = null)
+ {
+ return $this->session[$key] ?? $default;
+ }
+
+ /**
+ * Store a variable in user session.
+ *
+ * @param string $key Session key
+ * @param mixed $value Session value to store
+ *
+ * @return $this
+ */
+ public function setSessionParameter(string $key, $value): self
+ {
+ $this->session[$key] = $value;
+
+ return $this;
+ }
+
+ /**
+ * Store a variable in user session.
+ *
+ * @param string $key Session key
+ *
+ * @return $this
+ */
+ public function deleteSessionParameter(string $key): self
+ {
+ unset($this->session[$key]);
+
+ return $this;
+ }
+
+ public function getSavePath(): string
+ {
+ return $this->savePath;
+ }
+
+ /*
+ * Next public functions wrapping native PHP session API.
+ */
+
+ public function destroy(): bool
+ {
+ $this->session = [];
+
+ return session_destroy();
+ }
+
+ public function start(): bool
+ {
+ if (session_status() === PHP_SESSION_ACTIVE) {
+ $this->destroy();
+ }
+
+ return session_start();
+ }
+
+ /**
+ * Be careful, return type of session_set_cookie_params() changed between PHP 7.1 and 7.2.
+ */
+ public function cookieParameters(int $lifeTime, string $path, string $domain): void
+ {
+ session_set_cookie_params($lifeTime, $path, $domain);
+ }
+
+ public function regenerateId(bool $deleteOldSession = false): bool
+ {
+ return session_regenerate_id($deleteOldSession);
+ }
}
projects / github / shaarli / Shaarli.git / blobdiff