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

Open in your IDE?
  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\Security\Http\Firewall;
  11. use Psr\Log\LoggerInterface;
  12. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  13. use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
  14. use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
  15. use Symfony\Component\HttpKernel\Event\RequestEvent;
  16. use Symfony\Component\HttpKernel\KernelEvents;
  17. use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolver;
  18. use Symfony\Component\Security\Core\Authentication\AuthenticationTrustResolverInterface;
  19. use Symfony\Component\Security\Core\Authentication\Token\AnonymousToken;
  20. use Symfony\Component\Security\Core\Authentication\Token\RememberMeToken;
  21. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  22. use Symfony\Component\Security\Core\Authentication\Token\SwitchUserToken;
  23. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  24. use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
  25. use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
  26. use Symfony\Component\Security\Core\Role\SwitchUserRole;
  27. use Symfony\Component\Security\Core\User\UserInterface;
  28. use Symfony\Component\Security\Core\User\UserProviderInterface;
  29. use Symfony\Component\Security\Http\Event\DeauthenticatedEvent;
  30. /**
  31.  * ContextListener manages the SecurityContext persistence through a session.
  32.  *
  33.  * @author Fabien Potencier <fabien@symfony.com>
  34.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  35.  *
  36.  * @final since Symfony 4.3
  37.  */
  38. class ContextListener implements ListenerInterface
  39. {
  40.     use LegacyListenerTrait;
  41.     private $tokenStorage;
  42.     private $sessionKey;
  43.     private $logger;
  44.     private $userProviders;
  45.     private $dispatcher;
  46.     private $registered;
  47.     private $trustResolver;
  48.     /**
  49.      * @param iterable|UserProviderInterface[] $userProviders
  50.      */
  51.     public function __construct(TokenStorageInterface $tokenStorageiterable $userProvidersstring $contextKeyLoggerInterface $logger nullEventDispatcherInterface $dispatcher nullAuthenticationTrustResolverInterface $trustResolver null)
  52.     {
  53.         if (empty($contextKey)) {
  54.             throw new \InvalidArgumentException('$contextKey must not be empty.');
  55.         }
  56.         $this->tokenStorage $tokenStorage;
  57.         $this->userProviders $userProviders;
  58.         $this->sessionKey '_security_'.$contextKey;
  59.         $this->logger $logger;
  60.         $this->dispatcher LegacyEventDispatcherProxy::decorate($dispatcher);
  61.         $this->trustResolver $trustResolver ?: new AuthenticationTrustResolver(AnonymousToken::class, RememberMeToken::class);
  62.     }
  63.     /**
  64.      * Enables deauthentication during refreshUser when the user has changed.
  65.      *
  66.      * @param bool $logoutOnUserChange
  67.      *
  68.      * @deprecated since Symfony 4.1
  69.      */
  70.     public function setLogoutOnUserChange($logoutOnUserChange)
  71.     {
  72.         @trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.1.'__METHOD__), E_USER_DEPRECATED);
  73.     }
  74.     /**
  75.      * Reads the Security Token from the session.
  76.      */
  77.     public function __invoke(RequestEvent $event)
  78.     {
  79.         if (!$this->registered && null !== $this->dispatcher && $event->isMasterRequest()) {
  80.             $this->dispatcher->addListener(KernelEvents::RESPONSE, [$this'onKernelResponse']);
  81.             $this->registered true;
  82.         }
  83.         $request $event->getRequest();
  84.         $session $request->hasPreviousSession() ? $request->getSession() : null;
  85.         if (null === $session || null === $token $session->get($this->sessionKey)) {
  86.             $this->tokenStorage->setToken(null);
  87.             return;
  88.         }
  89.         $token $this->safelyUnserialize($token);
  90.         if (null !== $this->logger) {
  91.             $this->logger->debug('Read existing security token from the session.', [
  92.                 'key' => $this->sessionKey,
  93.                 'token_class' => \is_object($token) ? \get_class($token) : null,
  94.             ]);
  95.         }
  96.         if ($token instanceof TokenInterface) {
  97.             $token $this->refreshUser($token);
  98.         } elseif (null !== $token) {
  99.             if (null !== $this->logger) {
  100.                 $this->logger->warning('Expected a security token from the session, got something else.', ['key' => $this->sessionKey'received' => $token]);
  101.             }
  102.             $token null;
  103.         }
  104.         $this->tokenStorage->setToken($token);
  105.     }
  106.     /**
  107.      * Writes the security token into the session.
  108.      */
  109.     public function onKernelResponse(FilterResponseEvent $event)
  110.     {
  111.         if (!$event->isMasterRequest()) {
  112.             return;
  113.         }
  114.         $request $event->getRequest();
  115.         if (!$request->hasSession()) {
  116.             return;
  117.         }
  118.         $this->dispatcher->removeListener(KernelEvents::RESPONSE, [$this'onKernelResponse']);
  119.         $this->registered false;
  120.         $session $request->getSession();
  121.         if ((null === $token $this->tokenStorage->getToken()) || $this->trustResolver->isAnonymous($token)) {
  122.             if ($request->hasPreviousSession()) {
  123.                 $session->remove($this->sessionKey);
  124.             }
  125.         } else {
  126.             $session->set($this->sessionKeyserialize($token));
  127.             if (null !== $this->logger) {
  128.                 $this->logger->debug('Stored the security token in the session.', ['key' => $this->sessionKey]);
  129.             }
  130.         }
  131.     }
  132.     /**
  133.      * Refreshes the user by reloading it from the user provider.
  134.      *
  135.      * @return TokenInterface|null
  136.      *
  137.      * @throws \RuntimeException
  138.      */
  139.     protected function refreshUser(TokenInterface $token)
  140.     {
  141.         $user $token->getUser();
  142.         if (!$user instanceof UserInterface) {
  143.             return $token;
  144.         }
  145.         $userNotFoundByProvider false;
  146.         $userDeauthenticated false;
  147.         foreach ($this->userProviders as $provider) {
  148.             if (!$provider instanceof UserProviderInterface) {
  149.                 throw new \InvalidArgumentException(sprintf('User provider "%s" must implement "%s".', \get_class($provider), UserProviderInterface::class));
  150.             }
  151.             try {
  152.                 $refreshedUser $provider->refreshUser($user);
  153.                 $newToken = clone $token;
  154.                 $newToken->setUser($refreshedUser);
  155.                 // tokens can be deauthenticated if the user has been changed.
  156.                 if (!$newToken->isAuthenticated()) {
  157.                     $userDeauthenticated true;
  158.                     if (null !== $this->logger) {
  159.                         $this->logger->debug('Cannot refresh token because user has changed.', ['username' => $refreshedUser->getUsername(), 'provider' => \get_class($provider)]);
  160.                     }
  161.                     continue;
  162.                 }
  163.                 $token->setUser($refreshedUser);
  164.                 if (null !== $this->logger) {
  165.                     $context = ['provider' => \get_class($provider), 'username' => $refreshedUser->getUsername()];
  166.                     if ($token instanceof SwitchUserToken) {
  167.                         $context['impersonator_username'] = $token->getOriginalToken()->getUsername();
  168.                     } else {
  169.                         foreach ($token->getRoles(false) as $role) {
  170.                             if ($role instanceof SwitchUserRole) {
  171.                                 $context['impersonator_username'] = $role->getSource(false)->getUsername();
  172.                                 break;
  173.                             }
  174.                         }
  175.                     }
  176.                     $this->logger->debug('User was reloaded from a user provider.'$context);
  177.                 }
  178.                 return $token;
  179.             } catch (UnsupportedUserException $e) {
  180.                 // let's try the next user provider
  181.             } catch (UsernameNotFoundException $e) {
  182.                 if (null !== $this->logger) {
  183.                     $this->logger->warning('Username could not be found in the selected user provider.', ['username' => $e->getUsername(), 'provider' => \get_class($provider)]);
  184.                 }
  185.                 $userNotFoundByProvider true;
  186.             }
  187.         }
  188.         if ($userDeauthenticated) {
  189.             if (null !== $this->logger) {
  190.                 $this->logger->debug('Token was deauthenticated after trying to refresh it.');
  191.             }
  192.             if (null !== $this->dispatcher) {
  193.                 $this->dispatcher->dispatch(new DeauthenticatedEvent($token$newToken), DeauthenticatedEvent::class);
  194.             }
  195.             return null;
  196.         }
  197.         if ($userNotFoundByProvider) {
  198.             return null;
  199.         }
  200.         throw new \RuntimeException(sprintf('There is no user provider for user "%s".', \get_class($user)));
  201.     }
  202.     private function safelyUnserialize($serializedToken)
  203.     {
  204.         $e $token null;
  205.         $prevUnserializeHandler ini_set('unserialize_callback_func'__CLASS__.'::handleUnserializeCallback');
  206.         $prevErrorHandler set_error_handler(function ($type$msg$file$line$context = []) use (&$prevErrorHandler) {
  207.             if (__FILE__ === $file) {
  208.                 throw new \ErrorException($msg0x37313bc$type$file$line);
  209.             }
  210.             return $prevErrorHandler $prevErrorHandler($type$msg$file$line$context) : false;
  211.         });
  212.         try {
  213.             $token unserialize($serializedToken);
  214.         } catch (\Throwable $e) {
  215.         }
  216.         restore_error_handler();
  217.         ini_set('unserialize_callback_func'$prevUnserializeHandler);
  218.         if ($e) {
  219.             if (!$e instanceof \ErrorException || 0x37313bc !== $e->getCode()) {
  220.                 throw $e;
  221.             }
  222.             if ($this->logger) {
  223.                 $this->logger->warning('Failed to unserialize the security token from the session.', ['key' => $this->sessionKey'received' => $serializedToken'exception' => $e]);
  224.             }
  225.         }
  226.         return $token;
  227.     }
  228.     /**
  229.      * @internal
  230.      */
  231.     public static function handleUnserializeCallback($class)
  232.     {
  233.         throw new \ErrorException('Class not found: '.$class0x37313bc);
  234.     }
  235. }