vendor/symfony/security/Http/Firewall/RememberMeListener.php line31

Open in your IDE?
  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\EventDispatcher\EventDispatcherInterface;
  16. use Symfony\Component\HttpKernel\Event\GetResponseEvent;
  17. use Symfony\Component\Security\Core\Authentication\AuthenticationManagerInterface;
  18. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  19. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  20. use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
  21. use Symfony\Component\Security\Http\RememberMe\RememberMeServicesInterface;
  22. use Symfony\Component\Security\Http\SecurityEvents;
  23. use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategy;
  24. use Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface;
  26. /**
  27.  * RememberMeListener implements authentication capabilities via a cookie.
  28.  *
  29.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  30.  */
  31. class RememberMeListener implements ListenerInterface
  32. {
  33.     private $tokenStorage;
  34.     private $rememberMeServices;
  35.     private $authenticationManager;
  36.     private $logger;
  37.     private $dispatcher;
  38.     private $catchExceptions = true;
  39.     private $sessionStrategy;
  41.     /**
  42.      * @param TokenStorageInterface                       $tokenStorage
  43.      * @param RememberMeServicesInterface                 $rememberMeServices
  44.      * @param AuthenticationManagerInterface              $authenticationManager
  45.      * @param LoggerInterface|null                        $logger
  46.      * @param EventDispatcherInterface|null               $dispatcher
  47.      * @param bool                                        $catchExceptions
  48.      * @param SessionAuthenticationStrategyInterface|null $sessionStrategy
  49.      */
  50.     public function __construct(TokenStorageInterface $tokenStorage, RememberMeServicesInterface $rememberMeServices, AuthenticationManagerInterface $authenticationManager, LoggerInterface $logger = null, EventDispatcherInterface $dispatcher = null, $catchExceptions = true, SessionAuthenticationStrategyInterface $sessionStrategy = null)
  51.     {
  52.         $this->tokenStorage = $tokenStorage;
  53.         $this->rememberMeServices = $rememberMeServices;
  54.         $this->authenticationManager = $authenticationManager;
  55.         $this->logger = $logger;
  56.         $this->dispatcher = $dispatcher;
  57.         $this->catchExceptions = $catchExceptions;
  58.         $this->sessionStrategy = null === $sessionStrategy ? new SessionAuthenticationStrategy(SessionAuthenticationStrategy::MIGRATE) : $sessionStrategy;
  59.     }
  61.     /**
  62.      * Handles remember-me cookie based authentication.
  63.      */
  64.     public function handle(GetResponseEvent $event)
  65.     {
  66.         if (null !== $this->tokenStorage->getToken()) {
  67.             return;
  68.         }
  70.         $request = $event->getRequest();
  71.         try {
  72.             if (null === $token = $this->rememberMeServices->autoLogin($request)) {
  73.                 return;
  74.             }
  75.         } catch (AuthenticationException $e) {
  76.             if (null !== $this->logger) {
  77.                 $this->logger->warning(
  78.                     'The token storage was not populated with remember-me token as the'
  79.                    .' RememberMeServices was not able to create a token from the remember'
  80.                    .' me information.', ['exception' => $e]
  81.                 );
  82.             }
  84.             $this->rememberMeServices->loginFail($request);
  86.             if (!$this->catchExceptions) {
  87.                 throw $e;
  88.             }
  90.             return;
  91.         }
  93.         try {
  94.             $token = $this->authenticationManager->authenticate($token);
  95.             if ($request->hasSession() && $request->getSession()->isStarted()) {
  96.                 $this->sessionStrategy->onAuthentication($request, $token);
  97.             }
  98.             $this->tokenStorage->setToken($token);
  100.             if (null !== $this->dispatcher) {
  101.                 $loginEvent = new InteractiveLoginEvent($request, $token);
  102.                 $this->dispatcher->dispatch(SecurityEvents::INTERACTIVE_LOGIN, $loginEvent);
  103.             }
  105.             if (null !== $this->logger) {
  106.                 $this->logger->debug('Populated the token storage with a remember-me token.');
  107.             }
  108.         } catch (AuthenticationException $e) {
  109.             if (null !== $this->logger) {
  110.                 $this->logger->warning(
  111.                     'The token storage was not populated with remember-me token as the'
  112.                    .' AuthenticationManager rejected the AuthenticationToken returned'
  113.                    .' by the RememberMeServices.', ['exception' => $e]
  114.                 );
  115.             }
  117.             $this->rememberMeServices->loginFail($request, $e);
  119.             if (!$this->catchExceptions) {
  120.                 throw $e;
  121.             }
  122.         }
  123.     }
  124. }