wafris 2.1.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b9b1568fdef719383076bc488ff10f37d62b07aeaf143665e2e766e1d5d61b6
-  data.tar.gz: d96a46ce2ef95bbe3bfbd4d4d4b08d10a72f8270e1808f8e0f212692249a6634
+  metadata.gz: 0fad1d400c6106dc0f2f29b6b46a0ab919f4060ef45a4bde4dbb8607b95c1cae
+  data.tar.gz: b3b854a117e0a7021bf3194e339da5f0acdf320439f973226e850249bc445dcd
 SHA512:
-  metadata.gz: 3cf48c2b9aee1ac009b1e242490e6512e45e231d4a57d698cb89237a5c83f466cea1ef428feb4550dce39d786a102790257c861ddd4314e5f7865dad1967e32d
-  data.tar.gz: 29b8543c5dd1236471a60c29f45cd9ce71793db0ae77a349b6666c1862e4bcec90ee5e6ba211b87e719a74584fad142bead0afa04b6643f9999636e928aeb24e
+  metadata.gz: bd8e5e8109a7aa1b51c1361d7c288d11e2cca0ea4a5c0e66a198bbde30d9835b57ce2711f2869c575cc604577b4fe927836bfb0e47764f4e08a4c39c2a2e82db
+  data.tar.gz: fb171df540399f4a128e9bd28a1f80c3aa41e6a97e3cccc5eae0f2fa13b1de86be516d227bce3582fc9cefb35eb067e1b4ced665e79e5af89672187195eac109

data/lib/wafris/configuration.rb

@@ -1,98 +1,66 @@
+# frozen_string_literal: true
+
 require_relative "version"
 
 module Wafris
   class Configuration
-    attr_accessor :api_key
-    attr_accessor :db_file_path
-    attr_accessor :db_file_name
-    attr_accessor :downsync_custom_rules_interval
-    attr_accessor :downsync_data_subscriptions_interval
-    attr_accessor :downsync_url
-    attr_accessor :upsync_url
-    attr_accessor :upsync_interval
-    attr_accessor :upsync_queue_limit
-    attr_accessor :upsync_status
-    attr_accessor :upsync_queue
-    attr_accessor :local_only
-    attr_accessor :last_upsync_timestamp
-    attr_accessor :max_body_size_mb
-    attr_accessor :rate_limiters
+    attr_accessor :api_key,
+                  :db_file_path,
+                  :db_file_name,
+                  :downsync_custom_rules_interval,
+                  :downsync_data_subscriptions_interval,
+                  :downsync_url,
+                  :upsync_url,
+                  :upsync_interval,
+                  :upsync_queue_limit,
+                  :upsync_status,
+                  :upsync_queue,
+                  :local_only,
+                  :last_upsync_timestamp,
+                  :max_body_size_mb,
+                  :rate_limiters
 
     def initialize
-      # API Key - Required
-      if ENV["WAFRIS_API_KEY"]
-        @api_key = ENV["WAFRIS_API_KEY"]
-      else
-        unless @api_key
-          LogSuppressor.puts_log("Firewall disabled as neither local only or API key set")
-        end
-      end
-
-      # DB FILE PATH LOCATION - Optional
+      @api_key = ENV["WAFRIS_API_KEY"]
       @db_file_path = ENV["WAFRIS_DB_FILE_PATH"] || "./tmp/wafris"
-
-      # Ensure that the db_file_path exists
-      unless File.directory?(@db_file_path)
-        LogSuppressor.puts_log("DB File Path does not exist - creating it now.")
-        FileUtils.mkdir_p(@db_file_path) unless File.exist?(@db_file_path)
-      end
-
-      # DB FILE NAME - For local
       @db_file_name = ENV["WAFRIS_DB_FILE_NAME"] || "wafris.db"
-
-      # DOWNSYNC
-      # Custom Rules are checked often (default 1 minute) - Optional
       @downsync_custom_rules_interval = ENV["WAFRIS_DOWNSYNC_CUSTOM_RULES_INTERVAL"]&.to_i || 60
-
-      # Data Subscriptions are checked rarely (default 1 day) - Optional
       @downsync_data_subscriptions_interval = ENV["WAFRIS_DOWNSYNC_DATA_SUBSCRIPTIONS_INTERVAL"]&.to_i || 60
-
-      # Set Downsync URL - Optional
-      # Used for both DataSubscription and CustomRules
       @downsync_url = ENV["WAFRIS_DOWNSYNC_URL"] || "https://distributor.wafris.org/v2/downsync"
-
-      # UPSYNC - Optional
-      # Set Upsync URL
       @upsync_url = ENV["WAFRIS_UPSYNC_URL"] || "https://collector.wafris.org/v2/upsync"
-
-      # Set Upsync Interval - Optional
       @upsync_interval = ENV["WAFRIS_UPSYNC_INTERVAL"]&.to_i || 10
-
-      # Set Upsync Queued Request Limit - Optional
       @upsync_queue_limit = ENV["WAFRIS_UPSYNC_QUEUE_LIMIT"]&.to_i || 250
-
-      # Set Maximium Body Size for Requests - Optional (in Megabytes)
-      @max_body_size_mb = if ENV["WAFRIS_MAX_BODY_SIZE_MB"] && ENV["WAFRIS_MAX_BODY_SIZE_MB"].to_i > 0
-                            ENV["WAFRIS_MAX_BODY_SIZE_MB"].to_i
-                          else
-                            10
-                          end
-
-      # Upsync Queue Defaults
+      @max_body_size_mb = set_max_body_size
       @upsync_queue = []
       @last_upsync_timestamp = Time.now.to_i
-
-      # Memory structure for rate limiting
       @rate_limiters = {}
-
-      # Disable Upsync if Downsync API Key is invalid
-      # This prevents the client from sending upsync requests
-      # if the API key is known bad
       @upsync_status = "Disabled"
     end
 
-    def current_config
-      output = {}
-
-      instance_variables.each do |var|
-        output[var.to_s] = instance_variable_get(var)
+    def setup
+      if @api_key
+        create_db_file_path
+      else
+        LogSuppressor.puts_log("Firewall disabled as API key is not set.")
       end
+    end
 
-      output
+    private
+
+    def set_max_body_size
+      if ENV["WAFRIS_MAX_BODY_SIZE_MB"] && ENV["WAFRIS_MAX_BODY_SIZE_MB"].to_i > 0
+        ENV["WAFRIS_MAX_BODY_SIZE_MB"].to_i
+      else
+        10
+      end
     end
 
-    def create_settings
-      @version = Wafris::VERSION
+    def create_db_file_path
+      # Ensure that the db_file_path exists
+      unless File.directory?(@db_file_path)
+        LogSuppressor.puts_log("DB File Path does not exist - creating it now.")
+        FileUtils.mkdir_p(@db_file_path) unless File.exist?(@db_file_path)
+      end
     end
   end
 end

data/lib/wafris/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wafris
-  VERSION = "2.1.2"
+  VERSION = "2.3.0"
 end

data/lib/wafris.rb

@@ -34,12 +34,18 @@ module Wafris
 
     def configure
       self.configuration ||= Wafris::Configuration.new
-      yield(configuration)
+      if block_given?
+        yield(configuration)
+        LogSuppressor.puts_log("Configuration settings created with configure block.")
+      else
+        LogSuppressor.puts_log("Configuration settings created with defaults and ENV vars.")
+      end
 
-      LogSuppressor.puts_log("[Wafris] Configuration settings created.")
-      configuration.create_settings
+      configuration.setup
+
+      return configuration
     rescue => e
-      puts "[Wafris] firewall disabled due to: #{e.message}. Cannot connect via Wafris.configure. Please check your configuration settings. More info can be found at: https://github.com/Wafris/wafris-rb"
+      LogSuppressor.puts_log("Firewall disabled due to: #{e.message}. Please check your configuration settings.")
     end
 
     def zero_pad(number, length)
@@ -181,20 +187,25 @@ module Wafris
 
       url_and_api_key = @configuration.upsync_url + "/" + @configuration.api_key
 
+      LogSuppressor.puts_log("[Upsync] Beginning request thread...")
+      current_time = Time.now
       response = HTTParty.post(
         url_and_api_key,
         body: body,
         headers: headers,
-        timeout: 10
+        timeout: 5
       )
 
       if response.code == 200
         @configuration.upsync_status = "Complete"
       else
-        LogSuppressor.puts_log("Upsync Error. HTTP Response: #{response.code}")
+        LogSuppressor.puts_log("[Upsync] Error. HTTP Response: #{response.code}")
       end
     rescue HTTParty::Error => e
-      LogSuppressor.puts_log("Upsync Error. Failed to send upsync requests: #{e.message}")
+      LogSuppressor.puts_log("[Upsync] Thread Error. Failed to send upsync requests: #{e.message}")
+    ensure
+      elapsed_time = Time.now - current_time
+      LogSuppressor.puts_log("[Upsync] request thread complete in #{elapsed_time.round(2)} seconds.")
     end
 
     # This method is used to queue upsync requests. It takes in several parameters including:
@@ -220,7 +231,7 @@ module Wafris
           @configuration.upsync_queue = []
           @configuration.last_upsync_timestamp = Time.now.to_i
 
-          send_upsync_requests(requests_array)
+          Thread.new { send_upsync_requests(requests_array) }
         end
 
         @configuration.upsync_status = "Enabled"
@@ -249,10 +260,10 @@ module Wafris
       begin
         lockfile = File.open(lockfile_path, File::RDWR | File::CREAT | File::EXCL)
       rescue Errno::EEXIST
-        LogSuppressor.puts_log("[Wafris][Downsync] Lockfile already exists, skipping downsync.")
+        LogSuppressor.puts_log("[Downsync][downsync_db] Lockfile already exists, skipping downsync.")
         return
       rescue Exception => e
-        LogSuppressor.puts_log("[Wafris][Downsync] Error creating lockfile: #{e.message}")
+        LogSuppressor.puts_log("[Downsync] Error creating lockfile: #{e.message}")
       end
 
       begin
@@ -274,10 +285,14 @@ module Wafris
         # puts "Downloading from #{@configuration.downsync_url}/#{db_rule_category}/#{@configuration.api_key}?current_version=#{current_filename}&process_id=#{Process.pid}"
         uri = "#{@configuration.downsync_url}/#{db_rule_category}/#{@configuration.api_key}?#{data.to_query}"
 
+        LogSuppressor.puts_log("[Downsync] Beginning request thread for #{db_rule_category}...")
+        current_time = Time.now
+
         response = HTTParty.get(
           uri,
           follow_redirects: true,   # Enable following redirects
-          max_redirects: 2          # Maximum number of redirects to follow
+          max_redirects: 2,         # Maximum number of redirects to follow
+          timeout: 30
         )
 
         # TODO: What to do if timeout
@@ -285,13 +300,12 @@ module Wafris
 
         if response.code == 401
           @configuration.upsync_status = "Disabled"
-          LogSuppressor.puts_log("[Wafris][Downsync] Unauthorized: Bad or missing API key")
-          LogSuppressor.puts_log("[Wafris][Downsync] API Key: #{@configuration.api_key}")
+          LogSuppressor.puts_log("[Downsync] Unauthorized: Bad or missing API key")
+          LogSuppressor.puts_log("[Downsync] API Key: #{@configuration.api_key}")
           filename = current_filename
 
         elsif response.code == 304
           @configuration.upsync_status = "Enabled"
-          LogSuppressor.puts_log("[Wafris][Downsync] No new rules to download")
 
           filename = current_filename
 
@@ -326,12 +340,12 @@ module Wafris
           # DB file is bad or empty so keep using whatever we have now
           else
             filename = old_file_name
-            LogSuppressor.puts_log("[Wafris][Downsync] DB Error - No tables exist in the db file #{@configuration.db_file_path}/#{filename}")
+            LogSuppressor.puts_log("[Downsync] DB Error - No tables exist in the db file #{@configuration.db_file_path}/#{filename}")
           end
 
         end
       rescue => e
-        LogSuppressor.puts_log("[Wafris][Downsync] Error downloading rules: #{e.message}")
+        LogSuppressor.puts_log("[Downsync] Error downloading rules: #{e.message}")
 
       # This gets set even if the API key is bad or other issues
       # to prevent hammering the distribution server on every request
@@ -347,42 +361,47 @@ module Wafris
         # Ensure the lockfile is removed after operations
         lockfile.close
         File.delete(lockfile_path)
+
+        elapsed_time = Time.now - current_time
+        LogSuppressor.puts_log("[Downsync] request thread complete in #{elapsed_time.round(2)} seconds for #{db_rule_category}.")
       end
 
       filename
     end
 
+    def sync_interval(db_rule_category)
+      if db_rule_category == "custom_rules"
+        @configuration.downsync_custom_rules_interval
+      else
+        @configuration.downsync_data_subscriptions_interval
+      end
+    end
+
     # Returns the current database file,
     # if the file is older than the interval, it will download the latest db
     # if the file doesn't exist, it will download the latest db
     # if the lockfile exists, it will return the current db
     def current_db(db_rule_category)
-      interval = if db_rule_category == "custom_rules"
-                   @configuration.downsync_custom_rules_interval
-                 else
-                   @configuration.downsync_data_subscriptions_interval
-                 end
-
       # Checks for existing current modfile, which contains the current db filename
       if File.exist?("#{@configuration.db_file_path}/#{db_rule_category}.modfile")
 
-        LogSuppressor.puts_log("[Wafris][Downsync] Modfile exists, skipping downsync")
+        LogSuppressor.puts_log("[Downsync] Modfile exists, skipping downsync")
 
         # Get last Modified Time and current database file name
         last_db_synctime = File.mtime("#{@configuration.db_file_path}/#{db_rule_category}.modfile").to_i
         returned_db = File.read("#{@configuration.db_file_path}/#{db_rule_category}.modfile").strip
 
-        LogSuppressor.puts_log("[Wafris][Downsync] Modfile Last Modified Time: #{last_db_synctime}")
-        LogSuppressor.puts_log("[Wafris][Downsync] DB in Modfile: #{returned_db}")
+        LogSuppressor.puts_log("[Downsync] Modfile Last Modified Time: #{last_db_synctime}")
+        LogSuppressor.puts_log("[Downsync] DB in Modfile: #{returned_db}")
 
         # Check if the db file is older than the interval
-        if (Time.now.to_i - last_db_synctime) > interval
+        if (Time.now.to_i - last_db_synctime) > sync_interval(db_rule_category)
 
-          LogSuppressor.puts_log("[Wafris][Downsync] DB is older than the interval")
+          LogSuppressor.puts_log("[Downsync] DB is older than the interval")
 
           # Make sure that another process isn't already downloading the rules
           if !File.exist?("#{@configuration.db_file_path}/#{db_rule_category}.lockfile")
-            returned_db = downsync_db(db_rule_category, returned_db)
+            Thread.new { downsync_db(db_rule_category, returned_db) }
           end
 
           returned_db
@@ -390,7 +409,7 @@ module Wafris
         # Current db is up to date
         else
 
-          LogSuppressor.puts_log("[Wafris][Downsync] DB is up to date")
+          LogSuppressor.puts_log("[Downsync] DB is up to date")
 
           returned_db = File.read("#{@configuration.db_file_path}/#{db_rule_category}.modfile").strip
 
@@ -407,24 +426,18 @@ module Wafris
       # No modfile exists, so download the latest db
       else
 
-        LogSuppressor.puts_log("[Wafris][Downsync] No modfile exists, downloading latest db")
+        LogSuppressor.puts_log("[Downsync] No modfile exists, downloading latest #{db_rule_category} db")
 
         # Make sure that another process isn't already downloading the rules
         if File.exist?("#{@configuration.db_file_path}/#{db_rule_category}.lockfile")
-          LogSuppressor.puts_log("[Wafris][Downsync] Lockfile exists, skipping downsync")
+          LogSuppressor.puts_log("[Downsync][current_db] Lockfile exists, skipping downsync")
           # Lockfile exists, but no modfile with a db filename
           nil
         else
-
-          LogSuppressor.puts_log("[Wafris][Downsync] No modfile exists, downloading latest db")
           # No modfile exists, so download the latest db
-          returned_db = downsync_db(db_rule_category, nil)
+          Thread.new { downsync_db(db_rule_category, nil) }
 
-          if returned_db.nil?
-            nil
-          else
-            returned_db
-          end
+          nil
         end
       end
     end
@@ -432,15 +445,18 @@ module Wafris
     # This is the main loop that evaluates the request
     # as well as sorts out when downsync and upsync should be called
     def evaluate(request)
-      @configuration ||= Wafris::Configuration.new
+      if @configuration.nil?
+        configure
+      end
 
       return "Passed" if @configuration.api_key.nil?
 
+      # Now current_db can return the actual db, nil, or a future object
       rules_db_filename = current_db("custom_rules")
       data_subscriptions_db_filename = current_db("data_subscriptions")
 
       # Checks to see if the filenames are present before loading the db
-      if rules_db_filename.to_s.strip != "" && data_subscriptions_db_filename.strip.to_s.strip != ""
+      if rules_db_filename.to_s.strip != "" && data_subscriptions_db_filename.to_s.strip != ""
 
         rules_db = SQLite3::Database.new "#{@configuration.db_file_path}/#{rules_db_filename}"
         data_subscriptions_db =

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wafris
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Michael Buckbee
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-19 00:00:00.000000000 Z
+date: 2024-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack