ilBcryptPhpPasswordEncoder Class Reference

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

Private Attributes
const string	COST = 'cost'
string	$costs = '08'

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 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 36 of file class.ilBcryptPhpPasswordEncoder.php.

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

References benchmarkCost(), 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 54 of file class.ilBcryptPhpPasswordEncoder.php.

                                                            : int
    {
        $cost = 8;
 
        do {
            ++$cost;
            $start = microtime(true);
            $encoder = new self([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 90 of file class.ilBcryptPhpPasswordEncoder.php.

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

References 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 74 of file class.ilBcryptPhpPasswordEncoder.php.

                              : string
    {
        return $this->costs;
    }

References $costs.

Referenced by ilBcryptPasswordEncoder\encode(), 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 69 of file class.ilBcryptPhpPasswordEncoder.php.

                             : string
    {
        return 'bcryptphp';
    }

Referenced by ilBcryptPhpPasswordEncoderTest\testNameShouldBeBcryptPhp().

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 101 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 106 of file class.ilBcryptPhpPasswordEncoder.php.

                                                       : bool
    {
        return password_needs_rehash($encoded, PASSWORD_BCRYPT, [
            self::COST => $this->costs
        ]);
    }

Referenced by ilBcryptPhpPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

Here is the caller graph for this function:

setCosts()

ilBcryptPhpPasswordEncoder::setCosts

(

string

$costs

)

Definition at line 79 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);
        }
    }

References $costs, and ILIAS\Repository\int().

Referenced by __construct(), ilBcryptPasswordEncoderTest\testCostsCanBeRetrievedWhenCostsAreSet(), ilBcryptPhpPasswordEncoderTest\testCostsCanBeRetrievedWhenCostsAreSet(), ilBcryptPasswordEncoderTest\testCostsCanBeSetInRange(), ilBcryptPhpPasswordEncoderTest\testCostsCanBeSetInRange(), ilBcryptPasswordEncoderTest\testCostsCannotBeSetAboveRange(), ilBcryptPhpPasswordEncoderTest\testCostsCannotBeSetAboveRange(), ilBcryptPasswordEncoderTest\testCostsCannotBeSetBelowRange(), ilBcryptPhpPasswordEncoderTest\testCostsCannotBeSetBelowRange(), ilBcryptPasswordEncoderTest\testExceptionIsRaisedIfSaltIsMissingIsOnEncoding(), ilBcryptPasswordEncoderTest\testExceptionIsRaisedIfSaltIsMissingIsOnVerification(), and ilBcryptPhpPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$costs

string ilBcryptPhpPasswordEncoder::$costs = '08'

private

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

Referenced by getCosts(), and setCosts().

COST

const string ilBcryptPhpPasswordEncoder::COST = 'cost'

private

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

---

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

• components/ILIAS/Password/classes/encoders/class.ilBcryptPhpPasswordEncoder.php