class.ilUserPasswordEncoderFactory.php

Go to the documentation of this file.

<?php declare(strict_types=1);
/* Copyright (c) 1998-2014 ILIAS open source, Extended GPL, see docs/LICENSE */
 
require_once 'Services/User/exceptions/class.ilUserException.php';
 
class ilUserPasswordEncoderFactory
{
    protected $defaultEncoder;
 
    protected $encoders = array();
 
    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);
    }
 
    protected function getValidEncoders($config) : array
    {
        return [
            new ilBcryptPhpPasswordEncoder($config),
            new ilBcryptPasswordEncoder($config),
            new ilMd5PasswordEncoder($config),
        ];
    }
 
    protected function initEncoders(array $config)
    {
        $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)
    {
        $this->defaultEncoder = $defaultEncoder;
    }
 
    public function getEncoders() : array
    {
        return $this->encoders;
    }
 
    public function setEncoders(array $encoders) : void
    {
        $this->encoders = array();
        foreach ($encoders as $encoder) {
            if (!($encoder instanceof ilPasswordEncoder)) {
                throw new ilUserException(sprintf(
                    'One of the passed encoders is not valid: %s.',
                    json_encode($encoder)
                ));
            }
            $this->encoders[$encoder->getName()] = $encoder;
        }
    }
 
    public function getSupportedEncoderNames() : array
    {
        return array_keys($this->getEncoders());
    }
 
    public function getEncoderByName($name, $get_default_on_mismatch = false) : ilPasswordEncoder
    {
        if (!isset($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()];
        }
 
        return $this->encoders[$name];
    }
 
    public function getFirstEncoderForEncodedPasswordAndMatchers(string $encoded, array $matchers) : ilPasswordEncoder
    {
        foreach ($this->getEncoders() as $encoder) {
            foreach ($matchers as $encoderName => $callback) {
                if (
                    $encoder->getName() === $encoderName &&
                    is_callable($callback) && $callback($encoded) === true
                ) {
                    return $encoder;
                }
            }
        }
 
        return $this->getEncoderByName($this->getDefaultEncoder());
    }
}