BasePasswordEncoder
in package
implements
PasswordEncoderInterface
BasePasswordEncoder is the base class for all password encoders.
Tags
Interfaces, Classes, Traits and Enums
- PasswordEncoderInterface
- PasswordEncoderInterface is the interface for all encoders.
Table of Contents
- MAX_PASSWORD_LENGTH = 4096
- needsRehash() : bool
- {@inheritdoc}
- comparePasswords() : bool
- Compares two passwords.
- demergePasswordAndSalt() : array<string|int, mixed>
- Demerges a merge password and salt string.
- isPasswordTooLong() : bool
- Checks if the password is too long.
- mergePasswordAndSalt() : string
- Merges a password and a salt.
Constants
MAX_PASSWORD_LENGTH
public
mixed
MAX_PASSWORD_LENGTH
= 4096
Methods
needsRehash()
{@inheritdoc}
public
needsRehash(string $encoded) : bool
Parameters
- $encoded : string
Return values
bool —comparePasswords()
Compares two passwords.
protected
comparePasswords(string $password1, string $password2) : bool
This method implements a constant-time algorithm to compare passwords to avoid (remote) timing attacks.
Parameters
- $password1 : string
-
The first password
- $password2 : string
-
The second password
Return values
bool —true if the two passwords are the same, false otherwise
demergePasswordAndSalt()
Demerges a merge password and salt string.
protected
demergePasswordAndSalt(string $mergedPasswordSalt) : array<string|int, mixed>
Parameters
- $mergedPasswordSalt : string
-
The merged password and salt string
Return values
array<string|int, mixed> —An array where the first element is the password and the second the salt
isPasswordTooLong()
Checks if the password is too long.
protected
isPasswordTooLong(string $password) : bool
Parameters
- $password : string
-
The password to check
Return values
bool —true if the password is too long, false otherwise
mergePasswordAndSalt()
Merges a password and a salt.
protected
mergePasswordAndSalt(string $password, string|null $salt) : string
Parameters
- $password : string
-
The password to be used
- $salt : string|null
-
The salt to be used
Tags
Return values
string —a merged password and salt