ilMd5PasswordEncoder Class Reference

Inheritance diagram for ilMd5PasswordEncoder:

Collaboration diagram for ilMd5PasswordEncoder:

Public Member Functions
	__construct (array $config=array())
	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...
	getName ()
	{Returns a unique name/id of the concrete password encoder. Returns string } 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...
	encodePassword ($raw, $salt)
	Encodes the raw password. More...
	isPasswordValid ($encoded, $raw, $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 ($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...

Additional Inherited Members
Data Fields inherited from ilBasePasswordEncoder
const	MAX_PASSWORD_LENGTH = 4096
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...

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilMd5PasswordEncoder::__construct

(

array

$config = array()

)

Parameters

array

$config

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

        {
        }

Member Function Documentation

encodePassword()

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

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

References ilBasePasswordEncoder\isPasswordTooLong().

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

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.

Returns

string

}

Implements ilPasswordEncoder.

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

        {
                return 'md5';
        }

Referenced by ilMd5PasswordEncoderTest\testNameShouldBeMd5().

Here is the caller graph for this function:

isPasswordValid()

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

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

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

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

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