ArgonHasher.php
4.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
<?php
namespace Illuminate\Hashing;
use Illuminate\Contracts\Hashing\Hasher as HasherContract;
use RuntimeException;
class ArgonHasher extends AbstractHasher implements HasherContract
{
/**
* The default memory cost factor.
*
* @var int
*/
protected $memory = 1024;
/**
* The default time cost factor.
*
* @var int
*/
protected $time = 2;
/**
* The default threads factor.
*
* @var int
*/
protected $threads = 2;
/**
* Indicates whether to perform an algorithm check.
*
* @var bool
*/
protected $verifyAlgorithm = false;
/**
* Create a new hasher instance.
*
* @param array $options
* @return void
*/
public function __construct(array $options = [])
{
$this->time = $options['time'] ?? $this->time;
$this->memory = $options['memory'] ?? $this->memory;
$this->threads = $this->threads($options);
$this->verifyAlgorithm = $options['verify'] ?? $this->verifyAlgorithm;
}
/**
* Hash the given value.
*
* @param string $value
* @param array $options
* @return string
*
* @throws \RuntimeException
*/
public function make($value, array $options = [])
{
$hash = @password_hash($value, $this->algorithm(), [
'memory_cost' => $this->memory($options),
'time_cost' => $this->time($options),
'threads' => $this->threads($options),
]);
if (! is_string($hash)) {
throw new RuntimeException('Argon2 hashing not supported.');
}
return $hash;
}
/**
* Get the algorithm that should be used for hashing.
*
* @return int
*/
protected function algorithm()
{
return PASSWORD_ARGON2I;
}
/**
* Check the given plain value against a hash.
*
* @param string $value
* @param string $hashedValue
* @param array $options
* @return bool
*
* @throws \RuntimeException
*/
public function check($value, $hashedValue, array $options = [])
{
if ($this->verifyAlgorithm && $this->info($hashedValue)['algoName'] !== 'argon2i') {
throw new RuntimeException('This password does not use the Argon2i algorithm.');
}
return parent::check($value, $hashedValue, $options);
}
/**
* Check if the given hash has been hashed using the given options.
*
* @param string $hashedValue
* @param array $options
* @return bool
*/
public function needsRehash($hashedValue, array $options = [])
{
return password_needs_rehash($hashedValue, $this->algorithm(), [
'memory_cost' => $this->memory($options),
'time_cost' => $this->time($options),
'threads' => $this->threads($options),
]);
}
/**
* Set the default password memory factor.
*
* @param int $memory
* @return $this
*/
public function setMemory(int $memory)
{
$this->memory = $memory;
return $this;
}
/**
* Set the default password timing factor.
*
* @param int $time
* @return $this
*/
public function setTime(int $time)
{
$this->time = $time;
return $this;
}
/**
* Set the default password threads factor.
*
* @param int $threads
* @return $this
*/
public function setThreads(int $threads)
{
$this->threads = $threads;
return $this;
}
/**
* Extract the memory cost value from the options array.
*
* @param array $options
* @return int
*/
protected function memory(array $options)
{
return $options['memory'] ?? $this->memory;
}
/**
* Extract the time cost value from the options array.
*
* @param array $options
* @return int
*/
protected function time(array $options)
{
return $options['time'] ?? $this->time;
}
/**
* Extract the thread's value from the options array.
*
* @param array $options
* @return int
*/
protected function threads(array $options)
{
if (defined('PASSWORD_ARGON2_PROVIDER') && PASSWORD_ARGON2_PROVIDER === 'sodium') {
return 1;
}
return $options['threads'] ?? $this->threads;
}
}