UserSession.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Session;
 
use ‪TYPO3\CMS\Core\Http\CookieScope;
use ‪TYPO3\CMS\Core\Log\LogManager;
use ‪TYPO3\CMS\Core\Security\JwtTrait;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪UserSession
{
    use ‪JwtTrait;
 
    protected const ‪SESSION_UPDATE_GRACE_PERIOD = 61;
    protected string ‪$identifier;
    protected ?int ‪$userId;
    protected int ‪$lastUpdated;
    protected array ‪$data;
    protected bool ‪$wasUpdated = false;
    protected string ‪$ipLock = '';
    protected bool ‪$isNew = true;
    protected bool ‪$isPermanent = false;
 
    protected function ‪__construct(string ‪$identifier, int ‪$userId, int ‪$lastUpdated, array ‪$data = [])
    {
        $this->identifier = ‪$identifier;
        $this->userId = ‪$userId > 0 ? ‪$userId : null;
        $this->lastUpdated = ‪$lastUpdated;
        $this->data = ‪$data;
    }
 
    public function ‪getIdentifier(): string
    {
        return ‪$this->identifier;
    }
 
    public function ‪getUserId(): ?int
    {
        return ‪$this->userId;
    }
 
    public function ‪getLastUpdated(): int
    {
        return ‪$this->lastUpdated;
    }
 
    public function set(string $key, $value): void
    {
        if ($key === '') {
            throw new \InvalidArgumentException('Argument key must not be empty', 1484312516);
        }
        if ($value === null) {
            unset($this->data[$key]);
        } else {
            $this->data[$key] = $value;
        }
        $this->wasUpdated = true;
    }
 
    public function ‪hasData(): bool
    {
        return $this->data !== [];
    }
 
    public function get(string $key)
    {
        return $this->data[$key] ?? null;
    }
 
    public function ‪getData(): array
    {
        return ‪$this->data;
    }
 
    public function ‪overrideData(array ‪$data): void
    {
        if ($this->data !== ‪$data) {
            // Only set update flag if there is change in the $data array
            $this->wasUpdated = true;
        }
 
        $this->data = ‪$data;
    }
 
    public function ‪dataWasUpdated(): bool
    {
        return ‪$this->wasUpdated;
    }
 
    public function ‪isAnonymous(): bool
    {
        return $this->userId === 0 || $this->userId === null;
    }
 
    public function ‪getIpLock(): string
    {
        return ‪$this->ipLock;
    }
 
    public function ‪isNew(): bool
    {
        return ‪$this->isNew;
    }
 
    public function ‪isPermanent(): bool
    {
        return ‪$this->isPermanent;
    }
 
    public function ‪needsUpdate(): bool
    {
        return ‪$GLOBALS['EXEC_TIME'] > ($this->lastUpdated + ‪self::SESSION_UPDATE_GRACE_PERIOD);
    }
 
    public function ‪getJwt(?CookieScope $scope = null): string
    {
        // @todo payload could be organized in a new `SessionToken` object
        return ‪self::encodeHashSignedJwt(
            [
                'identifier' => $this->identifier,
                'time' => (new \DateTimeImmutable())->format(\DateTimeImmutable::RFC3339),
                'scope' => $scope,
            ],
            self::createSigningKeyFromEncryptionKey(UserSession::class)
        );
    }
 
    public static function ‪createFromRecord(string $id, array ‪$record, bool $markAsNew = false): self
    {
        $userSession = new self(
            $id,
            (int)(‪$record['ses_userid'] ?? 0),
            (int)(‪$record['ses_tstamp'] ?? 0),
            unserialize(‪$record['ses_data'] ?? '', ['allowed_classes' => false]) ?: []
        );
        $userSession->ipLock = ‪$record['ses_iplock'] ?? '';
        $userSession->isNew = $markAsNew;
        if (isset(‪$record['ses_permanent'])) {
            $userSession->isPermanent = (bool)‪$record['ses_permanent'];
        }
        return $userSession;
    }
 
    public static function ‪createNonFixated(string ‪$identifier): self
    {
        $userSession = new self(‪$identifier, 0, ‪$GLOBALS['EXEC_TIME'], []);
        $userSession->isPermanent = false;
        $userSession->isNew = true;
        return $userSession;
    }
 
    public static function ‪resolveIdentifierFromJwt(string $cookieValue, CookieScope $scope): ?string
    {
        if ($cookieValue === '') {
            return null;
        }
 
        $payload = ‪self::decodeJwt($cookieValue, self::createSigningKeyFromEncryptionKey(UserSession::class));
 
        ‪$identifier = !empty($payload->identifier) && is_string($payload->identifier) ? $payload->identifier : null;
        if (‪$identifier === null) {
            return null;
        }
 
        $domainScope = (string)($payload->scope->domain ?? '');
        $pathScope = (string)($payload->scope->path ?? '');
        if ($domainScope === '' || $pathScope === '') {
            $logger = GeneralUtility::makeInstance(LogManager::class)->getLogger(self::class);
            $logger->notice('A session cookie with out a domain scope has been used', ['cookieHash' => substr(sha1($cookieValue), 0, 12)]);
            return ‪$identifier;
        }
        if ($domainScope !== $scope->domain || $pathScope !== $scope->path) {
            // invalid scope, the cookie jwt has been used on a wrong path or domain
            return null;
        }
 
        return ‪$identifier;
    }
 
    public function ‪toArray(): array
    {
        ‪$data = [
            'ses_id' => ‪$this->identifier,
            'ses_data' => serialize($this->data),
            'ses_userid' => (int)$this->userId,
            'ses_iplock' => $this->ipLock,
            'ses_tstamp' => $this->lastUpdated,
        ];
        if ($this->‪isPermanent) {
            $data['ses_permanent'] = 1;
        }
        return ‪$data;
    }
}