Inheritance diagram for ilBcryptPhpPasswordEncoder:

Collaboration diagram for ilBcryptPhpPasswordEncoder:

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

	benchmarkCost (float $time_target=0.05)

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

	getCosts ()

	setCosts (string $costs)

	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...

	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...

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

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

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

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

Protected Member Functions
	init ()

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

	isPasswordTooLong (string $password)

Protected Attributes
string	$costs = '08'

Detailed Description

Definition at line 26 of file class.ilBcryptPhpPasswordEncoder.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

array<string,mixed> $config

Exceptions

ilPasswordException

Reimplemented in ilBcryptPasswordEncoder.

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

    {
        foreach ($config as $key => $value) {
            if (strtolower($key) === 'cost') {
                $this->setCosts($value);
            }
        }
 
        if (!isset($config['cost']) && static::class === self::class) {
            // Determine the costs only if they are not passed in constructor
            $this->setCosts((string) $this->benchmarkCost());
        }
 
        $this->init();
    }

References $config, ILIAS\LTI\ToolProvider\$key, benchmarkCost(), init(), and setCosts().

Here is the call graph for this function:

Member Function Documentation

◆ benchmarkCost()

ilBcryptPhpPasswordEncoder::benchmarkCost ( float $time_target = 0.05 )

See also: http://php.net/manual/en/function.password-hash.php#example-984

Exceptions

ilPasswordException

Definition at line 58 of file class.ilBcryptPhpPasswordEncoder.php.

                                                            : int
    {
        $cost = 8;
 
        do {
            ++$cost;
            $start = microtime(true);
            $encoder = new self(['cost' => (string) $cost]);
            $encoder->encodePassword('test', '');
            $end = microtime(true);
        } while (($end - $start) < $time_target && $cost < 32);
 
        return $cost;
    }

Referenced by __construct(), and ilBcryptPhpPasswordEncoderTest\testCostsCanBeDeterminedDynamically().

Here is the caller graph for this function:

◆ encodePassword()

ilBcryptPhpPasswordEncoder::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.

Reimplemented in ilBcryptPasswordEncoder.

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

                                                             : string
    {
        if ($this->isPasswordTooLong($raw)) {
            throw new ilPasswordException('Invalid password.');
        }
 
        return password_hash($raw, PASSWORD_BCRYPT, [
            'cost' => $this->getCosts()
        ]);
    }

References getCosts(), and ilBasePasswordEncoder\isPasswordTooLong().

Referenced by ilBcryptPhpPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCosts()

ilBcryptPhpPasswordEncoder::getCosts ( )

Definition at line 78 of file class.ilBcryptPhpPasswordEncoder.php.

                              : string
    {
        return $this->costs;
    }

References $costs.

Referenced by ilBcryptPasswordEncoder\encode(), encodePassword(), requiresReencoding(), ilBcryptPasswordEncoderTest\testCostsCanBeRetrievedWhenCostsAreSet(), and ilBcryptPhpPasswordEncoderTest\testCostsCanBeRetrievedWhenCostsAreSet().

Here is the caller graph for this function:

◆ getName()

ilBcryptPhpPasswordEncoder::getName ( )

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

Implements ilPasswordEncoder.

Reimplemented in ilBcryptPasswordEncoder.

Definition at line 73 of file class.ilBcryptPhpPasswordEncoder.php.

                             : string
    {
        return 'bcryptphp';
    }

Referenced by ilBcryptPhpPasswordEncoderTest\testNameShouldBeBcryptPhp().

Here is the caller graph for this function:

◆ init()

ilBcryptPhpPasswordEncoder::init ( )

protected

Reimplemented in ilBcryptPasswordEncoder.

Definition at line 50 of file class.ilBcryptPhpPasswordEncoder.php.

                             : void
    {
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ isPasswordValid()

ilBcryptPhpPasswordEncoder::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.

Reimplemented in ilBcryptPasswordEncoder.

Definition at line 105 of file class.ilBcryptPhpPasswordEncoder.php.

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

◆ requiresReencoding()

ilBcryptPhpPasswordEncoder::requiresReencoding ( string $encoded )

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

Reimplemented from ilBasePasswordEncoder.

Reimplemented in ilBcryptPasswordEncoder.

Definition at line 110 of file class.ilBcryptPhpPasswordEncoder.php.

                                                       : bool
    {
        return password_needs_rehash($encoded, PASSWORD_BCRYPT, [
            'cost' => $this->getCosts()
        ]);
    }

References getCosts().

Referenced by ilBcryptPhpPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCosts()

ilBcryptPhpPasswordEncoder::setCosts ( string $costs )

Definition at line 83 of file class.ilBcryptPhpPasswordEncoder.php.

                                           : void
    {
        if ($costs !== '') {
            $numeric_costs = (int) $costs;
            if ($numeric_costs < 4 || $numeric_costs > 31) {
                throw new ilPasswordException('The costs parameter of bcrypt must be in range 04-31');
            }
            $this->costs = sprintf('%1$02d', $numeric_costs);
        }
    }