kdf-salt

Latest version on npm Downloads on npm Project license
Lint status Test macOS status Test Ubuntu status Test Windows status
Codecov Coverage report Known Vulnerabilities Dependency Status
XO Code Style used AVA Test Runner used Istanbul Test Coverage used NI Scaffolding System used NP Release System used

🎲 Crypto secure salt generator
Coded with ❤️ by Simone Primarosa.

## Install ```bash npm install --save @kdf/salt ``` ## Usage ```js const gensalt = require('@kdf/salt'); gensalt(16).then(salt => { console.log(salt); // => 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 | Param | Type | Description | | --- | --- | --- | | length | number | The 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][new issue]. ## Authors - **Simone Primarosa** - *Github* ([@simonepri][github:simonepri]) • *Twitter* ([@simoneprimarosa][twitter:simoneprimarosa]) See also the list of [contributors][contributors] who participated in this project. ## License This project is licensed under the MIT License - see the [license][license] file for details. [new issue]: https://github.com/simonepri/node-kdf/issues/new [contributors]: https://github.com/simonepri/node-kdf/contributors [license]: https://github.com/simonepri/node-kdf/blob/master/packages/salt/license [github:simonepri]: https://github.com/simonepri [twitter:simoneprimarosa]: http://twitter.com/intent/user?screen_name=simoneprimarosa