2.0.1 • Published 4 years ago

@kdf/salt v2.0.1

Weekly downloads
2,279
License
MIT
Repository
github
Last release
4 years ago

Install

npm install --save @kdf/salt

Usage

const gensalt = require('@kdf/salt');

gensalt(16).then(salt => {
  console.log(salt);
  // => <Buffer 70 2c 6e 1c c1 07 2e 26 dc 82 52 4e 1b cf 1d 23>
  console.log(salt.toString('base64'));
  // => cCxuHMEHLibcglJOG88dIw==
  console.log(salt.toString('hex'));
  // => 702c6e1cc1072e26dc82524e1bcf1d23
})

API

gensalt(length) ⇒ Promise.<Buffer>

Generates a cryptographically secure random string to be used as a password salt , using Node's built-in crypto.randomBytes() function.

Kind: global function
Returns: Promise.<Buffer> - The salt as a Buffer.
Access: public

ParamTypeDescription
lengthnumberThe length of the salt to be generated. Must be an integer within the range (0 <= length <= 2^31-1).

Contributing

Contributions are REALLY welcome and if you find a security flaw in this code, PLEASE report it.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the license file for details.