doc: clarify PEM format for signing keys#64404
Open
harjothkhara wants to merge 1 commit into
Open
Conversation
Signed-off-by: harjoth <harjoth.khara@gmail.com>
Collaborator
|
Review requested:
|
nodejs-github-bot
added
crypto
pimterry
approved these changes
Jul 10, 2026
lpinca
approved these changes
Jul 10, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarify that bare string and buffer-source keys passed to the signing and
verification APIs must contain PEM-encoded key material.
This documents the behavior consistently for:
Sign#sign()Verify#verify()crypto.sign()crypto.verify()Structured key objects can continue to select other supported formats through
their
formatproperty.Fixes: #35331
Validation
node tools/lint-md/lint-md.mjs doc/api/crypto.mdmake doc-onlyArrayBuffer,Buffer,TypedArray, andDataViewPEM inputs, plus rejection of a bare DER inputDuplicate-work check
PR #63350 previously attempted similar wording for only
crypto.sign()andcrypto.verify(), then was withdrawn without review. This change covers allfour APIs identified in the issue discussion.