Skip to content

crypto: add keyObject.export() JWK format option #37081

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

Closed
panva wants to merge 10 commits into from
Closed

crypto: add keyObject.export() JWK format option #37081

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
9f6e3d1
crypto: add keyObject.export() 'jwk' format option
panva Jan 26, 2021
5ba12fb
add custom doc type
panva Jan 26, 2021
1cfd243
add doc changes entry
panva Jan 26, 2021
25a6c8c
address doc comments
panva Jan 26, 2021
955696f
add makefile for fixtures
panva Jan 26, 2021
a76db7a
get a curve not supported on openssl111fips
panva Jan 26, 2021
5f03cdf
Update doc/api/crypto.md
panva Jan 26, 2021
5ca795c
apply review feedback
panva Jan 31, 2021
44d49e0
address nits
panva Feb 1, 2021
a6d1e96
fail on private export with a passphrase
panva Feb 1, 2021
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
Prev Previous commit
Next Next commit
address doc comments
  • Loading branch information
@panva
panva committed Feb 2, 2021
commit 25a6c8c4f01cc024f7425e8247bc42fd0a64740c
11 changes: 7 additions & 4 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1355,7 +1355,7 @@ changes:
-->

* `options`: {Object}
* Returns: {string | Buffer | JWK}
* Returns: {string | Buffer | Object}

For symmetric keys, the following encoding options can be used:

Expand All @@ -1377,10 +1377,12 @@ For private keys, the following encoding options can be used:
* `passphrase`: {string | Buffer} The passphrase to use for encryption, see
`cipher`.

When PEM encoding was selected, the result will be a string, otherwise it will
be a buffer containing the data encoded as DER.
The result type depends on the selected encoding format, when PEM the
result is a string, when DER it will be a buffer containing the data
encoded as DER, when [JWK][] it will be a an object.
Comment thread
panva marked this conversation as resolved.
Outdated

When JWK encoding was selected, all other encoding options are ignored.
When [JWK][] encoding format was selected, all other encoding options are
ignored.

PKCS#1, SEC1, and PKCS#8 type keys can be encrypted by using a combination of
the `cipher` and `format` options. The PKCS#8 `type` can be used with any
Expand Down Expand Up @@ -4359,6 +4361,7 @@ See the [list of SSL OP Flags][] for details.
[Crypto constants]: #crypto_crypto_constants_1
[HTML 5.2]: https://www.w3.org/TR/html52/changes.html#features-removed
[HTML5's `keygen` element]: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/keygen
[JWK]: https://tools.ietf.org/html/rfc7517
[NIST SP 800-131A]: https://nvlpubs.nist.gov/nistpubs/SpecialPublications/NIST.SP.800-131Ar1.pdf
[NIST SP 800-132]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-132.pdf
[NIST SP 800-38D]: https://nvlpubs.nist.gov/nistpubs/Legacy/SP/nistspecialpublication800-38d.pdf
Expand Down
1 change: 0 additions & 1 deletion tools/doc/type-parser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ const customTypesMap = {
'ECDH': 'crypto.html#crypto_class_ecdh',
'Hash': 'crypto.html#crypto_class_hash',
'Hmac': 'crypto.html#crypto_class_hmac',
'JWK': 'https://tools.ietf.org/html/rfc7517',
'KeyObject': 'crypto.html#crypto_class_keyobject',
'Sign': 'crypto.html#crypto_class_sign',
'Verify': 'crypto.html#crypto_class_verify',
Expand Down