attr_keyring 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a7c2700c18142c251312d06c17ee3313fc570aeb1b163d25614db6d9cd75455
-  data.tar.gz: 68a9b8eda34be0e99bc8001fe13af68d1ab5dcd70b3aeb6a97d8422bcab75b5d
+  metadata.gz: caf27704434485775f0d328115de5a7803784efea398278d2ab091f90812fe69
+  data.tar.gz: 52ee0ed25266480a59444793108e5839d5c09064f50f8280bfe5a056ce827046
 SHA512:
-  metadata.gz: 42775a257403349c7c64b8ec5720cc0985400478252db31c9a15d7cedf572f67ea14802f95552368bcad15ec2fce568b26c1cd3988661e3d40311c811e630288
-  data.tar.gz: 6b672080b7eef29da9f5b99b1eb51a6878781b25fa046c762970abfc54ab7e2a8a7c6cc75fdee59f9ecb3b02a095b7847cb7c55dd1c7d528709c7246a48bed53
+  metadata.gz: 6eb5b417fdb67fd63d72d7cb263f26269192658d8b92b498a168163321cd5be68734244494161755911082b509f6cd16b340d253d8b88208b0586831a7c471de
+  data.tar.gz: 68bb5d48c931766027d4e6541044263f16c117d3628577a0a9bf79bddeace82dc25773d8d8b0b387ab24a39c7a58f01e94a6376a74740f0b5f53faaf01e7832d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attr_keyring (0.1.0)
+    attr_keyring (0.1.1)
       activerecord
 
 GEM
@@ -24,9 +24,11 @@ GEM
     byebug (10.0.2)
     coderay (1.1.2)
     concurrent-ruby (1.1.3)
+    docile (1.3.1)
     i18n (1.1.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.1)
+    json (2.1.0)
     method_source (0.9.2)
     minitest (5.11.3)
     minitest-utils (0.4.4)
@@ -60,6 +62,11 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.4.0)
     ruby-progressbar (1.10.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     slop (3.6.0)
     sqlite3 (1.3.13)
     thread_safe (0.3.6)
@@ -77,6 +84,7 @@ DEPENDENCIES
   pry-meta
   rake
   rubocop
+  simplecov
   sqlite3
 
 BUNDLED WITH

data/README.md

@@ -53,7 +53,22 @@ Keys are managed through a keyring--a short JSON document describing your encryp
 
 The `id` is used to track which key encrypted which piece of data; a key with a larger id is assumed to be newer. The value is the actual bytes of the encryption key.
 
-You can dynamically load
+#### Dynamically loading keyring
+
+If you're using Rails 5.2+, you can use credentials to define your keyring. Your `credentials.yml` must be define like the following:
+
+```yaml
+user_keyring:
+  1: "PV8+EHgJlHfsVVVstJHgEo+3OCSn4iJDzqJs55U650Q="
+  2: "0HyJ15am4haRsCyiFCxDdlKwl3G5yPNKTUbadpaIfPI="
+```
+
+Then you can setup your model by using `attr_keyring Rails.application.credentials.user_keyring`.
+
+Other possibilities (e.g. the keyring file is provided by configuration management):
+
+- `attr_keyring YAML.load_file(keyring_file)`
+- `attr_keyring JSON.parse(File.read(keyring_file))`.
 
 ### Model Setup
 

data/attr_keyring.gemspec

@@ -26,5 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "pry-meta"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "simplecov"
   spec.add_development_dependency "sqlite3"
 end

data/lib/attr_keyring/active_record.rb

@@ -16,23 +16,42 @@ module AttrKeyring
 
       def define_attr_encrypt_writer(attribute)
         define_method("#{attribute}=") do |value|
-          keyring_id = public_send(keyring_column_name)
+          return attr_reset_column(attribute) if value.nil?
+
+          stored_keyring_id = public_send(keyring_column_name)
+          keyring_id = stored_keyring_id || keyring.current_key&.id
           encrypted_value = keyring.encrypt(value, keyring_id)
 
+          public_send("#{keyring_column_name}=", keyring_id) unless stored_keyring_id
           public_send("encrypted_#{attribute}=", encrypted_value)
-          public_send("#{keyring_column_name}=", keyring_id || keyring.current_key.id) unless keyring_id
+          attr_encrypt_digest(attribute, value)
         end
       end
 
       def define_attr_encrypt_reader(attribute)
         define_method(attribute) do
+          encrypted_value = public_send("encrypted_#{attribute}")
+
+          return unless encrypted_value
+
           keyring_id = public_send(keyring_column_name)
-          keyring.decrypt(public_send("encrypted_#{attribute}"), keyring_id)
+          keyring.decrypt(encrypted_value, keyring_id)
         end
       end
     end
 
     module InstanceMethods
+      private def attr_reset_column(attribute)
+        public_send("encrypted_#{attribute}=", nil)
+        public_send("#{attribute}_digest=", nil)
+        nil
+      end
+
+      private def attr_encrypt_digest(attribute, value)
+        digest_column = "#{attribute}_digest"
+        public_send("#{digest_column}=", Digest::SHA256.hexdigest(value)) if respond_to?(digest_column)
+      end
+
       private def migrate_to_latest_encryption_key
         keyring_id = keyring.current_key.id
 
@@ -41,9 +60,7 @@ module AttrKeyring
           encrypted_value = keyring.encrypt(value, keyring_id)
 
           public_send("encrypted_#{attribute}=", encrypted_value)
-
-          digest_column = "#{attribute}_digest"
-          public_send("#{digest_column}=", Digest::SHA256.hexdigest(value)) if respond_to?(digest_column)
+          attr_encrypt_digest(attribute, value)
         end
 
         public_send("#{keyring_column_name}=", keyring_id)

data/lib/attr_keyring/version.rb

@@ -1,3 +1,3 @@
 module AttrKeyring
-  VERSION = "0.1.0".freeze
+  VERSION = "0.1.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_keyring
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nando Vieira
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement