blake2b - npm Package Compare versions

Comparing version 0.0.0 to 1.0.0

example.js

@@ -6,2 +6,4 @@ var blake2b = require('./index.js')
 
-blake2b(out, input)
+blake2b(output, input)
+
+console.log(output)

package.json

 {
   "name": "blake2b",
-  "version": "0.0.0",
+  "version": "1.0.0",
   "description": "Blake2b (64-bit version) in pure Javascript",
@@ -17,5 +17,3 @@ "main": "index.js",
   },
-  "keywords": [
-
-  ],
+  "keywords": [],
   "author": "Emil Bay <[e-mail]>",
@@ -22,0 +20,0 @@ "license": "Proprietary",

README.md

 # `blake2b`
 
+[![Build Status](https://travis-ci.org/emilbayes/blake2b.svg?branch=master)](https://travis-ci.org/emilbayes/blake2b)
+
 > Blake2b (64-bit version) in pure Javascript
 
+This module is based on @dcposch
+[implementation of BLAKE2b](https://github.com/dcposch/blakejs), with some changes:
+
+* This module requires you to pass in a `out` buffer, saving an allocation
+* This module allows you to set the `salt` and `personal` parameters
+* This module exports constants for the parameters in libsodium style
+
+All credit goes to @dcposch for doing the hard work of porting the
+implementation from C to Javascript.
+
 ## Usage
@@ -18,4 +30,34 @@
 
-### `blake2b(out, input, [key], [salt], [personal])`
+### `blake2b(out, input, [key], [salt], [personal], [noAssert = false])`
 
+Hash `input` and write result to `out`, optionally with `key`, `salt` and
+`personal`. Bypass input assertions by setting `noAssert` to `true`.
+
+All parameters must be `Uint8Array`, `Buffer` or another object with a compatible
+API. All parameters must also fulfill the following constraints, or an
+`AssertionError` will be thrown (unless `noAssert = true`):
+
+* `out` must within the byte ranges defined by the constants below.
+* `input` can be any length, including `0`
+* `key` is optional, but must within the byte ranges defined by the constants
+   below, if given. This value must be kept secret, and can be used to create
+   prefix-MACs.
+* `salt` is optional, but must be exactly `SALTBYTES`, if given. You can use
+  this parameter as a kind of per user id, or local versioning scheme. This
+  value is not required to be secret.
+* `personal` is optional, but must be exactly `PERSONALBYTES`, if given. You can
+  use this parameter as a kind of app id, or global versioning scheme. This
+  value is not required to be secret.
+
+### Constants
+
+* `blake2b.BYTES_MIN` Minimum length of `out`
+* `blake2b.BYTES_MAX` Maximum length of `out`
+* `blake2b.BYTES` Recommended default length of `out`
+* `blake2b.KEYBYTES_MIN` Minimum length of `key`
+* `blake2b.KEYBYTES_MAX` Maximum length of `key`
+* `blake2b.KEYBYTES` Recommended default length of `key`
+* `blake2b.SALTBYTES` Required length of `salt`
+* `blake2b.PERSONALBYTES` Required length of `personal`
+
 ## Install
@@ -27,4 +69,14 @@
 
+## Test vectors
+
+This repository includes test vectors with
+`{outlen, out, input, key, salt, personal}` objects for testing conformance
+against the spec and other implementations:
+
+* Lines [2 - 257](test-vectors.json#L2-L257) are tests for hashing with no key, taken from [BLAKE2 test vectors](https://github.com/BLAKE2/BLAKE2/blob/5cbb39c9ef8007f0b63723e3aea06cd0887e36ad/testvectors/blake2-kat.json)
+* Lines [258 - 513](test-vectors.json#L258-L513) are tests for hashing with keys, taken from [BLAKE2 test vectors](https://github.com/BLAKE2/BLAKE2/blob/5cbb39c9ef8007f0b63723e3aea06cd0887e36ad/testvectors/blake2-kat.json)
+* Lines [514- 577](test-vectors.json#L514-L577) are tests for hashing with key, salt and personalisation, derived from the [libsodium tests](https://github.com/jedisct1/libsodium/blob/3a9c4c38f7dbe671d91dcfa267c919734b4923df/test/default/generichash3.c)
+
 ## License
 
 [ISC](LICENSE.md)

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Trivial Package

Supply chain risk

Packages less than 10 lines of code are easily copied into your own project and may not warrant the additional supply chain risk of an external dependency.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

300860

increased by16717.22%

Number of package files

8

increased by100%

Lines of code

1670

increased by41650%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

81

increased by179.31%

No dependency changes