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

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