site-accueil-insa/matomo/core/Session.php

236 lines
8 KiB
PHP

<?php
/**
* Matomo - free/libre analytics platform
*
* @link https://matomo.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*
*/
namespace Piwik;
use Exception;
use Piwik\Container\StaticContainer;
use Piwik\Exception\MissingFilePermissionException;
use Piwik\Plugins\Overlay\Overlay;
use Piwik\Session\SaveHandler\DbTable;
use Psr\Log\LoggerInterface;
use Zend_Session;
/**
* Session initialization.
*/
class Session extends Zend_Session
{
const SESSION_NAME = 'MATOMO_SESSID';
public static $sessionName = self::SESSION_NAME;
protected static $sessionStarted = false;
/**
* Start the session
*
* @param array|bool $options An array of configuration options; the auto-start (bool) setting is ignored
* @return void
* @throws Exception if starting a session fails
*/
public static function start($options = false)
{
if (headers_sent()
|| self::$sessionStarted
|| (defined('PIWIK_ENABLE_SESSION_START') && !PIWIK_ENABLE_SESSION_START)
|| session_status() == PHP_SESSION_ACTIVE
) {
return;
}
self::$sessionStarted = true;
if (defined('PIWIK_SESSION_NAME')) {
self::$sessionName = PIWIK_SESSION_NAME;
}
$config = Config::getInstance();
// use cookies to store session id on the client side
@ini_set('session.use_cookies', '1');
// prevent attacks involving session ids passed in URLs
@ini_set('session.use_only_cookies', '1');
// advise browser that session cookie should only be sent over secure connection
if (ProxyHttp::isHttps()) {
@ini_set('session.cookie_secure', '1');
}
// advise browser that session cookie should only be accessible through the HTTP protocol (i.e., not JavaScript)
@ini_set('session.cookie_httponly', '1');
// don't use the default: PHPSESSID
@ini_set('session.name', self::$sessionName);
// proxies may cause the referer check to fail and
// incorrectly invalidate the session
@ini_set('session.referer_check', '');
// to preserve previous behavior matomo_auth provided when it contained a token_auth, we ensure
// the session data won't be deleted until the cookie expires.
@ini_set('session.gc_maxlifetime', $config->General['login_cookie_expire']);
@ini_set('session.cookie_path', empty($config->General['login_cookie_path']) ? '/' : $config->General['login_cookie_path']);
$currentSaveHandler = ini_get('session.save_handler');
if (!SettingsPiwik::isMatomoInstalled()) {
// Note: this handler doesn't work well in load-balanced environments and may have a concurrency issue with locked session files
// for "files", use our own folder to prevent local session file hijacking
$sessionPath = self::getSessionsDirectory();
// We always call mkdir since it also chmods the directory which might help when permissions were reverted for some reasons
Filesystem::mkdir($sessionPath);
@ini_set('session.save_handler', 'files');
@ini_set('session.save_path', $sessionPath);
} else {
// as of Matomo 3.7.0 we only support files session handler during installation
// We consider these to be misconfigurations, in that:
// - user - we can't verify that user-defined session handler functions have already been set via session_set_save_handler()
// - mm - this handler is not recommended, unsupported, not available for Windows, and has a potential concurrency issue
if (@ini_get('session.serialize_handler') !== 'php_serialize') {
@ini_set('session.serialize_handler', 'php_serialize');
}
$config = self::getDbTableConfig();
$saveHandler = new DbTable($config);
if ($saveHandler) {
self::setSaveHandler($saveHandler);
}
}
// set garbage collection according to user preferences (on by default)
@ini_set('session.gc_probability', Config::getInstance()->General['session_gc_probability']);
try {
parent::start();
register_shutdown_function(array('Zend_Session', 'writeClose'), true);
} catch (Exception $e) {
StaticContainer::get(LoggerInterface::class)->error('Unable to start session: {exception}', [
'exception' => $e,
'ignoreInScreenWriter' => true,
]);
if (SettingsPiwik::isMatomoInstalled()) {
$pathToSessions = '';
} else {
$pathToSessions = Filechecks::getErrorMessageMissingPermissions(self::getSessionsDirectory());
}
$message = sprintf("Error: %s %s\n<pre>Debug: the original error was \n%s</pre>",
Piwik::translate('General_ExceptionUnableToStartSession'),
$pathToSessions,
$e->getMessage()
);
$ex = new MissingFilePermissionException($message, $e->getCode(), $e);
$ex->setIsHtmlMessage();
throw $ex;
}
}
/**
* Returns the directory session files are stored in.
*
* @return string
*/
public static function getSessionsDirectory()
{
return StaticContainer::get('path.tmp') . '/sessions';
}
public static function close()
{
if (self::isSessionStarted()) {
// only write/close session if the session was actually started by us
// otherwise we will set the session values to base64 encoded and whoever the session started might not expect the values in that way
parent::writeClose();
}
}
public static function isSessionStarted()
{
return self::$sessionStarted;
}
public static function getSameSiteCookieValue()
{
$config = Config::getInstance();
$general = $config->General;
$module = Piwik::getModule();
$action = Piwik::getAction();
$method = Common::getRequestVar('method', '', 'string');
$referer = Url::getReferrer();
$isOptOutRequest = $module == 'CoreAdminHome' && ($action == 'optOut' || $action == 'optOutJS');
$shouldUseNone = !empty($general['enable_framed_pages']) || $isOptOutRequest || Overlay::isOverlayRequest($module, $action, $method, $referer);
if ($shouldUseNone && ProxyHttp::isHttps()) {
return 'None';
}
return 'Lax';
}
/**
* Write cookie header. Similar to the native setcookie() function but also supports
* the SameSite cookie property.
* @param $name
* @param $value
* @param int $expires
* @param string $path
* @param string $domain
* @param bool $secure
* @param bool $httpOnly
* @param string $sameSite
* @return string
*/
public static function writeCookie($name, $value, $expires = 0, $path = '/', $domain = '/', $secure = false, $httpOnly = false, $sameSite = 'lax')
{
$headerStr = 'Set-Cookie: ' . rawurlencode($name) . '=' . rawurlencode($value);
if ($expires) {
$headerStr .= '; expires=' . gmdate('D, d-M-Y H:i:s', $expires) . ' GMT';
}
if ($path) {
$headerStr .= '; path=' . $path;
}
if ($domain) {
$headerStr .= '; domain=' . rawurlencode($domain);
}
if ($secure) {
$headerStr .= '; secure';
}
if ($httpOnly) {
$headerStr .= '; httponly';
}
if ($sameSite) {
$headerStr .= '; SameSite=' . $sameSite;
}
Common::sendHeader($headerStr);
return $headerStr;
}
public static function getDbTableConfig()
{
return array(
'name' => Common::prefixTable(DbTable::TABLE_NAME),
'primary' => 'id',
'modifiedColumn' => 'modified',
'dataColumn' => 'data',
'lifetimeColumn' => 'lifetime',
);
}
}