Collaboration diagram for ilUserPasswordManager:

Public Member Functions
	__construct (array $config=array())
	Please use the singleton method for instance creation The constructor is still public because of the unit tests. More...

	getEncoderName ()

	setEncoderName ($encoder_name)

	getEncoderFactory ()

	setEncoderFactory (ilUserPasswordEncoderFactory $encoder_factory)

	encodePassword (ilObjUser $user, $raw)

	isEncodingTypeSupported ($name)

	verifyPassword (ilObjUser $user, $raw)

Static Public Member Functions
static	getInstance ()
	Single method to reduce footprint (included files, created instances) More...

Data Fields
const	MIN_SALT_SIZE = 16

Protected Attributes
	$encoder_factory

	$encoder_name

	$config = array()

Static Private Attributes
static	$instance

Detailed Description

Definition at line 11 of file class.ilUserPasswordManager.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserPasswordManager::__construct ( array $config = array() )

Please use the singleton method for instance creation The constructor is still public because of the unit tests.

Parameters

array $config

Exceptions

ilUserException

Definition at line 44 of file class.ilUserPasswordManager.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 ilUserException(sprintf('"password_encoder" must be set in %s.', json_encode($config)));
         }
 
         if (!($this->getEncoderFactory() instanceof ilUserPasswordEncoderFactory)) {
             throw new ilUserException(sprintf('"encoder_factory" must be instance of ilUserPasswordEncoderFactory and set in %s.', json_encode($config)));
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ encodePassword()

ilUserPasswordManager::encodePassword	(	ilObjUser	$user,
			$raw
	)

Parameters

ilObjUser	$user
string	$raw	The raw password

Definition at line 132 of file class.ilUserPasswordManager.php.

References ilPasswordUtils\getBytes(), getEncoderFactory(), getEncoderName(), ilObjUser\getPasswordSalt(), IL_PASSWD_CRYPTED, ilObjUser\setPasswd(), ilObjUser\setPasswordEncodingType(), and ilObjUser\setPasswordSalt().

     {
         $encoder = $this->getEncoderFactory()->getEncoderByName($this->getEncoderName());
         $user->setPasswordEncodingType($encoder->getName());
         if ($encoder->requiresSalt()) {
             require_once 'Services/Password/classes/class.ilPasswordUtils.php';
             $user->setPasswordSalt(
                 substr(str_replace('+', '.', base64_encode(ilPasswordUtils::getBytes(self::MIN_SALT_SIZE))), 0, 22)
             );
         } else {
             $user->setPasswordSalt(null);
         }
         $user->setPasswd($encoder->encodePassword($raw, $user->getPasswordSalt()), IL_PASSWD_CRYPTED);
     }

Here is the call graph for this function:

◆ getEncoderFactory()

ilUserPasswordManager::getEncoderFactory ( )

Returns: ilUserPasswordEncoderFactory

Definition at line 115 of file class.ilUserPasswordManager.php.

References $encoder_factory.

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

     {
         return $this->encoder_factory;
     }

Here is the caller graph for this function:

◆ getEncoderName()

ilUserPasswordManager::getEncoderName ( )

Returns: string

Definition at line 99 of file class.ilUserPasswordManager.php.

References $encoder_name.

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

     {
         return $this->encoder_name;
     }

Here is the caller graph for this function:

◆ getInstance()

static ilUserPasswordManager::getInstance ( )

static

Single method to reduce footprint (included files, created instances)

Returns: self

Definition at line 72 of file class.ilUserPasswordManager.php.

References ilUtil\getDataDir().

Referenced by ilObjUser\assignData(), ilPDNewsBlockGUI\changeFeedSettings(), ilObjUser\isPasswordChangeDemanded(), ilSetup\loginAsClient(), ilObjUser\refreshLogin(), ilPersonalSettingsGUI\savePassword(), and ilPDOAuthentication\setAuth().

     {
         if (self::$instance instanceof self) {
             return self::$instance;
         }
 
         require_once 'Services/User/classes/class.ilUserPasswordEncoderFactory.php';
         $password_manager = new ilUserPasswordManager(
             array(
                 'encoder_factory' => new ilUserPasswordEncoderFactory(
                     array(
                         'default_password_encoder' => 'bcryptphp',
                         'ignore_security_flaw' => true,
                         'data_directory' => ilUtil::getDataDir()
                     )
                 ),
                 'password_encoder' => 'bcryptphp'
             )
         );
 
         self::$instance = $password_manager;
         return self::$instance;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isEncodingTypeSupported()

ilUserPasswordManager::isEncodingTypeSupported ( $name )

Parameters

string $name

Returns: bool

Definition at line 151 of file class.ilUserPasswordManager.php.

References $name, and getEncoderFactory().

     {
         return in_array($name, $this->getEncoderFactory()->getSupportedEncoderNames());
     }

Here is the call graph for this function:

◆ setEncoderFactory()

ilUserPasswordManager::setEncoderFactory ( ilUserPasswordEncoderFactory $encoder_factory )

Parameters

ilUserPasswordEncoderFactory $encoder_factory

Definition at line 123 of file class.ilUserPasswordManager.php.

References $encoder_factory.

Referenced by __construct().

     {
         $this->encoder_factory = $encoder_factory;
     }

Here is the caller graph for this function:

◆ setEncoderName()

ilUserPasswordManager::setEncoderName ( $encoder_name )

Parameters

string $encoder_name

Definition at line 107 of file class.ilUserPasswordManager.php.

References $encoder_name.

Referenced by __construct().

     {
         $this->encoder_name = $encoder_name;
     }

Here is the caller graph for this function:

◆ verifyPassword()

ilUserPasswordManager::verifyPassword	(	ilObjUser	$user,
			$raw
	)

Parameters

ilObjUser	$user
string	$raw

Returns: bool

Definition at line 161 of file class.ilUserPasswordManager.php.

References getEncoderFactory(), getEncoderName(), ilObjUser\getPasswd(), ilObjUser\getPasswordEncodingType(), and ilObjUser\getPasswordSalt().

     {
         $encoder = $this->getEncoderFactory()->getEncoderByName($user->getPasswordEncodingType(), true);
         if ($this->getEncoderName() != $encoder->getName()) {
             if ($encoder->isPasswordValid($user->getPasswd(), $raw, $user->getPasswordSalt())) {
                 $user->resetPassword($raw, $raw);
                 return true;
             }
         } elseif ($encoder->isPasswordValid($user->getPasswd(), $raw, $user->getPasswordSalt())) {
             if ($encoder->requiresReencoding($user->getPasswd())) {
                 $user->resetPassword($raw, $raw);
             }
 
             return true;
         }
 
         return false;
     }