vendor/symfony/security-http/LoginLink/LoginLinkHandler.php line 47

  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\LoginLink;
  14. use Symfony\Component\HttpFoundation\Request;
  15. use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
  16. use Symfony\Component\Routing\RequestContext;
  17. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  18. use Symfony\Component\Security\Core\Signature\Exception\ExpiredSignatureException;
  19. use Symfony\Component\Security\Core\Signature\Exception\InvalidSignatureException;
  20. use Symfony\Component\Security\Core\Signature\SignatureHasher;
  21. use Symfony\Component\Security\Core\User\UserInterface;
  22. use Symfony\Component\Security\Core\User\UserProviderInterface;
  23. use Symfony\Component\Security\Http\LoginLink\Exception\ExpiredLoginLinkException;
  24. use Symfony\Component\Security\Http\LoginLink\Exception\InvalidLoginLinkException;
  26. /**
  27.  * @author Ryan Weaver <ryan@symfonycasts.com>
  28.  */
  29. final class LoginLinkHandler implements LoginLinkHandlerInterface
  30. {
  31.     private UrlGeneratorInterface $urlGenerator;
  32.     private UserProviderInterface $userProvider;
  33.     private array $options;
  34.     private SignatureHasher $signatureHasher;
  36.     public function __construct(UrlGeneratorInterface $urlGenerator, UserProviderInterface $userProvider, SignatureHasher $signatureHasher, array $options)
  37.     {
  38.         $this->urlGenerator = $urlGenerator;
  39.         $this->userProvider = $userProvider;
  40.         $this->signatureHasher = $signatureHasher;
  41.         $this->options = array_merge([
  42.             'route_name' => null,
  43.             'lifetime' => 600,
  44.         ], $options);
  45.     }
  47.     public function createLoginLink(UserInterface $user, Request $request = null, int $lifetime = null): LoginLinkDetails
  48.     {
  49.         $expires = time() + ($lifetime ?: $this->options['lifetime']);
  50.         $expiresAt = new \DateTimeImmutable('@'.$expires);
  52.         $parameters = [
  53.             'user' => $user->getUserIdentifier(),
  54.             'expires' => $expires,
  55.             'hash' => $this->signatureHasher->computeSignatureHash($user, $expires),
  56.         ];
  58.         if ($request) {
  59.             $currentRequestContext = $this->urlGenerator->getContext();
  60.             $this->urlGenerator->setContext(
  61.                 (new RequestContext())
  62.                     ->fromRequest($request)
  63.                     ->setParameter('_locale', $request->getLocale())
  64.             );
  65.         }
  67.         try {
  68.             $url = $this->urlGenerator->generate(
  69.                 $this->options['route_name'],
  70.                 $parameters,
  71.                 UrlGeneratorInterface::ABSOLUTE_URL
  72.             );
  73.         } finally {
  74.             if ($request) {
  75.                 $this->urlGenerator->setContext($currentRequestContext);
  76.             }
  77.         }
  79.         return new LoginLinkDetails($url, $expiresAt);
  80.     }
  82.     public function consumeLoginLink(Request $request): UserInterface
  83.     {
  84.         $userIdentifier = $request->get('user');
  86.         if (!$hash = $request->get('hash')) {
  87.             throw new InvalidLoginLinkException('Missing "hash" parameter.');
  88.         }
  89.         if (!$expires = $request->get('expires')) {
  90.             throw new InvalidLoginLinkException('Missing "expires" parameter.');
  91.         }
  93.         try {
  94.             $this->signatureHasher->acceptSignatureHash($userIdentifier, $expires, $hash);
  96.             $user = $this->userProvider->loadUserByIdentifier($userIdentifier);
  98.             $this->signatureHasher->verifySignatureHash($user, $expires, $hash);
  99.         } catch (UserNotFoundException $e) {
  100.             throw new InvalidLoginLinkException('User not found.', 0, $e);
  101.         } catch (ExpiredSignatureException $e) {
  102.             throw new ExpiredLoginLinkException(ucfirst(str_ireplace('signature', 'login link', $e->getMessage())), 0, $e);
  103.         } catch (InvalidSignatureException $e) {
  104.             throw new InvalidLoginLinkException(ucfirst(str_ireplace('signature', 'login link', $e->getMessage())), 0, $e);
  105.         }
  107.         return $user;
  108.     }
  109. }