Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install ripple-encryption
You call the activation, which initializes a global serializer within Ripple. Any object that gets saved with content-type 'application/x-json-encrypted' then goes through the Encryption::Serializer, which loads or unloads the data from Riak through the JsonDocument and EncryptedJsonDocument, respectively. Both of these have a dependency on Encryption::Encrypter, which makes the actual calls to OpenSSL.
JsonDocument stores the encrypted data wrapped in JSON encapsulation so that you can still introspect the Riak object and see which version of this gem was used to encrypt it. As of version 0.0.4, this is now the only supported serialization format for JSON data.
There is also a Rake file to convert between encrypted and decrypted JSON objects.
Include the gem in your Gemfile. Activate it somewhere in your application initialization by pointing it to your encryption config file like so:
Then include the Ripple::Encryption module in your document class:
class SomeDocument include Ripple::Document include Ripple::Encryption property :message, String end
These documents will now be stored encrypted.
Running the Tests
Adjust the 'test/fixtures/ripple.yml' to point to a test riak database.
bundle exec rake
This gem stores serialized encryption objects into Riak. The serialization
format is versioned; and where possible incrementally transitioned from one
version to another. Currently; only the
JsonSerializer supports this
type of incremental transition with the support matrix below.
BinarySerializer does not support incremental format transition but
does make the version and iv available for external code to support this.
- Fork it
- Create your feature branch (
git checkout -b my-new-feature)
- Commit your changes (
git commit -am 'Added some feature')
- Push to the branch (
git push origin my-new-feature)
- Create new Pull Request