class.ilSetupPasswordManager.php

Go to the documentation of this file.

<?php declare(strict_types=1);
/* Copyright (c) 1998-2018 ILIAS open source, Extended GPL, see docs/LICENSE */
 
class ilSetupPasswordManager
{
    private $encoderName;
 
    private $encoderFactory;
 
    public function __construct(array $config = [])
    {
        if (!empty($config)) {
            foreach ($config as $key => $value) {
                switch (strtolower($key)) {
                    case 'password_encoder':
                        $this->setEncoderName($value);
                        break;
 
                    case 'encoder_factory':
                        $this->setEncoderFactory($value);
                        break;
                }
            }
        }
 
        if (!$this->getEncoderName()) {
            throw new \Exception(sprintf('"password_encoder" must be set in %s.', json_encode($config)));
        }
 
        if (!($this->getEncoderFactory() instanceof \ilSetupPasswordEncoderFactory)) {
            throw new \ilUserException(sprintf(
                '"encoder_factory" must be instance of \ilSetupPasswordEncoderFactory and set in %s.',
                json_encode($config)
            ));
        }
    }
 
    public function getEncoderFactory() : \ilSetupPasswordEncoderFactory
    {
        return $this->encoderFactory;
    }
 
    public function setEncoderFactory(\ilSetupPasswordEncoderFactory $encoderFactory) : void
    {
        $this->encoderFactory = $encoderFactory;
    }
 
    public function getEncoderName() : string
    {
        return $this->encoderName;
    }
 
    public function setEncoderName(string $encoderName) : void
    {
        $this->encoderName = $encoderName;
    }
 
    public function encodePassword(string $raw) : string
    {
        $encoder = $this->getEncoderFactory()->getEncoderByName($this->getEncoderName());
 
        return $encoder->encodePassword($raw, '');
    }
 
    public function verifyPassword(string $encoded, string $raw, callable $passwordReHashCallback) : bool
    {
        $currentEncoder = $this->getEncoderFactory()->getFirstEncoderForEncodedPasswordAndMatchers(
            $encoded,
            [
                'md5' => function ($encoded) {
                    return is_string($encoded) && strlen($encoded) === 32;
                },
                'bcryptphp' => function ($encoded) {
                    return is_string($encoded) && substr($encoded, 0, 4) === '$2y$' && strlen($encoded) === 60;
                }
            ]
        );
 
        if ($this->getEncoderName() != $currentEncoder->getName()) {
            if ($currentEncoder->isPasswordValid($encoded, $raw, '')) {
                $passwordReHashCallback($raw);
 
                return true;
            }
        } else {
            if ($currentEncoder->isPasswordValid($encoded, $raw, '')) {
                if ($currentEncoder->requiresReencoding($encoded)) {
                    $passwordReHashCallback($raw);
                }
 
                return true;
            }
        }
 
        return false;
    }
}