Inheritance diagram for ilBcryptPasswordEncoder:

Collaboration diagram for ilBcryptPasswordEncoder:

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

	getDataDirectory ()

	setDataDirectory (string $data_directory)

	isBackwardCompatibilityEnabled ()

	setBackwardCompatibility (bool $backward_compatibility)
	Set the backward compatibility $2a$ instead of $2y$ for PHP 5.3.7+. More...

	isSecurityFlawIgnored ()

	setIsSecurityFlawIgnored (bool $is_security_flaw_ignored)

	getClientSalt ()

	setClientSalt (?string $client_salt)

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

	getClientSaltLocation ()

Public Member Functions inherited from ilBcryptPhpPasswordEncoder
	__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...

Data Fields
const	SALT_STORAGE_FILENAME = 'pwsalt.txt'

Private Member Functions
	isBcryptSupported ()

	encode (string $raw, string $userSecret)

	check (string $encoded, string $raw, string $salt)

	readClientSalt ()

	generateClientSalt ()

	storeClientSalt ()

Private Attributes
const	MIN_SALT_SIZE = 16

string	$client_salt = null

bool	$is_security_flaw_ignored = false

bool	$backward_compatibility = false

string	$data_directory = ''

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 27 of file class.ilBcryptPasswordEncoder.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

array<string,mixed> $config

Exceptions

ilPasswordException

Definition at line 44 of file class.ilBcryptPasswordEncoder.php.

References ILIAS\GlobalScreen\Provider\__construct(), readClientSalt(), setDataDirectory(), and setIsSecurityFlawIgnored().

     {
         foreach ($config as $key => $value) {
             $key = strtolower($key);
             if ($key === 'ignore_security_flaw') {
                 $this->setIsSecurityFlawIgnored($value);
             } elseif ($key === 'data_directory') {
                 $this->setDataDirectory($value);
             }
         }
 
         parent::__construct($config);
         $this->readClientSalt();
     }

Here is the call graph for this function:

Member Function Documentation

◆ check()

ilBcryptPasswordEncoder::check	(	string	$encoded,
		string	$raw,
		string	$salt
	)

private

Definition at line 185 of file class.ilBcryptPasswordEncoder.php.

References ilBasePasswordEncoder\comparePasswords().

Referenced by isPasswordValid().

                                                                       : bool
     {
         $hashedPassword = hash_hmac(
             'whirlpool',
             str_pad($raw, strlen($raw) * 4, sha1($salt), STR_PAD_BOTH),
             (string) $this->client_salt,
             true
         );
 
         return $this->comparePasswords($encoded, crypt($hashedPassword, substr($encoded, 0, 30)));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ encode()

ilBcryptPasswordEncoder::encode	(	string	$raw,
		string	$userSecret
	)

private

Check for security flaw in the bcrypt implementation used by crypt()

See also: http://php.net/security/crypt_blowfish.php

Definition at line 144 of file class.ilBcryptPasswordEncoder.php.

References $client_salt, ilBcryptPhpPasswordEncoder\getCosts(), and isBcryptSupported().

Referenced by encodePassword().

                                                             : string
     {
         $clientSecret = $this->client_salt;
         $hashedPassword = hash_hmac(
             'whirlpool',
             str_pad($raw, strlen($raw) * 4, sha1($userSecret), STR_PAD_BOTH),
             $clientSecret ?? '',
             true
         );
         $salt = substr(
             str_shuffle(str_repeat('./0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ', 22)),
             0,
             22
         );
 
         if ($this->isBcryptSupported() && !$this->backward_compatibility) {
             $prefix = '$2y$';
         } else {
             $prefix = '$2a$';
             // check if the password contains 8-bit character
             if (!$this->is_security_flaw_ignored && preg_match('#[\x80-\xFF]#', $raw)) {
                 throw new ilPasswordException(
                     'The bcrypt implementation used by PHP can contain a security flaw ' .
                     'using passwords with 8-bit characters. ' .
                     'We suggest to upgrade to PHP 5.3.7+ or use passwords with only 7-bit characters.'
                 );
             }
         }
 
         $saltedPassword = crypt($hashedPassword, $prefix . $this->getCosts() . '$' . $salt);
         if (strlen($saltedPassword) <= 13) {
             throw new ilPasswordException('Error during the bcrypt generation');
         }
 
         return $saltedPassword;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ encodePassword()

ilBcryptPasswordEncoder::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 107 of file class.ilBcryptPasswordEncoder.php.

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

Referenced by ilBcryptPasswordEncoderTest\testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding(), and ilBcryptPasswordEncoderTest\testPasswordShouldBeCorrectlyEncodedAndVerified().

                                                              : string
     {
         if (!$this->client_salt) {
             throw new ilPasswordException('Missing client salt.');
         }
 
         if ($this->isPasswordTooLong($raw)) {
             throw new ilPasswordException('Invalid password.');
         }
 
         return $this->encode($raw, $salt);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ generateClientSalt()

ilBcryptPasswordEncoder::generateClientSalt ( )

private

Definition at line 215 of file class.ilBcryptPasswordEncoder.php.

References ilPasswordUtils\getBytes(), and setClientSalt().

Referenced by readClientSalt().

                                          : void
     {
         $this->setClientSalt(
             substr(str_replace('+', '.', base64_encode(ilPasswordUtils::getBytes(self::MIN_SALT_SIZE))), 0, 22)
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getClientSalt()

ilBcryptPasswordEncoder::getClientSalt ( )

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

References $client_salt.

                                    : ?string
     {
         return $this->client_salt;
     }

◆ getClientSaltLocation()

ilBcryptPasswordEncoder::getClientSaltLocation ( )

Definition at line 197 of file class.ilBcryptPasswordEncoder.php.

Referenced by readClientSalt(), and storeClientSalt().

                                            : string
     {
         return $this->data_directory . '/' . self::SALT_STORAGE_FILENAME;
     }

Here is the caller graph for this function:

◆ getDataDirectory()

ilBcryptPasswordEncoder::getDataDirectory ( )

Definition at line 64 of file class.ilBcryptPasswordEncoder.php.

References $data_directory.

                                       : string
     {
         return $this->data_directory;
     }

◆ getName()

ilBcryptPasswordEncoder::getName ( )

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

Implements ilPasswordEncoder.

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

Referenced by ilBcryptPasswordEncoderTest\testNameShouldBeBcrypt().

                              : string
     {
         return 'bcrypt';
     }

Here is the caller graph for this function:

◆ isBackwardCompatibilityEnabled()

ilBcryptPasswordEncoder::isBackwardCompatibilityEnabled ( )

Definition at line 74 of file class.ilBcryptPasswordEncoder.php.

References $backward_compatibility.

                                                     : bool
     {
         return $this->backward_compatibility;
     }

◆ isBcryptSupported()

ilBcryptPasswordEncoder::isBcryptSupported ( )

private

Definition at line 59 of file class.ilBcryptPasswordEncoder.php.

Referenced by encode().

                                         : bool
     {
         return PHP_VERSION_ID >= 50307;
     }

Here is the caller graph for this function:

◆ isPasswordValid()

ilBcryptPasswordEncoder::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 120 of file class.ilBcryptPasswordEncoder.php.

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

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

                                                                                : bool
     {
         if (!$this->client_salt) {
             throw new ilPasswordException('Missing client salt.');
         }
 
         return !$this->isPasswordTooLong($raw) && $this->check($encoded, $raw, $salt);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSecurityFlawIgnored()

ilBcryptPasswordEncoder::isSecurityFlawIgnored ( )

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

References $is_security_flaw_ignored.

                                            : bool
     {
         return $this->is_security_flaw_ignored;
     }

◆ readClientSalt()

ilBcryptPasswordEncoder::readClientSalt ( )

private

Definition at line 202 of file class.ilBcryptPasswordEncoder.php.

References generateClientSalt(), getClientSaltLocation(), setClientSalt(), and storeClientSalt().

Referenced by __construct().

                                      : void
     {
         if (is_file($this->getClientSaltLocation()) && is_readable($this->getClientSaltLocation())) {
             $contents = file_get_contents($this->getClientSaltLocation());
             if ($contents !== false && trim($contents) !== '') {
                 $this->setClientSalt($contents);
             }
         } else {
             $this->generateClientSalt();
             $this->storeClientSalt();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requiresReencoding()

ilBcryptPasswordEncoder::requiresReencoding ( string $encoded )

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

Implements ilPasswordEncoder.

Definition at line 139 of file class.ilBcryptPasswordEncoder.php.

Referenced by ilBcryptPasswordEncoderTest\testEncoderDoesNotSupportReencoding().

                                                        : bool
     {
         return false;
     }

Here is the caller graph for this function:

◆ requiresSalt()

ilBcryptPasswordEncoder::requiresSalt ( )

Returns whether the encoder requires a salt.

Implements ilPasswordEncoder.

Definition at line 134 of file class.ilBcryptPasswordEncoder.php.

Referenced by ilBcryptPasswordEncoderTest\testEncoderReliesOnSalts().

                                   : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ setBackwardCompatibility()

ilBcryptPasswordEncoder::setBackwardCompatibility ( bool $backward_compatibility )

Set the backward compatibility $2a$ instead of $2y$ for PHP 5.3.7+.

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

References $backward_compatibility.

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

◆ setClientSalt()

ilBcryptPasswordEncoder::setClientSalt ( ?string $client_salt )

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

References $client_salt.

Referenced by generateClientSalt(), and readClientSalt().

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

Here is the caller graph for this function:

◆ setDataDirectory()

ilBcryptPasswordEncoder::setDataDirectory ( string $data_directory )

Definition at line 69 of file class.ilBcryptPasswordEncoder.php.

References $data_directory.

Referenced by __construct().

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

Here is the caller graph for this function:

◆ setIsSecurityFlawIgnored()

ilBcryptPasswordEncoder::setIsSecurityFlawIgnored ( bool $is_security_flaw_ignored )

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

References $is_security_flaw_ignored.

Referenced by __construct().

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

Here is the caller graph for this function:

◆ storeClientSalt()

ilBcryptPasswordEncoder::storeClientSalt ( )

private

Definition at line 222 of file class.ilBcryptPasswordEncoder.php.

References Vendor\Package\$e, $location, $message, and getClientSaltLocation().

Referenced by readClientSalt().

                                       : void
     {
         $location = $this->getClientSaltLocation();
 
         set_error_handler(static function (int $severity, string $message, string $file, int $line): never {
             throw new ErrorException($message, $severity, $severity, $file, $line);
         });
 
         try {
             $result = file_put_contents($location, $this->client_salt);
             if (!$result) {
                 throw new ilPasswordException(sprintf(
                     'Could not store the client salt in: %s. Please contact an administrator.',
                     $location
                 ));
             }
         } catch (Exception $e) {
             throw new ilPasswordException(sprintf(
                 'Could not store the client salt in: %s. Please contact an administrator.',
                 $location
             ), $e->getCode(), $e);
         } finally {
             restore_error_handler();
         }
     }