vendor/symfony/security-http/Authenticator/Passport/Badge/UserBadge.php line 29

  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\Authenticator\Passport\Badge;
  14. use Symfony\Component\Security\Core\Exception\AuthenticationException;
  15. use Symfony\Component\Security\Core\Exception\AuthenticationServiceException;
  16. use Symfony\Component\Security\Core\Exception\BadCredentialsException;
  17. use Symfony\Component\Security\Core\Exception\UserNotFoundException;
  18. use Symfony\Component\Security\Core\User\UserInterface;
  19. use Symfony\Component\Security\Http\EventListener\UserProviderListener;
  21. /**
  22.  * Represents the user in the authentication process.
  23.  *
  24.  * It uses an identifier (e.g. email, or username) and
  25.  * "user loader" to load the related User object.
  26.  *
  27.  * @author Wouter de Jong <wouter@wouterj.nl>
  28.  */
  29. class UserBadge implements BadgeInterface
  30. {
  31.     public const MAX_USERNAME_LENGTH = 4096;
  33.     private string $userIdentifier;
  34.     /** @var callable|null */
  35.     private $userLoader;
  36.     private UserInterface $user;
  38.     /**
  39.      * Initializes the user badge.
  40.      *
  41.      * You must provide a $userIdentifier. This is a unique string representing the
  42.      * user for this authentication (e.g. the email if authentication is done using
  43.      * email + password; or a string combining email+company if authentication is done
  44.      * based on email *and* company name). This string can be used for e.g. login throttling.
  45.      *
  46.      * Optionally, you may pass a user loader. This callable receives the $userIdentifier
  47.      * as argument and must return a UserInterface object (otherwise an AuthenticationServiceException
  48.      * is thrown). If this is not set, the default user provider will be used with
  49.      * $userIdentifier as username.
  50.      */
  51.     public function __construct(string $userIdentifier, callable $userLoader = null)
  52.     {
  53.         if (\strlen($userIdentifier) > self::MAX_USERNAME_LENGTH) {
  54.             throw new BadCredentialsException('Username too long.');
  55.         }
  57.         $this->userIdentifier = $userIdentifier;
  58.         $this->userLoader = $userLoader;
  59.     }
  61.     public function getUserIdentifier(): string
  62.     {
  63.         return $this->userIdentifier;
  64.     }
  66.     /**
  67.      * @throws AuthenticationException when the user cannot be found
  68.      */
  69.     public function getUser(): UserInterface
  70.     {
  71.         if (isset($this->user)) {
  72.             return $this->user;
  73.         }
  75.         if (null === $this->userLoader) {
  76.             throw new \LogicException(sprintf('No user loader is configured, did you forget to register the "%s" listener?', UserProviderListener::class));
  77.         }
  79.         $user = ($this->userLoader)($this->userIdentifier);
  81.         // No user has been found via the $this->userLoader callback
  82.         if (null === $user) {
  83.             $exception = new UserNotFoundException();
  84.             $exception->setUserIdentifier($this->userIdentifier);
  86.             throw $exception;
  87.         }
  89.         if (!$user instanceof UserInterface) {
  90.             throw new AuthenticationServiceException(sprintf('The user provider must return a UserInterface object, "%s" given.', get_debug_type($user)));
  91.         }
  93.         return $this->user = $user;
  94.     }
  96.     public function getUserLoader(): ?callable
  97.     {
  98.         return $this->userLoader;
  99.     }
  101.     public function setUserLoader(callable $userLoader): void
  102.     {
  103.         $this->userLoader = $userLoader;
  104.     }
  106.     public function isResolved(): bool
  107.     {
  108.         return true;
  109.     }
  110. }