diff --git a/doc/api/crypto.md b/doc/api/crypto.md index 18f52eb4f8ec5d..b56420bce9a1c7 100644 --- a/doc/api/crypto.md +++ b/doc/api/crypto.md @@ -1284,6 +1284,25 @@ passing keys as strings or `Buffer`s due to improved security features. The receiver obtains a cloned `KeyObject`, and the `KeyObject` does not need to be listed in the `transferList` argument. +### `keyObject.asymmetricKeyDetails` + + +* {Object} + * `modulusLength`: {number} Key size in bits (RSA, DSA). + * `publicExponent`: {bigint} Public exponent (RSA). + * `divisorLength`: {number} Size of `q` in bits (DSA). + * `namedCurve`: {string} Name of the curve (EC). + +This property exists only on asymmetric keys. Depending on the type of the key, +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. + ### `keyObject.asymmetricKeyType`