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

  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\Event\LogoutEvent;
  22. use Symfony\Component\Security\Http\HttpUtils;
  23. use Symfony\Component\Security\Http\ParameterBagUtils;
  24. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  26. /**
  27.  * LogoutListener logout users.
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  *
  31.  * @final
  32.  */
  33. class LogoutListener extends AbstractListener
  34. {
  35.     private TokenStorageInterface $tokenStorage;
  36.     private array $options;
  37.     private HttpUtils $httpUtils;
  38.     private ?CsrfTokenManagerInterface $csrfTokenManager;
  39.     private EventDispatcherInterface $eventDispatcher;
  41.     /**
  42.      * @param array $options An array of options to process a logout attempt
  43.      */
  44.     public function __construct(TokenStorageInterface $tokenStorage, HttpUtils $httpUtils, EventDispatcherInterface $eventDispatcher, 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->csrfTokenManager = $csrfTokenManager;
  54.         $this->eventDispatcher = $eventDispatcher;
  55.     }
  57.     public function supports(Request $request): ?bool
  58.     {
  59.         return $this->requiresLogout($request);
  60.     }
  62.     /**
  63.      * Performs the logout if requested.
  64.      *
  65.      * If a CsrfTokenManagerInterface instance is available, it will be used to
  66.      * validate the request.
  67.      *
  68.      * @throws LogoutException   if the CSRF token is invalid
  69.      * @throws \RuntimeException if the LogoutEvent listener does not set a response
  70.      */
  71.     public function authenticate(RequestEvent $event): void
  72.     {
  73.         $request = $event->getRequest();
  75.         if (null !== $this->csrfTokenManager) {
  76.             $csrfToken = ParameterBagUtils::getRequestParameterValue($request, $this->options['csrf_parameter']);
  78.             if (!\is_string($csrfToken) || false === $this->csrfTokenManager->isTokenValid(new CsrfToken($this->options['csrf_token_id'], $csrfToken))) {
  79.                 throw new LogoutException('Invalid CSRF token.');
  80.             }
  81.         }
  83.         $logoutEvent = new LogoutEvent($request, $this->tokenStorage->getToken());
  84.         $this->eventDispatcher->dispatch($logoutEvent);
  86.         if (!$response = $logoutEvent->getResponse()) {
  87.             throw new \RuntimeException('No logout listener set the Response, make sure at least the DefaultLogoutListener is registered.');
  88.         }
  90.         $this->tokenStorage->setToken(null);
  92.         $event->setResponse($response);
  93.     }
  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.     protected function requiresLogout(Request $request): bool
  103.     {
  104.         return isset($this->options['logout_path']) && $this->httpUtils->checkRequestPath($request, $this->options['logout_path']);
  105.     }
  107.     public static function getPriority(): int
  108.     {
  109.         return -127;
  110.     }
  111. }