lockbox 0.6.8 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0cc5589dbbfae34908ffdd634798549fa161c7dc79b528f23b8e097a044f3d9d
-  data.tar.gz: 3eb23c1dfb284abb335e2addfb20fee77b31373b561ab6c0f9afaf28abf8aeb8
+  metadata.gz: 767467c10e8b38cc53b822c604bc4d6189563a00b7a53a12181ac5d3de19e723
+  data.tar.gz: 56319f892b400761e11a96b9f0e05f3a5cf684c6b6f069e9f85cbbdd81299bef
 SHA512:
-  metadata.gz: b0bd8a7ee500cbba73daa2ef0c9c6af07695b53799735f865d5b0e9e907e8ef86904983d5f8cfdff098b554d4cd9d4351133778079bde93a7440bbacf03d0545
-  data.tar.gz: ea83a9ecb7734e907a03be89e628fc103815b0cc5acc2aec0c21dc0f2d6b7e746f299a489d4a11b14f413a55c4fb06b45d6e23302c853c8b216ad2bca63218d6
+  metadata.gz: 8e4550edc543add59495e42f0648b80c538ace8d326c12acbe5bad3bfb907f329d1ff63be86406bad83f8a2732b2938efa6ce6e20bce9b2d10406f173ee3e56b
+  data.tar.gz: 7087087f6307212b8b041c1703f4d08be578042295a4dcd91efdc1aaab17d1a4c8f2066969ae1837216d746ac3824f287f5fdcbb58afd8a12ce772bf7592d5b9

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0.0 (2022-06-11)
+
+- Deprecated `encrypts` in favor of `has_encrypted` to avoid conflicting with Active Record encryption
+- Deprecated `lockbox_encrypts` in favor of `has_encrypted`
+- Fixed error with `pluck`
+- Restored warning for attributes with `default` option
+- Dropped support for Active Record < 5.2 and Ruby < 2.6
+
 ## 0.6.8 (2022-01-25)
 
 - Fixed issue with `encrypts` loading model schema early

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[6.1]
+class AddEmailCiphertextToUsers < ActiveRecord::Migration[7.0]
   def change
     add_column :users, :email_ciphertext, :text
   end
@@ -83,12 +83,10 @@ Add to your model:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email
+  has_encrypted :email
 end
 ```
 
-**Note:** With Rails 7, use `lockbox_encrypts` instead of `encrypts`
-
 You can use `email` just like any other attribute.
 
 ```ruby
@@ -103,7 +101,7 @@ You can specify multiple fields in single line.
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, :phone, :city
+  has_encrypted :email, :phone, :city
 end
 ```
 
@@ -113,17 +111,17 @@ Fields are strings by default. Specify the type of a field with:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :born_on, type: :date
-  encrypts :signed_at, type: :datetime
-  encrypts :opens_at, type: :time
-  encrypts :active, type: :boolean
-  encrypts :salary, type: :integer
-  encrypts :latitude, type: :float
-  encrypts :video, type: :binary
-  encrypts :properties, type: :json
-  encrypts :settings, type: :hash
-  encrypts :messages, type: :array
-  encrypts :ip, type: :inet
+  has_encrypted :birthday, type: :date
+  has_encrypted :signed_at, type: :datetime
+  has_encrypted :opens_at, type: :time
+  has_encrypted :active, type: :boolean
+  has_encrypted :salary, type: :integer
+  has_encrypted :latitude, type: :float
+  has_encrypted :video, type: :binary
+  has_encrypted :properties, type: :json
+  has_encrypted :settings, type: :hash
+  has_encrypted :messages, type: :array
+  has_encrypted :ip, type: :inet
 end
 ```
 
@@ -137,7 +135,7 @@ class User < ApplicationRecord
   store :settings, accessors: [:color, :homepage]
   attribute :configuration, CustomType.new
 
-  encrypts :properties, :settings, :configuration
+  has_encrypted :properties, :settings, :configuration
 end
 ```
 
@@ -145,7 +143,7 @@ For [StoreModel](https://github.com/DmitryTsepelev/store_model), use:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :configuration, type: Configuration.to_type
+  has_encrypted :configuration, type: Configuration.to_type
 
   after_initialize do
     self.configuration ||= {}
@@ -176,7 +174,7 @@ Add a new column for the ciphertext, then add to your model:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, migrating: true
+  has_encrypted :email, migrating: true
 end
 ```
 
@@ -190,7 +188,7 @@ Then update the model to the desired state:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email
+  has_encrypted :email
 
   # remove this line after dropping email column
   self.ignored_columns = ["email"]
@@ -250,7 +248,7 @@ User.decrypt_email_ciphertext(user.email_ciphertext)
 Create a migration with:
 
 ```ruby
-class AddBodyCiphertextToRichTexts < ActiveRecord::Migration[6.1]
+class AddBodyCiphertextToRichTexts < ActiveRecord::Migration[7.0]
   def change
     add_column :action_text_rich_texts, :body_ciphertext, :text
   end
@@ -289,7 +287,7 @@ Add to your model:
 class User
   field :email_ciphertext, type: String
 
-  encrypts :email
+  has_encrypted :email
 end
 ```
 
@@ -381,7 +379,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[6.1]
+class AddLicenseToUsers < ActiveRecord::Migration[7.0]
   def change
     add_column :users, :license, :string
   end
@@ -574,7 +572,7 @@ Update your model:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, previous_versions: [{master_key: previous_key}]
+  has_encrypted :email, previous_versions: [{master_key: previous_key}]
 end
 ```
 
@@ -710,24 +708,30 @@ Lockbox uses 256-bit keys.
 
 ### XSalsa20
 
-You can also use XSalsa20, which uses an extended nonce so you don’t have to worry about nonce collisions. First, [install Libsodium](https://github.com/crypto-rb/rbnacl/wiki/Installing-libsodium). For Homebrew, use:
+You can also use XSalsa20, which uses an extended nonce so you don’t have to worry about nonce collisions. First, [install Libsodium](https://github.com/crypto-rb/rbnacl/wiki/Installing-libsodium). It comes preinstalled on [Heroku](https://devcenter.heroku.com/articles/stack-packages). For Homebrew, use:
 
 ```sh
 brew install libsodium
 ```
 
-And add to your Gemfile:
+And for Ubuntu, use:
+
+```sh
+sudo apt-get install libsodium23
+```
+
+Then add to your Gemfile:
 
 ```ruby
 gem "rbnacl"
 ```
 
-Then add to your model:
+And add to your model:
 
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, algorithm: "xsalsa20"
+  has_encrypted :email, algorithm: "xsalsa20"
 end
 ```
 
@@ -739,72 +743,6 @@ Lockbox.default_options = {algorithm: "xsalsa20"}
 
 You can also pass an algorithm to `previous_versions` for key rotation.
 
-#### XSalsa20 Deployment
-
-##### Heroku
-
-Heroku [comes with libsodium](https://devcenter.heroku.com/articles/stack-packages) preinstalled.
-
-##### Ubuntu
-
-For Ubuntu 20.04 and 18.04, use:
-
-```sh
-sudo apt-get install libsodium23
-```
-
-For Ubuntu 16.04, use:
-
-```sh
-sudo apt-get install libsodium18
-```
-
-##### GitHub Actions
-
-For Ubuntu 20.04 and 18.04, use:
-
-```yml
-    - name: Install Libsodium
-      run: sudo apt-get update && sudo apt-get install libsodium23
-```
-
-For Ubuntu 16.04, use:
-
-```yml
-    - name: Install Libsodium
-      run: sudo apt-get update && sudo apt-get install libsodium18
-```
-
-##### Travis CI
-
-On Bionic, add to `.travis.yml`:
-
-```yml
-addons:
-  apt:
-    packages:
-      - libsodium23
-```
-
-On Xenial, add to `.travis.yml`:
-
-```yml
-addons:
-  apt:
-    packages:
-      - libsodium18
-```
-
-##### CircleCI
-
-Add a step to `.circleci/config.yml`:
-
-```yml
-- run:
-    name: install Libsodium
-    command: sudo apt-get install -y libsodium18
-```
-
 ## Hybrid Cryptography
 
 [Hybrid cryptography](https://en.wikipedia.org/wiki/Hybrid_cryptosystem) allows servers to encrypt data without being able to decrypt it.
@@ -821,7 +759,7 @@ Store the keys with your other secrets. Then use:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, algorithm: "hybrid", encryption_key: encryption_key, decryption_key: decryption_key
+  has_encrypted :email, algorithm: "hybrid", encryption_key: encryption_key, decryption_key: decryption_key
 end
 ```
 
@@ -851,7 +789,7 @@ To rename a table with encrypted columns/uploaders, use:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, key_table: "original_table"
+  has_encrypted :email, key_table: "original_table"
 end
 ```
 
@@ -859,7 +797,7 @@ To rename an encrypted column itself, use:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, key_attribute: "original_column"
+  has_encrypted :email, key_attribute: "original_column"
 end
 ```
 
@@ -869,7 +807,7 @@ To set a key for an individual field/uploader, use a string:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, key: ENV["USER_EMAIL_ENCRYPTION_KEY"]
+  has_encrypted :email, key: ENV["USER_EMAIL_ENCRYPTION_KEY"]
 end
 ```
 
@@ -877,7 +815,7 @@ Or a proc:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, key: -> { code }
+  has_encrypted :email, key: -> { code }
 end
 ```
 
@@ -887,7 +825,7 @@ To use a different key for each record, use a symbol:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, key: :some_method
+  has_encrypted :email, key: :some_method
 end
 ```
 
@@ -895,7 +833,7 @@ Or a proc:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, key: -> { some_method }
+  has_encrypted :email, key: -> { some_method }
 end
 ```
 
@@ -907,7 +845,7 @@ For Active Record and Mongoid, use:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, key: :kms_key
+  has_encrypted :email, key: :kms_key
 end
 ```
 
@@ -995,7 +933,7 @@ lockbox.decrypt(ciphertext, associated_data: "othercontext") # fails
 You can use `binary` columns for the ciphertext instead of `text` columns.
 
 ```ruby
-class AddEmailCiphertextToUsers < ActiveRecord::Migration[6.1]
+class AddEmailCiphertextToUsers < ActiveRecord::Migration[7.0]
   def change
     add_column :users, :email_ciphertext, :binary
   end
@@ -1006,7 +944,7 @@ Disable Base64 encoding to save space.
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :email, encode: false
+  has_encrypted :email, encode: false
 end
 ```
 
@@ -1040,7 +978,7 @@ end
 Create a migration with:
 
 ```ruby
-class MigrateToLockbox < ActiveRecord::Migration[6.1]
+class MigrateToLockbox < ActiveRecord::Migration[7.0]
   def change
     add_column :users, :name_ciphertext, :text
     add_column :users, :email_ciphertext, :text
@@ -1048,11 +986,11 @@ class MigrateToLockbox < ActiveRecord::Migration[6.1]
 end
 ```
 
-And add `encrypts` to your model with the `migrating` option:
+And add `has_encrypted` to your model with the `migrating` option:
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :name, :email, migrating: true
+  has_encrypted :name, :email, migrating: true
 end
 ```
 
@@ -1066,14 +1004,14 @@ Once all records are migrated, remove the `migrating` option and the previous mo
 
 ```ruby
 class User < ApplicationRecord
-  encrypts :name, :email
+  has_encrypted :name, :email
 end
 ```
 
 Then remove the previous gem from your Gemfile and drop its columns.
 
 ```ruby
-class RemovePreviousEncryptedColumns < ActiveRecord::Migration[6.1]
+class RemovePreviousEncryptedColumns < ActiveRecord::Migration[7.0]
   def change
     remove_column :users, :encrypted_name, :text
     remove_column :users, :encrypted_name_iv, :text
@@ -1085,6 +1023,16 @@ end
 
 ## Upgrading
 
+### 1.0.0
+
+`encrypts` is now deprecated in favor of `has_encrypted` to avoid conflicting with Active Record encryption.
+
+```ruby
+class User < ApplicationRecord
+  has_encrypted :email
+end
+```
+
 ### 0.6.0
 
 0.6.0 adds `encrypted: true` to Active Storage metadata for new files. This field is informational, but if you prefer to add it to existing files, use:

data/lib/lockbox/calculations.rb

@@ -3,7 +3,12 @@ module Lockbox
     def pluck(*column_names)
       return super unless model.respond_to?(:lockbox_attributes)
 
-      lockbox_columns = column_names.map.with_index { |c, i| [model.lockbox_attributes[c.to_sym], i] }.select { |la, _i| la && !la[:migrating] }
+      lockbox_columns = column_names.map.with_index do |c, i|
+        next unless c.respond_to?(:to_sym)
+        [model.lockbox_attributes[c.to_sym], i]
+      end.select do |la, _i|
+        la && !la[:migrating]
+      end
 
       return super unless lockbox_columns.any?
 

data/lib/lockbox/carrier_wave_extensions.rb

@@ -106,10 +106,9 @@ module Lockbox
 end
 
 if CarrierWave::VERSION.to_i > 2
-  raise "CarrierWave version (#{CarrierWave::VERSION}) not supported in this version of Lockbox (#{Lockbox::VERSION})"
+  raise Lockbox::Error, "CarrierWave #{CarrierWave::VERSION} not supported in this version of Lockbox"
 elsif CarrierWave::VERSION.to_i < 1
-  # TODO raise error in 0.7.0
-  warn "CarrierWave version (#{CarrierWave::VERSION}) not supported in this version of Lockbox (#{Lockbox::VERSION})"
+  raise Lockbox::Error, "CarrierWave #{CarrierWave::VERSION} not supported"
 end
 
 CarrierWave::Uploader::Base.extend(Lockbox::CarrierWaveExtensions)

data/lib/lockbox/model.rb

@@ -1,6 +1,6 @@
 module Lockbox
   module Model
-    def lockbox_encrypts(*attributes, **options)
+    def has_encrypted(*attributes, **options)
       # support objects
       # case options[:type]
       # when Date
@@ -241,6 +241,23 @@ module Lockbox
           @lockbox_attributes[original_name] = options
 
           if activerecord
+            # 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]
+
+              has_default =
+                if ActiveRecord::VERSION::MAJOR >= 7
+                  # not ideal, since NO_DEFAULT_PROVIDED is private
+                  opt != ActiveRecord::Attributes::ClassMethods.const_get(:NO_DEFAULT_PROVIDED)
+                else
+                  opt.is_a?(Hash) && opt.key?(:default)
+                end
+
+              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
@@ -303,11 +320,9 @@ module Lockbox
               send("restore_#{encrypted_attribute}!")
             end
 
-            if ActiveRecord::VERSION::STRING >= "5.1"
-              define_method("#{name}_in_database") do
-                send(name) # writes attribute when not already set
-                super()
-              end
+            define_method("#{name}_in_database") do
+              send(name) # writes attribute when not already set
+              super()
             end
 
             define_method("#{name}?") do
@@ -443,7 +458,6 @@ module Lockbox
             table = activerecord ? table_name : collection_name.to_s
 
             unless message.nil?
-              # TODO use attribute type class in 0.7.0
               case options[:type]
               when :boolean
                 message = ActiveRecord::Type::Boolean.new.serialize(message)
@@ -506,7 +520,6 @@ module Lockbox
               end
 
             unless message.nil?
-              # TODO use attribute type class in 0.7.0
               case options[:type]
               when :boolean
                 message = message == "t"
@@ -564,6 +577,11 @@ module Lockbox
       end
     end
 
+    def lockbox_encrypts(*attributes, **options)
+      ActiveSupport::Deprecation.warn("`#{__callee__}` is deprecated in favor of `has_encrypted`")
+      has_encrypted(*attributes, **options)
+    end
+
     module Attached
       def encrypts_attached(*attributes, **options)
         attributes.each do |name|

data/lib/lockbox/version.rb

@@ -1,3 +1,3 @@
 module Lockbox
-  VERSION = "0.6.8"
+  VERSION = "1.0.0"
 end

data/lib/lockbox.rb

@@ -16,36 +16,6 @@ require "lockbox/padding"
 require "lockbox/utils"
 require "lockbox/version"
 
-# integrations
-require "lockbox/carrier_wave_extensions" if defined?(CarrierWave)
-require "lockbox/railtie" if defined?(Rails)
-
-if defined?(ActiveSupport::LogSubscriber)
-  require "lockbox/log_subscriber"
-  Lockbox::LogSubscriber.attach_to :lockbox
-end
-
-if defined?(ActiveSupport.on_load)
-  ActiveSupport.on_load(:active_record) do
-    # TODO raise error in 0.7.0
-    if ActiveRecord::VERSION::STRING.to_f < 5.0
-      warn "Active Record version (#{ActiveRecord::VERSION::STRING}) not supported in this version of Lockbox (#{Lockbox::VERSION})"
-    end
-
-    extend Lockbox::Model
-    extend Lockbox::Model::Attached
-    # alias_method is private in Ruby < 2.5
-    singleton_class.send(:alias_method, :encrypts, :lockbox_encrypts) if ActiveRecord::VERSION::MAJOR < 7
-    ActiveRecord::Relation.prepend Lockbox::Calculations
-  end
-
-  ActiveSupport.on_load(:mongoid) do
-    Mongoid::Document::ClassMethods.include(Lockbox::Model)
-    # alias_method is private in Ruby < 2.5
-    Mongoid::Document::ClassMethods.send(:alias_method, :encrypts, :lockbox_encrypts)
-  end
-end
-
 module Lockbox
   class Error < StandardError; end
   class DecryptionError < Error; end
@@ -110,7 +80,39 @@ module Lockbox
 
   def self.encrypts_action_text_body(**options)
     ActiveSupport.on_load(:action_text_rich_text) do
-      ActionText::RichText.lockbox_encrypts :body, **options
+      ActionText::RichText.has_encrypted :body, **options
     end
   end
 end
+
+# integrations
+require "lockbox/carrier_wave_extensions" if defined?(CarrierWave)
+require "lockbox/railtie" if defined?(Rails)
+
+if defined?(ActiveSupport::LogSubscriber)
+  require "lockbox/log_subscriber"
+  Lockbox::LogSubscriber.attach_to :lockbox
+end
+
+if defined?(ActiveSupport.on_load)
+  ActiveSupport.on_load(:active_record) do
+    ar_version = ActiveRecord::VERSION::STRING.to_f
+    if ar_version < 5.2
+      if ar_version >= 5
+        raise Lockbox::Error, "Active Record #{ActiveRecord::VERSION::STRING} requires Lockbox < 0.7"
+      else
+        raise Lockbox::Error, "Active Record #{ActiveRecord::VERSION::STRING} not supported"
+      end
+    end
+
+    extend Lockbox::Model
+    extend Lockbox::Model::Attached
+    singleton_class.alias_method(:encrypts, :lockbox_encrypts) if ActiveRecord::VERSION::MAJOR < 7
+    ActiveRecord::Relation.prepend Lockbox::Calculations
+  end
+
+  ActiveSupport.on_load(:mongoid) do
+    Mongoid::Document::ClassMethods.include(Lockbox::Model)
+    Mongoid::Document::ClassMethods.alias_method(:encrypts, :lockbox_encrypts)
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lockbox
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 1.0.0
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-26 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies: []
 description:
 email: andrew@ankane.org
@@ -51,14 +51,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Modern encryption for Ruby and Rails