Merge commit from fork

GHSA-869p-cjfg-cm3x on v3.x

Author: anicho123

.gitignore

@@ -2,3 +2,4 @@ node_modules
 /test/keys
 /test/*.pem
 /test/encrypted-key-passphrase
+package-lock.json

CHANGELOG.md

@@ -1,8 +1,20 @@
 # Change Log
+
 All notable changes to this project will be documented in this file.
 
+## [3.2.3]
+
+### Changed
+
+- Fix advisory GHSA-869p-cjfg-cm3x: createSign and createVerify now require
+  that a non empty secret is provided (via opts.secret, opts.privateKey or opts.key)
+  when using HMAC algorithms.
+- Upgrading JWA version to 1.4.2, adressing a compatibility issue for Node >= 25.
+
 ## [3.0.0]
+
 ### Changed
+
 - **BREAKING**: `jwt.verify` now requires an `algorithm` parameter, and
   `jws.createVerify` requires an `algorithm` option. The `"alg"` field
   signature headers is ignored. This mitigates a critical security flaw
@@ -12,7 +24,9 @@ All notable changes to this project will be documented in this file.
   for details.
 
 ## [2.0.0] - 2015-01-30
+
 ### Changed
+
 - **BREAKING**: Default payload encoding changed from `binary` to
   `utf8`. `utf8` is a is a more sensible default than `binary` because
   many payloads, as far as I can tell, will contain user-facing
@@ -21,14 +35,13 @@ All notable changes to this project will be documented in this file.
 - Code reorganization, thanks [@fearphage]! (<code>[7880050]</code>)
 
 ### Added
+
 - Option in all relevant methods for `encoding`. For those few users
   that might be depending on a `binary` encoding of the messages, this
   is for them. (<code>[6b6de48]</code>)
 
 [unreleased]: https://github.com/brianloveswords/node-jws/compare/v2.0.0...HEAD
 [2.0.0]: https://github.com/brianloveswords/node-jws/compare/v1.0.1...v2.0.0
-
 [7880050]: https://github.com/brianloveswords/node-jws/commit/7880050
 [6b6de48]: https://github.com/brianloveswords/node-jws/commit/6b6de48
-
 [@fearphage]: https://github.com/fearphage

lib/sign-stream.js

@@ -34,7 +34,12 @@ function jwsSign(opts) {
 }
 
 function SignStream(opts) {
-  var secret = opts.secret||opts.privateKey||opts.key;
+  var secret = opts.secret;
+  secret = secret == null ? opts.privateKey : secret;
+  secret = secret == null ? opts.key : secret;
+  if (/^hs/i.test(opts.header.alg) === true && secret == null) {
+    throw new TypeError('secret must be a string or buffer or a KeyObject')
+  }
   var secretStream = new DataStream(secret);
   this.readable = true;
   this.header = opts.header;

lib/verify-stream.js

@@ -79,7 +79,12 @@ function jwsDecode(jwsSig, opts) {
 
 function VerifyStream(opts) {
   opts = opts || {};
-  var secretOrKey = opts.secret||opts.publicKey||opts.key;
+  var secretOrKey = opts.secret;
+  secretOrKey = secretOrKey == null ? opts.publicKey : secretOrKey;
+  secretOrKey = secretOrKey == null ? opts.key : secretOrKey;
+  if (/^hs/i.test(opts.algorithm) === true && secretOrKey == null) {
+    throw new TypeError('secret must be a string or buffer or a KeyObject')
+  }
   var secretStream = new DataStream(secretOrKey);
   this.readable = true;
   this.algorithm = opts.algorithm;

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jws",
-  "version": "3.2.2",
+  "version": "3.2.3",
   "description": "Implementation of JSON Web Signatures",
   "main": "index.js",
   "directories": {
@@ -24,7 +24,7 @@
   "readmeFilename": "readme.md",
   "gitHead": "c0f6b27bcea5a2ad2e304d91c2e842e4076a6b03",
   "dependencies": {
-    "jwa": "^1.4.1",
+    "jwa": "^1.4.2",
     "safe-buffer": "^5.0.1"
   },
   "devDependencies": {

test/jws.test.js

@@ -330,3 +330,119 @@ test('jws.isValid', function (t) {
   t.same(jws.isValid(valid), true);
   t.end();
 });
+
+test('Streaming sign: HMAC with empty secret buffer', function (t) {
+  const dataStream = readstream('data.txt');
+  const secret = Buffer.alloc(0);
+  const sig = jws.createSign({
+    header: { alg: 'HS256' },
+    secret: secret
+  });
+  dataStream.pipe(sig.payload);
+  sig.on('done', function (signature) {
+    t.ok(jws.verify(signature, 'HS256', secret), 'should verify');
+    t.end();
+  }).sign();
+});
+
+test('Streaming sign: HMAC with empty secret string', function (t) {
+  const dataStream = readstream('data.txt');
+  const secret = '';
+  const sig = jws.createSign({
+    header: { alg: 'HS256' },
+    secret: secret
+  });
+  dataStream.pipe(sig.payload);
+  sig.on('done', function (signature) {
+    t.ok(jws.verify(signature, 'HS256', secret), 'should verify');
+    t.end();
+  }).sign();
+});
+
+test('Streaming sign: HMAC with undefined secret', function (t) {
+  try {
+    jws.createSign({
+      header: { alg: 'HS256' },
+      secret: undefined
+    });
+    t.fail('should have errored');
+    t.end();
+  } catch (error) {
+    t.equal(error.name, 'TypeError');
+    t.equal(error.message, 'secret must be a string or buffer or a KeyObject');
+    t.end();
+  }
+});
+
+test('Streaming sign: HMAC with null secret', function (t) {
+  try {
+    jws.createSign({
+      header: { alg: 'HS256' },
+      secret: null
+    });
+    t.fail('should have errored');
+    t.end();
+  } catch (error) {
+    t.equal(error.name, 'TypeError');
+    t.equal(error.message, 'secret must be a string or buffer or a KeyObject');
+    t.end();
+  }
+});
+
+test('Streaming verify: HMAC with empty secret buffer', function (t) {
+  const secret = Buffer.alloc(0);
+  jws.createVerify({
+    signature: 'eyJhbGciOiJIUzI1NiJ9.b25lLCB0d28sIHRocmVlCg.V1oQ0aq6FgAoe7C2TORtYpQAbYzJoFNFZlJkTlF1e60',
+    algorithm: 'HS256',
+    secret: secret
+  }).on('done', function (valid, decoded) {
+    t.true(valid);
+    t.same(decoded.payload, readfile('data.txt'));
+    t.end();
+  }).verify();
+});
+
+test('Streaming verify: HMAC with empty secret string', function (t) {
+  const secret = '';
+  jws.createVerify({
+    signature: 'eyJhbGciOiJIUzI1NiJ9.b25lLCB0d28sIHRocmVlCg.V1oQ0aq6FgAoe7C2TORtYpQAbYzJoFNFZlJkTlF1e60',
+    algorithm: 'HS256',
+    secret: secret
+  }).on('done', function (valid, decoded) {
+    t.true(valid);
+    t.same(decoded.payload, readfile('data.txt'));
+    t.end();
+  }).verify();
+});
+
+test('Streaming verify: HMAC with undefined secret', function (t) {
+  try {
+    jws.createVerify({
+      signature: 'eyJhbGciOiJIUzI1NiJ9.b25lLCB0d28sIHRocmVlCg.V1oQ0aq6FgAoe7C2TORtYpQAbYzJoFNFZlJkTlF1e60',
+      algorithm: 'HS256',
+      secret: undefined
+    });
+    t.fail('should have errored');
+    t.end();
+  } catch (error) {
+    t.equal(error.name, 'TypeError');
+    t.equal(error.message, 'secret must be a string or buffer or a KeyObject');
+    t.end();
+  }
+});
+
+test('Streaming verify: HMAC with null secret', function (t) {
+  try {
+    jws.createVerify({
+      signature: 'eyJhbGciOiJIUzI1NiJ9.b25lLCB0d28sIHRocmVlCg.V1oQ0aq6FgAoe7C2TORtYpQAbYzJoFNFZlJkTlF1e60',
+      algorithm: 'HS256',
+      secret: null
+    });
+    t.fail('should have errored');
+    t.end();
+  } catch (error) {
+    t.equal(error.name, 'TypeError');
+    t.equal(error.message, 'secret must be a string or buffer or a KeyObject');
+    t.end();
+  }
+});