class.LocalUserPasswordEncoderFactory.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Authentication\Password;

use ilArgon2idPasswordEncoder;
use ilBcryptPasswordEncoder;
use ilBcryptPhpPasswordEncoder;
use ilMd5PasswordEncoder;
use ilPasswordEncoder;
use ilPasswordException;
use ilUserException;

class LocalUserPasswordEncoderFactory
{
    private ?string $default_encoder = null;

    private array $supported_encoders = [];

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

                        break;
                }
            }
        }

        $this->initEncoders($config);
    }

    private function getEncoders(array $config): array
    {
        return [
            new ilArgon2idPasswordEncoder($config),
            new ilBcryptPhpPasswordEncoder($config),
            new ilBcryptPasswordEncoder($config),
            new ilMd5PasswordEncoder(),
        ];
    }

    private function initEncoders(array $config): void
    {
        $this->supported_encoders = [];

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

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

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

    public function getSupportedEncoders(): array
    {
        return $this->supported_encoders;
    }

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

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

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

        if (!$this->getDefaultEncoder()) {
            throw new ilUserException('No default encoder specified, fallback not possible.');
        }

        if (!isset($this->supported_encoders[$this->getDefaultEncoder()])) {
            throw new ilUserException("No default encoder found for name: '{$this->getDefaultEncoder()}'.");
        }

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