vendor/symfony/security-http/Firewall/LogoutListener.php line 33

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 Symfony\Component\HttpFoundation\Request;
  12. use Symfony\Component\HttpFoundation\Response;
  13. use Symfony\Component\HttpKernel\Event\RequestEvent;
  14. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  15. use Symfony\Component\Security\Core\Exception\LogoutException;
  16. use Symfony\Component\Security\Csrf\CsrfToken;
  17. use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
  18. use Symfony\Component\Security\Http\HttpUtils;
  19. use Symfony\Component\Security\Http\Logout\LogoutHandlerInterface;
  20. use Symfony\Component\Security\Http\Logout\LogoutSuccessHandlerInterface;
  21. use Symfony\Component\Security\Http\ParameterBagUtils;
  22. /**
  23.  * LogoutListener logout users.
  24.  *
  25.  * @author Fabien Potencier <fabien@symfony.com>
  26.  *
  27.  * @final since Symfony 4.3
  28.  */
  29. class LogoutListener implements ListenerInterface
  30. {
  31.     use LegacyListenerTrait;
  32.     private $tokenStorage;
  33.     private $options;
  34.     private $handlers;
  35.     private $successHandler;
  36.     private $httpUtils;
  37.     private $csrfTokenManager;
  38.     /**
  39.      * @param HttpUtils                      $httpUtils        An HttpUtils instance
  40.      * @param LogoutSuccessHandlerInterface  $successHandler   A LogoutSuccessHandlerInterface instance
  41.      * @param array                          $options          An array of options to process a logout attempt
  42.      * @param CsrfTokenManagerInterface|null $csrfTokenManager A CsrfTokenManagerInterface instance
  43.      */
  44.     public function __construct(TokenStorageInterface $tokenStorageHttpUtils $httpUtilsLogoutSuccessHandlerInterface $successHandler, array $options = [], CsrfTokenManagerInterface $csrfTokenManager null)
  45.     {
  46.         $this->tokenStorage $tokenStorage;
  47.         $this->httpUtils $httpUtils;
  48.         $this->options array_merge([
  49.             'csrf_parameter' => '_csrf_token',
  50.             'csrf_token_id' => 'logout',
  51.             'logout_path' => '/logout',
  52.         ], $options);
  53.         $this->successHandler $successHandler;
  54.         $this->csrfTokenManager $csrfTokenManager;
  55.         $this->handlers = [];
  56.     }
  57.     public function addHandler(LogoutHandlerInterface $handler)
  58.     {
  59.         $this->handlers[] = $handler;
  60.     }
  61.     /**
  62.      * Performs the logout if requested.
  63.      *
  64.      * If a CsrfTokenManagerInterface instance is available, it will be used to
  65.      * validate the request.
  66.      *
  67.      * @throws LogoutException   if the CSRF token is invalid
  68.      * @throws \RuntimeException if the LogoutSuccessHandlerInterface instance does not return a response
  69.      */
  70.     public function __invoke(RequestEvent $event)
  71.     {
  72.         $request $event->getRequest();
  73.         if (!$this->requiresLogout($request)) {
  74.             return;
  75.         }
  76.         if (null !== $this->csrfTokenManager) {
  77.             $csrfToken ParameterBagUtils::getRequestParameterValue($request$this->options['csrf_parameter']);
  78.             if (false === $this->csrfTokenManager->isTokenValid(new CsrfToken($this->options['csrf_token_id'], $csrfToken))) {
  79.                 throw new LogoutException('Invalid CSRF token.');
  80.             }
  81.         }
  82.         $response $this->successHandler->onLogoutSuccess($request);
  83.         if (!$response instanceof Response) {
  84.             throw new \RuntimeException('Logout Success Handler did not return a Response.');
  85.         }
  86.         // handle multiple logout attempts gracefully
  87.         if ($token $this->tokenStorage->getToken()) {
  88.             foreach ($this->handlers as $handler) {
  89.                 $handler->logout($request$response$token);
  90.             }
  91.         }
  92.         $this->tokenStorage->setToken(null);
  93.         $event->setResponse($response);
  94.     }
  95.     /**
  96.      * Whether this request is asking for logout.
  97.      *
  98.      * The default implementation only processed requests to a specific path,
  99.      * but a subclass could change this to logout requests where
  100.      * certain parameters is present.
  101.      *
  102.      * @return bool
  103.      */
  104.     protected function requiresLogout(Request $request)
  105.     {
  106.         return isset($this->options['logout_path']) && $this->httpUtils->checkRequestPath($request$this->options['logout_path']);
  107.     }
  108. }