vendor/symfony/security-core/Authentication/AuthenticationProviderManager.php line 85

Open in your IDE?
  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\Core\Authentication;
  14. use Symfony\Component\EventDispatcher\EventDispatcherInterface;
  15. use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
  16. use Symfony\Component\Security\Core\Authentication\Provider\AuthenticationProviderInterface;
  17. use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
  18. use Symfony\Component\Security\Core\AuthenticationEvents;
  19. use Symfony\Component\Security\Core\Event\AuthenticationFailureEvent;
  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\ProviderNotFoundException;
  25. // Help opcache.preload discover always-needed symbols
  26. class_exists(AuthenticationEvents::class);
  27. class_exists(AuthenticationFailureEvent::class);
  28. class_exists(AuthenticationSuccessEvent::class);
  30. /**
  31.  * AuthenticationProviderManager uses a list of AuthenticationProviderInterface
  32.  * instances to authenticate a Token.
  33.  *
  34.  * @author Fabien Potencier <fabien@symfony.com>
  35.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  36.  */
  37. class AuthenticationProviderManager implements AuthenticationManagerInterface
  38. {
  39.     private $providers;
  40.     private $eraseCredentials;
  41.     private $eventDispatcher;
  43.     /**
  44.      * @param iterable|AuthenticationProviderInterface[] $providers        An iterable with AuthenticationProviderInterface instances as values
  45.      * @param bool                                       $eraseCredentials Whether to erase credentials after authentication or not
  46.      *
  47.      * @throws \InvalidArgumentException
  48.      */
  49.     public function __construct(iterable $providers, bool $eraseCredentials = true)
  50.     {
  51.         if (!$providers) {
  52.             throw new \InvalidArgumentException('You must at least add one authentication provider.');
  53.         }
  55.         $this->providers = $providers;
  56.         $this->eraseCredentials = $eraseCredentials;
  57.     }
  59.     /**
  60.      * @final since Symfony 4.3, the type-hint will be updated to the interface from symfony/contracts in 5.0
  61.      */
  62.     public function setEventDispatcher(EventDispatcherInterface $dispatcher)
  63.     {
  64.         $this->eventDispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
  65.     }
  67.     /**
  68.      * {@inheritdoc}
  69.      */
  70.     public function authenticate(TokenInterface $token)
  71.     {
  72.         $lastException = null;
  73.         $result = null;
  75.         foreach ($this->providers as $provider) {
  76.             if (!$provider instanceof AuthenticationProviderInterface) {
  77.                 throw new \InvalidArgumentException(sprintf('Provider "%s" must implement the AuthenticationProviderInterface.', \get_class($provider)));
  78.             }
  80.             if (!$provider->supports($token)) {
  81.                 continue;
  82.             }
  84.             try {
  85.                 $result = $provider->authenticate($token);
  87.                 if (null !== $result) {
  88.                     break;
  89.                 }
  90.             } catch (AccountStatusException $e) {
  91.                 $lastException = $e;
  93.                 break;
  94.             } catch (AuthenticationException $e) {
  95.                 $lastException = $e;
  96.             }
  97.         }
  99.         if (null !== $result) {
  100.             if (true === $this->eraseCredentials) {
  101.                 $result->eraseCredentials();
  102.             }
  104.             if (null !== $this->eventDispatcher) {
  105.                 $this->eventDispatcher->dispatch(new AuthenticationSuccessEvent($result), AuthenticationEvents::AUTHENTICATION_SUCCESS);
  106.             }
  108.             return $result;
  109.         }
  111.         if (null === $lastException) {
  112.             $lastException = new ProviderNotFoundException(sprintf('No Authentication Provider found for token of class "%s".', \get_class($token)));
  113.         }
  115.         if (null !== $this->eventDispatcher) {
  116.             $this->eventDispatcher->dispatch(new AuthenticationFailureEvent($token, $lastException), AuthenticationEvents::AUTHENTICATION_FAILURE);
  117.         }
  119.         $lastException->setToken($token);
  121.         throw $lastException;
  122.     }
  123. }