diff options
author | Tobias Nießen <tniessen@users.noreply.github.com> | 2021-08-31 22:52:31 +0300 |
---|---|---|
committer | Filip Skokan <panva.ip@gmail.com> | 2021-09-01 09:20:19 +0300 |
commit | 6155499252199d12f1577c6e9321008e6cd9e89d (patch) | |
tree | aefbaacf05b60c16079395407feac9975492949b /doc/api | |
parent | 5b2ab7a75bd1fcb8093ead26a0d041763ecdf465 (diff) |
doc: add missing changes to generateKeyPair(Sync)
Refs: https://github.com/nodejs/node/pull/26774
Refs: https://github.com/nodejs/node/pull/26960
PR-URL: https://github.com/nodejs/node/pull/39963
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Diffstat (limited to 'doc/api')
-rw-r--r-- | doc/api/crypto.md | 25 |
1 files changed, 17 insertions, 8 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index c1836cf634c..87a89652308 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -3381,6 +3381,9 @@ changes: pr-url: https://github.com/nodejs/node/pull/31178 description: Add support for Diffie-Hellman. - version: v12.0.0 + pr-url: https://github.com/nodejs/node/pull/26960 + description: Add support for RSA-PSS key pairs. + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26774 description: Add ability to generate X25519 and X448 key pairs. - version: v12.0.0 @@ -3392,8 +3395,8 @@ changes: produce key objects if no encoding was specified. --> -* `type`: {string} Must be `'rsa'`, `'dsa'`, `'ec'`, `'ed25519'`, `'ed448'`, - `'x25519'`, `'x448'`, or `'dh'`. +* `type`: {string} Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`, + `'ed448'`, `'x25519'`, `'x448'`, or `'dh'`. * `options`: {Object} * `modulusLength`: {number} Key size in bits (RSA, DSA). * `publicExponent`: {number} Public exponent (RSA). **Default:** `0x10001`. @@ -3411,8 +3414,8 @@ changes: * `publicKey`: {string | Buffer | KeyObject} * `privateKey`: {string | Buffer | KeyObject} -Generates a new asymmetric key pair of the given `type`. RSA, DSA, EC, Ed25519, -Ed448, X25519, X448, and DH are currently supported. +Generates a new asymmetric key pair of the given `type`. RSA, RSA-PSS, DSA, EC, +Ed25519, Ed448, X25519, X448, and DH are currently supported. If a `publicKeyEncoding` or `privateKeyEncoding` was specified, this function behaves as if [`keyObject.export()`][] had been called on its result. Otherwise, @@ -3481,6 +3484,12 @@ changes: pr-url: https://github.com/nodejs/node/pull/31178 description: Add support for Diffie-Hellman. - version: v12.0.0 + pr-url: https://github.com/nodejs/node/pull/26960 + description: Add support for RSA-PSS key pairs. + - version: v12.0.0 + pr-url: https://github.com/nodejs/node/pull/26774 + description: Add ability to generate X25519 and X448 key pairs. + - version: v12.0.0 pr-url: https://github.com/nodejs/node/pull/26554 description: Add ability to generate Ed25519 and Ed448 key pairs. - version: v11.6.0 @@ -3489,8 +3498,8 @@ changes: produce key objects if no encoding was specified. --> -* `type`: {string} Must be `'rsa'`, `'dsa'`, `'ec'`, `'ed25519'`, `'ed448'`, - `'x25519'`, `'x448'`, or `'dh'`. +* `type`: {string} Must be `'rsa'`, `'rsa-pss'`, `'dsa'`, `'ec'`, `'ed25519'`, + `'ed448'`, `'x25519'`, `'x448'`, or `'dh'`. * `options`: {Object} * `modulusLength`: {number} Key size in bits (RSA, DSA). * `publicExponent`: {number} Public exponent (RSA). **Default:** `0x10001`. @@ -3507,8 +3516,8 @@ changes: * `publicKey`: {string | Buffer | KeyObject} * `privateKey`: {string | Buffer | KeyObject} -Generates a new asymmetric key pair of the given `type`. RSA, DSA, EC, Ed25519, -Ed448, X25519, X448, and DH are currently supported. +Generates a new asymmetric key pair of the given `type`. RSA, RSA-PSS, DSA, EC, +Ed25519, Ed448, X25519, X448, and DH are currently supported. If a `publicKeyEncoding` or `privateKeyEncoding` was specified, this function behaves as if [`keyObject.export()`][] had been called on its result. Otherwise, |