Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nodejs/node.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFilip Skokan <panva.ip@gmail.com>2021-08-29 11:09:48 +0300
committerFilip Skokan <panva.ip@gmail.com>2021-09-05 11:14:29 +0300
commitc6b0ae83e74199e8336ff23694530a5d9c77fc0a (patch)
treefbcdac3c0b6cdd60c134962cf8786da5d24f271d /doc
parent338ab0dfa0c99cb76032512b55baa6e3fede1a7b (diff)
crypto: add rsa-pss keygen parameters
PR-URL: https://github.com/nodejs/node/pull/39927 Reviewed-By: James M Snell <jasnell@gmail.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/api/crypto.md16
-rw-r--r--doc/api/deprecations.md13
2 files changed, 29 insertions, 0 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md
index 87a89652308..455692a254b 100644
--- a/doc/api/crypto.md
+++ b/doc/api/crypto.md
@@ -3375,6 +3375,10 @@ generateKey('hmac', { length: 64 }, (err, key) => {
<!-- YAML
added: v10.12.0
changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/39927
+ description: Add ability to define `RSASSA-PSS-params` sequence parameters
+ for RSA-PSS keys pairs.
- version:
- v13.9.0
- v12.17.0
@@ -3400,6 +3404,10 @@ changes:
* `options`: {Object}
* `modulusLength`: {number} Key size in bits (RSA, DSA).
* `publicExponent`: {number} Public exponent (RSA). **Default:** `0x10001`.
+ * `hashAlgorithm`: {string} Name of the message digest (RSA-PSS).
+ * `mgf1HashAlgorithm`: {string} Name of the message digest used by
+ MGF1 (RSA-PSS).
+ * `saltLength`: {number} Minimal salt length in bytes (RSA-PSS).
* `divisorLength`: {number} Size of `q` in bits (DSA).
* `namedCurve`: {string} Name of the curve to use (EC).
* `prime`: {Buffer} The prime parameter (DH).
@@ -3478,6 +3486,10 @@ a `Promise` for an `Object` with `publicKey` and `privateKey` properties.
<!-- YAML
added: v10.12.0
changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/39927
+ description: Add ability to define `RSASSA-PSS-params` sequence parameters
+ for RSA-PSS keys pairs.
- version:
- v13.9.0
- v12.17.0
@@ -3503,6 +3515,10 @@ changes:
* `options`: {Object}
* `modulusLength`: {number} Key size in bits (RSA, DSA).
* `publicExponent`: {number} Public exponent (RSA). **Default:** `0x10001`.
+ * `hashAlgorithm`: {string} Name of the message digest (RSA-PSS).
+ * `mgf1HashAlgorithm`: {string} Name of the message digest used by
+ MGF1 (RSA-PSS).
+ * `saltLength`: {number} Minimal salt length in bytes (RSA-PSS).
* `divisorLength`: {number} Size of `q` in bits (DSA).
* `namedCurve`: {string} Name of the curve to use (EC).
* `prime`: {Buffer} The prime parameter (DH).
diff --git a/doc/api/deprecations.md b/doc/api/deprecations.md
index f2668f9411a..aa4d0d024a4 100644
--- a/doc/api/deprecations.md
+++ b/doc/api/deprecations.md
@@ -2801,6 +2801,19 @@ non-number value for `hints` option, a non-nullish non-boolean value for `all`
option, or a non-nullish non-boolean value for `verbatim` option in
[`dns.lookup()`][] and [`dnsPromises.lookup()`][] is deprecated.
+### DEP0154: RSA-PSS generate key pair options
+<!-- YAML
+changes:
+ - version: REPLACEME
+ pr-url: https://github.com/nodejs/node/pull/39927
+ description: Documentation-only deprecation.
+-->
+
+Type: Documentation-only (supports [`--pending-deprecation`][])
+
+The `'hash'` and `'mgf1Hash'` options are replaced with `'hashAlgorithm'`
+and `'mgf1HashAlgorithm'`.
+
[Legacy URL API]: url.md#legacy-url-api
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
[RFC 6066]: https://tools.ietf.org/html/rfc6066#section-3