ilMd5PasswordEncoder Class Reference

Inheritance diagram for ilMd5PasswordEncoder:

Collaboration diagram for ilMd5PasswordEncoder:

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

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 30 of file class.ilMd5PasswordEncoder.php.

Member Function Documentation

encodePassword()

ilMd5PasswordEncoder::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 32 of file class.ilMd5PasswordEncoder.php.

References ilBasePasswordEncoder\isPasswordTooLong().

Referenced by isPasswordValid(), ilMd5PasswordEncoderTest\testExceptionIsRaisedIfThePasswordExceedsTheSupportedLengthOnEncoding(), and ilMd5PasswordEncoderTest\testPasswordShouldBeCorrectlyEncoded().

                                                             : string
    {
        if ($this->isPasswordTooLong($raw)) {
            throw new ilPasswordException('Invalid password.');
        }

        return md5($raw);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getName()

ilMd5PasswordEncoder::getName

(

)

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

Implements ilPasswordEncoder.

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

Referenced by ilMd5PasswordEncoderTest\testNameShouldBeMd5().

                             : string
    {
        return 'md5';
    }

Here is the caller graph for this function:

isPasswordValid()

ilMd5PasswordEncoder::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 41 of file class.ilMd5PasswordEncoder.php.

References ilBasePasswordEncoder\comparePasswords(), encodePassword(), and ilBasePasswordEncoder\isPasswordTooLong().

Referenced by ilMd5PasswordEncoderTest\testPasswordCanBeVerified(), and ilMd5PasswordEncoderTest\testPasswordVerificationShouldFailIfTheRawPasswordExceedsTheSupportedLength().

                                                                               : bool
    {
        return !$this->isPasswordTooLong($raw) && $this->comparePasswords($encoded, $this->encodePassword($raw, $salt));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

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