diff options
author | Anna Henningsen <anna@addaleax.net> | 2018-06-25 17:40:59 +0200 |
---|---|---|
committer | Anna Henningsen <anna@addaleax.net> | 2018-07-18 14:18:01 +0200 |
commit | e9b22e9569008de8485ece22bcbb2ce8b143d4b2 (patch) | |
tree | e331e384c7875b9a4d01c152e995af2aabb8547b /doc | |
parent | 07c514ce29ffb1875b62ad5cbf056b33b7fdc9e5 (diff) | |
download | android-node-v8-e9b22e9569008de8485ece22bcbb2ce8b143d4b2.tar.gz android-node-v8-e9b22e9569008de8485ece22bcbb2ce8b143d4b2.tar.bz2 android-node-v8-e9b22e9569008de8485ece22bcbb2ce8b143d4b2.zip |
crypto: add better scrypt option aliases
Make parameter names available in a human-readable way, for
more accessible/self-documenting usage of the `scrypt` functions.
This implements a review comment from the original PR that has
not been addressed.
Refs: https://github.com/nodejs/node/pull/20816#discussion_r189220776
PR-URL: https://github.com/nodejs/node/pull/21525
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r-- | doc/api/crypto.md | 28 |
1 files changed, 22 insertions, 6 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index a0fbb30bcd..0e038d93e3 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -2137,15 +2137,23 @@ request. ### crypto.scrypt(password, salt, keylen[, options], callback) <!-- YAML added: v10.5.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/XXX + description: The `cost`, `blockSize` and `parallelization` option names + have been added. --> * `password` {string|Buffer|TypedArray|DataView} * `salt` {string|Buffer|TypedArray|DataView} * `keylen` {number} * `options` {Object} - - `N` {number} CPU/memory cost parameter. Must be a power of two greater + - `cost` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`. - - `r` {number} Block size parameter. **Default:** `8`. - - `p` {number} Parallelization parameter. **Default:** `1`. + - `blockSize` {number} Block size parameter. **Default:** `8`. + - `parallelization` {number} Parallelization parameter. **Default:** `1`. + - `N` {number} Alias for `cost`. Only one of both may be specified. + - `r` {number} Alias for `blockSize`. Only one of both may be specified. + - `p` {number} Alias for `parallelization`. Only one of both may be specified. - `maxmem` {number} Memory upper bound. It is an error when (approximately) `128 * N * r > maxmem`. **Default:** `32 * 1024 * 1024`. * `callback` {Function} @@ -2183,15 +2191,23 @@ crypto.scrypt('secret', 'salt', 64, { N: 1024 }, (err, derivedKey) => { ### crypto.scryptSync(password, salt, keylen[, options]) <!-- YAML added: v10.5.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/XXX + description: The `cost`, `blockSize` and `parallelization` option names + have been added. --> * `password` {string|Buffer|TypedArray|DataView} * `salt` {string|Buffer|TypedArray|DataView} * `keylen` {number} * `options` {Object} - - `N` {number} CPU/memory cost parameter. Must be a power of two greater + - `cost` {number} CPU/memory cost parameter. Must be a power of two greater than one. **Default:** `16384`. - - `r` {number} Block size parameter. **Default:** `8`. - - `p` {number} Parallelization parameter. **Default:** `1`. + - `blockSize` {number} Block size parameter. **Default:** `8`. + - `parallelization` {number} Parallelization parameter. **Default:** `1`. + - `N` {number} Alias for `cost`. Only one of both may be specified. + - `r` {number} Alias for `blockSize`. Only one of both may be specified. + - `p` {number} Alias for `parallelization`. Only one of both may be specified. - `maxmem` {number} Memory upper bound. It is an error when (approximately) `128 * N * r > maxmem`. **Default:** `32 * 1024 * 1024`. * Returns: {Buffer} |