Inheritance diagram for ilArgon2idPasswordEncoder:

Collaboration diagram for ilArgon2idPasswordEncoder:

Public Member Functions
	__construct (array $config=[])

	getMemoryCost ()

	setMemoryCost (int $memory_costs)

	getTimeCost ()

	setTimeCost (int $time_cost)

	getThreads ()

	setThreads (int $threads)

	getName ()
	Returns a unique name/id of the concrete password encoder. More...

	isSupportedByRuntime ()
	Returns whether the encoder is supported by the runtime (PHP, HHVM, ...) More...

	encodePassword (string $raw, string $salt)
	Encodes the raw password. More...

	isPasswordValid (string $encoded, string $raw, string $salt)
	Checks a raw password against an encoded password. More...

	requiresReencoding (string $encoded)
	Returns whether the encoded password needs to be re-encoded. More...

Public Member Functions inherited from ilBasePasswordEncoder
	isSupportedByRuntime ()
	Returns whether the encoder is supported by the runtime (PHP, HHVM, ...) More...

	requiresSalt ()
	Returns whether the encoder requires a salt. More...

	requiresReencoding (string $encoded)
	Returns whether the encoded password needs to be re-encoded. More...

Private Attributes
const	CONFIG_KEY_TIME_COST = 'time_cost'

const	CONFIG_KEY_MEMORY_COST = 'memory_cost'

const	CONFIG_KEY_THREADS = 'threads'

int	$memory_cost = null

int	$time_cost = null

int	$threads = null

Additional Inherited Members
Protected Member Functions inherited from ilBasePasswordEncoder
	comparePasswords (string $knownString, string $userString)
	Compares two passwords. More...

	isPasswordTooLong (string $password)

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

array<string,mixed> $config

Definition at line 34 of file class.ilArgon2IdPasswordEncoder.php.

References isSupportedByRuntime(), setMemoryCost(), setThreads(), and setTimeCost().

     {
         if (!empty($config)) {
             foreach ($config as $key => $value) {
                 switch (strtolower($key)) {
                     case self::CONFIG_KEY_MEMORY_COST:
                         $this->setMemoryCost($value);
                         break;
 
                     case self::CONFIG_KEY_TIME_COST:
                         $this->setTimeCost($value);
                         break;
 
                     case self::CONFIG_KEY_THREADS:
                         $this->setThreads($value);
                         break;
                 }
             }
         }
 
         if ($this->isSupportedByRuntime() && static::class == self::class) {
             if (!isset($config[self::CONFIG_KEY_MEMORY_COST])) {
                 $this->setMemoryCost(PASSWORD_ARGON2_DEFAULT_MEMORY_COST);
             }
             if (!isset($config[self::CONFIG_KEY_TIME_COST])) {
                 $this->setTimeCost(PASSWORD_ARGON2_DEFAULT_TIME_COST);
             }
             if (!isset($config[self::CONFIG_KEY_THREADS])) {
                 $this->setThreads(PASSWORD_ARGON2_DEFAULT_THREADS);
             }
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ encodePassword()

ilArgon2idPasswordEncoder::encodePassword	(	string	$raw,
		string	$salt
	)

Encodes the raw password.

Parameters

string	$raw	The password to encode
string	$salt	The salt

Returns: string The encoded password

Implements ilPasswordEncoder.

Definition at line 111 of file class.ilArgon2IdPasswordEncoder.php.

References getMemoryCost(), getThreads(), getTimeCost(), and ilBasePasswordEncoder\isPasswordTooLong().

Referenced by ilArgon2IdPasswordEncoderTest\testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding(), ilArgon2IdPasswordEncoderTest\testPasswordShouldBeCorrectlyEncodedAndVerified(), and ilArgon2IdPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

                                                              : string
     {
         if ($this->isPasswordTooLong($raw)) {
             throw new ilPasswordException('Invalid password.');
         }
 
         return password_hash($raw, PASSWORD_ARGON2ID, [
             self::CONFIG_KEY_MEMORY_COST => $this->getMemoryCost(),
             self::CONFIG_KEY_TIME_COST => $this->getTimeCost(),
             self::CONFIG_KEY_THREADS => $this->getThreads(),
         ]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMemoryCost()

ilArgon2idPasswordEncoder::getMemoryCost ( )

Definition at line 67 of file class.ilArgon2IdPasswordEncoder.php.

References $memory_cost.

Referenced by encodePassword(), and requiresReencoding().

                                    : int
     {
         return $this->memory_cost;
     }

Here is the caller graph for this function:

◆ getName()

ilArgon2idPasswordEncoder::getName ( )

Returns a unique name/id of the concrete password encoder.

Implements ilPasswordEncoder.

Definition at line 97 of file class.ilArgon2IdPasswordEncoder.php.

Referenced by ilArgon2IdPasswordEncoderTest\testNameShouldBeArgon2id().

                              : string
     {
         return 'argon2id';
     }

Here is the caller graph for this function:

◆ getThreads()

ilArgon2idPasswordEncoder::getThreads ( )

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

References $threads.

Referenced by encodePassword(), and requiresReencoding().

                                 : int
     {
         return $this->threads;
     }

Here is the caller graph for this function:

◆ getTimeCost()

ilArgon2idPasswordEncoder::getTimeCost ( )

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

References $time_cost.

Referenced by encodePassword(), and requiresReencoding().

                                  : int
     {
         return $this->time_cost;
     }

Here is the caller graph for this function:

◆ isPasswordValid()

ilArgon2idPasswordEncoder::isPasswordValid	(	string	$encoded,
		string	$raw,
		string	$salt
	)

Checks a raw password against an encoded password.

The raw password has to be injected into the encoder instance before.

Parameters

string	$encoded	An encoded password
string	$raw	A raw password
string	$salt	The salt, may be empty

Returns: Boolean true if the password is valid, false otherwise

Implements ilPasswordEncoder.

Definition at line 124 of file class.ilArgon2IdPasswordEncoder.php.

Referenced by ilArgon2IdPasswordEncoderTest\testPasswordShouldBeCorrectlyEncodedAndVerified(), and ilArgon2IdPasswordEncoderTest\testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength().

                                                                                : bool
     {
         return password_verify($raw, $encoded);
     }

Here is the caller graph for this function:

◆ isSupportedByRuntime()

ilArgon2idPasswordEncoder::isSupportedByRuntime ( )

Returns whether the encoder is supported by the runtime (PHP, HHVM, ...)

Implements ilPasswordEncoder.

Definition at line 102 of file class.ilArgon2IdPasswordEncoder.php.

Referenced by __construct().

                                           : bool
     {
         return (
             parent::isSupportedByRuntime() &&
             version_compare(phpversion(), '7.3.0', '>=') &&
             defined('PASSWORD_ARGON2ID')
         );
     }

Here is the caller graph for this function:

◆ requiresReencoding()

ilArgon2idPasswordEncoder::requiresReencoding ( string $encoded )

Returns whether the encoded password needs to be re-encoded.

Implements ilPasswordEncoder.

Definition at line 129 of file class.ilArgon2IdPasswordEncoder.php.

References getMemoryCost(), getThreads(), and getTimeCost().

Referenced by ilArgon2IdPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

                                                        : bool
     {
         return password_needs_rehash($encoded, PASSWORD_ARGON2ID, [
             self::CONFIG_KEY_MEMORY_COST => $this->getMemoryCost(),
             self::CONFIG_KEY_TIME_COST => $this->getTimeCost(),
             self::CONFIG_KEY_THREADS => $this->getThreads(),
         ]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setMemoryCost()

ilArgon2idPasswordEncoder::setMemoryCost ( int $memory_costs )

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

Referenced by __construct(), and ilArgon2IdPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

                                                     : void
     {
         $this->memory_cost = $memory_costs;
     }

Here is the caller graph for this function:

◆ setThreads()

ilArgon2idPasswordEncoder::setThreads ( int $threads )

Definition at line 92 of file class.ilArgon2IdPasswordEncoder.php.

References $threads.

Referenced by __construct(), and ilArgon2IdPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

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

Here is the caller graph for this function:

◆ setTimeCost()

ilArgon2idPasswordEncoder::setTimeCost ( int $time_cost )

Definition at line 82 of file class.ilArgon2IdPasswordEncoder.php.

References $time_cost.

Referenced by __construct(), and ilArgon2IdPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

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

Here is the caller graph for this function:

Field Documentation

◆ $memory_cost

int ilArgon2idPasswordEncoder::$memory_cost = null

private

Definition at line 27 of file class.ilArgon2IdPasswordEncoder.php.

Referenced by getMemoryCost().

◆ $threads

int ilArgon2idPasswordEncoder::$threads = null

private

Definition at line 29 of file class.ilArgon2IdPasswordEncoder.php.

Referenced by getThreads(), and setThreads().

◆ $time_cost

int ilArgon2idPasswordEncoder::$time_cost = null

private

Definition at line 28 of file class.ilArgon2IdPasswordEncoder.php.

Referenced by getTimeCost(), and setTimeCost().

◆ CONFIG_KEY_MEMORY_COST

const ilArgon2idPasswordEncoder::CONFIG_KEY_MEMORY_COST = 'memory_cost'

private

Definition at line 24 of file class.ilArgon2IdPasswordEncoder.php.

◆ CONFIG_KEY_THREADS

const ilArgon2idPasswordEncoder::CONFIG_KEY_THREADS = 'threads'

private

Definition at line 25 of file class.ilArgon2IdPasswordEncoder.php.

◆ CONFIG_KEY_TIME_COST

const ilArgon2idPasswordEncoder::CONFIG_KEY_TIME_COST = 'time_cost'

private

Definition at line 23 of file class.ilArgon2IdPasswordEncoder.php.

The documentation for this class was generated from the following file:

components/ILIAS/Password/classes/encoders/class.ilArgon2IdPasswordEncoder.php

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ encodePassword()

◆ getMemoryCost()

◆ getName()

◆ getThreads()

◆ getTimeCost()

◆ isPasswordValid()

◆ isSupportedByRuntime()

◆ requiresReencoding()

◆ setMemoryCost()

◆ setThreads()

◆ setTimeCost()

Field Documentation

◆ $memory_cost

◆ $threads

◆ $time_cost

◆ CONFIG_KEY_MEMORY_COST

◆ CONFIG_KEY_THREADS

◆ CONFIG_KEY_TIME_COST