ioredis-encrypted

ioredis-encrypted

A wrapper for ioredis that transparently encrypts and decrypts data stored, using node-crypt.

Getting Started

ioredis-encrypted is designed to be a drop in replacement for ioredis, so you should just need to change your require line slightly and just like magic, the data in your redis instance will be secured.

So for starters, install the module with: npm install ioredis-encrypted

Support

NOTE: This implementation is limited to a small collection of commands, for my specific requirements. Sorry, there is only one of me!

• get/set
• hset/hget
• hgetall
• lpush/lpop
• rpush/rpop
• lrange
• pub/sub
• pub/psub

All other commands still work, they blind proxy through to ioredis, they just won't store encrypted data.

More will be coming, when I have time. Open to pull requests too ;)

Examples

I'm expecting that you'll probably have this:

const Redis = require('ioredis');
const redis = new Redis();

You just need to change it to look like this:

const key = 'bfa6220e845a8248f65ebbddf753d6bcdbaab404693890f920c663adce2d7ede';
const hmacKey = 'fdc6de8b925c8e4a120edac298139648e22c31f45d5ab5469ab0d696229338ad';

const Redis = require('ioredis-encrypted')(key, hmacKey);
const redis = new Redis();

Where key, and hmacKey are 32bit hex values.

In Action

Transparent to your application:

$ node
> const Redis = require('ioredis-encrypted')(key, hmacKey);
undefined
> const redis = new Redis();
undefined
> redis.set('akey', 'a value');
undefined
> redis.get('akey', (err, data) => { console.log(data); });
> a value

However if you look what is stored in redis:

$ redis-cli
127.0.0.1:6379> get akey
"ca25c1e77d3689"

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

• 0.1.0 Initial Release
• 0.1.3 Tidyups and bump version of node-crypt

License

Copyright (c) 2017 Karl Stoney Licensed under the Apache-2.0 license.