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

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