Source: digest/index.js

  1. /**
  2.  * @module digest
  3.  */
  4. const crypto = require("crypto");
  6. /**
  7.  * Generate a secure random salt of schema defined length
  8.  * (256-bits) and return value in hex.
  9.  * @return {hex} 32-byte salt in hex
  10.  */
  11. function generateSecureSaltInHex() {
  12.     return generateSecureRandomBytesInHex(32);
  13. }
  15. /**
  16.  * Generate a secure random salt of schema defined length
  17.  * (256-bits) and return value in Base64.
  18.  * @return {base64} 32-byte salt in base64
  19.  */
  20. function generateSecureSaltInBase64() {
  21.     return generateSecureRandomBytesInBase64(32);
  22. }
  24. /**
  25.  * Generate secure random bytes of given size
  26.  * and return value in hex.
  27.  * @param {number} size in bytes
  28.  * @return {string} random bytes in hex
  29.  */
  30. const generateSecureRandomBytesInHex = (size) => {
  31.     return crypto.randomBytes(size).toString("hex");
  32. };
  34. /**
  35.  * Generate secure random bytes of given size
  36.  * and return value in Base64.
  37.  * @param {number} size in bytes
  38.  * @return {string} random bytes in base64
  39.  */
  40. const generateSecureRandomBytesInBase64 = (size) => {
  41.     return crypto.randomBytes(size).toString("base64");
  42. };
  44. /**
  45.  * Hashes the given password and salt concatenated with the
  46.  * SHA-256 crypto standard hash function and returns the value in hex.
  47.  * @param {string} password
  48.  * @param {hex} secureSalt
  49.  * @return {hex} 32-byte hash in hex
  50.  */
  51. function hashPassWithSaltInHex(password, secureSalt) {
  52.     return hashVarargInHex(password, secureSalt);
  53. }
  55. /**
  56.  * Hashes the given password and salt concatenated with the
  57.  * SHA-256 crypto standard hash function and returns the value in Base64.
  58.  * @param {string} password
  59.  * @param {base64} secureSalt
  60.  * @return {base64} 32-byte hash in Base64
  61.  */
  62. function hashPassWithSaltInBase64(password, secureSalt) {
  63.     return hashVarargInBase64(password, secureSalt);
  64. }
  66. /**
  67.  * Hash a variable number of arguments concatenated
  68.  * with the SHA-256 crypto standard hash function and
  69.  * return result in hex.
  70.  * @param  {...any} args
  71.  * @return {digest} Sha-256 hash in hex
  72.  */
  73. function hashVarargInHex(...args) {
  74.     return hashInput(args.join("")).digest("hex");
  75. }
  77. /**
  78.  * Hash a variable number of arguments concatenated
  79.  * with the SHA-256 crypto standard hash function and
  80.  * return result in Base64.
  81.  * @param  {...any} args
  82.  * @return {digest} Sha-256 hash in Base64
  83.  */
  84. function hashVarargInBase64(...args) {
  85.     return hashInput(args.join("")).digest("base64");
  86. }
  88. /**
  89.  * Hash a variable number of arguments concatenated
  90.  * with the SHA-256 crypto standard hash function and
  91.  * return result.
  92.  * @param  {any} input
  93.  * @return {digest} Sha-256 hash
  94.  */
  95. function hashInput(input) {
  96.     return crypto
  97.         .createHash("sha256")
  98.         .update(input);
  99. }
  101. module.exports = {
  102.     generateSecureRandomBytesInHex,
  103.     generateSecureRandomBytesInBase64,
  104.     generateSecureSaltInHex,
  105.     generateSecureSaltInBase64,
  106.     hashPassWithSaltInHex,
  107.     hashPassWithSaltInBase64,
  108.     hashVarargInHex,
  109.     hashVarargInBase64,
  110. };