vendor/symfony/security-core/Encoder/BCryptPasswordEncoder.php line 14

Open in your IDE?
  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\Core\Encoder;
  14. @trigger_error(sprintf('The "%s" class is deprecated since Symfony 4.3, use "%s" instead.', BCryptPasswordEncoder::class, NativePasswordEncoder::class), E_USER_DEPRECATED);
  16. use Symfony\Component\Security\Core\Exception\BadCredentialsException;
  18. /**
  19.  * @author Elnur Abdurrakhimov <elnur@elnur.pro>
  20.  * @author Terje Bråten <terje@braten.be>
  21.  *
  22.  * @deprecated since Symfony 4.3, use NativePasswordEncoder instead
  23.  */
  24. class BCryptPasswordEncoder extends BasePasswordEncoder implements SelfSaltingEncoderInterface
  25. {
  26.     const MAX_PASSWORD_LENGTH = 72;
  28.     private $cost;
  30.     /**
  31.      * @param int $cost The algorithmic cost that should be used
  32.      *
  33.      * @throws \RuntimeException         When no BCrypt encoder is available
  34.      * @throws \InvalidArgumentException if cost is out of range
  35.      */
  36.     public function __construct(int $cost)
  37.     {
  38.         if ($cost < 4 || $cost > 31) {
  39.             throw new \InvalidArgumentException('Cost must be in the range of 4-31.');
  40.         }
  42.         $this->cost = $cost;
  43.     }
  45.     /**
  46.      * Encodes the raw password.
  47.      *
  48.      * It doesn't work with PHP versions lower than 5.3.7, since
  49.      * the password compat library uses CRYPT_BLOWFISH hash type with
  50.      * the "$2y$" salt prefix (which is not available in the early PHP versions).
  51.      *
  52.      * @see https://github.com/ircmaxell/password_compat/issues/10#issuecomment-11203833
  53.      *
  54.      * It is almost best to **not** pass a salt and let PHP generate one for you.
  55.      *
  56.      * @param string $raw  The password to encode
  57.      * @param string $salt The salt
  58.      *
  59.      * @return string The encoded password
  60.      *
  61.      * @throws BadCredentialsException when the given password is too long
  62.      *
  63.      * @see http://lxr.php.net/xref/PHP_5_5/ext/standard/password.c#111
  64.      */
  65.     public function encodePassword($raw, $salt)
  66.     {
  67.         if ($this->isPasswordTooLong($raw)) {
  68.             throw new BadCredentialsException('Invalid password.');
  69.         }
  71.         $options = ['cost' => $this->cost];
  73.         if ($salt) {
  74.             // Ignore $salt, the auto-generated one is always the best
  75.         }
  77.         return password_hash($raw, PASSWORD_BCRYPT, $options);
  78.     }
  80.     /**
  81.      * {@inheritdoc}
  82.      */
  83.     public function isPasswordValid($encoded, $raw, $salt)
  84.     {
  85.         return !$this->isPasswordTooLong($raw) && password_verify($raw, $encoded);
  86.     }
  87. }