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

  1. <?php
  2. /*
  3.  * This file is part of the Symfony package.
  4.  *
  5.  * (c) Fabien Potencier <fabien@symfony.com>
  6.  *
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  */
  10. namespace Symfony\Component\Security\Http\Authentication;
  11. use Psr\Log\LoggerInterface;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\HttpFoundation\Response;
  14. use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
  15. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  16. use Symfony\Component\Security\Core\AuthenticationEvents;
  17. use Symfony\Component\Security\Core\Event\AuthenticationSuccessEvent;
  18. use Symfony\Component\Security\Core\Exception\AccountStatusException;
  19. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  20. use Symfony\Component\Security\Core\Exception\BadCredentialsException;
  21. use Symfony\Component\Security\Core\Exception\CustomUserMessageAccountStatusException;
  22. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  23. use Symfony\Component\Security\Core\User\UserInterface;
  24. use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
  25. use Symfony\Component\Security\Http\Authenticator\Debug\TraceableAuthenticator;
  26. use Symfony\Component\Security\Http\Authenticator\InteractiveAuthenticatorInterface;
  27. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\BadgeInterface;
  28. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
  29. use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
  30. use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
  31. use Symfony\Component\Security\Http\Event\AuthenticationTokenCreatedEvent;
  32. use Symfony\Component\Security\Http\Event\CheckPassportEvent;
  33. use Symfony\Component\Security\Http\Event\InteractiveLoginEvent;
  34. use Symfony\Component\Security\Http\Event\LoginFailureEvent;
  35. use Symfony\Component\Security\Http\Event\LoginSuccessEvent;
  36. use Symfony\Component\Security\Http\SecurityEvents;
  37. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  38. /**
  39.  * @author Wouter de Jong <wouter@wouterj.nl>
  40.  * @author Ryan Weaver <ryan@symfonycasts.com>
  41.  * @author Amaury Leroux de Lens <amaury@lerouxdelens.com>
  42.  */
  43. class AuthenticatorManager implements AuthenticatorManagerInterfaceUserAuthenticatorInterface
  44. {
  45.     private iterable $authenticators;
  46.     private TokenStorageInterface $tokenStorage;
  47.     private EventDispatcherInterface $eventDispatcher;
  48.     private bool $eraseCredentials;
  49.     private ?LoggerInterface $logger;
  50.     private string $firewallName;
  51.     private bool $hideUserNotFoundExceptions;
  52.     private array $requiredBadges;
  53.     /**
  54.      * @param iterable<mixed, AuthenticatorInterface> $authenticators
  55.      */
  56.     public function __construct(iterable $authenticatorsTokenStorageInterface $tokenStorageEventDispatcherInterface $eventDispatcherstring $firewallNameLoggerInterface $logger nullbool $eraseCredentials truebool $hideUserNotFoundExceptions true, array $requiredBadges = [])
  57.     {
  58.         $this->authenticators $authenticators;
  59.         $this->tokenStorage $tokenStorage;
  60.         $this->eventDispatcher $eventDispatcher;
  61.         $this->firewallName $firewallName;
  62.         $this->logger $logger;
  63.         $this->eraseCredentials $eraseCredentials;
  64.         $this->hideUserNotFoundExceptions $hideUserNotFoundExceptions;
  65.         $this->requiredBadges $requiredBadges;
  66.     }
  67.     /**
  68.      * @param BadgeInterface[] $badges Optionally, pass some Passport badges to use for the manual login
  69.      */
  70.     public function authenticateUser(UserInterface $userAuthenticatorInterface $authenticatorRequest $request, array $badges = []): ?Response
  71.     {
  72.         // create an authentication token for the User
  73.         $passport = new SelfValidatingPassport(new UserBadge($user->getUserIdentifier(), function () use ($user) { return $user; }), $badges);
  74.         $token $authenticator->createToken($passport$this->firewallName);
  75.         // announce the authentication token
  76.         $token $this->eventDispatcher->dispatch(new AuthenticationTokenCreatedEvent($token$passport))->getAuthenticatedToken();
  77.         // authenticate this in the system
  78.         return $this->handleAuthenticationSuccess($token$passport$request$authenticator$this->tokenStorage->getToken());
  79.     }
  80.     public function supports(Request $request): ?bool
  81.     {
  82.         if (null !== $this->logger) {
  83.             $context = ['firewall_name' => $this->firewallName];
  84.             if (is_countable($this->authenticators)) {
  85.                 $context['authenticators'] = \count($this->authenticators);
  86.             }
  87.             $this->logger->debug('Checking for authenticator support.'$context);
  88.         }
  89.         $authenticators = [];
  90.         $skippedAuthenticators = [];
  91.         $lazy true;
  92.         foreach ($this->authenticators as $authenticator) {
  93.             $this->logger?->debug('Checking support on authenticator.', ['firewall_name' => $this->firewallName'authenticator' => $authenticator::class]);
  94.             if (false !== $supports $authenticator->supports($request)) {
  95.                 $authenticators[] = $authenticator;
  96.                 $lazy $lazy && null === $supports;
  97.             } else {
  98.                 $this->logger?->debug('Authenticator does not support the request.', ['firewall_name' => $this->firewallName'authenticator' => $authenticator::class]);
  99.                 $skippedAuthenticators[] = $authenticator;
  100.             }
  101.         }
  102.         if (!$authenticators) {
  103.             return false;
  104.         }
  105.         $request->attributes->set('_security_authenticators'$authenticators);
  106.         $request->attributes->set('_security_skipped_authenticators'$skippedAuthenticators);
  107.         return $lazy null true;
  108.     }
  109.     public function authenticateRequest(Request $request): ?Response
  110.     {
  111.         $authenticators $request->attributes->get('_security_authenticators');
  112.         $request->attributes->remove('_security_authenticators');
  113.         $request->attributes->remove('_security_skipped_authenticators');
  114.         if (!$authenticators) {
  115.             return null;
  116.         }
  117.         return $this->executeAuthenticators($authenticators$request);
  118.     }
  119.     /**
  120.      * @param AuthenticatorInterface[] $authenticators
  121.      */
  122.     private function executeAuthenticators(array $authenticatorsRequest $request): ?Response
  123.     {
  124.         foreach ($authenticators as $authenticator) {
  125.             // recheck if the authenticator still supports the listener. supports() is called
  126.             // eagerly (before token storage is initialized), whereas authenticate() is called
  127.             // lazily (after initialization).
  128.             if (false === $authenticator->supports($request)) {
  129.                 $this->logger?->debug('Skipping the "{authenticator}" authenticator as it did not support the request.', ['authenticator' => \get_class($authenticator instanceof TraceableAuthenticator $authenticator->getAuthenticator() : $authenticator)]);
  130.                 continue;
  131.             }
  132.             $response $this->executeAuthenticator($authenticator$request);
  133.             if (null !== $response) {
  134.                 $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)]);
  135.                 return $response;
  136.             }
  137.         }
  138.         return null;
  139.     }
  140.     private function executeAuthenticator(AuthenticatorInterface $authenticatorRequest $request): ?Response
  141.     {
  142.         $passport null;
  143.         $previousToken $this->tokenStorage->getToken();
  144.         try {
  145.             // get the passport from the Authenticator
  146.             $passport $authenticator->authenticate($request);
  147.             // check the passport (e.g. password checking)
  148.             $event = new CheckPassportEvent($authenticator$passport);
  149.             $this->eventDispatcher->dispatch($event);
  150.             // check if all badges are resolved
  151.             $resolvedBadges = [];
  152.             foreach ($passport->getBadges() as $badge) {
  153.                 if (!$badge->isResolved()) {
  154.                     throw new BadCredentialsException(sprintf('Authentication failed: Security badge "%s" is not resolved, did you forget to register the correct listeners?'get_debug_type($badge)));
  155.                 }
  156.                 $resolvedBadges[] = $badge::class;
  157.             }
  158.             $missingRequiredBadges array_diff($this->requiredBadges$resolvedBadges);
  159.             if ($missingRequiredBadges) {
  160.                 throw new BadCredentialsException(sprintf('Authentication failed; Some badges marked as required by the firewall config are not available on the passport: "%s".'implode('", "'$missingRequiredBadges)));
  161.             }
  162.             // create the authentication token
  163.             $authenticatedToken $authenticator->createToken($passport$this->firewallName);
  164.             // announce the authentication token
  165.             $authenticatedToken $this->eventDispatcher->dispatch(new AuthenticationTokenCreatedEvent($authenticatedToken$passport))->getAuthenticatedToken();
  166.             if (true === $this->eraseCredentials) {
  167.                 $authenticatedToken->eraseCredentials();
  168.             }
  169.             $this->eventDispatcher->dispatch(new AuthenticationSuccessEvent($authenticatedToken), AuthenticationEvents::AUTHENTICATION_SUCCESS);
  170.             $this->logger?->info('Authenticator successful!', ['token' => $authenticatedToken'authenticator' => \get_class($authenticator instanceof TraceableAuthenticator $authenticator->getAuthenticator() : $authenticator)]);
  171.         } catch (AuthenticationException $e) {
  172.             // oh no! Authentication failed!
  173.             $response $this->handleAuthenticationFailure($e$request$authenticator$passport);
  174.             if ($response instanceof Response) {
  175.                 return $response;
  176.             }
  177.             return null;
  178.         }
  179.         // success! (sets the token on the token storage, etc)
  180.         $response $this->handleAuthenticationSuccess($authenticatedToken$passport$request$authenticator$previousToken);
  181.         if ($response instanceof Response) {
  182.             return $response;
  183.         }
  184.         $this->logger?->debug('Authenticator set no success response: request continues.', ['authenticator' => \get_class($authenticator instanceof TraceableAuthenticator $authenticator->getAuthenticator() : $authenticator)]);
  185.         return null;
  186.     }
  187.     private function handleAuthenticationSuccess(TokenInterface $authenticatedTokenPassport $passportRequest $requestAuthenticatorInterface $authenticator, ?TokenInterface $previousToken): ?Response
  188.     {
  189.         $this->tokenStorage->setToken($authenticatedToken);
  190.         $response $authenticator->onAuthenticationSuccess($request$authenticatedToken$this->firewallName);
  191.         if ($authenticator instanceof InteractiveAuthenticatorInterface && $authenticator->isInteractive()) {
  192.             $loginEvent = new InteractiveLoginEvent($request$authenticatedToken);
  193.             $this->eventDispatcher->dispatch($loginEventSecurityEvents::INTERACTIVE_LOGIN);
  194.         }
  195.         $this->eventDispatcher->dispatch($loginSuccessEvent = new LoginSuccessEvent($authenticator$passport$authenticatedToken$request$response$this->firewallName$previousToken));
  196.         return $loginSuccessEvent->getResponse();
  197.     }
  198.     /**
  199.      * Handles an authentication failure and returns the Response for the authenticator.
  200.      */
  201.     private function handleAuthenticationFailure(AuthenticationException $authenticationExceptionRequest $requestAuthenticatorInterface $authenticator, ?Passport $passport): ?Response
  202.     {
  203.         $this->logger?->info('Authenticator failed.', ['exception' => $authenticationException'authenticator' => \get_class($authenticator instanceof TraceableAuthenticator $authenticator->getAuthenticator() : $authenticator)]);
  204.         // Avoid leaking error details in case of invalid user (e.g. user not found or invalid account status)
  205.         // to prevent user enumeration via response content comparison
  206.         if ($this->hideUserNotFoundExceptions && ($authenticationException instanceof UserNotFoundException || ($authenticationException instanceof AccountStatusException && !$authenticationException instanceof CustomUserMessageAccountStatusException))) {
  207.             $authenticationException = new BadCredentialsException('Bad credentials.'0$authenticationException);
  208.         }
  209.         $response $authenticator->onAuthenticationFailure($request$authenticationException);
  210.         if (null !== $response && null !== $this->logger) {
  211.             $this->logger->debug('The "{authenticator}" authenticator set the failure response.', ['authenticator' => \get_class($authenticator instanceof TraceableAuthenticator $authenticator->getAuthenticator() : $authenticator)]);
  212.         }
  213.         $this->eventDispatcher->dispatch($loginFailureEvent = new LoginFailureEvent($authenticationException$authenticator$request$response$this->firewallName$passport));
  214.         // returning null is ok, it means they want the request to continue
  215.         return $loginFailureEvent->getResponse();
  216.     }
  217. }