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

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. /**
  26.  * AuthenticationProviderManager uses a list of AuthenticationProviderInterface
  27.  * instances to authenticate a Token.
  28.  *
  29.  * @author Fabien Potencier <fabien@symfony.com>
  30.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  31.  */
  32. class AuthenticationProviderManager implements AuthenticationManagerInterface
  33. {
  34.     private $providers;
  35.     private $eraseCredentials;
  36.     private $eventDispatcher;
  38.     /**
  39.      * @param iterable|AuthenticationProviderInterface[] $providers        An iterable with AuthenticationProviderInterface instances as values
  40.      * @param bool                                       $eraseCredentials Whether to erase credentials after authentication or not
  41.      *
  42.      * @throws \InvalidArgumentException
  43.      */
  44.     public function __construct(iterable $providers, bool $eraseCredentials = true)
  45.     {
  46.         if (!$providers) {
  47.             throw new \InvalidArgumentException('You must at least add one authentication provider.');
  48.         }
  50.         $this->providers = $providers;
  51.         $this->eraseCredentials = $eraseCredentials;
  52.     }
  54.     /**
  55.      * @final since Symfony 4.3, the type-hint will be updated to the interface from symfony/contracts in 5.0
  56.      */
  57.     public function setEventDispatcher(EventDispatcherInterface $dispatcher)
  58.     {
  59.         $this->eventDispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function authenticate(TokenInterface $token)
  66.     {
  67.         $lastException = null;
  68.         $result = null;
  70.         foreach ($this->providers as $provider) {
  71.             if (!$provider instanceof AuthenticationProviderInterface) {
  72.                 throw new \InvalidArgumentException(sprintf('Provider "%s" must implement the AuthenticationProviderInterface.', \get_class($provider)));
  73.             }
  75.             if (!$provider->supports($token)) {
  76.                 continue;
  77.             }
  79.             try {
  80.                 $result = $provider->authenticate($token);
  82.                 if (null !== $result) {
  83.                     break;
  84.                 }
  85.             } catch (AccountStatusException $e) {
  86.                 $lastException = $e;
  88.                 break;
  89.             } catch (AuthenticationException $e) {
  90.                 $lastException = $e;
  91.             }
  92.         }
  94.         if (null !== $result) {
  95.             if (true === $this->eraseCredentials) {
  96.                 $result->eraseCredentials();
  97.             }
  99.             if (null !== $this->eventDispatcher) {
  100.                 $this->eventDispatcher->dispatch(new AuthenticationSuccessEvent($result), AuthenticationEvents::AUTHENTICATION_SUCCESS);
  101.             }
  103.             return $result;
  104.         }
  106.         if (null === $lastException) {
  107.             $lastException = new ProviderNotFoundException(sprintf('No Authentication Provider found for token of class "%s".', \get_class($token)));
  108.         }
  110.         if (null !== $this->eventDispatcher) {
  111.             $this->eventDispatcher->dispatch(new AuthenticationFailureEvent($token, $lastException), AuthenticationEvents::AUTHENTICATION_FAILURE);
  112.         }
  114.         $lastException->setToken($token);
  116.         throw $lastException;
  117.     }
  118. }