vendor/symfony/security-http/EventListener/CheckRememberMeConditionsListener.php line 41

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\LoginSuccessEvent;
  18. use Symfony\Component\Security\Http\ParameterBagUtils;
  20. /**
  21.  * Checks if all conditions are met for remember me.
  22.  *
  23.  * The conditions that must be met for this listener to enable remember me:
  24.  *  A) This badge is present in the Passport
  25.  *  B) The remember_me key under your firewall is configured
  26.  *  C) The "remember me" functionality is activated. This is usually
  27.  *      done by having a _remember_me checkbox in your form, but
  28.  *      can be configured by the "always_remember_me" and "remember_me_parameter"
  29.  *      parameters under the "remember_me" firewall key (or "always_remember_me"
  30.  *      is enabled)
  31.  *
  32.  * @author Wouter de Jong <wouter@wouterj.nl>
  33.  *
  34.  * @final
  35.  */
  36. class CheckRememberMeConditionsListener implements EventSubscriberInterface
  37. {
  38.     private array $options;
  39.     private ?LoggerInterface $logger;
  41.     public function __construct(array $options = [], LoggerInterface $logger = null)
  42.     {
  43.         $this->options = $options + ['always_remember_me' => false, 'remember_me_parameter' => '_remember_me'];
  44.         $this->logger = $logger;
  45.     }
  47.     public function onSuccessfulLogin(LoginSuccessEvent $event): void
  48.     {
  49.         $passport = $event->getPassport();
  50.         if (!$passport->hasBadge(RememberMeBadge::class)) {
  51.             return;
  52.         }
  54.         /** @var RememberMeBadge $badge */
  55.         $badge = $passport->getBadge(RememberMeBadge::class);
  56.         if (!$this->options['always_remember_me']) {
  57.             $parameter = ParameterBagUtils::getRequestParameterValue($event->getRequest(), $this->options['remember_me_parameter']);
  58.             if (!('true' === $parameter || 'on' === $parameter || '1' === $parameter || 'yes' === $parameter || true === $parameter)) {
  59.                 $this->logger?->debug('Remember me disabled; request does not contain remember me parameter ("{parameter}").', ['parameter' => $this->options['remember_me_parameter']]);
  61.                 return;
  62.             }
  63.         }
  65.         $badge->enable();
  66.     }
  68.     public static function getSubscribedEvents(): array
  69.     {
  70.         return [LoginSuccessEvent::class => ['onSuccessfulLogin', -32]];
  71.     }
  72. }