Subversion Repositories php_utils

Rev

Rev 73 | Rev 75 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
58 daniel-mar 1
<?php
2
 
3
/*
70 daniel-mar 4
 * ViaThinkSoft Modular Crypt Format 1.0 and vts_password_*() functions
58 daniel-mar 5
 * Copyright 2023 Daniel Marschall, ViaThinkSoft
72 daniel-mar 6
 * Revision 2023-03-03
58 daniel-mar 7
 *
8
 * Licensed under the Apache License, Version 2.0 (the "License");
9
 * you may not use this file except in compliance with the License.
10
 * You may obtain a copy of the License at
11
 *
12
 *     http://www.apache.org/licenses/LICENSE-2.0
13
 *
14
 * Unless required by applicable law or agreed to in writing, software
15
 * distributed under the License is distributed on an "AS IS" BASIS,
16
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17
 * See the License for the specific language governing permissions and
18
 * limitations under the License.
19
 */
20
 
21
/*
22
 
63 daniel-mar 23
The function vts_password_hash() replaces password_hash()
24
and adds the ViaThinkSoft Modular Crypt Format 1.0 hash as well as
25
all hashes from password_hash() and crypt().
26
 
27
The function vts_password_verify() replaces password_verify().
28
 
58 daniel-mar 29
ViaThinkSoft Modular Crypt Format 1.0 performs a simple hash or HMAC operation.
30
No key derivation function or iterations are performed.
31
Format:
74 daniel-mar 32
        $1.3.6.1.4.1.37476.3.0.1.1$a=<algo>,m=<mode>[,i=<iterations>]$<salt>$<hash>
58 daniel-mar 33
where <algo> is any valid hash algorithm (name scheme of PHP hash_algos() preferred), e.g.
34
        sha3-512
35
        sha3-384
36
        sha3-256
37
        sha3-224
38
        sha512
39
        sha512/256
40
        sha512/224
41
        sha384
42
        sha256
43
        sha224
44
        sha1
45
        md5
70 daniel-mar 46
Not supported are these hashes (because they have a special salt-handling and output their own crypt format):
47
        bcrypt [Standardized crypt identifier 2, 2a, 2x, 2y]
48
        argon2i [Crypt identifier argon2i, not standardized]
49
        argon2id [Crypt identifier argon2i, not standardized]
58 daniel-mar 50
Valid <mode> :
51
        sp = salt + password
52
        ps = password + salt
53
        sps = salt + password + salt
54
        hmac = HMAC (salt is the key)
68 daniel-mar 55
        pbkdf2 = PBKDF2-HMAC (Additional param i= contains the number of iterations)
74 daniel-mar 56
<iterations> can be omitted if 0. It is required for mode=pbkdf2. For sp/ps/sps/hmac, it is optional.
60 daniel-mar 57
Like most Crypt-hashes, <salt> and <hash> are Radix64 coded
58
with alphabet './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz' and no padding.
58 daniel-mar 59
Link to the online specification:
60
        https://oidplus.viathinksoft.com/oidplus/?goto=oid%3A1.3.6.1.4.1.37476.3.0.1.1
61
Reference implementation in PHP:
62
        https://github.com/danielmarschall/php_utils/blob/master/vts_crypt.inc.php
63
 
64
*/
65
 
63 daniel-mar 66
require_once __DIR__ . '/misc_functions.inc.php';
58 daniel-mar 67
 
64 daniel-mar 68
define('OID_MCF_VTS_V1',     '1.3.6.1.4.1.37476.3.0.1.1'); // { iso(1) identified-organization(3) dod(6) internet(1) private(4) enterprise(1) 37476 specifications(3) misc(0) modular-crypt-format(1) vts-crypt-v1(1) }
63 daniel-mar 69
 
64 daniel-mar 70
// Valid algorithms for vts_password_hash():
70 daniel-mar 71
define('PASSWORD_STD_DES',   'std-des');       // Algorithm from crypt()
72
define('PASSWORD_EXT_DES',   'ext-des');       // Algorithm from crypt()
64 daniel-mar 73
define('PASSWORD_MD5',       'md5');           // Algorithm from crypt()
74
define('PASSWORD_BLOWFISH',  'blowfish');      // Algorithm from crypt()
75
define('PASSWORD_SHA256',    'sha256');        // Algorithm from crypt()
76
define('PASSWORD_SHA512',    'sha512');        // Algorithm from crypt()
70 daniel-mar 77
define('PASSWORD_VTS_MCF1',  OID_MCF_VTS_V1);  // Algorithm by ViaThinkSoft
64 daniel-mar 78
// Other valid values (already defined in PHP):
79
// - PASSWORD_DEFAULT
80
// - PASSWORD_BCRYPT
81
// - PASSWORD_ARGON2I
82
// - PASSWORD_ARGON2ID
63 daniel-mar 83
 
70 daniel-mar 84
define('PASSWORD_VTS_MCF1_MODE_SP',             'sp');     // Salt+Password
85
define('PASSWORD_VTS_MCF1_MODE_PS',             'ps');     // Password+Salt
86
define('PASSWORD_VTS_MCF1_MODE_SPS',            'sps');    // Salt+Password+Salt
87
define('PASSWORD_VTS_MCF1_MODE_HMAC',           'hmac');   // HMAC
88
define('PASSWORD_VTS_MCF1_MODE_PBKDF2',         'pbkdf2'); // PBKDF2-HMAC
89
 
90
define('PASSWORD_EXT_DES_DEFAULT_ITERATIONS',   725);
91
define('PASSWORD_BLOWFISH_DEFAULT_COST',        10);
92
define('PASSWORD_SHA256_DEFAULT_ROUNDS',        5000);
93
define('PASSWORD_SHA512_DEFAULT_ROUNDS',        5000);
94
define('PASSWORD_VTS_MCF1_DEFAULT_ALGO',        'sha3-512'); // any value in hash_algos(), NOT vts_hash_algos()
95
define('PASSWORD_VTS_MCF1_DEFAULT_MODE',        PASSWORD_VTS_MCF1_MODE_PS);
74 daniel-mar 96
define('PASSWORD_VTS_MCF1_DEFAULT_ITERATIONS',  0); // For PBKDF2, iterations=0 means: Default, depending on the algo
70 daniel-mar 97
 
63 daniel-mar 98
// --- Part 1: Modular Crypt Format encode/decode
58 daniel-mar 99
 
64 daniel-mar 100
function crypt_modular_format_encode($id, $bin_salt, $bin_hash, $params=null) {
58 daniel-mar 101
        // $<id>[$<param>=<value>(,<param>=<value>)*][$<salt>[$<hash>]]
102
        $out = '$'.$id;
103
        if (!is_null($params)) {
104
                $ary_params = array();
105
                foreach ($params as $name => $value) {
106
                        $ary_params[] = "$name=$value";
107
                }
108
                $out .= '$'.implode(',',$ary_params);
109
        }
59 daniel-mar 110
        $out .= '$'.crypt_radix64_encode($bin_salt);
111
        $out .= '$'.crypt_radix64_encode($bin_hash);
58 daniel-mar 112
        return $out;
113
}
114
 
59 daniel-mar 115
function crypt_modular_format_decode($mcf) {
116
        $ary = explode('$', $mcf);
117
 
118
        $dummy = array_shift($ary);
119
        if ($dummy !== '') return false;
120
 
121
        $dummy = array_shift($ary);
122
        $id = $dummy;
123
 
124
        $params = array();
125
        $dummy = array_shift($ary);
126
        if (strpos($dummy, '=') !== false) {
127
                $params_ary = explode(',',$dummy);
128
                foreach ($params_ary as $param) {
129
                        $bry = explode('=', $param, 2);
130
                        if (count($bry) > 1) {
131
                                $params[$bry[0]] = $bry[1];
132
                        }
133
                }
134
        } else {
135
                array_unshift($ary, $dummy);
136
        }
137
 
138
        if (count($ary) > 1) {
139
                $dummy = array_shift($ary);
140
                $bin_salt = crypt_radix64_decode($dummy);
141
        } else {
142
                $bin_salt = '';
143
        }
144
 
145
        $dummy = array_shift($ary);
146
        $bin_hash = crypt_radix64_decode($dummy);
147
 
72 daniel-mar 148
        return array('id'     => $id,
149
                     'salt'   => $bin_salt,
150
                     'hash'   => $bin_hash,
151
                     'params' => $params);
59 daniel-mar 152
}
153
 
63 daniel-mar 154
// --- Part 2: ViaThinkSoft Modular Crypt Format 1.0
155
 
64 daniel-mar 156
function vts_crypt_version($hash) {
157
        if (str_starts_with($hash, '$'.OID_MCF_VTS_V1.'$')) {
158
                return '1';
159
        } else {
160
                return '0';
161
        }
162
}
163
 
70 daniel-mar 164
function vts_crypt_hash($algo, $str_password, $str_salt, $ver='1', $mode=PASSWORD_VTS_MCF1_DEFAULT_MODE, $iterations=PASSWORD_VTS_MCF1_DEFAULT_ITERATIONS) {
58 daniel-mar 165
        if ($ver == '1') {
70 daniel-mar 166
                if ($mode == PASSWORD_VTS_MCF1_MODE_SP) {
74 daniel-mar 167
                        $bin_hash = hash_ex($algo, $str_salt.$str_password, true);
168
                        for ($i=0; $i<$iterations; $i++) {
169
                                $bin_hash = hash_ex($algo, $str_salt.$bin_hash.$i, true);
170
                        }
70 daniel-mar 171
                } else if ($mode == PASSWORD_VTS_MCF1_MODE_PS) {
74 daniel-mar 172
                        $bin_hash = hash_ex($algo, $str_password.$str_salt, true);
173
                        for ($i=0; $i<$iterations; $i++) {
174
                                $bin_hash = hash_ex($algo, $bin_hash.$i.$str_salt, true);
175
                        }
70 daniel-mar 176
                } else if ($mode == PASSWORD_VTS_MCF1_MODE_SPS) {
74 daniel-mar 177
                        $bin_hash = hash_ex($algo, $str_salt.$str_password.$str_salt, true);
178
                        for ($i=0; $i<$iterations; $i++) {
179
                                $bin_hash = hash_ex($algo, $str_salt.$bin_hash.$i.$str_salt, true);
180
                        }
70 daniel-mar 181
                } else if ($mode == PASSWORD_VTS_MCF1_MODE_HMAC) {
72 daniel-mar 182
                        $bin_hash = hash_hmac_ex($algo, $str_password, $str_salt, true);
74 daniel-mar 183
                        for ($i=0; $i<$iterations; $i++) {
184
                                // https://security.stackexchange.com/questions/149299/rounds-in-a-hashing-function
185
                                $bin_hash = hash_hmac_ex($algo, $str_password, $bin_hash.$i, true);
186
                        }
70 daniel-mar 187
                } else if ($mode == PASSWORD_VTS_MCF1_MODE_PBKDF2) {
72 daniel-mar 188
                        $bin_hash = hash_pbkdf2_ex($algo, $str_password, $str_salt, $iterations, 0, true);
58 daniel-mar 189
                } else {
65 daniel-mar 190
                        throw new Exception("Invalid VTS crypt version 1 mode. Expect sp, ps, sps, hmac, or pbkdf2.");
58 daniel-mar 191
                }
192
                $bin_salt = $str_salt;
65 daniel-mar 193
                $params = array();
194
                $params['a'] = $algo;
195
                $params['m'] = $mode;
74 daniel-mar 196
                if ($iterations != 0) $params['i'] = $iterations; // i can be omitted if it is 0.
65 daniel-mar 197
                return crypt_modular_format_encode(OID_MCF_VTS_V1, $bin_salt, $bin_hash, $params);
58 daniel-mar 198
        } else {
59 daniel-mar 199
                throw new Exception("Invalid VTS crypt version, expect 1.");
58 daniel-mar 200
        }
201
}
63 daniel-mar 202
 
64 daniel-mar 203
function vts_crypt_verify($password, $hash): bool {
204
        $ver = vts_crypt_version($hash);
205
        if ($ver == '1') {
63 daniel-mar 206
                // Decode the MCF hash parameters
207
                $data = crypt_modular_format_decode($hash);
208
                if ($data === false) throw new Exception('Invalid auth key');
209
                $id = $data['id'];
210
                $bin_salt = $data['salt'];
211
                $bin_hash = $data['hash'];
212
                $params = $data['params'];
65 daniel-mar 213
 
214
                if (!isset($params['a'])) throw new Exception('Param "a" (algo) missing');
63 daniel-mar 215
                $algo = $params['a'];
65 daniel-mar 216
 
217
                if (!isset($params['m'])) throw new Exception('Param "m" (mode) missing');
63 daniel-mar 218
                $mode = $params['m'];
219
 
70 daniel-mar 220
                if ($mode == PASSWORD_VTS_MCF1_MODE_PBKDF2) {
66 daniel-mar 221
                        if (!isset($params['i'])) throw new Exception('Param "i" (iterations) missing');
222
                        $iterations = $params['i'];
223
                } else {
74 daniel-mar 224
                        $iterations = isset($params['i']) ? $params['i'] : 0;
66 daniel-mar 225
                }
65 daniel-mar 226
 
63 daniel-mar 227
                // Create a VTS MCF 1.0 hash based on the parameters of $hash and the password $password
65 daniel-mar 228
                $calc_authkey_1 = vts_crypt_hash($algo, $password, $bin_salt, $ver, $mode, $iterations);
63 daniel-mar 229
 
64 daniel-mar 230
                // We rewrite the MCF to make sure that they match (if params have the wrong order)
231
                $calc_authkey_2 = crypt_modular_format_encode($id, $bin_salt, $bin_hash, $params);
63 daniel-mar 232
 
233
                return hash_equals($calc_authkey_1, $calc_authkey_2);
64 daniel-mar 234
        } else {
235
                throw new Exception("Invalid VTS crypt version, expect 1.");
236
        }
237
}
63 daniel-mar 238
 
70 daniel-mar 239
// --- Part 3: Replacement of vts_password_*() functions
64 daniel-mar 240
 
70 daniel-mar 241
/**
242
 * This function replaces password_algos() by extending it with
243
 * password hashes that are implemented in vts_password_hash().
244
 * @return array of hashes that can be used in vts_password_hash().
64 daniel-mar 245
 */
70 daniel-mar 246
function vts_password_algos() {
247
        $hashes = password_algos();
248
        $hashes[] = PASSWORD_STD_DES;   // Algorithm from crypt()
249
        $hashes[] = PASSWORD_EXT_DES;   // Algorithm from crypt()
250
        $hashes[] = PASSWORD_MD5;       // Algorithm from crypt()
251
        $hashes[] = PASSWORD_BLOWFISH;  // Algorithm from crypt()
252
        $hashes[] = PASSWORD_SHA256;    // Algorithm from crypt()
253
        $hashes[] = PASSWORD_SHA512;    // Algorithm from crypt()
254
        $hashes[] = PASSWORD_VTS_MCF1;  // Algorithm by ViaThinkSoft
255
        return $hashes;
256
}
257
 
258
/** vts_password_get_info() is the same as password_get_info(),
259
 * but it adds the crypt() and ViaThinkSoft MCF 1.0 algos which can be
260
 * produced by vts_password_hash()
261
 * @param string $hash Hash created by vts_password_hash(), password_hash(), or crypt().
262
 * @return array Same output like password_get_info().
263
 */
264
function vts_password_get_info($hash) {
265
        if (vts_crypt_version($hash) == '1') {
266
                // OID_MCF_VTS_V1
267
                $mcf = crypt_modular_format_decode($hash);
268
 
269
                //$options['salt_length'] = strlen($mcf['salt']);  // Note: salt_length is not a MCF option! It's just a hint for vts_password_hash()
270
 
271
                if (!isset($mcf['params']['a'])) throw new Exception('Param "a" (algo) missing');
272
                $options['algo'] = $mcf['params']['a'];
273
 
274
                if (!isset($mcf['params']['m'])) throw new Exception('Param "m" (mode) missing');
275
                $options['mode'] = $mcf['params']['m'];
276
 
277
                if ($options['mode'] == PASSWORD_VTS_MCF1_MODE_PBKDF2) {
278
                        if (!isset($mcf['params']['i'])) throw new Exception('Param "i" (iterations) missing');
71 daniel-mar 279
                        $options['iterations'] = (int)$mcf['params']['i'];
74 daniel-mar 280
                } else {
281
                        $options['iterations'] = isset($mcf['params']['i']) ? (int)$mcf['params']['i'] : 0;
70 daniel-mar 282
                }
283
 
284
                return array(
285
                        "algo" => PASSWORD_VTS_MCF1,
286
                        "algoName" => "vts-mcf-v1",
287
                        "options" => $options
288
                );
289
        } else if (!str_starts_with($hash, '$') && (strlen($hash) == 13)) {
290
                // PASSWORD_STD_DES
291
                return array(
292
                        "algo" => PASSWORD_STD_DES,
293
                        "algoName" => "std-des",
294
                        "options" => array(
295
                                // None
296
                        )
297
                );
298
        } else if (str_starts_with($hash, '_') && (strlen($hash) == 20)) {
299
                // PASSWORD_EXT_DES
300
                return array(
301
                        "algo" => PASSWORD_EXT_DES,
302
                        "algoName" => "ext-des",
303
                        "options" => array(
71 daniel-mar 304
                                "iterations" => (int)base64_int_decode(substr($hash,1,4))
70 daniel-mar 305
                        )
306
                );
307
        } else if (str_starts_with($hash, '$1$')) {
308
                // PASSWORD_MD5
309
                return array(
310
                        "algo" => PASSWORD_MD5,
311
                        "algoName" => "md5",
312
                        "options" => array(
313
                                // None
314
                        )
315
                );
316
        } else if (str_starts_with($hash, '$2$')  || str_starts_with($hash, '$2a$') ||
317
                   str_starts_with($hash, '$2x$') || str_starts_with($hash, '$2y$')) {
318
                // PASSWORD_BLOWFISH
319
                return array(
320
                        "algo" => PASSWORD_BLOWFISH,
321
                        "algoName" => "blowfish",
322
                        "options" => array(
71 daniel-mar 323
                                "cost" => (int)ltrim(explode('$',$hash)[2],'0')
70 daniel-mar 324
                        )
325
                );
326
        } else if (str_starts_with($hash, '$5$')) {
327
                // PASSWORD_SHA256
328
                return array(
329
                        "algo" => PASSWORD_SHA256,
330
                        "algoName" => "sha256",
331
                        "options" => array(
71 daniel-mar 332
                                'rounds' => (int)str_replace('rounds=','',explode('$',$hash)[2])
70 daniel-mar 333
                        )
334
                );
335
        } else if (str_starts_with($hash, '$6$')) {
336
                // PASSWORD_SHA512
337
                return array(
338
                        "algo" => PASSWORD_SHA512,
339
                        "algoName" => "sha512",
340
                        "options" => array(
71 daniel-mar 341
                                'rounds' => (int)str_replace('rounds=','',explode('$',$hash)[2])
70 daniel-mar 342
                        )
343
                );
63 daniel-mar 344
        } else {
70 daniel-mar 345
                // PASSWORD_DEFAULT
346
                // PASSWORD_BCRYPT
347
                // PASSWORD_ARGON2I
348
                // PASSWORD_ARGON2ID
349
                return password_get_info($hash);
63 daniel-mar 350
        }
351
}
352
 
353
/** This function extends password_hash() with the algorithms supported by crypt().
64 daniel-mar 354
 * It also adds vts_crypt_hash() which implements the ViaThinkSoft Modular Crypt Format 1.0.
63 daniel-mar 355
 * The result can be verified using vts_password_verify().
356
 * @param string $password to be hashed
357
 * @param mixed $algo algorithm
358
 * @param array $options options for the hashing algorithm
64 daniel-mar 359
 * @return string Crypt style password hash
63 daniel-mar 360
 */
361
function vts_password_hash($password, $algo, $options=array()): string {
70 daniel-mar 362
        $options = vts_password_fill_default_options($algo, $options);
363
 
63 daniel-mar 364
        $crypt_salt = null;
365
        if (($algo === PASSWORD_STD_DES) && defined('CRYPT_STD_DES')) {
366
                // Standard DES-based hash with a two character salt from the alphabet "./0-9A-Za-z". Using invalid characters in the salt will cause crypt() to fail.
367
                $crypt_salt = des_compat_salt(2);
368
        } else if (($algo === PASSWORD_EXT_DES) && defined('CRYPT_EXT_DES')) {
369
                // Extended DES-based hash. The "salt" is a 9-character string consisting of an underscore followed by 4 characters of iteration count and 4 characters of salt. Each of these 4-character strings encode 24 bits, least significant character first. The values 0 to 63 are encoded as ./0-9A-Za-z. Using invalid characters in the salt will cause crypt() to fail.
70 daniel-mar 370
                $iterations = $options['iterations'];
371
                $crypt_salt = '_' . base64_int_encode($iterations,4) . des_compat_salt(4);
63 daniel-mar 372
        } else if (($algo === PASSWORD_MD5) && defined('CRYPT_MD5')) {
373
                // MD5 hashing with a twelve character salt starting with $1$
374
                $crypt_salt = '$1$'.des_compat_salt(12).'$';
375
        } else if (($algo === PASSWORD_BLOWFISH) && defined('CRYPT_BLOWFISH')) {
376
                // Blowfish hashing with a salt as follows: "$2a$", "$2x$" or "$2y$", a two digit cost parameter, "$", and 22 characters from the alphabet "./0-9A-Za-z". Using characters outside of this range in the salt will cause crypt() to return a zero-length string. The two digit cost parameter is the base-2 logarithm of the iteration count for the underlying Blowfish-based hashing algorithm and must be in range 04-31, values outside this range will cause crypt() to fail. "$2x$" hashes are potentially weak; "$2a$" hashes are compatible and mitigate this weakness. For new hashes, "$2y$" should be used.
377
                $algo = '$2y$'; // most secure
70 daniel-mar 378
                $cost = $options['cost'];
63 daniel-mar 379
                $crypt_salt = $algo.str_pad($cost,2,'0',STR_PAD_LEFT).'$'.des_compat_salt(22).'$';
380
        } else if (($algo === PASSWORD_SHA256) && defined('CRYPT_SHA256')) {
381
                // SHA-256 hash with a sixteen character salt prefixed with $5$. If the salt string starts with 'rounds=<N>$', the numeric value of N is used to indicate how many times the hashing loop should be executed, much like the cost parameter on Blowfish. The default number of rounds is 5000, there is a minimum of 1000 and a maximum of 999,999,999. Any selection of N outside this range will be truncated to the nearest limit.
382
                $algo = '$5$';
70 daniel-mar 383
                $rounds = $options['rounds'];
63 daniel-mar 384
                $crypt_salt = $algo.'rounds='.$rounds.'$'.des_compat_salt(16).'$';
385
        } else if (($algo === PASSWORD_SHA512) && defined('CRYPT_SHA512')) {
386
                // SHA-512 hash with a sixteen character salt prefixed with $6$. If the salt string starts with 'rounds=<N>$', the numeric value of N is used to indicate how many times the hashing loop should be executed, much like the cost parameter on Blowfish. The default number of rounds is 5000, there is a minimum of 1000 and a maximum of 999,999,999. Any selection of N outside this range will be truncated to the nearest limit.
387
                $algo = '$6$';
70 daniel-mar 388
                $rounds = $options['rounds'];
63 daniel-mar 389
                $crypt_salt = $algo.'rounds='.$rounds.'$'.des_compat_salt(16).'$';
390
        }
391
 
392
        if (!is_null($crypt_salt)) {
64 daniel-mar 393
                // Algorithms: PASSWORD_STD_DES
394
                //             PASSWORD_EXT_DES
395
                //             PASSWORD_MD5
396
                //             PASSWORD_BLOWFISH
397
                //             PASSWORD_SHA256
398
                //             PASSWORD_SHA512
63 daniel-mar 399
                $out = crypt($password, $crypt_salt);
400
                if (strlen($out) < 13) throw new Exception("crypt() failed");
401
                return $out;
402
        } else if ($algo === PASSWORD_VTS_MCF1) {
64 daniel-mar 403
                // Algorithms: PASSWORD_VTS_MCF1
63 daniel-mar 404
                $ver  = '1';
70 daniel-mar 405
                $algo = $options['algo'];
406
                $mode = $options['mode'];
407
                $iterations = $options['iterations'];
408
                $salt_len = isset($options['salt_length']) ? $options['salt_length'] : 50; // Note: salt_length is not a MCF option! It's just a hint for vts_password_hash()
63 daniel-mar 409
                $salt = random_bytes_ex($salt_len, true, true);
65 daniel-mar 410
                return vts_crypt_hash($algo, $password, $salt, $ver, $mode, $iterations);
63 daniel-mar 411
        } else {
64 daniel-mar 412
                // Algorithms: PASSWORD_DEFAULT
413
                //             PASSWORD_BCRYPT
414
                //             PASSWORD_ARGON2I
415
                //             PASSWORD_ARGON2ID
63 daniel-mar 416
                return password_hash($password, $algo, $options);
417
        }
418
}
419
 
70 daniel-mar 420
/** This function replaces password_needs_rehash() by adding additional algorithms
421
 * supported by vts_password_hash().
422
 * @param string $hash The current hash
423
 * @param string|int|null $algo Desired new default algo
424
 * @param array $options Desired new default options
425
 * @return bool True if algo or options of the current hash don't match the current desired values ($algo and $options), otherwise false.
426
 */
427
function vts_password_needs_rehash($hash, $algo, $options=array()) {
428
        $options = vts_password_fill_default_options($algo, $options);
429
 
430
        $info = vts_password_get_info($hash);
431
        $algo2 = $info['algo'];
432
        $options2 = $info['options'];
433
 
434
        // Check if algorithm matches
435
        if ($algo !== $algo2) return true;
436
 
437
        if (vts_crypt_version($hash) == '1') {
438
                if (isset($options['salt_length'])) {
439
                        // For VTS MCF 1.0, salt_length is a valid option for vts_password_hash(),
440
                        // but it is not a valid option inside the MCF options
441
                        // and it is not a valid option for vts_password_get_info().
442
                        unset($options['salt_length']);
443
                }
444
 
74 daniel-mar 445
                // For PBKDF2, iterations=0 means: Default, depending on the algo
72 daniel-mar 446
                if (($options['iterations'] == 0/*default*/) && ($options2['mode'] == PASSWORD_VTS_MCF1_MODE_PBKDF2)) {
70 daniel-mar 447
                        $algo = $options2['algo'];
448
                        $userland = !hash_pbkdf2_supported_natively($algo) && str_starts_with($algo, 'sha3-') && method_exists('\bb\Sha3\Sha3', 'hash_pbkdf2');
72 daniel-mar 449
                        $options['iterations'] = _vts_password_default_iterations($algo, $userland);
70 daniel-mar 450
                }
451
        }
452
 
453
        // Check if options match
454
        if (count($options) !== count($options2)) return true;
455
        foreach ($options as $name => $val) {
456
                if ($options2[$name] != $val) return true;
457
        }
458
        return false;
459
}
460
 
461
/** This function extends password_verify() by adding ViaThinkSoft Modular Crypt Format 1.0.
462
 * @param string $password to be checked
463
 * @param string $hash Hash created by crypt(), password_hash(), or vts_password_hash().
464
 * @return bool true if password is valid
465
 */
466
function vts_password_verify($password, $hash): bool {
467
        if (vts_crypt_version($hash) != '0') {
468
                // Hash created by vts_password_hash(), or vts_crypt_hash()
469
                return vts_crypt_verify($password, $hash);
470
        } else {
471
                // Hash created by vts_password_hash(), password_hash(), or crypt()
472
                return password_verify($password, $hash);
473
        }
474
}
475
 
72 daniel-mar 476
// --- Part 4: Functions which include a fallback to a pure-PHP sha3 implementation (requires https://github.com/danielmarschall/php-sha3 )
63 daniel-mar 477
 
72 daniel-mar 478
function hash_ex($algo, $data, $binary=false, $options=array()) {
479
        if (!hash_supported_natively($algo) && str_starts_with($algo, 'sha3-') && method_exists('\bb\Sha3\Sha3', 'hash')) {
480
                $bits = explode('-',$algo)[1];
481
                $hash = \bb\Sha3\Sha3::hash($data, $bits, $binary);
482
        } else {
483
                $hash = hash($algo, $data, $binary);
484
        }
485
        return $hash;
486
}
487
 
488
function hash_hmac_ex($algo, $data, $key, $binary=false) {
489
        if (!hash_hmac_supported_natively($algo) && str_starts_with($algo, 'sha3-') && method_exists('\bb\Sha3\Sha3', 'hash_hmac')) {
490
                $bits = explode('-',$algo)[1];
491
                $hash = \bb\Sha3\Sha3::hash_hmac($data, $key, $bits, $binary);
492
        } else {
493
                $hash = hash_hmac($algo, $data, $key, $binary);
494
        }
495
        return $hash;
496
}
497
 
498
function hash_pbkdf2_ex($algo, $password, $salt, &$iterations=0, $length=0, $binary=false) {
499
        if (!hash_pbkdf2_supported_natively($algo) && str_starts_with($algo, 'sha3-') && method_exists('\bb\Sha3\Sha3', 'hash_pbkdf2')) {
500
                if ($iterations == 0/*default*/) {
501
                        $iterations = _vts_password_default_iterations($algo, true);
502
                }
503
                $bits = explode('-',$algo)[1];
504
                $hash = \bb\Sha3\Sha3::hash_pbkdf2($password, $salt, $iterations, $bits, $length, $binary);
505
        } else {
506
                if ($iterations == 0/*default*/) {
507
                        $iterations = _vts_password_default_iterations($algo, false);
508
                }
509
                $hash = hash_pbkdf2($algo, $password, $salt, $iterations, $length, $binary);
510
        }
511
        return $hash;
512
}
513
 
514
// --- Part 5: Useful functions required by the crypt-functions
515
 
64 daniel-mar 516
define('BASE64_RFC4648_ALPHABET', '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+/');
517
define('BASE64_CRYPT_ALPHABET',   './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz');
518
 
63 daniel-mar 519
function des_compat_salt($salt_len) {
520
        if ($salt_len <= 0) return '';
64 daniel-mar 521
        $characters = BASE64_CRYPT_ALPHABET;
63 daniel-mar 522
        $salt = '';
523
        $bytes = random_bytes_ex($salt_len, true, true);
524
        for ($i=0; $i<$salt_len; $i++) {
525
                $salt .= $characters[ord($bytes[$i]) % strlen($characters)];
526
        }
527
        return $salt;
528
}
529
 
70 daniel-mar 530
function base64_int_encode($num, $len) {
63 daniel-mar 531
        // https://stackoverflow.com/questions/15534982/which-iteration-rules-apply-on-crypt-using-crypt-ext-des
64 daniel-mar 532
        $alphabet_raw = BASE64_CRYPT_ALPHABET;
533
        $alphabet = str_split($alphabet_raw);
534
        $arr = array();
535
        $base = sizeof($alphabet);
536
        while ($num) {
537
                $rem = $num % $base;
538
                $num = (int)($num / $base);
539
                $arr[] = $alphabet[$rem];
63 daniel-mar 540
        }
64 daniel-mar 541
        $string = implode($arr);
70 daniel-mar 542
        return str_pad($string, $len, '.', STR_PAD_RIGHT);
63 daniel-mar 543
}
544
 
70 daniel-mar 545
function base64_int_decode($base64) {
546
        $num = 0;
547
        for ($i=strlen($base64)-1;$i>=0;$i--) {
548
                $num += strpos(BASE64_CRYPT_ALPHABET, $base64[$i])*pow(strlen(BASE64_CRYPT_ALPHABET),$i);
549
        }
550
        return $num;
551
}
552
 
63 daniel-mar 553
function crypt_radix64_encode($str) {
554
        $x = $str;
555
        $x = base64_encode($x);
64 daniel-mar 556
        $x = rtrim($x, '='); // remove padding
63 daniel-mar 557
        $x = strtr($x, BASE64_RFC4648_ALPHABET, BASE64_CRYPT_ALPHABET);
558
        return $x;
559
}
560
 
561
function crypt_radix64_decode($str) {
562
        $x = $str;
563
        $x = strtr($x, BASE64_CRYPT_ALPHABET, BASE64_RFC4648_ALPHABET);
564
        $x = base64_decode($x);
565
        return $x;
566
}
567
 
67 daniel-mar 568
function hash_supported_natively($algo) {
569
        if (version_compare(PHP_VERSION, '5.1.2') >= 0) {
570
                return in_array($algo, hash_algos());
571
        } else {
572
                return false;
573
        }
574
}
575
 
576
function hash_hmac_supported_natively($algo): bool {
577
        if (version_compare(PHP_VERSION, '7.2.0') >= 0) {
578
                return in_array($algo, hash_hmac_algos());
579
        } else if (version_compare(PHP_VERSION, '5.1.2') >= 0) {
580
                return in_array($algo, hash_algos());
581
        } else {
582
                return false;
583
        }
584
}
585
 
586
function hash_pbkdf2_supported_natively($algo) {
587
        return hash_supported_natively($algo);
588
}
589
 
70 daniel-mar 590
function vts_password_fill_default_options($algo, $options) {
591
        if ($algo === PASSWORD_STD_DES) {
592
                // No options
593
        } else if ($algo === PASSWORD_EXT_DES) {
594
                if (!isset($options['iterations'])) {
595
                        $options['iterations'] = PASSWORD_EXT_DES_DEFAULT_ITERATIONS;
596
                }
597
        } else if ($algo === PASSWORD_MD5) {
598
                // No options
599
        } else if ($algo === PASSWORD_BLOWFISH) {
600
                if (!isset($options['cost'])) {
601
                        $options['cost'] = PASSWORD_BLOWFISH_DEFAULT_COST;
602
                }
603
        } else if ($algo === PASSWORD_SHA256) {
604
                if (!isset($options['rounds'])) {
605
                        $options['rounds'] = PASSWORD_SHA256_DEFAULT_ROUNDS;
606
                }
607
        } else if ($algo === PASSWORD_SHA512) {
608
                if (!isset($options['rounds'])) {
609
                        $options['rounds'] = PASSWORD_SHA512_DEFAULT_ROUNDS;
610
                }
611
        } else if ($algo === PASSWORD_VTS_MCF1) {
612
                if (!isset($options['algo'])) {
613
                        $options['algo'] = PASSWORD_VTS_MCF1_DEFAULT_ALGO;
614
                }
615
                if (!isset($options['mode'])) {
616
                        $options['mode'] = PASSWORD_VTS_MCF1_DEFAULT_MODE;
617
                }
618
                if ($options['mode'] == PASSWORD_VTS_MCF1_MODE_PBKDF2) {
619
                        if (!isset($options['iterations'])) {
620
                                $options['iterations'] = PASSWORD_VTS_MCF1_DEFAULT_ITERATIONS;
621
                        }
622
                } else {
74 daniel-mar 623
                        $options['iterations'] = isset($options['iterations']) ? $options['iterations'] : 0;
70 daniel-mar 624
                }
625
        }
626
        return $options;
627
}
628
 
72 daniel-mar 629
function _vts_password_default_iterations($algo, $userland) {
630
        if ($userland) {
631
                return 100; // because the userland implementation is EXTREMELY slow, we must choose a small value, sorry...
632
        } else {
633
                // Recommendations taken from https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#pbkdf2
634
                // Note that hash_pbkdf2() implements PBKDF2-HMAC-*
635
                if      ($algo == 'sha3-512')    return  100000;
636
                else if ($algo == 'sha3-384')    return  100000;
637
                else if ($algo == 'sha3-256')    return  100000;
638
                else if ($algo == 'sha3-224')    return  100000;
639
                else if ($algo == 'sha512')      return  210000; // value by owasp.org cheatcheat (28 February 2023)
640
                else if ($algo == 'sha512/256')  return  210000; // value by owasp.org cheatcheat (28 February 2023)
641
                else if ($algo == 'sha512/224')  return  210000; // value by owasp.org cheatcheat (28 February 2023)
642
                else if ($algo == 'sha384')      return  600000;
643
                else if ($algo == 'sha256')      return  600000; // value by owasp.org cheatcheat (28 February 2023)
644
                else if ($algo == 'sha224')      return  600000;
645
                else if ($algo == 'sha1')        return 1300000; // value by owasp.org cheatcheat (28 February 2023)
646
                else if ($algo == 'md5')         return 5000000;
647
                else                             return    5000;
648
        }
649
}
63 daniel-mar 650
 
72 daniel-mar 651
// --- Part 6: Selftest
652
 
73 daniel-mar 653
/*
70 daniel-mar 654
for ($i=0; $i<9999; $i++) {
655
        assert($i===base64_int_decode(base64_int_encode($i,4)));
656
}
657
 
64 daniel-mar 658
$rnd = random_bytes_ex(50, true, true);
659
assert(crypt_radix64_decode(crypt_radix64_encode($rnd)) === $rnd);
63 daniel-mar 660
 
64 daniel-mar 661
$password = random_bytes_ex(20, false, true);
70 daniel-mar 662
 
663
assert(vts_password_verify($password,$dummy = vts_password_hash($password, PASSWORD_STD_DES)));
664
//echo "'$dummy' ".strlen($dummy)."\n";
665
//var_dump(vts_password_get_info($dummy));
666
 
667
assert(vts_password_verify($password,$dummy = vts_password_hash($password, PASSWORD_EXT_DES)));
668
//echo "'$dummy' ".strlen($dummy)."\n";
669
//var_dump(vts_password_get_info($dummy));
670
 
671
assert(vts_password_verify($password,$dummy = vts_password_hash($password, PASSWORD_MD5)));
672
//echo "'$dummy' ".strlen($dummy)."\n";
673
//var_dump(vts_password_get_info($dummy));
674
 
675
assert(vts_password_verify($password,$dummy = vts_password_hash($password, PASSWORD_BLOWFISH)));
676
//echo "'$dummy' ".strlen($dummy)."\n";
677
//var_dump(vts_password_get_info($dummy));
678
 
679
assert(vts_password_verify($password,$dummy = vts_password_hash($password, PASSWORD_SHA256)));
680
//echo "'$dummy' ".strlen($dummy)."\n";
681
//var_dump(vts_password_get_info($dummy));
682
 
683
assert(vts_password_verify($password,$dummy = vts_password_hash($password, PASSWORD_SHA512)));
684
//echo "'$dummy' ".strlen($dummy)."\n";
685
//var_dump(vts_password_get_info($dummy));
686
 
687
assert(vts_password_verify($password,$dummy = vts_password_hash($password, PASSWORD_VTS_MCF1, array(
65 daniel-mar 688
        'algo' => 'sha3-512',
689
        'mode' => 'pbkdf2',
70 daniel-mar 690
        'iterations' => 0
65 daniel-mar 691
))));
70 daniel-mar 692
//echo "'$dummy' ".strlen($dummy)."\n";
693
//var_dump(vts_password_get_info($dummy));
694
assert(false===vts_password_needs_rehash($dummy,PASSWORD_VTS_MCF1,array(
695
        'salt_length' => 51,
696
        'algo' => 'sha3-512',
697
        'mode' => 'pbkdf2',
698
        'iterations' => 0
699
)));
700
assert(true===vts_password_needs_rehash($dummy,PASSWORD_VTS_MCF1,array(
701
        'salt_length' => 50,
702
        'algo' => 'sha3-256',
703
        'mode' => 'pbkdf2',
704
        'iterations' => 0
705
)));
706
 
74 daniel-mar 707
assert(vts_password_verify($password,$dummy = vts_password_hash($password, PASSWORD_VTS_MCF1, array(
708
        'algo' => 'sha3-512',
709
        'mode' => 'sps',
710
        'iterations' => 2
711
))));
712
//echo "'$dummy' ".strlen($dummy)."\n";
713
//var_dump(vts_password_get_info($dummy));
714
assert(false===vts_password_needs_rehash($dummy,PASSWORD_VTS_MCF1,array(
715
        'salt_length' => 51,
716
        'algo' => 'sha3-512',
717
        'mode' => 'sps',
718
        'iterations' => 2
719
)));
720
assert(true===vts_password_needs_rehash($dummy,PASSWORD_VTS_MCF1,array(
721
        'salt_length' => 50,
722
        'algo' => 'sha3-256',
723
        'mode' => 'sps',
724
        'iterations' => 2
725
)));
726
 
727
assert(vts_password_verify($password,$dummy = vts_password_hash($password, PASSWORD_VTS_MCF1, array(
728
        'algo' => 'sha3-512',
729
        'mode' => 'hmac',
730
        'iterations' => 2
731
))));
732
//echo "'$dummy' ".strlen($dummy)."\n";
733
//var_dump(vts_password_get_info($dummy));
734
assert(false===vts_password_needs_rehash($dummy,PASSWORD_VTS_MCF1,array(
735
        'salt_length' => 51,
736
        'algo' => 'sha3-512',
737
        'mode' => 'hmac',
738
        'iterations' => 2
739
)));
740
assert(true===vts_password_needs_rehash($dummy,PASSWORD_VTS_MCF1,array(
741
        'salt_length' => 50,
742
        'algo' => 'sha3-256',
743
        'mode' => 'hmac',
744
        'iterations' => 2
745
)));
73 daniel-mar 746
*/