trackguard 0.15.2 → 0.16.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae9f9bf943f2d35552e716b36c5a0fe3034ec1c950897ca8600063b5ae957e1e
-  data.tar.gz: fefa54219e288aeaca10e3fd2e5ba7533e06e50b197182980dfe7179fedb5118
+  metadata.gz: b4c12f652065f915f2b4b906869a232738d8cf96632e6676f7107e84c442ea9d
+  data.tar.gz: a50ce6042ea670cb43486972f7a47a8187273aebd2947bd42f2ccfd4aba67225
 SHA512:
-  metadata.gz: a79523a214364741d689519ac4aba172661b3634bda347b433544b6a9e49a655c569c5b0bbde41573038dc53bdfe262fac8735d2b98f84cfb7b8659e23b57bed
-  data.tar.gz: def6dacf4f57e4c7380a1ade1cec4c8ae421127bbe047b8276b3bbe0c0f1dd212e5b58dc68ef9dfe270f4b2299d0a9f959b5040b2fb146974ec57e8cdfdbe904
+  metadata.gz: 4eb185b4afe7cd71d3347afac5d203625a3348ff812647fc3ea6b04cff52bb2ded026d2601d546945900bd5f9a05bb0154fcb78a590ae6f5ec3249f283254b04
+  data.tar.gz: 18a0b707b1c085cab5c43a7249c4a6ed8bf753ba30a3b1e4e5bee00283381de4f2f511af06651009b587e9eeada7d69a860d4664f914adf92dfd2307e16d84f2

data/app/controllers/concerns/trackguard/page_tracker.rb

@@ -29,7 +29,8 @@ module Trackguard
         referer: request.referer,
         session_id: session.id.to_s,
         trace_id: @trace_id,
-        source: extract_source
+        source: extract_source,
+        http_method: request.request_method
       )
     end
 

data/app/controllers/trackguard/page_views_controller.rb

@@ -9,7 +9,8 @@ module Trackguard
         session_id: session.id.to_s,
         trace_id: params[:trace_id].to_s.presence,
         source: params[:ref].to_s.strip.downcase.first(64).presence,
-        initial: params[:initial] == true
+        initial: params[:initial] == true,
+        http_method: "GET"
       )
 
       head :no_content

data/app/jobs/trackguard/detect_suspicious_visitors_job.rb

@@ -103,7 +103,7 @@ module Trackguard
         .unflagged
         .joins("LEFT OUTER JOIN trackguard_whitelisted_ips wi ON wi.visitor_id = trackguard_visitors.id")
         .joins(:page_views)
-        .where(trackguard_page_views: { trace_id: shared, created_at: cutoff.. })
+        .where(trackguard_visits: { trace_id: shared, created_at: cutoff.. })
         .where("wi.id IS NULL OR wi.expires_at <= ?", Time.current)
         .distinct
         .each do |visitor|

data/app/jobs/trackguard/track_blocked_request_job.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Trackguard
+  class TrackBlockedRequestJob < ApplicationJob
+    queue_as :default
+
+    def perform(ip:, user_agent:, path:, http_method:, block_reason:)
+      visitor = Visitor.find_or_create_by!(ip: ip) do |v|
+        v.user_agent    = user_agent
+        v.first_seen_at = Time.current
+        v.last_seen_at  = Time.current
+      end
+      visitor.update!(last_seen_at: Time.current, user_agent: user_agent)
+
+      BlockedRequest.create!(
+        path: path,
+        user_agent: user_agent,
+        http_method: http_method,
+        block_reason: block_reason,
+        visitor: visitor
+      )
+    end
+  end
+end

data/app/jobs/trackguard/track_page_view_job.rb

@@ -2,7 +2,8 @@ module Trackguard
   class TrackPageViewJob < ApplicationJob
     queue_as :default
 
-    def perform(path:, ip:, user_agent:, referer:, session_id: nil, trace_id: nil, source: nil, initial: false)
+    def perform(path:, ip:, user_agent:, referer:, session_id: nil, trace_id: nil, source: nil, initial: false,
+                http_method: nil)
       hashed_session_id = Digest::SHA256.hexdigest(session_id) if session_id.present?
 
       visitor = Visitor.find_or_create_by!(ip: ip) do |v|
@@ -22,7 +23,7 @@ module Trackguard
         end
       end
 
-      PageView.create_with(source:, referer:)
+      PageView.create_with(source:, referer:, http_method:)
               .find_or_create_by!(path:, user_agent:, session_id: hashed_session_id, trace_id:, visitor:)
     end
   end

data/app/models/trackguard/blocked_request.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trackguard
+  class BlockedRequest < Visit
+    REASON_SCANNER = "trackguard/block known scanners"
+    REASON_FLAGGED = "trackguard/flagged visitors"
+
+    validates :path, :block_reason, presence: true
+
+    scope :scanners, -> { where(block_reason: REASON_SCANNER) }
+    scope :flagged,  -> { where(block_reason: REASON_FLAGGED) }
+  end
+end

data/app/models/trackguard/page_view.rb

@@ -1,16 +1,9 @@
 module Trackguard
-  class PageView < ApplicationRecord
-    self.table_name = "trackguard_page_views"
-
-    belongs_to :visitor, class_name: "Trackguard::Visitor"
-
+  class PageView < Visit
     validates :path, presence: true
 
-    scope :today,         -> { where(created_at: Time.current.beginning_of_day..) }
     scope :this_week,     -> { where(created_at: 1.week.ago..) }
     scope :this_month,    -> { where(created_at: 1.month.ago..) }
-    scope :last_30,       -> { where(created_at: 30.days.ago..) }
-    scope :last_24h,      -> { where(created_at: 24.hours.ago..) }
     scope :with_referrer, -> { where.not(referer: [ nil, "" ]) }
     scope :with_source,   -> { where.not(source: [ nil, "" ]) }
   end

data/app/models/trackguard/visit.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Trackguard
+  class Visit < ApplicationRecord
+    self.table_name = "trackguard_visits"
+
+    belongs_to :visitor, class_name: "Trackguard::Visitor"
+
+    scope :today,    -> { where(created_at: Time.current.beginning_of_day..) }
+    scope :last_24h, -> { where(created_at: 24.hours.ago..) }
+    scope :last_30,  -> { where(created_at: 30.days.ago..) }
+  end
+end

data/app/models/trackguard/visitor.rb

@@ -7,8 +7,9 @@ module Trackguard
 
     validates :flagged_by, inclusion: { in: FLAGGED_BY }, allow_blank: true
 
-    has_many :page_views, class_name: "Trackguard::PageView", foreign_key: "visitor_id"
-    has_one  :whitelisted_ip, class_name: "Trackguard::WhitelistedIp", foreign_key: "visitor_id"
+    has_many :page_views,       class_name: "Trackguard::PageView", foreign_key: "visitor_id"
+    has_many :blocked_requests, class_name: "Trackguard::BlockedRequest",  foreign_key: "visitor_id"
+    has_one  :whitelisted_ip,   class_name: "Trackguard::WhitelistedIp",   foreign_key: "visitor_id"
 
     scope :unflagged, -> { where(flagged_at: nil) }
     scope :flagged,   -> { where.not(flagged_at: nil) }

data/app/services/trackguard/page_view_recorder.rb

@@ -8,15 +8,17 @@ module Trackguard
       bot|crawl|spider
     /ix
 
-    def initialize(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source: nil, initial: false)
-      @path       = path.to_s
-      @ip         = ip
-      @user_agent = user_agent.to_s
-      @referer    = referer
-      @session_id = session_id
-      @trace_id   = trace_id
-      @source     = source.presence
-      @initial    = initial
+    def initialize(path:, ip:, user_agent:, referer:, session_id:, trace_id:, source: nil, initial: false,
+                   http_method: nil)
+      @path        = path.to_s
+      @ip          = ip
+      @user_agent  = user_agent.to_s
+      @referer     = referer
+      @session_id  = session_id
+      @trace_id    = trace_id
+      @source      = source.presence
+      @initial     = initial
+      @http_method = http_method
     end
 
     def call
@@ -32,7 +34,8 @@ module Trackguard
         session_id: @session_id,
         trace_id: @trace_id,
         source: @source,
-        initial: @initial
+        initial: @initial,
+        http_method: @http_method
       )
     end
   end

data/lib/generators/trackguard/templates/add_trackguard_visits.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class AddTrackguardVisits < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
+  def up
+    rename_table :trackguard_page_views, :trackguard_visits
+
+    add_column :trackguard_visits, :type,         :string
+    add_column :trackguard_visits, :block_reason, :string
+    add_column :trackguard_visits, :http_method,  :string
+
+    add_index :trackguard_visits, :type
+    add_index :trackguard_visits, :block_reason
+
+    execute "UPDATE trackguard_visits SET type = 'Trackguard::PageView'"
+  end
+
+  def down
+    remove_index :trackguard_visits, :block_reason
+    remove_index :trackguard_visits, :type
+
+    remove_column :trackguard_visits, :http_method
+    remove_column :trackguard_visits, :block_reason
+    remove_column :trackguard_visits, :type
+
+    rename_table :trackguard_visits, :trackguard_page_views
+  end
+end

data/lib/generators/trackguard/templates/create_trackguard_tables.rb

@@ -13,20 +13,25 @@ class CreateTrackguardTables < ActiveRecord::Migration[<%= ActiveRecord::Migrati
 
     add_index :trackguard_visitors, :ip, unique: true
 
-    create_table :trackguard_page_views do |t|
-      t.string    :path,       null: false
+    create_table :trackguard_visits do |t|
+      t.string    :type
+      t.string    :path,         null: false
       t.string    :user_agent
       t.string    :referer
       t.string    :session_id
       t.string    :trace_id
       t.string    :source
-      t.references :visitor,   null: false, foreign_key: { to_table: :trackguard_visitors }
-      t.datetime  :created_at, null: false
+      t.string    :block_reason
+      t.string    :http_method
+      t.references :visitor,     null: false, foreign_key: { to_table: :trackguard_visitors }
+      t.datetime  :created_at,   null: false
     end
 
-    add_index :trackguard_page_views, :path
-    add_index :trackguard_page_views, :created_at
-    add_index :trackguard_page_views, :source
+    add_index :trackguard_visits, :type
+    add_index :trackguard_visits, :path
+    add_index :trackguard_visits, :created_at
+    add_index :trackguard_visits, :source
+    add_index :trackguard_visits, :block_reason
 
     create_table :trackguard_whitelisted_ips do |t|
       t.string   :ip,         null: false

data/lib/generators/trackguard/upgrade_generator.rb

@@ -0,0 +1,23 @@
+require "rails/generators"
+require "rails/generators/active_record"
+
+module Trackguard
+  class UpgradeGenerator < Rails::Generators::Base
+    include Rails::Generators::Migration
+
+    source_root File.expand_path("templates", __dir__)
+
+    def self.next_migration_number(dirname)
+      ActiveRecord::Generators::Base.next_migration_number(dirname)
+    end
+
+    def create_visits_migration_file
+      migration_template "add_trackguard_visits.rb", "db/migrate/add_trackguard_visits.rb"
+    end
+
+    def print_next_steps
+      say "\nNext steps:", :green
+      say "  1. rails db:migrate"
+    end
+  end
+end

data/lib/trackguard/rack_attack.rb

@@ -26,6 +26,26 @@ module Trackguard
         limit: Trackguard.throttle_limit,
         period: Trackguard.throttle_period, &:ip
       )
+
+      subscribe_to_blocked_requests
+    end
+
+    def self.subscribe_to_blocked_requests
+      @subscribe_to_blocked_requests ||= ActiveSupport::Notifications.subscribe("rack.attack") do |*, payload|
+        req = payload[:request]
+        next unless req.env["rack.attack.match_type"] == :blocklist
+
+        Trackguard::TrackBlockedRequestJob.perform_later(
+          ip: req.ip,
+          user_agent: req.user_agent.to_s,
+          path: req.path,
+          http_method: req.request_method,
+          block_reason: req.env["rack.attack.matched"].to_s
+        )
+      rescue StandardError
+        # never let tracking errors surface into the middleware response
+      end
     end
+    private_class_method :subscribe_to_blocked_requests
   end
 end

data/lib/trackguard/version.rb

@@ -1,3 +1,3 @@
 module Trackguard
-  VERSION = "0.15.2".freeze
+  VERSION = "0.16.1".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trackguard
 version: !ruby/object:Gem::Version
-  version: 0.15.2
+  version: 0.16.1
 platform: ruby
 authors:
 - Krzysztof Rygielski
@@ -56,9 +56,12 @@ files:
 - app/controllers/trackguard/page_views_controller.rb
 - app/helpers/trackguard/application_helper.rb
 - app/jobs/trackguard/detect_suspicious_visitors_job.rb
+- app/jobs/trackguard/track_blocked_request_job.rb
 - app/jobs/trackguard/track_page_view_job.rb
+- app/models/trackguard/blocked_request.rb
 - app/models/trackguard/blocked_user_agent.rb
 - app/models/trackguard/page_view.rb
+- app/models/trackguard/visit.rb
 - app/models/trackguard/visitor.rb
 - app/models/trackguard/whitelisted_ip.rb
 - app/services/trackguard/application_service.rb
@@ -70,7 +73,9 @@ files:
 - config/importmap.rb
 - config/routes.rb
 - lib/generators/trackguard/install_generator.rb
+- lib/generators/trackguard/templates/add_trackguard_visits.rb
 - lib/generators/trackguard/templates/create_trackguard_tables.rb
+- lib/generators/trackguard/upgrade_generator.rb
 - lib/tasks/trackguard.rake
 - lib/trackguard.rb
 - lib/trackguard/engine.rb