libsodium-wrappers - npm Package Compare versions

Comparing version 0.2.10 to 0.2.11

package.json

 {
   "name": "libsodium-wrappers",
-  "version": "0.2.10",
+  "version": "0.2.11",
   "description": "The Sodium cryptographic library compiled to pure JavaScript (wrappers)",
@@ -12,3 +12,3 @@ "main": "dist/modules/libsodium-wrappers.js",
   "dependencies": {
-    "libsodium": "0.2.10"
+    "libsodium": "0.2.11"
   },
@@ -15,0 +15,0 @@ "keywords": [

README.md

@@ -22,3 +22,3 @@ # libsodium.js
 * Mobile Safari on iOS >= 8.0 (older versions produce incorrect results)
-* NodeJS / io.js
+* NodeJS
 * Opera >= 15
@@ -29,3 +29,3 @@ * Safari >= 6 (older versions produce incorrect results)
 
-Ready-to-use files based on libsodium 1.0.3 can be directly copied to your
+Ready-to-use files based on libsodium 1.0.5 can be directly copied to your
 project.
@@ -98,3 +98,5 @@
 * `from_string()`, `to_string()`
-* `memcmp()` (constant-time comparison, returns `true` or `false`)
+* `memcmp()` (constant-time check for equality, returns `true` or `false`)
+* `compare() (constant-time comparison. Values must have the same
+size. Returns `-1`, `0` or `1`)
 * `memzero()` (applies to `Uint8Array` objects)
@@ -154,7 +156,7 @@ * `increment()` (increments an arbitrary-long number stored as a
 * git
-* io.js or nodejs
+* nodejs
 * libtool
 * make
 * mocha (`npm install -g mocha`)
-* zopfli
+* zopfli (`npm install -g node-zopfli`)
 
@@ -164,2 +166,26 @@ Running `make` will clone libsodium, build it, test it, build the
 
+### Custom build
+
+The build available in this repository does not contain all the functions available in the original libsodium library.
+
+Providing that you have all the build dependencies installed, here is how you can build libsodium.js to include the functions you need :
+
+```shell
+git clone https://github.com/jedisct1/libsodium.js
+cd ./libsodium.js
+
+# Get the original C version of libsodium and configure it
+make libsodium/configure
+
+# Modify the emscripten.sh
+# 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. 
+nano libsodium/dist-build/emscripten.sh
+
+# Build libsodium, and then libsodium.js with your chosen functions
+make
+```
+
+__NOTE:__ for each of the functions/constants you add, make sure that the corresponding symbol files exist in the `wrapper/symbols` folder and that the constants are listed in the `wrapper/constants.json` file.
+
 ## Authors
@@ -166,0 +192,0 @@

No alert changes

Improved metrics

Total package byte prevSize

114176

increased by8.34%

Number of package files

5

increased by25%

Lines of code

2063

increased by0.78%

Number of lines in readme file

194

increased by15.48%

Dependency changes

• + Addedlibsodium@0.2.11(transitive)

• - Removedlibsodium@0.2.10(transitive)

• Updatedlibsodium@0.2.11