crypto: use globalThis.crypto over require('crypto').webcrypto

PR-URL: #45817 Reviewed-By: Yagiz Nizipli <yagiz@nizipli.com> Reviewed-By: James M Snell <jasnell@gmail.com>

Author: panva

.eslintrc.js

@@ -239,6 +239,12 @@ module.exports = {
  selector: "CallExpression[callee.name='isNaN']",
  message: 'Use Number.isNaN() instead of the global isNaN() function.',
  },
+ {
+ // TODO(@panva): move this to no-restricted-properties
+ // when https://github.com/eslint/eslint/issues/16412 is fixed
+ selector: "Identifier[name='webcrypto']",
+ message: 'Use `globalThis.crypto`.',
+ },
  ],
  'no-return-await': 'error',
  'no-self-compare': 'error',

benchmark/crypto/webcrypto-digest.js

@@ -1,11 +1,8 @@
 'use strict';
 
 const common = require('../common.js');
-const {
- createHash,
- webcrypto,
-} = require('crypto');
-const { subtle } = webcrypto;
+const { createHash } = require('crypto');
+const { subtle } = globalThis.crypto;
 
 const bench = common.createBenchmark(main, {
  sync: ['createHash', 'subtle'],
@@ -48,7 +45,7 @@ function measureSubtle(n, data, method) {
 }
 
 function main({ n, sync, data, method }) {
- data = webcrypto.getRandomValues(Buffer.alloc(data));
+ data = globalThis.crypto.getRandomValues(Buffer.alloc(data));
  switch (sync) {
  case 'createHash': return measureLegacy(n, data, method);
  case 'subtle': return measureSubtle(n, data, method);

test/.eslintrc.yaml

@@ -49,6 +49,8 @@ rules:
  message: Use 'test' as debuglog value in tests.
  - selector: CallExpression:matches([callee.object.name="common"][callee.property.name=/^mustCall/],[callee.name="mustCall"],[callee.name="mustCallAtLeast"])>:first-child[type=/FunctionExpression$/][body.body.length=0]
  message: Do not use an empty function, omit the parameter altogether.
+ - selector: Identifier[name='webcrypto']
+ message: Use `globalThis.crypto`.
 
  # Custom rules in tools/eslint-rules
  node-core/prefer-assert-iferror: error

test/parallel/test-crypto-psychic-signatures.js

@@ -80,14 +80,14 @@ for (const [encoding, signatures] of Object.entries(vectors)) {
  );
 
  // webcrypto
- crypto.webcrypto.subtle.importKey(
+ globalThis.crypto.subtle.importKey(
  'spki',
  keyPair.publicKey,
  { name: 'ECDSA', namedCurve: 'P-256' },
  false,
  ['verify'],
  ).then((publicKey) => {
- return crypto.webcrypto.subtle.verify(
+ return globalThis.crypto.subtle.verify(
  { name: 'ECDSA', hash: 'SHA-256' },
  publicKey,
  signature,

test/parallel/test-crypto-random.js

@@ -28,7 +28,6 @@ if (!common.hasCrypto)
 
 const assert = require('assert');
 const crypto = require('crypto');
-const cryptop = require('crypto').webcrypto;
 const { kMaxLength } = require('buffer');
 
 const kMaxInt32 = 2 ** 31 - 1;
@@ -107,7 +106,7 @@ common.expectWarning('DeprecationWarning',
  new Uint32Array(10),
  ].forEach((buf) => {
  const before = Buffer.from(buf.buffer).toString('hex');
- cryptop.getRandomValues(buf);
+ globalThis.crypto.getRandomValues(buf);
  const after = Buffer.from(buf.buffer).toString('hex');
  assert.notStrictEqual(before, after);
  });

test/parallel/test-crypto-subtle-zero-length.js

@@ -6,18 +6,18 @@ if (!common.hasCrypto)
  common.skip('missing crypto');
 
 const assert = require('assert');
-const crypto = require('crypto').webcrypto;
+const { subtle } = globalThis.crypto;
 
 (async () => {
- const k = await crypto.subtle.importKey(
+ const k = await subtle.importKey(
  'raw',
  new Uint8Array(32),
  { name: 'AES-GCM' },
  false,
  [ 'encrypt', 'decrypt' ]);
  assert(k instanceof CryptoKey);
 
- const e = await crypto.subtle.encrypt({
+ const e = await subtle.encrypt({
  name: 'AES-GCM',
  iv: new Uint8Array(12),
  }, k, new Uint8Array(0));
@@ -28,7 +28,7 @@ const crypto = require('crypto').webcrypto;
  0x53, 0x0f, 0x8a, 0xfb, 0xc7, 0x45, 0x36, 0xb9,
  0xa9, 0x63, 0xb4, 0xf1, 0xc4, 0xcb, 0x73, 0x8b ]));
 
- const v = await crypto.subtle.decrypt({
+ const v = await subtle.decrypt({
  name: 'AES-GCM',
  iv: new Uint8Array(12),
  }, k, e);

test/parallel/test-crypto-webcrypto-aes-decrypt-tag-too-small.js

@@ -6,9 +6,9 @@ if (!common.hasCrypto)
  common.skip('missing crypto');
 
 const assert = require('assert');
-const crypto = require('crypto').webcrypto;
+const { subtle } = globalThis.crypto;
 
-crypto.subtle.importKey(
+subtle.importKey(
  'raw',
  new Uint8Array(32),
  {
@@ -18,7 +18,7 @@ crypto.subtle.importKey(
  [ 'encrypt', 'decrypt' ])
  .then((k) => {
  assert.rejects(() => {
- return crypto.subtle.decrypt({
+ return subtle.decrypt({
  name: 'AES-GCM',
  iv: new Uint8Array(12),
  }, k, new Uint8Array(0));

test/parallel/test-global-webcrypto-classes.js

@@ -6,8 +6,9 @@ if (!common.hasCrypto)
  common.skip('missing crypto');
 
 const assert = require('assert');
-const webcrypto = require('internal/crypto/webcrypto');
 
+/* eslint-disable no-restricted-syntax */
+const webcrypto = require('internal/crypto/webcrypto');
 assert.strictEqual(Crypto, webcrypto.Crypto);
 assert.strictEqual(CryptoKey, webcrypto.CryptoKey);
 assert.strictEqual(SubtleCrypto, webcrypto.SubtleCrypto);

test/parallel/test-global-webcrypto.js

@@ -7,6 +7,7 @@ if (!common.hasCrypto)
 const assert = require('assert');
 const crypto = require('crypto');
 
+/* eslint-disable no-restricted-syntax */
 assert.strictEqual(globalThis.crypto, crypto.webcrypto);
 assert.strictEqual(Crypto, crypto.webcrypto.constructor);
 assert.strictEqual(SubtleCrypto, crypto.webcrypto.subtle.constructor);

test/parallel/test-webcrypto-constructors.js

@@ -6,6 +6,7 @@ if (!common.hasCrypto)
  common.skip('missing crypto');
 
 const assert = require('assert');
+const { subtle } = globalThis.crypto;
 
 // Test CryptoKey constructor
 {
@@ -137,15 +138,15 @@ const notSubtle = Reflect.construct(function() {}, [], SubtleCrypto);
 }
 
 {
- globalThis.crypto.subtle.importKey(
+ subtle.importKey(
  'raw',
  globalThis.crypto.getRandomValues(new Uint8Array(4)),
  'PBKDF2',
  false,
  ['deriveKey'],
  ).then((key) => {
- globalThis.crypto.subtle.importKey = common.mustNotCall();
- return globalThis.crypto.subtle.deriveKey({
+ subtle.importKey = common.mustNotCall();
+ return subtle.deriveKey({
  name: 'PBKDF2',
  hash: 'SHA-512',
  salt: globalThis.crypto.getRandomValues(new Uint8Array()),