Module: Lockbox::Model
- Defined in:
- lib/lockbox/model.rb
Defined Under Namespace
Modules: Attached
Instance Method Summary collapse
Instance Method Details
#has_encrypted(*attributes, **options) ⇒ Object
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 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 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 |
# File 'lib/lockbox/model.rb', line 3 def has_encrypted(*attributes, **) # support objects # case options[:type] # when Date # options[:type] = :date # when Time # options[:type] = :datetime # when JSON # options[:type] = :json # when Hash # options[:type] = :hash # when Array # options[:type] = :array # when String # options[:type] = :string # when Integer # options[:type] = :integer # when Float # options[:type] = :float # when BigDecimal # options[:type] = :decimal # end custom_type = [:type].respond_to?(:serialize) && [:type].respond_to?(:deserialize) valid_types = [nil, :string, :boolean, :date, :datetime, :time, :integer, :float, :decimal, :binary, :json, :hash, :array, :inet] raise ArgumentError, "Unknown type: #{[:type]}" unless custom_type || valid_types.include?([:type]) activerecord = defined?(ActiveRecord::Base) && self < ActiveRecord::Base raise ArgumentError, "Type not supported yet with Mongoid" if [:type] && !activerecord raise ArgumentError, "No attributes specified" if attributes.empty? raise ArgumentError, "Cannot use key_attribute with multiple attributes" if [:key_attribute] && attributes.size > 1 = .dup attributes.each do |name| # per attribute options # TODO use a different name = .dup # add default options encrypted_attribute = .delete(:encrypted_attribute) || "#{name}_ciphertext" # migrating original_name = name.to_sym name = "migrated_#{name}" if [:migrating] name = name.to_sym [:attribute] = name.to_s [:encrypted_attribute] = encrypted_attribute [:encode] = Lockbox.encode_attributes unless .key?(:encode) encrypt_method_name = "generate_#{encrypted_attribute}" decrypt_method_name = "decrypt_#{encrypted_attribute}" class_eval do # Lockbox uses custom inspect # but this could be useful for other gems if activerecord # only add virtual attribute # need to use regexp since strings do partial matching # also, need to use += instead of << self.filter_attributes += [/\A#{Regexp.escape([:attribute])}\z/] end @lockbox_attributes ||= {} if @lockbox_attributes.empty? def self.lockbox_attributes parent_attributes = if superclass.respond_to?(:lockbox_attributes) superclass.lockbox_attributes else {} end parent_attributes.merge(@lockbox_attributes || {}) end # use same approach as activerecord serialization def serializable_hash( = nil) = .try(:dup) || {} [:except] = Array([:except]) [:except] += self.class.lockbox_attributes.flat_map { |_, v| [v[:attribute], v[:encrypted_attribute]] } super() end # maintain order # replace ciphertext attributes w/ virtual attributes (filtered) def inspect lockbox_attributes = {} lockbox_encrypted_attributes = {} self.class.lockbox_attributes.each do |_, lockbox_attribute| lockbox_attributes[lockbox_attribute[:attribute]] = true lockbox_encrypted_attributes[lockbox_attribute[:encrypted_attribute]] = lockbox_attribute[:attribute] end inspection = [] # use serializable_hash like Devise values = serializable_hash self.class.attribute_names.each do |k| next if !has_attribute?(k) || lockbox_attributes[k] # check for lockbox attribute if lockbox_encrypted_attributes[k] # check if ciphertext attribute nil to avoid loading attribute v = send(k).nil? ? "nil" : "[FILTERED]" k = lockbox_encrypted_attributes[k] elsif values.key?(k) v = respond_to?(:attribute_for_inspect) ? attribute_for_inspect(k) : values[k].inspect else next end inspection << "#{k}: #{v}" end "#<#{self.class} #{inspection.join(", ")}>" end if activerecord # TODO wrap in module? def attributes # load attributes # essentially a no-op if already loaded # an exception is thrown if decryption fails self.class.lockbox_attributes.each do |_, lockbox_attribute| # it is possible that the encrypted attribute is not loaded, eg. # if the record was fetched partially (`User.select(:id).first`). # accessing a not loaded attribute raises an `ActiveModel::MissingAttributeError`. if has_attribute?(lockbox_attribute[:encrypted_attribute]) begin send(lockbox_attribute[:attribute]) rescue ArgumentError => e raise e if e. != "No decryption key set" end end end # remove attributes that do not have a ciphertext attribute attributes = super self.class.lockbox_attributes.each do |k, lockbox_attribute| if !attributes.include?(lockbox_attribute[:encrypted_attribute].to_s) attributes.delete(k.to_s) attributes.delete(lockbox_attribute[:attribute]) end end attributes end # remove attribute names that do not have a ciphertext attribute def attribute_names # hash preserves key order names_set = super.to_h { |v| [v, true] } self.class.lockbox_attributes.each do |k, lockbox_attribute| if !names_set.include?(lockbox_attribute[:encrypted_attribute].to_s) names_set.delete(k.to_s) names_set.delete(lockbox_attribute[:attribute]) end end names_set.keys end # check the ciphertext attribute for encrypted attributes def has_attribute?(attr_name) attr_name = attr_name.to_s _, lockbox_attribute = self.class.lockbox_attributes.find { |_, la| la[:attribute] == attr_name } if lockbox_attribute super(lockbox_attribute[:encrypted_attribute]) else super end end # needed for in-place modifications # assigned attributes are encrypted on assignment # and then again here def lockbox_sync_attributes self.class.lockbox_attributes.each do |_, lockbox_attribute| attribute = lockbox_attribute[:attribute] if attribute_changed_in_place?(attribute) || (send("#{attribute}_changed?") && !send("#{lockbox_attribute[:encrypted_attribute]}_changed?")) send("#{attribute}=", send(attribute)) end end end # safety check [:_create_record, :_update_record].each do |method_name| unless private_method_defined?(method_name) || method_defined?(method_name) raise Lockbox::Error, "Expected #{method_name} to be defined. Please report an issue." end end def _create_record(*) lockbox_sync_attributes super end def _update_record(*) lockbox_sync_attributes super end def [](attr_name) send(attr_name) if self.class.lockbox_attributes.any? { |_, la| la[:attribute] == attr_name.to_s } super end def update_columns(attributes) return super unless attributes.is_a?(Hash) # transform keys like Active Record attributes = attributes.transform_keys do |key| n = key.to_s self.class.attribute_aliases[n] || n end lockbox_attributes = self.class.lockbox_attributes.slice(*attributes.keys.map(&:to_sym)) return super unless lockbox_attributes.any? attributes_to_set = {} lockbox_attributes.each do |key, lockbox_attribute| attribute = key.to_s # check read only verify_readonly_attribute(attribute) = attributes[attribute] attributes.delete(attribute) unless lockbox_attribute[:migrating] encrypted_attribute = lockbox_attribute[:encrypted_attribute] ciphertext = self.class.send("generate_#{encrypted_attribute}", , context: self) attributes[encrypted_attribute] = ciphertext attributes_to_set[attribute] = attributes_to_set[lockbox_attribute[:attribute]] = if lockbox_attribute[:migrating] end result = super(attributes) # same logic as Active Record # (although this happens before saving) attributes_to_set.each do |k, v| if respond_to?(:write_attribute_without_type_cast, true) write_attribute_without_type_cast(k, v) elsif respond_to?(:raw_write_attribute, true) raw_write_attribute(k, v) else @attributes.write_cast_value(k, v) clear_attribute_change(k) end end result end if ActiveRecord::VERSION::STRING.to_f >= 7.2 def self.insert(attributes, **) super(lockbox_map_record_attributes(attributes), **) end def self.insert!(attributes, **) super(lockbox_map_record_attributes(attributes), **) end def self.upsert(attributes, **) super(lockbox_map_record_attributes(attributes, check_readonly: true), **) end end def self.insert_all(attributes, **) super(lockbox_map_attributes(attributes), **) end def self.insert_all!(attributes, **) super(lockbox_map_attributes(attributes), **) end def self.upsert_all(attributes, **) super(lockbox_map_attributes(attributes, check_readonly: true), **) end # private # does not try to handle :returning option for simplicity def self.lockbox_map_attributes(records, check_readonly: false) return records unless records.is_a?(Array) records.map do |attributes| lockbox_map_record_attributes(attributes, check_readonly: false) end end # private def self.lockbox_map_record_attributes(attributes, check_readonly: false) return attributes unless attributes.is_a?(Hash) # transform keys like Active Record attributes = attributes.transform_keys do |key| n = key.to_s attribute_aliases[n] || n end lockbox_attributes = self.lockbox_attributes.slice(*attributes.keys.map(&:to_sym)) lockbox_attributes.each do |key, lockbox_attribute| attribute = key.to_s # check read only # users should mark both plaintext and ciphertext columns if check_readonly && readonly_attributes.include?(attribute) && !readonly_attributes.include?(lockbox_attribute[:encrypted_attribute].to_s) warn "[lockbox] WARNING: Mark attribute as readonly: #{lockbox_attribute[:encrypted_attribute]}" end = attributes[attribute] attributes.delete(attribute) unless lockbox_attribute[:migrating] encrypted_attribute = lockbox_attribute[:encrypted_attribute] ciphertext = send("generate_#{encrypted_attribute}", ) attributes[encrypted_attribute] = ciphertext end attributes end else def reload self.class.lockbox_attributes.each do |_, v| instance_variable_set("@#{v[:attribute]}", nil) end super end end end raise "Duplicate encrypted attribute: #{original_name}" if lockbox_attributes[original_name] raise "Multiple encrypted attributes use the same column: #{encrypted_attribute}" if lockbox_attributes.any? { |_, v| v[:encrypted_attribute] == encrypted_attribute } @lockbox_attributes[original_name] = if activerecord # warn on store attributes if stored_attributes.any? { |k, v| v.include?(name) } warn "[lockbox] WARNING: encrypting store accessors is not supported. Encrypt the column instead." end # warn on default attributes if ActiveRecord::VERSION::STRING.to_f >= 7.2 # TODO improve if pending_attribute_modifications.any? { |v| v.is_a?(ActiveModel::AttributeRegistration::ClassMethods::PendingDefault) && v.name == name.to_s } warn "[lockbox] WARNING: attributes with `:default` option are not supported. Use `after_initialize` instead." end elsif attributes_to_define_after_schema_loads.key?(name.to_s) opt = attributes_to_define_after_schema_loads[name.to_s][1] # not ideal, since NO_DEFAULT_PROVIDED is private has_default = opt != ActiveRecord::Attributes::ClassMethods.const_get(:NO_DEFAULT_PROVIDED) if has_default warn "[lockbox] WARNING: attributes with `:default` option are not supported. Use `after_initialize` instead." end end # preference: # 1. type option # 2. existing virtual attribute # 3. default to string (which can later be overridden) if [:type] attribute_type = case [:type] when :json, :hash, :array :string when :integer ActiveModel::Type::Integer.new(limit: 8) else [:type] end attribute name, attribute_type if ActiveRecord::VERSION::STRING.to_f >= 7.1 case [:type] when :json serialize name, coder: JSON when :hash serialize name, type: Hash, coder: default_column_serializer || YAML when :array serialize name, type: Array, coder: default_column_serializer || YAML end else case [:type] when :json serialize name, JSON when :hash serialize name, Hash when :array serialize name, Array end end elsif ActiveRecord::VERSION::STRING.to_f >= 7.2 decorate_attributes([name]) do |attr_name, cast_type| if cast_type.instance_of?(ActiveRecord::Type::Value) original_type = pending_attribute_modifications.find { |v| v.is_a?(ActiveModel::AttributeRegistration::ClassMethods::PendingType) && v.name == original_name.to_s && !v.type.nil? }&.type if original_type original_type elsif [:migrating] cast_type else ActiveRecord::Type::String.new end elsif cast_type.is_a?(ActiveRecord::Type::Serialized) && cast_type.subtype.instance_of?(ActiveModel::Type::Value) # hack to set string type after serialize # otherwise, type gets set to ActiveModel::Type::Value # which always returns false for changed_in_place? ActiveRecord::Type::Serialized.new(ActiveRecord::Type::String.new, cast_type.coder) else cast_type end end elsif !attributes_to_define_after_schema_loads.key?(name.to_s) # when migrating it's best to specify the type directly # however, we can try to use the original type if its already defined if attributes_to_define_after_schema_loads.key?(original_name.to_s) attribute name, attributes_to_define_after_schema_loads[original_name.to_s].first elsif [:migrating] # we use the original attribute for serialization in the encrypt and decrypt methods # so we can use a generic value here attribute name, ActiveRecord::Type::Value.new else attribute name, :string end elsif attributes_to_define_after_schema_loads[name.to_s].first.is_a?(Proc) # hack for Active Record 6.1+ to set string type after serialize # otherwise, type gets set to ActiveModel::Type::Value # which always returns false for changed_in_place? # earlier versions of Active Record take the previous code path attribute_type = attributes_to_define_after_schema_loads[name.to_s].first.call(nil) if attribute_type.is_a?(ActiveRecord::Type::Serialized) && attribute_type.subtype.nil? attribute name, ActiveRecord::Type::Serialized.new(ActiveRecord::Type::String.new, attribute_type.coder) end end define_method("#{name}_was") do send(name) # writes attribute when not already set super() end # restore ciphertext as well define_method("restore_#{name}!") do super() send("restore_#{encrypted_attribute}!") end define_method("#{name}_in_database") do send(name) # writes attribute when not already set super() end define_method("#{name}?") do # uses public_send, so we don't need to preload attribute query_attribute(name) end else # keep this module dead simple # Mongoid uses changed_attributes to calculate keys to update # so we shouldn't mess with it m = Module.new do define_method("#{name}=") do |val| 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 ciphertext = send("#{encrypted_attribute}_was") self.class.send(decrypt_method_name, ciphertext, context: self) end define_method "#{name}_change" do ciphertexts = send("#{encrypted_attribute}_change") ciphertexts.map { |v| self.class.send(decrypt_method_name, v, context: self) } if ciphertexts end define_method "reset_#{name}!" do instance_variable_set("@#{name}", nil) send("reset_#{encrypted_attribute}!") send(name) end define_method "reset_#{name}_to_default!" do instance_variable_set("@#{name}", nil) send("reset_#{encrypted_attribute}_to_default!") send(name) end define_method("#{name}?") do send("#{encrypted_attribute}?") end end define_method("#{name}=") do || # decrypt first for dirty tracking # don't raise error if can't decrypt previous # don't try to decrypt if no decryption key given begin send(name) rescue Lockbox::DecryptionError warn "[lockbox] Decrypting previous value failed" rescue ArgumentError => e raise e if e. != "No decryption key set" end send("lockbox_direct_#{name}=", ) # warn every time, as this should be addressed # maybe throw an error in the future if ![:migrating] if activerecord if self.class.columns_hash.key?(name.to_s) warn "[lockbox] WARNING: Unencrypted column with same name: #{name}. Set `ignored_columns` or remove it to protect the data." end else if self.class.fields.key?(name.to_s) warn "[lockbox] WARNING: Unencrypted field with same name: #{name}. Remove it to protect the data." end end end super() end # separate method for setting directly # used to skip blind indexes for key rotation define_method("lockbox_direct_#{name}=") do || ciphertext = self.class.send(encrypt_method_name, , context: self) send("#{encrypted_attribute}=", ciphertext) end private :"lockbox_direct_#{name}=" define_method(name) do = super() # possibly keep track of decrypted attributes directly in the future # Hash serializer returns {} when nil, Array serializer returns [] when nil # check for this explicitly as a layer of safety if .nil? || (( == {} || == []) && activerecord && @attributes[name.to_s].value_before_type_cast.nil?) ciphertext = send(encrypted_attribute) # keep original message for empty hashes and arrays unless ciphertext.nil? = self.class.send(decrypt_method_name, ciphertext, context: self) end if activerecord # set previous attribute so changes populate correctly # it's fine if this is set on future decryptions (as is the case when message is nil) # as only the first value is loaded into changes @attributes[name.to_s].instance_variable_set("@value_before_type_cast", ) # cache # decrypt method does type casting if respond_to?(:write_attribute_without_type_cast, true) write_attribute_without_type_cast(name.to_s, ) if !@attributes.frozen? elsif respond_to?(:raw_write_attribute, true) raw_write_attribute(name, ) if !@attributes.frozen? else if !@attributes.frozen? @attributes.write_cast_value(name.to_s, ) clear_attribute_change(name) end end # ensure same object is returned as next call = super() else instance_variable_set("@#{name}", ) end end end # for fixtures define_singleton_method encrypt_method_name do |, **opts| table = activerecord ? table_name : collection_name.to_s unless .nil? case [:type] when :boolean = ActiveRecord::Type::Boolean.new.serialize() = ? "t" : "f" unless .nil? when :date = ActiveRecord::Type::Date.new.serialize() # strftime should be more stable than to_s(:db) = .strftime("%Y-%m-%d") unless .nil? when :datetime = ActiveRecord::Type::DateTime.new.serialize() = .iso8601(9) unless .nil? when :time = ActiveRecord::Type::Time.new.serialize() = nil unless .respond_to?(:strftime) = .strftime("%H:%M:%S.%N") unless .nil? when :integer = ActiveRecord::Type::Integer.new(limit: 8).serialize() = 0 if .nil? # signed 64-bit integer, big endian = [].pack("q>") when :float = ActiveRecord::Type::Float.new.serialize() # double precision, big endian = [].pack("G") unless .nil? when :decimal = ActiveRecord::Type::Decimal.new.serialize() # Postgres stores 4 decimal digits in 2 bytes # plus 3 to 8 bytes of overhead # but use string for simplicity = .to_s("F") unless .nil? when :inet unless .nil? ip = .is_a?(IPAddr) ? : (IPAddr.new() rescue nil) # same format as Postgres, with ipv4 padded to 16 bytes # family, netmask, ip # return nil for invalid IP like Active Record = ip ? [ip.ipv4? ? 0 : 1, ip.prefix, ip.hton].pack("CCa16") : nil end when :string, :binary # do nothing # encrypt will convert to binary else # use original name for serialized attributes if no type specified type = (try(:attribute_types) || {})[([:type] ? name : original_name).to_s] = type.serialize() if type end end if .nil? || ( == "" && ![:padding]) else Lockbox::Utils.build_box(opts[:context], , table, encrypted_attribute).encrypt() end end define_singleton_method decrypt_method_name do |ciphertext, **opts| = if ciphertext.nil? || (ciphertext == "" && ![:padding]) ciphertext else table = activerecord ? table_name : collection_name.to_s Lockbox::Utils.build_box(opts[:context], , table, encrypted_attribute).decrypt(ciphertext) end unless .nil? case [:type] when :boolean = == "t" when :date = ActiveRecord::Type::Date.new.deserialize() when :datetime = ActiveRecord::Type::DateTime.new.deserialize() when :time = ActiveRecord::Type::Time.new.deserialize() when :integer = ActiveRecord::Type::Integer.new(limit: 8).deserialize(.unpack1("q>")) when :float = ActiveRecord::Type::Float.new.deserialize(.unpack1("G")) when :decimal = ActiveRecord::Type::Decimal.new.deserialize() when :string .force_encoding(Encoding::UTF_8) when :binary # do nothing # decrypt returns binary string when :inet family, prefix, addr = .unpack("CCa16") len = family == 0 ? 4 : 16 = IPAddr.new_ntoh(addr.first(len)) .prefix = prefix else # use original name for serialized attributes if no type specified type = (try(:attribute_types) || {})[([:type] ? name : original_name).to_s] # for Action Text if activerecord && type.is_a?(ActiveRecord::Type::Serialized) && defined?(ActionText::Content) && type.coder == ActionText::Content .force_encoding(Encoding::UTF_8) end = type.deserialize() if type .force_encoding(Encoding::UTF_8) if !type || type.is_a?(ActiveModel::Type::String) end end end if [:migrating] # TODO reuse module m = Module.new do define_method "#{original_name}=" do |value| result = super(value) send("#{name}=", send(original_name)) result end unless activerecord define_method "reset_#{original_name}!" do result = super() send("#{name}=", send(original_name)) result end end end prepend m end end end end |