Elgg\PasswordService Class Reference

Public Member Functions
	__construct ()
	Constructor. More...
	needsRehash ($hash)
	Determine if the password hash needs to be rehashed. More...
	verify ($password, $hash)
	Verify a password against a hash using a timing attack resistant approach. More...
	generateHash ($password)
	Hash a password for storage using password_hash() More...
	generateLegacyHash (\ElggUser $user, $password)
	Hash a password for storage. More...
	sendNewPasswordRequest ($user_guid)
	Generate and send a password request email to a given user's registered email address. More...
	forcePasswordReset ($user, $password)
	Set a user's new password and save the entity. More...
	executeNewPasswordReset ($user_guid, $conf_code, $password=null)
	Validate and change password for a user. More...

Detailed Description

Definition at line 11 of file PasswordService.php.

Constructor & Destructor Documentation

__construct()

Elgg\PasswordService::__construct

(

)

Constructor.

Definition at line 16 of file PasswordService.php.

Member Function Documentation

executeNewPasswordReset()

Elgg\PasswordService::executeNewPasswordReset	(		$user_guid,
			$conf_code,
			$password = null
	)

Validate and change password for a user.

Parameters

int	$user_guid	The user id
string	$conf_code	Confirmation code as sent in the request email.
string	$password	Optional new password, if not randomly generated.

Returns

bool True on success

Definition at line 139 of file PasswordService.php.

forcePasswordReset()

Elgg\PasswordService::forcePasswordReset	(		$user,
			$password
	)

Set a user's new password and save the entity.

This can only be called from execute_new_password_request().

Parameters

\ElggUser | int	$user	The user GUID or entity
string	$password	Text (which will then be converted into a hash and stored)

Returns

bool

Definition at line 113 of file PasswordService.php.

generateHash()

Elgg\PasswordService::generateHash

(

$password

)

Hash a password for storage using password_hash()

Parameters

string

$password

Password in clear text

Returns

string

Definition at line 54 of file PasswordService.php.

generateLegacyHash()

Elgg\PasswordService::generateLegacyHash	(	\ElggUser	$user,
			$password
	)

Hash a password for storage.

Currently salted MD5.

Parameters

\ElggUser	$user	The user this is being generated for.
string	$password	Password in clear text

Returns

string

Definition at line 66 of file PasswordService.php.

needsRehash()

Elgg\PasswordService::needsRehash

(

$hash

)

Determine if the password hash needs to be rehashed.

If the answer is true, after validating the password using password_verify, rehash it.

Parameters

string

$hash

The hash to test

Returns

boolean True if the password needs to be rehashed.

Definition at line 31 of file PasswordService.php.

sendNewPasswordRequest()

Elgg\PasswordService::sendNewPasswordRequest

(

$user_guid

)

Generate and send a password request email to a given user's registered email address.

Parameters

int

$user_guid

User GUID

Returns

bool

Definition at line 77 of file PasswordService.php.

verify()

Elgg\PasswordService::verify	(		$password,
			$hash
	)

Verify a password against a hash using a timing attack resistant approach.

Parameters

string	$password	The password to verify
string	$hash	The hash to verify against

Returns

boolean If the password matches the hash

Definition at line 43 of file PasswordService.php.

---

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

• engine/classes/Elgg/PasswordService.php