Subversion Repositories php_utils

Rev

Rev 64 | Rev 66 | 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 && ($algo === 'sha3-512') && function_exists('sha3_512')) {
  148.                                 $bin_hash = sha3_512($payload, true);
  149.                         } else {
  150.                                 $bin_hash = hash($algo, $payload, true);
  151.                         }
  152.                 } else if ($mode == 'ps') {
  153.                         $payload = $str_password.$str_salt;
  154.                         $algo_supported_natively = in_array($algo, hash_algos());
  155.                         if (!$algo_supported_natively && ($algo === 'sha3-512') && function_exists('sha3_512')) {
  156.                                 $bin_hash = sha3_512($payload, true);
  157.                         } else {
  158.                                 $bin_hash = hash($algo, $payload, true);
  159.                         }
  160.                 } else if ($mode == 'sps') {
  161.                         $payload = $str_salt.$str_password.$str_salt;
  162.                         $algo_supported_natively = in_array($algo, hash_algos());
  163.                         if (!$algo_supported_natively && ($algo === 'sha3-512') && function_exists('sha3_512')) {
  164.                                 $bin_hash = sha3_512($payload, true);
  165.                         } else {
  166.                                 $bin_hash = hash($algo, $payload, true);
  167.                         }
  168.                 } else if ($mode == 'hmac') {
  169.                         if (version_compare(PHP_VERSION, '7.2.0') >= 0) {
  170.                                 $algo_supported_natively = in_array($algo, hash_hmac_algos());
  171.                         } else {
  172.                                 $algo_supported_natively = in_array($algo, hash_algos());
  173.                         }
  174.                         if (!$algo_supported_natively && ($algo === 'sha3-512') && function_exists('sha3_512_hmac')) {
  175.                                 $bin_hash = sha3_512_hmac($str_password, $str_salt, true);
  176.                         } else {
  177.                                 $bin_hash = hash_hmac($algo, $str_password, $str_salt, true);
  178.                         }
  179.                 } else if ($mode == 'pbkdf2') {
  180.                         if ($iterations == 0) {
  181.                                 // TODO: Find good value for iterations, see https://cheatsheetseries.owasp.org/cheatsheets/Password_Storage_Cheat_Sheet.html#pbkdf2
  182.                                 $iterations = 500000;
  183.                         }
  184.                         $algo_supported_natively = in_array($algo, hash_algos());
  185.                         if (!$algo_supported_natively && ($algo === 'sha3-512') && function_exists('sha3_512_pbkdf2')) {
  186.                                 $bin_hash = sha3_512_pbkdf2($str_password, $str_salt, $iterations, 0, true);
  187.                         } else {
  188.                                 $bin_hash = hash_pbkdf2($algo, $str_password, $str_salt, $iterations, 0, true);
  189.                         }
  190.                 } else {
  191.                         throw new Exception("Invalid VTS crypt version 1 mode. Expect sp, ps, sps, hmac, or pbkdf2.");
  192.                 }
  193.                 $bin_salt = $str_salt;
  194.                 $params = array();
  195.                 $params['a'] = $algo;
  196.                 $params['m'] = $mode;
  197.                 if ($mode == 'pbkdf2') $params['i'] = $iterations;
  198.                 return crypt_modular_format_encode(OID_MCF_VTS_V1, $bin_salt, $bin_hash, $params);
  199.         } else {
  200.                 throw new Exception("Invalid VTS crypt version, expect 1.");
  201.         }
  202. }
  203.  
  204. function vts_crypt_verify($password, $hash): bool {
  205.         $ver = vts_crypt_version($hash);
  206.         if ($ver == '1') {
  207.                 // Decode the MCF hash parameters
  208.                 $data = crypt_modular_format_decode($hash);
  209.                 if ($data === false) throw new Exception('Invalid auth key');
  210.                 $id = $data['id'];
  211.                 $bin_salt = $data['salt'];
  212.                 $bin_hash = $data['hash'];
  213.                 $params = $data['params'];
  214.  
  215.                 if (!isset($params['a'])) throw new Exception('Param "a" (algo) missing');
  216.                 $algo = $params['a'];
  217.  
  218.                 if (!isset($params['m'])) throw new Exception('Param "m" (mode) missing');
  219.                 $mode = $params['m'];
  220.  
  221.                 if (($mode == 'pbkdf2') && !isset($params['i'])) throw new Exception('Param "i" (iterations) missing');
  222.                 $iterations = $params['i'];
  223.  
  224.                 // Create a VTS MCF 1.0 hash based on the parameters of $hash and the password $password
  225.                 $calc_authkey_1 = vts_crypt_hash($algo, $password, $bin_salt, $ver, $mode, $iterations);
  226.  
  227.                 // We rewrite the MCF to make sure that they match (if params have the wrong order)
  228.                 $calc_authkey_2 = crypt_modular_format_encode($id, $bin_salt, $bin_hash, $params);
  229.  
  230.                 return hash_equals($calc_authkey_1, $calc_authkey_2);
  231.         } else {
  232.                 throw new Exception("Invalid VTS crypt version, expect 1.");
  233.         }
  234. }
  235.  
  236. // --- Part 3: vts_password_hash() and vts_password_verify()
  237.  
  238. /** This function extends password_verify() by adding ViaThinkSoft Modular Crypt Format 1.0.
  239.  * @param string $password to be checked
  240.  * @param string $hash Hash created by crypt(), password_hash(), or vts_password_hash().
  241.  * @return bool true if password is valid
  242.  */
  243. function vts_password_verify($password, $hash): bool {
  244.         if (vts_crypt_version($hash) != '0') {
  245.                 // Hash created by vts_password_hash(), or vts_crypt_hash()
  246.                 return vts_crypt_verify($password, $hash);
  247.         } else {
  248.                 // Hash created by vts_password_hash(), password_hash(), or crypt()
  249.                 return password_verify($password, $hash);
  250.         }
  251. }
  252.  
  253. /** This function extends password_hash() with the algorithms supported by crypt().
  254.  * It also adds vts_crypt_hash() which implements the ViaThinkSoft Modular Crypt Format 1.0.
  255.  * The result can be verified using vts_password_verify().
  256.  * @param string $password to be hashed
  257.  * @param mixed $algo algorithm
  258.  * @param array $options options for the hashing algorithm
  259.  * @return string Crypt style password hash
  260.  */
  261. function vts_password_hash($password, $algo, $options=array()): string {
  262.         $crypt_salt = null;
  263.         if (($algo === PASSWORD_STD_DES) && defined('CRYPT_STD_DES')) {
  264.                 // 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.
  265.                 $crypt_salt = des_compat_salt(2);
  266.         } else if (($algo === PASSWORD_EXT_DES) && defined('CRYPT_EXT_DES')) {
  267.                 // 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.
  268.                 $iterations = isset($options['iterations']) ? $options['iterations'] : 725;
  269.                 $crypt_salt = '_' . base64_int_encode($iterations) . des_compat_salt(4);
  270.         } else if (($algo === PASSWORD_MD5) && defined('CRYPT_MD5')) {
  271.                 // MD5 hashing with a twelve character salt starting with $1$
  272.                 $crypt_salt = '$1$'.des_compat_salt(12).'$';
  273.         } else if (($algo === PASSWORD_BLOWFISH) && defined('CRYPT_BLOWFISH')) {
  274.                 // 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.
  275.                 $algo = '$2y$'; // most secure
  276.                 $cost = isset($options['cost']) ? $options['cost'] : 10;
  277.                 $crypt_salt = $algo.str_pad($cost,2,'0',STR_PAD_LEFT).'$'.des_compat_salt(22).'$';
  278.         } else if (($algo === PASSWORD_SHA256) && defined('CRYPT_SHA256')) {
  279.                 // 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.
  280.                 $algo = '$5$';
  281.                 $rounds = isset($options['rounds']) ? $options['rounds'] : 5000;
  282.                 $crypt_salt = $algo.'rounds='.$rounds.'$'.des_compat_salt(16).'$';
  283.         } else if (($algo === PASSWORD_SHA512) && defined('CRYPT_SHA512')) {
  284.                 // 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.
  285.                 $algo = '$6$';
  286.                 $rounds = isset($options['rounds']) ? $options['rounds'] : 5000;
  287.                 $crypt_salt = $algo.'rounds='.$rounds.'$'.des_compat_salt(16).'$';
  288.         }
  289.  
  290.         if (!is_null($crypt_salt)) {
  291.                 // Algorithms: PASSWORD_STD_DES
  292.                 //             PASSWORD_EXT_DES
  293.                 //             PASSWORD_MD5
  294.                 //             PASSWORD_BLOWFISH
  295.                 //             PASSWORD_SHA256
  296.                 //             PASSWORD_SHA512
  297.                 $out = crypt($password, $crypt_salt);
  298.                 if (strlen($out) < 13) throw new Exception("crypt() failed");
  299.                 return $out;
  300.         } else if ($algo === PASSWORD_VTS_MCF1) {
  301.                 // Algorithms: PASSWORD_VTS_MCF1
  302.                 $ver  = '1';
  303.                 $algo = isset($options['algo']) ? $options['algo'] : 'sha3-512';
  304.                 $mode = isset($options['mode']) ? $options['mode'] : 'ps';
  305.                 $iterations = isset($options['iterations']) ? $options['iterations'] : 0/*default*/;
  306.                 $salt_len = isset($options['salt_length']) ? $options['salt_length'] : 50;
  307.                 $salt = random_bytes_ex($salt_len, true, true);
  308.                 return vts_crypt_hash($algo, $password, $salt, $ver, $mode, $iterations);
  309.         } else {
  310.                 // Algorithms: PASSWORD_DEFAULT
  311.                 //             PASSWORD_BCRYPT
  312.                 //             PASSWORD_ARGON2I
  313.                 //             PASSWORD_ARGON2ID
  314.                 return password_hash($password, $algo, $options);
  315.         }
  316. }
  317.  
  318. // --- Part 4: Useful functions required by the crypt-functions
  319.  
  320. define('BASE64_RFC4648_ALPHABET', '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz+/');
  321. define('BASE64_CRYPT_ALPHABET',   './0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz');
  322.  
  323. function des_compat_salt($salt_len) {
  324.         if ($salt_len <= 0) return '';
  325.         $characters = BASE64_CRYPT_ALPHABET;
  326.         $salt = '';
  327.         $bytes = random_bytes_ex($salt_len, true, true);
  328.         for ($i=0; $i<$salt_len; $i++) {
  329.                 $salt .= $characters[ord($bytes[$i]) % strlen($characters)];
  330.         }
  331.         return $salt;
  332. }
  333.  
  334. function base64_int_encode($num) {
  335.         // https://stackoverflow.com/questions/15534982/which-iteration-rules-apply-on-crypt-using-crypt-ext-des
  336.         $alphabet_raw = BASE64_CRYPT_ALPHABET;
  337.         $alphabet = str_split($alphabet_raw);
  338.         $arr = array();
  339.         $base = sizeof($alphabet);
  340.         while ($num) {
  341.                 $rem = $num % $base;
  342.                 $num = (int)($num / $base);
  343.                 $arr[] = $alphabet[$rem];
  344.         }
  345.         $string = implode($arr);
  346.         return str_pad($string, 4, '.', STR_PAD_RIGHT);
  347. }
  348.  
  349. function crypt_radix64_encode($str) {
  350.         $x = $str;
  351.         $x = base64_encode($x);
  352.         $x = rtrim($x, '='); // remove padding
  353.         $x = strtr($x, BASE64_RFC4648_ALPHABET, BASE64_CRYPT_ALPHABET);
  354.         return $x;
  355. }
  356.  
  357. function crypt_radix64_decode($str) {
  358.         $x = $str;
  359.         $x = strtr($x, BASE64_CRYPT_ALPHABET, BASE64_RFC4648_ALPHABET);
  360.         $x = base64_decode($x);
  361.         return $x;
  362. }
  363.  
  364. // --- Part 5: Selftest
  365.  
  366. /*
  367. $rnd = random_bytes_ex(50, true, true);
  368. assert(crypt_radix64_decode(crypt_radix64_encode($rnd)) === $rnd);
  369.  
  370. $password = random_bytes_ex(20, false, true);
  371. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_STD_DES)));
  372. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_EXT_DES)));
  373. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_MD5)));
  374. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_BLOWFISH)));
  375. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_SHA256)));
  376. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_SHA512)));
  377. assert(vts_password_verify($password,$debug = vts_password_hash($password, PASSWORD_VTS_MCF1, array(
  378.         'algo' => 'sha3-512',
  379.         'mode' => 'pbkdf2',
  380.         'iterations' => 5000
  381. ))));
  382. echo "$debug\n";
  383. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_DEFAULT)));
  384. assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_BCRYPT)));
  385. if (defined('PASSWORD_ARGON2I'))
  386.         assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_ARGON2I)));
  387. if (defined('PASSWORD_ARGON2ID'))
  388.         assert(vts_password_verify($password,vts_password_hash($password, PASSWORD_ARGON2ID)));
  389. echo "OK, Password $password\n";
  390. */
  391.