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, $migrate=true)

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.

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

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

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 137 of file class.ilUserPasswordManager.php.

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

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

Here is the call graph for this function:

◆ getEncoderFactory()

ilUserPasswordManager::getEncoderFactory ( )

Returns: ilUserPasswordEncoderFactory

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

        {
                return $this->encoder_factory;
        }

References $encoder_factory.

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

Here is the caller graph for this function:

◆ getEncoderName()

ilUserPasswordManager::getEncoderName ( )

Returns: string

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

        {
                return $this->encoder_name;
        }

References $encoder_name.

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

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 77 of file class.ilUserPasswordManager.php.

        {
                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' => 'bcrypt',
                                                'ignore_security_flaw'     => true
                                        )
                                ),
                                'password_encoder' => 'bcrypt'
                        )
                );
 
                self::$instance = $password_manager;
                return self::$instance;
        }

References $instance.

Referenced by ilPDNewsBlockGUI\changeFeedSettings(), ilPurchaseBMFGUI\getCreditCard(), ilPurchaseBMFGUI\getDebitEntry(), ilObjUser\isPasswordChangeDemanded(), ilSetup\loginAsClient(), and ilPersonalSettingsGUI\savePassword().

Here is the caller graph for this function:

◆ isEncodingTypeSupported()

ilUserPasswordManager::isEncodingTypeSupported ( $name )

Parameters

string $name

Returns: bool

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

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

References getEncoderFactory().

Here is the call graph for this function:

◆ setEncoderFactory()

ilUserPasswordManager::setEncoderFactory ( ilUserPasswordEncoderFactory $encoder_factory )

Parameters

ilUserPasswordEncoderFactory $encoder_factory

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

        {
                $this->encoder_factory = $encoder_factory;
        }

References $encoder_factory.

Referenced by __construct().

Here is the caller graph for this function:

◆ setEncoderName()

ilUserPasswordManager::setEncoderName ( $encoder_name )

Parameters

string $encoder_name

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

        {
                $this->encoder_name = $encoder_name;
        }

References $encoder_name.

Referenced by __construct().

Here is the caller graph for this function:

◆ verifyPassword()

ilUserPasswordManager::verifyPassword	(	ilObjUser	$user,
			$raw,
			$migrate = `true`
	)

Parameters

ilObjUser	$user
string	$raw
bool	$migrate

Returns: bool

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

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