sodium-native - npm Package Compare versions

Comparing version 1.1.2 to 1.2.0

package.json

 {
   "name": "sodium-native",
-  "version": "1.1.2",
+  "version": "1.2.0",
   "description": "Low level bindings for libsodium",
@@ -9,4 +9,3 @@ "main": "index.js",
     "nan": "^2.4.0",
-    "prebuild": "^4.4.0",
-    "standard": "^8.6.0"
+    "prebuild": "^4.4.0"
   },
@@ -16,2 +15,3 @@ "devDependencies": {
     "buffer-fill": "^0.1.0",
+    "standard": "^8.6.0",
     "tape": "^4.6.3"
@@ -18,0 +18,0 @@ },

README.md

@@ -165,15 +165,2 @@ # sodium-native
 
-### Hashing
-
-Bindings for the crypto_hash API.
-
-#### `crypto_hash(output, input)`
-
-Hash an input value.
-
-* `output` should be a buffer of length `crypto_hash_BYTES`.
-* `input` should be a buffer of any length.
-
-The generated hash is stored in `output`.
-
 ### Public / secret key box encryption
@@ -416,10 +403,10 @@
 
-* `output` should be a buffer of any size.
+* `output` should be a buffer with length within `16` - `2^32 - 1`.
 * `password` should be a buffer of any size.
 * `salt` should be a buffer with length `crypto_passwd_SALTBYTES`.
-* `opslimit` should a be number containing your ops limit setting.
-* `memlimit` should a be number containing your mem limit setting.
+* `opslimit` should a be number containing your ops limit setting in the range `3` - `2^32 - 1`.
+* `memlimit` should a be number containing your mem limit setting in the range `8` - `2^32 - 1`.
 * `algorithm` should be a number specifying the algorithm you want to use.
 
-Available ops and mem limits are
+Available default ops and mem limits are
 
@@ -441,19 +428,19 @@ * `crypto_pwhash_OPSLIMIT_INTERACTIVE`
 
-Create a password hash without a salt.
+Create a password hash with a random salt.
 
-* `output` should be a buffer of any size.
+* `output` should be a buffer with length `crypto_pwhash_STRBYTES`.
 * `password` should be a buffer of any size.
-* `opslimit` should a be number containing your ops limit setting.
-* `memlimit` should a be number containing your mem limit setting.
+* `opslimit` should a be number containing your ops limit setting in the range `3` - `2^32 - 1`.
+* `memlimit` should a be number containing your mem limit setting in the range `8` - `2^32 - 1`.
 
-The generated hash will be stored in `output` and the entire `output` buffer will be used.
+The generated hash, settings, salt, version and algorithm will be stored in `output` and the entire `output` buffer will be used.
 
-#### `var bool = crypto_pwhash_str_verify(output, password)`
+#### `var bool = crypto_pwhash_str_verify(str, password)`
 
 Verify a password hash generated with the above method.
 
-* `output` should be a buffer of any size.
+* `str` should be a buffer with length `crypto_pwhash_STRBYTES`.
 * `password` should be a buffer of any size.
 
-Returns `true` if the hash could be verified. Otherwise `false`.
+Returns `true` if the hash could be verified with the settings contained in `str`. Otherwise `false`.
 
@@ -460,0 +447,0 @@ ### Scalar multiplication

test/crypto_pwhash.js

@@ -34,2 +34,6 @@ var tape = require('tape')
 
+  t.throws(function () {
+    sodium.crypto_pwhash_str(output, passwd)
+  }, 'should throw on missing args')
+
   sodium.crypto_pwhash_str(output, passwd, opslimit, memlimit)
@@ -36,0 +40,0 @@

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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

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

Unidentified License

License

(Experimental) Something that seems like a license was found, but its contents could not be matched with a known license.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6813032

increased by0.01%

Dependency count

3

decreased by-25%

Lines of code

464

increased by0.65%

Worsened metrics

Dev dependency count

4

increased by33.33%

Number of lines in readme file

486

decreased by-2.61%

Dependency changes

• - Removedstandard@^8.6.0

• - Removedacorn@3.3.05.7.4(transitive)

• - Removedacorn-jsx@3.0.1(transitive)

• - Removedajv@4.11.8(transitive)

• - Removedajv-keywords@1.5.1(transitive)

• - Removedansi-escapes@1.4.0(transitive)

• - Removedansi-regex@2.1.13.0.1(transitive)

• - Removedansi-styles@2.2.1(transitive)

• - Removedargparse@1.0.10(transitive)

• - Removedbabel-code-frame@6.26.0(transitive)

• - Removedbuffer-from@1.1.2(transitive)

• - Removedcall-bind@1.0.7(transitive)

• - Removedcaller-path@0.1.0(transitive)

• - Removedcallsites@0.2.0(transitive)

• - Removedchalk@1.1.3(transitive)

• - Removedcircular-json@0.3.3(transitive)

• - Removedcli-cursor@1.0.2(transitive)

• - Removedcli-width@2.2.1(transitive)

• - Removedco@4.6.0(transitive)

• - Removedcode-point-at@1.1.0(transitive)

• - Removedconcat-stream@1.6.2(transitive)

• - Removeddebug-log@1.0.1(transitive)

• - Removeddeep-is@0.1.4(transitive)

• - Removeddefine-data-property@1.1.4(transitive)

• - Removeddeglob@2.1.1(transitive)

• - Removeddoctrine@1.5.0(transitive)

• - Removedes-define-property@1.0.0(transitive)

• - Removedes-errors@1.3.0(transitive)

• - Removedes6-map@0.1.5(transitive)

• - Removedes6-set@0.1.6(transitive)

• - Removedes6-weak-map@2.0.3(transitive)

• - Removedescape-string-regexp@1.0.5(transitive)

• - Removedescope@3.6.0(transitive)

• - Removedeslint@3.10.2(transitive)

• - Removedeslint-config-standard@6.2.1(transitive)

• - Removedeslint-config-standard-jsx@3.2.0(transitive)

• - Removedeslint-plugin-promise@3.4.2(transitive)

• - Removedeslint-plugin-react@6.7.1(transitive)

• - Removedeslint-plugin-standard@2.0.1(transitive)

• - Removedespree@3.5.4(transitive)

• - Removedesprima@4.0.1(transitive)

• - Removedesrecurse@4.3.0(transitive)

• - Removedestraverse@4.3.05.3.0(transitive)

• - Removedesutils@2.0.3(transitive)

• - Removedexit-hook@1.1.1(transitive)

• - Removedfast-levenshtein@2.0.6(transitive)

• - Removedfigures@1.7.0(transitive)

• - Removedfile-entry-cache@2.0.0(transitive)

• - Removedfind-root@1.1.0(transitive)

• - Removedflat-cache@1.3.4(transitive)

• - Removedfunction-bind@1.1.2(transitive)

• - Removedgenerate-function@2.3.1(transitive)

• - Removedgenerate-object-property@1.2.0(transitive)

• - Removedget-intrinsic@1.2.4(transitive)

• - Removedget-stdin@5.0.1(transitive)

• - Removedglobals@9.18.0(transitive)

• - Removedgopd@1.0.1(transitive)

• - Removedhas-ansi@2.0.0(transitive)

• - Removedhas-property-descriptors@1.0.2(transitive)

• - Removedhas-proto@1.0.3(transitive)

• - Removedhas-symbols@1.0.3(transitive)

• - Removedhasown@2.0.2(transitive)

• - Removedhome-or-tmp@2.0.0(transitive)

• - Removedignore@3.3.10(transitive)

• - Removedimurmurhash@0.1.4(transitive)

• - Removedinquirer@0.12.0(transitive)

• - Removedinterpret@1.4.0(transitive)

• - Removedis-core-module@2.15.1(transitive)

• - Removedis-fullwidth-code-point@1.0.02.0.0(transitive)

• - Removedis-my-ip-valid@1.0.1(transitive)

• - Removedis-my-json-valid@2.20.6(transitive)

• - Removedis-property@1.0.2(transitive)

• - Removedis-resolvable@1.1.0(transitive)

• - Removedisarray@2.0.5(transitive)

• - Removedjs-tokens@3.0.2(transitive)

• - Removedjs-yaml@3.14.1(transitive)

• - Removedjson-stable-stringify@1.1.1(transitive)

• - Removedjsonify@0.0.1(transitive)

• - Removedjsonpointer@5.0.1(transitive)

• - Removedjsx-ast-utils@1.4.1(transitive)

• - Removedlevn@0.3.0(transitive)

• - Removedlodash@4.17.21(transitive)

• - Removedmute-stream@0.0.5(transitive)

• - Removednatural-compare@1.4.0(transitive)

• - Removednumber-is-nan@1.0.1(transitive)

• - Removedobject-assign@4.1.1(transitive)

• - Removedobject-keys@1.1.1(transitive)

• - Removedonetime@1.1.0(transitive)

• - Removedoptionator@0.8.3(transitive)

• - Removedpath-is-inside@1.0.2(transitive)

• - Removedpath-parse@1.0.7(transitive)

• - Removedpkg-config@1.1.1(transitive)

• - Removedpluralize@1.2.1(transitive)

• - Removedprelude-ls@1.1.2(transitive)

• - Removedprogress@1.1.8(transitive)

• - Removedqueue-microtask@1.2.3(transitive)

• - Removedreadline2@1.0.1(transitive)

• - Removedrechoir@0.6.2(transitive)

• - Removedrequire-uncached@1.0.3(transitive)

• - Removedresolve@1.22.8(transitive)

• - Removedresolve-from@1.0.1(transitive)

• - Removedrestore-cursor@1.0.1(transitive)

• - Removedrimraf@2.6.3(transitive)

• - Removedrun-async@0.1.0(transitive)

• - Removedrun-parallel@1.2.0(transitive)

• - Removedrx-lite@3.1.2(transitive)

• - Removedset-function-length@1.2.2(transitive)

• - Removedshelljs@0.7.8(transitive)

• - Removedslice-ansi@0.0.4(transitive)

• - Removedsprintf-js@1.0.3(transitive)

• - Removedstandard@8.6.0(transitive)

• - Removedstandard-engine@5.2.0(transitive)

• - Removedstring-width@1.0.22.1.1(transitive)

• - Removedstrip-ansi@3.0.14.0.0(transitive)

• - Removedstrip-bom@3.0.0(transitive)

• - Removedstrip-json-comments@1.0.4(transitive)

• - Removedsupports-color@2.0.0(transitive)

• - Removedsupports-preserve-symlinks-flag@1.0.0(transitive)

• - Removedtable@3.8.3(transitive)

• - Removedtext-table@0.2.0(transitive)

• - Removedthrough@2.3.8(transitive)

• - Removedtype-check@0.3.2(transitive)

• - Removedtypedarray@0.0.6(transitive)

• - Removeduniq@1.0.1(transitive)

• - Removeduser-home@2.0.0(transitive)

• - Removedword-wrap@1.2.5(transitive)

• - Removedwrite@0.2.1(transitive)