-- -- (C) 2014-16 - ntop.org -- -- This file contains the description of all functions -- used to trigger host alerts local verbose = false if ntop.isEnterprise() then local dirs = ntop.getDirs() package.path = dirs.installdir .. "/pro/scripts/lua/enterprise/modules/?.lua;" .. package.path require "enterprise_alert_utils" end j = require("dkjson") require "persistence" function is_allowed_timespan(timespan) for _, granularity in pairs(alerts_granularity) do granularity = granularity[1] if timespan == granularity then return true end end return false end function is_allowed_alarmable_metric(metric) for _, allowed_metric in pairs(alarmable_metrics) do if metric == allowed_metric then return true end end return false end function get_alerts_hash_name(timespan, ifname) local ifid = getInterfaceId(ifname) if not is_allowed_timespan(timespan) or tonumber(ifid) == nil then return nil end return "ntopng.prefs.alerts_"..timespan..".ifid_"..tostring(ifid) end function get_re_arm_alerts_hash_name(timespan) if not is_allowed_timespan(timespan) then return nil end return "ntopng.prefs.alerts_"..timespan.."_re_arm_minutes" end function get_re_arm_alerts_temporary_key(timespan, ifname, alarmed_source, alarmed_metric) local ifid = getInterfaceId(ifname) if not is_allowed_timespan(timespan) or tonumber(ifid) == nil or not is_allowed_alarmable_metric(alarmed_metric) then return nil end local alarm_string = alarmed_source.."_"..timespan.."_"..alarmed_metric return "ntopng.alerts.ifid_"..tostring(ifid).."_re_arming_"..alarm_string end function ndpival_bytes(json, protoname) key = "ndpiStats" -- Host if((json[key] == nil) or (json[key][protoname] == nil)) then if(verbose) then print("## ("..protoname..") Empty
\n") end return(0) else local v = json[key][protoname]["bytes"]["sent"]+json[key][protoname]["bytes"]["rcvd"] if(verbose) then print("## ("..protoname..") "..v.."
\n") end return(v) end end function proto_bytes(old, new, protoname) return(ndpival_bytes(new, protoname)-ndpival_bytes(old, protoname)) end -- ===================================================== function bytes(old, new) if(new["sent"] ~= nil) then -- Host return((new["sent"]["bytes"]+new["rcvd"]["bytes"])-(old["sent"]["bytes"]+old["rcvd"]["bytes"])) else -- Interface return(new.stats.bytes - old.stats.bytes) end end function packets(old, new) if(new["sent"] ~= nil) then -- Host return((new["sent"]["packets"]+new["rcvd"]["packets"])-(old["sent"]["packets"]+old["rcvd"]["packets"])) else -- Interface return(new.stats.packets - old.stats.packets) end end function idle(old, new) local diff = os.time()-new["seen.last"] return(diff) end function dns(old, new) return(proto_bytes(old, new, "DNS")) end function p2p(old, new) return(proto_bytes(old, new, "eDonkey")+proto_bytes(old, new, "BitTorrent")+proto_bytes(old, new, "Skype")) end function get_alerts_suppressed_hash_name(ifname) local hash_name = "ntopng.prefs.alerts.ifid_"..tostring(getInterfaceId(ifname)) return hash_name end function are_alerts_suppressed(observed, ifname) local suppressAlerts = ntop.getHashCache(get_alerts_suppressed_hash_name(ifname), observed) --[[ tprint("are_alerts_suppressed ".. suppressAlerts) tprint("are_alerts_suppressed observed: ".. observed) tprint("are_alerts_suppressed ifname: "..ifname) --]] if((suppressAlerts == "") or (suppressAlerts == nil) or (suppressAlerts == "true")) then return false -- alerts are not suppressed else if(verbose) then print("Skipping alert check for("..address.."): disabled in preferences
\n") end return true -- alerts are suppressed end end alerts_granularity = { { "min", "Every Minute" }, { "5mins", "Every 5 Minutes" }, { "hour", "Hourly" }, { "day", "Daily" } } alarmable_metrics = {'bytes', 'packets', 'dns', 'p2p', 'idle', 'ingress', 'egress', 'inner'} default_re_arm_minutes = { ["min"] = 1 , ["5mins"]= 5 , ["hour"] = 60 , ["day"] = 3600 } alert_functions_description = { ["bytes"] = "Bytes delta (sent + received)", ["packets"] = "Packets delta (sent + received)", ["dns"] = "DNS traffic delta bytes (sent + received)", ["p2p"] = "Peer-to-peer traffic delta bytes (sent + received)", ["idle"] = "Idle time since last packet sent (seconds)", } network_alert_functions_description = { ["ingress"] = "Ingress Bytes delta", ["egress"] = "Egress Bytes delta", ["inner"] = "Inner Bytes delta", } function re_arm_alert(alarm_source, timespan, alarmed_metric, ifname) local ifid = getInterfaceId(ifname) local re_arm_key = get_re_arm_alerts_temporary_key(timespan, ifname, alarm_source, alarmed_metric) local re_arm_minutes = ntop.getHashCache(get_re_arm_alerts_hash_name(timespan), "ifid_"..tostring(ifid).."_"..alarm_source) if re_arm_minutes ~= "" then re_arm_minutes = tonumber(re_arm_minutes) else re_arm_minutes = default_re_arm_minutes[timespan] end if verbose then io.write('re_arm_minutes: '..re_arm_minutes..'\n') end -- we don't care about key contents, we just care about its exsistance if re_arm_minutes == 0 then return -- don't want to re arm the alert end ntop.setCache(re_arm_key, "dummy", re_arm_minutes * 60 - 5 --[[ subtract 5 seconds to make sure the limit is obeyed --]]) end function is_alert_re_arming(alarm_source, timespan, alarmed_metric, ifname) local re_arm_key = get_re_arm_alerts_temporary_key(timespan, ifname, alarm_source, alarmed_metric) local is_rearming = ntop.getCache(re_arm_key) if is_rearming ~= "" then if verbose then io.write('re_arm_key: '..re_arm_key..' -> ' ..is_rearming..'-- \n') end return true end return false end -- ################################################################# function delete_re_arming_alerts(alert_source, ifid) for k1, timespan in pairs(alerts_granularity) do timespan = timespan[1] local alarm_string = alert_source.."_"..timespan for k2, alarmed_metric in pairs(alarmable_metrics) do local alarm_string_2 = alarm_string.."_"..alarmed_metric local re_arm_key = "ntopng.alerts.ifid_"..tostring(ifid).."_re_arming_"..alarm_string_2 ntop.delCache(re_arm_key) end end end function delete_alert_configuration(alert_source, ifname) local ifid = getInterfaceId(ifname) local alert_level = 1 -- alert_level_warning local alert_type = 2 -- alert_threshold_exceeded delete_re_arming_alerts(alert_source, ifid) for k1,timespan in pairs(alerts_granularity) do timespan = timespan[1] local key = get_alerts_hash_name(timespan, ifname) local alarms = ntop.getHashCache(key, alert_source) if alarms ~= "" then for k1, metric in pairs(alarmable_metrics) do if ntop.isPro() then ntop.withdrawNagiosAlert(alert_source, timespan, metric, "OK, alarm deactivated") end -- check if we are processing a pair ip-vlan such as 192.168.1.0@0 if string.match(alert_source, "@") then interface.releaseHostAlert(alert_source, timespan.."_"..metric, alert_type, alert_level, "Alarm released.") -- check if this is a subnet elseif string.match(alert_source, "/") then interface.releaseNetworkAlert(alert_source, timespan.."_"..metric, alert_type, alert_level, "Alarm released.") -- finally assume it's an interface alert else interface.releaseInterfaceAlert(timespan.."_"..metric, alert_type, alert_level, "Alarm released.") end end ntop.delHashCache(key, alert_source) end ntop.delHashCache(get_re_arm_alerts_hash_name(timespan), "ifid_"..tostring(ifid).."_"..alert_source) end end function refresh_alert_configuration(alert_source, ifname, timespan, alerts_string) if tostring(alerts_string) == nil then return nil end if is_allowed_timespan(timespan) == false then return nil end local ifid = getInterfaceId(ifname) local alert_level = 1 -- alert_level_warning local alert_type = 2 -- alert_threshold_exceeded -- check if we are processing a pair ip-vlan such as 192.168.1.0@0 local new_alert_ids = {} -- alerts_string is a string such as dns;gt;23,bytes;gt;1,p2p;gt;3 -- that string comes directly from the web interface and is a comma-separated -- list of threshold alerts configured. -- since formerly configured alerts may have been deleted, we need to check -- the ongoing_alerts against alerts_string and move to the closed list -- any ongoing alert that is no longer part of the alerts_string local tokens = split(alerts_string, ",") if tokens == nil then tokens = {} end for _, s in pairs(tokens) do if tostring(s) == nil then goto continue end local metric = string.split(s, ";")--[1] if metric == nil or metric[1] == nil then goto continue end metric = metric[1] if is_allowed_alarmable_metric(metric) == true then new_alert_ids[timespan.."_"..metric] = true end ::continue:: end -- check if there are some ongoing alerts that no longer exist in new_alerts -- we want to close those alerts for k1, timespan in pairs(alerts_granularity) do timespan = timespan[1] for k2, metric in pairs(alarmable_metrics) do if new_alert_ids[timespan.."_"..metric] ~= true then if string.match(alert_source, "@") then interface.releaseHostAlert(alert_source, timespan.."_"..metric, alert_type, alert_level, "released.") elseif string.match(alert_source, "/") then interface.releaseNetworkAlert(alert_source, timespan.."_"..metric, alert_type, alert_level, "released.") else interface.releaseInterfaceAlert(timespan.."_"..metric, alert_type, alert_level, "Alarm released.") end end end end end function check_host_alert(ifname, hostname, mode, key, old_json, new_json) if(verbose) then print("check_host_alert("..ifname..", "..hostname..", "..mode..", "..key..")
\n") print("

--------------------------------------------

\n") print("NEW
"..new_json.."
\n") print("

--------------------------------------------

\n") print("OLD
"..old_json.."
\n") print("

--------------------------------------------

\n") end local alert_level = 1 -- alert_level_warning local alert_type = 2 -- alert_threshold_exceeded local alert_status -- to be set later old = j.decode(old_json, 1, nil) new = j.decode(new_json, 1, nil) -- str = "bytes;>;123,packets;>;12" hkey = get_alerts_hash_name(mode, ifname) str = ntop.getHashCache(hkey, hostname) -- if(verbose) then ("--"..hkey.."="..str.."--
") end if((str ~= nil) and (str ~= "")) then tokens = split(str, ",") for _,s in pairs(tokens) do -- if(verbose) then (""..s.."
\n") end t = string.split(s, ";") if(t[2] == "gt") then op = ">" else if(t[2] == "lt") then op = "<" else op = "==" end end local what = "val = "..t[1].."(old, new); if(val ".. op .. " " .. t[3] .. ") then return(true) else return(false) end" local f = loadstring(what) local rc = f() local alert_id = mode.."_"..t[1] -- the alert identifies is the concat. of time granularity and condition, e.g., min_bytes if(rc) then alert_status = 1 -- alert on local alert_msg = "Threshold "..t[1].." crossed by host "..key.." [".. val .." ".. op .. " " .. t[3].."]" -- only if the alert is not in its re-arming period... if not is_alert_re_arming(key, mode, t[1], ifname) then if verbose then io.write("queuing alert\n") end -- re-arm the alert re_arm_alert(key, mode, t[1], ifname) -- and send it to ntopng interface.engageHostAlert(key, alert_id, alert_type, alert_level, alert_msg) if ntop.isPro() then -- possibly send the alert to nagios as well ntop.sendNagiosAlert(string.gsub(key, "@0", "") --[[ vlan 0 is implicit for hosts --]], mode, t[1], alert_msg) end else if verbose then io.write("alarm silenced, re-arm in progress\n") end end if(verbose) then print("".. alert_msg .."
\n") end else -- alert has not been triggered alert_status = 2 -- alert off if(verbose) then print("

Threshold "..t[1].."@"..key.." not crossed [value="..val.."]["..op.." "..t[3].."]

\n") end if not is_alert_re_arming(key, mode, t[1], ifname) then interface.releaseHostAlert(key, alert_id, alert_type, alert_level, "released!") if ntop.isPro() then ntop.withdrawNagiosAlert(string.gsub(key, "@0", "") --[[ vlan 0 is implicit for hosts --]], mode, t[1], "service OK") end end end end end end function check_network_alert(ifname, network_name, mode, key, old_table, new_table) if(verbose) then io.write("check_newtowrk_alert("..ifname..", "..network_name..", "..mode..", "..key..")\n") io.write("new:\n") tprint(new_table) io.write("old:\n") tprint(old_table) end local alert_level = 1 -- alert_level_warning local alert_status = 1 -- alert_on local alert_type = 2 -- alert_threshold_exceeded deltas = {} local delta_names = {'ingress', 'egress', 'inner'} for i = 1, 3 do local delta_name = delta_names[i] deltas[delta_name] = 0 if old_table[delta_name] and new_table[delta_name] then deltas[delta_name] = new_table[delta_name] - old_table[delta_name] end end -- str = "bytes;>;123,packets;>;12" hkey = get_alerts_hash_name(mode, ifname) local str = ntop.getHashCache(hkey, network_name) -- if(verbose) then ("--"..hkey.."="..str.."--
") end if((str ~= nil) and (str ~= "")) then local tokens = split(str, ",") for _,s in pairs(tokens) do -- if(verbose) then (""..s.."
\n") end local t = string.split(s, ";") if(t[2] == "gt") then op = ">" else if(t[2] == "lt") then op = "<" else op = "==" end end local what = "val = deltas['"..t[1].."']; if(val ".. op .. " " .. t[3] .. ") then return(true) else return(false) end" local f = loadstring(what) local rc = f() local alert_id = mode.."_"..t[1] -- the alert identifies is the concat. of time granularity and condition, e.g., min_bytes if(rc) then local alert_msg = "Threshold "..t[1].." crossed by network "..network_name.." [".. val .." ".. op .. " " .. t[3].."]" if not is_alert_re_arming(network_name, mode, t[1], ifname) then if verbose then io.write("queuing alert\n") end re_arm_alert(network_name, mode, t[1], ifname) interface.engageNetworkAlert(network_name, alert_id, alert_type, alert_level, alert_msg) if ntop.isPro() then -- possibly send the alert to nagios as well ntop.sendNagiosAlert(network_name, mode, t[1], alert_msg) end else if verbose then io.write("alarm silenced, re-arm in progress\n") end end if(verbose) then print("".. alert_msg .."
\n") end else if(verbose) then print("

Network threshold "..t[1].."@"..network_name.." not crossed [value="..val.."]["..op.." "..t[3].."]

\n") end if not is_alert_re_arming(network_name, mode, t[1], ifname) then interface.releaseNetworkAlert(network_name, alert_id, alert_type, alert_level, "released!") if ntop.isPro() then ntop.withdrawNagiosAlert(network_name, mode, t[1], "service OK") end end end end end end -- ################################# function check_interface_alert(ifname, mode, old_table, new_table) local ifname_clean = "iface_"..tostring(getInterfaceId(ifname)) if(verbose) then print("check_interface_alert("..ifname..", "..mode..")
\n") end local alert_level = 1 -- alert_level_warning local alert_status = 1 -- alert_on local alert_type = 2 -- alert_threshold_exceeded -- Needed because Lua. loadstring() won't work otherwise. old = old_table new = new_table -- str = "bytes;>;123,packets;>;12" hkey = get_alerts_hash_name(mode, ifname) str = ntop.getHashCache(hkey, ifname_clean) -- if(verbose) then ("--"..hkey.."="..str.."--
") end if((str ~= nil) and (str ~= "")) then tokens = split(str, ",") for _,s in pairs(tokens) do -- if(verbose) then (""..s.."
\n") end t = string.split(s, ";") if(t[2] == "gt") then op = ">" else if(t[2] == "lt") then op = "<" else op = "==" end end local what = "val = "..t[1].."(old, new); if(val ".. op .. " " .. t[3] .. ") then return(true) else return(false) end" local f = loadstring(what) local rc = f() local alert_id = mode.."_"..t[1] -- the alert identifies is the concat. of time granularity and condition, e.g., min_bytes if(rc) then local alert_msg = "Threshold "..t[1].." crossed by interface "..ifname.." [".. val .." ".. op .. " " .. t[3].."]" if not is_alert_re_arming(ifname_clean, mode, t[1], ifname) then if verbose then io.write("queuing alert\n") end re_arm_alert(ifname_clean, mode, t[1], ifname) interface.engageInterfaceAlert(alert_id, alert_type, alert_level, alert_msg) if ntop.isPro() then -- possibly send the alert to nagios as well ntop.sendNagiosAlert(ifname_clean, mode, t[1], alert_msg) end else if verbose then io.write("alarm silenced, re-arm in progress\n") end end if(verbose) then print("".. alert_msg .."
\n") end else if(verbose) then print("

Threshold "..t[1].."@"..ifname.." not crossed [value="..val.."]["..op.." "..t[3].."]

\n") end if not is_alert_re_arming(ifname_clean, mode, t[1], ifname) then interface.releaseInterfaceAlert(alert_id, alert_type, alert_level, "released!") if ntop.isPro() then ntop.withdrawNagiosAlert(ifname_clean, mode, t[1], "service OK") end end end end end end -- ################################# function check_interface_threshold(ifname, mode) interface.select(ifname) local ifstats = interface.getStats() ifname_id = ifstats.id if are_alerts_suppressed("iface_"..ifname_id, ifname) then return end if(verbose) then print("check_interface_threshold("..ifname_id..", "..mode..")
\n") end basedir = fixPath(dirs.workingdir .. "/" .. ifname_id .. "/json/" .. mode) if(not(ntop.exists(basedir))) then ntop.mkdir(basedir) end if (ifstats ~= nil) then fname = fixPath(basedir.."/iface_"..ifname_id.."_lastdump") if(verbose) then print(fname.."

\n") end if (ntop.exists(fname)) then -- Read old version old_dump = persistence.load(fname) if old_dump ~= nil and old_dump.stats ~= nil then check_interface_alert(ifname, mode, old_dump, ifstats) end end -- Write new version persistence.store(fname, ifstats) end end function check_networks_threshold(ifname, mode) interface.select(ifname) local subnet_stats = interface.getNetworksStats() local alarmed_subnets = ntop.getHashKeysCache(get_alerts_hash_name(mode, ifname)) local ifname_id = interface.getStats().id local basedir = fixPath(dirs.workingdir .. "/" .. ifname_id .. "/json/" .. mode) if not ntop.exists(basedir) then ntop.mkdir(basedir) end for subnet,sstats in pairs(subnet_stats) do if sstats == nil or type(alarmed_subnets) ~= "table" or alarmed_subnets[subnet] == nil or are_alerts_suppressed(subnet, ifname) then goto continue end local statspath = getPathFromKey(subnet) statspath = fixPath(basedir.. "/" .. statspath) if not ntop.exists(statspath) then ntop.mkdir(statspath) end statspath = fixPath(statspath .. "/alarmed_subnet_stats_lastdump") if ntop.exists(statspath) then -- Read old version old_dump = persistence.load(statspath) if (old_dump ~= nil) then -- (ifname, network_name, mode, key, old_table, new_table) check_network_alert(ifname, subnet, mode, sstats['network_id'], old_dump, subnet_stats[subnet]) end end persistence.store(statspath, subnet_stats[subnet]) ::continue:: end end -- ################################# function check_host_threshold(ifname, host_ip, mode) interface.select(ifname) local ifstats = interface.getStats() ifname_id = ifstats.id local host_ip_fsname = host_ip if are_alerts_suppressed(host_ip, ifname) then return end if string.ends(host_ip, "@0") then host_ip_fsname = string.split(host_ip, "@") host_ip_fsname = host_ip_fsname[1] end if(verbose) then print("check_host_threshold("..ifname_id..", "..host_ip..", "..mode..")
\n") end basedir = fixPath(dirs.workingdir .. "/" .. ifname_id .. "/json/" .. mode) if(not(ntop.exists(basedir))) then ntop.mkdir(basedir) end json = interface.getHostInfo(host_ip) if(json ~= nil) then fname = fixPath(basedir.."/".. host_ip_fsname ..".json") if(verbose) then print(fname.."

\n") end -- Read old version f = io.open(fname, "r") if(f ~= nil) then old_json = f:read("*all") f:close() check_host_alert(ifname, host_ip, mode, host_ip, old_json, json["json"]) end -- Write new version f = io.open(fname, "w") if(f ~= nil) then f:write(json["json"]) f:close() end end end -- ################################# function scanAlerts(granularity, ifname) if(verbose) then print("[minute.lua] Scanning ".. granularity .." alerts for interface " .. ifname.."

\n") end check_interface_threshold(ifname, granularity) check_networks_threshold(ifname, granularity) -- host alerts checks local hash_key = get_alerts_hash_name(granularity, ifname) local hosts = ntop.getHashKeysCache(hash_key) if(hosts ~= nil) then for h in pairs(hosts) do if(verbose) then print("[minute.lua] Checking host " .. h.." alerts

\n") end check_host_threshold(ifname, h, granularity) end end end -- ################################# function checkDeleteStoredAlerts() if(_GET["csrf"] ~= nil) then if(_GET["id_to_delete"] ~= nil) then if(_GET["id_to_delete"] == "__all__") then if _GET["entity"] ~= nil and _GET["entity"] ~= "" then -- delete all alerts of a given entity (e.g., a given host) interface.deleteAlerts(true --[[ engaged --]], _GET["entity"], _GET["entity_val"]) interface.deleteAlerts(false --[[ and not engaged --]], _GET["entity"], _GET["entity_val"]) else -- delete all existing alerts interface.deleteAlerts(true --[[ engaged --]]) interface.deleteAlerts(false --[[ and not engaged --]]) interface.deleteFlowAlerts() end else local id_to_delete = tonumber(_GET["id_to_delete"]) if id_to_delete ~= nil then if _GET["status"] == "engaged" then interface.deleteAlerts(true, id_to_delete) elseif _GET["status"] == "historical" then interface.deleteAlerts(false, id_to_delete) elseif _GET["status"] == "historical-flows" then interface.deleteFlowAlerts(id_to_delete) end end end end end end -- ################################# function drawAlertTables(num_alerts, num_engaged_alerts, num_flow_alerts, url_params) local alert_items = {} print[[

]] local status = _GET["status"] if num_engaged_alerts > 0 then alert_items[#alert_items + 1] = {["label"] = "Engaged Alerts", ["div-id"] = "table-engaged-alerts", ["status"] = "engaged", ["date"] = "First Seen"} end if num_alerts > 0 then alert_items[#alert_items +1] = {["label"] = "Alerts History", ["div-id"] = "table-alerts-history", ["status"] = "historical", ["date"] = "Time"} end if num_flow_alerts > 0 then alert_items[#alert_items +1] = {["label"] = "Flow Alerts History", ["div-id"] = "table-flow-alerts-history", ["status"] = "historical-flows", ["date"] = "Time"} end local url_extra_params = "" if type(url_params) == "table" then for k, v in pairs(url_params) do if k ~= "csrf" then url_extra_params = url_extra_params.."&"..k.."="..v end end end for k, t in ipairs(alert_items) do local clicked = "0" if (k == 1 and status == nil) or (status ~= nil and status == t["status"]) then clicked = "1" end print [[
]] end if (num_alerts > 0 or num_flow_alerts > 0 or num_engaged_alerts > 0) then -- trigger the click on the right tab to force table load print[[ ]] local entity = nil if _GET["entity"] ~= nil and _GET["entity"] ~= "" then entity = _GET["entity"] end local purge_msg = " Purge All " if entity ~= nil and entity ~= "" then purge_msg = purge_msg..firstToUpper(entity).." " end purge_msg = purge_msg.."Alerts" print [[
]] print(purge_msg) print[[ ]] end end