@adorsys/encrypt-down

:closed_lock_with_key: encrypt-down :closed_lock_with_key:

An abstract-leveldown implementation that wraps another store to encrypt values.

Installation

npm install @adorsys/encrypt-down

Usage

Without any options encrypt-down can be used but nothing is encrypted.

const memdown = require('memdown')
const encryptdown = require('@adorsys/encrypt-down')
const levleup = require('levelup')

const db = levelup(encryptdown(memdown()))

db.put('key', { awesome: true }, function (err) {
  db.get('key', function (err, value) {
    console.log(value) // { awesome: true }
  })
})

Can we specify the encryption that shall be used? Yes!

const memdown = require('memdown')
const encryptdown = require('@adorsys/encrypt-down')
const levleup = require('levelup')

// WARNING: do not use this codec in production it is NOT ENCRYPTING
const codec = {
  encrypt: value => Promise.resolve(value),
  decrypt: value => Promise.resolve(value)
}
const db = levelup(encryptdown(memdown(), { codec }))

db.put('key', { awesome: true }, function (err) {
  db.get('key', function (err, value) {
    console.log(value) // { awesome: true }
  })
})

Is there an example that actually encrypts the values? Yes! We can use an existing encryption library like jwe-codec.

const memdown = require('memdown')
const encryptdown = require('@adorsys/encrypt-down')
const levleup = require('levelup')
const jwe = require('@adorsys/jwe-codec')
const key = {
  kty: 'oct',
  alg: 'A256GCM',
  use: 'enc',
  k: '123456789abcdefghijklmnopqrstuvwxyz12345678'
}

jwe(key).then(function(codec) {
  const db = levelup(encryptdown(memdown(), { codec }))

  db.put('key', { awesome: true }, function (err) {
    db.get('key', function (err, value) {
      console.log(value) // { awesome: true }
    })
  })
})

API

const db = require('@adorsys/encrypt-down')(db[, options])

• db must be an abstract-leveldown compliant store
• options:
  • codec:
    • encrypt: function returning promise of encrypted value
    • decrypt: function returning promise of decrypted value

encrypt and decrypt both default to identity function when not explicitly specified.

Credits

Made with :heart: by radzom and all these wonderful contributors (emoji key):

Vincent Weevers :speech_balloon:

This project follows the all-contributors specification. Contributions of any kind are welcome!