lockbox 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15860ff6f0c444491002e98231bb32785c05d2f6f73be85e34ecb7a53ad43888
-  data.tar.gz: 026be73917780e5bea3fc7178d404d2d4a2320378f94dc98c7dca0b180e40a83
+  metadata.gz: 732b29630e94d7e05292a10ff4106f05152418a335fb7a5e7da9b5a632c05856
+  data.tar.gz: 8d7d40d7d4f8bb5ecc4737c4664a87bfc33d1f331b0a46d36ebc6a3ce5573ee2
 SHA512:
-  metadata.gz: 5cef3979e21483caaa9a860d2e6301c29dbc6c58a44be765da92970981695eb813d09a6c0b43dbd3a53fe3b30dc48dc212436be63dcbeac303d566064095e36b
-  data.tar.gz: 9a7378720dcfb6a1a07687a42d957b3d4abfae349cbef0678a98e6b0f458d4726087c1ee69457624c13f8342ef67687232ccab25d6e2e339561e5603d98b9ea3
+  metadata.gz: 11ba243e0e997a3140a5f3682f38023b9dcf29fdd9c181ea9f693404b4204bd7e83a4caef669126ff9fe432882773ff8f52e129117c201f0dc6eae7de9539849
+  data.tar.gz: 206197fbff415597cb816f77d9354fc8b2ee0c60ceccfb1b5414a44cf19a14b1b9224e09d1c7b0148a9ecb4b0d6673f70f2f35008b6a105bab8e02a55fdf81ce

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+## 2.1.0 (2025-10-15)
+
+- Added warning for `download_chunk` method
+- Fixed error for `download` method with block
+- Dropped support for Active Record < 7.1 and Ruby < 3.2
+
+## 2.0.1 (2024-12-29)
+
+- Added support for Ruby 3.4
+
 ## 2.0.0 (2024-10-26)
 
 - Improved `attributes`, `attribute_names`, and `has_attribute?` when ciphertext attributes not loaded

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2018-2024 Andrew Kane
+Copyright (c) 2018-2025 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

@@ -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.2]
+class AddEmailCiphertextToUsers < ActiveRecord::Migration[8.0]
   def change
     add_column :users, :email_ciphertext, :text
   end
@@ -251,7 +251,7 @@ User.decrypt_email_ciphertext(user.email_ciphertext)
 Create a migration with:
 
 ```ruby
-class AddBodyCiphertextToRichTexts < ActiveRecord::Migration[7.2]
+class AddBodyCiphertextToRichTexts < ActiveRecord::Migration[8.0]
   def change
     add_column :action_text_rich_texts, :body_ciphertext, :text
   end
@@ -382,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.2]
+class AddLicenseToUsers < ActiveRecord::Migration[8.0]
   def change
     add_column :users, :license, :string
   end
@@ -910,7 +910,7 @@ end
 You can use `binary` columns for the ciphertext instead of `text` columns.
 
 ```ruby
-class AddEmailCiphertextToUsers < ActiveRecord::Migration[7.2]
+class AddEmailCiphertextToUsers < ActiveRecord::Migration[8.0]
   def change
     add_column :users, :email_ciphertext, :binary
   end
@@ -961,7 +961,7 @@ end
 Create a migration with:
 
 ```ruby
-class MigrateToLockbox < ActiveRecord::Migration[7.2]
+class MigrateToLockbox < ActiveRecord::Migration[8.0]
   def change
     add_column :users, :name_ciphertext, :text
     add_column :users, :email_ciphertext, :text
@@ -994,7 +994,7 @@ end
 Then remove the previous gem from your Gemfile and drop its columns.
 
 ```ruby
-class RemovePreviousEncryptedColumns < ActiveRecord::Migration[7.2]
+class RemovePreviousEncryptedColumns < ActiveRecord::Migration[8.0]
   def change
     remove_column :users, :encrypted_name, :text
     remove_column :users, :encrypted_name_iv, :text

data/lib/lockbox/active_storage_extensions.rb

@@ -80,7 +80,7 @@ module Lockbox
 
     module Attachment
       def download
-        result = super
+        result = super(&nil)
 
         options = Utils.encrypted_options(record, name)
         # only trust the metadata when migrating
@@ -91,15 +91,29 @@ module Lockbox
           result = Utils.decrypt_result(record, name, options, result)
         end
 
-        result
+        if block_given?
+          io = StringIO.new(result)
+          chunk_size = 5.megabytes
+          while (chunk = io.read(chunk_size))
+            yield chunk
+          end
+        else
+          result
+        end
+      end
+
+      def download_chunk(...)
+        # TODO raise error in 3.0
+        warn "[lockbox] WARNING: download_chunk not supported for encrypted files" if Utils.encrypted_options(record, name)
+        super
       end
 
-      def variant(*args)
+      def variant(...)
         raise Lockbox::Error, "Variant not supported for encrypted files" if Utils.encrypted_options(record, name)
         super
       end
 
-      def preview(*args)
+      def preview(...)
         raise Lockbox::Error, "Preview not supported for encrypted files" if Utils.encrypted_options(record, name)
         super
       end

data/lib/lockbox/encryptor.rb

@@ -15,12 +15,12 @@ module Lockbox
     def encrypt(message, **options)
       message = check_string(message)
       ciphertext = @boxes.first.encrypt(message, **options)
-      ciphertext = Base64.strict_encode64(ciphertext) if @encode
+      ciphertext = [ciphertext].pack("m0") if @encode
       ciphertext
     end
 
     def decrypt(ciphertext, **options)
-      ciphertext = Base64.decode64(ciphertext) if @encode
+      ciphertext = ciphertext.unpack1("m") if @encode
       ciphertext = check_string(ciphertext)
 
       # ensure binary

data/lib/lockbox/model.rb

@@ -377,24 +377,13 @@ module Lockbox
 
               attribute name, attribute_type
 
-              if ActiveRecord::VERSION::STRING.to_f >= 7.1
-                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
-                case options[:type]
-                when :json
-                  serialize name, JSON
-                when :hash
-                  serialize name, Hash
-                when :array
-                  serialize name, Array
-                end
+              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
             elsif ActiveRecord::VERSION::STRING.to_f >= 7.2
               decorate_attributes([name]) do |attr_name, cast_type|

data/lib/lockbox/version.rb

@@ -1,3 +1,3 @@
 module Lockbox
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/lockbox.rb

@@ -1,5 +1,4 @@
 # stdlib
-require "base64"
 require "openssl"
 require "securerandom"
 require "stringio"
@@ -99,8 +98,10 @@ end
 if defined?(ActiveSupport.on_load)
   ActiveSupport.on_load(:active_record) do
     ar_version = ActiveRecord::VERSION::STRING.to_f
-    if ar_version < 7
-      if ar_version >= 5.2
+    if ar_version < 7.1
+      if ar_version >= 7.0
+        raise Lockbox::Error, "Active Record #{ActiveRecord::VERSION::STRING} requires Lockbox < 2.1"
+      elsif ar_version >= 5.2
         raise Lockbox::Error, "Active Record #{ActiveRecord::VERSION::STRING} requires Lockbox < 2"
       elsif ar_version >= 5
         raise Lockbox::Error, "Active Record #{ActiveRecord::VERSION::STRING} requires Lockbox < 0.7"

metadata

@@ -1,16 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockbox
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Andrew Kane
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-27 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description:
 email: andrew@ankane.org
 executables: []
 extensions: []
@@ -43,7 +41,6 @@ homepage: https://github.com/ankane/lockbox
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -51,15 +48,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.16
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Modern encryption for Ruby and Rails
 test_files: []