authtrail 0.1.3 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d58f1c05f2177c5a9dd84c1aeed638ce17b5d601f8b8b9a677f5046cad5f239
-  data.tar.gz: 79b099d5edba1165e553c35aa8ed43040ca58c2d1ff2616f76cd020da48b15d5
+  metadata.gz: eb0329a5efc01b445b4686a7e1712d6937f57d52443ad880802c5a79c6e746c4
+  data.tar.gz: d4ac5c96149eebd39ba9964303758e48b537e1823345e27117ce35bf1ff7752a
 SHA512:
-  metadata.gz: bc289ab35e5bddd7ea8043fe771787f737bc6661444921485a0b86d13c741c39e4812277718246d612f17bd63cd9719543d23f57803b17cdd30e20f948eeb1ae
-  data.tar.gz: 8ba5999ed1ed9f96a225d4f16ce94117204045d3375080ca6dbac0f4020a5e0b00279e69175ef0845403707ea5a1c9b89fe709a0b613666bf207f04cea2c46b2
+  metadata.gz: 837b7df27b74e7c4ac54855bc40584c0fb7ed5291abb5f7627d13d9bd5fa8adfb25bdb50f2292721c67394ca5a8274b8e95a881bf63213dea7a73b927da204ae
+  data.tar.gz: 20b98bad8507a73e67fececc5cb2811a98013e4f449ab8d8b9c97227a4ffb33ecdf1237228c3282ebd3449f2b04cd080369b75d3c1f4f6fa585155169d1433cd

data/CHANGELOG.md

@@ -1,17 +1,41 @@
-## 0.1.3
+## 0.3.1 (2021-03-03)
+
+- Added `--lockbox` option to install generator
+
+## 0.3.0 (2021-03-01)
+
+- Disabled geocoding by default for new installations
+- Raise an exception instead of logging when auditing fails
+- Removed support for Rails < 5.2 and Ruby < 2.6
+
+## 0.2.2 (2020-11-21)
+
+- Added `transform_method` option
+
+## 0.2.1 (2020-08-17)
+
+- Added `job_queue` option
+
+## 0.2.0 (2019-06-23)
+
+- Added latitude and longitude
+- `AuthTrail::GeocodeJob` now inherits from `ActiveJob::Base` instead of `ApplicationJob`
+- Removed support for Rails 4.2
+
+## 0.1.3 (2018-09-27)
 
 - Added support for Rails 4.2
 
-## 0.1.2
+## 0.1.2 (2018-07-30)
 
 - Added `identity_method` option
 - Fixed geocoding
 
-## 0.1.1
+## 0.1.1 (2018-07-13)
 
 - Improved strategy detection for failures
 - Fixed migration for MySQL
 
-## 0.1.0
+## 0.1.0 (2017-11-07)
 
 - First release

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2017-2018 Andrew Kane
+Copyright (c) 2017-2021 Andrew Kane
 
 MIT License
 

data/README.md

@@ -4,6 +4,8 @@ Track Devise login activity
 
 :tangerine: Battle-tested at [Instacart](https://www.instacart.com/opensource)
 
+[![Build Status](https://github.com/ankane/authtrail/workflows/build/badge.svg?branch=master)](https://github.com/ankane/authtrail/actions)
+
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -12,7 +14,14 @@ Add this line to your application’s Gemfile:
 gem 'authtrail'
 ```
 
-And run:
+To encrypt email and IP addresses, 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 db:migrate
+```
+
+If you prefer not to encrypt data, run:
 
 ```sh
 rails generate authtrail:install
@@ -32,7 +41,7 @@ A `LoginActivity` record is created every time a user tries to login. You can th
 - `context` - controller and action
 - `ip` - IP address
 - `user_agent` and `referrer` - from browser
-- `city`, `region`, and `country` - from IP
+- `city`, `region`, `country`, `latitude`, and `longitude` - from IP
 - `created_at` - time of event
 
 ## Features
@@ -40,20 +49,36 @@ A `LoginActivity` record is created every time a user tries to login. You can th
 Exclude certain attempts from tracking - useful if you run acceptance tests
 
 ```ruby
-AuthTrail.exclude_method = lambda do |info|
-  info[:identity] == "capybara@example.org"
+AuthTrail.exclude_method = lambda do |data|
+  data[:identity] == "capybara@example.org"
+end
+```
+
+Add or modify data - also add new fields to the `login_activities` table if needed
+
+```ruby
+AuthTrail.transform_method = lambda do |data, request|
+  data[:request_id] = request.request_id
+end
+```
+
+Store the user on failed attempts
+
+```ruby
+AuthTrail.transform_method = lambda do |data, request|
+  data[:user] ||= User.find_by(email: data[:identity])
 end
 ```
 
 Write data somewhere other than the `login_activities` table
 
 ```ruby
-AuthTrail.track_method = lambda do |info|
+AuthTrail.track_method = lambda do |data|
   # code
 end
 ```
 
-Use a custom identity method [master]
+Use a custom identity method
 
 ```ruby
 AuthTrail.identity_method = lambda do |request, opts, user|
@@ -73,63 +98,96 @@ class User < ApplicationRecord
 end
 ```
 
-The `LoginActivity` model uses a [polymorphic association](http://guides.rubyonrails.org/association_basics.html#polymorphic-associations) so it can be associated with different user models.
+The `LoginActivity` model uses a [polymorphic association](https://guides.rubyonrails.org/association_basics.html#polymorphic-associations) so it can be associated with different user models.
 
 ## Geocoding
 
-IP geocoding is performed in a background job so it doesn’t slow down web requests. You can disable it entirely with:
+AuthTrail uses [Geocoder](https://github.com/alexreisner/geocoder) for geocoding. We recommend configuring [local geocoding](#local-geocoding) or [load balancer geocoding](#load-balancer-geocoding) so IP addresses are not sent to a 3rd party service. If you do use a 3rd party service and adhere to GDPR, be sure to add it to your subprocessor list.
+
+To enable geocoding, update `config/initializers/authtrail.rb`:
 
 ```ruby
-AuthTrail.geocode = false
+AuthTrail.geocode = true
 ```
 
-Set job queue for geocoding
+Geocoding is performed in a background job so it doesn’t slow down web requests. Set the job queue with:
 
 ```ruby
-AuthTrail::GeocodeJob.queue_as :low
+AuthTrail.job_queue = :low_priority
 ```
 
-### Geocoding Performance
+### Local Geocoding
 
-To avoid calls to a remote API, download the [GeoLite2 City database](https://dev.maxmind.com/geoip/geoip2/geolite2/) and configure Geocoder to use it.
-
-Add this line to your application’s Gemfile:
+For privacy and performance, we recommend geocoding locally. Add this line to your application’s Gemfile:
 
 ```ruby
 gem 'maxminddb'
 ```
 
-And create an initializer at `config/initializers/geocoder.rb` with:
+For city-level geocoding, download the [GeoLite2 City database](https://dev.maxmind.com/geoip/geoip2/geolite2/) and create `config/initializers/geocoder.rb` with:
 
 ```ruby
 Geocoder.configure(
   ip_lookup: :geoip2,
   geoip2: {
-    file: Rails.root.join("lib", "GeoLite2-City.mmdb")
+    file: "path/to/GeoLite2-City.mmdb"
+  }
+)
+```
+
+For country-level geocoding, install the `geoip-database` package. It’s preinstalled on Heroku. For Ubuntu, use:
+
+```sh
+sudo apt-get install geoip-database
+```
+
+And create `config/initializers/geocoder.rb` with:
+
+```ruby
+Geocoder.configure(
+  ip_lookup: :maxmind_local,
+  maxmind_local: {
+    file: "/usr/share/GeoIP/GeoIP.dat",
+    package: :country
   }
 )
 ```
 
-## Data Protection
+### Load Balancer Geocoding
+
+Some load balancers can add geocoding information to request headers.
 
-Protect the privacy of your users by encrypting fields that contain personal information, such as `identity` and `ip`. [attr_encrypted](https://github.com/attr-encrypted/attr_encrypted) is great for this.
+- [nginx](https://nginx.org/en/docs/http/ngx_http_geoip_module.html)
+- [Google Cloud](https://cloud.google.com/load-balancing/docs/custom-headers)
+- [Cloudflare](https://support.cloudflare.com/hc/en-us/articles/200168236-Configuring-Cloudflare-IP-Geolocation)
 
 ```ruby
-class LoginActivity < ApplicationRecord
-  attr_encrypted :identity, ...
-  attr_encrypted :ip, ...
+AuthTrail.geocode = false
+AuthTrail.transform_method = lambda do |data, request|
+  data[:country] = request.headers["<country-header>"]
+  data[:region] = request.headers["<region-header>"]
+  data[:city] = request.headers["<city-header>"]
 end
 ```
 
-You should also make it clear that you collect this information in your privacy policy.
+Check out [this example](https://github.com/ankane/authtrail/issues/40)
 
 ## Other Notes
 
 We recommend using this in addition to Devise’s `Lockable` module and [Rack::Attack](https://github.com/kickstarter/rack-attack).
 
-Check out [Hardening Devise](https://github.com/ankane/shorts/blob/master/Hardening-Devise.md) and [Secure Rails](https://github.com/ankane/secure_rails) for more best practices.
+Check out [Hardening Devise](https://ankane.org/hardening-devise) and [Secure Rails](https://github.com/ankane/secure_rails) for more best practices.
+
+## Upgrading
+
+### 0.2.0
 
-Works with Rails 4.2+
+To store latitude and longitude, create a migration with:
+
+```ruby
+add_column :login_activities, :latitude, :float
+add_column :login_activities, :longitude, :float
+```
 
 ## History
 
@@ -143,3 +201,12 @@ Everyone is encouraged to help improve this project. Here are a few ways you can
 - Fix bugs and [submit pull requests](https://github.com/ankane/authtrail/pulls)
 - Write, clarify, or fix documentation
 - Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/authtrail.git
+cd authtrail
+bundle install
+bundle exec rake test
+```

data/app/jobs/auth_trail/geocode_job.rb

@@ -1,5 +1,9 @@
 module AuthTrail
-  class GeocodeJob < Rails::VERSION::MAJOR >= 5 ? ApplicationJob : ActiveJob::Base
+  class GeocodeJob < ActiveJob::Base
+    # default queue is used if queue_as returns nil
+    # Rails has a test for this
+    queue_as { AuthTrail.job_queue }
+
     def perform(login_activity)
       result =
         begin
@@ -10,11 +14,17 @@ module AuthTrail
         end
 
       if result
-        login_activity.update!(
-          city: result.try(:city).presence,
-          region: result.try(:state).presence,
-          country: result.try(:country).presence
-        )
+        attributes = {
+          city: result.try(:city),
+          region: result.try(:state),
+          country: result.try(:country),
+          latitude: result.try(:latitude),
+          longitude: result.try(:longitude)
+        }
+        attributes.each do |k, v|
+          login_activity.try("#{k}=", v.presence)
+        end
+        login_activity.save!
       end
     end
   end

data/lib/auth_trail/manager.rb

@@ -2,36 +2,29 @@ module AuthTrail
   module Manager
     class << self
       def after_set_user(user, auth, opts)
-        # do not raise an exception for tracking
-        AuthTrail.safely do
-          request = ActionDispatch::Request.new(auth.env)
+        request = ActionDispatch::Request.new(auth.env)
 
-          AuthTrail.track(
-            strategy: detect_strategy(auth),
-            scope: opts[:scope].to_s,
-            identity: AuthTrail.identity_method.call(request, opts, user),
-            success: true,
-            request: request,
-            user: user
-          )
-        end
+        AuthTrail.track(
+          strategy: detect_strategy(auth),
+          scope: opts[:scope].to_s,
+          identity: AuthTrail.identity_method.call(request, opts, user),
+          success: true,
+          request: request,
+          user: user
+        )
       end
 
       def before_failure(env, opts)
-        AuthTrail.safely do
-          if opts[:message]
-            request = ActionDispatch::Request.new(env)
+        request = ActionDispatch::Request.new(env)
 
-            AuthTrail.track(
-              strategy: detect_strategy(env["warden"]),
-              scope: opts[:scope].to_s,
-              identity: AuthTrail.identity_method.call(request, opts, nil),
-              success: false,
-              request: request,
-              failure_reason: opts[:message].to_s
-            )
-          end
-        end
+        AuthTrail.track(
+          strategy: detect_strategy(env["warden"]),
+          scope: opts[:scope].to_s,
+          identity: AuthTrail.identity_method.call(request, opts, nil),
+          success: false,
+          request: request,
+          failure_reason: opts[:message].to_s
+        )
       end
 
       private

data/lib/auth_trail/version.rb

@@ -1,3 +1,3 @@
 module AuthTrail
-  VERSION = "0.1.3"
+  VERSION = "0.3.1"
 end

data/lib/authtrail.rb

@@ -9,7 +9,7 @@ require "auth_trail/version"
 
 module AuthTrail
   class << self
-    attr_accessor :exclude_method, :geocode, :track_method, :identity_method
+    attr_accessor :exclude_method, :geocode, :track_method, :identity_method, :job_queue, :transform_method
   end
   self.geocode = true
   self.identity_method = lambda do |request, opts, user|
@@ -22,7 +22,7 @@ module AuthTrail
   end
 
   def self.track(strategy:, scope:, identity:, success:, request:, user: nil, failure_reason: nil)
-    info = {
+    data = {
       strategy: strategy,
       scope: scope,
       identity: identity,
@@ -35,17 +35,25 @@ module AuthTrail
     }
 
     if request.params[:controller]
-      info[:context] = "#{request.params[:controller]}##{request.params[:action]}"
+      data[:context] = "#{request.params[:controller]}##{request.params[:action]}"
     end
 
+    # add request data before exclude_method since exclude_method doesn't have access to request
+    # could also add 2nd argument to exclude_method when arity > 1
+    AuthTrail.transform_method.call(data, request) if AuthTrail.transform_method
+
     # if exclude_method throws an exception, default to not excluding
-    exclude = AuthTrail.exclude_method && AuthTrail.safely(default: false) { AuthTrail.exclude_method.call(info) }
+    exclude = AuthTrail.exclude_method && AuthTrail.safely(default: false) { AuthTrail.exclude_method.call(data) }
 
     unless exclude
       if AuthTrail.track_method
-        AuthTrail.track_method.call(info)
+        AuthTrail.track_method.call(data)
       else
-        login_activity = LoginActivity.create!(info)
+        login_activity = LoginActivity.new
+        data.each do |k, v|
+          login_activity.try("#{k}=", v)
+        end
+        login_activity.save!
         AuthTrail::GeocodeJob.perform_later(login_activity) if AuthTrail.geocode
       end
     end
@@ -66,5 +74,5 @@ Warden::Manager.after_set_user except: :fetch do |user, auth, opts|
 end
 
 Warden::Manager.before_failure do |env, opts|
-  AuthTrail::Manager.before_failure(env, opts)
+  AuthTrail::Manager.before_failure(env, opts) if opts[:message]
 end

data/lib/generators/authtrail/install_generator.rb

@@ -1,52 +1,52 @@
-# taken from https://github.com/collectiveidea/audited/blob/master/lib/generators/audited/install_generator.rb
-require "rails/generators"
-require "rails/generators/migration"
-require "active_record"
 require "rails/generators/active_record"
 
 module Authtrail
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      include Rails::Generators::Migration
-      source_root File.expand_path("../templates", __FILE__)
-
-      # Implement the required interface for Rails::Generators::Migration.
-      def self.next_migration_number(dirname) #:nodoc:
-        next_migration_number = current_migration_number(dirname) + 1
-        if ::ActiveRecord::Base.timestamped_migrations
-          [Time.now.utc.strftime("%Y%m%d%H%M%S"), "%.14d" % next_migration_number].max
-        else
-          "%.3d" % next_migration_number
-        end
-      end
+      include ActiveRecord::Generators::Migration
+      source_root File.join(__dir__, "templates")
+
+      class_option :lockbox, type: :boolean
 
       def copy_migration
         migration_template "login_activities_migration.rb", "db/migrate/create_login_activities.rb", migration_version: migration_version
       end
 
-      def generate_model
-        template "login_activity_model.rb", "app/models/login_activity.rb", model_base_class: model_base_class, ar_optional_flag: ar_optional_flag
+      def copy_templates
+        template "initializer.rb", "config/initializers/authtrail.rb"
       end
 
-      def migration_version
-        if rails5?
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      def generate_model
+        if lockbox?
+          template "model_lockbox.rb", "app/models/login_activity.rb"
+        else
+          template "model.rb", "app/models/login_activity.rb"
         end
       end
 
-      def rails5?
-        Rails::VERSION::MAJOR >= 5
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
       end
 
-      def model_base_class
-        rails5? ? "ApplicationRecord" : "ActiveRecord::Base"
+      def identity_column
+        if lockbox?
+          "t.text :identity_ciphertext\n      t.string :identity_bidx, index: true"
+        else
+          "t.string :identity, index: true"
+        end
       end
 
-      def ar_optional_flag
-        if rails5?
-          ", optional: true"
+      def ip_column
+        if lockbox?
+          "t.text :ip_ciphertext\n      t.string :ip_bidx, index: true"
+        else
+          "t.string :ip, index: true"
         end
       end
+
+      def lockbox?
+        options[:lockbox]
+      end
     end
   end
 end

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

@@ -0,0 +1,14 @@
+# set to true for geocoding
+# we recommend configuring local geocoding first
+# see https://github.com/ankane/authtrail#geocoding
+AuthTrail.geocode = false
+
+# add or modify data
+# AuthTrail.transform_method = lambda do |data, request|
+#   data[:request_id] = request.request_id
+# end
+
+# exclude certain attempts from tracking
+# AuthTrail.exclude_method = lambda do |data|
+#   data[:identity] == "capybara@example.org"
+# end

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

@@ -3,21 +3,20 @@ class <%= migration_class_name %> < ActiveRecord::Migration<%= migration_version
     create_table :login_activities do |t|
       t.string :scope
       t.string :strategy
-      t.string :identity
+      <%= identity_column %>
       t.boolean :success
       t.string :failure_reason
       t.references :user, polymorphic: true
       t.string :context
-      t.string :ip
+      <%= ip_column %>
       t.text :user_agent
       t.text :referrer
       t.string :city
       t.string :region
       t.string :country
+      t.float :latitude
+      t.float :longitude
       t.datetime :created_at
     end
-
-    add_index :login_activities, :identity
-    add_index :login_activities, :ip
   end
 end

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

@@ -0,0 +1,3 @@
+class LoginActivity < ApplicationRecord
+  belongs_to :user, polymorphic: true, optional: true
+end

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

@@ -0,0 +1,14 @@
+class LoginActivity < ApplicationRecord
+  belongs_to :user, polymorphic: true, optional: true
+
+  encrypts :identity, :ip
+  blind_index :identity, :ip
+
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: authtrail
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.3.1
 platform: ruby
 authors:
 - Andrew Kane
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-28 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: warden
   requirement: !ruby/object:Gem::Requirement
@@ -66,50 +66,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-description: 
-email: andrew@chartkick.com
+description:
+email: andrew@ankane.org
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -123,13 +81,15 @@ files:
 - lib/auth_trail/version.rb
 - lib/authtrail.rb
 - 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/login_activity_model.rb.tt
+- lib/generators/authtrail/templates/model.rb.tt
+- lib/generators/authtrail/templates/model_lockbox.rb.tt
 homepage: https://github.com/ankane/authtrail
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,16 +97,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Track Devise login activity
 test_files: []

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

@@ -1,3 +0,0 @@
-class LoginActivity < <%= model_base_class %>
-  belongs_to :user, polymorphic: true<%= ar_optional_flag %>
-end