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

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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\Session\SessionInterface;
  15. use Symfony\Component\Security\Csrf\Exception\TokenNotFoundException;
  17. /**
  18.  * Token storage that uses a Symfony Session object.
  19.  *
  20.  * @author Bernhard Schussek <[email protected]>
  21.  */
  22. class SessionTokenStorage implements ClearableTokenStorageInterface
  23. {
  24.     /**
  25.      * The namespace used to store values in the session.
  26.      */
  27.     public const SESSION_NAMESPACE = '_csrf';
  29.     private $session;
  30.     private $namespace;
  32.     /**
  33.      * Initializes the storage with a Session object and a session namespace.
  34.      *
  35.      * @param string $namespace The namespace under which the token is stored in the session
  36.      */
  37.     public function __construct(SessionInterface $session, string $namespace = self::SESSION_NAMESPACE)
  38.     {
  39.         $this->session = $session;
  40.         $this->namespace = $namespace;
  41.     }
  43.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     public function getToken(string $tokenId)
  47.     {
  48.         if (!$this->session->isStarted()) {
  49.             $this->session->start();
  50.         }
  52.         if (!$this->session->has($this->namespace.'/'.$tokenId)) {
  53.             throw new TokenNotFoundException('The CSRF token with ID '.$tokenId.' does not exist.');
  54.         }
  56.         return (string) $this->session->get($this->namespace.'/'.$tokenId);
  57.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      */
  62.     public function setToken(string $tokenId, string $token)
  63.     {
  64.         if (!$this->session->isStarted()) {
  65.             $this->session->start();
  66.         }
  68.         $this->session->set($this->namespace.'/'.$tokenId, $token);
  69.     }
  71.     /**
  72.      * {@inheritdoc}
  73.      */
  74.     public function hasToken(string $tokenId)
  75.     {
  76.         if (!$this->session->isStarted()) {
  77.             $this->session->start();
  78.         }
  80.         return $this->session->has($this->namespace.'/'.$tokenId);
  81.     }
  83.     /**
  84.      * {@inheritdoc}
  85.      */
  86.     public function removeToken(string $tokenId)
  87.     {
  88.         if (!$this->session->isStarted()) {
  89.             $this->session->start();
  90.         }
  92.         return $this->session->remove($this->namespace.'/'.$tokenId);
  93.     }
  95.     /**
  96.      * {@inheritdoc}
  97.      */
  98.     public function clear()
  99.     {
  100.         foreach (array_keys($this->session->all()) as $key) {
  101.             if (str_starts_with($key, $this->namespace.'/')) {
  102.                 $this->session->remove($key);
  103.             }
  104.         }
  105.     }
  106. }