class Argon2IdHasher extends ArgonHasher (View source)

Properties

protected int $memory

The default memory cost factor.

from  ArgonHasher
protected int $time

The default time cost factor.

from  ArgonHasher
protected int $threads

The default threads factor.

from  ArgonHasher
protected bool $verifyAlgorithm

Indicates whether to perform an algorithm check.

from  ArgonHasher

Methods

array
info(string $hashedValue)

Get information about the given hashed value.

bool
check(string $value, string|null $hashedValue, array $options = [])

Check the given plain value against a hash.

void
__construct(array $options = [])

Create a new hasher instance.

string
make(string $value, array $options = [])

Hash the given value.

int
algorithm()

Get the algorithm that should be used for hashing.

bool
needsRehash(string $hashedValue, array $options = [])

Check if the given hash has been hashed using the given options.

verifyConfiguration($value)

Verifies that the configuration is less than or equal to what is configured.

bool
isUsingCorrectAlgorithm(string $hashedValue)

Verify the hashed value's algorithm.

bool
isUsingValidOptions(string $hashedValue)

Verify the hashed value's options.

$this
setMemory(int $memory)

Set the default password memory factor.

$this
setTime(int $time)

Set the default password timing factor.

$this
setThreads(int $threads)

Set the default password threads factor.

int
memory(array $options)

Extract the memory cost value from the options array.

int
time(array $options)

Extract the time cost value from the options array.

int
threads(array $options)

Extract the thread's value from the options array.

Details

array info(string $hashedValue)

Get information about the given hashed value.

Parameters

string $hashedValue

Return Value

array

bool check(string $value, string|null $hashedValue, array $options = [])

Check the given plain value against a hash.

Parameters

string $value
string|null $hashedValue
array $options

Return Value

bool

Exceptions

RuntimeException

void __construct(array $options = [])

Create a new hasher instance.

Parameters

array $options

Return Value

void

string make(string $value, array $options = [])

Hash the given value.

Parameters

string $value
array $options

Return Value

string

Exceptions

RuntimeException

protected int algorithm()

Get the algorithm that should be used for hashing.

Return Value

int

bool needsRehash(string $hashedValue, array $options = [])

Check if the given hash has been hashed using the given options.

Parameters

string $hashedValue
array $options

Return Value

bool

verifyConfiguration($value)

internal  
 

Verifies that the configuration is less than or equal to what is configured.

Parameters

$value

protected bool isUsingCorrectAlgorithm(string $hashedValue)

Verify the hashed value's algorithm.

Parameters

string $hashedValue

Return Value

bool

protected bool isUsingValidOptions(string $hashedValue)

Verify the hashed value's options.

Parameters

string $hashedValue

Return Value

bool

$this setMemory(int $memory)

Set the default password memory factor.

Parameters

int $memory

Return Value

$this

$this setTime(int $time)

Set the default password timing factor.

Parameters

int $time

Return Value

$this

$this setThreads(int $threads)

Set the default password threads factor.

Parameters

int $threads

Return Value

$this

protected int memory(array $options)

Extract the memory cost value from the options array.

Parameters

array $options

Return Value

int

protected int time(array $options)

Extract the time cost value from the options array.

Parameters

array $options

Return Value

int

protected int threads(array $options)

Extract the thread's value from the options array.

Parameters

array $options

Return Value

int