vendor/symfony/security/Http/Firewall/LogoutListener.php line 31

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