authtrail 0.4.0 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc8ae231bde9d10834ea6a7fa2fb0cd50a12e351ba2296abb15b743975fad197
-  data.tar.gz: c52435deca659cd45a8ed647daccaf8b19e9d7d92374db06be69c63cbcc6b1e3
+  metadata.gz: 00a8cfabe2cfddb7349c055c13db2b56080409058ba48813310c6218a6b34fba
+  data.tar.gz: 59190df662382f672ad17c753d1eee6c0f8afacb68f7e082ed8766f188487d66
 SHA512:
-  metadata.gz: 8531404800e70b37e0f6bca1fd79f690bfe36434efe768c926fa7248f1f50d803de16aa3324ecaa656c142940e69de35f80d2c5f4699f5408fbd92f41e5c24b0
-  data.tar.gz: bd4daf16b7ad615477cdbf0592f45d789fa7b6b0ba759c417f6e4e89888e2b4014dae6a2b48333a9863b6b1b0670082f9b9808da327dc790f2e0f173d6d63714
+  metadata.gz: c9137421c5e8f4c91be7dae62ccc9f12a831da6ae6fb390cfca766274045135c130f3cd9b0b5178d041be1348c527f39cc1aa0c986c798634e68300ee1c5a0a7
+  data.tar.gz: fa139b3a9df804feb52fa3823a67fb88781cefeda509d5719caf3f98c793e1aaaaecec553e8d1b1f08c03da8c4886b8e42400158e04aef12c34d404045b7b799

data/CHANGELOG.md

@@ -1,6 +1,19 @@
+## 0.4.3 (2022-06-12)
+
+- Updated install generator for Lockbox 1.0
+
+## 0.4.2 (2021-12-13)
+
+- Added experimental support for Active Record encryption
+- Fixed error with Rails 7 rc1
+
+## 0.4.1 (2021-08-14)
+
+- Improved error message when `geocoder` gem not installed
+
 ## 0.4.0 (2021-08-13)
 
-- Disabled geocoding by default
+- Disabled geocoding by default (this was already the case for new installations with 0.3.0+)
 - Made the `geocoder` gem an optional dependency
 - Added `country_code` to geocoding
 

data/README.md

@@ -13,20 +13,27 @@ Track Devise login activity
 Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'authtrail'
+gem "authtrail"
 ```
 
-To encrypt email and IP addresses, install [Lockbox](https://github.com/ankane/lockbox) and [Blind Index](https://github.com/ankane/blind_index) and run:
+To encrypt email and IP addresses with Lockbox, install [Lockbox](https://github.com/ankane/lockbox) and [Blind Index](https://github.com/ankane/blind_index) and run:
 
 ```sh
-rails generate authtrail:install --lockbox
+rails generate authtrail:install --encryption=lockbox
+rails db:migrate
+```
+
+To use Active Record encryption (Rails 7+, experimental), run:
+
+```sh
+rails generate authtrail:install --encryption=activerecord
 rails db:migrate
 ```
 
 If you prefer not to encrypt data, run:
 
 ```sh
-rails generate authtrail:install
+rails generate authtrail:install --encryption=none
 rails db:migrate
 ```
 
@@ -111,7 +118,7 @@ AuthTrail uses [Geocoder](https://github.com/alexreisner/geocoder) for geocoding
 To enable geocoding, add this line to your application’s Gemfile:
 
 ```ruby
-gem 'geocoder'
+gem "geocoder"
 ```
 
 And update `config/initializers/authtrail.rb`:
@@ -131,7 +138,7 @@ AuthTrail.job_queue = :low_priority
 For privacy and performance, we recommend geocoding locally. Add this line to your application’s Gemfile:
 
 ```ruby
-gem 'maxminddb'
+gem "maxminddb"
 ```
 
 For city-level geocoding, download the [GeoLite2 City database](https://dev.maxmind.com/geoip/geoip2/geolite2/) and create `config/initializers/geocoder.rb` with:
@@ -173,6 +180,7 @@ Some load balancers can add geocoding information to request headers.
 
 ```ruby
 AuthTrail.geocode = false
+
 AuthTrail.transform_method = lambda do |data, request|
   data[:country] = request.headers["<country-header>"]
   data[:region] = request.headers["<region-header>"]
@@ -182,6 +190,20 @@ end
 
 Check out [this example](https://github.com/ankane/authtrail/issues/40)
 
+## Data Retention
+
+Delete older data with:
+
+```ruby
+LoginActivity.where("created_at < ?", 2.years.ago).in_batches.delete_all
+```
+
+Delete data for a specific user with:
+
+```ruby
+LoginActivity.where(user_id: 1, user_type: "User").in_batches.delete_all
+```
+
 ## Other Notes
 
 We recommend using this in addition to Devise’s `Lockable` module and [Rack::Attack](https://github.com/kickstarter/rack-attack).
@@ -199,7 +221,7 @@ There are two notable changes to geocoding:
 2. The `geocoder` gem is now an optional dependency. To use geocoding, add it to your Gemfile:
 
   ```ruby
-  gem 'geocoder'
+  gem "geocoder"
   ```
 
 ### 0.2.0

data/app/jobs/auth_trail/geocode_job.rb

@@ -9,8 +9,7 @@ module AuthTrail
         begin
           Geocoder.search(login_activity.ip).first
         rescue NameError
-          # geocoder gem not installed
-          raise
+          raise "Add the geocoder gem to your Gemfile to use geocoding"
         rescue => e
           Rails.logger.info "Geocode failed: #{e.message}"
           nil

data/lib/auth_trail/engine.rb

@@ -1,3 +1,4 @@
+require "active_support"
 require "rails/engine"
 
 module AuthTrail

data/lib/auth_trail/version.rb

@@ -1,3 +1,3 @@
 module AuthTrail
-  VERSION = "0.4.0"
+  VERSION = "0.4.3"
 end

data/lib/generators/authtrail/install_generator.rb

@@ -6,9 +6,12 @@ module Authtrail
       include ActiveRecord::Generators::Migration
       source_root File.join(__dir__, "templates")
 
+      class_option :encryption, type: :string
+      # deprecated
       class_option :lockbox, type: :boolean
 
       def copy_migration
+        encryption # ensure valid
         migration_template "login_activities_migration.rb", "db/migrate/create_login_activities.rb", migration_version: migration_version
       end
 
@@ -17,10 +20,13 @@ module Authtrail
       end
 
       def generate_model
-        if lockbox?
-          template "model_lockbox.rb", "app/models/login_activity.rb"
+        case encryption
+        when "lockbox"
+          template "model_lockbox.rb", "app/models/login_activity.rb", lockbox_method: lockbox_method
+        when "activerecord"
+          template "model_activerecord.rb", "app/models/login_activity.rb"
         else
-          template "model.rb", "app/models/login_activity.rb"
+          template "model_none.rb", "app/models/login_activity.rb"
         end
       end
 
@@ -29,23 +35,48 @@ module Authtrail
       end
 
       def identity_column
-        if lockbox?
+        case encryption
+        when "lockbox"
           "t.text :identity_ciphertext\n      t.string :identity_bidx, index: true"
         else
+          # TODO add limit: 510 for Active Record encryption + MySQL?
           "t.string :identity, index: true"
         end
       end
 
       def ip_column
-        if lockbox?
+        case encryption
+        when "lockbox"
           "t.text :ip_ciphertext\n      t.string :ip_bidx, index: true"
         else
+          # TODO add limit: 510 for Active Record encryption + MySQL?
           "t.string :ip, index: true"
         end
       end
 
-      def lockbox?
-        options[:lockbox]
+      # TODO remove default
+      def encryption
+        case options[:encryption]
+        when "lockbox", "activerecord", "none"
+          options[:encryption]
+        when nil
+          if options[:lockbox]
+            # TODO deprecation warning
+            "lockbox"
+          else
+            "none"
+          end
+        else
+          abort "Error: encryption must be lockbox, activerecord, or none"
+        end
+      end
+
+      def lockbox_method
+        if defined?(Lockbox::VERSION) && Lockbox::VERSION.to_i < 1
+          "encrypts"
+        else
+          "has_encrypted"
+        end
       end
     end
   end

data/lib/generators/authtrail/templates/model_activerecord.rb.tt

@@ -0,0 +1,14 @@
+class LoginActivity < ApplicationRecord
+  belongs_to :user, polymorphic: true, optional: true
+
+  encrypts :identity, deterministic: true
+  encrypts :ip, deterministic: true
+
+  before_save :reduce_precision
+
+  # reduce precision to city level to protect IP
+  def reduce_precision
+    self.latitude = latitude&.round(1) if try(:latitude_changed?)
+    self.longitude = longitude&.round(1) if try(:longitude_changed?)
+  end
+end

data/lib/generators/authtrail/templates/model_lockbox.rb.tt

@@ -1,7 +1,7 @@
 class LoginActivity < ApplicationRecord
   belongs_to :user, polymorphic: true, optional: true
 
-  encrypts :identity, :ip
+  <%= lockbox_method %> :identity, :ip
   blind_index :identity, :ip
 
   before_save :reduce_precision

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authtrail
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.3
 platform: ruby
 authors:
 - Andrew Kane
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-08-13 00:00:00.000000000 Z
+date: 2022-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -69,8 +69,9 @@ files:
 - lib/generators/authtrail/install_generator.rb
 - lib/generators/authtrail/templates/initializer.rb.tt
 - lib/generators/authtrail/templates/login_activities_migration.rb.tt
-- lib/generators/authtrail/templates/model.rb.tt
+- lib/generators/authtrail/templates/model_activerecord.rb.tt
 - lib/generators/authtrail/templates/model_lockbox.rb.tt
+- lib/generators/authtrail/templates/model_none.rb.tt
 homepage: https://github.com/ankane/authtrail
 licenses:
 - MIT
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Track Devise login activity