Collaboration diagram for ilSetupPasswordManager:

Public Member Functions
	__construct (array $config=[])
	ilSetupPasswordManager constructor. More...

	getEncoderFactory ()

	setEncoderFactory (\ilSetupPasswordEncoderFactory $encoderFactory)

	getEncoderName ()

	setEncoderName (string $encoderName)

	encodePassword (string $raw)
	Encodes the raw password based on the relevant encoding strategy. More...

	verifyPassword (string $encoded, string $raw, callable $passwordReHashCallback)
	Verifies if the passed raw password matches the encoded one, based on the current encoding strategy. More...

Private Attributes
	$encoderName

	$encoderFactory

Detailed Description

Class ilSetupPasswordManager.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Definition at line 8 of file class.ilSetupPasswordManager.php.

Constructor & Destructor Documentation

◆ __construct()

ilSetupPasswordManager::__construct ( array $config = [] )

ilSetupPasswordManager constructor.

Parameters

array $config

Exceptions

Exception

Definition at line 21 of file class.ilSetupPasswordManager.php.

    {
        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)
            ));
        }
    }

References $config, getEncoderFactory(), getEncoderName(), setEncoderFactory(), and setEncoderName().

Here is the call graph for this function:

Member Function Documentation

◆ encodePassword()

ilSetupPasswordManager::encodePassword ( string $raw )

Encodes the raw password based on the relevant encoding strategy.

Parameters

string $raw

Returns: string

Exceptions

ilUserException

Definition at line 87 of file class.ilSetupPasswordManager.php.

                                                : string
    {
        $encoder = $this->getEncoderFactory()->getEncoderByName($this->getEncoderName());
 
        return $encoder->encodePassword($raw, '');
    }

References getEncoderFactory(), and getEncoderName().

Here is the call graph for this function:

◆ getEncoderFactory()

ilSetupPasswordManager::getEncoderFactory ( )

Returns: \ilSetupPasswordEncoderFactory

Definition at line 52 of file class.ilSetupPasswordManager.php.

                                        : \ilSetupPasswordEncoderFactory
    {
        return $this->encoderFactory;
    }

References $encoderFactory.

Referenced by __construct(), encodePassword(), and verifyPassword().

Here is the caller graph for this function:

◆ getEncoderName()

ilSetupPasswordManager::getEncoderName ( )

Returns: string

Definition at line 68 of file class.ilSetupPasswordManager.php.

                                     : string
    {
        return $this->encoderName;
    }

References $encoderName.

Referenced by __construct(), encodePassword(), and verifyPassword().

Here is the caller graph for this function:

◆ setEncoderFactory()

ilSetupPasswordManager::setEncoderFactory ( \ilSetupPasswordEncoderFactory $encoderFactory )

Parameters

\ilSetupPasswordEncoderFactory $encoderFactory

Definition at line 60 of file class.ilSetupPasswordManager.php.

                                                                                      : void
    {
        $this->encoderFactory = $encoderFactory;
    }

References $encoderFactory.

Referenced by __construct().

Here is the caller graph for this function:

◆ setEncoderName()

ilSetupPasswordManager::setEncoderName ( string $encoderName )

Parameters

string $encoderName

Definition at line 76 of file class.ilSetupPasswordManager.php.

                                                        : void
    {
        $this->encoderName = $encoderName;
    }

References $encoderName.

Referenced by __construct().

Here is the caller graph for this function:

◆ verifyPassword()

ilSetupPasswordManager::verifyPassword	(	string	$encoded,
		string	$raw,
		callable	$passwordReHashCallback
	)

Verifies if the passed raw password matches the encoded one, based on the current encoding strategy.

Parameters

string	$encoded
string	$raw
callable	$passwordReHashCallback	A callback passed by consumer, which accepts the raw password and is called if the encoder strategy decides a password has to be re-hashed.

Returns: bool

Exceptions

ilUserException

Definition at line 103 of file class.ilSetupPasswordManager.php.

                                                                                                   : 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;
    }