class.ilUserPasswordEncoderFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilUserPasswordEncoderFactory
{
    protected ?string $defaultEncoder = null;
    protected array $encoders = [];

    public function __construct(array $config = []) // Missing array type.
    {
        if (!empty($config)) {
            foreach ($config as $key => $value) {
                switch (strtolower($key)) {
                    case 'default_password_encoder':
                        $this->setDefaultEncoder($value);
                        break;
                }
            }
        }

        $this->initEncoders($config);
    }

    protected function getValidEncoders(array $config): array // Missing array type.
    {
        return [
            new ilBcryptPhpPasswordEncoder($config),
            new ilBcryptPasswordEncoder($config),
            new ilMd5PasswordEncoder(),
        ];
    }

    protected function initEncoders(array $config): void // Missing array type.
    {
        $this->encoders = [];

        $encoders = $this->getValidEncoders($config);
        foreach ($encoders as $encoder) {
            if ($encoder->isSupportedByRuntime()) {
                $this->encoders[$encoder->getName()] = $encoder;
            }
        }
    }

    public function getDefaultEncoder(): ?string
    {
        return $this->defaultEncoder;
    }

    public function setDefaultEncoder(string $defaultEncoder): void
    {
        $this->defaultEncoder = $defaultEncoder;
    }

    public function getEncoders(): array
    {
        return $this->encoders;
    }

    public function setEncoders(array $encoders): void
    {
        $this->encoders = [];
        foreach ($encoders as $encoder) {
            if (!($encoder instanceof ilPasswordEncoder)) {
                throw new ilUserException(sprintf(
                    'One of the passed encoders is not valid: %s.',
                    json_encode($encoder, JSON_THROW_ON_ERROR)
                ));
            }
            $this->encoders[$encoder->getName()] = $encoder;
        }
    }

    public function getSupportedEncoderNames(): array
    {
        return array_keys($this->getEncoders());
    }

    public function getEncoderByName(?string $name, bool $get_default_on_mismatch = false): ilPasswordEncoder
    {
        if ($name !== null && isset($this->encoders[$name])) {
            return $this->encoders[$name];
        }

        if (!$get_default_on_mismatch) {
            throw new ilUserException(sprintf('The encoder "%s" was not configured.', $name));
        } elseif (!$this->getDefaultEncoder()) {
            throw new ilUserException('No default encoder specified, fallback not possible.');
        } elseif (!isset($this->encoders[$this->getDefaultEncoder()])) {
            throw new ilUserException("No default encoder found for name: '{$this->getDefaultEncoder()}'.");
        }

        return $this->encoders[$this->getDefaultEncoder()];
    }

    public function getFirstEncoderForEncodedPasswordAndMatchers(string $encoded, array $matchers): ilPasswordEncoder
    {
        foreach ($this->getEncoders() as $encoder) {
            foreach ($matchers as $encoderName => $callback) {
                if (
                    is_callable($callback) &&
                    $encoder->getName() === $encoderName &&
                    $callback($encoded) === true
                ) {
                    return $encoder;
                }
            }
        }

        return $this->getEncoderByName($this->getDefaultEncoder());
    }
}