vendor/symfony/security-http/Authentication/AuthenticatorManager.php line 154

  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\Authentication;
  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\Storage\TokenStorageInterface;
  18. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  19. use Symfony\Component\Security\Core\AuthenticationEvents;
  20. use Symfony\Component\Security\Core\Event\AuthenticationSuccessEvent;
  21. use Symfony\Component\Security\Core\Exception\AccountStatusException;
  22. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  23. use Symfony\Component\Security\Core\Exception\BadCredentialsException;
  24. use Symfony\Component\Security\Core\Exception\CustomUserMessageAccountStatusException;
  25. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  26. use Symfony\Component\Security\Core\User\UserInterface;
  27. use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
  28. use Symfony\Component\Security\Http\Authenticator\Debug\TraceableAuthenticator;
  29. use Symfony\Component\Security\Http\Authenticator\InteractiveAuthenticatorInterface;
  30. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\BadgeInterface;
  31. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
  32. use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
  33. use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
  34. use Symfony\Component\Security\Http\Event\AuthenticationTokenCreatedEvent;
  35. use Symfony\Component\Security\Http\Event\CheckPassportEvent;
  36. use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
  37. use Symfony\Component\Security\Http\Event\LoginFailureEvent;
  38. use Symfony\Component\Security\Http\Event\LoginSuccessEvent;
  39. use Symfony\Component\Security\Http\SecurityEvents;
  40. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  42. /**
  43.  * @author Wouter de Jong <wouter@wouterj.nl>
  44.  * @author Ryan Weaver <ryan@symfonycasts.com>
  45.  * @author Amaury Leroux de Lens <amaury@lerouxdelens.com>
  46.  */
  47. class AuthenticatorManager implements AuthenticatorManagerInterface, UserAuthenticatorInterface
  48. {
  49.     private iterable $authenticators;
  50.     private TokenStorageInterface $tokenStorage;
  51.     private EventDispatcherInterface $eventDispatcher;
  52.     private bool $eraseCredentials;
  53.     private ?LoggerInterface $logger;
  54.     private string $firewallName;
  55.     private bool $hideUserNotFoundExceptions;
  56.     private array $requiredBadges;
  58.     /**
  59.      * @param iterable<mixed, AuthenticatorInterface> $authenticators
  60.      */
  61.     public function __construct(iterable $authenticators, TokenStorageInterface $tokenStorage, EventDispatcherInterface $eventDispatcher, string $firewallName, LoggerInterface $logger = null, bool $eraseCredentials = true, bool $hideUserNotFoundExceptions = true, array $requiredBadges = [])
  62.     {
  63.         $this->authenticators = $authenticators;
  64.         $this->tokenStorage = $tokenStorage;
  65.         $this->eventDispatcher = $eventDispatcher;
  66.         $this->firewallName = $firewallName;
  67.         $this->logger = $logger;
  68.         $this->eraseCredentials = $eraseCredentials;
  69.         $this->hideUserNotFoundExceptions = $hideUserNotFoundExceptions;
  70.         $this->requiredBadges = $requiredBadges;
  71.     }
  73.     /**
  74.      * @param BadgeInterface[] $badges Optionally, pass some Passport badges to use for the manual login
  75.      */
  76.     public function authenticateUser(UserInterface $user, AuthenticatorInterface $authenticator, Request $request, array $badges = []): ?Response
  77.     {
  78.         // create an authentication token for the User
  79.         $passport = new SelfValidatingPassport(new UserBadge($user->getUserIdentifier(), function () use ($user) { return $user; }), $badges);
  80.         $token = $authenticator->createToken($passport, $this->firewallName);
  82.         // announce the authentication token
  83.         $token = $this->eventDispatcher->dispatch(new AuthenticationTokenCreatedEvent($token, $passport))->getAuthenticatedToken();
  85.         // authenticate this in the system
  86.         return $this->handleAuthenticationSuccess($token, $passport, $request, $authenticator, $this->tokenStorage->getToken());
  87.     }
  89.     public function supports(Request $request): ?bool
  90.     {
  91.         if (null !== $this->logger) {
  92.             $context = ['firewall_name' => $this->firewallName];
  94.             if (is_countable($this->authenticators)) {
  95.                 $context['authenticators'] = \count($this->authenticators);
  96.             }
  98.             $this->logger->debug('Checking for authenticator support.', $context);
  99.         }
  101.         $authenticators = [];
  102.         $skippedAuthenticators = [];
  103.         $lazy = true;
  104.         foreach ($this->authenticators as $authenticator) {
  105.             $this->logger?->debug('Checking support on authenticator.', ['firewall_name' => $this->firewallName, 'authenticator' => $authenticator::class]);
  107.             if (false !== $supports = $authenticator->supports($request)) {
  108.                 $authenticators[] = $authenticator;
  109.                 $lazy = $lazy && null === $supports;
  110.             } else {
  111.                 $this->logger?->debug('Authenticator does not support the request.', ['firewall_name' => $this->firewallName, 'authenticator' => $authenticator::class]);
  112.                 $skippedAuthenticators[] = $authenticator;
  113.             }
  114.         }
  116.         if (!$authenticators) {
  117.             return false;
  118.         }
  120.         $request->attributes->set('_security_authenticators', $authenticators);
  121.         $request->attributes->set('_security_skipped_authenticators', $skippedAuthenticators);
  123.         return $lazy ? null : true;
  124.     }
  126.     public function authenticateRequest(Request $request): ?Response
  127.     {
  128.         $authenticators = $request->attributes->get('_security_authenticators');
  129.         $request->attributes->remove('_security_authenticators');
  130.         $request->attributes->remove('_security_skipped_authenticators');
  132.         if (!$authenticators) {
  133.             return null;
  134.         }
  136.         return $this->executeAuthenticators($authenticators, $request);
  137.     }
  139.     /**
  140.      * @param AuthenticatorInterface[] $authenticators
  141.      */
  142.     private function executeAuthenticators(array $authenticators, Request $request): ?Response
  143.     {
  144.         foreach ($authenticators as $authenticator) {
  145.             // recheck if the authenticator still supports the listener. supports() is called
  146.             // eagerly (before token storage is initialized), whereas authenticate() is called
  147.             // lazily (after initialization).
  148.             if (false === $authenticator->supports($request)) {
  149.                 $this->logger?->debug('Skipping the "{authenticator}" authenticator as it did not support the request.', ['authenticator' => \get_class($authenticator instanceof TraceableAuthenticator ? $authenticator->getAuthenticator() : $authenticator)]);
  151.                 continue;
  152.             }
  154.             $response = $this->executeAuthenticator($authenticator, $request);
  155.             if (null !== $response) {
  156.                 $this->logger?->debug('The "{authenticator}" authenticator set the response. Any later authenticator will not be called', ['authenticator' => \get_class($authenticator instanceof TraceableAuthenticator ? $authenticator->getAuthenticator() : $authenticator)]);
  158.                 return $response;
  159.             }
  160.         }
  162.         return null;
  163.     }
  165.     private function executeAuthenticator(AuthenticatorInterface $authenticator, Request $request): ?Response
  166.     {
  167.         $passport = null;
  168.         $previousToken = $this->tokenStorage->getToken();
  170.         try {
  171.             // get the passport from the Authenticator
  172.             $passport = $authenticator->authenticate($request);
  174.             // check the passport (e.g. password checking)
  175.             $event = new CheckPassportEvent($authenticator, $passport);
  176.             $this->eventDispatcher->dispatch($event);
  178.             // check if all badges are resolved
  179.             $resolvedBadges = [];
  180.             foreach ($passport->getBadges() as $badge) {
  181.                 if (!$badge->isResolved()) {
  182.                     throw new BadCredentialsException(sprintf('Authentication failed: Security badge "%s" is not resolved, did you forget to register the correct listeners?', get_debug_type($badge)));
  183.                 }
  185.                 $resolvedBadges[] = $badge::class;
  186.             }
  188.             $missingRequiredBadges = array_diff($this->requiredBadges, $resolvedBadges);
  189.             if ($missingRequiredBadges) {
  190.                 throw new BadCredentialsException(sprintf('Authentication failed; Some badges marked as required by the firewall config are not available on the passport: "%s".', implode('", "', $missingRequiredBadges)));
  191.             }
  193.             // create the authentication token
  194.             $authenticatedToken = $authenticator->createToken($passport, $this->firewallName);
  196.             // announce the authentication token
  197.             $authenticatedToken = $this->eventDispatcher->dispatch(new AuthenticationTokenCreatedEvent($authenticatedToken, $passport))->getAuthenticatedToken();
  199.             if (true === $this->eraseCredentials) {
  200.                 $authenticatedToken->eraseCredentials();
  201.             }
  203.             $this->eventDispatcher->dispatch(new AuthenticationSuccessEvent($authenticatedToken), AuthenticationEvents::AUTHENTICATION_SUCCESS);
  205.             $this->logger?->info('Authenticator successful!', ['token' => $authenticatedToken, 'authenticator' => \get_class($authenticator instanceof TraceableAuthenticator ? $authenticator->getAuthenticator() : $authenticator)]);
  206.         } catch (AuthenticationException $e) {
  207.             // oh no! Authentication failed!
  208.             $response = $this->handleAuthenticationFailure($e, $request, $authenticator, $passport);
  209.             if ($response instanceof Response) {
  210.                 return $response;
  211.             }
  213.             return null;
  214.         }
  216.         // success! (sets the token on the token storage, etc)
  217.         $response = $this->handleAuthenticationSuccess($authenticatedToken, $passport, $request, $authenticator, $previousToken);
  218.         if ($response instanceof Response) {
  219.             return $response;
  220.         }
  222.         $this->logger?->debug('Authenticator set no success response: request continues.', ['authenticator' => \get_class($authenticator instanceof TraceableAuthenticator ? $authenticator->getAuthenticator() : $authenticator)]);
  224.         return null;
  225.     }
  227.     private function handleAuthenticationSuccess(TokenInterface $authenticatedToken, Passport $passport, Request $request, AuthenticatorInterface $authenticator, ?TokenInterface $previousToken): ?Response
  228.     {
  229.         $this->tokenStorage->setToken($authenticatedToken);
  231.         $response = $authenticator->onAuthenticationSuccess($request, $authenticatedToken, $this->firewallName);
  232.         if ($authenticator instanceof InteractiveAuthenticatorInterface && $authenticator->isInteractive()) {
  233.             $loginEvent = new InteractiveLoginEvent($request, $authenticatedToken);
  234.             $this->eventDispatcher->dispatch($loginEvent, SecurityEvents::INTERACTIVE_LOGIN);
  235.         }
  237.         $this->eventDispatcher->dispatch($loginSuccessEvent = new LoginSuccessEvent($authenticator, $passport, $authenticatedToken, $request, $response, $this->firewallName, $previousToken));
  239.         return $loginSuccessEvent->getResponse();
  240.     }
  242.     /**
  243.      * Handles an authentication failure and returns the Response for the authenticator.
  244.      */
  245.     private function handleAuthenticationFailure(AuthenticationException $authenticationException, Request $request, AuthenticatorInterface $authenticator, ?Passport $passport): ?Response
  246.     {
  247.         $this->logger?->info('Authenticator failed.', ['exception' => $authenticationException, 'authenticator' => \get_class($authenticator instanceof TraceableAuthenticator ? $authenticator->getAuthenticator() : $authenticator)]);
  249.         // Avoid leaking error details in case of invalid user (e.g. user not found or invalid account status)
  250.         // to prevent user enumeration via response content comparison
  251.         if ($this->hideUserNotFoundExceptions && ($authenticationException instanceof UserNotFoundException || ($authenticationException instanceof AccountStatusException && !$authenticationException instanceof CustomUserMessageAccountStatusException))) {
  252.             $authenticationException = new BadCredentialsException('Bad credentials.', 0, $authenticationException);
  253.         }
  255.         $response = $authenticator->onAuthenticationFailure($request, $authenticationException);
  256.         if (null !== $response && null !== $this->logger) {
  257.             $this->logger->debug('The "{authenticator}" authenticator set the failure response.', ['authenticator' => \get_class($authenticator instanceof TraceableAuthenticator ? $authenticator->getAuthenticator() : $authenticator)]);
  258.         }
  260.         $this->eventDispatcher->dispatch($loginFailureEvent = new LoginFailureEvent($authenticationException, $authenticator, $request, $response, $this->firewallName, $passport));
  262.         // returning null is ok, it means they want the request to continue
  263.         return $loginFailureEvent->getResponse();
  264.     }
  265. }