vendor/symfony/symfony/src/Symfony/Component/Security/Http/Firewall/LogoutListener.php line 33

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