Add backwards compatibility test for encryption (#681)

* createLegacyProvider only takes blockKey

* add back compat test

* fixtures are exported from cjs file

* generate encryption fixtures by version

* standard

* remove log

* close stream properly

Author: chm-diederichs

index.js

@@ -1069,7 +1069,7 @@ class Hypercore extends EventEmitter {
       ? encryptionKey
       : getLegacyBlockKey(this.key, encryptionKey, this.core.compat)
 
-    return HypercoreEncryption.createLegacyProvider(encryptionKey, blockKey)
+    return HypercoreEncryption.createLegacyProvider(blockKey)
   }
 }
 

test/encryption.js

@@ -1,9 +1,12 @@
 const test = require('brittle')
 const b4a = require('b4a')
+const crypto = require('hypercore-crypto')
 const HypercoreEncryption = require('hypercore-encryption')
 const Hypercore = require('..')
 const { create, createStorage, replicate } = require('./helpers')
 
+const fixturesRaw = require('./fixtures/encryption/v11.0.48.cjs')
+
 const encryptionKey = b4a.alloc(32, 'hello world')
 
 test('encrypted append and get', async function (t) {
@@ -273,9 +276,86 @@ test('block encryption module', async function (t) {
   }
 })
 
+test('encryption backwards compatibility', async function (t) {
+  const encryptionKey = b4a.alloc(32).fill('encryption key')
+
+  const compatKey = crypto.keyPair(b4a.alloc(32, 0))
+  const defaultKey = crypto.keyPair(b4a.alloc(32, 1))
+  const blockKey = crypto.keyPair(b4a.alloc(32, 2))
+
+  const fixtures = [
+    getFixture('compat'),
+    getFixture('default'),
+    getFixture('default'),
+    getFixture('block')
+  ]
+
+  const compat = await create(t, null, { keyPair: compatKey, encryptionKey, compat: true })
+  const def = await create(t, null, { keyPair: defaultKey, encryptionKey, isBlockKey: false })
+  const notBlock = await create(t, null, { keyPair: defaultKey, encryptionKey, isBlockKey: false })
+  const block = await create(t, null, { keyPair: blockKey, encryptionKey, isBlockKey: true })
+
+  await compat.ready()
+  await def.ready()
+  await notBlock.ready()
+  await block.ready()
+
+  const largeBlock = Buffer.alloc(512)
+  for (let i = 0; i < largeBlock.byteLength; i++) largeBlock[i] = i & 0xff
+
+  for (let i = 0; i < 10; i++) {
+    await compat.append('compat test: ' + i.toString())
+    await def.append('default test: ' + i.toString())
+    await notBlock.append('default test: ' + i.toString())
+    await block.append('block test: ' + i.toString())
+  }
+
+  await compat.append(largeBlock.toString('hex'))
+  await def.append(largeBlock.toString('hex'))
+  await notBlock.append(largeBlock.toString('hex'))
+  await block.append(largeBlock.toString('hex'))
+
+  // compat
+  t.comment('test compat mode')
+  t.is(compat.length, fixtures[0].length)
+
+  for (let i = 0; i < compat.length; i++) {
+    t.alike(await compat.get(i, { raw: true }), fixtures[0][i])
+  }
+
+  // default
+  t.comment('test default mode')
+  t.is(def.length, fixtures[1].length)
+
+  for (let i = 0; i < def.length; i++) {
+    t.alike(await def.get(i, { raw: true }), fixtures[1][i])
+  }
+
+  // not block
+  t.comment('test block false')
+  t.is(notBlock.length, fixtures[2].length)
+
+  for (let i = 0; i < notBlock.length; i++) {
+    t.alike(await notBlock.get(i, { raw: true }), fixtures[2][i])
+  }
+
+  // compat
+  t.comment('test block mode')
+  t.is(block.length, fixtures[3].length)
+
+  for (let i = 0; i < block.length; i++) {
+    t.alike(await block.get(i, { raw: true }), fixtures[3][i])
+  }
+})
+
 function getBlock (core, index) {
   const batch = core.core.storage.read()
   const b = batch.getBlock(index)
   batch.tryFlush()
   return b
 }
+
+function getFixture (name) {
+  const blocks = fixturesRaw[name]
+  return blocks.map(b => b4a.from(b, 'base64'))
+}

test/fixtures/encryption/generate.js

@@ -0,0 +1,78 @@
+// Generate encryption fixtures
+
+const fs = require('fs')
+const path = require('path')
+const crypto = require('hypercore-crypto')
+const tmpDir = require('test-tmp')
+
+const Hypercore = require('../../../')
+const { version } = require('../../../package.json')
+
+main()
+
+async function main () {
+  const encryptionKey = Buffer.alloc(32).fill('encryption key')
+
+  const compatKey = crypto.keyPair(Buffer.alloc(32, 0))
+  const defaultKey = crypto.keyPair(Buffer.alloc(32, 1))
+  const blockKey = crypto.keyPair(Buffer.alloc(32, 2))
+
+  const closing = []
+
+  const compat = new Hypercore(await tmpDir({ teardown }), { keyPair: compatKey, encryptionKey, compat: true })
+  const def = new Hypercore(await tmpDir({ teardown }), { keyPair: defaultKey, encryptionKey, isBlockKey: false })
+  const block = new Hypercore(await tmpDir({ teardown }), { keyPair: blockKey, encryptionKey, isBlockKey: true })
+
+  await compat.ready()
+  await def.ready()
+  await block.ready()
+
+  const largeBlock = Buffer.alloc(512)
+  for (let i = 0; i < largeBlock.byteLength; i++) largeBlock[i] = i & 0xff
+
+  for (let i = 0; i < 10; i++) {
+    await compat.append('compat test: ' + i.toString())
+    await def.append('default test: ' + i.toString())
+    await block.append('block test: ' + i.toString())
+  }
+
+  await compat.append(largeBlock.toString('hex'))
+  await def.append(largeBlock.toString('hex'))
+  await block.append(largeBlock.toString('hex'))
+
+  const fixture = fs.createWriteStream(path.join(__dirname, `v${version}`))
+
+  fixture.write('/* eslint-disable */\n\n')
+
+  await writeFixture('compat', compat)
+  await writeFixture('default', def)
+  await writeFixture('block', block)
+
+  fixture.write('/* eslint-enable */\n')
+
+  fixture.end()
+  await new Promise(resolve => fixture.on('close', resolve))
+
+  await compat.close()
+  await def.close()
+  await block.close()
+
+  await shutdown()
+
+  function teardown (fn) {
+    closing.push(fn)
+  }
+
+  function shutdown () {
+    return Promise.all(closing.map(fn => fn()))
+  }
+
+  async function writeFixture (name, core) {
+    fixture.write(`exports['${name}'] = [\n`)
+    for (let i = 0; i < core.length; i++) {
+      const b64 = (await core.get(i, { raw: true })).toString('base64')
+      fixture.write(`  '${b64}'${(i === core.length - 1) ? '' : ','}\n`)
+    }
+    fixture.write(']\n\n')
+  }
+}

test/fixtures/encryption/v11.0.48.cjs

@@ -0,0 +1,45 @@
+/* eslint-disable */
+
+exports['compat'] = [
+  'nDwlg9HRVVn48l5C+beY4f1hlxif8A==',
+  'PLfFcX+Z9TFJS5viqhMYATUyhMk7rw==',
+  'QbLGoZSGCQtO/U4DJ2cIN7Kk4FzAZw==',
+  '8pnkYgewV1dENUgeQs6YY+0CsV6ctA==',
+  'vP8WwW71BLHHs3fcHmTtSxmmV3tvpQ==',
+  '8LO53CW0Mn0BOGjPjwASq8ZycaRWiA==',
+  'OJql22gF2kO7o6IRjLHFVqL2413PAQ==',
+  'CohERKsAMKtiI3LwPo+ELVMraGMKtw==',
+  '5gxIRLBm/q+6Pc0ww3+AxCi41RcudA==',
+  'mBr2B3XnMnSYo2KzC6MNBOtchY2EUw==',
+  'w9PUVzvOSjYZdzL3n/3Yjyk8Pm3prIfc/MkRNCtSvVRT1rK86nuLfb3YkKWgY7Ed0YD9X+DB680VxIBXneRACZCP9SUtkQ5iLhaD9/riG0Fw+penagGC9X47108EJAd1gMR1O1G2WH7nVRVb3y/myo98anwkG+eKi8xGIn+UARBdQtNkzz3l+Y/QMZ1wvDOEaZh/Ffp0AVNj66yvDlnHINFc5q7VRKNrddXa70rNPlD1zqYNmqbvAV8QBdPLUjPjWGCCi1Y8gWC74ocYSUT9Z8iS8DQ/SzUplQJIvsBgCJrIn7zlldOTL7EMw7O3564Ojl93GRHbDregmXkyiNrnlJRkk8i3loHXoW3kJ1DDLOCS00Se3w2xOqOOLtd4XhRR9kr7qiQ4uHJv+duNdfrVhNiicAVXe6TW4RCPVIlUkOMv5rKAO5KGqIOAD34nQgyeSoIhKxitKXwgadgm+g9ahbSXufu0EPr4bh4CuQ95bIWsTaXFn76HajRDwQMgNuNJPjCD/SE4EFyTjZaPwKuPE5FFodBPHpW43S1+UBwN5Vh+NO2WVwL9neVQKe9FvLBAk44ndMzZLebGJVwEFBogREBTxoLU0AreCjkpS0pzmIzk5byHJrcsm0GFEH+e+zKmfIEYwhUdpNPW3wrM0J/PL9rfD2N/GbCOdc58D5FwOgJcL1fK37lly6iT7XRXUrGgIOED9VfQYrWWnvnxiHLAQQ+poy51IldzsHR5pySdhyim3/+pezJuEcm3V0Vx8+Xxf7ciZ0xbueLVMvvqQ3MLCc6ZSA7az7HvJw8jqeq5/miIcEVVclCD0EGiDa32erGwsoFCu5D0PdV9+emmEg6X47WwPiorDrdrAEZlZwxYR/TTztU+A+e/Y1gahY0jjiSObIBr2UvIoeFae/QxDYmzvwAkeKCOWAStYXso0hWJVeI72oYAnmIiGA9yBXJhdWJY9IewS77oFnOBjKKmLJUbeoACEBxqbebDizE9562666Netqo6HyuAu+0jcuea3ZKjvh0ZwD6Rpv+7VjGL7R633fQwdrmL5iWrXO5wY/mOcq86+g3yVOvZr+sfbL9VAdACYut/Himzak980xfQraX1omDxg03wuQFYvbKJ04Uzca+FbYxnl4YzbVfuZt8wLoBTPssTFFWhQxkiYoqHmhbklIU83nMiNH+U8T7nrtNCBXgCmQEImAiroMIPGaP0v+A3skAI6rgVtL2IZ6mf6LVDDWVhXgPu5uHi3QHiuqv/rGF8ongWEIqQqRgt7sRAK7mwluKzceDEZuU+zhdYID3P1iVvzHo2QEOCWfN95j9+GRyFUMCjc/3e+BOvrtNu2gloCAaZ3E0p7kQt7zTAX3qMs/UvB9LzVD2d'
+]
+
+exports['default'] = [
+  '/UFE+5IFU2U3o/jwybXF9Yf+0JlwfsM=',
+  'no9bWiyQvlaabzLKKfbvfkqW9IcTKc8=',
+  'VPg3K5hmg+BBSn+xPmUrZcjp3s2vLG8=',
+  'WjF137E0suunTmbtcyJMaUkMISpYOoU=',
+  '1wsLIjbEqsD6Pmef9irDIjUjshi+Upo=',
+  'GJWnyuKtIaq9dqIWv6hd4RLotToIH6g=',
+  'Vsm2xOl1aGgI2vPmAj8ZKs7/xgaa8R4=',
+  'Vxy1Q524Zke8RSu62qYViSymsFPwgh4=',
+  'Y8QlWTKAqUcfiR1ozb9uj7nzsG19Pfw=',
+  'HJqWtozv1C7wQjWnwVyL+wP9/7obVcs=',
+  'rOi0T3JF6VeEQ/eSOyaRsMaGBXWi1bbEAu8G9a0A6Zesg1lhfRYG5N7du/aIF4WVMjwpMhTU+dQq4r/j/KmF/SCfnthQeyytJl1yxvYNDOSXacTc/D8DBKjU7IQqpl6bRkmpJDJwUlBOTLMD/daYa0sXpnYg1jyhlqmi4genCPUx9pkER/6vAPrdHq1zkwuVMYT3aoinQrco+HrhlHxFAAqxoPElAUJE1+VFn5xKe77pkoUwHsj7vjqG/r4s9qDjtYxwc2ZNo90o2FmTJ+KnL9IvGYcwNyBP3ZDsPspcPyQdtK1rS6zQJHGf4qLpg+1NnbQ3BHWJ64BWN9y3hLWTzH4Xau2u8S2ipCmrusHLeIJQAUXOmPKYFYFuSPOSIvAGpHNYWpDvyPFbCs0ZC2ttD/GIMaJLWT8XYL6isY4ns8HYOB0gCndT9RZLdVW0VT1jkYhtbVqlQD1LHaGhhXxJnucVJ1PI8ZbT+CiygmxqCMeG0C76hKjbTEcTiQuhH3B9Tk8s3Wifj8YlElyGkOTSHtVM2x6pEei0EP9kqtB8mt9wGwVd3RjUYJoNcZt7r3X6ZsGjFmYIIMmZmilFloB7uIUABtIecukrvlbRzpy5RzlRr0cywPMW+MO6qY1SPgeAdtMHoqj2fW/RNUZMT7exrKGVetWuCqaTiPeR1gC4qAdBtc5DHwoBhxo4meyp876E9/BRpFUnw3E5HLeadu6jTnC7zdfveUk7+HJx7iLxaVPDxVQqNQpB/xjBCHtDMWdJ0FxWbS55TvCbK+s8QMPN+PtIzT3WWD9/6y2DvxdNqjQDVBZHxJidS3HPkpq8nUrfDGQhzlZ3qDLeRrASxl2rODVO6JU6kxLYXTpMFsqj4pUgJNMPnt5d2klXS0qQD8ZE/HlRNB4jXmJ8dbGOC/izFtmMhene4Np7n5sEYiJgfvsXk7TAR7/d/nRLIx7drEqwyoHzQtISez9SxF2d79/tNfE3QVi/wKIjo72tGw+3jaryYEuuZkx+tvaXIbBDWKglHemD0orNCRuuf+ZPyNjb8WlMrZ5J4HP6cI/uz8xHc4owypdqxEt2Ne2QTq/Z3XaT/sOQhiF1WM1BlZ6pstX1/Es6g9k4fHvXJMvgGn13LRBtSliUKN08GeCVv5ozs/0kUYsHe1SFX0tCoA2S2yU5V6aUTa1+bC2gnhxO4mYoGhwyqny7vjFg2hwVYLaDg4JgaGf9ePYLKj/M5Xj5Q+Q44ZKgjcuXRA10buIcXeR1EsScBiqwjzR/8D0hHACoJ81utNfN9L7OtIUh6OIYRYnMxcNx5Y3svgxb7STTmrLkorD2UdNZjSo7sKLXIMaJSY5n0p+kZQjOsgHxMyfUNkZVvRNZTfbc60wd'
+]
+
+exports['block'] = [
+  '87VJ77lmAFwJzx9vlrKaB+XB/REc',
+  'G0JfCfdn1m9FQlqjfexPK8xJQD4d',
+  'C8Zuffa7K1Kf+Gvw7GbgSN5E+3zd',
+  '8MF5UefDZkf93UzRenq3ebfyQ02A',
+  '0OLCgve744BDosP4g+RQrUbeZdHh',
+  '93gFjJH1tzvHdyad1S6+1iF1rJVn',
+  'VxnSlCE/vgI1aB/d6tAaGJpawQfi',
+  'neKG5Nl77jFCQFTvFvsxp+1pvoFA',
+  'r96xMtHumU388zQETcHcUkU//wyT',
+  'YH44ccE3PF57SMPbh7G4TVFOLn+/',
+  'e33cPYNqfjwsRDQjjwcdtSiffKXFu+j82ffRn7TUsaZ09Ms6gug4KVb5ky/OFAz1VRVab9Mp+tlZHxfmmdUC9KCQMcFf677CsxZwyfvh22JtFWK4cDPLdJog+9Aed4iJaZ6DSK/QXm6x/QPTrX3aXTWq/U0z/yU1NEg2i1i4yMjfWU/+3FAa0XwF+9xmjpLrFKKfOrny6QLgZGlYwjtRJqJpbHIF5FpJtzWaY7l6ya1shzNv2gZ88RUKag2bwunvcC9KuT5wnfhkDjFv/oVn6nvqjKXxKpvyEZ5MnzOkZNL9zSxFj8vXM+2hcwItwzSIHKsnoCmZVgePsWkZOQ3MlEW8fMsS2S4wtFeiBQFnuELGfZXgH+6Iv0UuXc+bv5DAMnwLHdpQgFYNLVqptRlbbmY+EKkxbyLjcp9Z3b5zP1JuV2136ZT1CUTZEUTQ/e4hj582TmcmUKYORirzoImBPHR112UCeBn9yRR/BsLSp+po0VamcxRjvp4mgJAJj5OGA/70nSU30Nd71JaogtirUv8yt10gYRb1FK1I1Uh2R8/SCKm34I/XZQXIB+1R0SVp/qLwmGaI8XyoOWJXHkYqTc3K5IzAr762WA3xDtMc8e2eUSFaVLuOcXGCBut2jzyeeWDUR6Ge5UpWeT8NAHg+zWQKk4CRN4U/PoQwOJB/qRdUg9G5R6c5W+pGHmQKv6qSBeKVlL3BjzG4c6f1mGe6n4t7YHZYV3ZNlSxMOtGhpWLKUAasWmRvpFtyouMAbYh0yNCsbc8VE5CnZs7YoebtSjvCoDEf/k7cEEH9bsMgs0IG4MFZ58Th0LHZGXdQWNwhS4Zh8eYukWF2CUU5QyUZxNSn2f84kRqlb6DQ7ps7xSzPXBEIFMAv5RTxRPk5EexT8Tnc7JQpssLKx2RMTUYBV/ZqzJeQ/k/HEMgkf7biwhiKKZ5/PbiDbO3oqHmDlIx7XVxp+svHgqIsZldJ03LfX31aKnASE3YBbgxwJHeaYLWV64xFfbOo+VtqP+F5ZjVUQtf/FjYA4h1ATE2GkNlqlC7dwgJzuUqC1IkvONNUfCHSUVKou4/LKs/O8ncGkhhjJzbbg9OGKmGl2T9Hcfgq42uloWhiiN0mOaIJxt9ZT0VoAox8PQ5783JnNFeVkgJ0H+nlOY8iy4DcaoOKzGsuZFLWvG1uhhktcx3pUlX9ufdAhiPlaVmpR2UfRESMf8QTIzCs0VqfbSyxxrESGoVcEgICXYDW5HCjzl5O8e18NqnreiuCYMqTjPGY0u0aOm2XIemSU6rqJ0SVknZdoDuF0KI8no65z0iPeePK+Z7odBme5XvErxKLN0VFNPm4sGhTrC1Gh8sH1n6XWsmd+VnnV0/wJ1BdMlFe'
+]
+
+/* eslint-enable */