diff options
| author | Tobias Nießen <tniessen@tnie.de> | 2021-08-23 15:34:30 +0300 |
|---|---|---|
| committer | Filip Skokan <panva.ip@gmail.com> | 2021-08-29 21:23:18 +0300 |
| commit | b6b638bdd69e4bd07140497c026cdf0aba8dd544 (patch) | |
| tree | 64feb906db9eb3db9db8d3de929426fbe09408ec /doc/api | |
| parent | 449147ebab8d91e5326b839a1ae61e45b1e73582 (diff) | |
crypto: add RSA-PSS params to asymmetricKeyDetails
Fixes: https://github.com/nodejs/node/issues/39837
Refs: https://github.com/openssl/openssl/pull/10568
PR-URL: https://github.com/nodejs/node/pull/39851
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Filip Skokan <panva.ip@gmail.com>
Diffstat (limited to 'doc/api')
| -rw-r--r-- | doc/api/crypto.md | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 73f5ecd9506..b54ad3019cd 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1908,11 +1908,20 @@ const { ### `keyObject.asymmetricKeyDetails` <!-- YAML added: v15.7.0 +changes: + - version: REPLACEME + pr-url: https://github.com/nodejs/node/pull/39851 + description: Expose `RSASSA-PSS-params` sequence parameters + for RSA-PSS keys. --> * {Object} * `modulusLength`: {number} Key size in bits (RSA, DSA). * `publicExponent`: {bigint} Public exponent (RSA). + * `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 (EC). @@ -1921,8 +1930,11 @@ this object contains information about the key. None of the information obtained through this property can be used to uniquely identify a key or to compromise the security of the key. -RSA-PSS parameters, DH, or any future key type details might be exposed via this -API using additional attributes. +For RSA-PSS keys, if the key material contains a `RSASSA-PSS-params` sequence, +the `hashAlgorithm`, `mgf1HashAlgorithm`, and `saltLength` properties will be +set. + +Other key details might be exposed via this API using additional attributes. ### `keyObject.asymmetricKeyType` <!-- YAML |