Sha256: 51c856a12d91066625e714d8849cdde010874abe0efbd01c354f656fe23d1e3d

Contents?: true

Size: 1.49 KB

Versions: 15

Compression:

Stored size: 1.49 KB

Contents

# frozen_string_literal: true

module ActiveRecord
  module Encryption
    # A +KeyProvider+ serves keys:
    #
    # * An encryption key
    # * A list of potential decryption keys. Serving multiple decryption keys supports rotation-schemes
    #   where new keys are added but old keys need to continue working
    class KeyProvider
      def initialize(keys)
        @keys = Array(keys)
      end

      # Returns the last key in the list as the active key to perform encryptions
      #
      # When +ActiveRecord::Encryption.config.store_key_references+ is true, the key will include
      # a public tag referencing the key itself. That key will be stored in the public
      # headers of the encrypted message
      def encryption_key
        @encryption_key ||= @keys.last.tap do |key|
          key.public_tags.encrypted_data_key_id = key.id if ActiveRecord::Encryption.config.store_key_references
        end

        @encryption_key
      end

      # Returns the list of decryption keys
      #
      # When the message holds a reference to its encryption key, it will return an array
      # with that key. If not, it will return the list of keys.
      def decryption_keys(encrypted_message)
        if encrypted_message.headers.encrypted_data_key_id
          keys_grouped_by_id[encrypted_message.headers.encrypted_data_key_id]
        else
          @keys
        end
      end

      private
        def keys_grouped_by_id
          @keys_grouped_by_id ||= @keys.group_by(&:id)
        end
    end
  end
end

Version data entries

15 entries across 15 versions & 2 rubygems

Version Path
activerecord-8.0.1 lib/active_record/encryption/key_provider.rb
activerecord-8.0.0.1 lib/active_record/encryption/key_provider.rb
activerecord-7.2.2.1 lib/active_record/encryption/key_provider.rb
activerecord-8.0.0 lib/active_record/encryption/key_provider.rb
activerecord-7.2.2 lib/active_record/encryption/key_provider.rb
activerecord-8.0.0.rc2 lib/active_record/encryption/key_provider.rb
activerecord-8.0.0.rc1 lib/active_record/encryption/key_provider.rb
activerecord-8.0.0.beta1 lib/active_record/encryption/key_provider.rb
omg-activerecord-8.0.0.alpha9 lib/active_record/encryption/key_provider.rb
omg-activerecord-8.0.0.alpha8 lib/active_record/encryption/key_provider.rb
omg-activerecord-8.0.0.alpha7 lib/active_record/encryption/key_provider.rb
omg-activerecord-8.0.0.alpha4 lib/active_record/encryption/key_provider.rb
omg-activerecord-8.0.0.alpha3 lib/active_record/encryption/key_provider.rb
omg-activerecord-8.0.0.alpha2 lib/active_record/encryption/key_provider.rb
omg-activerecord-8.0.0.alpha1 lib/active_record/encryption/key_provider.rb