Debian Codegraph @

lualib/lua_scanners/savapi.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 savapi
19 -- This module contains avira savapi 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 = "savapi"
30
31 local default_message = '${SCANNER}: virus found: "${VIRUS}"'
32
33 local function savapi_config(opts)
34 local savapi_conf = {
35 name = N,
36 scan_mime_parts = true,
37 scan_text_mime = false,
38 scan_image_mime = false,
39 default_port = 4444, -- note: You must set ListenAddress in savapi.conf
40 product_id = 0,
41 log_clean = false,
42 timeout = 15.0, -- FIXME: this will break task_timeout!
43 retransmits = 1, -- FIXME: useless, for local files
44 cache_expire = 3600, -- expire redis in one hour
45 message = default_message,
46 detection_category = "virus",
47 tmpdir = '/tmp',
48 }
49
50 savapi_conf = lua_util.override_defaults(savapi_conf, opts)
51
52 if not savapi_conf.prefix then
53 savapi_conf.prefix = 'rs_' .. savapi_conf.name .. '_'
54 end
55
56 if not savapi_conf.log_prefix then
57 if savapi_conf.name:lower() == savapi_conf.type:lower() then
58 savapi_conf.log_prefix = savapi_conf.name
59 else
60 savapi_conf.log_prefix = savapi_conf.name .. ' (' .. savapi_conf.type .. ')'
61 end
62 end
63
64 if not savapi_conf['servers'] then
65 rspamd_logger.errx(rspamd_config, 'no servers defined')
66
67 return nil
68 end
69
70 savapi_conf['upstreams'] = upstream_list.create(rspamd_config,
71 savapi_conf['servers'],
72 savapi_conf.default_port)
73
74 if savapi_conf['upstreams'] then
75 lua_util.add_debug_alias('antivirus', savapi_conf.name)
76 return savapi_conf
77 end
78
79 rspamd_logger.errx(rspamd_config, 'cannot parse servers %s',
80 savapi_conf['servers'])
81 return nil
82 end
83
84 local function savapi_check(task, content, digest, rule)
85 local function savapi_check_uncached ()
86 local upstream = rule.upstreams:get_upstream_round_robin()
87 local addr = upstream:get_addr()
88 local retransmits = rule.retransmits
89 local fname = string.format('%s/%s.tmp',
90 rule.tmpdir, rspamd_util.random_hex(32))
91 local message_fd = rspamd_util.create_file(fname)
92
93 if not message_fd then
94 rspamd_logger.errx(task, 'cannot store file for savapi scan: %s', fname)
95 return
96 end
97
98 if type(content) == 'string' then
99 -- Create rspamd_text
100 local rspamd_text = require "rspamd_text"
101 content = rspamd_text.fromstring(content)
102 end
103 content:save_in_file(message_fd)
104
105 -- Ensure cleanup
106 task:get_mempool():add_destructor(function()
107 os.remove(fname)
108 rspamd_util.close_file(message_fd)
109 end)
110
111 local vnames = {}
112
113 -- Forward declaration for recursive calls
114 local savapi_scan1_cb
115
116 local function savapi_fin_cb(err, conn)
117 local vnames_reordered = {}
118 -- Swap table
119 for virus, _ in pairs(vnames) do
120 table.insert(vnames_reordered, virus)
121 end
122 lua_util.debugm(rule.name, task, "%s: number of virus names found %s", rule['type'], #vnames_reordered)
123 if #vnames_reordered > 0 then
124 local vname = {}
125 for _, virus in ipairs(vnames_reordered) do
126 table.insert(vname, virus)
127 end
128
129 common.yield_result(task, rule, vname)
130 common.save_cache(task, digest, rule, vname)
131 end
132 if conn then
133 conn:close()
134 end
135 end
136
137 local function savapi_scan2_cb(err, data, conn)
138 local result = tostring(data)
139 lua_util.debugm(rule.name, task, "%s: got reply: %s",
140 rule.type, result)
141
142 -- Terminal response - clean
143 if string.find(result, '200') or string.find(result, '210') then
144 if rule['log_clean'] then
145 rspamd_logger.infox(task, '%s: message or mime_part is clean', rule['type'])
146 end
147 common.save_cache(task, digest, rule, 'OK')
148 conn:add_write(savapi_fin_cb, 'QUIT\n')
149
150 -- Terminal response - infected
151 elseif string.find(result, '319') then
152 conn:add_write(savapi_fin_cb, 'QUIT\n')
153
154 -- Non-terminal response
155 elseif string.find(result, '310') then
156 local virus
157 virus = result:match "310.*<<<%s(.*)%s+;.*;.*"
158 if not virus then
159 virus = result:match "310%s(.*)%s+;.*;.*"
160 if not virus then
161 rspamd_logger.errx(task, "%s: virus result unparseable: %s",
162 rule['type'], result)
163 common.yield_result(task, rule, 'virus result unparseable: ' .. result, 0.0, 'fail')
164 return
165 end
166 end
167 -- Store unique virus names
168 vnames[virus] = 1
169 -- More content is expected
170 conn:add_write(savapi_scan1_cb, '\n')
171 end
172 end
173
174 savapi_scan1_cb = function(err, conn)
175 conn:add_read(savapi_scan2_cb, '\n')
176 end
177
178 -- 100 PRODUCT:xyz
179 local function savapi_greet2_cb(err, data, conn)
180 local result = tostring(data)
181 if string.find(result, '100 PRODUCT') then
182 lua_util.debugm(rule.name, task, "%s: scanning file: %s",
183 rule['type'], fname)
184 conn:add_write(savapi_scan1_cb, { string.format('SCAN %s\n',
185 fname) })
186 else
187 rspamd_logger.errx(task, '%s: invalid product id %s', rule['type'],
188 rule['product_id'])
189 common.yield_result(task, rule, 'invalid product id: ' .. result, 0.0, 'fail')
190 conn:add_write(savapi_fin_cb, 'QUIT\n')
191 end
192 end
193
194 local function savapi_greet1_cb(err, conn)
195 conn:add_read(savapi_greet2_cb, '\n')
196 end
197
198 local function savapi_callback_init(err, data, conn)
199 if err then
200
201 -- retry with another upstream until retransmits exceeds
202 if retransmits > 0 then
203
204 retransmits = retransmits - 1
205
206 -- Select a different upstream!
207 upstream = rule.upstreams:get_upstream_round_robin()
208 addr = upstream:get_addr()
209
210 lua_util.debugm(rule.name, task, '%s: error: %s; retry IP: %s; retries left: %s',
211 rule.log_prefix, err, addr, retransmits)
212
213 tcp.request({
214 task = task,
215 host = addr:to_string(),
216 port = addr:get_port(),
217 upstream = upstream,
218 timeout = rule['timeout'],
219 callback = savapi_callback_init,
220 stop_pattern = { '\n' },
221 })
222 else
223 rspamd_logger.errx(task, '%s [%s]: failed to scan, maximum retransmits exceed', rule['symbol'], rule['type'])
224 common.yield_result(task, rule, 'failed to scan and retransmits exceed', 0.0, 'fail')
225 end
226 else
227 local result = tostring(data)
228
229 -- 100 SAVAPI:4.0 greeting
230 if string.find(result, '100') then
231 conn:add_write(savapi_greet1_cb, { string.format('SET PRODUCT %s\n', rule['product_id']) })
232 end
233 end
234 end
235
236 tcp.request({
237 task = task,
238 host = addr:to_string(),
239 port = addr:get_port(),
240 upstream = upstream,
241 timeout = rule['timeout'],
242 callback = savapi_callback_init,
243 stop_pattern = { '\n' },
244 })
245 end
246
247 if common.condition_check_and_continue(task, content, rule, digest, savapi_check_uncached) then
248 return
249 else
250 savapi_check_uncached()
251 end
252
253 end
254
255 return {
256 type = 'antivirus',
257 description = 'savapi avira antivirus',
258 configure = savapi_config,
259 check = savapi_check,
260 name = N
261 }