vendor/symfony/security-http/RememberMe/RememberMeDetails.php line 44

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Http\RememberMe;
  14. use Symfony\Component\Security\Core\Authentication\RememberMe\PersistentToken;
  15. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  17. /**
  18.  * @author Wouter de Jong <wouter@wouterj.nl>
  19.  */
  20. class RememberMeDetails
  21. {
  22.     public const COOKIE_DELIMITER = ':';
  24.     private $userFqcn;
  25.     private $userIdentifier;
  26.     private $expires;
  27.     private $value;
  29.     public function __construct(string $userFqcn, string $userIdentifier, int $expires, string $value)
  30.     {
  31.         $this->userFqcn = $userFqcn;
  32.         $this->userIdentifier = $userIdentifier;
  33.         $this->expires = $expires;
  34.         $this->value = $value;
  35.     }
  37.     public static function fromRawCookie(string $rawCookie): self
  38.     {
  39.         if (!str_contains($rawCookie, self::COOKIE_DELIMITER)) {
  40.             $rawCookie = base64_decode($rawCookie);
  41.         }
  42.         $cookieParts = explode(self::COOKIE_DELIMITER, $rawCookie, 4);
  43.         if (4 !== \count($cookieParts)) {
  44.             throw new AuthenticationException('The cookie contains invalid data.');
  45.         }
  46.         if (false === $cookieParts[1] = base64_decode(strtr($cookieParts[1], '-_~', '+/='), true)) {
  47.             throw new AuthenticationException('The user identifier contains a character from outside the base64 alphabet.');
  48.         }
  49.         $cookieParts[0] = strtr($cookieParts[0], '.', '\\');
  51.         return new static(...$cookieParts);
  52.     }
  54.     public static function fromPersistentToken(PersistentToken $persistentToken, int $expires): self
  55.     {
  56.         return new static($persistentToken->getClass(), $persistentToken->getUserIdentifier(), $expires, $persistentToken->getSeries().':'.$persistentToken->getTokenValue());
  57.     }
  59.     public function withValue(string $value): self
  60.     {
  61.         $details = clone $this;
  62.         $details->value = $value;
  64.         return $details;
  65.     }
  67.     public function getUserFqcn(): string
  68.     {
  69.         return $this->userFqcn;
  70.     }
  72.     public function getUserIdentifier(): string
  73.     {
  74.         return $this->userIdentifier;
  75.     }
  77.     public function getExpires(): int
  78.     {
  79.         return $this->expires;
  80.     }
  82.     public function getValue(): string
  83.     {
  84.         return $this->value;
  85.     }
  87.     public function toString(): string
  88.     {
  89.         // $userIdentifier is encoded because it might contain COOKIE_DELIMITER, we assume other values don't
  90.         return implode(self::COOKIE_DELIMITER, [strtr($this->userFqcn, '\\', '.'), strtr(base64_encode($this->userIdentifier), '+/=', '-_~'), $this->expires, $this->value]);
  91.     }
  92. }