libsodium-wrappers - npm Package Compare versions

Comparing version 0.3.1 to 0.4.0

README.md

@@ -82,13 +82,13 @@ # libsodium.js
 * [`crypto_box`](https://doc.libsodium.org/public-key_cryptography/authenticated_encryption.html)
-* [`crypto_box_seal`](https://doc.libsodium.org/public-key_cryptography/sealed_boxes.html)
-* [`crypto_generichash`](https://doc.libsodium.org/hashing/generic_hashing.html) (Blake2b)
-* [`crypto_hash`](https://doc.libsodium.org/advanced/sha-2_hash_function.html) (SHA-512-256)
-* [`crypto_onetimeauth`](https://doc.libsodium.org/advanced/poly1305.html) (Poly1305)
-* [`crypto_pwhash`](https://download.libsodium.org/doc/password_hashing/index.html) (Argon2)
-* [`crypto_scalarmult`](https://doc.libsodium.org/advanced/scalar_multiplication.html) (Curve25519)
-* [`crypto_secretbox`](https://doc.libsodium.org/secret-key_cryptography/authenticated_encryption.html)
-* [`crypto_shorthash`](https://doc.libsodium.org/hashing/short-input_hashing.html) (SipHash)
-* [`crypto_sign`](https://doc.libsodium.org/public-key_cryptography/public-key_signatures.html) (Ed25519)
-* [Ed25519->Curve25519 conversion](https://doc.libsodium.org/advanced/ed25519-curve25519.html)
-* [`randombytes`](https://doc.libsodium.org/generating_random_data/README.html)
+* [`crypto_box_seal`](https://download.libsodium.org/libsodium/content/public-key_cryptography/sealed_boxes.html)
+* [`crypto_generichash`](https://download.libsodium.org/libsodium/content/hashing/generic_hashing.html) (Blake2b)
+* [`crypto_hash`](https://download.libsodium.org/libsodium/content/advanced/sha-2_hash_function.html) (SHA-512-256)
+* [`crypto_onetimeauth`](https://download.libsodium.org/libsodium/content/secret-key_cryptography/chacha20-poly1305.html) (Poly1305)
+* [`crypto_pwhash`](https://download.libsodium.org/libsodium/content/password_hashing/) (Argon2)
+* [`crypto_scalarmult`](https://download.libsodium.org/libsodium/content/advanced/scalar_multiplication.html) (Curve25519)
+* [`crypto_secretbox`](https://download.libsodium.org/libsodium/content/secret-key_cryptography/authenticated_encryption.html)
+* [`crypto_shorthash`](https://download.libsodium.org/libsodium/content/hashing/short-input_hashing.html) (SipHash)
+* [`crypto_sign`](https://download.libsodium.org/libsodium/content/public-key_cryptography/public-key_signatures.html) (Ed25519)
+* [Ed25519->Curve25519 conversion](https://download.libsodium.org/libsodium/content/advanced/ed25519-curve25519.html)
+* [`randombytes`](https://download.libsodium.org/libsodium/content/generating_random_data/)
 
@@ -132,3 +132,4 @@ ## Additional helpers
 
-Example:
+Example (shorthash):
+
 ```javascript
@@ -139,2 +140,28 @@ var key = sodium.randombytes_buf(sodium.crypto_shorthash_KEYBYTES),
 
+Example (secretbox):
+
+```javascript
+// Load your secret key from a safe place and reuse it across multiple
+// secretbox calls. (Obviously don't use this example key for anything
+// real.)
+//
+var secret = Buffer.from('724b092810ec86d7e35c9d067702b31ef90bc43a7b598626749914d6a3e033ed', 'hex');
+
+// Given a message as a string, return a Buffer containing the
+// nonce (in the first 24 bytes) and the encrypted content.
+var encrypt = function(message) {
+    // You must use a different nonce for each message you encrypt.
+    var nonce = Buffer.from(sodium.randombytes_buf(sodium.crypto_box_NONCEBYTES));
+    var buf = Buffer.from(message);
+    return Buffer.concat([nonce, Buffer.from(sodium.crypto_secretbox_easy(buf, nonce, secret))]);
+},
+
+// Decrypt takes a Buffer and returns the decrypted message as plain text.
+var decrypt = function(encryptedBuffer) {
+    var nonce = encryptedBuffer.slice(0, sodium.crypto_box_NONCEBYTES);
+    var encryptedMessage = encryptedBuffer.slice(sodium.crypto_box_NONCEBYTES);
+    return sodium.crypto_secretbox_open_easy(encryptedMessage, nonce, secret, 'text');
+}
+```
+
 In addition, the `from_hex`, `to_hex`, `from_string`, and `to_string`
@@ -162,5 +189,9 @@ functions are available to explicitly convert hexadecimal, and
 
-It is slightly larger than the standard version, and should be used
-only if you really need the extra symbols it provides.
+The `crypto_pwhash_*` function set is also only included in the Sumo
+version. The high amount of heap memory (allocated after loading) required by
+these functions may not be desirable when they are not being used.
 
+The sumo version is slightly larger than the standard version, and
+should be used only if you really need the extra symbols it provides.
+
 ### Compilation
@@ -199,3 +230,3 @@
 # Specifically, add the name of the missing functions and constants in the "EXPORTED_FUNCTIONS" array.
-# Ensure that the name begins with an underscore and that it is between double quotes. 
+# Ensure that the name begins with an underscore and that it is between double quotes.
 nano libsodium/dist-build/emscripten.sh
@@ -202,0 +233,0 @@

New alerts

Invalid manifest file

Quality

Package has an invalid manifest file and can cause installation problems if you try to use it.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

134011

increased by0.56%

Dependency count

0

decreased by-100%

Number of lines in readme file

243

increased by14.62%

Worsened metrics

Number of package files

3

decreased by-25%

Number of medium quality alerts

1

increased byInfinity%

Dependency changes

• - Removedlibsodium@0.3.1

• - Removedlibsodium@0.3.1(transitive)