Skip to content

doc: clarify PEM format for signing keys #64404

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
harjothkhara wants to merge 1 commit into
base: main
Choose a base branch
from
+16 −8
Open

doc: clarify PEM format for signing keys #64404

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 16 additions & 8 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2665,8 +2665,10 @@ Calculates the signature on all the data passed through using either
[`sign.update()`][] or [`sign.write()`][stream-writable-write].

If `privateKey` is not a [`KeyObject`][], this function behaves as if
`privateKey` had been passed to [`crypto.createPrivateKey()`][]. If it is an
object, the following additional properties can be passed:
`privateKey` had been passed to [`crypto.createPrivateKey()`][]. When
`privateKey` is a string, `ArrayBuffer`, [`Buffer`][], `TypedArray`, or
`DataView`, it must contain PEM-encoded key material. If it is an object, the
following additional properties can be passed:

* `dsaEncoding` {string} For DSA and ECDSA, this option specifies the
format of the generated signature. It can be one of the following:
Expand Down Expand Up @@ -2799,8 +2801,10 @@ changes:
Verifies the provided data using the given `key` and `signature`.

If `key` is not a [`KeyObject`][], this function behaves as if
`key` had been passed to [`crypto.createPublicKey()`][]. If it is an
object, the following additional properties can be passed:
`key` had been passed to [`crypto.createPublicKey()`][]. When `key` is a string,
`ArrayBuffer`, [`Buffer`][], `TypedArray`, or `DataView`, it must contain
PEM-encoded key material. If it is an object, the following additional
properties can be passed:

* `dsaEncoding` {string} For DSA and ECDSA, this option specifies the
format of the signature. It can be one of the following:
Expand Down Expand Up @@ -6209,8 +6213,10 @@ dependent upon the key type.
ML-DSA.

If `key` is not a [`KeyObject`][], this function behaves as if `key` had been
passed to [`crypto.createPrivateKey()`][]. If it is an object, the following
additional properties can be passed:
passed to [`crypto.createPrivateKey()`][]. When `key` is a string, `ArrayBuffer`,
[`Buffer`][], `TypedArray`, or `DataView`, it must contain PEM-encoded key
material. If it is an object, the following additional properties can be
passed:

* `dsaEncoding` {string} For DSA and ECDSA, this option specifies the
format of the generated signature. It can be one of the following:
Expand Down Expand Up @@ -6349,8 +6355,10 @@ key type.
ML-DSA.

If `key` is not a [`KeyObject`][], this function behaves as if `key` had been
passed to [`crypto.createPublicKey()`][]. If it is an object, the following
additional properties can be passed:
passed to [`crypto.createPublicKey()`][]. When `key` is a string, `ArrayBuffer`,
[`Buffer`][], `TypedArray`, or `DataView`, it must contain PEM-encoded key
material. If it is an object, the following additional properties can be
passed:

* `dsaEncoding` {string} For DSA and ECDSA, this option specifies the
format of the signature. It can be one of the following:
Expand Down
Loading