vendor/symfony/security-http/Authenticator/RememberMeAuthenticator.php line 44

  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\Authenticator;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\Response;
  17. use Symfony\Component\Security\Core\Authentication\Token\RememberMeToken;
  18. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  19. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  20. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  21. use Symfony\Component\Security\Core\Exception\CookieTheftException;
  22. use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
  23. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  24. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
  25. use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
  26. use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
  27. use Symfony\Component\Security\Http\RememberMe\RememberMeDetails;
  28. use Symfony\Component\Security\Http\RememberMe\RememberMeHandlerInterface;
  29. use Symfony\Component\Security\Http\RememberMe\ResponseListener;
  31. /**
  32.  * The RememberMe *Authenticator* performs remember me authentication.
  33.  *
  34.  * This authenticator is executed whenever a user's session
  35.  * expired and a remember-me cookie was found. This authenticator
  36.  * then "re-authenticates" the user using the information in the
  37.  * cookie.
  38.  *
  39.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  40.  * @author Wouter de Jong <wouter@wouterj.nl>
  41.  *
  42.  * @final
  43.  */
  44. class RememberMeAuthenticator implements InteractiveAuthenticatorInterface
  45. {
  46.     private RememberMeHandlerInterface $rememberMeHandler;
  47.     private string $secret;
  48.     private TokenStorageInterface $tokenStorage;
  49.     private string $cookieName;
  50.     private ?LoggerInterface $logger;
  52.     public function __construct(RememberMeHandlerInterface $rememberMeHandler, #[\SensitiveParameter] string $secret, TokenStorageInterface $tokenStorage, string $cookieName, LoggerInterface $logger = null)
  53.     {
  54.         $this->rememberMeHandler = $rememberMeHandler;
  55.         $this->secret = $secret;
  56.         $this->tokenStorage = $tokenStorage;
  57.         $this->cookieName = $cookieName;
  58.         $this->logger = $logger;
  59.     }
  61.     public function supports(Request $request): ?bool
  62.     {
  63.         // do not overwrite already stored tokens (i.e. from the session)
  64.         if (null !== $this->tokenStorage->getToken()) {
  65.             return false;
  66.         }
  68.         if (($cookie = $request->attributes->get(ResponseListener::COOKIE_ATTR_NAME)) && null === $cookie->getValue()) {
  69.             return false;
  70.         }
  72.         if (!$request->cookies->has($this->cookieName)) {
  73.             return false;
  74.         }
  76.         $this->logger?->debug('Remember-me cookie detected.');
  78.         // the `null` return value indicates that this authenticator supports lazy firewalls
  79.         return null;
  80.     }
  82.     public function authenticate(Request $request): Passport
  83.     {
  84.         if (!$rawCookie = $request->cookies->get($this->cookieName)) {
  85.             throw new \LogicException('No remember-me cookie is found.');
  86.         }
  88.         $rememberMeCookie = RememberMeDetails::fromRawCookie($rawCookie);
  90.         $userBadge = new UserBadge($rememberMeCookie->getUserIdentifier(), function () use ($rememberMeCookie) {
  91.             return $this->rememberMeHandler->consumeRememberMeCookie($rememberMeCookie);
  92.         });
  94.         return new SelfValidatingPassport($userBadge);
  95.     }
  97.     public function createToken(Passport $passport, string $firewallName): TokenInterface
  98.     {
  99.         return new RememberMeToken($passport->getUser(), $firewallName, $this->secret);
  100.     }
  102.     public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
  103.     {
  104.         return null; // let the original request continue
  105.     }
  107.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
  108.     {
  109.         if (null !== $this->logger) {
  110.             if ($exception instanceof UserNotFoundException) {
  111.                 $this->logger->info('User for remember-me cookie not found.', ['exception' => $exception]);
  112.             } elseif ($exception instanceof UnsupportedUserException) {
  113.                 $this->logger->warning('User class for remember-me cookie not supported.', ['exception' => $exception]);
  114.             } elseif (!$exception instanceof CookieTheftException) {
  115.                 $this->logger->debug('Remember me authentication failed.', ['exception' => $exception]);
  116.             }
  117.         }
  119.         return null;
  120.     }
  122.     public function isInteractive(): bool
  123.     {
  124.         return true;
  125.     }
  126. }