vendor/symfony/security-http/EventListener/RememberMeListener.php line 40

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\EventListener;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  16. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\RememberMeBadge;
  17. use Symfony\Component\Security\Http\Event\LoginFailureEvent;
  18. use Symfony\Component\Security\Http\Event\LoginSuccessEvent;
  19. use Symfony\Component\Security\Http\Event\LogoutEvent;
  20. use Symfony\Component\Security\Http\Event\TokenDeauthenticatedEvent;
  21. use Symfony\Component\Security\Http\RememberMe\RememberMeHandlerInterface;
  23. /**
  24.  * The RememberMe *listener* creates and deletes remember-me cookies.
  25.  *
  26.  * Upon login success or failure and support for remember me
  27.  * in the firewall and authenticator, this listener will create
  28.  * a remember-me cookie.
  29.  * Upon login failure, all remember-me cookies are removed.
  30.  *
  31.  * @author Wouter de Jong <wouter@wouterj.nl>
  32.  *
  33.  * @final
  34.  */
  35. class RememberMeListener implements EventSubscriberInterface
  36. {
  37.     private RememberMeHandlerInterface $rememberMeHandler;
  38.     private ?LoggerInterface $logger;
  40.     public function __construct(RememberMeHandlerInterface $rememberMeHandler, LoggerInterface $logger = null)
  41.     {
  42.         $this->rememberMeHandler = $rememberMeHandler;
  43.         $this->logger = $logger;
  44.     }
  46.     public function onSuccessfulLogin(LoginSuccessEvent $event): void
  47.     {
  48.         $passport = $event->getPassport();
  49.         if (!$passport->hasBadge(RememberMeBadge::class)) {
  50.             $this->logger?->debug('Remember me skipped: your authenticator does not support it.', ['authenticator' => \get_class($event->getAuthenticator())]);
  52.             return;
  53.         }
  55.         // Make sure any old remember-me cookies are cancelled
  56.         $this->rememberMeHandler->clearRememberMeCookie();
  58.         /** @var RememberMeBadge $badge */
  59.         $badge = $passport->getBadge(RememberMeBadge::class);
  60.         if (!$badge->isEnabled()) {
  61.             $this->logger?->debug('Remember me skipped: the RememberMeBadge is not enabled.');
  63.             return;
  64.         }
  66.         $this->logger?->debug('Remember-me was requested; setting cookie.');
  68.         $this->rememberMeHandler->createRememberMeCookie($event->getUser());
  69.     }
  71.     public function clearCookie(): void
  72.     {
  73.         $this->rememberMeHandler->clearRememberMeCookie();
  74.     }
  76.     public static function getSubscribedEvents(): array
  77.     {
  78.         return [
  79.             LoginSuccessEvent::class => ['onSuccessfulLogin', -64],
  80.             LoginFailureEvent::class => 'clearCookie',
  81.             LogoutEvent::class => 'clearCookie',
  82.             TokenDeauthenticatedEvent::class => 'clearCookie',
  83.         ];
  84.     }
  85. }