1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
|
--[[
Copyright (c) 2021, defkev <defkev@gmail.com>
Copyright (c) 2018, Carsten Rosenberg <c.rosenberg@heinlein-support.de>
Copyright (c) 2022, Vsevolod Stakhov <vsevolod@rspamd.com>
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 pyzor
-- This module contains pyzor access functions
--]]
local lua_util = require "lua_util"
local tcp = require "rspamd_tcp"
local upstream_list = require "rspamd_upstream_list"
local rspamd_logger = require "rspamd_logger"
local common = require "lua_scanners/common"
local N = 'pyzor'
local categories = { 'pyzor', 'bulk', 'hash', 'scanner' }
local function pyzor_config(opts)
local pyzor_conf = {
text_part_min_words = 2,
default_port = 5953,
timeout = 15.0,
log_clean = false,
retransmits = 2,
detection_category = "hash",
cache_expire = 7200, -- expire redis in one hour
message = '${SCANNER}: Pyzor bulk message found: "${VIRUS}"',
default_score = 1.5,
action = false,
}
pyzor_conf = lua_util.override_defaults(pyzor_conf, opts)
if not pyzor_conf.prefix then
pyzor_conf.prefix = 'rext_' .. N .. '_'
end
if not pyzor_conf.log_prefix then
pyzor_conf.log_prefix = N .. ' (' .. pyzor_conf.detection_category .. ')'
end
if not pyzor_conf['servers'] then
rspamd_logger.errx(rspamd_config, 'no servers defined')
return nil
end
pyzor_conf['upstreams'] = upstream_list.create(rspamd_config,
pyzor_conf['servers'],
pyzor_conf.default_port)
if pyzor_conf['upstreams'] then
lua_util.add_debug_alias('external_services', N)
return pyzor_conf
end
rspamd_logger.errx(rspamd_config, 'cannot parse servers %s',
pyzor_conf['servers'])
return nil
end
local function pyzor_check(task, content, digest, rule)
local function pyzor_check_uncached ()
local upstream = rule.upstreams:get_upstream_round_robin()
local addr = upstream:get_addr()
local retransmits = rule.retransmits
local function pyzor_callback(err, data, conn)
if err then
-- retry with another upstream until retransmits exceeds
if retransmits > 0 then
retransmits = retransmits - 1
-- Select a different upstream!
upstream = rule.upstreams:get_upstream_round_robin()
addr = upstream:get_addr()
lua_util.debugm(N, task, '%s: retry IP: %s:%s err: %s',
rule.log_prefix, addr, addr:get_port(), err)
tcp.request({
task = task,
host = addr:to_string(),
port = addr:get_port(),
upstream = upstream,
timeout = rule['timeout'],
shutdown = true,
data = content,
callback = pyzor_callback,
})
else
rspamd_logger.errx(task, '%s: failed to scan, maximum retransmits exceed',
rule['symbol'], rule['type'])
task:insert_result(rule['symbol_fail'], 0.0,
'failed to scan and retransmits exceed')
end
else
-- pyzor output is unicode (\x09 -> tab, \0a -> newline)
-- public.pyzor.org:24441 (200, 'OK') 21285091 206759
-- server:port Code Diag Count WL-Count
local str_data = tostring(data)
lua_util.debugm(N, task, '%s: returned data: %s',
rule.log_prefix, str_data)
-- If pyzor would return JSON this wouldn't be necessary
local resp = {}
for v in string.gmatch(str_data, '[^\t]+') do
table.insert(resp, v)
end
-- rspamd_logger.infox(task, 'resp: %s', resp)
if resp[2] ~= [[(200, 'OK')]] then
rspamd_logger.errx(task, "error parsing response: %s", str_data)
return
end
local whitelisted = tonumber(resp[4])
local reported = tonumber(resp[3])
--rspamd_logger.infox(task, "%s - count=%s wl=%s", addr:to_string(), reported, whitelisted)
--[[
Weight is Count - WL-Count of rule.default_score in percent, e.g.
SPAM:
Count: 100 (100%)
WL-Count: 1 (1%)
rule.default_score: 1
Weight: 0.99
HAM:
Count: 10 (100%)
WL-Count: 10 (100%)
rule.default_score: 1
Weight: 0
]]
local weight = tonumber(string.format("%.2f",
rule.default_score * (reported - whitelisted) / (reported + whitelisted)))
local info = string.format("count=%d wl=%d", reported, whitelisted)
local threat_string = string.format("bl_%d_wl_%d",
reported, whitelisted)
if weight > 0 then
lua_util.debugm(N, task, '%s: returned result is spam - info: %s',
rule.log_prefix, info)
common.yield_result(task, rule, threat_string, weight)
common.save_cache(task, digest, rule, threat_string, weight)
else
if rule.log_clean then
rspamd_logger.infox(task, '%s: clean, returned result is ham - info: %s',
rule.log_prefix, info)
else
lua_util.debugm(N, task, '%s: returned result is ham - info: %s',
rule.log_prefix, info)
end
common.save_cache(task, digest, rule, 'OK', weight)
end
end
end
if digest == 'da39a3ee5e6b4b0d3255bfef95601890afd80709' then
rspamd_logger.infox(task, '%s: not checking default digest', rule.log_prefix)
return
end
tcp.request({
task = task,
host = addr:to_string(),
port = addr:get_port(),
upstream = upstream,
timeout = rule.timeout,
shutdown = true,
data = content,
callback = pyzor_callback,
})
end
if common.condition_check_and_continue(task, content, rule, digest, pyzor_check_uncached) then
return
else
pyzor_check_uncached()
end
end
return {
type = categories,
description = 'pyzor bulk scanner',
configure = pyzor_config,
check = pyzor_check,
name = N
}
|
