vendor/symfony/security-core/Encoder/EncoderFactory.php line 80

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. /**
  15.  * A generic encoder factory implementation.
  16.  *
  17.  * @author Johannes M. Schmitt <schmittjoh@gmail.com>
  18.  */
  19. class EncoderFactory implements EncoderFactoryInterface
  20. {
  21.     private $encoders;
  23.     public function __construct(array $encoders)
  24.     {
  25.         $this->encoders = $encoders;
  26.     }
  28.     /**
  29.      * {@inheritdoc}
  30.      */
  31.     public function getEncoder($user)
  32.     {
  33.         $encoderKey = null;
  35.         if ($user instanceof EncoderAwareInterface && (null !== $encoderName = $user->getEncoderName())) {
  36.             if (!\array_key_exists($encoderName, $this->encoders)) {
  37.                 throw new \RuntimeException(sprintf('The encoder "%s" was not configured.', $encoderName));
  38.             }
  40.             $encoderKey = $encoderName;
  41.         } else {
  42.             foreach ($this->encoders as $class => $encoder) {
  43.                 if ((\is_object($user) && $user instanceof $class) || (!\is_object($user) && (is_subclass_of($user, $class) || $user == $class))) {
  44.                     $encoderKey = $class;
  45.                     break;
  46.                 }
  47.             }
  48.         }
  50.         if (null === $encoderKey) {
  51.             throw new \RuntimeException(sprintf('No encoder has been configured for account "%s".', \is_object($user) ? \get_class($user) : $user));
  52.         }
  54.         if (!$this->encoders[$encoderKey] instanceof PasswordEncoderInterface) {
  55.             $this->encoders[$encoderKey] = $this->createEncoder($this->encoders[$encoderKey]);
  56.         }
  58.         return $this->encoders[$encoderKey];
  59.     }
  61.     /**
  62.      * Creates the actual encoder instance.
  63.      *
  64.      * @return PasswordEncoderInterface
  65.      *
  66.      * @throws \InvalidArgumentException
  67.      */
  68.     private function createEncoder(array $config)
  69.     {
  70.         if (isset($config['algorithm'])) {
  71.             $config = $this->getEncoderConfigFromAlgorithm($config);
  72.         }
  73.         if (!isset($config['class'])) {
  74.             throw new \InvalidArgumentException(sprintf('"class" must be set in %s.', json_encode($config)));
  75.         }
  76.         if (!isset($config['arguments'])) {
  77.             throw new \InvalidArgumentException(sprintf('"arguments" must be set in %s.', json_encode($config)));
  78.         }
  80.         $reflection = new \ReflectionClass($config['class']);
  82.         return $reflection->newInstanceArgs($config['arguments']);
  83.     }
  85.     private function getEncoderConfigFromAlgorithm($config)
  86.     {
  87.         if ('auto' === $config['algorithm']) {
  88.             $config['algorithm'] = SodiumPasswordEncoder::isSupported() ? 'sodium' : 'native';
  89.         }
  91.         switch ($config['algorithm']) {
  92.             case 'plaintext':
  93.                 return [
  94.                     'class' => PlaintextPasswordEncoder::class,
  95.                     'arguments' => [$config['ignore_case']],
  96.                 ];
  98.             case 'pbkdf2':
  99.                 return [
  100.                     'class' => Pbkdf2PasswordEncoder::class,
  101.                     'arguments' => [
  102.                         $config['hash_algorithm'],
  103.                         $config['encode_as_base64'],
  104.                         $config['iterations'],
  105.                         $config['key_length'],
  106.                     ],
  107.                 ];
  109.             /* @deprecated since Symfony 4.3 */
  110.             case 'bcrypt':
  111.                 return [
  112.                     'class' => BCryptPasswordEncoder::class,
  113.                     'arguments' => [$config['cost']],
  114.                 ];
  116.             case 'native':
  117.                 return [
  118.                     'class' => NativePasswordEncoder::class,
  119.                     'arguments' => [
  120.                         $config['time_cost'] ?? null,
  121.                         (($config['memory_cost'] ?? 0) << 10) ?: null,
  122.                         $config['cost'] ?? null,
  123.                     ],
  124.                 ];
  126.             case 'sodium':
  127.                 return [
  128.                     'class' => SodiumPasswordEncoder::class,
  129.                     'arguments' => [
  130.                         $config['time_cost'] ?? null,
  131.                         (($config['memory_cost'] ?? 0) << 10) ?: null,
  132.                     ],
  133.                 ];
  135.             /* @deprecated since Symfony 4.3 */
  136.             case 'argon2i':
  137.                 return [
  138.                     'class' => Argon2iPasswordEncoder::class,
  139.                     'arguments' => [
  140.                         $config['memory_cost'],
  141.                         $config['time_cost'],
  142.                         $config['threads'],
  143.                     ],
  144.                 ];
  145.         }
  147.         return [
  148.             'class' => MessageDigestPasswordEncoder::class,
  149.             'arguments' => [
  150.                 $config['algorithm'],
  151.                 $config['encode_as_base64'],
  152.                 $config['iterations'],
  153.             ],
  154.         ];
  155.     }
  156. }