ilBasePasswordEncoder Class Reference

Inheritance diagram for ilBasePasswordEncoder:

Collaboration diagram for ilBasePasswordEncoder:

Public Member Functions
	isSupportedByRuntime ()
	@inheritDoc More...
	requiresSalt ()
	@inheritDoc More...
	requiresReencoding (string $encoded)
	@inheritDoc 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...
	requiresSalt ()
	Returns whether or not the encoder requires a salt. More...
	requiresReencoding (string $encoded)
	Returns whether or not the a encoded password needs to be re-encoded. More...
	isSupportedByRuntime ()
	Returns whether or not the encoder is supported by the runtime (PHP, HHVM, ...) More...

Data Fields
const	MAX_PASSWORD_LENGTH = 4096

Protected Member Functions
	comparePasswords (string $knownString, string $userString)
	Compares two passwords. More...
	isPasswordTooLong (string $password)
	Checks if the password is too long. More...

Detailed Description

Definition at line 9 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. @url http://codahale.com/a-lesson-in-timing-attacks/

Parameters

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

Returns

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

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

                                                                                 : 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]));
        }
 
        // They are only identical strings if $result is exactly 0...
        return 0 === $result;
    }

References $i, and $result.

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

Here is the caller graph for this function:

isPasswordTooLong()

ilBasePasswordEncoder::isPasswordTooLong ( string  $password )

protected

Checks if the password is too long.

Parameters

string

$password

The password

Returns

bool true if the password is too long, false otherwise

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

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

References $password, and MAX_PASSWORD_LENGTH.

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

Here is the caller graph for this function:

isSupportedByRuntime()

ilBasePasswordEncoder::isSupportedByRuntime

(

)

@inheritDoc

Implements ilPasswordEncoder.

Reimplemented in ilBcryptPhpPasswordEncoder.

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

                                           : bool
    {
        return true;
    }

requiresReencoding()

ilBasePasswordEncoder::requiresReencoding

(

string

$encoded

)

@inheritDoc

Implements ilPasswordEncoder.

Reimplemented in ilBcryptPasswordEncoder, and ilBcryptPhpPasswordEncoder.

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

                                                        : bool
    {
        return false;
    }

Referenced by ilMd5PasswordEncoderTest\testEncoderDoesNotSupportReencoding().

Here is the caller graph for this function:

requiresSalt()

ilBasePasswordEncoder::requiresSalt

(

)

@inheritDoc

Implements ilPasswordEncoder.

Reimplemented in ilBcryptPasswordEncoder.

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

                                   : bool
    {
        return false;
    }

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

Here is the caller graph for this function:

Field Documentation

MAX_PASSWORD_LENGTH

const ilBasePasswordEncoder::MAX_PASSWORD_LENGTH = 4096

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

Referenced by isPasswordTooLong().

---

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

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