vendor/symfony/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
  32.  */
  33. class LogoutListener extends AbstractListener
  34. {
  35.     private $tokenStorage;
  36.     private $options;
  37.     private $handlers;
  38.     private $successHandler;
  39.     private $httpUtils;
  40.     private $csrfTokenManager;
  42.     /**
  43.      * @param array $options An array of options to process a logout attempt
  44.      */
  45.     public function __construct(TokenStorageInterface $tokenStorage, HttpUtils $httpUtils, LogoutSuccessHandlerInterface $successHandler, array $options = [], CsrfTokenManagerInterface $csrfTokenManager = null)
  46.     {
  47.         $this->tokenStorage = $tokenStorage;
  48.         $this->httpUtils = $httpUtils;
  49.         $this->options = array_merge([
  50.             'csrf_parameter' => '_csrf_token',
  51.             'csrf_token_id' => 'logout',
  52.             'logout_path' => '/logout',
  53.         ], $options);
  54.         $this->successHandler = $successHandler;
  55.         $this->csrfTokenManager = $csrfTokenManager;
  56.         $this->handlers = [];
  57.     }
  59.     public function addHandler(LogoutHandlerInterface $handler)
  60.     {
  61.         $this->handlers[] = $handler;
  62.     }
  64.     /**
  65.      * {@inheritdoc}
  66.      */
  67.     public function supports(Request $request): ?bool
  68.     {
  69.         return $this->requiresLogout($request);
  70.     }
  72.     /**
  73.      * Performs the logout if requested.
  74.      *
  75.      * If a CsrfTokenManagerInterface instance is available, it will be used to
  76.      * validate the request.
  77.      *
  78.      * @throws LogoutException   if the CSRF token is invalid
  79.      * @throws \RuntimeException if the LogoutSuccessHandlerInterface instance does not return a response
  80.      */
  81.     public function authenticate(RequestEvent $event)
  82.     {
  83.         $request = $event->getRequest();
  85.         if (null !== $this->csrfTokenManager) {
  86.             $csrfToken = ParameterBagUtils::getRequestParameterValue($request, $this->options['csrf_parameter']);
  88.             if (false === $this->csrfTokenManager->isTokenValid(new CsrfToken($this->options['csrf_token_id'], $csrfToken))) {
  89.                 throw new LogoutException('Invalid CSRF token.');
  90.             }
  91.         }
  93.         $response = $this->successHandler->onLogoutSuccess($request);
  94.         if (!$response instanceof Response) {
  95.             throw new \RuntimeException('Logout Success Handler did not return a Response.');
  96.         }
  98.         // handle multiple logout attempts gracefully
  99.         if ($token = $this->tokenStorage->getToken()) {
  100.             foreach ($this->handlers as $handler) {
  101.                 $handler->logout($request, $response, $token);
  102.             }
  103.         }
  105.         $this->tokenStorage->setToken(null);
  107.         $event->setResponse($response);
  108.     }
  110.     /**
  111.      * Whether this request is asking for logout.
  112.      *
  113.      * The default implementation only processed requests to a specific path,
  114.      * but a subclass could change this to logout requests where
  115.      * certain parameters is present.
  116.      */
  117.     protected function requiresLogout(Request $request): bool
  118.     {
  119.         return isset($this->options['logout_path']) && $this->httpUtils->checkRequestPath($request, $this->options['logout_path']);
  120.     }
  121. }