ilBcryptPhpPasswordEncoder Class Reference

Inheritance diagram for ilBcryptPhpPasswordEncoder:

Collaboration diagram for ilBcryptPhpPasswordEncoder:

Public Member Functions
	__construct (array $config=array())
	benchmarkCost ($time_target=0.05)
	getName ()
	isSupportedByRuntime ()
	{Returns whether or not the encoder is supported by the runtime (PHP, HHVM, ...) Returns boolean } More...
	getCosts ()
	setCosts ($costs)
	encodePassword ($raw, $salt)
	{Encodes the raw password. Parameters string $raw The password to encode string $salt The salt Returns string The encoded password } More...
	isPasswordValid ($encoded, $raw, $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 Returns Boolean true if the password is valid, false otherwise } More...
	requiresReencoding ($encoded)
	{Returns whether or not the a encoded password needs to be re-encoded. Parameters $encoded string Returns boolean } More...
Public Member Functions inherited from ilBasePasswordEncoder
	isSupportedByRuntime ()
	{Returns whether or not the encoder is supported by the runtime (PHP, HHVM, ...) Returns boolean } More...
	requiresSalt ()
	{Returns whether or not the encoder requires a salt. Returns boolean } More...
	requiresReencoding ($encoded)
	{Returns whether or not the a encoded password needs to be re-encoded. Parameters $encoded string Returns boolean } More...

Protected Member Functions
	init ()
Protected Member Functions inherited from ilBasePasswordEncoder
	comparePasswords ($known_string, $user_string)
	Compares two passwords. More...
	isPasswordTooLong ($password)
	Checks if the password is too long. More...

Protected Attributes
	$costs = '08'

Additional Inherited Members
Data Fields inherited from ilBasePasswordEncoder
const	MAX_PASSWORD_LENGTH = 4096

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilBcryptPhpPasswordEncoder::__construct

(

array

$config = array()

)

Parameters

array

$config

Exceptions

ilPasswordException

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

References $config, $key, benchmarkCost(), init(), and setCosts().

    {
        if (!empty($config)) {
            foreach ($config as $key => $value) {
                switch (strtolower($key)) {
                    case 'cost':
                        $this->setCosts($value);
                        break;
                }
            }
        }

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

        $this->init();
    }

Here is the call graph for this function:

Member Function Documentation

benchmarkCost()

ilBcryptPhpPasswordEncoder::benchmarkCost

(

$time_target = 0.05

)

See also

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

Parameters

float

$time_target

Returns

int

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

References $end, and $start.

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

    {
        $cost = 8;

        do {
            $cost++;
            $start = microtime(true);
            $encoder = new self(array('cost' => $cost));
            $encoder->encodePassword('test', '');
            $end = microtime(true);
        } while (($end - $start) < $time_target && $cost < 32);

        return $cost;
    }

Here is the caller graph for this function:

encodePassword()

ilBcryptPhpPasswordEncoder::encodePassword	(		$raw,
			$salt
	)

{Encodes the raw password.

Parameters

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

Returns

string The encoded password

}

Exceptions

ilPasswordException

Implements ilPasswordEncoder.

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

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

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

    {
        if ($this->isPasswordTooLong($raw)) {
            require_once 'Services/Password/exceptions/class.ilPasswordException.php';
            throw new ilPasswordException('Invalid password.');
        }

        return password_hash($raw, PASSWORD_BCRYPT, array(
            'cost' => $this->getCosts()
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCosts()

ilBcryptPhpPasswordEncoder::getCosts

(

)

Returns

string

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

References $costs.

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

    {
        return $this->costs;
    }

Here is the caller graph for this function:

getName()

ilBcryptPhpPasswordEncoder::getName

(

)

Returns

string

Implements ilPasswordEncoder.

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

Referenced by ilBcryptPhpPasswordEncoderTest\testNameShouldBeBcryptPhp().

    {
        return 'bcryptphp';
    }

Here is the caller graph for this function:

init()

ilBcryptPhpPasswordEncoder::init ( )

protected

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

Referenced by __construct().

    {
    }

Here is the caller graph for this function:

isPasswordValid()

ilBcryptPhpPasswordEncoder::isPasswordValid	(		$encoded,
			$raw,
			$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

Returns

Boolean true if the password is valid, false otherwise

}

Implements ilPasswordEncoder.

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

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

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

Here is the caller graph for this function:

isSupportedByRuntime()

ilBcryptPhpPasswordEncoder::isSupportedByRuntime

(

)

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

Returns

boolean

}

Implements ilPasswordEncoder.

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

    {
        return parent::isSupportedByRuntime() && version_compare(phpversion(), '5.5.0', '>=');
    }

requiresReencoding()

ilBcryptPhpPasswordEncoder::requiresReencoding

(

$encoded

)

{Returns whether or not the a encoded password needs to be re-encoded.

Parameters

$encoded

string

Returns

boolean

}

Implements ilPasswordEncoder.

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

References getCosts().

Referenced by ilBcryptPhpPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

    {
        return password_needs_rehash($encoded, PASSWORD_BCRYPT, array(
            'cost' => $this->getCosts()
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setCosts()

ilBcryptPhpPasswordEncoder::setCosts

(

$costs

)

Parameters

string

$costs

Exceptions

ilPasswordException

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

References $costs.

Referenced by __construct(), ilBcryptPhpPasswordEncoderTest\testCostsCanBeRetrievedWhenCostsAreSet(), ilBcryptPasswordEncoderTest\testCostsCanBeRetrievedWhenCostsAreSet(), ilBcryptPhpPasswordEncoderTest\testCostsCanBeSetInRange(), ilBcryptPasswordEncoderTest\testCostsCanBeSetInRange(), ilBcryptPhpPasswordEncoderTest\testCostsCannotBeSetAboveRange(), ilBcryptPasswordEncoderTest\testCostsCannotBeSetAboveRange(), ilBcryptPhpPasswordEncoderTest\testCostsCannotBeSetBelowRange(), ilBcryptPasswordEncoderTest\testCostsCannotBeSetBelowRange(), ilBcryptPhpPasswordEncoderTest\testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding(), ilBcryptPasswordEncoderTest\testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding(), ilBcryptPhpPasswordEncoderTest\testPasswordShouldBeCorrectlyEncodedAndVerified(), ilBcryptPasswordEncoderTest\testPasswordShouldBeCorrectlyEncodedAndVerified(), ilBcryptPhpPasswordEncoderTest\testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength(), ilBcryptPasswordEncoderTest\testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength(), and ilBcryptPhpPasswordEncoderTest\testReencodingIsDetectedWhenNecessary().

    {
        if (!empty($costs)) {
            $costs = (int) $costs;
            if ($costs < 4 || $costs > 31) {
                require_once 'Services/Password/exceptions/class.ilPasswordException.php';
                throw new ilPasswordException('The costs parameter of bcrypt must be in range 04-31');
            }
            $this->costs = sprintf('%1$02d', $costs);
        }
    }

Here is the caller graph for this function:

Field Documentation

$costs

ilBcryptPhpPasswordEncoder::$costs = '08'

protected

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

Referenced by getCosts(), and setCosts().

---

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

• Services/Password/classes/encoders/class.ilBcryptPhpPasswordEncoder.php