Class: ActiveRecord::Encryption::EncryptedAttributeType

Inherits:
Type::Text show all
Includes:
ActiveModel::Type::Helpers::Mutable
Defined in:
activerecord/lib/active_record/encryption/encrypted_attribute_type.rb

Overview

An ActiveModel::Type::Value that encrypts/decrypts strings of text.

This is the central piece that connects the encryption system with encrypts declarations in the model classes. Whenever you declare an attribute as encrypted, it configures an EncryptedAttributeType for that attribute.

Instance Attribute Summary collapse

Attributes inherited from ActiveModel::Type::Value

#limit, #precision, #scale

Instance Method Summary collapse

Methods included from ActiveModel::Type::Helpers::Mutable

#mutable?

Methods inherited from Type::Text

#type

Methods inherited from ActiveModel::Type::String

#to_immutable_string

Methods inherited from ActiveModel::Type::ImmutableString

#serialize_cast_value, #type

Methods inherited from ActiveModel::Type::Value

#==, #as_json, #assert_valid_value, #binary?, #changed?, #force_equality?, #hash, #map, #mutable?, #serializable?, #serialized?, #type, #type_cast_for_schema, #value_constructed_by_mass_assignment?

Methods included from ActiveModel::Type::SerializeCastValue

included, #itself_if_serialize_cast_value_compatible, serialize

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included, #prepend_features, #prepended

Constructor Details

#initialize(scheme:, cast_type: ActiveModel::Type::String.new, previous_type: false, default: nil) ⇒ EncryptedAttributeType

Options

  • :scheme - A Scheme with the encryption properties for this attribute.

  • :cast_type - A type that will be used to serialize (before encrypting) and deserialize (after decrypting). ActiveModel::Type::String by default.



23
24
25
26
27
28
29
 
# File 'activerecord/lib/active_record/encryption/encrypted_attribute_type.rb', line 23

def initialize(scheme:, cast_type: ActiveModel::Type::String.new, previous_type: false, default: nil)
  super()
  @scheme = scheme
  @cast_type = cast_type
  @previous_type = previous_type
  @default = default
end

Instance Attribute Details

#cast_type ⇒ Object (readonly)

Returns the value of attribute cast_type.



13
14
15
 
# File 'activerecord/lib/active_record/encryption/encrypted_attribute_type.rb', line 13

def cast_type
  @cast_type
end

#scheme ⇒ Object (readonly)

Returns the value of attribute scheme.



13
14
15
 
# File 'activerecord/lib/active_record/encryption/encrypted_attribute_type.rb', line 13

def scheme
  @scheme
end

Instance Method Details

#cast(value) ⇒ Object 



31
32
33
 
# File 'activerecord/lib/active_record/encryption/encrypted_attribute_type.rb', line 31

def cast(value)
  cast_type.cast(value)
end

#changed_in_place?(raw_old_value, new_value) ⇒ Boolean

Returns:

  • (Boolean) 


47
48
49
50
 
# File 'activerecord/lib/active_record/encryption/encrypted_attribute_type.rb', line 47

def changed_in_place?(raw_old_value, new_value)
  old_value = raw_old_value.nil? ? nil : deserialize(raw_old_value)
  old_value != new_value
end

#deserialize(value) ⇒ Object 



35
36
37
 
# File 'activerecord/lib/active_record/encryption/encrypted_attribute_type.rb', line 35

def deserialize(value)
  cast_type.deserialize decrypt(value)
end

#previous_types ⇒ Object

:nodoc:



52
53
54
55
 
# File 'activerecord/lib/active_record/encryption/encrypted_attribute_type.rb', line 52

def previous_types # :nodoc:
  @previous_types ||= {} # Memoizing on support_unencrypted_data so that we can tweak it during tests
  @previous_types[support_unencrypted_data?] ||= build_previous_types_for(previous_schemes_including_clean_text)
end

#serialize(value) ⇒ Object 



39
40
41
42
43
44
45
 
# File 'activerecord/lib/active_record/encryption/encrypted_attribute_type.rb', line 39

def serialize(value)
  if serialize_with_oldest?
    serialize_with_oldest(value)
  else
    serialize_with_current(value)
  end
end

#support_unencrypted_data? ⇒ Boolean

Returns:

  • (Boolean) 


57
58
59
 
# File 'activerecord/lib/active_record/encryption/encrypted_attribute_type.rb', line 57

def support_unencrypted_data?
  ActiveRecord::Encryption.config.support_unencrypted_data && scheme.support_unencrypted_data? && !previous_type?
end