vendor/symfony/security-http/RememberMe/AbstractRememberMeHandler.php line 31

  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\RememberMe;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\HttpFoundation\Cookie;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  18. use Symfony\Component\Security\Core\User\UserInterface;
  19. use Symfony\Component\Security\Core\User\UserProviderInterface;
  21. /**
  22.  * @author Wouter de Jong <wouter@wouterj.nl>
  23.  */
  24. abstract class AbstractRememberMeHandler implements RememberMeHandlerInterface
  25. {
  26.     private UserProviderInterface $userProvider;
  27.     protected $requestStack;
  28.     protected $options;
  29.     protected $logger;
  31.     public function __construct(UserProviderInterface $userProvider, RequestStack $requestStack, array $options = [], LoggerInterface $logger = null)
  32.     {
  33.         $this->userProvider = $userProvider;
  34.         $this->requestStack = $requestStack;
  35.         $this->options = $options + [
  36.             'name' => 'REMEMBERME',
  37.             'lifetime' => 31536000,
  38.             'path' => '/',
  39.             'domain' => null,
  40.             'secure' => false,
  41.             'httponly' => true,
  42.             'samesite' => null,
  43.             'always_remember_me' => false,
  44.             'remember_me_parameter' => '_remember_me',
  45.         ];
  46.         $this->logger = $logger;
  47.     }
  49.     /**
  50.      * Checks if the RememberMeDetails is a valid cookie to login the given User.
  51.      *
  52.      * This method should also:
  53.      * - Create a new remember-me cookie to be sent with the response (using {@see createCookie()});
  54.      * - If you store the token somewhere else (e.g. in a database), invalidate the stored token.
  55.      *
  56.      * @throws AuthenticationException If the remember-me details are not accepted
  57.      */
  58.     abstract protected function processRememberMe(RememberMeDetails $rememberMeDetails, UserInterface $user): void;
  60.     public function consumeRememberMeCookie(RememberMeDetails $rememberMeDetails): UserInterface
  61.     {
  62.         try {
  63.             $user = $this->userProvider->loadUserByIdentifier($rememberMeDetails->getUserIdentifier());
  64.         } catch (AuthenticationException $e) {
  65.             throw $e;
  66.         }
  68.         if (!$user instanceof UserInterface) {
  69.             throw new \LogicException(sprintf('The UserProviderInterface implementation must return an instance of UserInterface, but returned "%s".', get_debug_type($user)));
  70.         }
  72.         $this->processRememberMe($rememberMeDetails, $user);
  74.         $this->logger?->info('Remember-me cookie accepted.');
  76.         return $user;
  77.     }
  79.     public function clearRememberMeCookie(): void
  80.     {
  81.         $this->logger?->debug('Clearing remember-me cookie.', ['name' => $this->options['name']]);
  83.         $this->createCookie(null);
  84.     }
  86.     /**
  87.      * Creates the remember-me cookie using the correct configuration.
  88.      *
  89.      * @param RememberMeDetails|null $rememberMeDetails The details for the cookie, or null to clear the remember-me cookie
  90.      */
  91.     protected function createCookie(?RememberMeDetails $rememberMeDetails)
  92.     {
  93.         $request = $this->requestStack->getMainRequest();
  94.         if (!$request) {
  95.             throw new \LogicException('Cannot create the remember-me cookie; no master request available.');
  96.         }
  98.         // the ResponseListener configures the cookie saved in this attribute on the final response object
  99.         $request->attributes->set(ResponseListener::COOKIE_ATTR_NAME, new Cookie(
  100.             $this->options['name'],
  101.             $rememberMeDetails?->toString(),
  102.             $rememberMeDetails?->getExpires() ?? 1,
  103.             $this->options['path'],
  104.             $this->options['domain'],
  105.             $this->options['secure'] ?? $request->isSecure(),
  106.             $this->options['httponly'],
  107.             false,
  108.             $this->options['samesite']
  109.         ));
  110.     }
  111. }