crypto: fix webcrypto derive(Bits|Key) resolve values and docs

panva · panva · commit 896dc39951b0 · 2021-04-12T23:27:51.000+02:00
fixes #38115 PR-URL: #38148 Reviewed-By: Tobias Nießen <tniessen@tnie.de> Reviewed-By: James M Snell <jasnell@gmail.com>
diff --git a/doc/api/webcrypto.md b/doc/api/webcrypto.md
@@ -275,7 +275,7 @@ async function pbkdf2Key(pass, salt, iterations = 1000, length = 256) {
     ec.encode(pass),
     'PBKDF2',
     false,
-    ['deriveBits']);
+    ['deriveKey']);
   const key = await subtle.deriveKey({
     name: 'PBKDF2',
     hash: 'SHA-512',
@@ -536,7 +536,7 @@ added: v15.0.0
 * `derivedKeyAlgorithm`: {HmacKeyGenParams|AesKeyGenParams}
 * `extractable`: {boolean}
 * `keyUsages`: {string[]} See [Key usages][].
-* Returns: {Promise} containing {ArrayBuffer}
+* Returns: {Promise} containing {CryptoKey}
 <!--lint enable maximum-line-length remark-lint-->
 
 Using the method and parameters specified in `algorithm`, and the keying
diff --git a/lib/internal/crypto/pbkdf2.js b/lib/internal/crypto/pbkdf2.js
@@ -122,7 +122,7 @@ async function pbkdf2DeriveBits(algorithm, baseKey, length) {
   return new Promise((resolve, reject) => {
     pbkdf2(raw, salt, iterations, byteLength, hash, (err, result) => {
       if (err) return reject(err);
-      resolve(result);
+      resolve(result.buffer);
     });
   });
 }
diff --git a/lib/internal/crypto/scrypt.js b/lib/internal/crypto/scrypt.js
@@ -167,7 +167,7 @@ async function scryptDeriveBits(algorithm, baseKey, length) {
   return new Promise((resolve, reject) => {
     scrypt(raw, salt, byteLength, { N, r, p, maxmem }, (err, result) => {
       if (err) return reject(err);
-      resolve(result);
+      resolve(result.buffer);
     });
   });
 }
diff --git a/test/parallel/test-webcrypto-derivebits-ecdh.js b/test/parallel/test-webcrypto-derivebits-ecdh.js
@@ -98,6 +98,7 @@ async function prepareKeys() {
           public: publicKey
         }, privateKey, 8 * size);
 
+        assert(bits instanceof ArrayBuffer);
         assert.strictEqual(Buffer.from(bits).toString('hex'), result);
       }
 
diff --git a/test/parallel/test-webcrypto-derivebits-hkdf.js b/test/parallel/test-webcrypto-derivebits-hkdf.js
@@ -237,6 +237,7 @@ async function testDeriveBits(
     baseKeys[size],
     256);
 
+  assert(bits instanceof ArrayBuffer);
   assert.strictEqual(
     Buffer.from(bits).toString('hex'),
     kDerivations[size][saltSize][hash][infoSize]);
diff --git a/test/parallel/test-webcrypto-derivebits-node-dh.js b/test/parallel/test-webcrypto-derivebits-node-dh.js
@@ -112,6 +112,7 @@ async function prepareKeys() {
       public: publicKey
     }, privateKey, null);
 
+    assert(bits instanceof ArrayBuffer);
     assert.strictEqual(Buffer.from(bits).toString('hex'), result);
   }
 
diff --git a/test/parallel/test-webcrypto-derivebits-pbkdf2.js b/test/parallel/test-webcrypto-derivebits-pbkdf2.js
@@ -421,6 +421,7 @@ async function testDeriveBits(
 
   const bits = await subtle.deriveBits(algorithm, baseKeys[size], 256);
 
+  assert(bits instanceof ArrayBuffer);
   assert.strictEqual(
     Buffer.from(bits).toString('hex'),
     kDerivations[size][saltSize][hash][iterations]);
diff --git a/test/parallel/test-webcrypto-derivebits.js b/test/parallel/test-webcrypto-derivebits.js
@@ -31,6 +31,8 @@ const { internalBinding } = require('internal/test/binding');
       }, alice.privateKey, 128),
     ]);
 
+    assert(secret1 instanceof ArrayBuffer);
+    assert(secret2 instanceof ArrayBuffer);
     assert.deepStrictEqual(secret1, secret2);
   }
 
@@ -114,6 +116,7 @@ if (typeof internalBinding('crypto').ScryptJob === 'function') {
       name: 'NODE-SCRYPT',
       salt: ec.encode(salt),
     }, key, length);
+    assert(secret instanceof ArrayBuffer);
     assert.strictEqual(Buffer.from(secret).toString('hex'), expected);
   }
 

Original file line number	Diff line number	Diff line change
`@@ -122,7 +122,7 @@ async function pbkdf2DeriveBits(algorithm, baseKey, length) {`
`122`	`122`	`return new Promise((resolve, reject) => {`
`123`	`123`	`pbkdf2(raw, salt, iterations, byteLength, hash, (err, result) => {`
`124`	`124`	`if (err) return reject(err);`
`125`		`- resolve(result);`
	`125`	`+ resolve(result.buffer);`
`126`	`126`	`});`
`127`	`127`	`});`
`128`	`128`	`}`
Original file line number	Diff line number	Diff line change
`@@ -167,7 +167,7 @@ async function scryptDeriveBits(algorithm, baseKey, length) {`
`167`	`167`	`return new Promise((resolve, reject) => {`
`168`	`168`	`scrypt(raw, salt, byteLength, { N, r, p, maxmem }, (err, result) => {`
`169`	`169`	`if (err) return reject(err);`
`170`		`- resolve(result);`
	`170`	`+ resolve(result.buffer);`
`171`	`171`	`});`
`172`	`172`	`});`
`173`	`173`	`}`
Original file line number	Diff line number	Diff line change
`@@ -98,6 +98,7 @@ async function prepareKeys() {`
`98`	`98`	`public: publicKey`
`99`	`99`	`}, privateKey, 8 * size);`
`100`	`100`
	`101`	`+ assert(bits instanceof ArrayBuffer);`
`101`	`102`	`assert.strictEqual(Buffer.from(bits).toString('hex'), result);`
`102`	`103`	`}`
`103`	`104`
Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,7 @@ async function prepareKeys() {`
`112`	`112`	`public: publicKey`
`113`	`113`	`}, privateKey, null);`
`114`	`114`
	`115`	`+ assert(bits instanceof ArrayBuffer);`
`115`	`116`	`assert.strictEqual(Buffer.from(bits).toString('hex'), result);`
`116`	`117`	`}`
`117`	`118`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@ const { internalBinding } = require('internal/test/binding');`
`31`	`31`	`}, alice.privateKey, 128),`
`32`	`32`	`]);`
`33`	`33`
	`34`	`+ assert(secret1 instanceof ArrayBuffer);`
	`35`	`+ assert(secret2 instanceof ArrayBuffer);`
`34`	`36`	`assert.deepStrictEqual(secret1, secret2);`
`35`	`37`	`}`
`36`	`38`
`@@ -114,6 +116,7 @@ if (typeof internalBinding('crypto').ScryptJob === 'function') {`
`114`	`116`	`name: 'NODE-SCRYPT',`
`115`	`117`	`salt: ec.encode(salt),`
`116`	`118`	`}, key, length);`
	`119`	`+ assert(secret instanceof ArrayBuffer);`
`117`	`120`	`assert.strictEqual(Buffer.from(secret).toString('hex'), expected);`
`118`	`121`	`}`
`119`	`122`