vendor/symfony/security-csrf/TokenStorage/SessionTokenStorage.php line 59

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\Csrf\TokenStorage;
  14. use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
  15. use Symfony\Component\HttpFoundation\RequestStack;
  16. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  17. use Symfony\Component\Security\Csrf\Exception\TokenNotFoundException;
  19. /**
  20.  * Token storage that uses a Symfony Session object.
  21.  *
  22.  * @author Bernhard Schussek <bschussek@gmail.com>
  23.  */
  24. class SessionTokenStorage implements ClearableTokenStorageInterface
  25. {
  26.     /**
  27.      * The namespace used to store values in the session.
  28.      */
  29.     public const SESSION_NAMESPACE = '_csrf';
  31.     private RequestStack $requestStack;
  32.     private string $namespace;
  34.     /**
  35.      * Initializes the storage with a RequestStack object and a session namespace.
  36.      *
  37.      * @param string $namespace The namespace under which the token is stored in the requestStack
  38.      */
  39.     public function __construct(RequestStack $requestStack, string $namespace = self::SESSION_NAMESPACE)
  40.     {
  41.         $this->requestStack = $requestStack;
  42.         $this->namespace = $namespace;
  43.     }
  45.     /**
  46.      * {@inheritdoc}
  47.      */
  48.     public function getToken(string $tokenId): string
  49.     {
  50.         $session = $this->getSession();
  51.         if (!$session->isStarted()) {
  52.             $session->start();
  53.         }
  55.         if (!$session->has($this->namespace.'/'.$tokenId)) {
  56.             throw new TokenNotFoundException('The CSRF token with ID '.$tokenId.' does not exist.');
  57.         }
  59.         return (string) $session->get($this->namespace.'/'.$tokenId);
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function setToken(string $tokenId, string $token)
  66.     {
  67.         $session = $this->getSession();
  68.         if (!$session->isStarted()) {
  69.             $session->start();
  70.         }
  72.         $session->set($this->namespace.'/'.$tokenId, $token);
  73.     }
  75.     /**
  76.      * {@inheritdoc}
  77.      */
  78.     public function hasToken(string $tokenId): bool
  79.     {
  80.         $session = $this->getSession();
  81.         if (!$session->isStarted()) {
  82.             $session->start();
  83.         }
  85.         return $session->has($this->namespace.'/'.$tokenId);
  86.     }
  88.     /**
  89.      * {@inheritdoc}
  90.      */
  91.     public function removeToken(string $tokenId): ?string
  92.     {
  93.         $session = $this->getSession();
  94.         if (!$session->isStarted()) {
  95.             $session->start();
  96.         }
  98.         return $session->remove($this->namespace.'/'.$tokenId);
  99.     }
  101.     /**
  102.      * {@inheritdoc}
  103.      */
  104.     public function clear()
  105.     {
  106.         $session = $this->getSession();
  107.         foreach (array_keys($session->all()) as $key) {
  108.             if (str_starts_with($key, $this->namespace.'/')) {
  109.                 $session->remove($key);
  110.             }
  111.         }
  112.     }
  114.     /**
  115.      * @throws SessionNotFoundException
  116.      */
  117.     private function getSession(): SessionInterface
  118.     {
  119.         return $this->requestStack->getSession();
  120.     }
  121. }