node-aes-gcm - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

 {
   "name": "node-aes-gcm",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "AES GCM module for node.js that takes advantage of GCM authentication",
@@ -25,4 +25,3 @@ "main": "build/Release/node_aes_gcm.node",
   "gypfile": true,
-  "readmeFilename": "README.md",
-  "gitHead": "2cb14a93ec28eaed98fcedb0d78a2752ce7b75d4"
+  "readmeFilename": "README.md"
 }

README.md

@@ -10,2 +10,5 @@ node-aes-gcm
 [node]: http://nodejs.org
+[crypto]: http://nodejs.org/api/crypto.html
+[OpenSSL]: http://www.openssl.org/
+[IV]: http://en.wikipedia.org/wiki/Initialization_vector
 
@@ -24,6 +27,8 @@ Installation
 
-The reason for the existence of this module is that the node.js crypto module does not seem to expose a way to use the ability of [GCM (Galois Counter Mode)][GCM] to perform both encryption and authentication simultaneously.  This functionality is available in OpenSSL, so this module provides a thin wrapper around OpenSSL to expose this functionality for use in node.js.
+The reason for the existence of this module is that the [node.js][node] [crypto][] module does not seem to expose a way to use the ability of [GCM (Galois Counter Mode)][GCM] to perform both encryption and authentication simultaneously.  This functionality is available in [OpenSSL][] 1.0+, so this module provides a thin wrapper around [OpenSSL][] to expose this functionality for use in [node.js][node].
 
-It was written for my own use and is not very flexible.  It is hard-coded for most common usage of GCM when it is combined with AES-128 (128-bit key), using a 96-bit IV, and generating a 128-bit authentication tag.  It does include support for additional authenticated data (AAD).
+[GCM][] is a useful mode to communicate securely with small embedded devices, because of its low operating overhead.  When combined with [node.js][node], large scalable systems can be designed. Another advantage is that it is unencumbered by patents.
 
+This module was written for my own use and is not designed to be extremely flexible, but to provide support for the most common use case of [GCM][] in embedded systems.  It uses the [AES-128][AES] cipher (128-bit key), supports a 96-bit [initialization vector][IV] (IV), and generates a 128-bit authentication tag.  It does include support for additional authenticated data (AAD).
+
 The module exports 2 functions: `encrypt` and `decrypt`.
@@ -90,3 +95,3 @@
 ``` javascript
-> gcm = require('node_aes_gcm')
+> gcm = require('node-aes-gcm')
 { encrypt: [Function], decrypt: [Function] }
@@ -93,0 +98,0 @@ > key = new Buffer([0xfe,0xff,0xe9,0x92,0x86,0x65,0x73,0x1c,0x6d,0x6a,0x8f,0x94,0x67,0x30,0x83,0x08])

No alert changes

Improved metrics

Total package byte prevSize

17358

increased by2.69%

Number of lines in readme file

110

increased by4.76%

No dependency changes