lockbox 1.3.0 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db8c162439dc5376d1aabf48af3925fd2d7a5129e3902b49b973dce9eda16a77
-  data.tar.gz: 2e82dc5026e09fdaee0bb1baddabc9b0f8294f38cf613ee09368d62aa39c4ff4
+  metadata.gz: 2a238a9d70f5c46cabf8824957f739beb662730a2039696da29b6bc2f7a23462
+  data.tar.gz: eaebb7f1bd209792eee41166c6b5878b99ea0ee9436d030bf76ff13c8c56e4e2
 SHA512:
-  metadata.gz: e8d6d9a2c4661767c01ab8874f29c3fd705712d4f3d6d153e09b4c7ad6441bb0812d45c6cf526d3a59177ae23c44289b1aa375e462303c17fcb952edd4641a8e
-  data.tar.gz: 2e5cd80ddca65447f10a666b5568bbdeff449bf6517c944a67f6fdfdd5ff253e7560569133216a5459d1519ad3bb72b5cabd17065240a2aa1091750e21b4c26c
+  metadata.gz: cc5a1953cbc1493d5eba15ef0d0aed760ee6bd5d0f50e9810d522d57e46e2426f1a8573284834b262208fb6b20638ce15f0f52b5eb1c74dd9f5cc79c9124d6d1
+  data.tar.gz: ab01a6601a0317e0182f49bff4410ab232f88a88a5e65b68d20c6b761a38c3777a527d66c6c1fc0896ce23fdeacb493ec5487a494bf310760581f0ab511c3be3

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## 1.3.3 (2024-02-07)
+
+- Added warning for encrypting store attributes
+
+## 1.3.2 (2024-01-10)
+
+- Fixed issue with serialized attributes
+
+## 1.3.1 (2024-01-06)
+
+- Fixed error with `array` and `hash` types and no default column serializer with Rails 7.1
+- Fixed Action Text deserialization with Rails 7.1
+
 ## 1.3.0 (2023-07-02)
 
 - Added support for CarrierWave 3

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2022 Andrew Kane
+Copyright (c) 2018-2024 Andrew Kane
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -9,7 +9,7 @@
 
 Learn [the principles behind it](https://ankane.org/modern-encryption-rails), [how to secure emails with Devise](https://ankane.org/securing-user-emails-lockbox), and [how to secure sensitive data in Rails](https://ankane.org/sensitive-data-rails).
 
-[![Build Status](https://github.com/ankane/lockbox/workflows/build/badge.svg?branch=master)](https://github.com/ankane/lockbox/actions)
+[![Build Status](https://github.com/ankane/lockbox/actions/workflows/build.yml/badge.svg)](https://github.com/ankane/lockbox/actions)
 
 ## Installation
 
@@ -72,7 +72,7 @@ Then follow the instructions below for the data you want to encrypt.
 Create a migration with:
 
 ```ruby
-class AddEmailCiphertextToUsers < ActiveRecord::Migration[7.0]
+class AddEmailCiphertextToUsers < ActiveRecord::Migration[7.1]
   def change
     add_column :users, :email_ciphertext, :text
   end
@@ -140,6 +140,8 @@ class User < ApplicationRecord
 end
 ```
 
+For [Active Record Store](https://api.rubyonrails.org/classes/ActiveRecord/Store.html), encrypt the column rather than individual accessors.
+
 For [StoreModel](https://github.com/DmitryTsepelev/store_model), use:
 
 ```ruby
@@ -249,7 +251,7 @@ User.decrypt_email_ciphertext(user.email_ciphertext)
 Create a migration with:
 
 ```ruby
-class AddBodyCiphertextToRichTexts < ActiveRecord::Migration[7.0]
+class AddBodyCiphertextToRichTexts < ActiveRecord::Migration[7.1]
   def change
     add_column :action_text_rich_texts, :body_ciphertext, :text
   end
@@ -380,7 +382,7 @@ Encryption is applied to all versions after processing.
 You can mount the uploader [as normal](https://github.com/carrierwaveuploader/carrierwave#activerecord). With Active Record, this involves creating a migration:
 
 ```ruby
-class AddLicenseToUsers < ActiveRecord::Migration[7.0]
+class AddLicenseToUsers < ActiveRecord::Migration[7.1]
   def change
     add_column :users, :license, :string
   end
@@ -908,7 +910,7 @@ end
 You can use `binary` columns for the ciphertext instead of `text` columns.
 
 ```ruby
-class AddEmailCiphertextToUsers < ActiveRecord::Migration[7.0]
+class AddEmailCiphertextToUsers < ActiveRecord::Migration[7.1]
   def change
     add_column :users, :email_ciphertext, :binary
   end
@@ -959,7 +961,7 @@ end
 Create a migration with:
 
 ```ruby
-class MigrateToLockbox < ActiveRecord::Migration[7.0]
+class MigrateToLockbox < ActiveRecord::Migration[7.1]
   def change
     add_column :users, :name_ciphertext, :text
     add_column :users, :email_ciphertext, :text
@@ -992,7 +994,7 @@ end
 Then remove the previous gem from your Gemfile and drop its columns.
 
 ```ruby
-class RemovePreviousEncryptedColumns < ActiveRecord::Migration[7.0]
+class RemovePreviousEncryptedColumns < ActiveRecord::Migration[7.1]
   def change
     remove_column :users, :encrypted_name, :text
     remove_column :users, :encrypted_name_iv, :text

data/lib/lockbox/model.rb

@@ -289,6 +289,11 @@ module Lockbox
           @lockbox_attributes[original_name] = options
 
           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 attributes_to_define_after_schema_loads.key?(name.to_s)
               opt = attributes_to_define_after_schema_loads[name.to_s][1]
@@ -324,13 +329,23 @@ module Lockbox
               attribute name, attribute_type
 
               if ActiveRecord::VERSION::STRING.to_f >= 7.1
-                serialize name, coder: JSON if options[:type] == :json
-                serialize name, type: Hash if options[:type] == :hash
-                serialize name, type: Array if options[:type] == :array
+                case options[: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
-                serialize name, JSON if options[:type] == :json
-                serialize name, Hash if options[:type] == :hash
-                serialize name, Array if options[:type] == :array
+                case options[:type]
+                when :json
+                  serialize name, JSON
+                when :hash
+                  serialize name, Hash
+                when :array
+                  serialize name, Array
+                end
               end
             elsif !attributes_to_define_after_schema_loads.key?(name.to_s)
               # when migrating it's best to specify the type directly
@@ -499,6 +514,9 @@ module Lockbox
                     clear_attribute_change(name)
                   end
                 end
+
+                # ensure same object is returned as next call
+                message = super()
               else
                 instance_variable_set("@#{name}", message)
               end
@@ -615,6 +633,10 @@ module Lockbox
               else
                 # use original name for serialized attributes if no type specified
                 type = (try(:attribute_types) || {})[(options[:type] ? name : original_name).to_s]
+                # for Action Text
+                if activerecord && type.is_a?(ActiveRecord::Type::Serialized) && defined?(ActionText::Content) && type.coder == ActionText::Content
+                  message.force_encoding(Encoding::UTF_8)
+                end
                 message = type.deserialize(message) if type
                 message.force_encoding(Encoding::UTF_8) if !type || type.is_a?(ActiveModel::Type::String)
               end

data/lib/lockbox/version.rb

@@ -1,3 +1,3 @@
 module Lockbox
-  VERSION = "1.3.0"
+  VERSION = "1.3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockbox
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-02 00:00:00.000000000 Z
+date: 2024-02-07 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
@@ -58,7 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Modern encryption for Ruby and Rails