rom-encrypted_attribute 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26555bd77c9580cd7889520b0cd9737065ac1be7b66572770ddae63cd4ffe5df
-  data.tar.gz: 5a7b73206a06cadec42c6ad584ad239a3f81bcb9e30790641d4bb1868fd75d22
+  metadata.gz: edac4dc1b09b3b903aefc265d78a56a7fafd2f6d28f1b503d3f4fbe64eede9c6
+  data.tar.gz: c7de7fd6c2bc5c6de81ef0bf3f804f7cda02df4d5687156647155dd77e5c358e
 SHA512:
-  metadata.gz: cf70faabb89dad5e071bae34ad030c87816656a27384c3aed6f4247f8d7d5eef9cb67ce365ec6d5e62a0e4341cc604ab8169e2a6fb641a31fbe71ffa7d02a1ae
-  data.tar.gz: 335fe66bfa7993e3a4dd22f2f40b86fd0e6ab85ec94e288804f3abad89a166036da8a62351b495f111437ea7084b46ad32b25d4ae86ab7ecd734fc80c3cf7784
+  metadata.gz: d603a67e727a2079904ed7f45629fcc2fabe185297ea26f479b9573c8d8b1bb366c6a404ca3720176769890b70d280490cb198b7798731b8efbbe92a47d68581
+  data.tar.gz: dd4d03515ab81bbd335793688f202e73b21f9ad815d9881700e8cf99ff6dc69bc95aebe8c15a74440283b80c19c7c17850133770b98a06a19df54e61476f568f

data/README.md

@@ -20,6 +20,60 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
+There are two ways to use this library: via a ROM schema plugin or by a "bare metal" approach.
+
+### ROM plugin
+
+Somewhere in you code set the config for the gem. This is done using [`Dry::Configurable`](https://dry-rb.org/gems/dry-configurable/1.0/), so you can use all options available there. For example:
+
+``` ruby
+ROM::EncryptedAttribute.configure do |config|
+  config.primary_key = "your-primary-key" # required
+  config.key_derivation_salt = "your-derivation-salt" # required
+  config.hash_digest_class = OpenSSL::Digest::SHA256 # SHA1 by default
+end
+```
+
+Then use the plugin in your ROM relation:
+
+``` ruby
+class SecretNotes < ::ROM::Relation[:sql]
+  schema(:secret_notes, infer: true) do
+    use :encrypted_attributes
+    encrypt :content
+  end
+end
+```
+
+You can override individual configuration values if, for example, one database table uses different primary key:
+
+``` ruby
+class SecretNotes < ::ROM::Relation[:sql]
+  schema(:secret_notes, infer: true) do
+    use :encrypted_attributes, primary_key: ENV["SPECIAL_PRIMARY_KEY"]
+    encrypt :content
+  end
+end
+```
+
+If you specify all configuration options, or use defaults, you can skip setting the global config.
+
+You can also override global per-schema settings on a per-field level:
+
+``` ruby
+class SecretNotes < ::ROM::Relation[:sql]
+  schema(:secret_notes, infer: true) do
+    use :encrypted_attributes
+    encrypt :content
+    encrypt :title, :hash_digest_class: OpenSSL::Digest::SHA256
+    encrypt :maybe_encrypted, support_unencrypted_data: true
+  end
+end
+
+```
+
+### "Bare metal"
+
 In your relation, define custom types using a helper method from the gem. You need to provide the credentials to it somehow. This might be done via environmental variables, Hanami settings (if you're using Hanami) or any other means, really.
 
 ```ruby
@@ -36,7 +90,11 @@ class SecretNotes < ROM::Relation[:sql]
 end
 ```
 
-By default the gem uses SHA1 for key derivation (same as Rails' default), but you can configure it by passing custom `has_digest_class` option.
+With this approach you can define the types globally in your application and reuse it, without having to pass primary_key and key_derivation_salt every time in the schema.
+
+### Other considerations
+
+By default the gem uses SHA1 for key derivation (same as Rails' default), but you can configure it by passing custom `hash_digest_class` option.
 
 ``` ruby
 class SecretNotes < ROM::Relation[:sql]
@@ -56,9 +114,9 @@ end
 
 ### Caveats
 
-* Due to [a bug](https://github.com/rom-rb/rom-sql/issues/423) in `rom-sql`, reading unencrypted data is always supported, which means that if there's a plain not-encrypted data in your database already, it will be read correctly. This might or might not be desirable, but for the time being there's no choice in cofiguring this behaviour.
-* Support for deterministic encryption from `ActiveRecord::Encryption` is not implemented
-* Support for key rotation is not implemented
+* Due to [a bug](https://github.com/rom-rb/rom-sql/issues/423) in `rom-sql`, reading unencrypted data requires a monkey patch to ROM. Since this is quite aggressive, you are expected to opt-in to this by calling `ROM::SQL::Patch432.install!`.
+* Support for deterministic encryption from `ActiveRecord::Encryption` is not (yet) implemented
+* Support for key rotation is not (yet) implemented
 
 ## Contributing
 

data/lib/rom/encrypted_attribute/decryptor.rb

@@ -7,11 +7,16 @@ require_relative "payload"
 module ROM
   module EncryptedAttribute
     class Decryptor
-      def initialize(derivator:)
+      UnencryptedDataNotAllowed = Class.new(RuntimeError)
+
+      def initialize(derivator:, support_unencrypted_data: false)
         @derivator = derivator
+        @support_unencrypted_data = support_unencrypted_data
       end
 
       def decrypt(message)
+        return nil if message.nil?
+
         payload = ROM::EncryptedAttribute::Payload.decode(message)
 
         cipher = OpenSSL::Cipher.new("aes-256-gcm")
@@ -25,9 +30,11 @@ module ROM
         cipher.auth_data = ""
         cipher.update(payload.message) + cipher.final
       rescue JSON::ParserError
-        # we need to unconditionally support of reading unencrypted data due to a bug in rom-sql
-        # https://github.com/rom-rb/rom-sql/issues/423
-        message
+        if @support_unencrypted_data
+          message
+        else
+          raise UnencryptedDataNotAllowed
+        end
       end
     end
   end

data/lib/rom/encrypted_attribute/encryptor.rb

@@ -13,6 +13,8 @@ module ROM
       end
 
       def encrypt(message)
+        return nil if message.nil?
+
         cipher = OpenSSL::Cipher.new("aes-256-gcm")
         key = @derivator.derive(cipher.key_len)
         iv = cipher.random_iv

data/lib/rom/encrypted_attribute/rom_sql_patch.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# this is used to silence the redefinition warnings
+require "warning"
+
+# This provides a patch for rom-sql while https://github.com/rom-rb/rom-sql/pull/432
+# is pending merge. It allows to block reading unencrypted values from the database.
+# You need to opt-in for this patch yourself by calling:
+#
+#     ROM::SQL::Patch432.install!
+#
+# The patch can be reverted with
+#     ROM::SQL::Patch432.uninstall!
+#
+# Note: that you don't need this if you are using PostgreSQL.
+# Also note that this will emit a warning of overwriting a method.
+module ROM
+  module SQL
+    module Patch432
+      def self.install!
+        Warning.ignore(:method_redefined)
+        ROM::SQL::Commands::Create.class_eval do
+          def insert(tuples)
+            pks = tuples.map { |tuple| relation.insert(tuple) }
+            relation.dataset.where(relation.primary_key => pks).to_a
+          end
+
+          def multi_insert(tuples)
+            pks = relation.multi_insert(tuples, return: :primary_key)
+            relation.dataset.where(relation.primary_key => pks).to_a
+          end
+        end
+        Warning.ignore(:method_redefined, false)
+      end
+
+      def self.uninstall!
+        Warning.ignore(:method_redefined)
+        ROM::SQL::Commands::Create.class_eval do
+          def insert(tuples)
+            pks = tuples.map { |tuple| relation.insert(tuple) }
+            relation.where(relation.primary_key => pks).to_a
+          end
+
+          def multi_insert(tuples)
+            pks = relation.multi_insert(tuples, return: :primary_key)
+            relation.where(relation.primary_key => pks).to_a
+          end
+        end
+        Warning.ignore(:method_redefined, false)
+      end
+    end
+  end
+end

data/lib/rom/encrypted_attribute/version.rb

@@ -2,6 +2,6 @@
 
 module ROM
   module EncryptedAttribute
-    VERSION = "0.0.3"
+    VERSION = "0.0.5"
   end
 end

data/lib/rom/encrypted_attribute.rb

@@ -4,20 +4,32 @@ require_relative "encrypted_attribute/key_derivator"
 require_relative "encrypted_attribute/decryptor"
 require_relative "encrypted_attribute/encryptor"
 require_relative "encrypted_attribute/version"
+require_relative "plugins/schema/encrypted_attributes"
 
 require "dry/types"
 
 module ROM
   module EncryptedAttribute
-    def self.define_encrypted_attribute_types(primary_key:, key_derivation_salt:, hash_digest_class: OpenSSL::Digest::SHA1)
+    extend Dry::Configurable
+
+    module Types
+      include Dry.Types()
+    end
+
+    setting :primary_key
+    setting :key_derivation_salt
+    setting :hash_digest_class, default: OpenSSL::Digest::SHA1
+    setting :support_unencrypted_data, default: false
+
+    def self.define_encrypted_attribute_types(primary_key:, key_derivation_salt:, hash_digest_class: OpenSSL::Digest::SHA1, support_unencrypted_data: false)
       key_derivator = KeyDerivator.new(salt: key_derivation_salt, secret: primary_key,
         hash_digest_class: hash_digest_class)
 
-      reader_type = Dry.Types.Constructor(String) do |value|
-        ROM::EncryptedAttribute::Decryptor.new(derivator: key_derivator).decrypt(value)
+      reader_type = Dry.Types.Constructor(Types::String.optional) do |value|
+        ROM::EncryptedAttribute::Decryptor.new(derivator: key_derivator, support_unencrypted_data: support_unencrypted_data).decrypt(value)
       end
 
-      writer_type = Dry.Types.Constructor(String) do |value|
+      writer_type = Dry.Types.Constructor(Types::String.optional) do |value|
         ROM::EncryptedAttribute::Encryptor.new(derivator: key_derivator).encrypt(value)
       end
 

data/lib/rom/plugins/schema/encrypted_attributes.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "rom"
+
+module ROM
+  module Plugins
+    module Schema
+      module EncryptedAttributes
+        def self.apply(schema, **options)
+          attributes = options.fetch(:attributes)
+          primary_key = options.fetch(:primary_key, ROM::EncryptedAttribute.config.primary_key)
+          key_derivation_salt = options.fetch(:key_derivation_salt, ROM::EncryptedAttribute.config.key_derivation_salt)
+          hash_digest_class = options.fetch(:hash_digest_class, ROM::EncryptedAttribute.config.hash_digest_class)
+          support_unencrypted_data = options.fetch(:support_unencrypted_data, EncryptedAttribute.config.support_unencrypted_data)
+
+          encrypted_string, encrypted_string_reader =
+            ROM::EncryptedAttribute.define_encrypted_attribute_types(
+              primary_key: primary_key, key_derivation_salt: key_derivation_salt, hash_digest_class: hash_digest_class, support_unencrypted_data: support_unencrypted_data
+            )
+
+          attrs =
+            attributes.map do |name|
+              ROM::Schema::DSL.new(schema.name).build_attribute_info(
+                name,
+                encrypted_string,
+                name: name, read: encrypted_string_reader
+              )
+            end
+
+          schema.attributes.concat(
+            schema.class.attributes(attrs, schema.attr_class)
+          )
+        end
+
+        module DSL
+          # @example
+          #   schema do
+          #     use :encrypted_attributes
+          #     encrypt :api_key, :ssn, hash_digest_class: OpenSSL::Digest::SHA256
+          #   end
+          def encrypt(*attributes, **opts)
+            options = plugin_options(:encrypted_attributes)
+            options.merge!(opts)
+            options[:attributes] ||= []
+            options[:attributes] += attributes
+            self
+          end
+        end
+      end
+    end
+  end
+end
+
+ROM.plugins do
+  register :encrypted_attributes, ROM::Plugins::Schema::EncryptedAttributes, type: :schema
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: rom-encrypted_attribute
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Paweł Świątkowski
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-21 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -66,7 +65,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.0'
-description:
 email:
 - katafrakt@vivaldi.net
 executables: []
@@ -83,13 +81,13 @@ files:
 - lib/rom/encrypted_attribute/encryptor.rb
 - lib/rom/encrypted_attribute/key_derivator.rb
 - lib/rom/encrypted_attribute/payload.rb
+- lib/rom/encrypted_attribute/rom_sql_patch.rb
 - lib/rom/encrypted_attribute/version.rb
+- lib/rom/plugins/schema/encrypted_attributes.rb
 - rom-encrypted_attribute.gemspec
-homepage:
 licenses: []
 metadata:
   source_code_uri: https://github.com/katafrakt/rom-encrypted_attribute
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,8 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: Encrypted attributes for ROM
 test_files: []