wafris 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '090c73e4e16d97aa2076a9bed6a68cc4353d0f490f2954d7263bf919dd5cefee'
-  data.tar.gz: 3365dab3150d151be29735b95862adc7cda7e91142ddc05fa84d91bb9d7b59a4
+  metadata.gz: 722b44b21ce69ec8d515c442b3ee5fd783298de0714105eb9cd9585f3f007af9
+  data.tar.gz: d93da5905d328163e235e193998e63033a2be5b1e509a4b62ecbe804b0023289
 SHA512:
-  metadata.gz: f45d69161062ff57688c30e300bceae2425e80e7e954458317c248580ad64f7d580f2c25f36428e5123468b26d74b37ee8643ce250c4f5902da33a0d9c56d370
-  data.tar.gz: 3c9480600f9f51624db89f2ceb34483df8ab3f79d6e0153f810bb88343c39d93bcb72dd8f73c149539910382abe4a5eb029c2446f56f5f66e936d43f270f8aa2
+  metadata.gz: 9945fef04660a4e6aeaf6aac33669bcfc210c1386ba684e7a147602f76542c0764c98dd9072fe35faace14bbaaf5d0be492e21c754da9b2607dae204ee350b1b
+  data.tar.gz: d219c32ddb8f9375bb1b006d3b0b3d49c5fe47ca4632e5bb8b8bd93a398c05d2dd183d5ad5a79510d4de89bf6f677d0c84ed038ea40fd0a7b4319bc6aff28d03

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.1"
+  VERSION = "2.2.0"
 end

data/lib/wafris/wafris_request.rb

@@ -3,7 +3,7 @@
 module Wafris
   class WafrisRequest
     attr_reader :ip, :user_agent, :path, :parameters, :host, :method,
-                :headers, :body, :request_id, :request_timestamp
+                :headers, :request_id, :request_timestamp
 
     def initialize(request, env)
       @ip = encode_to_utf8(IpResolver.new(request).resolve)
@@ -15,10 +15,6 @@ module Wafris
       @headers = extract_headers(env)
       @request_id = env.fetch("action_dispatch.request_id", SecureRandom.uuid.to_s)
       @request_timestamp = Time.now.utc.to_i
-
-      pos = request.body&.pos
-      @body = encode_to_utf8(request.body&.read)
-      request.body&.rewind if request.body&.pos != pos
     end
 
     def data(treatment:, category:, rule:)

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)
@@ -432,7 +438,9 @@ 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?
 

metadata

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