lockbox 1.2.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f26c45499c84a35d3a4aaeb7043853a4090dd63b2268e128fc0f2713dfc25b09
-  data.tar.gz: 697626daf2a92ecf69eabc56390074f497ba51a31d1ee24a2a5644c9437d0f09
+  metadata.gz: abb80e6c644b820a341291fe3aeddf0779c216cf24bd4a3af47e16a204cb8af1
+  data.tar.gz: 7c7f698ff608746a2bea81fadcb69251e6ef705a7dae7b1f5d9df87321f959db
 SHA512:
-  metadata.gz: 1b0832e473ba43bb36cc9b11398d20385eae5f94b3a2d13f66a5cc4322605f28bf93a22b9fcb9ac5e171e7004b909b59e0f26d5a75d1be6561c61bbdf054c65e
-  data.tar.gz: 77995606e64719168bb0688215721e89c84b7ce9b758e49dbbb1beeecd460ca85c129089c8f1f160320ead16cbe64bd7eb2fb72491d7e9575ac392ef11ca492b
+  metadata.gz: 87507b0a931adb08a59c530e73776adb59568560d4cb792e668a3688ede13d7f210015e78e086b2109aed5e577e434f9e0d79c7f86e9cbbb447714e42e8bcad7
+  data.tar.gz: 5f078ed8ad8e0b4bed5dacf0d0a01295a34ce994159559aad0bdc2576c5885c979f32174a1cd4cb03e942b6850053c7117acc7e2c630ace333f9178a9fcace80

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 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
+
 ## 1.2.0 (2023-03-20)
 
 - Made it easier to rotate master key

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
@@ -249,7 +249,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 +380,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
@@ -895,12 +895,20 @@ lockbox.decrypt(ciphertext, associated_data: "somecontext")  # success
 lockbox.decrypt(ciphertext, associated_data: "othercontext") # fails
 ```
 
+You can also use it with database fields and files.
+
+```ruby
+class User < ApplicationRecord
+  has_encrypted :email, associated_data: -> { code }
+end
+```
+
 ## Binary Columns
 
 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
@@ -951,7 +959,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
@@ -984,7 +992,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/carrier_wave_extensions.rb

@@ -105,7 +105,7 @@ module Lockbox
   end
 end
 
-if CarrierWave::VERSION.to_i > 2
+if CarrierWave::VERSION.to_i > 3
   raise Lockbox::Error, "CarrierWave #{CarrierWave::VERSION} not supported in this version of Lockbox"
 elsif CarrierWave::VERSION.to_i < 1
   raise Lockbox::Error, "CarrierWave #{CarrierWave::VERSION} not supported"

data/lib/lockbox/model.rb

@@ -324,13 +324,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
@@ -615,6 +625,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.2.0"
+  VERSION = "1.3.1"
 end

data/lib/lockbox.rb

@@ -5,17 +5,17 @@ require "securerandom"
 require "stringio"
 
 # modules
-require "lockbox/aes_gcm"
-require "lockbox/box"
-require "lockbox/calculations"
-require "lockbox/encryptor"
-require "lockbox/key_generator"
-require "lockbox/io"
-require "lockbox/migrator"
-require "lockbox/model"
-require "lockbox/padding"
-require "lockbox/utils"
-require "lockbox/version"
+require_relative "lockbox/aes_gcm"
+require_relative "lockbox/box"
+require_relative "lockbox/calculations"
+require_relative "lockbox/encryptor"
+require_relative "lockbox/key_generator"
+require_relative "lockbox/io"
+require_relative "lockbox/migrator"
+require_relative "lockbox/model"
+require_relative "lockbox/padding"
+require_relative "lockbox/utils"
+require_relative "lockbox/version"
 
 module Lockbox
   class Error < StandardError; end
@@ -88,11 +88,11 @@ module Lockbox
 end
 
 # integrations
-require "lockbox/carrier_wave_extensions" if defined?(CarrierWave)
-require "lockbox/railtie" if defined?(Rails)
+require_relative "lockbox/carrier_wave_extensions" if defined?(CarrierWave)
+require_relative "lockbox/railtie" if defined?(Rails)
 
 if defined?(ActiveSupport::LogSubscriber)
-  require "lockbox/log_subscriber"
+  require_relative "lockbox/log_subscriber"
   Lockbox::LogSubscriber.attach_to :lockbox
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockbox
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2024-01-06 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.6
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Modern encryption for Ruby and Rails