src: decouple KeyObject and CryptoKey and move CryptoKey to src by panva · Pull Request #12 · panva/node

panva · 2026-04-23T23:39:23Z

~~CI: https://ci.nodejs.org/job/node-test-commit/87270/~~
CI: https://ci.nodejs.org/job/node-test-commit/87272/

Copilot

Pull request overview

This PR refactors Node.js’ WebCrypto CryptoKey implementation to decouple it from KeyObject by moving CryptoKey’s internal-slot storage into a new native NativeCryptoKey base and updating internal crypto code to use slot accessors instead of JS-visible properties.

Changes:

Introduces NativeCryptoKey (C++) plus JS-side slot helpers (getCryptoKey{Type,Extractable,Algorithm,Usages,Handle}) and updates WebCrypto/internal consumers accordingly.
Migrates WebCrypto key generation/import/export paths from KeyObject wrappers to KeyObjectHandle usage, including structured-clone/worker transfer support.
Adds targeted regression tests for slot hiding/brand checks/clone-transfer and adds WebCrypto sign/verify benchmarks.

Reviewed changes

Copilot reviewed 30 out of 30 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
test/parallel/test-webcrypto-cryptokey-no-own-symbols.js	New coverage ensuring CryptoKey instances don’t expose own symbol/name keys.
test/parallel/test-webcrypto-cryptokey-hidden-slots.js	New coverage ensuring internal consumers/inspect bypass user-mutable prototype getters.
test/parallel/test-webcrypto-cryptokey-clone-transfer.js	New coverage for structuredClone and worker/message cloning of CryptoKey.
test/parallel/test-webcrypto-cryptokey-brand-check.js	New coverage for robust receiver brand checks on CryptoKey getters.
src/node_crypto.cc	Registers `NativeCryptoKey` with crypto binding init machinery.
src/env_properties.h	Adds env property for internal CryptoKey constructor used during transfer deserialize.
src/crypto/crypto_rsa.cc	Relaxes RSA keygen argument-count checks to support handle-returning job usage.
src/crypto/crypto_keys.h	Declares new `NativeCryptoKey` BaseObject with slot access + transfer support.
src/crypto/crypto_keys.cc	Implements `NativeCryptoKey` initialization, slot retrieval, and clone/transfer behavior.
lib/internal/util/comparisons.js	Updates deep-equal semantics for CryptoKey to use slot accessors and handle equality.
lib/internal/crypto/webidl.js	Switches WebIDL validators to use internal slot helpers instead of public getters.
lib/internal/crypto/webcrypto_util.js	Changes key import helpers to return `KeyObjectHandle` (plus secret-key import helpers).
lib/internal/crypto/webcrypto.js	Replaces direct symbol-slot reads with slot helper calls across WebCrypto ops.
lib/internal/crypto/util.js	Removes exported `kKeyObject` symbol (part of decoupling).
lib/internal/crypto/rsa.js	Switches RSA keygen/import/export/sign-verify to handle-based plumbing and jobs.
lib/internal/crypto/pbkdf2.js	Uses `getCryptoKeyHandle()` for PBKDF2 deriveBits inputs.
lib/internal/crypto/ml_kem.js	Uses Nid keygen job + handle-based import/export/cipher operations.
lib/internal/crypto/ml_dsa.js	Uses Nid keygen job + handle-based import/export/sign-verify operations.
lib/internal/crypto/mac.js	Migrates HMAC/KMAC keygen/import/sign-verify to handle-based plumbing/jobs.
lib/internal/crypto/keys.js	Replaces symbol-based CryptoKey storage with NativeCryptoKey + private-field caching and helper APIs.
lib/internal/crypto/hkdf.js	Updates HKDF deriveBits to use CryptoKey handle path.
lib/internal/crypto/ec.js	Migrates EC keygen/import/export/sign-verify to handle-based plumbing/jobs.
lib/internal/crypto/diffiehellman.js	Uses slot helpers and handles for ECDH deriveBits.
lib/internal/crypto/chacha20_poly1305.js	Migrates keygen/import/cipher to handle-based plumbing/jobs.
lib/internal/crypto/cfrg.js	Migrates CFRG algos to Nid keygen + handle-based import/export/sign-verify.
lib/internal/crypto/argon2.js	Uses `getCryptoKeyHandle()` for Argon2 deriveBits key material.
lib/internal/crypto/aes.js	Migrates AES keygen/import/cipher to handle-based plumbing/jobs.
lib/eslint.config_partial.mjs	Adds lint restriction guiding `getCryptoKeyHandle` import source.
benchmark/crypto/webcrypto-verify.js	Adds benchmark for WebCrypto verify throughput across algorithms.
benchmark/crypto/webcrypto-sign.js	Adds benchmark for WebCrypto sign throughput across algorithms.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 30 out of 30 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 35 out of 35 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 36 out of 36 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 37 out of 37 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 37 out of 37 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 37 out of 37 changed files in this pull request and generated 1 comment.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 37 out of 37 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot

Pull request overview

Copilot reviewed 37 out of 37 changed files in this pull request and generated no new comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Signed-off-by: Filip Skokan <panva.ip@gmail.com>

Introduces a C++ `NativeCryptoKey` class that holds the real CryptoKey slots (`handle_data_`, `algorithm_`, `usages_`, `extractable_`) and provides structured-clone and worker-transfer support through a dedicated `CryptoKeyTransferData`. New bindings `createCryptoKeyClass`, `getCryptoKeyHandle`, and `getCryptoKeySlots` expose the class and accessors to JS; a brand-tag class-ID pointer rejects spoofed receivers on the accessors. Signed-off-by: Filip Skokan <panva.ip@gmail.com>

JS-side `CryptoKey` now extends the native `NativeCryptoKey` created via `createCryptoKeyClass`. `InternalCryptoKey` caches the `[type, extractable, algorithm, usages, handle]` slot tuple in a `#slots` private field on first access; the public getters and `isCryptoKey` route through dedicated `getCryptoKey{Type,Extractable, Algorithm,Usages,Handle}` helpers re-exported from this module. Symbol property storage (`kKeyObject`, `kAlgorithm`, `kExtractable`, `kKeyUsages`, `kCachedAlgorithm`, `kCachedKeyUsages`) is gone; `kKeyObject` is dropped from `internal/crypto/util` exports. `deepStrictEqual` on CryptoKey switches to the new accessors plus `handle.equals()` (instead of structural compare on wrapper objects). An ESLint rule forbids destructuring `getCryptoKeyHandle` from `internalBinding('crypto')`; it must come from `internal/crypto/keys` so the brand-check path is used. Signed-off-by: Filip Skokan <panva.ip@gmail.com>

Every Web Crypto algorithm module drops `key[kKeyObject][kHandle]` symbol access in favor of `getCryptoKey*` accessors and stores the raw `KeyObjectHandle` directly (no more `SecretKeyObject`/`PublicKeyObject`/ `PrivateKeyObject` wrappers on the CryptoKey slot). Key generation moves off the promisified `generateKey`/`generateKeyPair` paths onto ones that return `KeyObjectHandle` (i.e. not wrapped in KeyObject): - `SecretKeyGenJob` for AES, ChaCha20-Poly1305, HMAC/CMAC (aes.js, chacha20_poly1305.js, mac.js). - `EcKeyPairGenJob` for ECDSA, ECDH (ec.js). - `NidKeyPairGenJob` for Ed25519/Ed448/X25519/X448, ML-DSA-{44,65,87}, ML-KEM-{512,768,1024} (cfrg.js, ml_dsa.js, ml_kem.js). - `RsaKeyPairGenJob` for RSASSA-PKCS1-v1_5, RSA-PSS, RSA-OAEP (rsa.js). `webcrypto_util.js` switches its import helpers (`importDerKey`, `importJwkKey`, `importRawKey`) to return raw `KeyObjectHandle`s and adds `importSecretKey` / `importJwkSecretKey` helpers for symmetric imports. `webcrypto.js` follows the same pattern; its `getPublicKey` builds a temporary wrapper and carries a TODO for future refactor. `hkdf.js` switches from `promisify(hkdf)` to `jobPromise(() => new HKDFJob(...))` directly. `diffiehellman.js`, `argon2.js`, and `pbkdf2.js` are accessor-only migrations (the `TODO(panva)` notes on argon2/pbkdf2 are orthogonal and left for a later cleanup). Signed-off-by: Filip Skokan <panva.ip@gmail.com>

Loosens two `AdditionalConfig` precondition checks so the new Web Crypto keygen jobs added earlier (RsaKeyPairGenJob, EcKeyPairGenJob) can reuse the shared traits without threading unused encoding args through the job constructor. - `RsaKeyGenTraits::AdditionalConfig` now CHECKs RSA key type-dependant argument count accounting for being able to skip unused parameters. - `EcKeyGenTraits::AdditionalConfig` now defaults `param_encoding` to `OPENSSL_EC_NAMED_CURVE`, this is not observable in existing crypto.generateKeyPair(Sync) as its dispatch already applies the same default. This is just so that a stray OPENSSL_EC_NAMED_CURVE isn't needed in ec.js Pure precondition relaxation — no new code paths. Existing `generateKeyPair` callers still pass the same args and hit the same branches. Signed-off-by: Filip Skokan <panva.ip@gmail.com>

Enforces a 1024-byte maximum on `HkdfParams.info` at the WebIDL layer using refactored `validateMaxBufferLength`. Its error message is also fixed. Oversized `info` was already rejected via a different code path. It just relocates the rejection earlier into the WebIDL conversion step so the failure reproduces the OpenSSL's limitation early. Signed-off-by: Filip Skokan <panva.ip@gmail.com>

Tightens `validateJwk` to require the per-`kty` string members up front (before switching to C++), short-circuiting with the same `Invalid keyData` message and `DataError` when the JWK is missing required fields or passes a non-string value for one. In theory non-strings are already rejected by WebIDL's JWK converter but this doesn't hurt. - RSA: requires `n`, `e`; if `d` is present, also requires `p`, `q`, `dp`, `dq`, and `qi`. - EC: requires `crv`, `x`, `y`; optional `d`. - OKP: requires `crv`, `x`; optional `d`. - oct: requires `k`. - AKP: requires `alg`, `pub`; optional `priv`. Four export/import negative tests update their expected error text from the later "Invalid JWK … Parameter and algorithm name mismatch" to the new short-circuit "Invalid keyData" (for the case where `crv`/`alg` is missing entirely). A new `{ kty: 'oct' }` missing-`k` negative is added for ChaCha20-Poly1305. The tests check error messages but the error class (DataError/DOMException) is the same everywhere. Signed-off-by: Filip Skokan <panva.ip@gmail.com>

Adds four focused tests that check guarantees either introduced by the native `CryptoKey` refactor or carried over from the existing state. - `test-webcrypto-cryptokey-brand-check.js` - each of the four prototype getters (`type`, `extractable`, `algorithm`, `usages`) throws `ERR_INVALID_THIS` for foreign receivers (plain objects, null-proto, primitives, null/undefined, functions, a subverted `Symbol.hasInstance`, and a real `BaseObject` of a different kind). `util.types.isCryptoKey()` remains accurate after a prototype swap, confirming it cannot be spoofed. - `test-webcrypto-cryptokey-clone-transfer.js` - exhaustive structured-clone, `MessagePort.postMessage`, and `Worker.postMessage` round-trips. Verifies slot preservation, inspect-output equivalence, and that crypto operations interoperate across clones including repeated round-trips. - `test-webcrypto-cryptokey-hidden-slots.js` - replaces all four prototype getters with forged versions and confirms internal consumers (export, inspect) still read the real native slots. - `test-webcrypto-cryptokey-no-own-symbols.js`, asserts CryptoKey instances expose no own symbol-keyed properties even after every public getter has been touched (proof the `#slots` private field plus native storage leaves the instance shape pristine). Signed-off-by: Filip Skokan <panva.ip@gmail.com>

Adds two benchmarks exercising `subtle.sign` / `subtle.verify` across the main algorithm families: - ECDSA P-256 - RSASSA-PKCS1-v1_5 - RSA-PSS - Ed25519 - ML-DSA-44 (gated on OpenSSL >= 3.5) Each benchmark runs two modes (serial / parallel) × two key-reuse patterns (shared / unique per call) so regressions in slot-access hot paths (getCryptoKey* accessors) and in per-call key wrapping surface on both dimensions. Signed-off-by: Filip Skokan <panva.ip@gmail.com>

Signed-off-by: Filip Skokan <panva.ip@gmail.com>

This function call can fail with `Z_VERSION_ERROR` if the compiled library vs loaded library mismatched in version number or in stream structure size. In those cases, zlib doesn't initialize the `strm_.msg` field to null. Therefore, when a `CompressionError` object is created via `ErrorForMessage()`, it can read a stale or uninitialized `strm_.msg` pointer that will cause a crash. Example ASAN report: ``` AddressSanitizer: SEGV on unknown address #0 __strlen_avx2 string/../sysdeps/x86_64/multiarch/strlen-avx2.S:76 #1 strlen (/work/node/out/Debug/node+0x1a42ab7) #2 v8::(anonymous namespace)::StringLength(char const*) /work/node/out/../deps/v8/src/api/api.cc:7581:16 #3 v8::(anonymous namespace)::StringLength(unsigned char const*) /work/node/out/../deps/v8/src/api/api.cc:7587:10 #4 v8::String::NewFromOneByte(v8::Isolate*, unsigned char const*, v8::NewStringType, int) /work/node/out/../deps/v8/src/api/api.cc:7677:3 #5 node::OneByteString(v8::Isolate*, char const*, int, v8::NewStringType) /work/node/out/../src/util-inl.h:166:10 nodejs#6 node::(anonymous namespace)::CompressionStream< node::(anonymous namespace)::ZlibContext> ::EmitError(node::(anonymous namespace) ::CompressionError const&) /work/node/out/../src/node_zlib.cc:565:7 nodejs#7 node::(anonymous namespace)::CompressionStream< node::(anonymous namespace)::ZlibContext> ::CheckError() /work/node/out/../src/node_zlib.cc:519:5 #8 node::(anonymous namespace)::CompressionStream< node::(anonymous namespace)::ZlibContext> ::AfterThreadPoolWork(int) /work/node/out/../src/node_zlib.cc:543:10 #9 node::ThreadPoolWork::ScheduleWork() ::'lambda'(uv_work_s*, int) ::operator()(uv_work_s*, int) const /work/node/out/../src/threadpoolwork-inl.h:57:15 #10 node::ThreadPoolWork::ScheduleWork() ::'lambda'(uv_work_s*, int) ::__invoke(uv_work_s*, int) /work/node/out/../src/threadpoolwork-inl.h:48:7 #11 uv__work_done /work/libuv-1.51.0/src/threadpool.c:330:5 #12 uv__async_io.part.0 /work/libuv-1.51.0/src/unix/async.c:208:5 ``` Signed-off-by: ndossche <nora.dossche@ugent.be> PR-URL: nodejs#63476 Reviewed-By: Anna Henningsen <anna@addaleax.net>

panva requested a review from Copilot April 23, 2026 23:40

Copilotstarted reviewing on behalf of panva April 23, 2026 23:41 View session

CopilotAI reviewed Apr 23, 2026
View reviewed changes

Comment threadlib/internal/util/comparisons.js
Comment threadlib/internal/crypto/hkdf.js Outdated
Comment threadlib/internal/crypto/keys.js Outdated
Comment threadlib/internal/crypto/keys.js Outdated
Comment threadsrc/crypto/crypto_rsa.cc Outdated

panva force-pushed the native-cryptokey branch from 72f14eb to 9d7ddb1Compare April 24, 2026 06:48

panva requested a review from Copilot April 24, 2026 06:50

Copilotstarted reviewing on behalf of panva April 24, 2026 06:51 View session

CopilotAI reviewed Apr 24, 2026
View reviewed changes

Comment threadsrc/crypto/crypto_keys.cc Outdated
Comment threadlib/internal/crypto/keys.js

panva force-pushed the native-cryptokey branch from 9d7ddb1 to 241b9f9Compare April 24, 2026 07:55

panva requested a review from Copilot April 24, 2026 07:56

Copilotstarted reviewing on behalf of panva April 24, 2026 07:57 View session

CopilotAI reviewed Apr 24, 2026
View reviewed changes

Comment threadsrc/crypto/crypto_keys.cc Outdated

panva force-pushed the native-cryptokey branch from 241b9f9 to e1718e3Compare April 24, 2026 08:23

panva requested a review from Copilot April 24, 2026 08:24

Copilotstarted reviewing on behalf of panva April 24, 2026 08:24 View session

CopilotAI reviewed Apr 24, 2026
View reviewed changes

Comment threadlib/internal/crypto/keys.js

panva force-pushed the native-cryptokey branch from e1718e3 to 58f3d07Compare April 24, 2026 09:18

panva requested a review from Copilot April 24, 2026 09:18

Copilotstarted reviewing on behalf of panva April 24, 2026 09:19 View session

panva force-pushed the native-cryptokey branch from 58f3d07 to ebb5f0aCompare April 24, 2026 09:27

CopilotAI reviewed Apr 24, 2026
View reviewed changes

Comment threadsrc/crypto/crypto_keys.cc Outdated
Comment threadlib/internal/crypto/webidl.js

panva force-pushed the native-cryptokey branch from ebb5f0a to 93d2955Compare April 24, 2026 09:38

panva requested a review from Copilot April 24, 2026 09:39

Copilotstarted reviewing on behalf of panva April 24, 2026 09:40 View session

CopilotAI reviewed Apr 24, 2026
View reviewed changes

panva force-pushed the native-cryptokey branch 2 times, most recently from fc03610 to e3cb124Compare April 24, 2026 10:09

panva requested a review from Copilot April 24, 2026 10:14

Copilotstarted reviewing on behalf of panva April 24, 2026 10:14 View session

CopilotAI reviewed Apr 24, 2026
View reviewed changes

Comment threadlib/internal/crypto/keys.js Outdated

panva force-pushed the native-cryptokey branch from e3cb124 to 943754cCompare April 24, 2026 10:21

panva force-pushed the native-cryptokey branch from 943754c to f5b1f67Compare April 24, 2026 10:28

panva requested a review from Copilot April 24, 2026 10:28

Copilotstarted reviewing on behalf of panva April 24, 2026 10:28 View session

panva force-pushed the native-cryptokey branch from f5b1f67 to fcc387aCompare April 24, 2026 10:33

CopilotAI reviewed Apr 24, 2026
View reviewed changes

panva requested a review from Copilot April 24, 2026 11:07

Copilotstarted reviewing on behalf of panva April 24, 2026 11:08 View session

CopilotAI reviewed Apr 24, 2026
View reviewed changes

Comment threadlib/internal/crypto/keys.js Outdated

panva force-pushed the native-cryptokey branch from fcc387a to 533d329Compare April 24, 2026 11:33

panva requested a review from Copilot April 24, 2026 11:34

Copilotstarted reviewing on behalf of panva April 24, 2026 11:34 View session

panva force-pushed the native-cryptokey branch from 533d329 to 685f83aCompare April 24, 2026 11:40

CopilotAI reviewed Apr 24, 2026
View reviewed changes

panva requested a review from Copilot April 24, 2026 11:41

Copilotstarted reviewing on behalf of panva April 24, 2026 11:42 View session

CopilotAI reviewed Apr 24, 2026
View reviewed changes

panva added 9 commits April 24, 2026 13:52

src: decouple KeyObject and CryptoKey and move CryptoKey to src
d78bb5c
Signed-off-by: Filip Skokan <panva.ip@gmail.com>

panva force-pushed the native-cryptokey branch from 685f83a to 4a0dbabCompare April 24, 2026 12:35

panva added 2 commits April 24, 2026 16:31

fixup! src,crypto: add NativeCryptoKey
1cb4aad
Signed-off-by: Filip Skokan <panva.ip@gmail.com>

fixup! lib,crypto: rewire CryptoKey on the native class
e11737b
Signed-off-by: Filip Skokan <panva.ip@gmail.com>

panva closed this Apr 24, 2026

Conversation

panva commented Apr 23, 2026• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

panva commented Apr 23, 2026•
edited
Loading