Implemented custom host script (WIP)

scripts/lua/modules/alert_definitions/flow/alert_custom_lua_script.lua

@@ -40,7 +40,7 @@ end
 -- @param alert_type_params Table `alert_type_params` as built in the `:init` method
 -- @return A human-readable string
 function alert_custom_lua_script.format(ifid, alert, alert_type_params)
-   return i18n("flow_details.custom_lua_script", { message = alert_type_params["alert.message"], value = alert_type_params["alert.value"] } )
+   return i18n("flow_details.custom_lua_script", { message = alert_type_params["alert.message"] } )
 end
 
 -- #######################################################

scripts/lua/modules/alert_definitions/host/host_alert_custom_lua_script.lua

@@ -0,0 +1,79 @@
+--
+-- (C) 2019-22 - ntop.org
+--
+
+-- ##############################################
+
+local host_alert_keys = require "host_alert_keys"
+
+local json = require("dkjson")
+local alert_creators = require "alert_creators"
+
+-- Import the classes library.
+local classes = require "classes"
+-- Make sure to import the Superclass!
+local alert = require "alert"
+
+-- ##############################################
+
+local host_alert_custom_lua_script = classes.class(alert)
+
+-- ##############################################
+
+host_alert_custom_lua_script.meta = {
+  alert_key = host_alert_keys.host_alert_custom_lua_script,
+  i18n_title = "alerts_dashboard.custom_lua_script",
+  icon = "fas fa-fw fa-life-ring",
+  has_attacker = true,
+}
+
+-- ##############################################
+
+-- @brief Prepare an alert table used to generate the alert
+-- @param one_param The first alert param
+-- @param another_param The second alert param
+-- @return A table with the alert built
+function host_alert_custom_lua_script:init(metric, value, operator, threshold)
+   -- Call the parent constructor
+   self.super:init()
+
+   self.alert_type_params = alert_creators.createThresholdCross(metric, value, operator, threshold)
+end
+
+-- #######################################################
+
+-- @brief Format an alert into a human-readable string
+-- @param ifid The integer interface id of the generated alert
+-- @param alert The alert description table, including alert data such as the generating entity, timestamp, granularity, type
+-- @param alert_type_params Table `alert_type_params` as built in the `:init` method
+-- @return A human-readable string
+function host_alert_custom_lua_script.format(ifid, alert, alert_type_params)
+  local alert_consts = require "alert_consts"
+
+  return i18n("alert_messages.custom_lua_script", { message = alert_type_params["message"] } )
+end
+
+-- #######################################################
+
+-- @brief Prepare a table containing a set of filters useful to query historical flows that contributed to the generation of this alert
+-- @param ifid The integer interface id of the generated alert
+-- @param alert The alert description table, including alert data such as the generating entity, timestamp, granularity, type
+-- @param alert_type_params Table `alert_type_params` as built in the `:init` method
+-- @return A human-readable string
+function host_alert_custom_lua_script.filter_to_past_flows(ifid, alert, alert_type_params)
+   local res = {}
+   local host_key = hostinfo2hostkey({ip = alert["ip"], vlan = alert["vlan_id"]})
+
+   -- Filter by client or server, depending on whether this alert is as-client or as-server
+   if alert["is_client"] == true or alert["is_client"] == "1" then
+      res["cli_ip"] = host_key
+   elseif alert["is_server"] == true or alert["is_server"] == "1" then
+      res["srv_ip"] = host_key
+   end
+
+   return res
+end
+
+-- #######################################################
+
+return host_alert_custom_lua_script

scripts/lua/modules/alert_keys/host_alert_keys.lua

@@ -30,7 +30,8 @@ local host_alert_keys = {
   host_alert_fin_scan                    = 21,
   host_alert_dns_flood                   = 22,
   host_alert_snmp_flood                  = 23,
-
+  host_alert_custom_lua_script           = 24,
+  
   -- NOTE: Keep in sync with HostAlertTypeEnum in ntop_typedefs.h
 }
 

scripts/lua/modules/check_definitions/host/custom_host_lua_script.lua

@@ -0,0 +1,30 @@
+--
+-- (C) 2019-22 - ntop.org
+--
+
+local checks = require("checks")
+local host_alert_keys = require "host_alert_keys"
+local alert_consts = require("alert_consts")
+
+-- #################################################################
+
+local p2p = {
+  -- Script category
+  category = checks.check_categories.network,
+  severity = alert_consts.get_printable_severities().error,
+
+  default_enabled = false,
+  alert_id = host_alert_keys.host_alert_custom_lua_script,
+
+  default_value = {
+  },
+
+  gui = {
+     i18n_title = "alerts_thresholds_config.custom_host_lua_script_title",
+     i18n_description = "alerts_thresholds_config.custom_host_lua_script_description",
+  },
+}
+
+-- #################################################################
+
+return p2p