secure-store-redis

secure-store-redis

A simple wrapper to encrypt and decrypt data stored in redis. The main point is to ensure that any data you store in redis cannot be accessed by anyone else outside of the process, without the key.

var SecureStore = require('secure-store-redis');

var store = new SecureStore({
    namespace: 'myApp:store',
    secret: '823HD8DG26JA0LK1239Hgb651TWfs0j1', // must be 32 char secret
    errorOnNotFound: true, //optional; will cb error if data can't be found
    redis: {
      host: 'localhost', // optional
      port: 6379, // optional
      // optionally use the 'url' property to specify entire redis connect string
      // url: 'redis://localhost:6379',
      max_clients: 30, // optional
      database: 0, // optional
      options: {
        auth_pass: 'password'
      } //options for createClient of node-redis, optional
    }
});

store.save('quote', 'i see dead people', function (err, reply) {
    //...
    store.get('quote', function (err, reply) {
        // err: null
        // reply: 'i see dead people'
    });
    store.get('quote', function (err, reply) {
        // err: record not found
        // reply: undefined
    });
});

store.delete('quote', function (err, reply) {
  // err: null
  // reply: 1
});


var otherStore = new SecureStore({
    prefix: 'myApp:store',
    secret: 'this is the wrong secret',
    redis: { // standard redis config object
        host: "127.0.0.1",
        port: 6379
    }
});

otherStore.get('quote', function (err, reply) {
        // err: record not found
        // reply: undefined
    });