metawa / browser-passworder

A simple browserifiable module for encrypting and decrypting JSON-serializable objects with a password.

Browser Passworder

A simple module for encrypting & decrypting Javascript objects with a password in the browser.

Serializes the encrypted payload as a string of text for easy storage.

Uses browser native crypto to be the lightest possible module you can have, with the most vetted internals you could ask for (the real guts here are implemented by the browser provider).

Installation

You need to have node.js installed.

yarn install browser-passworder

Usage

var passworder = require('browser-passworder')

var secrets = { coolStuff: 'all', ssn: 'livin large' }
var password = 'hunter55'

passworder.encrypt(password, secrets)
.then(function(blob) {
  return passworder.decrypt(password, blob)
})
.then(function(result) {
  assert.deepEqual(result, secrets)
})

There are also some more advanced internal methods you can choose to use, but that's the basic version of it.

The most advanced alternate usage would be if you want to cache the password-derived key to speed up performance for many encryptions/decryptions with the same password.

Details

The serialized text is stored as a JSON blob that includes two base64-encoded fields, data and iv, neither of which you need to worry about.

The data is encrypted using the AES-GCM algorithm. It is salted with the result of crypto.getRandomValues(), and the encryption vector is generated the same way.

Running Tests

If modules are not installed, first be sure to run:

yarn

Then to activate the test suite:

yarn test