Fixes custom category change not working and apply button disabled (#7406 #7405)

This commit is contained in:
Matteo Biscosi 2023-04-17 10:26:26 +00:00
parent 1c8c8b697c
commit 4b1ee9d278
7 changed files with 7584 additions and 6767 deletions

View file

@ -1,7 +1,6 @@
--
-- (C) 2021 - ntop.org
--
local os_utils = require("os_utils")
local http_lint = require "http_lint"
local protos_utils = {}
@ -13,59 +12,59 @@ local first_proto_id = 1024
-- ##############################################
local function getProtosFile()
return os_utils.fixPath(ntop.getPrefs().ndpi_proto_file)
return os_utils.fixPath(ntop.getPrefs().ndpi_proto_file)
end
-- ##############################################
-- Function used to reload the custom applications (the protocol file, -p option)
local function reloadApplications()
--traceError(TRACE_NORMAL, TRACE_CONSOLE, string.format("Reloading the custom applications"))
if(not ntop.initnDPIReload()) then
-- Too early, need to retry later
traceError(TRACE_ERROR, TRACE_CONSOLE, string.format("Error while reloading the custom applications"))
return(false)
end
--traceError(TRACE_NORMAL, TRACE_CONSOLE, string.format("Finalizing the reload of custom applications"))
ntop.finalizenDPIReload()
-- traceError(TRACE_NORMAL, TRACE_CONSOLE, string.format("Reloading the custom applications"))
if (not ntop.initnDPIReload()) then
-- Too early, need to retry later
traceError(TRACE_ERROR, TRACE_CONSOLE, string.format("Error while reloading the custom applications"))
return (false)
end
-- traceError(TRACE_NORMAL, TRACE_CONSOLE, string.format("Finalizing the reload of custom applications"))
ntop.finalizenDPIReload()
end
-- ##############################################
local function parsePortBasedRule(filter, value, line)
local parts
local parts
if((filter == "tcp") or (filter == "udp")) then
-- single port or port range
local lower, upper
parts = string.split(value, "-")
if ((filter == "tcp") or (filter == "udp")) then
-- single port or port range
local lower, upper
parts = string.split(value, "-")
if((parts ~= nil) and (#parts == 2)) then
-- port range
lower = tonumber(parts[1])
upper = tonumber(parts[2])
else
lower = tonumber(value)
upper = lower
if ((parts ~= nil) and (#parts == 2)) then
-- port range
lower = tonumber(parts[1])
upper = tonumber(parts[2])
else
lower = tonumber(value)
upper = lower
end
if ((lower ~= nil) and (upper ~= nil)) then
return true, {
match = "port",
proto = filter,
port_lower = lower,
port_upper = upper,
value = string.format("%s:%s", filter, value)
}
else
traceError(TRACE_WARNING, TRACE_CONSOLE,
string.format("[protos.txt] Ignoring bad %s port range '%s' in rule: %s", filter, value, line))
return true, nil
end
end
if((lower ~= nil) and (upper ~= nil)) then
return true, {
match = "port",
proto = filter,
port_lower = lower,
port_upper = upper,
value = string.format("%s:%s", filter, value),
}
else
traceError(TRACE_WARNING, TRACE_CONSOLE,
string.format("[protos.txt] Ignoring bad %s port range '%s' in rule: %s", filter, value, line))
return true, nil
end
end
return false, nil
return false, nil
end
-- ##############################################
@ -75,202 +74,206 @@ end
-- defined protocols is returned to ensure that the protocols are always appended to the
-- end of the file as nDPI assigns the custom protocol IDs sequentially.
function protos_utils.parseProtosTxt()
local path = getProtosFile()
local path = getProtosFile()
if not ntop.exists(path) then
return {}, {}
end
local f = io.open(path, "r")
local defined_protos = {}
local rules = {}
local function addRule(proto, rule)
if(rules[proto] == nil) then
rules[proto] = {}
defined_protos[#defined_protos + 1] = proto
if not ntop.exists(path) then
return {}, {}
end
rules[proto][#rules[proto] + 1] = rule
end
local f = io.open(path, "r")
local defined_protos = {}
local rules = {}
if f == nil then
traceError(TRACE_ERROR, TRACE_CONSOLE, string.format("[protos.txt] Could not open '%s' (invalid permissions?)", path))
return {}, {}
end
for full_line in f:lines() do
local line = trimString(full_line)
local parts = string.split(line, "@")
if((line == "") or starts(line, "#")) then
-- comment or empty line
elseif((parts ~= nil) and (#parts == 2)) then
local proto = parts[2]
local rules = parts[1]
local tmp = string.split(proto, "=")
rules = string.split(rules, ",") or {rules}
if (tmp ~= nil) and (#tmp == 2) then
proto = tmp[1]
end
for _, rule in ipairs(rules) do
parts = string.split(rule, ":")
if((parts ~= nil) and (#parts == 2 or #parts == 3)) then
local filter = parts[1]
local value = rule:gsub(filter..":", "")
local is_port_based, port_based_rule = parsePortBasedRule(filter, value, line)
if is_port_based then
addRule(proto, port_based_rule)
elseif(filter == "host") then
-- possibly remove quotas
value = value:gsub("^\"*(.-)\"*$", "%1")
if not isEmptyString(value) then
addRule(proto, {
match = "host",
value = value,
})
else
traceError(TRACE_WARNING, TRACE_CONSOLE,
string.format("[protos.txt] Ignoring bad host '%s' in rule: %s", value, line))
end
elseif(filter == "ip") then
addRule(proto, {
match = "ip",
value = value,
})
else
traceError(TRACE_WARNING, TRACE_CONSOLE,
string.format("[protos.txt] Ignoring unknown filter '%s' in rule: %s", filter, line))
end
else
traceError(TRACE_WARNING, TRACE_CONSOLE,
string.format("[protos.txt] Ignoring bad rule: %s", line))
local function addRule(proto, rule)
if (rules[proto] == nil) then
rules[proto] = {}
defined_protos[#defined_protos + 1] = proto
end
end
else
traceError(TRACE_WARNING, TRACE_CONSOLE,
string.format("[protos.txt] Ignoring bad rule: %s", line))
rules[proto][#rules[proto] + 1] = rule
end
end
f:close()
if f == nil then
traceError(TRACE_ERROR, TRACE_CONSOLE,
string.format("[protos.txt] Could not open '%s' (invalid permissions?)", path))
return {}, {}
end
return rules, defined_protos
for full_line in f:lines() do
local line = trimString(full_line)
local parts = string.split(line, "@")
if ((line == "") or starts(line, "#")) then
-- comment or empty line
elseif ((parts ~= nil) and (#parts == 2)) then
local proto = parts[2]
local rules = parts[1]
local tmp = string.split(proto, "=")
rules = string.split(rules, ",") or {rules}
if (tmp ~= nil) and (#tmp == 2) then
proto = tmp[1]
end
for _, rule in ipairs(rules) do
parts = string.split(rule, ":")
if ((parts ~= nil) and (#parts == 2 or #parts == 3)) then
local filter = parts[1]
local value = rule:gsub(filter .. ":", "")
local is_port_based, port_based_rule = parsePortBasedRule(filter, value, line)
if is_port_based then
addRule(proto, port_based_rule)
elseif (filter == "host") then
-- possibly remove quotas
value = value:gsub("^\"*(.-)\"*$", "%1")
if not isEmptyString(value) then
addRule(proto, {
match = "host",
value = value
})
else
traceError(TRACE_WARNING, TRACE_CONSOLE,
string.format("[protos.txt] Ignoring bad host '%s' in rule: %s", value, line))
end
elseif (filter == "ip") then
addRule(proto, {
match = "ip",
value = value
})
else
traceError(TRACE_WARNING, TRACE_CONSOLE,
string.format("[protos.txt] Ignoring unknown filter '%s' in rule: %s", filter, line))
end
else
traceError(TRACE_WARNING, TRACE_CONSOLE, string.format("[protos.txt] Ignoring bad rule: %s", line))
end
end
else
traceError(TRACE_WARNING, TRACE_CONSOLE, string.format("[protos.txt] Ignoring bad rule: %s", line))
end
end
f:close()
return rules, defined_protos
end
-- ##############################################
function protos_utils.hasProtosFile()
return(not isEmptyString(getProtosFile()))
return (not isEmptyString(getProtosFile()))
end
-- ##############################################
function protos_utils.getProtosTxtRule(line)
line = trimString(line)
line = trimString(line)
if isIPv4(line) or http_lint.validateNetwork(line) then
return {
match = "ip",
value = line
}
else
local parts = string.split(line, ":")
if isIPv4(line) or http_lint.validateNetwork(line) then
return {
match = "ip",
value = line
}
else
local parts = string.split(line, ":")
if((parts ~= nil) and (#parts == 2)) then
local filter = parts[1]
local value = parts[2]
if ((parts ~= nil) and (#parts >= 2)) then
local filter = parts[1]
local value = parts[2]
if tonumber(value) then
if isIPv4(filter) or http_lint.validateNetwork(filter) then
-- e.g., 8.248.73.247:443
-- e.g., 213.75.170.11/32:443
return {
match = "ip",
value = line
}
end
end
if filter == 'ip' then
-- Add the port in case there is one, so accept both cases, ip and ip:port :
-- e.g. ip:1.1.1.1 and ip:1.1.1.1:5466
if parts[3] then
value = value .. ':' .. parts[3]
end
return {
match = "ip",
value = value
}
elseif filter == 'host' then
-- Domain name filter
-- e.g. host:google
return {
match = "host",
value = value
}
else
-- Check if it's a port or port range filter
-- e.g. udp:5555 and udp:5555-5557
local is_port_based, port_based_rule = parsePortBasedRule(filter, value, line)
local is_port_based, port_based_rule = parsePortBasedRule(filter, value, line)
if is_port_based then
return port_based_rule
end
elseif not isEmptyString(line) then
return {
match = "host",
value = line,
}
if is_port_based then
return port_based_rule
end
end
end
end
end
end
-- ##############################################
function protos_utils.overwriteAppRules(app, rules)
local current_rules, defined_protos = protos_utils.parseProtosTxt()
local current_rules, defined_protos = protos_utils.parseProtosTxt()
if(current_rules == nil) or (type("app") ~= "string") then
return false
end
if (current_rules == nil) or (type("app") ~= "string") then
return false
end
if(not current_rules[app]) then
-- This is a new app, append it to the end
defined_protos[#defined_protos + 1] = app
end
if (not current_rules[app]) then
-- This is a new app, append it to the end
defined_protos[#defined_protos + 1] = app
end
current_rules[app] = rules
return protos_utils.generateProtosTxt(current_rules, defined_protos)
current_rules[app] = rules
return protos_utils.generateProtosTxt(current_rules, defined_protos)
end
-- ##############################################
function protos_utils.addAppRule(app, rule)
local current_rules, defined_protos = protos_utils.parseProtosTxt()
local app_rules
local current_rules, defined_protos = protos_utils.parseProtosTxt()
local app_rules
if(current_rules == nil) or (type("app") ~= "string") then
return false
end
app_rules = current_rules[app] or {}
-- Uniqueness Check
for _, existing_rule in pairs(app_rules) do
if((existing_rule.match == rule.match) and (existing_rule.value == rule.value)) then
return false
if (current_rules == nil) or (type("app") ~= "string") then
return false
end
end
if(not current_rules[app]) then
-- This is a new app, append it to the end
defined_protos[#defined_protos + 1] = app
end
app_rules = current_rules[app] or {}
app_rules[#app_rules + 1] = rule
current_rules[app] = app_rules
return protos_utils.generateProtosTxt(current_rules, defined_protos)
-- Uniqueness Check
for _, existing_rule in pairs(app_rules) do
if ((existing_rule.match == rule.match) and (existing_rule.value == rule.value)) then
return false
end
end
if (not current_rules[app]) then
-- This is a new app, append it to the end
defined_protos[#defined_protos + 1] = app
end
app_rules[#app_rules + 1] = rule
current_rules[app] = app_rules
return protos_utils.generateProtosTxt(current_rules, defined_protos)
end
-- ##############################################
function protos_utils.deleteAppRules(app)
local current_rules, defined_protos = protos_utils.parseProtosTxt()
local current_rules, defined_protos = protos_utils.parseProtosTxt()
if(not current_rules[app]) then
-- App does not exist
return false
end
if (not current_rules[app]) then
-- App does not exist
return false
end
current_rules[app] = nil
return protos_utils.generateProtosTxt(current_rules, defined_protos)
current_rules[app] = nil
return protos_utils.generateProtosTxt(current_rules, defined_protos)
end
-- ##############################################
@ -280,73 +283,73 @@ end
-- in the specified order as nDPI assigns IDs sequentially and existing
-- IDs must not be changed.
function protos_utils.generateProtosTxt(rules, defined_protos)
local path = getProtosFile()
local backup_file = path .. ".bak"
local path = getProtosFile()
local backup_file = path .. ".bak"
if(ntop.exists(path) and (not ntop.exists(backup_file))) then
traceError(TRACE_INFO, TRACE_CONSOLE, string.format("Backing up '%s' to '%s'", path, backup_file))
os.rename(path, backup_file)
end
local f = io.open(path, "w")
if f == nil then
traceError(TRACE_ERROR, TRACE_CONSOLE, string.format("[protos.txt] Could not open '%s' for write", path))
return false
end
local function writeRule(rule)
f:write(string.format("%s\n", rule))
end
-- Important: iterate by index to ensure that new protocols are always appended
for _, proto in ipairs(defined_protos) do
local proto_rules = rules[proto]
local proto_name = string.split(proto, "=") or {}
if proto_name and #proto_name == 2 then
proto_name = proto_name[1]
else
proto_name = proto
if (ntop.exists(path) and (not ntop.exists(backup_file))) then
traceError(TRACE_INFO, TRACE_CONSOLE, string.format("Backing up '%s' to '%s'", path, backup_file))
os.rename(path, backup_file)
end
local proto_id = ntop.getHashCache(proto_key, proto_name) or ''
local f = io.open(path, "w")
if isEmptyString(proto_id) then
proto_id = tonumber(ntop.getCache(proto_last_id)) or 0
if proto_id == 0 then
proto_id = first_proto_id
end
ntop.setCache(proto_last_id, proto_id + 1)
ntop.setHashCache(proto_key, proto_name, proto_id)
if f == nil then
traceError(TRACE_ERROR, TRACE_CONSOLE, string.format("[protos.txt] Could not open '%s' for write", path))
return false
end
if proto_rules then
writeRule(string.format("# %s", proto_name))
local function writeRule(rule)
f:write(string.format("%s\n", rule))
end
for _, rule in ipairs(proto_rules) do
if rule.match == "port" then
writeRule(string.format("%s@%s=%s", rule.value, proto_name, proto_id))
elseif rule.match == "host" then
writeRule(string.format("host:\"%s\"@%s=%s", rule.value, proto_name, proto_id))
elseif rule.match == "ip" then
writeRule(string.format("ip:%s@%s=%s", rule.value, proto_name, proto_id))
-- Important: iterate by index to ensure that new protocols are always appended
for _, proto in ipairs(defined_protos) do
local proto_rules = rules[proto]
local proto_name = string.split(proto, "=") or {}
if proto_name and #proto_name == 2 then
proto_name = proto_name[1]
else
proto_name = proto
end
end
writeRule("")
local proto_id = ntop.getHashCache(proto_key, proto_name) or ''
if isEmptyString(proto_id) then
proto_id = tonumber(ntop.getCache(proto_last_id)) or 0
if proto_id == 0 then
proto_id = first_proto_id
end
ntop.setCache(proto_last_id, proto_id + 1)
ntop.setHashCache(proto_key, proto_name, proto_id)
end
if proto_rules then
writeRule(string.format("# %s", proto_name))
for _, rule in ipairs(proto_rules) do
if rule.match == "port" then
writeRule(string.format("%s@%s=%s", rule.value, proto_name, proto_id))
elseif rule.match == "host" then
writeRule(string.format("host:\"%s\"@%s=%s", rule.value, proto_name, proto_id))
elseif rule.match == "ip" then
writeRule(string.format("ip:%s@%s=%s", rule.value, proto_name, proto_id))
end
end
writeRule("")
end
end
end
f:close()
f:close()
-- Reload the application file
reloadApplications()
-- Reload the application file
reloadApplications()
return true
return true
end
-- ##############################################
return(protos_utils)
return (protos_utils)