ilBasePasswordEncoder Class Reference

Inheritance diagram for ilBasePasswordEncoder:

Collaboration diagram for ilBasePasswordEncoder:

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

Protected Member Functions
	comparePasswords (string $knownString, string $userString)
	Compares two passwords. More...
	isPasswordTooLong (string $password)

Private Attributes
const	MAX_PASSWORD_LENGTH = 4096

Detailed Description

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

Member Function Documentation

comparePasswords()

ilBasePasswordEncoder::comparePasswords ( string  $knownString, string  $userString  )

protected

Compares two passwords.

This method implements a constant-time algorithm to compare passwords to avoid (remote) timing attacks. http://codahale.com/a-lesson-in-timing-attacks/

Parameters

string	$knownString	The first password
string	$userString	The second password

Returns

bool true if the two passwords are the same, false otherwise

Definition at line 40 of file class.ilBasePasswordEncoder.php.

Referenced by ilBcryptPasswordEncoder\check(), and ilMd5PasswordEncoder\isPasswordValid().

                                                                                : bool
    {
        $knownString .= chr(0);
        $userString .= chr(0);

        $known_string_length = strlen($knownString);
        $user_string_length = strlen($userString);

        $result = $known_string_length - $user_string_length;

        for ($i = 0; $i < $user_string_length; ++$i) {
            $result |= (ord($knownString[$i % $known_string_length]) ^ ord($userString[$i]));
        }

        return 0 === $result;
    }

Here is the caller graph for this function:

isPasswordTooLong()

ilBasePasswordEncoder::isPasswordTooLong ( string  $password )

protected

Definition at line 57 of file class.ilBasePasswordEncoder.php.

Referenced by ilMd5PasswordEncoder\encodePassword(), ilBcryptPhpPasswordEncoder\encodePassword(), ilBcryptPasswordEncoder\encodePassword(), ilArgon2idPasswordEncoder\encodePassword(), ilMd5PasswordEncoder\isPasswordValid(), and ilBcryptPasswordEncoder\isPasswordValid().

                                                          : bool
    {
        return strlen($password) > self::MAX_PASSWORD_LENGTH;
    }

Here is the caller graph for this function:

isSupportedByRuntime()

ilBasePasswordEncoder::isSupportedByRuntime

(

)

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

Implements ilPasswordEncoder.

Definition at line 62 of file class.ilBasePasswordEncoder.php.

                                          : bool
    {
        return true;
    }

requiresReencoding()

ilBasePasswordEncoder::requiresReencoding

(

string

$encoded

)

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

Implements ilPasswordEncoder.

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

Referenced by ilMd5PasswordEncoderTest\testEncoderDoesNotSupportReencoding().

                                                       : bool
    {
        return false;
    }

Here is the caller graph for this function:

requiresSalt()

ilBasePasswordEncoder::requiresSalt

(

)

Returns whether the encoder requires a salt.

Implements ilPasswordEncoder.

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

Referenced by ilMd5PasswordEncoderTest\testEncoderDoesNotRelyOnSalts(), ilArgon2IdPasswordEncoderTest\testEncoderDoesNotRelyOnSalts(), and ilBcryptPhpPasswordEncoderTest\testEncoderDoesNotRelyOnSalts().

                                  : bool
    {
        return false;
    }

Here is the caller graph for this function:

Field Documentation

MAX_PASSWORD_LENGTH

const ilBasePasswordEncoder::MAX_PASSWORD_LENGTH = 4096

private

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

---

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

• Services/Password/classes/class.ilBasePasswordEncoder.php