Browse Source

crypto: allow GCM ciphers to have longer IV length

GCM cipher IV length can be >=1 bytes.
When not the default 12 bytes (96 bits) sets the IV length using
`EVP_CIPHER_CTX_ctrl` with type `EVP_CTRL_GCM_SET_IVLEN`

PR-URL: https://github.com/nodejs/node/pull/6376
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Fedor Indutny <fedor.indutny@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
v4.x
Michael Wain 9 years ago
committed by Myles Borins
parent
commit
65624440bf
  1. 14
      src/node_crypto.cc
  2. 325
      test/parallel/test-crypto-authenticated.js

14
src/node_crypto.cc

@ -3028,12 +3028,24 @@ void CipherBase::InitIv(const char* cipher_type,
/* OpenSSL versions up to 0.9.8l failed to return the correct /* OpenSSL versions up to 0.9.8l failed to return the correct
iv_length (0) for ECB ciphers */ iv_length (0) for ECB ciphers */
if (EVP_CIPHER_iv_length(cipher_) != iv_len && if (EVP_CIPHER_iv_length(cipher_) != iv_len &&
!(EVP_CIPHER_mode(cipher_) == EVP_CIPH_ECB_MODE && iv_len == 0)) { !(EVP_CIPHER_mode(cipher_) == EVP_CIPH_ECB_MODE && iv_len == 0) &&
!(EVP_CIPHER_mode(cipher_) == EVP_CIPH_GCM_MODE) && iv_len > 0) {
return env()->ThrowError("Invalid IV length"); return env()->ThrowError("Invalid IV length");
} }
EVP_CIPHER_CTX_init(&ctx_); EVP_CIPHER_CTX_init(&ctx_);
const bool encrypt = (kind_ == kCipher); const bool encrypt = (kind_ == kCipher);
EVP_CipherInit_ex(&ctx_, cipher_, nullptr, nullptr, nullptr, encrypt); EVP_CipherInit_ex(&ctx_, cipher_, nullptr, nullptr, nullptr, encrypt);
/* Set IV length. Only required if GCM cipher and IV is not default iv. */
if (EVP_CIPHER_mode(cipher_) == EVP_CIPH_GCM_MODE &&
iv_len != EVP_CIPHER_iv_length(cipher_)) {
if (!EVP_CIPHER_CTX_ctrl(&ctx_, EVP_CTRL_GCM_SET_IVLEN, iv_len, nullptr)) {
EVP_CIPHER_CTX_cleanup(&ctx_);
return env()->ThrowError("Invalid IV length");
}
}
if (!EVP_CIPHER_CTX_set_key_length(&ctx_, key_len)) { if (!EVP_CIPHER_CTX_set_key_length(&ctx_, key_len)) {
EVP_CIPHER_CTX_cleanup(&ctx_); EVP_CIPHER_CTX_cleanup(&ctx_);
return env()->ThrowError("Invalid key length"); return env()->ThrowError("Invalid key length");

325
test/parallel/test-crypto-authenticated.js

@ -1,12 +1,12 @@
'use strict'; 'use strict';
var common = require('../common'); const common = require('../common');
var assert = require('assert'); const assert = require('assert');
if (!common.hasCrypto) { if (!common.hasCrypto) {
common.skip('missing crypto'); common.skip('missing crypto');
return; return;
} }
var crypto = require('crypto'); const crypto = require('crypto');
crypto.DEFAULT_ENCODING = 'buffer'; crypto.DEFAULT_ENCODING = 'buffer';
@ -16,38 +16,295 @@ crypto.DEFAULT_ENCODING = 'buffer';
// !NEVER USE STATIC IVs IN REAL LIFE! // !NEVER USE STATIC IVs IN REAL LIFE!
// //
var TEST_CASES = [ const TEST_CASES = [
{ algo: 'aes-128-gcm', { algo: 'aes-128-gcm',
key: '6970787039613669314d623455536234', key: '6970787039613669314d623455536234',
iv: '583673497131313748307652', plain: 'Hello World!', iv: '583673497131313748307652', plain: 'Hello World!',
ct: '4BE13896F64DFA2C2D0F2C76', ct: '4be13896f64dfa2c2d0f2c76',
tag: '272B422F62EB545EAA15B5FF84092447', tampered: false }, tag: '272b422f62eb545eaa15b5ff84092447', tampered: false },
{ algo: 'aes-128-gcm', { algo: 'aes-128-gcm',
key: '6970787039613669314d623455536234', key: '6970787039613669314d623455536234',
iv: '583673497131313748307652', plain: 'Hello World!', iv: '583673497131313748307652', plain: 'Hello World!',
ct: '4BE13896F64DFA2C2D0F2C76', aad: '000000FF', ct: '4be13896f64dfa2c2d0f2c76', aad: '000000FF',
tag: 'BA2479F66275665A88CB7B15F43EB005', tampered: false }, tag: 'ba2479f66275665a88cb7b15f43eb005', tampered: false },
{ algo: 'aes-128-gcm', { algo: 'aes-128-gcm',
key: '6970787039613669314d623455536234', key: '6970787039613669314d623455536234',
iv: '583673497131313748307652', plain: 'Hello World!', iv: '583673497131313748307652', plain: 'Hello World!',
ct: '4BE13596F64DFA2C2D0FAC76', ct: '4be13596f64dfa2c2d0fac76',
tag: '272B422F62EB545EAA15B5FF84092447', tampered: true }, tag: '272b422f62eb545eaa15b5ff84092447', tampered: true },
{ algo: 'aes-256-gcm', { algo: 'aes-256-gcm',
key: '337a54767a7233703637564336316a6d56353472495975313534357834546c59', key: '337a54767a7233703637564336316a6d56353472495975313534357834546c59',
iv: '36306950306836764a6f4561', plain: 'Hello node.js world!', iv: '36306950306836764a6f4561', plain: 'Hello node.js world!',
ct: '58E62CFE7B1D274111A82267EBB93866E72B6C2A', ct: '58e62cfe7b1d274111a82267ebb93866e72b6c2a',
tag: '9BB44F663BADABACAE9720881FB1EC7A', tampered: false }, tag: '9bb44f663badabacae9720881fb1ec7a', tampered: false },
{ algo: 'aes-256-gcm', { algo: 'aes-256-gcm',
key: '337a54767a7233703637564336316a6d56353472495975313534357834546c59', key: '337a54767a7233703637564336316a6d56353472495975313534357834546c59',
iv: '36306950306836764a6f4561', plain: 'Hello node.js world!', iv: '36306950306836764a6f4561', plain: 'Hello node.js world!',
ct: '58E62CFF7B1D274011A82267EBB93866E72B6C2B', ct: '58e62cff7b1d274011a82267ebb93866e72b6c2b',
tag: '9BB44F663BADABACAE9720881FB1EC7A', tampered: true }, tag: '9bb44f663badabacae9720881fb1ec7a', tampered: true },
{ algo: 'aes-192-gcm', { algo: 'aes-192-gcm',
key: '1ed2233fa2223ef5d7df08546049406c7305220bca40d4c9', key: '1ed2233fa2223ef5d7df08546049406c7305220bca40d4c9',
iv: '0e1791e9db3bd21a9122c416', plain: 'Hello node.js world!', iv: '0e1791e9db3bd21a9122c416', plain: 'Hello node.js world!',
password: 'very bad password', aad: '63616c76696e', password: 'very bad password', aad: '63616c76696e',
ct: 'DDA53A4059AA17B88756984995F7BBA3C636CC44', ct: 'dda53a4059aa17b88756984995f7bba3c636cc44',
tag: 'D2A35E5C611E5E3D2258360241C5B045', tampered: false } tag: 'd2a35e5c611e5e3d2258360241c5b045', tampered: false },
// Following test cases are from
// http://csrc.nist.gov/groups/ST/toolkit/BCM/documents/
// proposedmodes/gcm/gcm-revised-spec.pdf
// Test case 1
{ algo: 'aes-128-gcm',
key: '00000000000000000000000000000000',
iv: '000000000000000000000000',
plain: '',
plainIsHex: false,
ct: '',
tag: '58e2fccefa7e3061367f1d57a4e7455a', tampered: false },
// Test case 2
{ algo: 'aes-128-gcm',
key: '00000000000000000000000000000000',
iv: '000000000000000000000000',
plain: '00000000000000000000000000000000',
plainIsHex: true,
ct: '0388dace60b6a392f328c2b971b2fe78',
tag: 'ab6e47d42cec13bdf53a67b21257bddf', tampered: false },
// Test case 3
{ algo: 'aes-128-gcm',
key: 'feffe9928665731c6d6a8f9467308308',
iv: 'cafebabefacedbaddecaf888',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a721' +
'c3c0c95956809532fcf0e2449a6b525b1' +
'6aedf5aa0de657ba637b391aafd255',
plainIsHex: true,
ct: '42831ec2217774244b7221b784d0d49c' +
'e3aa212f2c02a4e035c17e2329aca12e2' +
'1d514b25466931c7d8f6a5aac84aa051b' +
'a30b396a0aac973d58e091473f5985',
tag: '4d5c2af327cd64a62cf35abd2ba6fab4', tampered: false },
// Test case 4
{ algo: 'aes-128-gcm',
key: 'feffe9928665731c6d6a8f9467308308',
iv: 'cafebabefacedbaddecaf888',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a721' +
'c3c0c95956809532fcf0e2449a6b525b16' +
'aedf5aa0de657ba637b39',
aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2',
plainIsHex: true,
ct: '42831ec2217774244b7221b784d0d49c' +
'e3aa212f2c02a4e035c17e2329aca12e2' +
'1d514b25466931c7d8f6a5aac84aa051b' +
'a30b396a0aac973d58e091',
tag: '5bc94fbc3221a5db94fae95ae7121a47', tampered: false },
// Test case 5, 8 byte IV
{ algo: 'aes-128-gcm',
key: 'feffe9928665731c6d6a8f9467308308',
iv: 'cafebabefacedbad',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b39',
aad: 'feedfacedeadbeeffeedfacedeadbeef' +
'abaddad2',
plainIsHex: true,
ct: '61353b4c2806934a777ff51fa22a4755' +
'699b2a714fcdc6f83766e5f97b6c7423' +
'73806900e49f24b22b097544d4896b42' +
'4989b5e1ebac0f07c23f4598',
tag: '3612d2e79e3b0785561be14aaca2fccb', tampered: false },
// Test case 6, 60 byte IV
{ algo: 'aes-128-gcm',
key: 'feffe9928665731c6d6a8f9467308308',
iv: '9313225DF88406E555909C5AFF5269AA' +
'6A7A9538534F7DA1E4C303D2A318A728' +
'C3C0C95156809539FCF0E2429A6B52541' +
'6AEDBF5A0DE6A57A637B39B',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b39',
aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2',
plainIsHex: true,
ct: '8ce24998625615b603a033aca13fb894' +
'be9112a5c3a211a8ba262a3cca7e2ca7' +
'01e4a9a4fba43c90ccdcb281d48c7c6f' +
'd62875d2aca417034c34aee5',
tag: '619cc5aefffe0bfa462af43c1699d050', tampered: false },
// Test case 7
{ algo: 'aes-192-gcm',
key: '000000000000000000000000000000000000000000000000',
iv: '000000000000000000000000',
plain: '',
plainIsHex: false,
ct: '',
tag: 'cd33b28ac773f74ba00ed1f312572435', tampered: false },
// Test case 8
{ algo: 'aes-192-gcm',
key: '000000000000000000000000000000000000000000000000',
iv: '000000000000000000000000',
plain: '00000000000000000000000000000000',
plainIsHex: true,
ct: '98e7247c07f0fe411c267e4384b0f600',
tag: '2ff58d80033927ab8ef4d4587514f0fb', tampered: false },
// Test case 9
{ algo: 'aes-192-gcm',
key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c',
iv: 'cafebabefacedbaddecaf888',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b391aafd255',
plainIsHex: true,
ct: '3980ca0b3c00e841eb06fac4872a2757' +
'859e1ceaa6efd984628593b40ca1e19c' +
'7d773d00c144c525ac619d18c84a3f47' +
'18e2448b2fe324d9ccda2710acade256',
tag: '9924a7c8587336bfb118024db8674a14', tampered: false },
// Test case 10
{ algo: 'aes-192-gcm',
key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c',
iv: 'cafebabefacedbaddecaf888',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b39',
aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2',
plainIsHex: true,
ct: '3980ca0b3c00e841eb06fac4872a2757' +
'859e1ceaa6efd984628593b40ca1e19c' +
'7d773d00c144c525ac619d18c84a3f47' +
'18e2448b2fe324d9ccda2710',
tag: '2519498e80f1478f37ba55bd6d27618c', tampered: false },
// Test case 11
{ algo: 'aes-192-gcm',
key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c',
iv: 'cafebabefacedbad',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b39',
aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2',
plainIsHex: true,
ct: '0f10f599ae14a154ed24b36e25324db8' +
'c566632ef2bbb34f8347280fc4507057' +
'fddc29df9a471f75c66541d4d4dad1c9' +
'e93a19a58e8b473fa0f062f7',
tag: '65dcc57fcf623a24094fcca40d3533f8', tampered: false },
// Test case 12, 60 byte IV
{ algo: 'aes-192-gcm',
key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c',
iv: '9313225df88406e555909c5aff5269aa' +
'6a7a9538534f7da1e4c303d2a318a728' +
'c3c0c95156809539fcf0e2429a6b5254' +
'16aedbf5a0de6a57a637b39b',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b39',
aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2',
plainIsHex: true,
ct: 'd27e88681ce3243c4830165a8fdcf9ff' +
'1de9a1d8e6b447ef6ef7b79828666e45' +
'81e79012af34ddd9e2f037589b292db3' +
'e67c036745fa22e7e9b7373b',
tag: 'dcf566ff291c25bbb8568fc3d376a6d9', tampered: false },
// Test case 13
{ algo: 'aes-256-gcm',
key: '0000000000000000000000000000000000000000000000000000000000000000',
iv: '000000000000000000000000',
plain: '',
plainIsHex: false,
ct: '',
tag: '530f8afbc74536b9a963b4f1c4cb738b', tampered: false },
// Test case 14
{ algo: 'aes-256-gcm',
key: '0000000000000000000000000000000000000000000000000000000000000000',
iv: '000000000000000000000000',
plain: '00000000000000000000000000000000',
plainIsHex: true,
ct: 'cea7403d4d606b6e074ec5d3baf39d18',
tag: 'd0d1c8a799996bf0265b98b5d48ab919', tampered: false },
// Test case 15
{ algo: 'aes-256-gcm',
key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c6d6a8f9467308308',
iv: 'cafebabefacedbaddecaf888',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b391aafd255',
plainIsHex: true,
ct: '522dc1f099567d07f47f37a32a84427d' +
'643a8cdcbfe5c0c97598a2bd2555d1aa' +
'8cb08e48590dbb3da7b08b1056828838' +
'c5f61e6393ba7a0abcc9f662898015ad',
tag: 'b094dac5d93471bdec1a502270e3cc6c', tampered: false },
// Test case 16
{ algo: 'aes-256-gcm',
key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c6d6a8f9467308308',
iv: 'cafebabefacedbaddecaf888',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b39',
aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2',
plainIsHex: true,
ct: '522dc1f099567d07f47f37a32a84427d' +
'643a8cdcbfe5c0c97598a2bd2555d1aa' +
'8cb08e48590dbb3da7b08b1056828838' +
'c5f61e6393ba7a0abcc9f662',
tag: '76fc6ece0f4e1768cddf8853bb2d551b', tampered: false },
// Test case 17, 8 byte IV
{ algo: 'aes-256-gcm',
key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c6d6a8f9467308308',
iv: 'cafebabefacedbad',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b39',
aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2',
plainIsHex: true,
ct: 'c3762df1ca787d32ae47c13bf19844cb' +
'af1ae14d0b976afac52ff7d79bba9de0' +
'feb582d33934a4f0954cc2363bc73f78' +
'62ac430e64abe499f47c9b1f',
tag: '3a337dbf46a792c45e454913fe2ea8f2', tampered: false },
// Test case 18, 60 byte IV
{ algo: 'aes-256-gcm',
key: 'feffe9928665731c6d6a8f9467308308feffe9928665731c6d6a8f9467308308',
iv: '9313225df88406e555909c5aff5269aa' +
'6a7a9538534f7da1e4c303d2a318a728' +
'c3c0c95156809539fcf0e2429a6b5254' +
'16aedbf5a0de6a57a637b39b',
plain: 'd9313225f88406e5a55909c5aff5269a' +
'86a7a9531534f7da2e4c303d8a318a72' +
'1c3c0c95956809532fcf0e2449a6b525' +
'b16aedf5aa0de657ba637b39',
aad: 'feedfacedeadbeeffeedfacedeadbeefabaddad2',
plainIsHex: true,
ct: '5a8def2f0c9e53f1f75d7853659e2a20' +
'eeb2b22aafde6419a058ab4f6f746bf4' +
'0fc0c3b780f244452da3ebf1c5d82cde' +
'a2418997200ef82e44ae7e3f',
tag: 'a44a8266ee1c8eb0c8b5d4cf5ae9f19a', tampered: false },
]; ];
var ciphers = crypto.getCiphers(); var ciphers = crypto.getCiphers();
@ -60,18 +317,26 @@ for (var i in TEST_CASES) {
continue; continue;
} }
if (common.hasFipsCrypto && test.iv.length < 24) {
console.log('1..0 # Skipped: IV len < 12 bytes unsupported in FIPS mode');
continue;
}
(function() { (function() {
var encrypt = crypto.createCipheriv(test.algo, var encrypt = crypto.createCipheriv(test.algo,
new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex')); new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex'));
if (test.aad) if (test.aad)
encrypt.setAAD(new Buffer(test.aad, 'hex')); encrypt.setAAD(new Buffer(test.aad, 'hex'));
var hex = encrypt.update(test.plain, 'ascii', 'hex');
var inputEncoding = test.plainIsHex ? 'hex' : 'ascii';
var hex = encrypt.update(test.plain, inputEncoding, 'hex');
hex += encrypt.final('hex'); hex += encrypt.final('hex');
var auth_tag = encrypt.getAuthTag(); var auth_tag = encrypt.getAuthTag();
// only test basic encryption run if output is marked as tampered. // only test basic encryption run if output is marked as tampered.
if (!test.tampered) { if (!test.tampered) {
assert.equal(hex.toUpperCase(), test.ct); assert.equal(hex, test.ct);
assert.equal(auth_tag.toString('hex').toUpperCase(), test.tag); assert.equal(auth_tag.toString('hex'), test.tag);
} }
})(); })();
@ -81,9 +346,12 @@ for (var i in TEST_CASES) {
decrypt.setAuthTag(new Buffer(test.tag, 'hex')); decrypt.setAuthTag(new Buffer(test.tag, 'hex'));
if (test.aad) if (test.aad)
decrypt.setAAD(new Buffer(test.aad, 'hex')); decrypt.setAAD(new Buffer(test.aad, 'hex'));
var msg = decrypt.update(test.ct, 'hex', 'ascii');
var outputEncoding = test.plainIsHex ? 'hex' : 'ascii';
var msg = decrypt.update(test.ct, 'hex', outputEncoding);
if (!test.tampered) { if (!test.tampered) {
msg += decrypt.final('ascii'); msg += decrypt.final(outputEncoding);
assert.equal(msg, test.plain); assert.equal(msg, test.plain);
} else { } else {
// assert that final throws if input data could not be verified! // assert that final throws if input data could not be verified!
@ -106,8 +374,8 @@ for (var i in TEST_CASES) {
var auth_tag = encrypt.getAuthTag(); var auth_tag = encrypt.getAuthTag();
// only test basic encryption run if output is marked as tampered. // only test basic encryption run if output is marked as tampered.
if (!test.tampered) { if (!test.tampered) {
assert.equal(hex.toUpperCase(), test.ct); assert.equal(hex, test.ct);
assert.equal(auth_tag.toString('hex').toUpperCase(), test.tag); assert.equal(auth_tag.toString('hex'), test.tag);
} }
} }
})(); })();
@ -174,4 +442,15 @@ for (var i in TEST_CASES) {
new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex')); new Buffer(test.key, 'hex'), new Buffer(test.iv, 'hex'));
assert.throws(function() { decrypt.getAuthTag(); }, / state/); assert.throws(function() { decrypt.getAuthTag(); }, / state/);
})(); })();
(function() {
// trying to create cipher with incorrect IV length
assert.throws(function() {
crypto.createCipheriv(
test.algo,
Buffer.from(test.key, 'hex'),
Buffer.alloc(0)
);
}, /Invalid IV length/);
})();
} }

Loading…
Cancel
Save