vendor/symfony/security/Http/Firewall/ContextListener.php line 120

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