Skip to content

Latest commit

 

History

History
163 lines (125 loc) · 6.69 KB

README.md

File metadata and controls

163 lines (125 loc) · 6.69 KB
Raw

sha256-uint8array

Node.js CI npm version minified size

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

SYNOPSIS

import {createHash} from "sha256-uint8array";

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>

See TypeScript declaration sha256-uint8array.d.ts for detail.

CJS

Both ES Modules and CommonJS supported.

const {createHash} = require("sha256-uint8array");

COMPATIBILITY

It has a better compatibility with Node.js's crypto module in its smaller footprint.

module string IN Uint8Array IN TypedArray IN hex OUT Uint8Array OUT minified
crypto ✅ OK ✅ OK ✅ OK ✅ OK ✅ OK -
sha256-uint8array ✅ OK ✅ OK ✅ OK ✅ OK ✅ OK 4KB
crypto-js ✅ OK 🚫 NO 🚫 NO ✅ OK 🚫 NO 109KB
jssha ✅ OK ✅ OK 🚫 NO ✅ OK ✅ OK 11KB
hash.js ✅ OK ✅ OK 🚫 NO ✅ OK ✅ OK 17KB
sha.js ✅ OK ✅ OK 🚫 NO ✅ OK ✅ OK 27KB
jshashes ✅ OK 🚫 NO 🚫 NO ✅ OK 🚫 NO 23KB
create-hash ✅ OK ✅ OK 🚫 NO ✅ OK ✅ OK 95KB
@aws-crypto/sha256-js ✅ OK ✅ OK 🚫 NO 🚫 NO ✅ OK 14KB
crypto.subtle.digest() 🚫 NO ✅ OK ✅ OK 🚫 NO 🚫 NO -

The W3C standard crypto.subtle.digest() API has a different interface which returns Promise<ArrayBuffer>.

SPEED

It runs well both on Node.js and browsers. Node.js's native crypto module definitely runs faster than any others on Node.js, though.

module version node.js V14 Chrome 87 Safari 14
crypto - 93ms 👍 N/A N/A
sha256-uint8array 0.10.0 286ms 488ms 👍 271ms 👍
crypto-js 4.0.0 809ms 935ms 912ms
jssha 3.2.0 869ms 943ms 974ms
hash.js 1.1.7 642ms 712ms 1,570ms
sha.js 2.4.11 353ms 806ms 3,615ms
jshashes 1.0.8 1,395ms 2,344ms 1,103ms

The benchmark above shows milliseconds for 20,000 times of SHA-256 hex hash digest generation for approx 1KB string as input. It 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
cd sha256-uint8array
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
open browser/test.html

WEB BROWSERS

<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

It 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.10.0"
  }
}

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

MIT LICENSE

Copyright (c) 2020-2023 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.