123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280 |
- --[[
- Copyright (c) 2020, Vsevolod Stakhov <vsevolod@highsecure.ru>
-
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- ]]--
-
- --[[[
- -- @module lua_urls_compose
- -- This module contains functions to compose urls queries from hostname
- -- to TLD part
- --]]
-
- local N = "lua_urls_compose"
- local lua_util = require "lua_util"
- local rspamd_util = require "rspamd_util"
- local bit = require "bit"
- local rspamd_trie = require "rspamd_trie"
- local fun = require "fun"
- local rspamd_regexp = require "rspamd_regexp"
-
- local maps_cache = {}
-
- local exports = {}
-
- local function process_url(self, log_obj, url_tld, url_host)
- local tld_elt = self.tlds[url_tld]
-
- if tld_elt then
- lua_util.debugm(N, log_obj, 'found compose tld for %s (host = %s)',
- url_tld, url_host)
-
- for _,excl in ipairs(tld_elt.except_rules) do
- local matched,ret = excl[2](url_tld, url_host)
- if matched then
- lua_util.debugm(N, log_obj, 'found compose exclusion for %s (%s) -> %s',
- url_host, excl[1], ret)
-
- return ret
- end
- end
-
- if tld_elt.multipattern_compose_rules then
- local matches = tld_elt.multipattern_compose_rules:match(url_host)
-
- if matches then
- local lua_pat_idx = math.huge
-
- for m,_ in pairs(matches) do
- if m < lua_pat_idx then
- lua_pat_idx = m
- end
- end
-
- if #tld_elt.compose_rules >= lua_pat_idx then
- local lua_pat = tld_elt.compose_rules[lua_pat_idx]
- local matched,ret = lua_pat[2](url_tld, url_host)
-
- if not matched then
- lua_util.debugm(N, log_obj, 'NOT found compose inclusion for %s (%s) -> %s',
- url_host, lua_pat[1], url_tld)
-
- return url_tld
- else
- lua_util.debugm(N, log_obj, 'found compose inclusion for %s (%s) -> %s',
- url_host, lua_pat[1], ret)
-
- return ret
- end
- else
- lua_util.debugm(N, log_obj, 'NOT found compose inclusion for %s (%s) -> %s',
- url_host, lua_pat_idx, url_tld)
-
- return url_tld
- end
- end
- else
- -- Match one by one
- for _,lua_pat in ipairs(tld_elt.compose_rules) do
- local matched,ret = lua_pat[2](url_tld, url_host)
- if matched then
- lua_util.debugm(N, log_obj, 'found compose inclusion for %s (%s) -> %s',
- url_host, lua_pat[1], ret)
-
- return ret
- end
- end
- end
-
- lua_util.debugm(N, log_obj, 'not found compose inclusion for %s in %s -> %s',
- url_host, url_tld, url_tld)
- else
- lua_util.debugm(N, log_obj, 'not found compose tld for %s in %s -> %s',
- url_host, url_tld, url_tld)
- end
-
- return url_tld
- end
-
- local function tld_pattern_transform(tld_pat)
- -- Convert tld like pattern to a lua match pattern
- -- blah -> %.blah
- -- *.blah -> .*%.blah
- local ret
- if tld_pat:sub(1, 2) == '*.' then
- ret = string.format('^((?:[^.]+\\.)*%s)$', tld_pat:sub(3))
- else
- ret = string.format('(?:^|\\.)((?:[^.]+\\.)?%s)$', tld_pat)
- end
-
- lua_util.debugm(N, nil, 'added pattern %s -> %s',
- tld_pat, ret)
-
- return ret
- end
-
- local function include_elt_gen(pat)
- pat = rspamd_regexp.create(tld_pattern_transform(pat), 'i')
- return function(_, host)
- local matches = pat:search(host, false, true)
- if matches then
- return true,matches[1][2]
- end
-
- return false
- end
- end
-
- local function exclude_elt_gen(pat)
- pat = rspamd_regexp.create(tld_pattern_transform(pat))
- return function(tld, host)
- if pat:search(host) then
- return true,tld
- end
-
- return false
- end
- end
-
- local function compose_map_cb(self, map_text)
- local lpeg = require "lpeg"
-
- local singleline_comment = lpeg.P '#' * (1 - lpeg.S '\r\n\f') ^ 0
- local comments_strip_grammar = lpeg.C((1 - lpeg.P '#') ^ 1) * lpeg.S(' \t')^0 * singleline_comment^0
-
- local function process_tld_rule(tld_elt, l)
- if l:sub(1, 1) == '!' then
- -- Exclusion elt
- table.insert(tld_elt.except_rules, {l, exclude_elt_gen(l:sub(2))})
- else
- table.insert(tld_elt.compose_rules, {l, include_elt_gen(l)})
- end
- end
-
- local function process_map_line(l)
- -- Skip empty lines and comments
- if #l == 0 then return end
- l = comments_strip_grammar:match(l)
- if not l or #l == 0 then return end
-
- -- Get TLD
- local tld = rspamd_util.get_tld(l)
-
- if tld then
- local tld_elt = self.tlds[tld]
-
- if not tld_elt then
- tld_elt = {
- compose_rules = {},
- except_rules = {},
- multipattern_compose_rules = nil
- }
-
- lua_util.debugm(N, rspamd_config, 'processed new tld rule for %s', tld)
- self.tlds[tld] = tld_elt
- end
-
- process_tld_rule(tld_elt, l)
- else
- lua_util.debugm(N, rspamd_config, 'cannot read tld from compose map line: %s', l)
- end
- end
-
- for line in map_text:lines() do
- process_map_line(line)
- end
-
- local multipattern_threshold = 1
- for tld,tld_elt in pairs(self.tlds) do
- -- Sort patterns to have longest labels before shortest ones,
- -- so we can ensure that they match before
- table.sort(tld_elt.compose_rules, function(e1, e2)
- local _,ndots1 = string.gsub(e1[1], '(%.)', '')
- local _,ndots2 = string.gsub(e2[1], '(%.)', '')
-
- return ndots1 > ndots2
- end)
- if rspamd_trie.has_hyperscan() and #tld_elt.compose_rules >= multipattern_threshold then
- lua_util.debugm(N, rspamd_config, 'tld %s has %s rules, apply multipattern',
- tld, #tld_elt.compose_rules)
- local flags = bit.bor(rspamd_trie.flags.re,
- rspamd_trie.flags.dot_all,
- rspamd_trie.flags.no_start,
- rspamd_trie.flags.icase)
-
-
- -- We now convert our internal patterns to multipattern patterns
- local mp_table = fun.totable(fun.map(function(pat_elt)
- return tld_pattern_transform(pat_elt[1])
- end, tld_elt.compose_rules))
- tld_elt.multipattern_compose_rules = rspamd_trie.create(mp_table, flags)
- end
- end
- end
-
- exports.add_composition_map = function(cfg, map_obj)
- local hash_key = map_obj
- if type(map_obj) == 'table' then
- hash_key = lua_util.table_digest(map_obj)
- end
-
- local map = maps_cache[hash_key]
-
- if not map then
- local ret = {
- process_url = process_url,
- hash = hash_key,
- tlds = {},
- }
-
- map = cfg:add_map{
- type = 'callback',
- description = 'URL compose map',
- url = map_obj,
- callback = function(input) compose_map_cb(ret, input) end,
- opaque_data = true,
- }
-
- ret.map = map
- maps_cache[hash_key] = ret
- map = ret
- end
-
- return map
- end
-
- exports.inject_composition_rules = function(cfg, rules)
- local hash_key = rules
- local rspamd_text = require "rspamd_text"
- if type(rules) == 'table' then
- hash_key = lua_util.table_digest(rules)
- end
-
- local map = maps_cache[hash_key]
-
- if not map then
- local ret = {
- process_url = process_url,
- hash = hash_key,
- tlds = {},
- }
-
- compose_map_cb(ret, rspamd_text.fromtable(rules, '\n'))
- maps_cache[hash_key] = ret
- map = ret
- end
-
- return map
- end
-
- return exports
|