rom_encrypted_attribute 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fa68f6b6119a75fb160eed6c69ecb341f0966e09b2e1e2d234d0ce20e1f2a1c
+  data.tar.gz: 4f33329807bc3337d001ebe8c4840ae10ed70272db064343588fc38c444f0452
+SHA512:
+  metadata.gz: 3ca2ba7ffdb4b96fdc97ca403100bd996593724953a9938483619f82916d62ac7a2c7161e19401fef5cad66837ea6571235dc8064cdb0a7aace0aae3a1776453
+  data.tar.gz: cc3dc7e8b45d235d5fdf10cd069b84c9ee8a590fcc9247d6df36fedf3529634980c95a32b5978030294cd36ed26858aea4ca4ad97b5debcf1f957dffacfe0957

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,49 @@
+# RomEncryptedAttribute
+
+This gem adds support for encrypted fields using [ROM](https://rom-rb.org/).
+
+Traditionally ROM suggested 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 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. This gem uses custom types to achieve encryption and decryption.
+
+The scheme is compatible with Rails' default settings for ActiveRecord encryption, so you can still read encrypted records as long as you provide the same primary key and salt derivation key.
+
+## 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 =
+    RomEncryptedAttribute.define_encrypted_attribute_types(
+      primary_key: ENV["ENCRYPTION_PRIMARY_KEY"],
+      derivation_salt: ENV["ENCRYPTION_DERIVATION_SALT"]
+    )
+    
+  schema(:secret_notes, infer: true) do
+    attribute :content, EncryptedString, read: EncryptedStringReader
+  end
+end
+```
+
+Of course, you can define it somewhere else and just `include` in the relation or use your custom types code organization.
+
+### Caveats
+
+* Due to a bug in `rom-sql`, reading unencrypted data is turned on by default
+* The gem uses SHA256 for key derivation and it's currently not configurable
+* Support for deterministic encryption from `ActiveRecord::Entryption` 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,35 @@
+# frozen_string_literal: true
+
+require "base64"
+require "json"
+require_relative "key_derivator"
+
+module RomEncryptedAttribute
+  class Decryptor
+    def initialize(secret:, salt:)
+      @derivator = KeyDerivator.new(secret: secret, salt: salt)
+    end
+
+    def decrypt(message)
+      message = JSON.parse(message)
+      data = Base64.strict_decode64(message["p"])
+      iv = Base64.strict_decode64(message["h"]["iv"])
+      auth_tag = Base64.strict_decode64(message["h"]["at"])
+
+      cipher = OpenSSL::Cipher.new("aes-256-gcm")
+      key = @derivator.derive(cipher.key_len)
+
+      cipher.decrypt
+      cipher.padding = 0
+      cipher.key = key
+      cipher.iv = iv
+      cipher.auth_tag = auth_tag
+      cipher.auth_data = ""
+      cipher.update(data) + 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

data/lib/rom_encrypted_attribute/encryptor.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require "base64"
+require "json"
+require "openssl"
+require_relative "key_derivator"
+
+module RomEncryptedAttribute
+  class Encryptor
+    def initialize(secret:, salt:)
+      @derivator = KeyDerivator.new(secret: secret, salt: salt)
+    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
+      serialize(encrypted, cipher: cipher, iv: iv)
+    end
+
+    private
+
+    def serialize(encrypted, iv:, cipher:)
+      payload =
+        {
+          "p" => Base64.strict_encode64(encrypted),
+          "h" => {
+            "iv" => Base64.strict_encode64(iv),
+            "at" => Base64.strict_encode64(cipher.auth_tag)
+          }
+        }
+
+      JSON.dump(payload)
+    end
+  end
+end

data/lib/rom_encrypted_attribute/key_derivator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "openssl"
+
+module RomEncryptedAttribute
+  class KeyDerivator
+    DIGEST_CLASS = OpenSSL::Digest::SHA256
+    ITERATIONS = 2**16
+
+    def initialize(secret:, salt:)
+      @secret = secret
+      @salt = salt
+    end
+
+    def derive(size)
+      OpenSSL::PKCS5.pbkdf2_hmac(@secret, @salt, ITERATIONS, size, DIGEST_CLASS.new)
+    end
+  end
+end

data/lib/rom_encrypted_attribute/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RomEncryptedAttribute
+  VERSION = "0.0.1"
+end

data/lib/rom_encrypted_attribute.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "rom_encrypted_attribute/decryptor"
+require_relative "rom_encrypted_attribute/encryptor"
+require_relative "rom_encrypted_attribute/version"
+
+require "dry/types"
+
+module RomEncryptedAttribute
+  def self.define_encrypted_attribute_types(primary_key:, derivation_salt:)
+    reader_type = Dry.Types.Constructor(String) do |value|
+      RomEncryptedAttribute::Decryptor.new(secret: primary_key, salt: derivation_salt).decrypt(value)
+    end
+
+    writer_type = Dry.Types.Constructor(String) do |value|
+      RomEncryptedAttribute::Encryptor.new(secret: primary_key, salt: derivation_salt).encrypt(value)
+    end
+
+    [writer_type, reader_type]
+  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 = RomEncryptedAttribute::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,110 @@
+--- !ruby/object:Gem::Specification
+name: rom_encrypted_attribute
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Paweł Świątkowski
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-07 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/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.4.21
+signing_key:
+specification_version: 4
+summary: Encrypted attributes for ROM
+test_files: []