1. class
  2. Illuminate
  3. \
  4. Hashing
  5. \
  6. Argon2IdHasher

Argon2IdHasher

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.

from  AbstractHasher
bool
check(string $value, string $hashedValue, array $options = [])

Check the given plain value against a hash.

__construct(array $options = [])

Create a new hasher instance.

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

Hash the given value.

from  ArgonHasher
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.

from  ArgonHasher
verifyConfiguration($value)

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

from  ArgonHasher
bool
isUsingCorrectAlgorithm(string $hashedValue)

Verify the hashed value's algorithm.

bool
isUsingValidOptions(string $hashedValue)

Verify the hashed value's options.

from  ArgonHasher
$this
setMemory(int $memory)

Set the default password memory factor.

from  ArgonHasher
$this
setTime(int $time)

Set the default password timing factor.

from  ArgonHasher
$this
setThreads(int $threads)

Set the default password threads factor.

from  ArgonHasher
int
memory(array $options)

Extract the memory cost value from the options array.

from  ArgonHasher
int
time(array $options)

Extract the time cost value from the options array.

from  ArgonHasher
int
threads(array $options)

Extract the thread's value from the options array.

from  ArgonHasher

Details

in AbstractHasher at line 13
array info(string $hashedValue)

Get information about the given hashed value.

Parameters

string $hashedValue

Return Value

array

at line 19
bool check(string $value, string $hashedValue, array $options = [])

Check the given plain value against a hash.

Parameters

string $value
string $hashedValue
array $options

Return Value

bool

Exceptions

RuntimeException

in ArgonHasher at line 44
__construct(array $options = [])

Create a new hasher instance.

Parameters

array $options

in ArgonHasher at line 61
string make(string $value, array $options = [])

Hash the given value.

Parameters

string $value
array $options

Return Value

string

Exceptions

RuntimeException

at line 48
protected int algorithm()

Get the algorithm that should be used for hashing.

Return Value

int

in ArgonHasher at line 116
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

in ArgonHasher at line 130
verifyConfiguration($value)

internal  
 

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

Parameters

$value

at line 38
protected bool isUsingCorrectAlgorithm(string $hashedValue)

Verify the hashed value's algorithm.

Parameters

string $hashedValue

Return Value

bool

in ArgonHasher at line 152
protected bool isUsingValidOptions(string $hashedValue)

Verify the hashed value's options.

Parameters

string $hashedValue

Return Value

bool

in ArgonHasher at line 181
$this setMemory(int $memory)

Set the default password memory factor.

Parameters

int $memory

Return Value

$this

in ArgonHasher at line 194
$this setTime(int $time)

Set the default password timing factor.

Parameters

int $time

Return Value

$this

in ArgonHasher at line 207
$this setThreads(int $threads)

Set the default password threads factor.

Parameters

int $threads

Return Value

$this

in ArgonHasher at line 220
protected int memory(array $options)

Extract the memory cost value from the options array.

Parameters

array $options

Return Value

int

in ArgonHasher at line 231
protected int time(array $options)

Extract the time cost value from the options array.

Parameters

array $options

Return Value

int

in ArgonHasher at line 242
protected int threads(array $options)

Extract the thread's value from the options array.

Parameters

array $options

Return Value

int