node-blake2
Why BLAKE2 for hashing? Because "BLAKE2 outperforms MD5, SHA-1, SHA-2, and SHA-3 on recent Intel CPUs" and has "no known security issues, whereas SHA-1, MD5, and SHA-512 are susceptible to length-extension". https://blake2.net/
node-blake2 provides a stream-compatible
blake2b, blake2bp, blake2s, and blake2sp Hash
and KeyedHash
for node 4+.
node-blake2 was tested to work on
- Ubuntu 14.04 (g++ 4.8.2)
- Ubuntu 14.04 (clang++ 3.6.2-svn238746-1~exp1)
- Ubuntu 15.04 (g++ 4.9.2)
- Windows 8.1 x64 (VS2013)
- OS X 10.10 (Apple LLVM 6.1.0)
Install
On Windows, first install Python 2.7.13 so that node-gyp works.
In your project, run:
npm install blake2 --save
or install from the GitHub repo:
npm install ludios/node-blake2 --save
Examples
Unkeyed BLAKE2b
var blake2 = ;var h = blake2;h;console;
blake2.createHash
works like node's
crypto.createHash
.
Keyed BLAKE2b
var blake2 = ;var h = blake2;h;console;
blake2.createKeyedHash
takes a key argument like
crypto.createHmac
.
Although it is not an HMAC, a keyed hash serves the same purpose.
Important notes
blake2.create{Hash,KeyedHash}
support algorithmsblake2b
,blake2bp
,blake2s
, andblake2sp
.- Data passed to
.update
onblake2.{Hash,KeyedHash}
must be aBuffer
. - Keys passed to
blake2.createKeyedHash(algo, key)
must be aBuffer
. - Just as with
crypto.Hash
,.digest()
can only be called once.
With streams
This works exactly like it does with crypto.Hash
. See b2sum.js.
Custom digest length
BLAKE2 can generate digests between 1-64 bytes for BLAKE2b and 1-32 bytes for
BLAKE2s. Pass digestLength
as an option to use a digest shorter than the
default (maximum length):
var blake2 = ;var h = blake2;h;h; // Returns a Buffer with 16 bytes
or with a key:
var blake2 = ;var h = blake2;h;h; // Returns a Buffer with 16 bytes
Note that BLAKE2 will generate completely different digests for shorter digest lengths; they are not simply a slice of the default digest.
Copying a hash object
You can call .copy()
on a Hash
or KeyedHash
, which will return a new object with all of the internal BLAKE2 state copied from the source object.
var blake2 = ;var h = blake2;h; // Call .copy() before .digest(), because .digest() finalizes internal statevar j = h; // h is unaffected by updates to jj; console;console;
Known issues
- On Windows, node-blake2 requires AVX instructions due to some SSE2 build problems. This shouldn't be too hard to fix.