From: Vsevolod Stakhov <vsevolod@rspamd.com>
Date: Fri, 14 Nov 2025 13:56:39 +0000 (+0000)
Subject: [Refactor] Simplify configuration by removing use_*_map flags
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=a5398bfe7a84a2eaac5e0ef88f67e1f7d6b75957;p=thirdparty%2Frspamd.git

[Refactor] Simplify configuration by removing use_*_map flags

- Removed all use_pattern_map, use_range_map, use_tld_map, etc. flags
- Maps are now implicitly enabled if configured (not nil)
- Cleaner configuration: just uncomment the map parameter to enable
- Updated init_maps() to check map existence instead of enable flags
- Updated check functions to use maps if configured
- Simpler, more intuitive configuration approach
---

diff --git a/conf/modules.d/url_suspect.conf b/conf/modules.d/url_suspect.conf
index fd198e03a2..467612eb21 100644
--- a/conf/modules.d/url_suspect.conf
+++ b/conf/modules.d/url_suspect.conf
@@ -22,13 +22,12 @@ url_suspect {
         very_long = 256;     # Even higher if > 256
       }
 
-      # OPTIONAL: Advanced pattern matching (disabled by default)
-      # Enable only if you need custom user field patterns
-      use_pattern_map = false;
+      # OPTIONAL: Advanced pattern matching
+      # Uncomment to enable custom user field patterns
       # pattern_map = "$LOCAL_CONFDIR/local.d/url_suspect_user_patterns.map";
 
-      # OPTIONAL: User blacklist (disabled by default)
-      use_blacklist = false;
+      # OPTIONAL: User blacklist
+      # Uncomment to enable user field blacklist
       # blacklist_map = "$LOCAL_CONFDIR/local.d/url_suspect_user_blacklist.map";
     }
 
@@ -44,8 +43,8 @@ url_suspect {
       allow_private_ranges = true;
       private_score = 0.5;       # Lower score for private IPs
 
-      # OPTIONAL: Suspicious IP ranges map (disabled by default)
-      use_range_map = false;
+      # OPTIONAL: Suspicious IP ranges map
+      # Uncomment to enable custom IP range checking
       # range_map = "$LOCAL_CONFDIR/local.d/url_suspect_ip_ranges.map";
     }
 
@@ -60,9 +59,8 @@ url_suspect {
       # Missing TLD score
       missing_tld_score = 2.0;
 
-      # OPTIONAL: Custom TLD map (disabled by default)
-      # Add this if you have additional TLDs to check
-      use_tld_map = false;
+      # OPTIONAL: Custom TLD map
+      # Uncomment to add additional TLDs to check
       # tld_map = "$LOCAL_CONFDIR/local.d/url_suspect_tlds.map";
     }
 
@@ -96,8 +94,8 @@ url_suspect {
       check_length = true;
       max_url_length = 2048;
 
-      # OPTIONAL: Suspicious ports map (disabled by default)
-      use_port_map = false;
+      # OPTIONAL: Suspicious ports map
+      # Uncomment to check for unusual ports
       # port_map = "$LOCAL_CONFDIR/local.d/url_suspect_ports.map";
     }
   }
@@ -131,9 +129,8 @@ url_suspect {
     very_long = "URL_VERY_LONG";
   }
 
-  # ADVANCED: Global whitelist (disabled by default)
-  # Use only if you need to skip checks for specific domains
-  use_whitelist = false;
+  # ADVANCED: Global whitelist
+  # Uncomment to skip checks for specific domains
   # whitelist_map = "$LOCAL_CONFDIR/local.d/url_suspect_whitelist.map";
 
   # ADVANCED: Custom checks (disabled by default)
diff --git a/src/plugins/lua/url_suspect.lua b/src/plugins/lua/url_suspect.lua
index 0b5c82b971..95bcda3594 100644
--- a/src/plugins/lua/url_suspect.lua
+++ b/src/plugins/lua/url_suspect.lua
@@ -44,23 +44,20 @@ local settings = {
         long = 128,
         very_long = 256
       },
-      use_pattern_map = false,
-      use_blacklist = false
+
     },
     numeric_ip = {
       enabled = true,
       base_score = 1.5,
       with_user_score = 4.0,
       allow_private_ranges = true,
-      private_score = 0.5,
-      use_range_map = false
+      private_score = 0.5
     },
     tld = {
       enabled = true,
       builtin_suspicious = { ".tk", ".ml", ".ga", ".cf", ".gq" },
       builtin_score = 3.0,
-      missing_tld_score = 2.0,
-      use_tld_map = false
+      missing_tld_score = 2.0
     },
     unicode = {
       enabled = true,
@@ -77,8 +74,7 @@ local settings = {
       check_excessive_dots = true,
       max_host_dots = 6,
       check_length = true,
-      max_url_length = 2048,
-      use_port_map = false
+      max_url_length = 2048
     }
   },
   symbols = {
@@ -171,8 +167,8 @@ function checks.user_password_analysis(task, url, cfg)
     })
   end
 
-  -- Optional: check pattern map if enabled
-  if cfg.use_pattern_map and maps.user_patterns then
+  -- Optional: check pattern map if configured
+  if maps.user_patterns then
     local match = maps.user_patterns:get_key(user)
     if match then
       lua_util.debugm(N, task, "User field matches suspicious pattern")
@@ -180,8 +176,8 @@ function checks.user_password_analysis(task, url, cfg)
     end
   end
 
-  -- Optional: check blacklist if enabled
-  if cfg.use_blacklist and maps.user_blacklist then
+  -- Optional: check blacklist if configured
+  if maps.user_blacklist then
     if maps.user_blacklist:get_key(user) then
       lua_util.debugm(N, task, "User field is blacklisted")
       -- Could add additional symbol or increase score
@@ -238,8 +234,8 @@ function checks.numeric_ip_analysis(task, url, cfg)
     end
   end
 
-  -- Optional: check IP range map if enabled
-  if cfg.use_range_map and maps.suspicious_ips then
+  -- Optional: check IP range map if configured
+  if maps.suspicious_ips then
     if maps.suspicious_ips:get_key(host) then
       lua_util.debugm(N, task, "IP is in suspicious range")
       -- Could add additional penalty
@@ -292,8 +288,8 @@ function checks.tld_analysis(task, url, cfg)
     end
   end
 
-  -- Optional: check TLD map if enabled
-  if cfg.use_tld_map and maps.suspicious_tlds then
+  -- Optional: check TLD map if configured
+  if maps.suspicious_tlds then
     if maps.suspicious_tlds:get_key(tld) then
       lua_util.debugm(N, task, "URL TLD in suspicious map: %s", tld)
       -- Already handled by built-in check, or could add extra penalty
@@ -521,40 +517,37 @@ local function url_suspect_callback(task)
   return false
 end
 
--- Initialize maps (only if enabled)
+-- Initialize maps (only if configured)
 local function init_maps(cfg)
-  if cfg.use_whitelist and cfg.whitelist_map then
-    local lua_maps = require "lua_maps"
+  local lua_maps = require "lua_maps"
+
+  -- Load maps if they are configured (not nil)
+  if cfg.whitelist_map then
     maps.whitelist = lua_maps.map_add_from_ucl(
         cfg.whitelist_map, 'set', 'url_suspect_whitelist')
   end
 
-  if cfg.checks.user_password.use_pattern_map and cfg.checks.user_password.pattern_map then
-    local lua_maps = require "lua_maps"
+  if cfg.checks.user_password.pattern_map then
     maps.user_patterns = lua_maps.map_add_from_ucl(
         cfg.checks.user_password.pattern_map, 'regexp', 'url_suspect_user_patterns')
   end
 
-  if cfg.checks.user_password.use_blacklist and cfg.checks.user_password.blacklist_map then
-    local lua_maps = require "lua_maps"
+  if cfg.checks.user_password.blacklist_map then
     maps.user_blacklist = lua_maps.map_add_from_ucl(
         cfg.checks.user_password.blacklist_map, 'set', 'url_suspect_user_blacklist')
   end
 
-  if cfg.checks.numeric_ip.use_range_map and cfg.checks.numeric_ip.range_map then
-    local lua_maps = require "lua_maps"
+  if cfg.checks.numeric_ip.range_map then
     maps.suspicious_ips = lua_maps.map_add_from_ucl(
         cfg.checks.numeric_ip.range_map, 'radix', 'url_suspect_ip_ranges')
   end
 
-  if cfg.checks.tld.use_tld_map and cfg.checks.tld.tld_map then
-    local lua_maps = require "lua_maps"
+  if cfg.checks.tld.tld_map then
     maps.suspicious_tlds = lua_maps.map_add_from_ucl(
         cfg.checks.tld.tld_map, 'set', 'url_suspect_tlds')
   end
 
-  if cfg.checks.structure.use_port_map and cfg.checks.structure.port_map then
-    local lua_maps = require "lua_maps"
+  if cfg.checks.structure.port_map then
     maps.suspicious_ports = lua_maps.map_add_from_ucl(
         cfg.checks.structure.port_map, 'set', 'url_suspect_ports')
   end