serket 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ad79717d0198ee41fa6b33200a5e3981b38e23f
-  data.tar.gz: 4a81d8df831e731c119852f48d41ba1a9b697b97
+  metadata.gz: 9849d15eee6960c7de33414df0d5748a5175d6a6
+  data.tar.gz: 87fd71b37ebcb7ca3f21a67c58a1211b2140bd57
 SHA512:
-  metadata.gz: 9fe9da5c68f650defa989dc9ff38b95e888919efce12c8095b1fd74135dd47aecb7e9b206b1f21dc035a0d20afb0551c1195e038f98ef64c54acab19f8d905eb
-  data.tar.gz: b422b32fbddeb028a070b758a4dec4d90406ed85b25a01aeb827ca175e6d778b66c1d26999ecd4c5cd23740e31aaacd4a46977b6bad90b7d5ead469378de3c6e
+  metadata.gz: 97aad6851b4293cb0f1f5a91a265843127c18d30e2f84aa78b302a2e562f527ffd224be67aa908cda35f1ccc891362886e7eb78f71b1769da2621d3b12053be9
+  data.tar.gz: c92245e14eca0be9ea732fc2469558a7a9a257464337946db754d8ee0be22f395cefd68dd5a9d46132823b2ba2cd66873af05ce99749390dbe3bb5c88317d1b7

data/README.md

@@ -4,6 +4,8 @@ A gem for creating encrypted data using RSA and (by default) AES-256-CBC.
 
 The envisioned use case for this is to encrypt data before saving it to a server or mobile device using a public key, and decrypting that data only when it is sent to another server that has the private key.
 
+It works by generating a random AES key, encrypting text with that generated key, encrypting the generated AES key with RSA, and then saving the initialization vector + rsa-encrypted aes-key + the aes-encrypted cipher text in either a delimited string or json.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -20,6 +22,8 @@ Or install it yourself as:
 
 ## Usage
 
+### Encrypting data
+
 To encrypt data, you must first tell serket where your public key is:
 
 ```
@@ -30,12 +34,14 @@ end
 
 You can then use the FieldEncrypter class to encrypt some text:
 ``
-  Serket::FieldEncrypter.encrypt("Hello out there!")
+  Serket.encrypt("Hello out there!")
 ``
 
 By default, this will return a double-colon (::) delimited string.  The first field is the initialization vector used for the symmetric encryption algorithm (by default, this is AES-256-CBC).  The second field is the encrypted key for the symmetric algorithm.  This key is encrypted using RSA, using the provided public key.  The final field is the encrypted text ("Hello out there!" in this example).
 
 
+### Decrypting data
+
 To decrypt data, tell serket where to find your private key:
 ```
 Serket.configure do |config|
@@ -45,23 +51,31 @@ end
 
 This expects the same format described for encryption, and is the inverse operation.
 
-Quick Start:
+```
+  Serket.decrypt(Serket.encrypt('Hello out there!'))
+```
+
+### Quick Start
 
 ```
 Serket.configure do |config|
-  config.public_key_path = "spec/resources/test_public_key.pem"
-  config.private_key_path = "spec/resources/test_private_key.pem"
+  config.public_key_path = "public_key.pem"
+  config.private_key_path = "private_key.pem"
 end
 
-encrypted = Serket::FieldEncrypter.new.encrypt("Hello out there!")
-puts "#{encrypted} can be decrypted to #{Serket::FieldDecrypter.new.decrypt(encrypted)}"
+encrypted = Serket.encrypt("Hello out there!")
+puts "#{encrypted} can be decrypted to #{Serket.decrypt(encrypted)}"
 ```
 
+### Additional configuration
+
 There are a few more configuration options.
 
-format: :delimited (default), :json
-symmetric_algorithm: AES-256-CBC (default)
-delimiter: '::' (default)
+| Config                   | Default       | Options                               |
+| ------------------------ |---------------| --------------------------------------|
+| format                   | :delimited    | :delimited, :json                     |
+| symmetric_algorithm      | AES-256-CBC   | Any valid cipher from OpenSSL::Cipher |
+| delimiter                | ::            | Anything not base64                   |
 
 These can all be modified in the configuration block, eg:
 
@@ -78,6 +92,8 @@ end
 
 Note: trying to use a delimiter in the base64 character set throws an exception.  This is because the iv/encrypted key/encrypted text are encoded in base64, and so it is a bad idea to use something in base64 as a delimiter.
 
+### Use with Rails
+
 There are also some helpers if you are using rails that make encryption/decryption straight forward.  Assuming you have a model with a name field that you would like to encrypt before saving to the database, you could do so like this:
 
 ```
@@ -88,7 +104,7 @@ class EncryptedModel < ActiveRecord::Base
 end
 ```
 
-If you instead would like to decrypt a field before saving (for example, and encrypted value that is coming from an api), then you could do so like this:
+If you instead would like to decrypt a field before saving (for example, an encrypted value that is coming from an api), then you could do so like this:
 
 ```
 class DecryptedModel < ActiveRecord::Base
@@ -100,6 +116,24 @@ end
 
 This will automatically decrypt any values before saving assuming it matches your configurations.
 
+I recommend putting an initializer at config/initializers/serket.rb and putting your serket config block there.  I would also recommend having dummy keys for test/development, and using different config blocks depending on current env (test/development vs production). 
+For example:
+```
+if Rails.env.production?
+  Serket.configure do |config|
+    config.public_key_path = "config/keys/public_key.pem"
+    config.private_key_path = "config/keys/private_key.pem"
+  end
+else
+  Serket.configure do |config|
+    config.public_key_path = "config/keys/test_public_key.pem"
+    config.private_key_path = "config/keys/test_private_key.pem"
+  end
+end
+```
+
+### Android Java Client
+
 You can see an example java client for use with Android in EncryptUtil.java
 
 ## Contributing

data/lib/serket/version.rb

@@ -1,3 +1,3 @@
 module Serket
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/serket.rb

@@ -17,4 +17,12 @@ module Serket
   def self.configure
     yield(configuration)
   end
+  
+  def self.encrypt(text)
+    FieldEncrypter.new.encrypt(text)
+  end
+
+  def self.decrypt(cipher)
+    FieldDecrypter.new.decrypt(cipher)
+  end
 end

data/spec/serket/encrypted_fields_spec.rb

@@ -7,9 +7,8 @@ describe Serket::EncryptedFields do
     end
 
     it "should encrypt a plaintext field" do
-      field_decrypter = Serket::FieldDecrypter.new
       @encrypted_model.email = 'kemba.walker@aol.com'
-      decrypted = field_decrypter.decrypt(@encrypted_model.email)
+      decrypted = Serket.decrypt(@encrypted_model.email)
       decrypted.should == 'kemba.walker@aol.com'
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: serket
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Nipper