diff options
Diffstat (limited to 'doc/api/crypto.md')
| -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 8318b20ca3..ae38a31beb 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 |