vendor/symfony/security-core/Encoder/MigratingPasswordEncoder.php line 16

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <[email protected]>
  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\Encoder;
  14. use Symfony\Component\PasswordHasher\Hasher\MigratingPasswordHasher;
  16. trigger_deprecation('symfony/security-core', '5.3', 'The "%s" class is deprecated, use "%s" instead.', MigratingPasswordEncoder::class, MigratingPasswordHasher::class);
  18. /**
  19.  * Hashes passwords using the best available encoder.
  20.  * Validates them using a chain of encoders.
  21.  *
  22.  * /!\ Don't put a PlaintextPasswordEncoder in the list as that'd mean a leaked hash
  23.  * could be used to authenticate successfully without knowing the cleartext password.
  24.  *
  25.  * @author Nicolas Grekas <[email protected]>
  26.  *
  27.  * @deprecated since Symfony 5.3, use {@link MigratingPasswordHasher} instead
  28.  */
  29. final class MigratingPasswordEncoder extends BasePasswordEncoder implements SelfSaltingEncoderInterface
  30. {
  31.     private $bestEncoder;
  32.     private $extraEncoders;
  34.     public function __construct(PasswordEncoderInterface $bestEncoder, PasswordEncoderInterface ...$extraEncoders)
  35.     {
  36.         $this->bestEncoder = $bestEncoder;
  37.         $this->extraEncoders = $extraEncoders;
  38.     }
  40.     /**
  41.      * {@inheritdoc}
  42.      */
  43.     public function encodePassword(string $raw, ?string $salt): string
  44.     {
  45.         return $this->bestEncoder->encodePassword($raw, $salt);
  46.     }
  48.     /**
  49.      * {@inheritdoc}
  50.      */
  51.     public function isPasswordValid(string $encoded, string $raw, ?string $salt): bool
  52.     {
  53.         if ($this->bestEncoder->isPasswordValid($encoded, $raw, $salt)) {
  54.             return true;
  55.         }
  57.         if (!$this->bestEncoder->needsRehash($encoded)) {
  58.             return false;
  59.         }
  61.         foreach ($this->extraEncoders as $encoder) {
  62.             if ($encoder->isPasswordValid($encoded, $raw, $salt)) {
  63.                 return true;
  64.             }
  65.         }
  67.         return false;
  68.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      */
  73.     public function needsRehash(string $encoded): bool
  74.     {
  75.         return $this->bestEncoder->needsRehash($encoded);
  76.     }
  77. }