rails_audit_log 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26fdf8335990094a7278cbcf9921e123fbf44f6ec464b974b1c73e1f41047691
-  data.tar.gz: 9700fef384bb8f23eb929b0c62cb82880ba8217a44f64660f97823c4ffe6f1c0
+  metadata.gz: 40a23f8ea1990a26ea7f575102fb5ddd5f1a7323c796315672de57f0154faec3
+  data.tar.gz: 8b0563eebeeb21fe9836f3ff091640ae4a1c5484b45dc515abfc4647510cfae9
 SHA512:
-  metadata.gz: 8c0450b8f9228ec6ea98e7e026e0554d73004accf1a284433fa6260b5acd941d8314fd33b9bf873156e214f65f8bcd1d687613077f60c310dacd2a2b4e1f98e8
-  data.tar.gz: 733c560b234f96900a760cc76b74a18bd39303179e36ae8272c0f150560139272eb3fb0de9ee435883fbd2c128bd408b373601f407818ff9e5c72cb9c465e503
+  metadata.gz: 29cc8682459e2d7968555a49faa77e47c00da42a54bf633f286dd01e89979be8fff6790aa0880de5d7516d23f1fc16f4a88c10b1e4aa086921c6052fdb812784
+  data.tar.gz: f1a1ba92cfe1c9a1ff0640b9b8a78f94275195fb018da97d89557b9612d631c31293b228e0715d059b790a3f0d2888069066f9897f376e43a40467c8c0c6dbd2

data/README.md

@@ -25,6 +25,7 @@ Audit logging for Rails. Tracks `create`, `update`, and `destroy` events as stru
   - [Capping history per record](#capping-history-per-record)
   - [Time-based retention](#time-based-retention)
   - [Scheduled and manual pruning](#scheduled-and-manual-pruning)
+  - [Encrypting audit data](#encrypting-audit-data)
   - [Selective tracking](#selective-tracking)
   - [Disabling auditing](#disabling-auditing)
   - [Object reconstruction](#object-reconstruction)
@@ -369,6 +370,63 @@ Or run it once manually via the rake task:
 bin/rails rails_audit_log:prune
 ```
 
+### Encrypting audit data
+
+Encrypt `object_changes` and `object` at write time using `ActiveRecord::Encryption` (Rails 7.1+). Pass `encrypt: true` to `audit_log` in the model:
+
+```ruby
+class Payment < ApplicationRecord
+  include RailsAuditLog::Auditable
+  audit_log encrypt: true
+end
+```
+
+The host app must configure `ActiveRecord::Encryption` with primary, deterministic, and key-derivation-salt keys — typically in `config/initializers/rails_audit_log.rb` or `config/application.rb`:
+
+```ruby
+config.active_record.encryption.primary_key        = Rails.application.credentials.ral_primary_key
+config.active_record.encryption.deterministic_key  = Rails.application.credentials.ral_deterministic_key
+config.active_record.encryption.key_derivation_salt = Rails.application.credentials.ral_kdf_salt
+```
+
+Enable encryption globally so every audited model encrypts by default:
+
+```ruby
+# config/initializers/rails_audit_log.rb
+RailsAuditLog.encrypt = true
+```
+
+Opt a specific model out when the global default is on:
+
+```ruby
+class PublicLog < ApplicationRecord
+  include RailsAuditLog::Auditable
+  audit_log encrypt: false   # plain JSON even when RailsAuditLog.encrypt = true
+end
+```
+
+Decryption is transparent — `#diff`, `#reify`, `#changed_attributes`, and all other instance methods work without any changes.
+
+> **Note:** The `touching` scope uses database-level JSON extraction (`json_extract` / `->>`) and will not match encrypted entries. All Ruby-side query methods work normally.
+
+#### Setting up encryption keys
+
+Run the Rails built-in task to generate keys and store them in `config/credentials.yml.enc`:
+
+```bash
+bin/rails db:encryption:init
+```
+
+Then run the encryption generator to produce a wired-up initializer and a re-encryption migration for existing entries:
+
+```bash
+bin/rails generate rails_audit_log:encryption
+```
+
+The generator creates:
+- `config/initializers/rails_audit_log_encryption.rb` — reads the generated keys from credentials and passes them to `ActiveRecord::Encryption`
+- `db/migrate/TIMESTAMP_encrypt_rails_audit_log_entries.rb` — re-encrypts existing plain-text audit entries; edit `ENCRYPTED_MODELS` to list your model class names, then run `bin/rails db:migrate`
+
 ### Selective tracking
 
 Track only specific attributes, or exclude noisy ones:
@@ -754,7 +812,7 @@ bundle exec rake benchmark
 
 [↑ Table of contents](#table-of-contents)
 
-Bug reports and pull requests are welcome on [GitHub](https://github.com/eclectic-coding/rails_audit_log).
+Bug reports and pull requests are welcome on [GitHub](https://github.com/eclectic-coding/rails_audit_log). See [CONTRIBUTING.md](CONTRIBUTING.md) for setup instructions, branch workflow, and CHANGELOG conventions.
 
 ## License
 

data/app/concerns/rails_audit_log/auditable.rb

@@ -30,6 +30,7 @@ module RailsAuditLog
       class_attribute :_audit_log_version_limit,  default: nil
       class_attribute :_audit_log_retain_for,     default: nil
       class_attribute :_audit_log_async,          default: false
+      class_attribute :_audit_log_encrypt,        default: nil
 
       _warn_if_audit_table_missing
 
@@ -111,6 +112,13 @@ module RailsAuditLog
       #   {RailsAuditLog.retention_period} for this model
       # @param async [Boolean, nil] when +true+, writes are dispatched via
       #   +WriteAuditLogJob+; overrides {RailsAuditLog.async} for this model
+      # @param encrypt [Boolean, nil] when +true+, encrypts +object_changes+ and
+      #   +object+ at write time using +ActiveRecord::Encryption+; when +false+,
+      #   opts this model out even if {RailsAuditLog.encrypt} is +true+; when
+      #   +nil+ (default), falls back to {RailsAuditLog.encrypt}; requires the
+      #   host app to configure +config.active_record.encryption+; decryption is
+      #   transparent — {AuditLogEntry#diff}, {AuditLogEntry#reify}, and
+      #   {AuditLogEntry.touching} work unchanged for non-SQL access paths
       # @return [void]
       # @example
       #   class Article < ApplicationRecord
@@ -119,9 +127,10 @@ module RailsAuditLog
       #               meta: { tenant_id: -> { Current.tenant_id } },
       #               associations: %i[tags],
       #               version_limit: 100,
-      #               retain_for: 30.days
+      #               retain_for: 30.days,
+      #               encrypt: true
       #   end
-      def audit_log(only: nil, ignore: nil, meta: nil, associations: nil, version_limit: nil, retain_for: nil, async: nil)
+      def audit_log(only: nil, ignore: nil, meta: nil, associations: nil, version_limit: nil, retain_for: nil, async: nil, encrypt: nil)
         self._audit_log_only          = only.map(&:to_s)   if only
         self._audit_log_ignore        = ignore.map(&:to_s) if ignore
         self._audit_log_meta          = meta                if meta
@@ -129,6 +138,7 @@ module RailsAuditLog
         self._audit_log_version_limit = version_limit       unless version_limit.nil?
         self._audit_log_retain_for    = retain_for          unless retain_for.nil?
         self._audit_log_async         = async               unless async.nil?
+        self._audit_log_encrypt       = encrypt             unless encrypt.nil?
       end
     end
 
@@ -169,7 +179,7 @@ module RailsAuditLog
         event:              "update",
         item_type:          self.class.name,
         item_id:            id,
-        object_changes:     { assoc_name => [before, after] },
+        object_changes:     maybe_encrypt({ assoc_name => [before, after] }),
         object:             nil,
         reason:             RailsAuditLog.reason,
         metadata:           meta.presence,
@@ -191,8 +201,8 @@ module RailsAuditLog
         event:               event,
         item_type:           self.class.name,
         item_id:             id,
-        object_changes:      filtered,
-        object:              snapshot,
+        object_changes:      maybe_encrypt(filtered),
+        object:              maybe_encrypt(snapshot),
         reason:              RailsAuditLog.reason,
         metadata:            meta.presence,
         whodunnit_snapshot:  actor ? RailsAuditLog.whodunnit_display.call(actor) : nil,
@@ -201,6 +211,14 @@ module RailsAuditLog
       )
     end
 
+    def maybe_encrypt(value)
+      return value unless value
+      encrypt = self.class._audit_log_encrypt.nil? ? RailsAuditLog.encrypt : self.class._audit_log_encrypt
+      return value unless encrypt
+      ciphertext = ActiveRecord::Encryption.encryptor.encrypt(value.to_json)
+      { RailsAuditLog::AuditLogEntry::ENCRYPTION_MARKER => ciphertext }
+    end
+
     def write_audit_entry(entry_attrs)
       if (buffer = RailsAuditLog.batch_audit_buffer)
         buffer << entry_attrs.stringify_keys.merge("created_at" => Time.current)

data/app/models/rails_audit_log/audit_log_entry.rb

@@ -21,9 +21,10 @@ module RailsAuditLog
   class AuditLogEntry < ApplicationRecord
     self.table_name = "audit_log_entries"
 
-    EVENTS       = %w[create update destroy].freeze
-    BLOB_COLUMNS = %w[object_changes object metadata].freeze
-    PERIODS      = { "1h" => 1.hour, "24h" => 24.hours, "7d" => 7.days }.freeze
+    EVENTS             = %w[create update destroy].freeze
+    BLOB_COLUMNS       = %w[object_changes object metadata].freeze
+    PERIODS            = { "1h" => 1.hour, "24h" => 24.hours, "7d" => 7.days }.freeze
+    ENCRYPTION_MARKER  = "__ral_enc__"
 
     # @api private
     def self.configure_connection!
@@ -192,6 +193,21 @@ module RailsAuditLog
       self.class.where(item_type: item_type, item_id: item_id).where("id > ?", id).order(id: :asc).first
     end
 
+    # Returns the decrypted +object_changes+ hash. Transparent to callers —
+    # encrypted and non-encrypted entries behave identically.
+    #
+    # @return [Hash, nil]
+    def object_changes
+      decrypt_if_encrypted(super)
+    end
+
+    # Returns the decrypted +object+ snapshot hash. Transparent to callers.
+    #
+    # @return [Hash, nil]
+    def object
+      decrypt_if_encrypted(super)
+    end
+
     # Returns the list of attribute (and association) names that changed in
     # this entry, derived from the keys of +object_changes+.
     #
@@ -215,6 +231,12 @@ module RailsAuditLog
 
     private
 
+    def decrypt_if_encrypted(value)
+      return value unless value.is_a?(Hash) && value.keys == [ENCRYPTION_MARKER]
+      json = ActiveRecord::Encryption.encryptor.decrypt(value[ENCRYPTION_MARKER])
+      JSON.parse(json)
+    end
+
     def metadata_must_be_a_hash
       errors.add(:metadata, "must be a Hash") if metadata.present? && !metadata.is_a?(Hash)
     end

data/lib/generators/rails_audit_log/encryption/encryption_generator.rb

@@ -0,0 +1,41 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module RailsAuditLog
+  module Generators
+    class EncryptionGenerator < Rails::Generators::Base
+      include ActiveRecord::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      desc "Creates an ActiveRecord::Encryption config initializer and a data migration " \
+           "that re-encrypts existing audit entries for models using audit_log encrypt: true."
+
+      def create_initializer_file
+        template "rails_audit_log_encryption.rb",
+                 "config/initializers/rails_audit_log_encryption.rb"
+      end
+
+      def create_migration_file
+        migration_template(
+          "encrypt_rails_audit_log_entries.rb",
+          "db/migrate/encrypt_rails_audit_log_entries.rb"
+        )
+      end
+
+      def print_next_steps
+        say ""
+        say "Next steps:", :green
+        say "  1. Run `bin/rails db:encryption:init` to generate encryption keys"
+        say "     and store them in config/credentials.yml.enc."
+        say "  2. Review config/initializers/rails_audit_log_encryption.rb and wire"
+        say "     the generated keys into ActiveRecord::Encryption."
+        say "  3. Add `audit_log encrypt: true` (or set RailsAuditLog.encrypt = true)"
+        say "     on the models whose audit data you want to protect."
+        say "  4. Edit the generated migration — add your encrypted model class names"
+        say "     to ENCRYPTED_MODELS — then run `bin/rails db:migrate`."
+        say ""
+      end
+    end
+  end
+end

data/lib/generators/rails_audit_log/encryption/templates/encrypt_rails_audit_log_entries.rb

@@ -0,0 +1,85 @@
+# Data migration: re-encrypts existing plain-text audit entries for every
+# model listed in ENCRYPTED_MODELS.
+#
+# == Before running
+#
+# 1. Add the class names of every model that uses `audit_log encrypt: true`
+#    (or that will be covered by `RailsAuditLog.encrypt = true`) to the
+#    ENCRYPTED_MODELS constant below.
+#
+# 2. Ensure ActiveRecord::Encryption is configured with your production keys
+#    (config/initializers/rails_audit_log_encryption.rb).
+#
+# 3. Run: bin/rails db:migrate
+#
+# Entries that are already encrypted (detected by the internal envelope format)
+# are skipped automatically — the migration is safe to re-run.
+#
+# This migration is irreversible.
+
+class EncryptRailsAuditLogEntries < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  BATCH_SIZE        = 500
+  ENCRYPTION_MARKER = RailsAuditLog::AuditLogEntry::ENCRYPTION_MARKER
+
+  # Add the class names of every model whose audit entries should be encrypted:
+  ENCRYPTED_MODELS = %w[
+    # Post
+    # Payment
+    # User
+  ].freeze
+
+  # Isolated AR class — avoids coupling to host-app model overrides.
+  class Entry < ActiveRecord::Base   # @api private
+    self.table_name = "audit_log_entries"
+  end
+
+  def up
+    if ENCRYPTED_MODELS.empty?
+      say "  No ENCRYPTED_MODELS configured — nothing to re-encrypt. " \
+          "Edit the migration and add your model class names, then re-run."
+      return
+    end
+
+    ENCRYPTED_MODELS.each do |model_name|
+      say_with_time "Re-encrypting audit entries for #{model_name}" do
+        re_encrypt_for(model_name)
+      end
+    end
+  end
+
+  def down
+    raise ActiveRecord::IrreversibleMigration,
+          "Cannot reverse encryption migration — decryption would require the original " \
+          "keys and there is no way to distinguish re-encrypted rows from native ones."
+  end
+
+  private
+
+  def re_encrypt_for(item_type)
+    count = 0
+    Entry.where(item_type: item_type).find_in_batches(batch_size: BATCH_SIZE) do |batch|
+      batch.each do |entry|
+        changes = entry.read_attribute(:object_changes)
+        object  = entry.read_attribute(:object)
+
+        updates = {}
+        updates[:object_changes] = encrypt(changes) if changes && !encrypted?(changes)
+        updates[:object]         = encrypt(object)  if object  && !encrypted?(object)
+        next if updates.empty?
+
+        entry.update_columns(updates)
+        count += 1
+      end
+    end
+    count
+  end
+
+  def encrypted?(value)
+    value.is_a?(Hash) && value.keys == [ENCRYPTION_MARKER]
+  end
+
+  def encrypt(value)
+    ciphertext = ActiveRecord::Encryption.encryptor.encrypt(value.to_json)
+    { ENCRYPTION_MARKER => ciphertext }
+  end
+end

data/lib/generators/rails_audit_log/encryption/templates/rails_audit_log_encryption.rb

@@ -0,0 +1,41 @@
+# config/initializers/rails_audit_log_encryption.rb
+# Generated by `bin/rails generate rails_audit_log:encryption`
+#
+# == Setup
+#
+# 1. Run `bin/rails db:encryption:init` to generate encryption keys and store
+#    them in config/credentials.yml.enc under the :active_record_encryption key.
+#
+#    Rails adds entries like:
+#      active_record_encryption:
+#        primary_key: <generated>
+#        deterministic_key: <generated>
+#        key_derivation_salt: <generated>
+#
+# 2. Wire the keys into ActiveRecord::Encryption (already done below).
+#
+# 3. Enable encryption globally or per model:
+#
+#      # Global — every audited model encrypts by default:
+#      # RailsAuditLog.encrypt = true
+#
+#      # Per model — opt individual models in:
+#      # class Payment < ApplicationRecord
+#      #   include RailsAuditLog::Auditable
+#      #   audit_log encrypt: true
+#      # end
+#
+#      # Per model — opt a model out when the global default is on:
+#      # class PublicLog < ApplicationRecord
+#      #   include RailsAuditLog::Auditable
+#      #   audit_log encrypt: false
+#      # end
+
+Rails.application.configure do
+  config.active_record.encryption.primary_key =
+    Rails.application.credentials.dig(:active_record_encryption, :primary_key)
+  config.active_record.encryption.deterministic_key =
+    Rails.application.credentials.dig(:active_record_encryption, :deterministic_key)
+  config.active_record.encryption.key_derivation_salt =
+    Rails.application.credentials.dig(:active_record_encryption, :key_derivation_salt)
+end

data/lib/generators/rails_audit_log/initializer/templates/rails_audit_log.rb

@@ -31,6 +31,13 @@ RailsAuditLog.configure do |config|
   # Per-model `audit_log async: true` also works.
   # config.async = true
 
+  # Encrypt object_changes and object for all audited models using
+  # ActiveRecord::Encryption (Rails 7.1+). Requires config.active_record.encryption
+  # to be configured — run `bin/rails generate rails_audit_log:encryption` for the
+  # setup initializer and re-encryption migration. Default: false
+  # Per-model `audit_log encrypt: false` opts a specific model out.
+  # config.encrypt = true
+
   # Route AuditLogEntry to a dedicated database (Rails multi-DB). Default: nil
   # config.connects_to = { database: { writing: :audit_log, reading: :audit_log } }
 

data/lib/rails_audit_log/version.rb

@@ -1,3 +1,3 @@
 module RailsAuditLog
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/rails_audit_log.rb

@@ -69,6 +69,14 @@ module RailsAuditLog
   # @return [Boolean]
   mattr_accessor :async, default: false
 
+  # When +true+, encrypts +object_changes+ and +object+ for all audited models
+  # using +ActiveRecord::Encryption+. Requires the host app to configure
+  # +config.active_record.encryption+. Override per-model with
+  # <tt>audit_log encrypt: false</tt> to opt a specific model out.
+  #
+  # @return [Boolean]
+  mattr_accessor :encrypt, default: false
+
   # Passes +connects_to+ options directly to {AuditLogEntry} so audit entries
   # can be stored on a separate database.
   #

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_audit_log
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Chuck Smith
@@ -109,6 +109,9 @@ files:
 - app/views/rails_audit_log/resources/show.html.erb
 - config/importmap.rb
 - config/routes.rb
+- lib/generators/rails_audit_log/encryption/encryption_generator.rb
+- lib/generators/rails_audit_log/encryption/templates/encrypt_rails_audit_log_entries.rb
+- lib/generators/rails_audit_log/encryption/templates/rails_audit_log_encryption.rb
 - lib/generators/rails_audit_log/initializer/initializer_generator.rb
 - lib/generators/rails_audit_log/initializer/templates/rails_audit_log.rb
 - lib/generators/rails_audit_log/install/install_generator.rb