rom_encrypted_attribute 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4fa68f6b6119a75fb160eed6c69ecb341f0966e09b2e1e2d234d0ce20e1f2a1c
-  data.tar.gz: 4f33329807bc3337d001ebe8c4840ae10ed70272db064343588fc38c444f0452
+  metadata.gz: a969ae5d8669ac0bba27f0ba1aeb8ad53b42962c4a63dea849033f3398ea0048
+  data.tar.gz: 752b299f84b9a569983e7b937fb8588f404572032d4fd58d64a022399ffbeb98
 SHA512:
-  metadata.gz: 3ca2ba7ffdb4b96fdc97ca403100bd996593724953a9938483619f82916d62ac7a2c7161e19401fef5cad66837ea6571235dc8064cdb0a7aace0aae3a1776453
-  data.tar.gz: cc3dc7e8b45d235d5fdf10cd069b84c9ee8a590fcc9247d6df36fedf3529634980c95a32b5978030294cd36ed26858aea4ca4ad97b5debcf1f957dffacfe0957
+  metadata.gz: a8a2e9a6dbebf654fff5349968e66b8a77909720ffedafeb1dfa9e7232d789c758123c36f078266fd6895fbacebed1d79a8aa78e439450bcb437cd6cbcdbfe80
+  data.tar.gz: 414fbbf17de5976ec4940f1d4244dc215f1b6ebfb3d4b98d80c2c72ba574c9ebe79a48d5db1b8960ef302f3320afcf1e6e19ee1845d228c81865c4b09587b14e

data/README.md

@@ -1,12 +1,12 @@
 # RomEncryptedAttribute
 
-This gem adds support for encrypted fields using [ROM](https://rom-rb.org/).
+This gem adds support for encrypted attributes to [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.
+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. This gem uses custom types to achieve encryption and decryption.
+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 encrypted records as long as you provide the same primary key and salt derivation key.
+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
 
@@ -27,7 +27,7 @@ class SecretNotes < ROM::Relation[:sql]
   EncryptedString, EncryptedStringReader =
     RomEncryptedAttribute.define_encrypted_attribute_types(
       primary_key: ENV["ENCRYPTION_PRIMARY_KEY"],
-      derivation_salt: ENV["ENCRYPTION_DERIVATION_SALT"]
+      key_derivation_salt: ENV["ENCRYPTION_KEY_DERIVATION_SALT"]
     )
     
   schema(:secret_notes, infer: true) do
@@ -42,7 +42,7 @@ Of course, you can define it somewhere else and just `include` in the relation o
 
 * 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
+* Support for deterministic encryption from `ActiveRecord::Encryption` is not implemented
 
 ## Contributing
 

data/lib/rom_encrypted_attribute/decryptor.rb

@@ -3,6 +3,7 @@
 require "base64"
 require "json"
 require_relative "key_derivator"
+require_relative "payload"
 
 module RomEncryptedAttribute
   class Decryptor
@@ -11,10 +12,7 @@ module RomEncryptedAttribute
     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"])
+      payload = RomEncryptedAttribute::Payload.decode(message)
 
       cipher = OpenSSL::Cipher.new("aes-256-gcm")
       key = @derivator.derive(cipher.key_len)
@@ -22,10 +20,10 @@ module RomEncryptedAttribute
       cipher.decrypt
       cipher.padding = 0
       cipher.key = key
-      cipher.iv = iv
-      cipher.auth_tag = auth_tag
+      cipher.iv = payload.initialization_vector
+      cipher.auth_tag = payload.auth_tag
       cipher.auth_data = ""
-      cipher.update(data) + cipher.final
+      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

data/lib/rom_encrypted_attribute/encryptor.rb

@@ -4,6 +4,7 @@ require "base64"
 require "json"
 require "openssl"
 require_relative "key_derivator"
+require_relative "payload"
 
 module RomEncryptedAttribute
   class Encryptor
@@ -20,22 +21,7 @@ module RomEncryptedAttribute
       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)
+      Payload.new(message: encrypted, initialization_vector: iv, auth_tag: cipher.auth_tag).encode
     end
   end
 end

data/lib/rom_encrypted_attribute/payload.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "dry/types"
+require "dry/struct"
+require "base64"
+
+class RomEncryptedAttribute::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

data/lib/rom_encrypted_attribute/version.rb

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

data/lib/rom_encrypted_attribute.rb

@@ -7,13 +7,13 @@ require_relative "rom_encrypted_attribute/version"
 require "dry/types"
 
 module RomEncryptedAttribute
-  def self.define_encrypted_attribute_types(primary_key:, derivation_salt:)
+  def self.define_encrypted_attribute_types(primary_key:, key_derivation_salt:)
     reader_type = Dry.Types.Constructor(String) do |value|
-      RomEncryptedAttribute::Decryptor.new(secret: primary_key, salt: derivation_salt).decrypt(value)
+      RomEncryptedAttribute::Decryptor.new(secret: primary_key, salt: key_derivation_salt).decrypt(value)
     end
 
     writer_type = Dry.Types.Constructor(String) do |value|
-      RomEncryptedAttribute::Encryptor.new(secret: primary_key, salt: derivation_salt).encrypt(value)
+      RomEncryptedAttribute::Encryptor.new(secret: primary_key, salt: key_derivation_salt).encrypt(value)
     end
 
     [writer_type, reader_type]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rom_encrypted_attribute
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Paweł Świątkowski
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-types
@@ -82,6 +82,7 @@ files:
 - 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: