attr_keyring 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4a80344a57c60c546692d38f9d117129a9ad8f6ab796247de5a6188bbdddbd7a
-  data.tar.gz: 5842f654124fcd2de9c409b3464ff36b029a79dc19f2be973fabafb316f139ed
+  metadata.gz: fd14faa33fac1e6f05f9e66ca58f23f1d25b2ac283a81c0592a443e4141da54b
+  data.tar.gz: b1a5ee0e2351b0ba7662355cacf834de59e21192b3e3e297e3a9116189a528d5
 SHA512:
-  metadata.gz: a734ba2ae31db2ee0875d1cde94184a389f319242f01bce6cce70b561ba14e7075c7926dd8b82bd313bacbcdbb8148e7ddf2f91a46a532065e85d79a18db4fd7
-  data.tar.gz: 47499f9c934a7956588586c27fb07a6a913d8d658ee46a3d6b8d619af2e8df2af4a4d2fdc01cf6e749139c774d0aabe8ecac51ab6ff0d6b9e0e9f32821b97416
+  metadata.gz: dcee2d1e763ae6386f82d5012504597a7a37011e89680fae7dbae5ede27589d6a08b852bf40518cbafa4c3bd91879a33ca54df59f2a77d0c587ef657d10897f0
+  data.tar.gz: 4112694e88e9c8bf2a6676f99dd70504fec0ed79e6e0ccf2c397a32680d7b0028e1a622750d700e4be67693aa6c0fac16c4b9598296b40d84ed3d9880db13b3c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attr_keyring (0.2.2)
+    attr_keyring (0.3.0)
       activerecord
 
 GEM

data/README.md

@@ -96,6 +96,17 @@ user.encrypted_twitter_oauth_token
 #=> "\xF0\xFD\xE3\x98\x98\xBBBp\xCCV45\x17\xA8\xF2r\x99\xC8W\xB2i\xD0;\xC2>7[\xF0R\xAC\x00s\x8F\x82QW{\x0F\x01\x88\x86\x03w\x0E\xCBJ\xC6q"
 ```
 
+You may want to store a Base64 version instead of binary data (e.g. `jsonb` column with `store_accessor`). In this case, you may specify the option `encode: true`.
+
+```ruby
+class User < ApplicationRecord
+  store_accessor :meta, :twitter_oauth_token
+
+  attr_keyring ENV["USER_KEYRING"]
+  attr_encrypt :twitter_oauth_token, encode: true
+end
+```
+
 ### Encryption
 
 By default, AES-128-CBC is the algorithm used for encryption. This algorithm uses 16 bytes keys. Using 16-bytes of random data base64-encoded is the recommended way. You can easily generate keys by using the following command:

data/lib/attr_keyring.rb

@@ -26,13 +26,13 @@ module AttrKeyring
         def inherited(subclass)
           super
 
-          subclass.keyring_attrs = []
+          subclass.keyring_attrs = {}
           subclass.keyring = Keyring.new({})
         end
       end
 
       cattr_accessor :keyring_column_name, default: "keyring_id"
-      self.keyring_attrs = []
+      self.keyring_attrs = {}
       self.keyring = Keyring.new({})
 
       before_save :migrate_to_latest_encryption_key

data/lib/attr_keyring/active_record.rb

@@ -5,9 +5,12 @@ module AttrKeyring
         self.keyring = Keyring.new(keyring, encryptor)
       end
 
-      def attr_encrypt(*attributes)
-        self.keyring_attrs ||= []
-        keyring_attrs.push(*attributes)
+      def attr_encrypt(*attributes, encode: true)
+        self.keyring_attrs ||= {}
+
+        attributes.each do |attribute|
+          keyring_attrs[attribute.to_sym] = {encode: encode}
+        end
 
         attributes.each do |attribute|
           define_attr_encrypt_writer(attribute)
@@ -19,9 +22,11 @@ module AttrKeyring
         define_method("#{attribute}=") do |value|
           return attr_reset_column(attribute) if value.nil?
 
+          options = self.class.keyring_attrs.fetch(attribute)
           stored_keyring_id = public_send(keyring_column_name)
           keyring_id = stored_keyring_id || self.class.keyring.current_key&.id
           encrypted_value = self.class.keyring.encrypt(value, keyring_id)
+          encrypted_value = Base64.strict_encode64(encrypted_value) if options[:encode]
 
           public_send("#{keyring_column_name}=", keyring_id) unless stored_keyring_id
           public_send("encrypted_#{attribute}=", encrypted_value)
@@ -35,8 +40,11 @@ module AttrKeyring
 
           return unless encrypted_value
 
+          options = self.class.keyring_attrs.fetch(attribute)
+          encrypted_value = Base64.strict_decode64(encrypted_value) if options[:encode]
           keyring_id = public_send(keyring_column_name)
-          self.class.keyring.decrypt(encrypted_value, keyring_id)
+          value = self.class.keyring.decrypt(encrypted_value, keyring_id)
+          value
         end
       end
     end
@@ -56,9 +64,10 @@ module AttrKeyring
       private def migrate_to_latest_encryption_key
         keyring_id = self.class.keyring.current_key.id
 
-        self.class.keyring_attrs.each do |attribute|
+        self.class.keyring_attrs.each do |attribute, options|
           value = public_send(attribute)
           encrypted_value = self.class.keyring.encrypt(value, keyring_id)
+          encrypted_value = Base64.strict_encode64(encrypted_value) if options[:encode]
 
           public_send("encrypted_#{attribute}=", encrypted_value)
           attr_encrypt_digest(attribute, value)

data/lib/attr_keyring/version.rb

@@ -1,3 +1,3 @@
 module AttrKeyring
-  VERSION = "0.2.2".freeze
+  VERSION = "0.3.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_keyring
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Nando Vieira