browserify-aes - npm Package Compare versions

Comparing version 0.4.0 to 0.5.0

decrypter.js

@@ -6,2 +6,3 @@ var aes = require('./aes');
 var StreamCipher = require('./streamCipher');
+var AuthCipher = require('./authCipher');
 var ebtk = require('./EVP_BytesToKey');
@@ -79,3 +80,4 @@
   OFB: require('./modes/ofb'),
-  CTR: require('./modes/ctr')
+  CTR: require('./modes/ctr'),
+  GCM: require('./modes/ctr')
 };
@@ -103,2 +105,4 @@
       return new StreamCipher(modelist[config.mode], password, iv, true);
+    } else if (config.type === 'auth') {
+      return new AuthCipher(modelist[config.mode], password, iv, true);
     }
@@ -105,0 +109,0 @@ return new Decipher(modelist[config.mode], password, iv);

encrypter.js

@@ -7,2 +7,3 @@ var aes = require('./aes');
 var StreamCipher = require('./streamCipher');
+var AuthCipher = require('./authCipher');
 inherits(Cipher, Transform);
@@ -72,3 +73,4 @@ function Cipher(mode, key, iv) {
   OFB: require('./modes/ofb'),
-  CTR: require('./modes/ctr')
+  CTR: require('./modes/ctr'),
+  GCM: require('./modes/ctr')
 };
@@ -95,2 +97,4 @@ module.exports = function (crypto) {
       return new StreamCipher(modelist[config.mode], password, iv);
+    } else if (config.type === 'auth') {
+      return new AuthCipher(modelist[config.mode], password, iv);
     }
@@ -97,0 +101,0 @@ return new Cipher(modelist[config.mode], password, iv);

modes.js

@@ -108,2 +108,23 @@ exports['aes-128-ecb'] = {
   type: 'stream'
+};
+exports['aes-128-gcm'] = {
+  cipher: 'AES',
+  key: 128,
+  iv: 12,
+  mode: 'GCM',
+  type: 'auth'
+};
+exports['aes-192-gcm'] = {
+  cipher: 'AES',
+  key: 192,
+  iv: 12,
+  mode: 'GCM',
+  type: 'auth'
+};
+exports['aes-256-gcm'] = {
+  cipher: 'AES',
+  key: 256,
+  iv: 12,
+  mode: 'GCM',
+  type: 'auth'
 };

package.json

 {
   "name": "browserify-aes",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "aes, for browserify",
@@ -5,0 +5,0 @@ "main": "index.js",

test/index.js

@@ -8,5 +8,14 @@ var test = require('tape');
 var ebtk = require('../EVP_BytesToKey');
+function isGCM(cipher) {
+  return modes[cipher].mode === 'GCM';
+}
+function isNode10() {
+  return process.version && process.version.split('.').length === 3 && parseInt(process.version.split('.')[1], 10) <= 10;
+}
 fixtures.forEach(function (fixture, i) {
   //var ciphers = fixture.results.ciphers = {};
   types.forEach(function (cipher) {
+    if (isGCM(cipher)) {
+      return;
+    }
     test('fixture ' + i + ' ' + cipher, function (t) {
@@ -88,2 +97,3 @@ t.plan(1);
     //var cipherivs = fixture.results.cipherivs = {};
+
     types.forEach(function (cipher) {
@@ -93,6 +103,15 @@ if (modes[cipher].mode === 'ECB') {
       }
+      if (isGCM(cipher) && isNode10()) {
+        return;
+      }
       test('fixture ' + i + ' ' + cipher + '-iv', function (t) {
-        t.plan(1);
-        var suite = crypto.createCipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, new Buffer(fixture.iv, 'hex'));
+        if (isGCM(cipher)) {
+          t.plan(4);
+        } else {
+          t.plan(2);
+        }
+        var suite = crypto.createCipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, isGCM(cipher) ? (new Buffer(fixture.iv, 'hex').slice(0, 12)) : (new Buffer(fixture.iv, 'hex')));
+        var suite2 = _crypto.createCipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, isGCM(cipher) ? (new Buffer(fixture.iv, 'hex').slice(0, 12)) : (new Buffer(fixture.iv, 'hex')));
         var buf = new Buffer('');
+        var buf2 = new Buffer('');
         suite.on('data', function (d) {
@@ -104,16 +123,42 @@ buf = Buffer.concat([buf, d]);
         });
+        suite2.on('data', function (d) {
+          buf2 = Buffer.concat([buf2, d]);
+        });
+        suite2.on('error', function (e) {
+          console.log(e);
+        });
         suite.on("end", function () {
-          t.equals(buf.toString('hex'), fixture.results.cipherivs[cipher]);
+          t.equals(buf.toString('hex'), fixture.results.cipherivs[cipher], 'vs fixture');
+          t.equals(buf.toString('hex'), buf2.toString('hex'), 'vs node');
+          if (isGCM(cipher)) {
+            t.equals(suite.getAuthTag().toString('hex'), fixture.authtag[cipher], 'authtag vs fixture');
+            t.equals(suite.getAuthTag().toString('hex'), suite2.getAuthTag().toString('hex'), 'authtag vs node');
+          }
         });
+        if (isGCM(cipher)) {
+          suite.setAAD(new Buffer(fixture.aad, 'hex'));
+          suite2.setAAD(new Buffer(fixture.aad, 'hex'));
+        }
+        suite2.write(new Buffer(fixture.text));
+        suite2.end();
         suite.write(new Buffer(fixture.text));
         suite.end();
       });
+      
       test('fixture ' + i + ' ' + cipher + '-legacy-iv', function (t) {
-        t.plan(4);
-        var suite = crypto.createCipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, new Buffer(fixture.iv, 'hex'));
+        if (isGCM(cipher)) {
+          t.plan(6);
+        } else {
+          t.plan(4);
+        }
+        var suite = crypto.createCipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, isGCM(cipher) ? (new Buffer(fixture.iv, 'hex').slice(0, 12)) : (new Buffer(fixture.iv, 'hex')));
+        var suite2 = _crypto.createCipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, isGCM(cipher) ? (new Buffer(fixture.iv, 'hex').slice(0, 12)) : (new Buffer(fixture.iv, 'hex')));
         var buf = new Buffer('');
-        var suite2 = _crypto.createCipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, new Buffer(fixture.iv, 'hex'));
         var buf2 = new Buffer('');
         var inbuf = new Buffer(fixture.text);
         var mid = ~~(inbuf.length/2);
+        if (isGCM(cipher)) {
+          suite.setAAD(new Buffer(fixture.aad, 'hex'));
+          suite2.setAAD(new Buffer(fixture.aad, 'hex'));
+        }
         buf = Buffer.concat([buf, suite.update(inbuf.slice(0, mid))]);
@@ -129,7 +174,13 @@ buf2 = Buffer.concat([buf2, suite2.update(inbuf.slice(0, mid))]);
         t.equals(buf.toString('hex'), buf2.toString('hex'), 'final');
+        if (isGCM(cipher)) {
+          t.equals(suite.getAuthTag().toString('hex'), fixture.authtag[cipher], 'authtag vs fixture');
+          t.equals(suite.getAuthTag().toString('hex'), suite2.getAuthTag().toString('hex'), 'authtag vs node');
+        }
       });
       test('fixture ' + i + ' ' + cipher + '-iv-decrypt', function (t) {
-        t.plan(1);
-        var suite = crypto.createDecipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, new Buffer(fixture.iv, 'hex'));
+        t.plan(2);
+        var suite = crypto.createDecipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key,  isGCM(cipher) ? (new Buffer(fixture.iv, 'hex').slice(0, 12)) : (new Buffer(fixture.iv, 'hex')));
         var buf = new Buffer('');
+        var suite2 = _crypto.createDecipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key,  isGCM(cipher) ? (new Buffer(fixture.iv, 'hex').slice(0, 12)) : (new Buffer(fixture.iv, 'hex')));
+        var buf2 = new Buffer('');
         suite.on('data', function (d) {
@@ -139,8 +190,24 @@ buf = Buffer.concat([buf, d]);
         suite.on('error', function (e) {
-          console.log(e);
+          t.notOk(e);
         });
+        suite2.on('data', function (d) {
+          buf2 = Buffer.concat([buf2, d]);
+        });
+        suite2.on('error', function (e) {
+          t.notOk(e);
+        });
         suite.on("end", function () {
-            t.equals(buf.toString('utf8'), fixture.text);
+            t.equals(buf.toString('utf8'), fixture.text, 'correct text vs fixture');
+            t.equals(buf.toString('utf8'), buf2.toString('utf8'), 'correct text vs node');
         });
+        if (isGCM(cipher)) {
+          suite.setAuthTag(new Buffer(fixture.authtag[cipher], 'hex'));
+          suite2.setAuthTag(new Buffer(fixture.authtag[cipher], 'hex'));
+          suite.setAAD(new Buffer(fixture.aad, 'hex'));
+          suite2.setAAD(new Buffer(fixture.aad, 'hex'));
+        }
+        
+        suite2.write(new Buffer(fixture.results.cipherivs[cipher], 'hex'));
         suite.write(new Buffer(fixture.results.cipherivs[cipher], 'hex'));
+        suite2.end();
         suite.end();
@@ -150,10 +217,17 @@ });
         t.plan(4);
-        var suite = crypto.createDecipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, new Buffer(fixture.iv, 'hex'));
+        var suite = crypto.createDecipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key,  isGCM(cipher) ? (new Buffer(fixture.iv, 'hex').slice(0, 12)) : (new Buffer(fixture.iv, 'hex')));
         var buf = new Buffer('');
-        var suite2 = _crypto.createDecipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key, new Buffer(fixture.iv, 'hex'));
+        var suite2 = _crypto.createDecipheriv(cipher, ebtk(_crypto, fixture.password, modes[cipher].key).key,  isGCM(cipher) ? (new Buffer(fixture.iv, 'hex').slice(0, 12)) : (new Buffer(fixture.iv, 'hex')));
         var buf2 = new Buffer('');
         var inbuf = new Buffer(fixture.results.cipherivs[cipher], 'hex');
         var mid = ~~(inbuf.length/2);
+        if (isGCM(cipher)) {
+          suite.setAAD(new Buffer(fixture.aad, 'hex'));
+          suite2.setAAD(new Buffer(fixture.aad, 'hex'));
+          suite.setAuthTag(new Buffer(fixture.authtag[cipher], 'hex'));
+          suite2.setAuthTag(new Buffer(fixture.authtag[cipher], 'hex'));
+        }
         buf = Buffer.concat([buf, suite.update(inbuf.slice(0, mid))]);
         buf2 = Buffer.concat([buf2, suite2.update(inbuf.slice(0, mid))]);
+
         t.equals(buf.toString('utf8'), buf2.toString('utf8'), 'intermediate');
@@ -171,1 +245,154 @@ buf = Buffer.concat([buf, suite.update(inbuf.slice(mid))]);
 });
+
+if (!isNode10()) {
+  test('node tests', function (t) {
+  var TEST_CASES = [
+  { algo: 'aes-128-gcm', key: '6970787039613669314d623455536234',
+    iv: '583673497131313748307652', plain: 'Hello World!',
+    ct: '4BE13896F64DFA2C2D0F2C76',
+    tag: '272B422F62EB545EAA15B5FF84092447', tampered: false },
+  { algo: 'aes-128-gcm', key: '6970787039613669314d623455536234',
+    iv: '583673497131313748307652', plain: 'Hello World!',
+    ct: '4BE13896F64DFA2C2D0F2C76', aad: '000000FF',
+    tag: 'BA2479F66275665A88CB7B15F43EB005', tampered: false },
+  { algo: 'aes-128-gcm', key: '6970787039613669314d623455536234',
+    iv: '583673497131313748307652', plain: 'Hello World!',
+    ct: '4BE13596F64DFA2C2D0FAC76',
+    tag: '272B422F62EB545EAA15B5FF84092447', tampered: true },
+  { algo: 'aes-256-gcm', key: '337a54767a7233703637564336316a6d56353472495975313534357834546c59',
+    iv: '36306950306836764a6f4561', plain: 'Hello node.js world!',
+    ct: '58E62CFE7B1D274111A82267EBB93866E72B6C2A',
+    tag: '9BB44F663BADABACAE9720881FB1EC7A', tampered: false },
+  { algo: 'aes-256-gcm', key: '337a54767a7233703637564336316a6d56353472495975313534357834546c59',
+    iv: '36306950306836764a6f4561', plain: 'Hello node.js world!',
+    ct: '58E62CFF7B1D274011A82267EBB93866E72B6C2B',
+    tag: '9BB44F663BADABACAE9720881FB1EC7A', tampered: true },
+  { algo: 'aes-192-gcm', key: '1ed2233fa2223ef5d7df08546049406c7305220bca40d4c9',
+    iv: '0e1791e9db3bd21a9122c416', plain: 'Hello node.js world!',
+    password: 'very bad password', aad: '63616c76696e',
+    ct: 'DDA53A4059AA17B88756984995F7BBA3C636CC44',
+    tag: 'D2A35E5C611E5E3D2258360241C5B045', tampered: false }
+];
+
+var ciphers = Object.keys(modes);
+function testIt(i) {
+  t.test('test case ' + i, function (t) {
+     var test = TEST_CASES[i];
+
+  if (ciphers.indexOf(test.algo) == -1) {
+    console.log('skipping unsupported ' + test.algo + ' test');
+    return;
+  }
+
+  (function() {
+    var encrypt = crypto.createCipheriv(test.algo,
+      new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex'));
+    if (test.aad)
+      encrypt.setAAD(new Buffer(test.aad, 'hex'));
+    var hex = encrypt.update(test.plain, 'ascii', 'hex');
+    hex += encrypt.final('hex');
+    var auth_tag = encrypt.getAuthTag();
+    // only test basic encryption run if output is marked as tampered.
+    if (!test.tampered) {
+      t.equal(hex.toUpperCase(), test.ct);
+      t.equal(auth_tag.toString('hex').toUpperCase(), test.tag);
+    }
+  })();
+
+  (function() {
+    var decrypt = crypto.createDecipheriv(test.algo,
+      new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex'));
+    decrypt.setAuthTag(new Buffer(test.tag, 'hex'));
+    if (test.aad)
+      decrypt.setAAD(new Buffer(test.aad, 'hex'));
+    var msg = decrypt.update(test.ct, 'hex', 'ascii');
+    if (!test.tampered) {
+      msg += decrypt.final('ascii');
+      t.equal(msg, test.plain);
+    } else {
+      // assert that final throws if input data could not be verified!
+      t.throws(function() { decrypt.final('ascii'); }, / auth/);
+    }
+  })();
+
+  (function() {
+    if (!test.password) return;
+    var encrypt = crypto.createCipher(test.algo, test.password);
+    if (test.aad)
+      encrypt.setAAD(new Buffer(test.aad, 'hex'));
+    var hex = encrypt.update(test.plain, 'ascii', 'hex');
+    hex += encrypt.final('hex');
+    var auth_tag = encrypt.getAuthTag();
+    // only test basic encryption run if output is marked as tampered.
+    if (!test.tampered) {
+      t.equal(hex.toUpperCase(), test.ct);
+      t.equal(auth_tag.toString('hex').toUpperCase(), test.tag);
+    }
+  })();
+
+  (function() {
+    if (!test.password) return;
+    var decrypt = crypto.createDecipher(test.algo, test.password);
+    decrypt.setAuthTag(new Buffer(test.tag, 'hex'));
+    if (test.aad)
+      decrypt.setAAD(new Buffer(test.aad, 'hex'));
+    var msg = decrypt.update(test.ct, 'hex', 'ascii');
+    if (!test.tampered) {
+      msg += decrypt.final('ascii');
+      t.equal(msg, test.plain);
+    } else {
+      // assert that final throws if input data could not be verified!
+      t.throws(function() { decrypt.final('ascii'); }, / auth/);
+    }
+  })();
+
+  // after normal operation, test some incorrect ways of calling the API:
+  // it's most certainly enough to run these tests with one algorithm only.
+
+  if (i > 0) {
+    t.end();
+    return;
+  }
+
+  (function() {
+    // non-authenticating mode:
+    var encrypt = crypto.createCipheriv('aes-128-cbc',
+      'ipxp9a6i1Mb4USb4', '6fKjEjR3Vl30EUYC');
+    encrypt.update('blah', 'ascii');
+    encrypt.final();
+    t.throws(function() { encrypt.getAuthTag(); });
+    t.throws(function() {
+      encrypt.setAAD(new Buffer('123', 'ascii')); });
+  })();
+
+  (function() {
+    // trying to get tag before inputting all data:
+    var encrypt = crypto.createCipheriv(test.algo, 
+      new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex'));
+    encrypt.update('blah', 'ascii');
+    t.throws(function() { encrypt.getAuthTag(); }, / state/);
+  })();
+
+  (function() {
+    // trying to set tag on encryption object:
+    var encrypt = crypto.createCipheriv(test.algo, 
+      new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex'));
+    t.throws(function() {
+      encrypt.setAuthTag(new Buffer(test.tag, 'hex')); }, / state/);
+  })();
+
+  (function() {
+    // trying to read tag from decryption object:
+    var decrypt = crypto.createDecipheriv(test.algo,
+      new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex'));
+    t.throws(function() { decrypt.getAuthTag(); }, / state/);
+  })();
+  t.end();
+  });
+}
+for (var i in TEST_CASES) {
+  testIt(i);
+ 
+}
+});
+}

No alert changes

Improved metrics

Total package byte prevSize

324829

13.61%

Number of package files

24

9.09%

Lines of code

2695

26.88%

No dependency changes