vendor/symfony/security-http/Authenticator/Passport/Badge/PasswordUpgradeBadge.php line 26

  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\LogicException;
  15. use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
  17. /**
  18.  * Adds automatic password migration, if enabled and required in the password encoder.
  19.  *
  20.  * @see PasswordUpgraderInterface
  21.  *
  22.  * @author Wouter de Jong <wouter@wouterj.nl>
  23.  *
  24.  * @final
  25.  */
  26. class PasswordUpgradeBadge implements BadgeInterface
  27. {
  28.     private ?string $plaintextPassword = null;
  29.     private ?PasswordUpgraderInterface $passwordUpgrader;
  31.     /**
  32.      * @param string                         $plaintextPassword The presented password, used in the rehash
  33.      * @param PasswordUpgraderInterface|null $passwordUpgrader  The password upgrader, defaults to the UserProvider if null
  34.      */
  35.     public function __construct(#[\SensitiveParameter] string $plaintextPassword, PasswordUpgraderInterface $passwordUpgrader = null)
  36.     {
  37.         $this->plaintextPassword = $plaintextPassword;
  38.         $this->passwordUpgrader = $passwordUpgrader;
  39.     }
  41.     public function getAndErasePlaintextPassword(): string
  42.     {
  43.         $password = $this->plaintextPassword;
  44.         if (null === $password) {
  45.             throw new LogicException('The password is erased as another listener already used this badge.');
  46.         }
  48.         $this->plaintextPassword = null;
  50.         return $password;
  51.     }
  53.     public function getPasswordUpgrader(): ?PasswordUpgraderInterface
  54.     {
  55.         return $this->passwordUpgrader;
  56.     }
  58.     public function isResolved(): bool
  59.     {
  60.         return true;
  61.     }
  62. }