bump version

* fix: don't modify global Array and ArrayBuffer prototypes

* wip: simplify formatMessage

* wip: simplify formatMessage internal logic

* wip: simplify formatMessage internal logic

* wip: simplify formatMessage internal logic

* refactor: simplify formatMessage internal logic

* formatMessage: remove double-negation: now returns istring instead of notString

* refactor: remove double-negation of isString

* refactor: remove double-negation of isString

* add comment on formatMessage return type

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## v0.9.2 / 2023-09-16
+### Fixed
+- don't modify global Array and ArrayBuffer prototypes.  #33
+- refactor: simplify formatMessage internal logic.  #34
+
+## v0.9.1 / 2023-08-31
+### Fixed
+- cSHAKE empty Array bug. #24
+
+## v0.9.0 / 2023-08-30
+### Fixed
+- cSHAKE bug. #24
+- dependencies and security issues.
+
 ## v0.8.0 / 2018-08-05
 ### Added
 - TypeScript definitions.

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright 2015-2018 Chen, Yi-Cyuan
+Copyright 2015-2023 Chen, Yi-Cyuan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

README.md

@@ -84,26 +84,46 @@ var hash = cshake128.create(256, 'function name', 'customization');
 // specify kmac key, output bits and customization when creating
 var hash = kmac128.create('key', 256, 'customization');
 ```
+### Node.js
 If you use node.js, you should require the module first:
 ```JavaScript
-sha3_512 = require('js-sha3').sha3_512;
-sha3_384 = require('js-sha3').sha3_384;
-sha3_256 = require('js-sha3').sha3_256;
-sha3_224 = require('js-sha3').sha3_224;
-keccak512 = require('js-sha3').keccak512;
-keccak384 = require('js-sha3').keccak384;
-keccak256 = require('js-sha3').keccak256;
-keccak224 = require('js-sha3').keccak224;
-shake128 = require('js-sha3').shake128;
-shake256 = require('js-sha3').shake256;
-cshake128 = require('js-sha3').cshake128;
-cshake256 = require('js-sha3').cshake256;
-kmac128 = require('js-sha3').kmac128;
-kmac256 = require('js-sha3').kmac256;
+const {
+  sha3_512,
+  sha3_384,
+  sha3_256,
+  sha3_224,
+  keccak512,
+  keccak384,
+  keccak256,
+  keccak224,
+  shake128,
+  shake256,
+  cshake128,
+  cshake256,
+  kmac128,
+  kmac25
+} = require('js-sha3');
 ```
+
+### TypeScript
 If you use TypeScript, you can import like this:
 ```TypeScript
-import { sha3_512 } from 'js-sha3';
+import {
+  sha3_512,
+  sha3_384,
+  sha3_256,
+  sha3_224,
+  keccak512,
+  keccak384,
+  keccak256,
+  keccak224,
+  shake128,
+  shake256,
+  cshake128,
+  cshake256,
+  kmac128,
+  kmac256
+} from 'js-sha3';
 ```
 
 ## Example

bower.json

@@ -1,6 +1,6 @@
 {
   "name": "js-sha3",
-  "version": "0.8.0",
+  "version": "0.9.2",
   "main": ["src/sha3.js"],
   "ignore": [
     "samples",

package.json

@@ -1,14 +1,14 @@
 {
   "name": "js-sha3",
-  "version": "0.8.0",
+  "version": "0.9.2",
   "description": "A simple SHA-3 / Keccak / Shake hash function for JavaScript supports UTF-8 encoding.",
   "main": "src/sha3.js",
   "devDependencies": {
     "expect.js": "~0.3.1",
-    "mocha": "~2.3.4",
-    "nyc": "^11.3.0",
-    "uglify-js": "^3.1.9",
-    "webworker-threads": "^0.7.13"
+    "mocha": "~10.2.0",
+    "nyc": "^15.1.0",
+    "tiny-worker": "^2.3.0",
+    "uglify-js": "^3.1.9"
   },
   "scripts": {
     "test": "nyc mocha tests/node-test.js",

src/sha3.js

@@ -1,9 +1,9 @@
 /**
  * [js-sha3]{@link https://github.com/emn178/js-sha3}
  *
- * @version 0.8.0
+ * @version 0.9.2
  * @author Chen, Yi-Cyuan [emn178@gmail.com]
- * @copyright Chen, Yi-Cyuan 2015-2018
+ * @copyright Chen, Yi-Cyuan 2015-2023
  * @license MIT
  */
 /*jslint bitwise: true */
@@ -46,17 +46,40 @@
     '256': 136
   };
 
-  if (root.JS_SHA3_NO_NODE_JS || !Array.isArray) {
-    Array.isArray = function (obj) {
-      return Object.prototype.toString.call(obj) === '[object Array]';
-    };
+
+  var isArray = root.JS_SHA3_NO_NODE_JS || !Array.isArray
+    ? function (obj) {
+        return Object.prototype.toString.call(obj) === '[object Array]';
+      }
+    : Array.isArray;
+
+  var isView = (ARRAY_BUFFER && (root.JS_SHA3_NO_ARRAY_BUFFER_IS_VIEW || !ArrayBuffer.isView))
+    ? function (obj) {
+        return typeof obj === 'object' && obj.buffer && obj.buffer.constructor === ArrayBuffer;
+      }
+    : ArrayBuffer.isView;
+
+  // [message: string, isString: bool]
+  var formatMessage = function (message) {
+    var type = typeof message;
+    if (type === 'string') {
+      return [message, true];
+    }
+    if (type !== 'object' || message === null) {
+      throw new Error(INPUT_ERROR);
+    }
+    if (ARRAY_BUFFER && message.constructor === ArrayBuffer) {
+      return [new Uint8Array(message), false];
+    }
+    if (!isArray(message) && !isView(message)) {
+      throw new Error(INPUT_ERROR);
+    }
+    return [message, false];
   }
 
-  if (ARRAY_BUFFER && (root.JS_SHA3_NO_ARRAY_BUFFER_IS_VIEW || !ArrayBuffer.isView)) {
-    ArrayBuffer.isView = function (obj) {
-      return typeof obj === 'object' && obj.buffer && obj.buffer.constructor === ArrayBuffer;
-    };
-  }
+  var empty = function (message) {
+    return formatMessage(message)[0].length === 0;
+  };
 
   var createOutputMethod = function (bits, padding, outputType) {
     return function (message) {
@@ -116,7 +139,7 @@
     var w = CSHAKE_BYTEPAD[bits];
     var method = createCshakeOutputMethod(bits, padding, 'hex');
     method.create = function (outputBits, n, s) {
-      if (!n && !s) {
+      if (empty(n) && empty(s)) {
         return methods['shake' + bits].create(outputBits);
       } else {
         return new Keccak(bits, padding, outputBits).bytepad([n, s], w);
@@ -188,23 +211,9 @@
     if (this.finalized) {
       throw new Error(FINALIZE_ERROR);
     }
-    var notString, type = typeof message;
-    if (type !== 'string') {
-      if (type === 'object') {
-        if (message === null) {
-          throw new Error(INPUT_ERROR);
-        } else if (ARRAY_BUFFER && message.constructor === ArrayBuffer) {
-          message = new Uint8Array(message);
-        } else if (!Array.isArray(message)) {
-          if (!ARRAY_BUFFER || !ArrayBuffer.isView(message)) {
-            throw new Error(INPUT_ERROR);
-          }
-        }
-      } else {
-        throw new Error(INPUT_ERROR);
-      }
-      notString = true;
-    }
+    var result = formatMessage(message);
+    message = result[0];
+    var isString = result[1];
     var blocks = this.blocks, byteCount = this.byteCount, length = message.length,
       blockCount = this.blockCount, index = 0, s = this.s, i, code;
 
@@ -216,11 +225,7 @@
           blocks[i] = 0;
         }
       }
-      if (notString) {
-        for (i = this.start; index < length && i < byteCount; ++index) {
-          blocks[i >> 2] |= message[index] << SHIFT[i++ & 3];
-        }
-      } else {
+      if (isString) {
         for (i = this.start; index < length && i < byteCount; ++index) {
           code = message.charCodeAt(index);
           if (code < 0x80) {
@@ -240,6 +245,10 @@
             blocks[i >> 2] |= (0x80 | (code & 0x3f)) << SHIFT[i++ & 3];
           }
         }
+      } else {
+        for (i = this.start; index < length && i < byteCount; ++index) {
+          blocks[i >> 2] |= message[index] << SHIFT[i++ & 3];
+        }
       }
       this.lastByteIndex = i;
       if (i >= byteCount) {
@@ -278,27 +287,11 @@
   };
 
   Keccak.prototype.encodeString = function (str) {
-    var notString, type = typeof str;
-    if (type !== 'string') {
-      if (type === 'object') {
-        if (str === null) {
-          throw new Error(INPUT_ERROR);
-        } else if (ARRAY_BUFFER && str.constructor === ArrayBuffer) {
-          str = new Uint8Array(str);
-        } else if (!Array.isArray(str)) {
-          if (!ARRAY_BUFFER || !ArrayBuffer.isView(str)) {
-            throw new Error(INPUT_ERROR);
-          }
-        }
-      } else {
-        throw new Error(INPUT_ERROR);
-      }
-      notString = true;
-    }
+    var result = formatMessage(str);
+    str = result[0];
+    var isString = result[1];
     var bytes = 0, length = str.length;
-    if (notString) {
-      bytes = length;
-    } else {
+    if (isString) {
       for (var i = 0; i < str.length; ++i) {
         var code = str.charCodeAt(i);
         if (code < 0x80) {
@@ -312,6 +305,8 @@
           bytes += 4;
         }
       }
+    } else {
+      bytes = length;
     }
     bytes += this.encode(bytes * 8);
     this.update(str);
@@ -323,7 +318,7 @@
     for (var i = 0; i < strs.length; ++i) {
       bytes += this.encodeString(strs[i]);
     }
-    var paddingBytes = w - bytes % w;
+    var paddingBytes = (w - bytes % w) % w;
     var zeros = [];
     zeros.length = paddingBytes;
     this.update(zeros);

tests/node-test.js

@@ -1,5 +1,5 @@
 expect = require('expect.js');
-Worker = require('webworker-threads').Worker;
+Worker = require("tiny-worker");
 
 function unset() {
   delete require.cache[require.resolve('../src/sha3.js')];

tests/test-cshake.js

@@ -25,6 +25,27 @@
           n: '',
           s: '',
           output: '7f9c2ba4e88f827d616045507605853ed73b8093f6efbc88eb1a6eacfa66ef26'
+        },
+        {
+          input: [],
+          bits: 256,
+          n: [],
+          s: [],
+          output: '7f9c2ba4e88f827d616045507605853ed73b8093f6efbc88eb1a6eacfa66ef26'
+        },
+        {
+          input: [],
+          bits: 256,
+          n: new ArrayBuffer(0),
+          s: new ArrayBuffer(0),
+          output: '7f9c2ba4e88f827d616045507605853ed73b8093f6efbc88eb1a6eacfa66ef26'
+        },
+        {
+          input: [],
+          bits: 256,
+          n: new Uint8Array([]),
+          s: new Uint8Array([]),
+          output: '7f9c2ba4e88f827d616045507605853ed73b8093f6efbc88eb1a6eacfa66ef26'
         }
       ]
     },

tests/test-kmac.js

@@ -94,6 +94,13 @@
           key: [0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4A, 0x4B, 0x4C, 0x4D, 0x4E, 0x4F, 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5A, 0x5B, 0x5C, 0x5D, 0x5E, 0x5F],
           s: 'My Tagged Application',
           output: 'b58618f71f92e1d56c1b8c55ddd7cd188b97b4ca4d99831eb2699a837da2e4d970fbacfde50033aea585f1a2708510c32d07880801bd182898fe476876fc8965'
+        },
+        {
+          input: [],
+          bits: 128,
+          key: [],
+          s: [8, 79, 237, 8, 185, 120, 175, 77, 125, 25, 106, 116, 70, 168, 107, 88, 0, 158, 99, 107, 97, 29, 177, 98, 17, 182, 90, 154, 173, 255, 41, 197, 8, 79, 237, 8, 185, 120, 175, 77, 125, 25, 106, 116, 70, 168, 107, 88, 0, 158, 99, 107, 97, 29, 177, 98, 17, 182, 90, 154, 173, 255, 41, 197, 8, 79, 237, 8, 185, 120, 175, 77, 125, 25, 106, 116, 70, 168, 107, 88, 0, 158, 99, 107, 97, 29, 177, 98, 17, 182, 90, 154, 173, 255, 41, 197, 8, 79, 237, 8, 185, 120, 175, 77, 125, 25, 106, 116, 70, 168, 107, 88, 0, 158, 99, 107, 97, 29, 177, 98, 17, 182, 90, 154, 173],
+          output: '031801b0b50ebeef772fbe7a279bc144'
         }
       ]
     }

tests/test.js

@@ -185,8 +185,8 @@
 
   if (typeof BUFFER === 'boolean' && BUFFER) {
     testCases.sha3_512.Buffer = {
-      'a69f73cca23a9ac5c8b567dc185a756e97c982164fe25859e0d1dcc1475c80a615b2123af1f5f94c11e3e9402c3ac558f500199d95b6d3e301758586281dcd26': new Buffer(0),
-      '01dedd5de4ef14642445ba5f5b97c15e47b9ad931326e4b0727cd94cefc44fff23f07bf543139939b49128caf436dc1bdee54fcb24023a08d9403f9b4bf0d450': new Buffer(new Uint8Array([84, 104, 101, 32, 113, 117, 105, 99, 107, 32, 98, 114, 111, 119, 110, 32, 102, 111, 120, 32, 106, 117, 109, 112, 115, 32, 111, 118, 101, 114, 32, 116, 104, 101, 32, 108, 97, 122, 121, 32, 100, 111, 103]))
+      'a69f73cca23a9ac5c8b567dc185a756e97c982164fe25859e0d1dcc1475c80a615b2123af1f5f94c11e3e9402c3ac558f500199d95b6d3e301758586281dcd26': Buffer.from([]),
+      '01dedd5de4ef14642445ba5f5b97c15e47b9ad931326e4b0727cd94cefc44fff23f07bf543139939b49128caf436dc1bdee54fcb24023a08d9403f9b4bf0d450': Buffer.from(new Uint8Array([84, 104, 101, 32, 113, 117, 105, 99, 107, 32, 98, 114, 111, 119, 110, 32, 102, 111, 120, 32, 106, 117, 109, 112, 115, 32, 111, 118, 101, 114, 32, 116, 104, 101, 32, 108, 97, 122, 121, 32, 100, 111, 103]))
     };
   }
 

tests/worker-test.js

@@ -11,6 +11,9 @@
         var worker = new Worker(WORKER);
         worker.onmessage = function(event) {
           expect(event.data).to.be(hash);
+          if (worker.terminate) {
+            worker.terminate();
+          }
           done();
         };
         worker.postMessage(SOURCE);