cerebus 0.0.2 → 0.0.3

data/README.md

@@ -2,12 +2,23 @@
 
 ## Summary
 
-This is a simple library which wraps openssl to provide a (hopefully)
-secure encryption system for arbitrary strings. The aim was to remove
-all the hard stuff and make it blindingly easy to encrypt and decrypt
-strings. Of course, this doesn't mean you can ignore basic crypographic
-best practices. If you store all your keys insecurely then you might as
-well use rot13.
+Cerebus was the many headed guardian at the entrance of hell. So... he
+guards things of little value, kind of like this library. This is a simple
+library which wraps openssl to provide a (hopefully) secure encryption
+system for arbitrary strings. The aim was to remove all the hard stuff and
+make it blindingly easy to encrypt and decrypt strings. Of course, this
+doesn't mean you can ignore basic crypographic best practices. Play safe,
+this is serious stuff.
+
+It uses an RSA public key to encryt a Blowfish key which is used to
+encrypt the data. Decryption uses the RSA private key to decrypt the
+Blowfish key and then the data. Which is a fairly common pattern. It
+would be easy to adapt to use AES-256, IDEA or any of the other popular
+block cyphers.
+
+The main value of this library is hiding the implementation internals of
+such a common operation. I couldn't find anything off-the-shelf that
+made this easy.
 
 ## Examples
 
@@ -19,7 +30,16 @@ cleartext = 'It is a secret to everybody!'
 encrypted = Cerebus.encrypt cleartext, 'test/keys/public.pem'
 ```
 
-For rails it's the same, just first add it to the Gemfile and bundle install to get openssl.
+Decryption is similarly simple.
+
+```
+require 'cerebus'
+cleartext = Cerebus.decrypt encrypted_text, 'test/keys/private.pem',
+'pass phrase'
+```
+
+Passphrase can be optionally left off and you will be prompted for it on
+the terminal. For rails just add it to the Gemfile and bundle install.
 
 ## Making Keys
 

data/lib/cerebus.rb

@@ -3,7 +3,7 @@
 require 'openssl'
 
 module Cerebus
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 
   def Cerebus.make_key
     OpenSSL::Random.random_bytes(56)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cerebus
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors: