kms_rails 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59b22bd75675cc0973d37c1d05cc270ad708e856
-  data.tar.gz: f1d5963c493dde234bfe4da707c169f40bd3960b
+  metadata.gz: f2118b63c674364c221226b10ae0e100f8ab8802
+  data.tar.gz: e0d597bdbd866795280db1e22d538c777031e4c2
 SHA512:
-  metadata.gz: c44f8efcaf9d0a5bff949cbd7ae94521a2d2e962008c27c3e491cda9273a7653a9e8489d4c3c6d19cf28729a196c2a540a4e7e93f9816572a1a6efa029afd1c9
-  data.tar.gz: edb200a86655ac83d9d05f1c485d5cdef3c58250e9092a231d18098a127a6a8a06369751b41c2f25f76cc2705c7f6c80741a8e5ddad936f5a55c1aeb67c4cc96
+  metadata.gz: 4b123ed8023a46f1bc524494fe2c08b913c00f8b1f49e22449663cd4a679964568db75f82031f6cdaa3758ba4385bb565f970b45d9b5f05179f4d8969d09b20c
+  data.tar.gz: 65e73fa8898b985086ab192ce939dd3d5cbeded70a5051be29f60b39907a730c55de7cf4bc2b230023982bfd69133858b36c120717270cb7808064321204f474

data/README.md

@@ -51,6 +51,10 @@ To clear a retained decrypted value, call:
 
 This will attempt mutate the stored string to contain just null bytes, and then dereference it to be garbage collected. No guarantees are provided about additional copies of the retained data being cached elsewhere.
 
+### Data Serialization
+
+By default kms_rails will convert your encrypted values into strings, however if you would like higher level structures to be stored, you can set `msgpack: true` on any kms_attr declaration. This will encode and decode your values using [MessagePack](https://github.com/msgpack/msgpack-ruby), as long as those value types are supported by it.
+
 ## ActiveJob
 
 To use on ActiveJob, simply put the following code in your job for the arguments you wish to encrypt in flight.

data/lib/kms_rails/active_record.rb

@@ -10,7 +10,7 @@ module KmsRails
     end
     
     module ClassMethods
-      def kms_attr(field, key_id:, retain: false, context_key: nil, context_value: nil)
+      def kms_attr(field, key_id:, retain: false, msgpack: false, context_key: nil, context_value: nil)
         include InstanceMethods
 
         real_field = "#{field}_enc"
@@ -26,6 +26,7 @@ module KmsRails
             return 
           end
 
+          data = data.to_msgpack if msgpack
           encrypted_data = enc.encrypt(data)
 
           set_retained(field, data) if retain
@@ -43,9 +44,11 @@ module KmsRails
           return nil unless hash
 
           if retain && (plaintext = get_retained(field))
+            plaintext = MessagePack.unpack(plaintext) if msgpack
             plaintext
           else
             plaintext = enc.decrypt(hash)
+            plaintext = MessagePack.unpack(plaintext) if msgpack
             set_retained(field, plaintext) if retain
             plaintext
           end

data/lib/kms_rails/version.rb

@@ -1,3 +1,3 @@
 module KmsRails
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kms_rails
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Ash Tyndall
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2016-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord