Collaboration diagram for ILIAS\Data\Password\LocalUserPasswordManager:

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

	setSettings (?ilSetting $settings)

	setDb (ilDBInterface $db)

	getEncoderName ()

	setEncoderName (string $encoderName)

	getEncoderFactory ()

	setEncoderFactory (LocalUserPasswordEncoderFactory $encoderFactory)

	encodePassword (ilObjUser $user, string $raw)

	isEncodingTypeSupported (string $name)

	verifyPassword (ilObjUser $user, string $raw)

	resetLastPasswordChangeForLocalUsers ()

	allowPasswordChange (ilObjUser $user)

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

Private Attributes
const	MIN_SALT_SIZE = 16

LocalUserPasswordEncoderFactory	$encoderFactory = null

ilSetting	$settings = null

ilDBInterface	$db = null

string	$encoderName = null

Static Private Attributes
static self	$instance = null

Detailed Description

Definition at line 33 of file class.LocalUserPasswordManager.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\Data\Password\LocalUserPasswordManager::__construct ( array $config = [] )

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

Parameters

array<string,mixed> $config

Exceptions

ilUserException

Definition at line 49 of file class.LocalUserPasswordManager.php.

References ILIAS\Data\Password\LocalUserPasswordManager\getEncoderFactory(), ILIAS\Data\Password\LocalUserPasswordManager\getEncoderName(), ILIAS\Data\Password\LocalUserPasswordManager\setDb(), ILIAS\Data\Password\LocalUserPasswordManager\setEncoderFactory(), ILIAS\Data\Password\LocalUserPasswordManager\setEncoderName(), and ILIAS\Data\Password\LocalUserPasswordManager\setSettings().

     {
         if (!empty($config)) {
             foreach ($config as $key => $value) {
                 switch (strtolower($key)) {
                     case 'settings':
                         $this->setSettings($value);
 
                         break;
                     case 'db':
                         $this->setDb($value);
 
                         break;
                     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.',
                 print_r($config, true)
             ));
         }
 
         if (!$this->getEncoderFactory() instanceof LocalUserPasswordEncoderFactory) {
             throw new ilUserException(sprintf(
                 '"encoder_factory" must be instance of LocalUserPasswordEncoderFactory and set in %s.',
                 print_r($config, true)
             ));
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ allowPasswordChange()

ILIAS\Data\Password\LocalUserPasswordManager::allowPasswordChange ( ilObjUser $user )

Definition at line 221 of file class.LocalUserPasswordManager.php.

References ilSession\get(), ilObjUser\getAuthMode(), ilObjUser\isPasswordChangeDemanded(), ilObjUser\isPasswordExpired(), and ilAuthUtils\isPasswordModificationEnabled().

                                                         : bool
     {
         if (ilSession::get('used_external_auth_mode')) {
             return false;
         }
 
         $status = ilAuthUtils::isPasswordModificationEnabled($user->getAuthMode(true));
         if ($status) {
             return true;
         }
 
         return ilAuthUtils::isPasswordModificationHidden()
             && ($user->isPasswordChangeDemanded() || $user->isPasswordExpired());
     }

Here is the call graph for this function:

◆ encodePassword()

ILIAS\Data\Password\LocalUserPasswordManager::encodePassword	(	ilObjUser	$user,
		string	$raw
	)

Definition at line 156 of file class.LocalUserPasswordManager.php.

References ilPasswordUtils\getBytes(), ILIAS\Data\Password\LocalUserPasswordManager\getEncoderFactory(), ILIAS\Data\Password\LocalUserPasswordManager\getEncoderName(), ilObjUser\getPasswordSalt(), null, ilObjUser\PASSWD_CRYPTED, ilObjUser\setPasswd(), ilObjUser\setPasswordEncodingType(), and ilObjUser\setPasswordSalt().

                                                                 : void
     {
         $encoder = $this->getEncoderFactory()->getEncoderByName($this->getEncoderName());
         $user->setPasswordEncodingType($encoder->getName());
         if ($encoder->requiresSalt()) {
             $user->setPasswordSalt(
                 substr(
                     str_replace(
                         '+',
                         '.',
                         base64_encode(ilPasswordUtils::getBytes(self::MIN_SALT_SIZE))
                     ),
                     0,
                     22
                 )
             );
         } else {
             $user->setPasswordSalt(null);
         }
         $user->setPasswd(
             $encoder->encodePassword($raw, (string) $user->getPasswordSalt()),
             ilObjUser::PASSWD_CRYPTED
         );
     }

Here is the call graph for this function:

◆ getEncoderFactory()

ILIAS\Data\Password\LocalUserPasswordManager::getEncoderFactory ( )

Definition at line 146 of file class.LocalUserPasswordManager.php.

References ILIAS\Data\Password\LocalUserPasswordManager\$encoderFactory.

Referenced by ILIAS\Data\Password\LocalUserPasswordManager\__construct(), ILIAS\Data\Password\LocalUserPasswordManager\encodePassword(), ILIAS\Data\Password\LocalUserPasswordManager\isEncodingTypeSupported(), and ILIAS\Data\Password\LocalUserPasswordManager\verifyPassword().

                                        : ?LocalUserPasswordEncoderFactory
     {
         return $this->encoderFactory;
     }

Here is the caller graph for this function:

◆ getEncoderName()

ILIAS\Data\Password\LocalUserPasswordManager::getEncoderName ( )

Definition at line 136 of file class.LocalUserPasswordManager.php.

References ILIAS\Data\Password\LocalUserPasswordManager\$encoderName.

Referenced by ILIAS\Data\Password\LocalUserPasswordManager\__construct(), ILIAS\Data\Password\LocalUserPasswordManager\encodePassword(), and ILIAS\Data\Password\LocalUserPasswordManager\verifyPassword().

                                     : ?string
     {
         return $this->encoderName;
     }

Here is the caller graph for this function:

◆ getInstance()

static ILIAS\Data\Password\LocalUserPasswordManager::getInstance ( )

static

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

Exceptions

ilUserException
ilPasswordException

Definition at line 94 of file class.LocalUserPasswordManager.php.

References $DIC, ilFileUtils\getDataDir(), and null.

                                         : self
     {
         global $DIC;
 
         if (self::$instance instanceof self) {
             return self::$instance;
         }
 
         $password_manager = new LocalUserPasswordManager(
             [
                 'encoder_factory' => new LocalUserPasswordEncoderFactory(
                     [
                         // bcrypt (native PHP impl.) is still the default for the factory
                         'default_password_encoder' => 'bcryptphp',
                         // Recommended: https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#argon2id
                         'memory_cost' => 19_456,
                         'ignore_security_flaw' => true,
                         'data_directory' => ilFileUtils::getDataDir()
                     ]
                 ),
                 // https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#argon2id
                 'password_encoder' => 'argon2id',
                 'settings' => $DIC->isDependencyAvailable('settings') ? $DIC->settings() : null,
                 'db' => $DIC->database(),
             ]
         );
 
         self::$instance = $password_manager;
 
         return self::$instance;
     }

Here is the call graph for this function:

◆ isEncodingTypeSupported()

ILIAS\Data\Password\LocalUserPasswordManager::isEncodingTypeSupported ( string $name )

Definition at line 181 of file class.LocalUserPasswordManager.php.

References ILIAS\Data\Password\LocalUserPasswordManager\getEncoderFactory().

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

Here is the call graph for this function:

◆ resetLastPasswordChangeForLocalUsers()

ILIAS\Data\Password\LocalUserPasswordManager::resetLastPasswordChangeForLocalUsers ( )

Definition at line 206 of file class.LocalUserPasswordManager.php.

References ilAuthUtils\AUTH_LOCAL, and ILIAS\Repository\settings().

                                                           : void
     {
         $defaultAuthMode = $this->settings->get('auth_mode');
         $defaultAuthModeCondition = '';
         if ((int) $defaultAuthMode === ilAuthUtils::AUTH_LOCAL) {
             $defaultAuthModeCondition = ' OR auth_mode = ' . $this->db->quote('default', 'text');
         }
 
         $this->db->manipulateF(
             "UPDATE usr_data SET passwd_policy_reset = %s WHERE (auth_mode = %s $defaultAuthModeCondition)",
             ['integer', 'text'],
             [1, 'local']
         );
     }

Here is the call graph for this function:

◆ setDb()

ILIAS\Data\Password\LocalUserPasswordManager::setDb ( ilDBInterface $db )

Definition at line 131 of file class.LocalUserPasswordManager.php.

References ILIAS\Data\Password\LocalUserPasswordManager\$db.

Referenced by ILIAS\Data\Password\LocalUserPasswordManager\__construct().

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

Here is the caller graph for this function:

◆ setEncoderFactory()

ILIAS\Data\Password\LocalUserPasswordManager::setEncoderFactory ( LocalUserPasswordEncoderFactory $encoderFactory )

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

References ILIAS\Data\Password\LocalUserPasswordManager\$encoderFactory.

Referenced by ILIAS\Data\Password\LocalUserPasswordManager\__construct().

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

Here is the caller graph for this function:

◆ setEncoderName()

ILIAS\Data\Password\LocalUserPasswordManager::setEncoderName ( string $encoderName )

Definition at line 141 of file class.LocalUserPasswordManager.php.

References ILIAS\Data\Password\LocalUserPasswordManager\$encoderName.

Referenced by ILIAS\Data\Password\LocalUserPasswordManager\__construct().

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

Here is the caller graph for this function:

◆ setSettings()

ILIAS\Data\Password\LocalUserPasswordManager::setSettings ( ?ilSetting $settings )

Definition at line 126 of file class.LocalUserPasswordManager.php.

References ILIAS\Data\Password\LocalUserPasswordManager\$settings, and ILIAS\Repository\settings().

Referenced by ILIAS\Data\Password\LocalUserPasswordManager\__construct().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ verifyPassword()

ILIAS\Data\Password\LocalUserPasswordManager::verifyPassword	(	ilObjUser	$user,
		string	$raw
	)

Definition at line 186 of file class.LocalUserPasswordManager.php.

References ILIAS\Data\Password\LocalUserPasswordManager\getEncoderFactory(), ILIAS\Data\Password\LocalUserPasswordManager\getEncoderName(), ilObjUser\getPasswd(), ilObjUser\getPasswordEncodingType(), ilObjUser\getPasswordSalt(), and ilObjUser\resetPassword().

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