vendor/symfony/security-csrf/CsrfTokenManager.php line 27

  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;
  14. use Symfony\Component\HttpFoundation\RequestStack;
  15. use Symfony\Component\Security\Core\Exception\InvalidArgumentException;
  16. use Symfony\Component\Security\Csrf\TokenGenerator\TokenGeneratorInterface;
  17. use Symfony\Component\Security\Csrf\TokenGenerator\UriSafeTokenGenerator;
  18. use Symfony\Component\Security\Csrf\TokenStorage\NativeSessionTokenStorage;
  19. use Symfony\Component\Security\Csrf\TokenStorage\TokenStorageInterface;
  21. /**
  22.  * Default implementation of {@link CsrfTokenManagerInterface}.
  23.  *
  24.  * @author Bernhard Schussek <bschussek@gmail.com>
  25.  * @author Kévin Dunglas <dunglas@gmail.com>
  26.  */
  27. class CsrfTokenManager implements CsrfTokenManagerInterface
  28. {
  29.     private TokenGeneratorInterface $generator;
  30.     private TokenStorageInterface $storage;
  31.     private \Closure|string $namespace;
  33.     /**
  34.      * @param $namespace
  35.      *                   * null: generates a namespace using $_SERVER['HTTPS']
  36.      *                   * string: uses the given string
  37.      *                   * RequestStack: generates a namespace using the current main request
  38.      *                   * callable: uses the result of this callable (must return a string)
  39.      */
  40.     public function __construct(TokenGeneratorInterface $generator = null, TokenStorageInterface $storage = null, string|RequestStack|callable $namespace = null)
  41.     {
  42.         $this->generator = $generator ?? new UriSafeTokenGenerator();
  43.         $this->storage = $storage ?? new NativeSessionTokenStorage();
  45.         $superGlobalNamespaceGenerator = function () {
  46.             return !empty($_SERVER['HTTPS']) && 'off' !== strtolower($_SERVER['HTTPS']) ? 'https-' : '';
  47.         };
  49.         if (null === $namespace) {
  50.             $this->namespace = $superGlobalNamespaceGenerator;
  51.         } elseif ($namespace instanceof RequestStack) {
  52.             $this->namespace = function () use ($namespace, $superGlobalNamespaceGenerator) {
  53.                 if ($request = $namespace->getMainRequest()) {
  54.                     return $request->isSecure() ? 'https-' : '';
  55.                 }
  57.                 return $superGlobalNamespaceGenerator();
  58.             };
  59.         } elseif ($namespace instanceof \Closure || \is_string($namespace)) {
  60.             $this->namespace = $namespace;
  61.         } elseif (\is_callable($namespace)) {
  62.             $this->namespace = $namespace(...);
  63.         } else {
  64.             throw new InvalidArgumentException(sprintf('$namespace must be a string, a callable returning a string, null or an instance of "RequestStack". "%s" given.', get_debug_type($namespace)));
  65.         }
  66.     }
  68.     public function getToken(string $tokenId): CsrfToken
  69.     {
  70.         $namespacedId = $this->getNamespace().$tokenId;
  71.         if ($this->storage->hasToken($namespacedId)) {
  72.             $value = $this->storage->getToken($namespacedId);
  73.         } else {
  74.             $value = $this->generator->generateToken();
  76.             $this->storage->setToken($namespacedId, $value);
  77.         }
  79.         return new CsrfToken($tokenId, $this->randomize($value));
  80.     }
  82.     public function refreshToken(string $tokenId): CsrfToken
  83.     {
  84.         $namespacedId = $this->getNamespace().$tokenId;
  85.         $value = $this->generator->generateToken();
  87.         $this->storage->setToken($namespacedId, $value);
  89.         return new CsrfToken($tokenId, $this->randomize($value));
  90.     }
  92.     public function removeToken(string $tokenId): ?string
  93.     {
  94.         return $this->storage->removeToken($this->getNamespace().$tokenId);
  95.     }
  97.     public function isTokenValid(CsrfToken $token): bool
  98.     {
  99.         $namespacedId = $this->getNamespace().$token->getId();
  100.         if (!$this->storage->hasToken($namespacedId)) {
  101.             return false;
  102.         }
  104.         return hash_equals($this->storage->getToken($namespacedId), $this->derandomize($token->getValue()));
  105.     }
  107.     private function getNamespace(): string
  108.     {
  109.         return \is_callable($ns = $this->namespace) ? $ns() : $ns;
  110.     }
  112.     private function randomize(string $value): string
  113.     {
  114.         $key = random_bytes(32);
  115.         $value = $this->xor($value, $key);
  117.         return sprintf('%s.%s.%s', substr(md5($key), 0, 1 + (\ord($key[0]) % 32)), rtrim(strtr(base64_encode($key), '+/', '-_'), '='), rtrim(strtr(base64_encode($value), '+/', '-_'), '='));
  118.     }
  120.     private function derandomize(string $value): string
  121.     {
  122.         $parts = explode('.', $value);
  123.         if (3 !== \count($parts)) {
  124.             return $value;
  125.         }
  126.         $key = base64_decode(strtr($parts[1], '-_', '+/'));
  127.         if ('' === $key || false === $key) {
  128.             return $value;
  129.         }
  130.         $value = base64_decode(strtr($parts[2], '-_', '+/'));
  132.         return $this->xor($value, $key);
  133.     }
  135.     private function xor(string $value, string $key): string
  136.     {
  137.         if (\strlen($value) > \strlen($key)) {
  138.             $key = str_repeat($key, ceil(\strlen($value) / \strlen($key)));
  139.         }
  141.         return $value ^ $key;
  142.     }
  143. }