31 lines
1.6 KiB
Markdown
31 lines
1.6 KiB
Markdown
# pbkdf2
|
|
|
|
[](https://www.npmjs.org/package/pbkdf2)
|
|
[](https://travis-ci.org/crypto-browserify/pbkdf2)
|
|
[](https://david-dm.org/crypto-browserify/pbkdf2#info=dependencies)
|
|
|
|
[](https://github.com/feross/standard)
|
|
|
|
This library provides the functionality of PBKDF2 with the ability to use any supported hashing algorithm returned from `crypto.getHashes()`
|
|
|
|
|
|
## Usage
|
|
|
|
```js
|
|
var pbkdf2 = require('pbkdf2')
|
|
var derivedKey = pbkdf2.pbkdf2Sync('password', 'salt', 1, 32, 'sha512')
|
|
|
|
...
|
|
```
|
|
|
|
For more information on the API, please see the relevant [Node documentation](https://nodejs.org/api/crypto.html#crypto_crypto_pbkdf2_password_salt_iterations_keylen_digest_callback).
|
|
|
|
For high performance, use the `async` variant (`pbkdf2.pbkdf2`), not `pbkdf2.pbkdf2Sync`, this variant has the oppurtunity to use `window.crypto.subtle` when browserified.
|
|
|
|
|
|
## Credits
|
|
|
|
This module is a derivative of [cryptocoinjs/pbkdf2-sha256](https://github.com/cryptocoinjs/pbkdf2-sha256/), so thanks to [JP Richardson](https://github.com/jprichardson/) for laying the ground work.
|
|
|
|
Thank you to [FangDun Cai](https://github.com/fundon) for donating the package name on npm, if you're looking for his previous module it is located at [fundon/pbkdf2](https://github.com/fundon/pbkdf2).
|