vendor/symfony/security-http/Session/SessionAuthenticationStrategy.php line 37

  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\Session;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  16. use Symfony\Component\Security\Csrf\TokenStorage\ClearableTokenStorageInterface;
  18. /**
  19.  * The default session strategy implementation.
  20.  *
  21.  * Supports the following strategies:
  22.  * NONE: the session is not changed
  23.  * MIGRATE: the session id is updated, attributes are kept
  24.  * INVALIDATE: the session id is updated, attributes are lost
  25.  *
  26.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  27.  */
  28. class SessionAuthenticationStrategy implements SessionAuthenticationStrategyInterface
  29. {
  30.     public const NONE = 'none';
  31.     public const MIGRATE = 'migrate';
  32.     public const INVALIDATE = 'invalidate';
  34.     private string $strategy;
  35.     private ?ClearableTokenStorageInterface $csrfTokenStorage = null;
  37.     public function __construct(string $strategy, ClearableTokenStorageInterface $csrfTokenStorage = null)
  38.     {
  39.         $this->strategy = $strategy;
  41.         if (self::MIGRATE === $strategy) {
  42.             $this->csrfTokenStorage = $csrfTokenStorage;
  43.         }
  44.     }
  46.     public function onAuthentication(Request $request, TokenInterface $token)
  47.     {
  48.         switch ($this->strategy) {
  49.             case self::NONE:
  50.                 return;
  52.             case self::MIGRATE:
  53.                 $request->getSession()->migrate(true);
  55.                 if ($this->csrfTokenStorage) {
  56.                     $this->csrfTokenStorage->clear();
  57.                 }
  59.                 return;
  61.             case self::INVALIDATE:
  62.                 $request->getSession()->invalidate();
  64.                 return;
  66.             default:
  67.                 throw new \RuntimeException(sprintf('Invalid session authentication strategy "%s".', $this->strategy));
  68.         }
  69.     }
  70. }