vendor/symfony/security-http/Firewall/ContextListener.php line 170

  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\Firewall;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Session\Session;
  17. use Symfony\Component\HttpKernel\Event\RequestEvent;
  18. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  19. use Symfony\Component\HttpKernel\KernelEvents;
  20. use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolver;
  21. use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
  22. use Symfony\Component\Security\Core\Authentication\Token\AbstractToken;
  23. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  24. use Symfony\Component\Security\Core\Authentication\Token\SwitchUserToken;
  25. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  26. use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
  27. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  28. use Symfony\Component\Security\Core\User\EquatableInterface;
  29. use Symfony\Component\Security\Core\User\LegacyPasswordAuthenticatedUserInterface;
  30. use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
  31. use Symfony\Component\Security\Core\User\UserInterface;
  32. use Symfony\Component\Security\Core\User\UserProviderInterface;
  33. use Symfony\Component\Security\Http\Event\TokenDeauthenticatedEvent;
  34. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  36. /**
  37.  * ContextListener manages the SecurityContext persistence through a session.
  38.  *
  39.  * @author Fabien Potencier <fabien@symfony.com>
  40.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  41.  *
  42.  * @final
  43.  */
  44. class ContextListener extends AbstractListener
  45. {
  46.     private TokenStorageInterface $tokenStorage;
  47.     private string $sessionKey;
  48.     private ?LoggerInterface $logger;
  49.     private iterable $userProviders;
  50.     private ?EventDispatcherInterface $dispatcher;
  51.     private bool $registered = false;
  52.     private AuthenticationTrustResolverInterface $trustResolver;
  53.     private ?\Closure $sessionTrackerEnabler;
  55.     /**
  56.      * @param iterable<mixed, UserProviderInterface> $userProviders
  57.      */
  58.     public function __construct(TokenStorageInterface $tokenStorage, iterable $userProviders, string $contextKey, ?LoggerInterface $logger = null, ?EventDispatcherInterface $dispatcher = null, ?AuthenticationTrustResolverInterface $trustResolver = null, ?callable $sessionTrackerEnabler = null)
  59.     {
  60.         if (empty($contextKey)) {
  61.             throw new \InvalidArgumentException('$contextKey must not be empty.');
  62.         }
  64.         $this->tokenStorage = $tokenStorage;
  65.         $this->userProviders = $userProviders;
  66.         $this->sessionKey = '_security_'.$contextKey;
  67.         $this->logger = $logger;
  68.         $this->dispatcher = $dispatcher;
  70.         $this->trustResolver = $trustResolver ?? new AuthenticationTrustResolver();
  71.         $this->sessionTrackerEnabler = null === $sessionTrackerEnabler ? null : $sessionTrackerEnabler(...);
  72.     }
  74.     public function supports(Request $request): ?bool
  75.     {
  76.         return null; // always run authenticate() lazily with lazy firewalls
  77.     }
  79.     /**
  80.      * Reads the Security Token from the session.
  81.      */
  82.     public function authenticate(RequestEvent $event): void
  83.     {
  84.         if (!$this->registered && null !== $this->dispatcher && $event->isMainRequest()) {
  85.             $this->dispatcher->addListener(KernelEvents::RESPONSE, $this->onKernelResponse(...));
  86.             $this->registered = true;
  87.         }
  89.         $request = $event->getRequest();
  90.         $session = $request->hasPreviousSession() ? $request->getSession() : null;
  92.         $request->attributes->set('_security_firewall_run', $this->sessionKey);
  94.         if (null !== $session) {
  95.             $usageIndexValue = $session instanceof Session ? $usageIndexReference = &$session->getUsageIndex() : 0;
  96.             $usageIndexReference = \PHP_INT_MIN;
  97.             $sessionId = $request->cookies->all()[$session->getName()] ?? null;
  98.             $token = $session->get($this->sessionKey);
  100.             // sessionId = true is used in the tests
  101.             if ($this->sessionTrackerEnabler && \in_array($sessionId, [true, $session->getId()], true)) {
  102.                 $usageIndexReference = $usageIndexValue;
  103.             } else {
  104.                 $usageIndexReference = $usageIndexReference - \PHP_INT_MIN + $usageIndexValue;
  105.             }
  106.         }
  108.         if (null === $session || null === $token) {
  109.             if ($this->sessionTrackerEnabler) {
  110.                 ($this->sessionTrackerEnabler)();
  111.             }
  113.             $this->tokenStorage->setToken(null);
  115.             return;
  116.         }
  118.         $token = $this->safelyUnserialize($token);
  120.         $this->logger?->debug('Read existing security token from the session.', [
  121.             'key' => $this->sessionKey,
  122.             'token_class' => \is_object($token) ? $token::class : null,
  123.         ]);
  125.         if ($token instanceof TokenInterface) {
  126.             $originalToken = $token;
  127.             $token = $this->refreshUser($token);
  129.             if (!$token) {
  130.                 $this->logger?->debug('Token was deauthenticated after trying to refresh it.');
  132.                 $this->dispatcher?->dispatch(new TokenDeauthenticatedEvent($originalToken, $request));
  133.             }
  134.         } elseif (null !== $token) {
  135.             $this->logger?->warning('Expected a security token from the session, got something else.', ['key' => $this->sessionKey, 'received' => $token]);
  137.             $token = null;
  138.         }
  140.         if ($this->sessionTrackerEnabler) {
  141.             ($this->sessionTrackerEnabler)();
  142.         }
  144.         $this->tokenStorage->setToken($token);
  145.     }
  147.     /**
  148.      * Writes the security token into the session.
  149.      */
  150.     public function onKernelResponse(ResponseEvent $event): void
  151.     {
  152.         if (!$event->isMainRequest()) {
  153.             return;
  154.         }
  156.         $request = $event->getRequest();
  158.         if (!$request->hasSession() || $request->attributes->get('_security_firewall_run') !== $this->sessionKey) {
  159.             return;
  160.         }
  162.         $this->dispatcher?->removeListener(KernelEvents::RESPONSE, $this->onKernelResponse(...));
  163.         $this->registered = false;
  164.         $session = $request->getSession();
  165.         $sessionId = $session->getId();
  166.         $usageIndexValue = $session instanceof Session ? $usageIndexReference = &$session->getUsageIndex() : null;
  167.         $token = $this->tokenStorage->getToken();
  169.         if (!$this->trustResolver->isAuthenticated($token)) {
  170.             if ($request->hasPreviousSession()) {
  171.                 $session->remove($this->sessionKey);
  172.             }
  173.         } else {
  174.             $session->set($this->sessionKey, serialize($token));
  176.             $this->logger?->debug('Stored the security token in the session.', ['key' => $this->sessionKey]);
  177.         }
  179.         if ($this->sessionTrackerEnabler && $session->getId() === $sessionId) {
  180.             $usageIndexReference = $usageIndexValue;
  181.         }
  182.     }
  184.     /**
  185.      * Refreshes the user by reloading it from the user provider.
  186.      *
  187.      * @throws \RuntimeException
  188.      */
  189.     protected function refreshUser(TokenInterface $token): ?TokenInterface
  190.     {
  191.         $user = $token->getUser();
  193.         $userNotFoundByProvider = false;
  194.         $userDeauthenticated = false;
  195.         $userClass = $user::class;
  197.         foreach ($this->userProviders as $provider) {
  198.             if (!$provider instanceof UserProviderInterface) {
  199.                 throw new \InvalidArgumentException(sprintf('User provider "%s" must implement "%s".', get_debug_type($provider), UserProviderInterface::class));
  200.             }
  202.             if (!$provider->supportsClass($userClass)) {
  203.                 continue;
  204.             }
  206.             try {
  207.                 $refreshedUser = $provider->refreshUser($user);
  208.                 $newToken = clone $token;
  209.                 $newToken->setUser($refreshedUser, false);
  211.                 // tokens can be deauthenticated if the user has been changed.
  212.                 if ($token instanceof AbstractToken && $this->hasUserChanged($user, $newToken)) {
  213.                     $userDeauthenticated = true;
  215.                     $this->logger?->debug('Cannot refresh token because user has changed.', ['username' => $refreshedUser->getUserIdentifier(), 'provider' => $provider::class]);
  217.                     continue;
  218.                 }
  220.                 $token->setUser($refreshedUser);
  222.                 if (null !== $this->logger) {
  223.                     $context = ['provider' => $provider::class, 'username' => $refreshedUser->getUserIdentifier()];
  225.                     if ($token instanceof SwitchUserToken) {
  226.                         $originalToken = $token->getOriginalToken();
  227.                         $context['impersonator_username'] = $originalToken->getUserIdentifier();
  228.                     }
  230.                     $this->logger->debug('User was reloaded from a user provider.', $context);
  231.                 }
  233.                 return $token;
  234.             } catch (UnsupportedUserException) {
  235.                 // let's try the next user provider
  236.             } catch (UserNotFoundException $e) {
  237.                 $this->logger?->warning('Username could not be found in the selected user provider.', ['username' => $e->getUserIdentifier(), 'provider' => $provider::class]);
  239.                 $userNotFoundByProvider = true;
  240.             }
  241.         }
  243.         if ($userDeauthenticated) {
  244.             return null;
  245.         }
  247.         if ($userNotFoundByProvider) {
  248.             return null;
  249.         }
  251.         throw new \RuntimeException(sprintf('There is no user provider for user "%s". Shouldn\'t the "supportsClass()" method of your user provider return true for this classname?', $userClass));
  252.     }
  254.     private function safelyUnserialize(string $serializedToken): mixed
  255.     {
  256.         $token = null;
  257.         $prevUnserializeHandler = ini_set('unserialize_callback_func', __CLASS__.'::handleUnserializeCallback');
  258.         $prevErrorHandler = set_error_handler(function ($type, $msg, $file, $line, $context = []) use (&$prevErrorHandler) {
  259.             if (__FILE__ === $file && !\in_array($type, [\E_DEPRECATED, \E_USER_DEPRECATED], true)) {
  260.                 throw new \ErrorException($msg, 0x37313BC, $type, $file, $line);
  261.             }
  263.             return $prevErrorHandler ? $prevErrorHandler($type, $msg, $file, $line, $context) : false;
  264.         });
  266.         try {
  267.             $token = unserialize($serializedToken);
  268.         } catch (\ErrorException $e) {
  269.             if (0x37313BC !== $e->getCode()) {
  270.                 throw $e;
  271.             }
  272.             $this->logger?->warning('Failed to unserialize the security token from the session.', ['key' => $this->sessionKey, 'received' => $serializedToken, 'exception' => $e]);
  273.         } finally {
  274.             restore_error_handler();
  275.             ini_set('unserialize_callback_func', $prevUnserializeHandler);
  276.         }
  278.         return $token;
  279.     }
  281.     private static function hasUserChanged(UserInterface $originalUser, TokenInterface $refreshedToken): bool
  282.     {
  283.         $refreshedUser = $refreshedToken->getUser();
  285.         if ($originalUser instanceof EquatableInterface) {
  286.             return !(bool) $originalUser->isEqualTo($refreshedUser);
  287.         }
  289.         if ($originalUser instanceof PasswordAuthenticatedUserInterface || $refreshedUser instanceof PasswordAuthenticatedUserInterface) {
  290.             if (!$originalUser instanceof PasswordAuthenticatedUserInterface || !$refreshedUser instanceof PasswordAuthenticatedUserInterface || $originalUser->getPassword() !== $refreshedUser->getPassword()) {
  291.                 return true;
  292.             }
  294.             if ($originalUser instanceof LegacyPasswordAuthenticatedUserInterface xor $refreshedUser instanceof LegacyPasswordAuthenticatedUserInterface) {
  295.                 return true;
  296.             }
  298.             if ($originalUser instanceof LegacyPasswordAuthenticatedUserInterface && $refreshedUser instanceof LegacyPasswordAuthenticatedUserInterface && $originalUser->getSalt() !== $refreshedUser->getSalt()) {
  299.                 return true;
  300.             }
  301.         }
  303.         $userRoles = array_map('strval', (array) $refreshedUser->getRoles());
  305.         if ($refreshedToken instanceof SwitchUserToken) {
  306.             $userRoles[] = 'ROLE_PREVIOUS_ADMIN';
  307.         }
  309.         if (
  310.             \count($userRoles) !== \count($refreshedToken->getRoleNames())
  311.             || \count($userRoles) !== \count(array_intersect($userRoles, $refreshedToken->getRoleNames()))
  312.         ) {
  313.             return true;
  314.         }
  316.         if ($originalUser->getUserIdentifier() !== $refreshedUser->getUserIdentifier()) {
  317.             return true;
  318.         }
  320.         return false;
  321.     }
  323.     /**
  324.      * @internal
  325.      */
  326.     public static function handleUnserializeCallback(string $class): never
  327.     {
  328.         throw new \ErrorException('Class not found: '.$class, 0x37313BC);
  329.     }
  330. }