vendor/symfony/security-core/Authentication/Token/RememberMeToken.php line 21

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\Core\Authentication\Token;
  14. use Symfony\Component\Security\Core\User\UserInterface;
  16. /**
  17.  * Authentication Token for "Remember-Me".
  18.  *
  19.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  20.  */
  21. class RememberMeToken extends AbstractToken
  22. {
  23.     private $secret;
  24.     private $firewallName;
  26.     /**
  27.      * @param string $secret A secret used to make sure the token is created by the app and not by a malicious client
  28.      *
  29.      * @throws \InvalidArgumentException
  30.      */
  31.     public function __construct(UserInterface $user, string $firewallName, string $secret)
  32.     {
  33.         parent::__construct($user->getRoles());
  35.         if (empty($secret)) {
  36.             throw new \InvalidArgumentException('$secret must not be empty.');
  37.         }
  39.         if ('' === $firewallName) {
  40.             throw new \InvalidArgumentException('$firewallName must not be empty.');
  41.         }
  43.         $this->firewallName = $firewallName;
  44.         $this->secret = $secret;
  46.         $this->setUser($user);
  47.         parent::setAuthenticated(true);
  48.     }
  50.     /**
  51.      * {@inheritdoc}
  52.      */
  53.     public function setAuthenticated(bool $authenticated)
  54.     {
  55.         if ($authenticated) {
  56.             throw new \LogicException('You cannot set this token to authenticated after creation.');
  57.         }
  59.         parent::setAuthenticated(false);
  60.     }
  62.     /**
  63.      * Returns the provider secret.
  64.      *
  65.      * @return string The provider secret
  66.      *
  67.      * @deprecated since Symfony 5.2, use getFirewallName() instead
  68.      */
  69.     public function getProviderKey()
  70.     {
  71.         if (1 !== \func_num_args() || true !== func_get_arg(0)) {
  72.             trigger_deprecation('symfony/security-core', '5.2', 'Method "%s" is deprecated, use "getFirewallName()" instead.', __METHOD__);
  73.         }
  75.         return $this->firewallName;
  76.     }
  78.     public function getFirewallName(): string
  79.     {
  80.         return $this->getProviderKey(true);
  81.     }
  83.     /**
  84.      * Returns the secret.
  85.      *
  86.      * @return string
  87.      */
  88.     public function getSecret()
  89.     {
  90.         return $this->secret;
  91.     }
  93.     /**
  94.      * {@inheritdoc}
  95.      */
  96.     public function getCredentials()
  97.     {
  98.         return '';
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function __serialize(): array
  105.     {
  106.         return [$this->secret, $this->firewallName, parent::__serialize()];
  107.     }
  109.     /**
  110.      * {@inheritdoc}
  111.      */
  112.     public function __unserialize(array $data): void
  113.     {
  114.         [$this->secret, $this->firewallName, $parentData] = $data;
  115.         $parentData = \is_array($parentData) ? $parentData : unserialize($parentData);
  116.         parent::__unserialize($parentData);
  117.     }
  118. }