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

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