vendor/symfony/security-http/Authenticator/Passport/Passport.php line 28

  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;
  14. use Symfony\Component\Security\Core\User\UserInterface;
  15. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\BadgeInterface;
  16. use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
  17. use Symfony\Component\Security\Http\Authenticator\Passport\Credentials\CredentialsInterface;
  19. /**
  20.  * A Passport contains all security-related information that needs to be
  21.  * validated during authentication.
  22.  *
  23.  * A passport badge can be used to add any additional information to the
  24.  * passport.
  25.  *
  26.  * @author Wouter de Jong <wouter@wouterj.nl>
  27.  */
  28. class Passport
  29. {
  30.     protected $user;
  32.     private array $badges = [];
  33.     private array $attributes = [];
  35.     /**
  36.      * @param CredentialsInterface $credentials the credentials to check for this authentication, use
  37.      *                                          SelfValidatingPassport if no credentials should be checked
  38.      * @param BadgeInterface[]     $badges
  39.      */
  40.     public function __construct(UserBadge $userBadge, CredentialsInterface $credentials, array $badges = [])
  41.     {
  42.         $this->addBadge($userBadge);
  43.         $this->addBadge($credentials);
  44.         foreach ($badges as $badge) {
  45.             $this->addBadge($badge);
  46.         }
  47.     }
  49.     public function getUser(): UserInterface
  50.     {
  51.         if (null === $this->user) {
  52.             if (!$this->hasBadge(UserBadge::class)) {
  53.                 throw new \LogicException('Cannot get the Security user, no username or UserBadge configured for this passport.');
  54.             }
  56.             $this->user = $this->getBadge(UserBadge::class)->getUser();
  57.         }
  59.         return $this->user;
  60.     }
  62.     /**
  63.      * Adds a new security badge.
  64.      *
  65.      * A passport can hold only one instance of the same security badge.
  66.      * This method replaces the current badge if it is already set on this
  67.      * passport.
  68.      *
  69.      * @return $this
  70.      */
  71.     public function addBadge(BadgeInterface $badge): static
  72.     {
  73.         $this->badges[$badge::class] = $badge;
  75.         return $this;
  76.     }
  78.     public function hasBadge(string $badgeFqcn): bool
  79.     {
  80.         return isset($this->badges[$badgeFqcn]);
  81.     }
  83.     /**
  84.      * @template TBadge of BadgeInterface
  85.      *
  86.      * @param class-string<TBadge> $badgeFqcn
  87.      *
  88.      * @return TBadge|null
  89.      */
  90.     public function getBadge(string $badgeFqcn): ?BadgeInterface
  91.     {
  92.         return $this->badges[$badgeFqcn] ?? null;
  93.     }
  95.     /**
  96.      * @return array<class-string<BadgeInterface>, BadgeInterface>
  97.      */
  98.     public function getBadges(): array
  99.     {
  100.         return $this->badges;
  101.     }
  103.     public function setAttribute(string $name, mixed $value): void
  104.     {
  105.         $this->attributes[$name] = $value;
  106.     }
  108.     public function getAttribute(string $name, mixed $default = null): mixed
  109.     {
  110.         return $this->attributes[$name] ?? $default;
  111.     }
  113.     public function getAttributes(): array
  114.     {
  115.         return $this->attributes;
  116.     }
  117. }