blind-encryption-sodium 2.1.0 → 3.0.0

package/README.md

@@ -10,7 +10,7 @@ const b4a = require('b4a')
 
 const key = b4a.alloc(32) // 32-byte key
 
-const encryption = new BlindEncryptionSodium([{ key, type: 0 }])
+const encryption = new BlindEncryptionSodium(key)
 
 const encrypted = await encryption.encrypt(plaintext)
 // { value: <Buffer>, type: 1 }
@@ -20,12 +20,11 @@ const { value, rotated } = await encryption.decrypt(encrypted)
 // if rotated, it was decrypted with a newer type, and you should encrypt and store
 ```
 
-Multiple values can be passed in. This enables you to "rotate" keys.
+Multiple values can be passed in. This enables you to "rotate" entropies.
 
-- Value encrypted with an old `type` will be upgraded to the latest `type`
-- Cannot be downgraded
+- Value encrypted with an entropy will be decoded with the old entropy automatically
 - Old types are no longer needed after upgrade
-- Returns if rotated when decrypting. Note: if it was decrypted with a newer type, you should encrypt and store to ensure it uses your latest key/entropy
+- Returns if rotated when decrypting. Note: if it was decrypted with a newer entropy, you should encrypt and store to ensure it uses your latest entropy
 
 ### Usage with Autobase:
 
@@ -34,10 +33,7 @@ const base = new Autobase(store, {
   apply,
   open,
   encryptionKey,
-  blindEncryption: new BlindEncryptionSodium([
-    { key: oldKey, type: 0 },
-    { key: newKey, type: 1 }
-  ])
+  blindEncryption: new BlindEncryptionSodium(newKey, oldKey)
 })
 ```
 

package/index.d.ts

@@ -5,7 +5,7 @@ declare module 'blind-encryption-sodium' {
   }
 
   declare class BlindEncryptionSodium {
-    constructor(entropy?: Buffer | null)
+    constructor(entropy: Buffer, oldEntropy?: Buffer)
     encrypt(key: Buffer): Promise<EncryptedData>
     decrypt(data: EncryptedData): Promise<Buffer>
   }

package/index.js

@@ -2,40 +2,28 @@ const b4a = require('b4a')
 const sodium = require('sodium-universal')
 
 class BlindEncryptionSodium {
-  constructor(entropies) {
-    this._entropies = entropies.sort((a, b) => b.type - a.type)
-
+  constructor(entropy, oldEntropy) {
     this.encrypt = async (value) => {
-      // use latest
-      const entropy = this._entropies[0]
-      const buffer = this._encrypt(value, entropy.key)
+      const buffer = this._encrypt(value, entropy)
 
-      return { value: buffer, type: entropy.type }
+      return { value: buffer, type: 0 }
     }
 
-    this.decrypt = async ({ value, type }) => {
-      let entropy = this._entropies[0]
-
-      // no backward compat
-      if (type > entropy.type) throw new Error('Encrypted using new type: ' + type)
-
-      let rotated = false
+    this.decrypt = async ({ value }) => {
+      const { output, ok } = this._decrypt(value, oldEntropy || entropy)
 
-      // auto upgrade
-      if (type < entropy.type) {
-        entropy = this._entropies.find((e) => e.type === type)
-        if (!entropy) throw new Error('Missing type: ' + type)
-        rotated = true
+      if (!ok) {
+        throw new Error(`failed to rotate`)
       }
 
-      return { value: this._decrypt(value, entropy.key), rotated }
+      return { value: output, rotated: !!oldEntropy }
     }
   }
 
   _encrypt(value, entropy) {
     if (!value || !value.byteLength) throw new TypeError('value must be a Uint8Array')
     if (!entropy || entropy.byteLength !== sodium.crypto_secretbox_KEYBYTES) {
-      throw new Error('invalid key length')
+      throw new Error('invalid entropy length')
     }
     if (value.byteLength < 32) {
       throw new Error('value too short')
@@ -58,8 +46,8 @@ class BlindEncryptionSodium {
     const box = value.subarray(nonce.byteLength)
     const output = b4a.alloc(box.byteLength - sodium.crypto_secretbox_MACBYTES)
 
-    sodium.crypto_secretbox_open_easy(output, box, nonce, entropy)
-    return output
+    const ok = sodium.crypto_secretbox_open_easy(output, box, nonce, entropy)
+    return { output, ok }
   }
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "blind-encryption-sodium",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "Implemention of encryption encoding for Autobase blind encryption using sodium easy box",
   "main": "index.js",
   "exports": {