vendor/gesdinet/jwt-refresh-token-bundle/Security/Http/Authenticator/RefreshTokenAuthenticator.php line 41

  1. <?php
  3. /*
  4.  * This file is part of the GesdinetJWTRefreshTokenBundle package.
  5.  *
  6.  * (c) Gesdinet <http://www.gesdinet.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 Gesdinet\JWTRefreshTokenBundle\Security\Http\Authenticator;
  14. use Gesdinet\JWTRefreshTokenBundle\Event\RefreshTokenNotFoundEvent;
  15. use Gesdinet\JWTRefreshTokenBundle\Http\RefreshAuthenticationFailureResponse;
  16. use Gesdinet\JWTRefreshTokenBundle\Model\RefreshTokenInterface;
  17. use Gesdinet\JWTRefreshTokenBundle\Model\RefreshTokenManagerInterface;
  18. use Gesdinet\JWTRefreshTokenBundle\Request\Extractor\ExtractorInterface;
  19. use Gesdinet\JWTRefreshTokenBundle\Security\Exception\InvalidTokenException;
  20. use Gesdinet\JWTRefreshTokenBundle\Security\Exception\MissingTokenException;
  21. use Gesdinet\JWTRefreshTokenBundle\Security\Exception\TokenNotFoundException;
  22. use Gesdinet\JWTRefreshTokenBundle\Security\Http\Authenticator\Token\PostRefreshTokenAuthenticationToken;
  23. use Symfony\Component\HttpFoundation\Request;
  24. use Symfony\Component\HttpFoundation\Response;
  25. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  26. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  27. use Symfony\Component\Security\Core\Exception\LogicException;
  28. use Symfony\Component\Security\Core\User\UserProviderInterface;
  29. use Symfony\Component\Security\Http\Authentication\AuthenticationFailureHandlerInterface;
  30. use Symfony\Component\Security\Http\Authentication\AuthenticationSuccessHandlerInterface;
  31. use Symfony\Component\Security\Http\Authenticator\AbstractAuthenticator;
  32. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
  33. use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
  34. use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;
  35. use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
  36. use Symfony\Component\Security\Http\Authenticator\Passport\UserPassportInterface;
  37. use Symfony\Component\Security\Http\EntryPoint\AuthenticationEntryPointInterface;
  38. use Symfony\Component\Security\Http\HttpUtils;
  39. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  41. class RefreshTokenAuthenticator extends AbstractAuthenticator implements AuthenticationEntryPointInterface
  42. {
  43.     private RefreshTokenManagerInterface $refreshTokenManager;
  45.     private EventDispatcherInterface $eventDispatcher;
  47.     private ExtractorInterface $extractor;
  49.     private UserProviderInterface $userProvider;
  51.     private AuthenticationSuccessHandlerInterface $successHandler;
  53.     private AuthenticationFailureHandlerInterface $failureHandler;
  55.     private array $options;
  57.     private ?HttpUtils $httpUtils;
  59.     public function __construct(
  60.         RefreshTokenManagerInterface $refreshTokenManager,
  61.         EventDispatcherInterface $eventDispatcher,
  62.         ExtractorInterface $extractor,
  63.         UserProviderInterface $userProvider,
  64.         AuthenticationSuccessHandlerInterface $successHandler,
  65.         AuthenticationFailureHandlerInterface $failureHandler,
  66.         array $options,
  67.         ?HttpUtils $httpUtils = null
  68.     ) {
  69.         $this->refreshTokenManager = $refreshTokenManager;
  70.         $this->eventDispatcher = $eventDispatcher;
  71.         $this->extractor = $extractor;
  72.         $this->userProvider = $userProvider;
  73.         $this->successHandler = $successHandler;
  74.         $this->failureHandler = $failureHandler;
  75.         $this->options = array_merge([
  76.             'check_path' => null, // @todo in 2.0, change the default to `/login_check`
  77.             'ttl' => 2592000,
  78.             'ttl_update' => false,
  79.             'token_parameter_name' => 'refresh_token',
  80.         ], $options);
  81.         $this->httpUtils = $httpUtils;
  83.         if (null === $httpUtils) {
  84.             trigger_deprecation('gesdinet/jwt-refresh-token-bundle', '1.1', 'Not passing an instance of "%s" to the "%s" constructor is deprecated, it will be required in 2.0.', HttpUtils::class, self::class);
  85.         }
  86.     }
  88.     public function supports(Request $request): bool
  89.     {
  90.         if (null !== $this->httpUtils && null !== $this->options['check_path']) {
  91.             return $this->httpUtils->checkRequestPath($request, $this->options['check_path']);
  92.         }
  94.         trigger_deprecation('gesdinet/jwt-refresh-token-bundle', '1.1', 'Checking if the refresh token is in the request in %s() is deprecated, as of 2.0 only the request path will be checked.', __METHOD__);
  96.         return null !== $this->extractor->getRefreshToken($request, $this->options['token_parameter_name']);
  97.     }
  99.     public function authenticate(Request $request): Passport
  100.     {
  101.         $token = $this->extractor->getRefreshToken($request, $this->options['token_parameter_name']);
  103.         if (null === $token) {
  104.             throw new MissingTokenException();
  105.         }
  107.         $refreshToken = $this->refreshTokenManager->get($token);
  109.         if (null === $refreshToken) {
  110.             throw new TokenNotFoundException();
  111.         }
  113.         if (!$refreshToken->isValid()) {
  114.             throw new InvalidTokenException(sprintf('Refresh token "%s" is invalid.', $refreshToken->getRefreshToken()));
  115.         }
  117.         if ($this->options['ttl_update']) {
  118.             $expirationDate = new \DateTime();
  120.             // Explicitly check for a negative number based on a behavior change in PHP 8.2, see https://github.com/php/php-src/issues/9950
  121.             if ($this->options['ttl'] > 0) {
  122.                 $expirationDate->modify(sprintf('+%d seconds', $this->options['ttl']));
  123.             } elseif ($this->options['ttl'] < 0) {
  124.                 $expirationDate->modify(sprintf('%d seconds', $this->options['ttl']));
  125.             }
  127.             $refreshToken->setValid($expirationDate);
  129.             $this->refreshTokenManager->save($refreshToken);
  130.         }
  132.         $method = method_exists($this->userProvider, 'loadUserByIdentifier') ? 'loadUserByIdentifier' : 'loadUserByUsername';
  134.         $passport = new SelfValidatingPassport(new UserBadge($refreshToken->getUsername(), [$this->userProvider, $method]));
  135.         $passport->setAttribute('refreshToken', $refreshToken);
  137.         return $passport;
  138.     }
  140.     /**
  141.      * @deprecated to be removed in 2.0, use `createToken()` instead
  142.      */
  143.     public function createAuthenticatedToken(PassportInterface $passport, string $firewallName): TokenInterface
  144.     {
  145.         if (!$passport instanceof UserPassportInterface) {
  146.             throw new LogicException(sprintf('Passport does not contain a user, overwrite "createToken()" in "%s" to create a custom authentication token.', static::class));
  147.         }
  149.         trigger_deprecation('gesdinet/jwt-refresh-token-bundle', '1.0', '"%s()" is deprecated, use "%s::createToken()" instead.', __METHOD__, __CLASS__);
  151.         return $this->createToken($passport, $firewallName);
  152.     }
  154.     public function createToken(Passport $passport, string $firewallName): TokenInterface
  155.     {
  156.         /** @var RefreshTokenInterface|null $refreshToken */
  157.         $refreshToken = $passport->getAttribute('refreshToken');
  159.         if (null === $refreshToken) {
  160.             throw new LogicException('Passport does not contain the refresh token.');
  161.         }
  163.         return new PostRefreshTokenAuthenticationToken(
  164.             $passport->getUser(),
  165.             $firewallName,
  166.             $passport->getUser()->getRoles(),
  167.             $refreshToken
  168.         );
  169.     }
  171.     public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
  172.     {
  173.         return $this->successHandler->onAuthenticationSuccess($request, $token);
  174.     }
  176.     public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
  177.     {
  178.         return $this->failureHandler->onAuthenticationFailure($request, $exception);
  179.     }
  181.     public function start(Request $request, AuthenticationException $authException = null): Response
  182.     {
  183.         $event = new RefreshTokenNotFoundEvent(
  184.             new MissingTokenException('JWT Refresh Token not found', 0, $authException),
  185.             new RefreshAuthenticationFailureResponse($authException ? $authException->getMessageKey() : 'Authentication error')
  186.         );
  188.         $this->eventDispatcher->dispatch($event, 'gesdinet.refresh_token_not_found');
  190.         return $event->getResponse();
  191.     }
  192. }