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 25 of file class.ilSetupPasswordManager.php.

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

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

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

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

References getEncoderFactory(), and getEncoderName().

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

Here is the call graph for this function:

◆ getEncoderFactory()

ilSetupPasswordManager::getEncoderFactory ( )

Returns

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

References $encoderFactory.

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

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

Here is the caller graph for this function:

◆ getEncoderName()

ilSetupPasswordManager::getEncoderName ( )

Returns: string

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

References $encoderName.

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

                                      : string
     {
         return $this->encoderName;
     }

Here is the caller graph for this function:

◆ setEncoderFactory()

ilSetupPasswordManager::setEncoderFactory ( \ilSetupPasswordEncoderFactory $encoderFactory )

Parameters

\ilSetupPasswordEncoderFactory $encoderFactory

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

References $encoderFactory.

Referenced by __construct().

     {
         $this->encoderFactory = $encoderFactory;
     }

Here is the caller graph for this function:

◆ setEncoderName()

ilSetupPasswordManager::setEncoderName ( string $encoderName )

Parameters

string $encoderName

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

References $encoderName.

Referenced by __construct().

     {
         $this->encoderName = $encoderName;
     }

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

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

References getEncoderFactory(), and getEncoderName().

                                                                                                    : 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;
             }
         } elseif ($currentEncoder->isPasswordValid($encoded, $raw, '')) {
             if ($currentEncoder->requiresReencoding($encoded)) {
                 $passwordReHashCallback($raw);
             }
 
             return true;
         }
 
         return false;
     }