34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
|
# File 'lib/lockbox/model.rb', line 34
def encrypts(*attributes, encode: true, **options)
raise ArgumentError, "Unknown type: #{options[:type]}" unless [nil, :string, :boolean, :date, :datetime, :time, :integer, :float, :binary, :json, :hash].include?(options[:type])
attribute_type =
case options[:type]
when nil, :json, :hash
:string
when :integer
ActiveModel::Type::Integer.new(limit: 8)
else
options[:type]
end
attributes.each do |name|
encrypted_attribute = "#{name}_ciphertext"
options = options.dup
original_name = name.to_sym
name = "migrated_#{name}" if options[:migrating]
name = name.to_sym
options[:attribute] = name.to_s
options[:encrypted_attribute] = encrypted_attribute
class_method_name = "generate_#{encrypted_attribute}"
class_eval do
if options[:migrating]
before_validation do
send("#{name}=", send(original_name)) if send("#{original_name}_changed?")
end
end
@lockbox_attributes ||= {}
unless respond_to?(:lockbox_attributes)
def self.lockbox_attributes
parent_attributes =
if superclass.respond_to?(:lockbox_attributes)
superclass.lockbox_attributes
else
{}
end
parent_attributes.merge(@lockbox_attributes || {})
end
end
raise "Duplicate encrypted attribute: #{original_name}" if lockbox_attributes[original_name]
@lockbox_attributes[original_name] = options.merge(encode: encode)
if @lockbox_attributes.size == 1
def serializable_hash(options = nil)
options = options.try(:dup) || {}
options[:except] = Array(options[:except])
options[:except] += self.class.lockbox_attributes.values.flat_map { |v| [v[:attribute], v[:encrypted_attribute]] }
super(options)
end
def inspect
inspection =
serializable_hash.map do |k,v|
"#{k}: #{respond_to?(:attribute_for_inspect) ? attribute_for_inspect(k) : v.inspect}"
end
"#<#{self.class} #{inspection.join(", ")}>"
end
before_save do
self.class.lockbox_attributes.each do |_, lockbox_attribute|
attribute = lockbox_attribute[:attribute]
if changes.include?(attribute)
type = (self.class.try(:attribute_types) || {})[attribute]
if type && type.is_a?(ActiveRecord::Type::Serialized)
send("#{attribute}=", send(attribute))
end
end
end
end
if defined?(Mongoid::Document) && included_modules.include?(Mongoid::Document)
def reload
self.class.lockbox_attributes.each do |_, v|
instance_variable_set("@#{v[:attribute]}", nil)
end
super
end
end
end
serialize name, JSON if options[:type] == :json
serialize name, Hash if options[:type] == :hash
if respond_to?(:attribute)
attribute name, attribute_type
else
m = Module.new do
define_method("#{name}=") do |val|
prev_val = instance_variable_get("@#{name}")
unless val == prev_val
unless changed_attributes.key?(name.to_s)
changed_attributes[name.to_s] = prev_val.__deep_copy__
end
end
instance_variable_set("@#{name}", val)
end
define_method(name) do
instance_variable_get("@#{name}")
end
end
include m
alias_method "#{name}_changed?", "#{encrypted_attribute}_changed?"
define_method "#{name}_was" do
attribute_was(name.to_s)
end
end
define_method("#{name}=") do |message|
original_message = message
unless message.nil?
case options[:type]
when :boolean
message = ActiveRecord::Type::Boolean.new.serialize(message)
message = nil if message == "" message = message ? "t" : "f" unless message.nil?
when :date
message = ActiveRecord::Type::Date.new.serialize(message)
message = message.strftime("%Y-%m-%d") unless message.nil?
when :datetime
message = ActiveRecord::Type::DateTime.new.serialize(message)
message = nil unless message.respond_to?(:iso8601) message = message.iso8601(9) unless message.nil?
when :time
message = ActiveRecord::Type::Time.new.serialize(message)
message = nil unless message.respond_to?(:strftime)
message = message.strftime("%H:%M:%S.%N") unless message.nil?
message
when :integer
message = ActiveRecord::Type::Integer.new(limit: 8).serialize(message)
message = 0 if message.nil?
message = [message].pack("q>")
when :float
message = ActiveRecord::Type::Float.new.serialize(message)
message = [message].pack("G") unless message.nil?
when :string, :binary
else
type = (self.class.try(:attribute_types) || {})[name.to_s]
if type && type.is_a?(ActiveRecord::Type::Serialized)
message = type.serialize(message)
end
end
end
begin
send(name)
rescue Lockbox::DecryptionError
nil
end
ciphertext =
if message.nil? || (message == "" && !options[:padding])
message
else
self.class.send(class_method_name, message, context: self)
end
send("#{encrypted_attribute}=", ciphertext)
super(original_message)
end
define_method(name) do
message = super()
unless message
ciphertext = send(encrypted_attribute)
message =
if ciphertext.nil? || (ciphertext == "" && !options[:padding])
ciphertext
else
ciphertext = Base64.decode64(ciphertext) if encode
table = self.class.respond_to?(:table_name) ? self.class.table_name : self.class.collection_name.to_s
Lockbox::Utils.build_box(self, options, table, encrypted_attribute).decrypt(ciphertext)
end
unless message.nil?
case options[:type]
when :boolean
message = message == "t"
when :date
message = ActiveRecord::Type::Date.new.deserialize(message)
when :datetime
message = ActiveRecord::Type::DateTime.new.deserialize(message)
when :time
message = ActiveRecord::Type::Time.new.deserialize(message)
when :integer
message = ActiveRecord::Type::Integer.new(limit: 8).deserialize(message.unpack("q>").first)
when :float
message = ActiveRecord::Type::Float.new.deserialize(message.unpack("G").first)
when :string
message.force_encoding(Encoding::UTF_8)
when :binary
else
type = (self.class.try(:attribute_types) || {})[name.to_s]
if type && type.is_a?(ActiveRecord::Type::Serialized)
message = type.deserialize(message)
else
message.force_encoding(Encoding::UTF_8)
end
end
end
@attributes[name.to_s].instance_variable_set("@value_before_type_cast", message) if @attributes[name.to_s]
if respond_to?(:_write_attribute, true)
_write_attribute(name, message)
elsif respond_to?(:raw_write_attribute)
raw_write_attribute(name, message)
else
instance_variable_set("@#{name}", message)
end
end
message
end
define_singleton_method class_method_name do |message, **opts|
table = respond_to?(:table_name) ? table_name : collection_name.to_s
ciphertext = Lockbox::Utils.build_box(opts[:context], options, table, encrypted_attribute).encrypt(message)
ciphertext = Base64.strict_encode64(ciphertext) if encode
ciphertext
end
end
end
end
|