rom-encrypted_attribute 0.0.3

checksums.yaml

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

data/.standard.yml

@@ -0,0 +1,6 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.0
+ignore:
+  - "test/test_data.rb":
+    - Naming/ConstantName

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.4.0, available at [https://www.contributor-covenant.org/version/1/4/code-of-conduct](https://www.contributor-covenant.org/version/1/4/code-of-conduct)

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Paweł Świątkowski
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,65 @@
+# ROM::EncryptedAttribute
+
+This gem adds support for encrypted attributes to [ROM](https://rom-rb.org/).
+
+Traditionally ROM team [suggested](https://discourse.rom-rb.org/t/question-encryption-support-thoughts/387) to put encryption logic in repository code (more precisely, in the mapper from database struct to an entity). I personally think this is not the greatest idea. Repository lies logically in the application layer (or even domain layer), while encryption and decryption of data is a purely infrastructure concern. As such, it should be as low-level and hidden as possible.
+
+In ROM terms it means doing it in a relation. The gem leverages custom types to achieve encryption and decryption.
+
+The scheme is compatible with Rails' default settings for ActiveRecord encryption, so you can still read records encrypted with ActiveRecord from ROM (and vice versa) as long as you provide the same primary key and key derivation salt.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add rom-encrypted_attribute
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install rom-encrypted_attribute
+
+## Usage
+
+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
+class SecretNotes < ROM::Relation[:sql]
+  EncryptedString, EncryptedStringReader =
+    ROM::EncryptedAttribute.define_encrypted_attribute_types(
+      primary_key: ENV["ENCRYPTION_PRIMARY_KEY"],
+      key_derivation_salt: ENV["ENCRYPTION_KEY_DERIVATION_SALT"]
+    )
+    
+  schema(:secret_notes, infer: true) do
+    attribute :content, EncryptedString, read: EncryptedStringReader
+  end
+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.
+
+``` ruby
+class SecretNotes < ROM::Relation[:sql]
+  EncryptedString, EncryptedStringReader =
+    ROM::EncryptedAttribute.define_encrypted_attribute_types(
+      primary_key: ENV["ENCRYPTION_PRIMARY_KEY"],
+      key_derivation_salt: ENV["ENCRYPTION_KEY_DERIVATION_SALT"],
+      hash_digest_class: OpenSSL::Digest::SHA256
+    )
+    
+  schema(:secret_notes, infer: true) do
+    attribute :content, EncryptedString, read: EncryptedStringReader
+  end
+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
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/katafrakt/rom-encrypted_attribute.

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/rom/encrypted_attribute/decryptor.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "base64"
+require "json"
+require_relative "payload"
+
+module ROM
+  module EncryptedAttribute
+    class Decryptor
+      def initialize(derivator:)
+        @derivator = derivator
+      end
+
+      def decrypt(message)
+        payload = ROM::EncryptedAttribute::Payload.decode(message)
+
+        cipher = OpenSSL::Cipher.new("aes-256-gcm")
+        key = @derivator.derive(cipher.key_len)
+
+        cipher.decrypt
+        cipher.padding = 0
+        cipher.key = key
+        cipher.iv = payload.initialization_vector
+        cipher.auth_tag = payload.auth_tag
+        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
+      end
+    end
+  end
+end

data/lib/rom/encrypted_attribute/encryptor.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "base64"
+require "json"
+require "openssl"
+require_relative "payload"
+
+module ROM
+  module EncryptedAttribute
+    class Encryptor
+      def initialize(derivator:)
+        @derivator = derivator
+      end
+
+      def encrypt(message)
+        cipher = OpenSSL::Cipher.new("aes-256-gcm")
+        key = @derivator.derive(cipher.key_len)
+        iv = cipher.random_iv
+
+        cipher.encrypt
+        cipher.key = key
+        cipher.iv = iv
+        encrypted = cipher.update(message) + cipher.final
+        Payload.new(message: encrypted, initialization_vector: iv, auth_tag: cipher.auth_tag).encode
+      end
+    end
+  end
+end

data/lib/rom/encrypted_attribute/key_derivator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "openssl"
+
+module ROM
+  module EncryptedAttribute
+    class KeyDerivator
+      DEFAULT_DIGEST_CLASS = OpenSSL::Digest::SHA1
+      ITERATIONS = 2**16
+
+      def initialize(secret:, salt:, hash_digest_class: DEFAULT_DIGEST_CLASS)
+        @secret = secret
+        @salt = salt
+        @hash_digest_class = hash_digest_class
+      end
+
+      def derive(size)
+        OpenSSL::PKCS5.pbkdf2_hmac(@secret, @salt, ITERATIONS, size, @hash_digest_class.new)
+      end
+    end
+  end
+end

data/lib/rom/encrypted_attribute/payload.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "dry/types"
+require "dry/struct"
+require "base64"
+
+module ROM
+  class EncryptedAttribute::Payload < Dry::Struct
+    class Types
+      include Dry.Types()
+    end
+
+    attribute :message, Types::Strict::String
+    attribute :initialization_vector, Types::Strict::String
+    attribute :auth_tag, Types::Strict::String
+
+    def self.decode(database_value)
+      payload = JSON.parse(database_value)
+      new(
+        message: decode64(payload["p"]),
+        initialization_vector: decode64(payload.dig("h", "iv")),
+        auth_tag: decode64(payload.dig("h", "at"))
+      )
+    end
+
+    def self.decode64(value)
+      Base64.strict_decode64(value)
+    end
+
+    def encode
+      payload =
+        {
+          "p" => encode64(message),
+          "h" => {
+            "iv" => encode64(initialization_vector),
+            "at" => encode64(auth_tag)
+          }
+        }
+
+      JSON.dump(payload)
+    end
+
+    private
+
+    def encode64(value)
+      Base64.strict_encode64(value)
+    end
+  end
+end

data/lib/rom/encrypted_attribute/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module ROM
+  module EncryptedAttribute
+    VERSION = "0.0.3"
+  end
+end

data/lib/rom/encrypted_attribute.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "encrypted_attribute/key_derivator"
+require_relative "encrypted_attribute/decryptor"
+require_relative "encrypted_attribute/encryptor"
+require_relative "encrypted_attribute/version"
+
+require "dry/types"
+
+module ROM
+  module EncryptedAttribute
+    def self.define_encrypted_attribute_types(primary_key:, key_derivation_salt:, hash_digest_class: OpenSSL::Digest::SHA1)
+      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)
+      end
+
+      writer_type = Dry.Types.Constructor(String) do |value|
+        ROM::EncryptedAttribute::Encryptor.new(derivator: key_derivator).encrypt(value)
+      end
+
+      [writer_type, reader_type]
+    end
+  end
+end

data/rom-encrypted_attribute.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/rom/encrypted_attribute/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rom-encrypted_attribute"
+  spec.version = ROM::EncryptedAttribute::VERSION
+  spec.authors = ["Paweł Świątkowski"]
+  spec.email = ["katafrakt@vivaldi.net"]
+
+  spec.summary = "Encrypted attributes for ROM"
+  spec.required_ruby_version = ">= 3.0.0"
+  spec.metadata["source_code_uri"] = "https://github.com/katafrakt/rom-encrypted_attribute"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "dry-types", "~> 1.5"
+
+  spec.add_development_dependency "activerecord", ">= 7.0"
+  spec.add_development_dependency "rom-sql", ">= 3.0"
+  spec.add_development_dependency "sqlite3", ">= 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: rom-encrypted_attribute
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Paweł Świątkowski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rom-sql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description:
+email:
+- katafrakt@vivaldi.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- CODE_OF_CONDUCT.md
+- LICENSE
+- README.md
+- Rakefile
+- lib/rom/encrypted_attribute.rb
+- lib/rom/encrypted_attribute/decryptor.rb
+- lib/rom/encrypted_attribute/encryptor.rb
+- lib/rom/encrypted_attribute/key_derivator.rb
+- lib/rom/encrypted_attribute/payload.rb
+- lib/rom/encrypted_attribute/version.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
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.16
+signing_key:
+specification_version: 4
+summary: Encrypted attributes for ROM
+test_files: []