Subversion Repositories php_utils

Rev

Rev 65 | Rev 67 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | RSS feed

  1. <?php
  2.  
  3. /*
  4.  * ViaThinkSoft Modular Crypt Format 1.0 / vts_password_hash() / vts_password_verify()
  5.  * Copyright 2023 Daniel Marschall, ViaThinkSoft
  6.  * Revision 2023-02-28
  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.  
  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.  
  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:
  32.         $1.3.6.1.4.1.37476.3.0.1.1$a=<algo>,m=<mode>$<salt>$<hash>
  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
  46. Valid <mode> :
  47.         sp = salt + password
  48.         ps = password + salt
  49.         sps = salt + password + salt
  50.         hmac = HMAC (salt is the key)
  51.         pbkdf2 = PBKDF2 (Additional param i= contains the number of iterations)
  52. Like most Crypt-hashes, <salt> and <hash> are Radix64 coded
  53. with alphabet './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz' and no padding.
  54. Link to the online specification:
  55.         https://oidplus.viathinksoft.com/oidplus/?goto=oid%3A1.3.6.1.4.1.37476.3.0.1.1
  56. Reference implementation in PHP:
  57.         https://github.com/danielmarschall/php_utils/blob/master/vts_crypt.inc.php
  58.  
  59. */
  60.  
  61. require_once __DIR__ . '/misc_functions.inc.php';
  62.  
  63. 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) }
  64.  
  65. // Valid algorithms for vts_password_hash():
  66. define('PASSWORD_STD_DES',   'std_des');       // Algorithm from crypt()
  67. define('PASSWORD_EXT_DES',   'ext_des');       // Algorithm from crypt()
  68. define('PASSWORD_MD5',       'md5');           // Algorithm from crypt()
  69. define('PASSWORD_BLOWFISH',  'blowfish');      // Algorithm from crypt()
  70. define('PASSWORD_SHA256',    'sha256');        // Algorithm from crypt()
  71. define('PASSWORD_SHA512',    'sha512');        // Algorithm from crypt()
  72. define('PASSWORD_VTS_MCF1',  OID_MCF_VTS_V1);  // Algorithm from ViaThinkSoft
  73. // Other valid values (already defined in PHP):
  74. // - PASSWORD_DEFAULT
  75. // - PASSWORD_BCRYPT
  76. // - PASSWORD_ARGON2I
  77. // - PASSWORD_ARGON2ID
  78.  
  79. // --- Part 1: Modular Crypt Format encode/decode
  80.  
  81. function crypt_modular_format_encode($id, $bin_salt, $bin_hash, $params=null) {
  82.         // $<id>[$<param>=<value>(,<param>=<value>)*][$<salt>[$<hash>]]
  83.         $out = '$'.$id;
  84.         if (!is_null($params)) {
  85.                 $ary_params = array();
  86.                 foreach ($params as $name => $value) {
  87.                         $ary_params[] = "$name=$value";
  88.                 }
  89.                 $out .= '$'.implode(',',$ary_params);
  90.         }
  91.         $out .= '$'.crypt_radix64_encode($bin_salt);
  92.         $out .= '$'.crypt_radix64_encode($bin_hash);
  93.         return $out;
  94. }
  95.  
  96. function crypt_modular_format_decode($mcf) {
  97.         $ary = explode('$', $mcf);
  98.  
  99.         $dummy = array_shift($ary);
  100.         if ($dummy !== '') return false;
  101.  
  102.         $dummy = array_shift($ary);
  103.         $id = $dummy;
  104.  
  105.         $params = array();
  106.         $dummy = array_shift($ary);
  107.         if (strpos($dummy, '=') !== false) {
  108.                 $params_ary = explode(',',$dummy);
  109.                 foreach ($params_ary as $param) {
  110.                         $bry = explode('=', $param, 2);
  111.                         if (count($bry) > 1) {
  112.                                 $params[$bry[0]] = $bry[1];
  113.                         }
  114.                 }
  115.         } else {
  116.                 array_unshift($ary, $dummy);
  117.         }
  118.  
  119.         if (count($ary) > 1) {
  120.                 $dummy = array_shift($ary);
  121.                 $bin_salt = crypt_radix64_decode($dummy);
  122.         } else {
  123.                 $bin_salt = '';
  124.         }
  125.  
  126.         $dummy = array_shift($ary);
  127.         $bin_hash = crypt_radix64_decode($dummy);
  128.  
  129.         return array('id' => $id, 'salt' => $bin_salt, 'hash' => $bin_hash, 'params' => $params);
  130. }
  131.  
  132. // --- Part 2: ViaThinkSoft Modular Crypt Format 1.0
  133.  
  134. function vts_crypt_version($hash) {
  135.         if (str_starts_with($hash, '$'.OID_MCF_VTS_V1.'$')) {
  136.                 return '1';
  137.         } else {
  138.                 return '0';
  139.         }
  140. }
  141.  
  142. function vts_crypt_hash($algo, $str_password, $str_salt, $ver='1', $mode='ps', $iterations=0/*default*/) {
  143.         if ($ver == '1') {
  144.                 if ($mode == 'sp') {
  145.                         $payload = $str_salt.$str_password;
  146.                         $algo_supported_natively = in_array($algo, hash_algos());
  147.                         if (!$algo_supported_natively && str_starts_with($algo, 'sha3-') && method_exists('\bb\Sha3\Sha3', 'hash')) {
  148.                                 $bits = explode('-',$algo)[1];
  149.                                 $bin_hash = \bb\Sha3\Sha3::hash($payload, $bits, true);
  150.                         } else {
  151.                                 $bin_hash = hash($algo, $payload, true);
  152.                         }
  153.                 } else if ($mode == 'ps') {
  154.                         $payload = $str_password.$str_salt;
  155.                         $algo_supported_natively = in_array($algo, hash_algos());
  156.                         if (!$algo_supported_natively && str_starts_with($algo, 'sha3-') && method_exists('\bb\Sha3\Sha3', 'hash')) {
  157.                                 $bits = explode('-',$algo)[1];
  158.                                 $bin_hash = \bb\Sha3\Sha3::hash($payload, $bits, true);
  159.                         } else {
  160.                                 $bin_hash = hash($algo, $payload, true);
  161.                         }
  162.                 } else if ($mode == 'sps') {
  163.                         $payload = $str_salt.$str_password.$str_salt;
  164.                         $algo_supported_natively = in_array($algo, hash_algos());
  165.                         if (!$algo_supported_natively && str_starts_with($algo, 'sha3-') && method_exists('\bb\Sha3\Sha3', 'hash')) {
  166.                                 $bits = explode('-',$algo)[1];
  167.                                 $bin_hash = \bb\Sha3\Sha3::hash($payload, $bits, true);
  168.                         } else {
  169.                                 $bin_hash = hash($algo, $payload, true);
  170.                         }
  171.                 } else if ($mode == 'hmac') {
  172.                         if (version_compare(PHP_VERSION, '7.2.0') >= 0) {
  173.                                 $algo_supported_natively = in_array($algo, hash_hmac_algos());
  174.                         } else {
  175.                                 $algo_supported_natively = in_array($algo, hash_algos());
  176.                         }
  177.                         if (!$algo_supported_natively && str_starts_with($algo, 'sha3-') && method_exists('\bb\Sha3\Sha3', 'hash_hmac')) {
  178.                                 $bits = explode('-',$algo)[1];
  179.                                 $bin_hash = \bb\Sha3\Sha3::hash_hmac($str_password, $str_salt, $bits, true);
  180.                         } else {
  181.                                 $bin_hash = hash_hmac($algo, $str_password, $str_salt, true);
  182.                         }
  183.                 } else if ($mode == 'pbkdf2') {
  184.                         $algo_supported_natively = in_array($algo, hash_algos());
  185.                         if (!$algo_supported_natively && str_starts_with($algo, 'sha3-') && method_exists('\bb\Sha3\Sha3', 'hash_pbkdf2')) {
  186.                                 if ($iterations == 0) {
  187.                                         $iterations = 2000; // because userland implementations are much slower, we must choose a small value...
  188.                                 }
  189.                                 $bits = explode('-',$algo)[1];
  190.                                 $bin_hash = \bb\Sha3\Sha3::hash_pbkdf2($str_password, $str_salt, $iterations, $bits, 0, true);
  191.                         } else {
  192.                                 if ($iterations == 0) {
  193.                                         // Recommendations taken from https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#pbkdf2
  194.                                         // I am not sure if these recommendations are correct. They write PBKDF2-HMAC-SHA1...
  195.                                         // Does this count for us, or does hash_pbkdf2() implement PBKDF2-SHA1 rather than PBKDF2-HMAC-SHA1?
  196.                                         if      ($algo == 'sha3-512')    $iterations =  100000;
  197.                                         else if ($algo == 'sha3-384')    $iterations =  100000;
  198.                                         else if ($algo == 'sha3-256')    $iterations =  100000;
  199.                                         else if ($algo == 'sha3-224')    $iterations =  100000;
  200.                                         else if ($algo == 'sha512')      $iterations =  210000; // value by owasp.org cheatcheat (28.02.2023)
  201.                                         else if ($algo == 'sha512/256')  $iterations =  210000; // value by owasp.org cheatcheat (28.02.2023)
  202.                                         else if ($algo == 'sha512/224')  $iterations =  210000; // value by owasp.org cheatcheat (28.02.2023)
  203.                                         else if ($algo == 'sha384')      $iterations =  600000;
  204.                                         else if ($algo == 'sha256')      $iterations =  600000; // value by owasp.org cheatcheat (28.02.2023)
  205.                                         else if ($algo == 'sha224')      $iterations =  600000;
  206.                                         else if ($algo == 'sha1')        $iterations = 1300000; // value by owasp.org cheatcheat (28.02.2023)
  207.                                         else if ($algo == 'md5')         $iterations = 5000000;
  208.                                         else                             $iterations =    5000;
  209.                                 }
  210.                                 $bin_hash = hash_pbkdf2($algo, $str_password, $str_salt, $iterations, 0, true);
  211.                         }
  212.                 } else {
  213.                         throw new Exception("Invalid VTS crypt version 1 mode. Expect sp, ps, sps, hmac, or pbkdf2.");
  214.                 }
  215.                 $bin_salt = $str_salt;
  216.                 $params = array();
  217.                 $params['a'] = $algo;
  218.                 $params['m'] = $mode;
  219.                 if ($mode == 'pbkdf2') $params['i'] = $iterations;
  220.                 return crypt_modular_format_encode(OID_MCF_VTS_V1, $bin_salt, $bin_hash, $params);
  221.         } else {
  222.                 throw new Exception("Invalid VTS crypt version, expect 1.");
  223.         }
  224. }
  225.  
  226. function vts_crypt_verify($password, $hash): bool {
  227.         $ver = vts_crypt_version($hash);
  228.         if ($ver == '1') {
  229.                 // Decode the MCF hash parameters
  230.                 $data = crypt_modular_format_decode($hash);
  231.                 if ($data === false) throw new Exception('Invalid auth key');
  232.                 $id = $data['id'];
  233.                 $bin_salt = $data['salt'];
  234.                 $bin_hash = $data['hash'];
  235.                 $params = $data['params'];
  236.  
  237.                 if (!isset($params['a'])) throw new Exception('Param "a" (algo) missing');
  238.                 $algo = $params['a'];
  239.  
  240.                 if (!isset($params['m'])) throw new Exception('Param "m" (mode) missing');
  241.                 $mode = $params['m'];
  242.  
  243.                 if ($mode == 'pbkdf2') {
  244.                         if (!isset($params['i'])) throw new Exception('Param "i" (iterations) missing');
  245.                         $iterations = $params['i'];
  246.                 } else {
  247.                         $iterations = 0;
  248.                 }
  249.  
  250.                 // Create a VTS MCF 1.0 hash based on the parameters of $hash and the password $password
  251.                 $calc_authkey_1 = vts_crypt_hash($algo, $password, $bin_salt, $ver, $mode, $iterations);
  252.  
  253.                 // We rewrite the MCF to make sure that they match (if params have the wrong order)
  254.                 $calc_authkey_2 = crypt_modular_format_encode($id, $bin_salt, $bin_hash, $params);
  255.  
  256.                 return hash_equals($calc_authkey_1, $calc_authkey_2);
  257.         } else {
  258.                 throw new Exception("Invalid VTS crypt version, expect 1.");
  259.         }
  260. }
  261.  
  262. // --- Part 3: vts_password_hash() and vts_password_verify()
  263.  
  264. /** This function extends password_verify() by adding ViaThinkSoft Modular Crypt Format 1.0.
  265.  * @param string $password to be checked
  266.  * @param string $hash Hash created by crypt(), password_hash(), or vts_password_hash().
  267.  * @return bool true if password is valid
  268.  */
  269. function vts_password_verify($password, $hash): bool {
  270.         if (vts_crypt_version($hash) != '0') {
  271.                 // Hash created by vts_password_hash(), or vts_crypt_hash()
  272.                 return vts_crypt_verify($password, $hash);
  273.         } else {
  274.                 // Hash created by vts_password_hash(), password_hash(), or crypt()
  275.                 return password_verify($password, $hash);
  276.         }
  277. }
  278.  
  279. /** This function extends password_hash() with the algorithms supported by crypt().
  280.  * It also adds vts_crypt_hash() which implements the ViaThinkSoft Modular Crypt Format 1.0.
  281.  * The result can be verified using vts_password_verify().
  282.  * @param string $password to be hashed
  283.  * @param mixed $algo algorithm
  284.  * @param array $options options for the hashing algorithm
  285.  * @return string Crypt style password hash
  286.  */
  287. function vts_password_hash($password, $algo, $options=array()): string {
  288.         $crypt_salt = null;
  289.         if (($algo === PASSWORD_STD_DES) && defined('CRYPT_STD_DES')) {
  290.                 // 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.
  291.                 $crypt_salt = des_compat_salt(2);
  292.         } else if (($algo === PASSWORD_EXT_DES) && defined('CRYPT_EXT_DES')) {
  293.                 // 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.
  294.                 $iterations = isset($options['iterations']) ? $options['iterations'] : 725;
  295.                 $crypt_salt = '_' . base64_int_encode($iterations) . des_compat_salt(4);
  296.         } else if (($algo === PASSWORD_MD5) && defined('CRYPT_MD5')) {
  297.                 // MD5 hashing with a twelve character salt starting with $1$
  298.                 $crypt_salt = '$1$'.des_compat_salt(12).'$';
  299.         } else if (($algo === PASSWORD_BLOWFISH) && defined('CRYPT_BLOWFISH')) {
  300.                 // 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.
  301.                 $algo = '$2y$'; // most secure
  302.                 $cost = isset($options['cost']) ? $options['cost'] : 10;
  303.                 $crypt_salt = $algo.str_pad($cost,2,'0',STR_PAD_LEFT).'$'.des_compat_salt(22).'$';
  304.         } else if (($algo === PASSWORD_SHA256) && defined('CRYPT_SHA256')) {
  305.                 // 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.
  306.                 $algo = '$5$';
  307.                 $rounds = isset($options['rounds']) ? $options['rounds'] : 5000;
  308.                 $crypt_salt = $algo.'rounds='.$rounds.'$'.des_compat_salt(16).'$';
  309.         } else if (($algo === PASSWORD_SHA512) && defined('CRYPT_SHA512')) {
  310.                 // 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.
  311.                 $algo = '$6$';
  312.                 $rounds = isset($options['rounds']) ? $options['rounds'] : 5000;
  313.                 $crypt_salt = $algo.'rounds='.$rounds.'$'.des_compat_salt(16).'$';
  314.         }
  315.  
  316.         if (!is_null($crypt_salt)) {
  317.                 // Algorithms: PASSWORD_STD_DES
  318.                 //             PASSWORD_EXT_DES
  319.                 //             PASSWORD_MD5
  320.                 //             PASSWORD_BLOWFISH
  321.                 //             PASSWORD_SHA256
  322.                 //             PASSWORD_SHA512
  323.                 $out = crypt($password, $crypt_salt);
  324.                 if (strlen($out) < 13) throw new Exception("crypt() failed");
  325.                 return $out;
  326.         } else if ($algo === PASSWORD_VTS_MCF1) {
  327.                 // Algorithms: PASSWORD_VTS_MCF1
  328.                 $ver  = '1';
  329.                 $algo = isset($options['algo']) ? $options['algo'] : 'sha3-512';
  330.                 $mode = isset($options['mode']) ? $options['mode'] : 'ps';
  331.                 $iterations = isset($options['iterations']) ? $options['iterations'] : 0/*default*/;
  332.                 $salt_len = isset($options['salt_length']) ? $options['salt_length'] : 50;
  333.                 $salt = random_bytes_ex($salt_len, true, true);
  334.                 return vts_crypt_hash($algo, $password, $salt, $ver, $mode, $iterations);
  335.         } else {
  336.                 // Algorithms: PASSWORD_DEFAULT
  337.                 //             PASSWORD_BCRYPT
  338.                 //             PASSWORD_ARGON2I
  339.                 //             PASSWORD_ARGON2ID
  340.                 return password_hash($password, $algo, $options);
  341.         }
  342. }
  343.  
  344. // --- Part 4: Useful functions required by the crypt-functions
  345.  
  346. define('BASE64_RFC4648_ALPHABET', '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+/');
  347. define('BASE64_CRYPT_ALPHABET',   './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz');
  348.  
  349. function des_compat_salt($salt_len) {
  350.         if ($salt_len <= 0) return '';
  351.         $characters = BASE64_CRYPT_ALPHABET;
  352.         $salt = '';
  353.         $bytes = random_bytes_ex($salt_len, true, true);
  354.         for ($i=0; $i<$salt_len; $i++) {
  355.                 $salt .= $characters[ord($bytes[$i]) % strlen($characters)];
  356.         }
  357.         return $salt;
  358. }
  359.  
  360. function base64_int_encode($num) {
  361.         // https://stackoverflow.com/questions/15534982/which-iteration-rules-apply-on-crypt-using-crypt-ext-des
  362.         $alphabet_raw = BASE64_CRYPT_ALPHABET;
  363.         $alphabet = str_split($alphabet_raw);
  364.         $arr = array();
  365.         $base = sizeof($alphabet);
  366.         while ($num) {
  367.                 $rem = $num % $base;
  368.                 $num = (int)($num / $base);
  369.                 $arr[] = $alphabet[$rem];
  370.         }
  371.         $string = implode($arr);
  372.         return str_pad($string, 4, '.', STR_PAD_RIGHT);
  373. }
  374.  
  375. function crypt_radix64_encode($str) {
  376.         $x = $str;
  377.         $x = base64_encode($x);
  378.         $x = rtrim($x, '='); // remove padding
  379.         $x = strtr($x, BASE64_RFC4648_ALPHABET, BASE64_CRYPT_ALPHABET);
  380.         return $x;
  381. }
  382.  
  383. function crypt_radix64_decode($str) {
  384.         $x = $str;
  385.         $x = strtr($x, BASE64_CRYPT_ALPHABET, BASE64_RFC4648_ALPHABET);
  386.         $x = base64_decode($x);
  387.         return $x;
  388. }
  389.  
  390. // --- Part 5: Selftest
  391.  
  392. /*
  393. $rnd = random_bytes_ex(50, true, true);
  394. assert(crypt_radix64_decode(crypt_radix64_encode($rnd)) === $rnd);
  395.  
  396. $password = random_bytes_ex(20, false, true);
  397. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_STD_DES)));
  398. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_EXT_DES)));
  399. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_MD5)));
  400. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_BLOWFISH)));
  401. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_SHA256)));
  402. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_SHA512)));
  403. assert(vts_password_verify($password,$debug = vts_password_hash($password, PASSWORD_VTS_MCF1, array(
  404.         'algo' => 'sha3-512',
  405.         'mode' => 'pbkdf2',
  406.         'iterations' => 5000
  407. ))));
  408. echo "$debug\n";
  409. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_DEFAULT)));
  410. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_BCRYPT)));
  411. if (defined('PASSWORD_ARGON2I'))
  412.         assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_ARGON2I)));
  413. if (defined('PASSWORD_ARGON2ID'))
  414.         assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_ARGON2ID)));
  415. echo "OK, Password $password\n";
  416. */
  417.