sha256-uint8array

sha256-uint8array

Fast SHA-256 digest hash based on Uint8Array, pure JavaScript.

SYNOPSIS

const createHash = require("sha256-uint8array").createHash;

const text = "";
const hex = createHash().update(text).digest("hex");
// => "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

const data = new Uint8Array(0);
const hash = createHash().update(data).digest();
// => <Uint8Array e3 b0 c4 42 98 fc 1c 14 9a fb f4 c8 99 6f b9 24 27 ae 41 e4 64 9b 93 4c a4 95 99 1b 78 52 b8 55>

The interface is a subset of Node.js's crypto module. See TypeScript declaration sha256-uint8array.d.ts for detail.

BENCHMARK

Node.js's native crypto module run faster than others on Node.js. sha256-uint8array runs well both on Node.js and browsers with its smaller footprint.

module	version	node.js V14	Chrome 87	Safari 14	minified	backend	note
crypto	-	103ms 👍	-	-	-	OpenSSL	👍 on node.js
sha256-uint8array	0.9.0	274ms	446ms 👍	243ms 👍	3KB 👍	Uint8Array	👍 on browsers
crypto-js	4.0.0	805ms	910ms	918ms	108KB	Uint8Array	crypto-js/sha256.js
jssha	3.2.0	835ms	892ms	913ms	10KB	Uint8Array	jssha/dist/sha256.js
hash.js	1.1.7	635ms	611ms	1,577ms	7KB	Array	hash.js/lib/hash/sha/1.js
sha.js	2.4.11	356ms	965ms	3,512ms	27KB	Buffer	sha.js/sha256.js
create-hash	1.2.0	381ms	1,002ms	3,502ms	97KB	Buffer	create-hash/browser.js
jshashes	1.0.8	1,450ms	2,239ms	1,164ms	23KB	Array	jshashes/hashes.js

The benchmark result above is tested on macOS 10.15.7 Intel Core i7 3.2GHz. You could run the benchmark as below.

git clone https://github.com/kawanet/sha256-uint8array.git
npm install
npm run build

# run the benchmark on Node.js
REPEAT=10000 ./node_modules/.bin/mocha test/99.benchmark.js

# run tests and the benchmark on browser
make -C browser test

BROWSER

The minified version of the library is also available for browsers via jsDelivr CDN.

• Live Demo https://kawanet.github.io/sha256-uint8array/
• Minified https://cdn.jsdelivr.net/npm/sha256-uint8array/dist/sha256-uint8array.min.js

<script src="https://cdn.jsdelivr.net/npm/sha256-uint8array/dist/sha256-uint8array.min.js"></script>
<script>
  const text = "";
  const hex = SHA256.createHash().update(text).digest("hex");
  // => "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

  const data = new Uint8Array(0);
  const hash = SHA256.createHash().update(data).digest();
  // => <Uint8Array e3 b0 c4 42 98 fc 1c 14 9a fb f4 c8 99 6f b9 24 27 ae 41 e4 64 9b 93 4c a4 95 99 1b 78 52 b8 55>
</script>

BROWSERIFY

This works great with browserify via browser property of package.json of your app if you needs crypto.createHash("sha256").update(data).digest("hex"); syntax only.

{
  "browser": {
    "crypto": "sha256-uint8array/dist/sha256-uint8array.min.js"
  },
  "devDependencies": {
    "browserify": "^17.0.0",
    "sha256-uint8array": "^0.9.0",
    "terser": "^5.5.1"
  }
}

It costs only less than 4KB, whereas browserify's default crypto polyfill costs more than 300KB huge even after minified.

// On Node.js, this loads Node.js's native crypto module which is faster.
// On browsers, this uses sha256-uint8array.min.js which is small and fast.
const crypto = require("crypto");

const hash = crypto.createHash("sha256").update("").digest("hex");
// => "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

LINKS

• https://www.npmjs.com/package/sha1-uint8array
• https://www.npmjs.com/package/sha256-uint8array
• https://github.com/kawanet/sha256-uint8array
• https://github.com/kawanet/sha256-uint8array/blob/main/types/sha256-uint8array.d.ts

MIT LICENSE

Copyright (c) 2020-2021 Yusuke Kawasaki

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.