Commit 086103b
doc: show keylen in pbkdf2 as a byte length
Ensure that keylen for pbkdf2 is documented as a length of bytes and not
bits.
PR-URL: #3334
Reviewed-By: Fedor Indutny <fedor@indutny.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>1 parent 4c80c02 commit 086103b
1 file changed
Lines changed: 2 additions & 2 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -621,13 +621,13 @@ Example (obtaining a shared secret): | |||
| 621 | 621 | ## crypto.pbkdf2(password, salt, iterations, keylen[, digest], callback) | |
| 622 | 622 | ||
| 623 | 623 | Asynchronous PBKDF2 function. Applies the selected HMAC digest function | |
| 624 | - (default: SHA1) to derive a key of the requested length from the password, | ||
| 624 | + (default: SHA1) to derive a key of the requested byte length from the password, | ||
| 625 | 625 | salt and number of iterations. The callback gets two arguments: | |
| 626 | 626 | `(err, derivedKey)`. | |
| 627 | 627 | ||
| 628 | 628 | Example: | |
| 629 | 629 | ||
| 630 | - crypto.pbkdf2('secret', 'salt', 4096, 512, 'sha256', function(err, key) { | ||
| 630 | + crypto.pbkdf2('secret', 'salt', 4096, 64, 'sha256', function(err, key) { | ||
| 631 | 631 | if (err) | |
| 632 | 632 | throw err; | |
| 633 | 633 | console.log(key.toString('hex')); // 'c5e478d...1469e50' | |
0 commit comments