Debian Codegraph @

lualib/lua_scanners/kaspersky_av.lua

raw
1 --[[
2 Copyright (c) 2022, Vsevolod Stakhov <[email protected]>
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15 ]]--
16
17 --[[[
18 -- @module kaspersky
19 -- This module contains kaspersky antivirus access functions
20 --]]
21
22 local lua_util = require "lua_util"
23 local tcp = require "rspamd_tcp"
24 local upstream_list = require "rspamd_upstream_list"
25 local rspamd_util = require "rspamd_util"
26 local rspamd_logger = require "rspamd_logger"
27 local common = require "lua_scanners/common"
28
29 local N = "kaspersky"
30
31 local default_message = '${SCANNER}: virus found: "${VIRUS}"'
32
33 local function kaspersky_config(opts)
34 local kaspersky_conf = {
35 name = N,
36 scan_mime_parts = true,
37 scan_text_mime = false,
38 scan_image_mime = false,
39 product_id = 0,
40 log_clean = false,
41 timeout = 5.0,
42 retransmits = 1, -- use local files, retransmits are useless
43 cache_expire = 3600, -- expire redis in one hour
44 message = default_message,
45 detection_category = "virus",
46 tmpdir = '/tmp',
47 }
48
49 kaspersky_conf = lua_util.override_defaults(kaspersky_conf, opts)
50
51 if not kaspersky_conf.prefix then
52 kaspersky_conf.prefix = 'rs_' .. kaspersky_conf.name .. '_'
53 end
54
55 if not kaspersky_conf.log_prefix then
56 if kaspersky_conf.name:lower() == kaspersky_conf.type:lower() then
57 kaspersky_conf.log_prefix = kaspersky_conf.name
58 else
59 kaspersky_conf.log_prefix = kaspersky_conf.name .. ' (' .. kaspersky_conf.type .. ')'
60 end
61 end
62
63 if not kaspersky_conf['servers'] then
64 rspamd_logger.errx(rspamd_config, 'no servers defined')
65
66 return nil
67 end
68
69 kaspersky_conf['upstreams'] = upstream_list.create(rspamd_config,
70 kaspersky_conf['servers'], 0)
71
72 if kaspersky_conf['upstreams'] then
73 lua_util.add_debug_alias('antivirus', kaspersky_conf.name)
74 return kaspersky_conf
75 end
76
77 rspamd_logger.errx(rspamd_config, 'cannot parse servers %s',
78 kaspersky_conf['servers'])
79 return nil
80 end
81
82 local function kaspersky_check(task, content, digest, rule, maybe_part)
83 local function kaspersky_check_uncached ()
84 local upstream = rule.upstreams:get_upstream_round_robin()
85 local addr = upstream:get_addr()
86 local retransmits = rule.retransmits
87 local fname = string.format('%s/%s.tmp',
88 rule.tmpdir, rspamd_util.random_hex(32))
89 local message_fd = rspamd_util.create_file(fname)
90 local clamav_compat_cmd = string.format("nSCAN %s\n", fname)
91
92 if not message_fd then
93 rspamd_logger.errx(task, 'cannot store file for kaspersky scan: %s', fname)
94 return
95 end
96
97 if type(content) == 'string' then
98 -- Create rspamd_text
99 local rspamd_text = require "rspamd_text"
100 content = rspamd_text.fromstring(content)
101 end
102 content:save_in_file(message_fd)
103
104 -- Ensure file cleanup
105 task:get_mempool():add_destructor(function()
106 os.remove(fname)
107 rspamd_util.close_file(message_fd)
108 end)
109
110 local function kaspersky_callback(err, data)
111 if err then
112
113 -- retry with another upstream until retransmits exceeds
114 if retransmits > 0 then
115
116 retransmits = retransmits - 1
117
118 -- Select a different upstream!
119 upstream = rule.upstreams:get_upstream_round_robin()
120 addr = upstream:get_addr()
121
122 lua_util.debugm(rule.name, task, '%s: error: %s; retry IP: %s; retries left: %s',
123 rule.log_prefix, err, addr, retransmits)
124
125 tcp.request({
126 task = task,
127 host = addr:to_string(),
128 port = addr:get_port(),
129 upstream = upstream,
130 timeout = rule['timeout'],
131 callback = kaspersky_callback,
132 data = { clamav_compat_cmd },
133 stop_pattern = '\n'
134 })
135 else
136 rspamd_logger.errx(task,
137 '%s [%s]: failed to scan, maximum retransmits exceed',
138 rule['symbol'], rule['type'])
139 common.yield_result(task, rule,
140 'failed to scan and retransmits exceed', 0.0, 'fail',
141 maybe_part)
142 end
143
144 else
145 data = tostring(data)
146 local cached
147 lua_util.debugm(rule.name, task,
148 '%s [%s]: got reply: %s',
149 rule['symbol'], rule['type'], data)
150 if data == 'stream: OK' or data == fname .. ': OK' then
151 cached = 'OK'
152 common.log_clean(task, rule)
153 else
154 local vname = string.match(data, ': (.+) FOUND')
155 if vname then
156 common.yield_result(task, rule, vname, 1.0, nil, maybe_part)
157 cached = vname
158 else
159 rspamd_logger.errx(task, 'unhandled response: %s', data)
160 common.yield_result(task, rule, 'unhandled response',
161 0.0, 'fail', maybe_part)
162 end
163 end
164 if cached then
165 common.save_cache(task, digest, rule, cached, 1.0, maybe_part)
166 end
167 end
168 end
169
170 tcp.request({
171 task = task,
172 host = addr:to_string(),
173 port = addr:get_port(),
174 upstream = upstream,
175 timeout = rule['timeout'],
176 callback = kaspersky_callback,
177 data = { clamav_compat_cmd },
178 stop_pattern = '\n'
179 })
180 end
181
182 if common.condition_check_and_continue(task, content, rule, digest,
183 kaspersky_check_uncached, maybe_part) then
184 return
185 else
186 kaspersky_check_uncached()
187 end
188
189 end
190
191 return {
192 type = 'antivirus',
193 description = 'kaspersky antivirus',
194 configure = kaspersky_config,
195 check = kaspersky_check,
196 name = N
197 }