Class: ActiveRecord::Encryption::Encryptor

Inherits:
Object
  • Object
show all
Defined in:
lib/active_record/encryption/encryptor.rb

Overview

An encryptor exposes the encryption API that ActiveRecord::Encryption::EncryptedAttributeType uses for encrypting and decrypting attribute values.

It interacts with a KeyProvider for getting the keys, and delegate to ActiveRecord::Encryption::Cipher the actual encryption algorithm.

Direct Known Subclasses

EncryptingOnlyEncryptor

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(compress: true, compressor: nil) ⇒ Encryptor

Options

  • :compress - Boolean indicating whether records should be compressed before encryption. Defaults to true.

  • :compressor - The compressor to use.

    1. If compressor is provided, it will be used.

    2. If not, it will use ActiveRecord::Encryption.config.compressor which default value is Zlib.

    If you want to use a custom compressor, it must respond to deflate and inflate.



25
26
27
28
 
# File 'lib/active_record/encryption/encryptor.rb', line 25

def initialize(compress: true, compressor: nil)
  @compress = compress
  @compressor = compressor || ActiveRecord::Encryption.config.compressor
end

Instance Attribute Details

#compressor ⇒ Object (readonly)

The compressor to use for compressing the payload



15
16
17
 
# File 'lib/active_record/encryption/encryptor.rb', line 15

def compressor
  @compressor
end

Instance Method Details

#binary? ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'lib/active_record/encryption/encryptor.rb', line 84

def binary?
  serializer.binary?
end

#compress? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


88
89
90
 
# File 'lib/active_record/encryption/encryptor.rb', line 88

def compress? # :nodoc:
  @compress
end

#decrypt(encrypted_text, key_provider: default_key_provider, cipher_options: {}) ⇒ Object

Decrypts an encrypted_text and returns the result as clean text

Options

:key_provider

Key provider to use for the encryption operation. It will default to ActiveRecord::Encryption.key_provider when not provided

:cipher_options

Cipher-specific options that will be passed to the Cipher configured in ActiveRecord::Encryption.cipher



67
68
69
70
71
72
73
74
 
# File 'lib/active_record/encryption/encryptor.rb', line 67

def decrypt(encrypted_text, key_provider: default_key_provider, cipher_options: {})
  message = deserialize_message(encrypted_text)
  keys = key_provider.decryption_keys(message)
  raise Errors::Decryption unless keys.present?
  uncompress_if_needed(cipher.decrypt(message, key: keys.collect(&:secret), **cipher_options), message.headers.compressed)
rescue *(ENCODING_ERRORS + DECRYPT_ERRORS)
  raise Errors::Decryption
end

#encrypt(clear_text, key_provider: default_key_provider, cipher_options: {}) ⇒ Object

Encrypts clean_text and returns the encrypted result

Internally, it will:

  1. Create a new ActiveRecord::Encryption::Message

  2. Compress and encrypt clean_text as the message payload

  3. Serialize it with ActiveRecord::Encryption.message_serializer (ActiveRecord::Encryption::SafeMarshal by default)

  4. Encode the result with Base 64

Options

:key_provider

Key provider to use for the encryption operation. It will default to ActiveRecord::Encryption.key_provider when not provided.

:cipher_options

Cipher-specific options that will be passed to the Cipher configured in ActiveRecord::Encryption.cipher



49
50
51
52
53
54
 
# File 'lib/active_record/encryption/encryptor.rb', line 49

def encrypt(clear_text, key_provider: default_key_provider, cipher_options: {})
  clear_text = force_encoding_if_needed(clear_text) if cipher_options[:deterministic]

  validate_payload_type(clear_text)
  serialize_message build_encrypted_message(clear_text, key_provider: key_provider, cipher_options: cipher_options)
end

#encrypted?(text) ⇒ Boolean

Returns whether the text is encrypted or not

Returns:

  • (Boolean) 


77
78
79
80
81
82
 
# File 'lib/active_record/encryption/encryptor.rb', line 77

def encrypted?(text)
  deserialize_message(text)
  true
rescue Errors::Encoding, *DECRYPT_ERRORS
  false
end