@adorsys/encrypt-down
v2.1.2
Published
Encryption layer for level-db
Downloads
688
Readme
:closed_lock_with_key: encrypt-down :closed_lock_with_key:
encrypt-down is an encryption layer for LevelDB.
For LevelDB exist several persistence bindings. Amongst others bindings for IndexedDB.
By using encrypt-down it is possible to store lots (several MB) of sensitive user data securely (encrypted) in the browser across user sessions.
Installation
npm install @adorsys/encrypt-down
Usage
We need a JSON Web Key (JWK) or JSON Web Key Set (JWKS) as specified by RFC 7517.
const memdown = require('memdown')
const encryptdown = require('@adorsys/encrypt-down')
const levelup = require('levelup')
const jwk = {
kty: 'oct',
alg: 'A256GCM',
use: 'enc',
k: '123456789abcdefghijklmnopqrstuvwxyz12345678'
}
const memdb = memdown()
const db = levelup(encryptdown(memdb, { jwk }))
db.put('key', { awesome: true }, function (err) {
memdb._get('key', { asBuffer: false }, function (err, value) {
console.log(value)
// eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIiwia2lkIjoialpESEVqN0ZhR3N5OHNUSUZLRWlnejB4TjFEVWlBZWp0S1ZNcEl2Z3dqOCJ9..LLeRPtRCpn-Zie6-.zZc0LQ_vvHCppRAaC5fxw4yJ0041l6mGOSgLDVnaPagSv_3Khp8a8lyAo9utHQKpVX6RNVaVPBQQxJpkw_Zyljeg7L-O_Nc3N2Hi_904qE6_zwORqQRc.R0JhfgTHIcD_93kXzZ8BrA
})
db.get('key', { asBuffer: false }, function (err, value) {
console.log(value)
// { awesome: true }
})
})
Browser Support
API
const db = require('@adorsys/encrypt-down')(db[, options])
db
must be anabstract-leveldown
compliant storeoptions
:jwk
: a JSON Web Key (JWK) or JSON Web Key Set (JWKS) as specified by RFC 7517
Credits
Made with :heart: by radzom and all these wonderful contributors (emoji key):
This project follows the all-contributors specification. Contributions of any kind are welcome!
Big Thanks
Cross-browser Testing Platform and Open Source ♥ Provided by Sauce Labs.
Contributors ✨
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!