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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
|
--[[
Copyright (c) 2011-2015, 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.
]]--
if confighelp then
return
end
-- Phishing detection interface for selecting phished urls and inserting corresponding symbol
--
--
local N = 'phishing'
local symbol = 'PHISHED_URL'
local generic_service_symbol = 'PHISHED_GENERIC_SERVICE'
local openphish_symbol = 'PHISHED_OPENPHISH'
local phishtank_symbol = 'PHISHED_PHISHTANK'
local generic_service_name = 'generic service'
local domains = nil
local strict_domains = {}
local redirector_domains = {}
local generic_service_map = nil
local openphish_map = 'https://www.openphish.com/feed.txt'
local phishtank_suffix = 'phishtank.rspamd.com'
-- Not enabled by default as their feed is quite large
local openphish_premium = false
local phishtank_enabled = false
local generic_service_hash
local openphish_hash
local generic_service_data = {}
local openphish_data = {}
local rspamd_logger = require "rspamd_logger"
local util = require "rspamd_util"
local opts = rspamd_config:get_all_opt(N)
if not (opts and type(opts) == 'table') then
rspamd_logger.infox(rspamd_config, 'Module is unconfigured')
return
end
local function phishing_cb(task)
local function check_phishing_map(map, url, phish_symbol)
local host = url:get_host()
if host then
local elt = map[host]
local found_path = false
local found_query = false
local data = nil
if elt then
local path = url:get_path()
local query = url:get_query()
if path then
for _,d in ipairs(elt) do
if d['path'] == path then
found_path = true
data = d['data']
if query and d['query'] and query == d['query'] then
found_query = true
elseif not d['query'] then
found_query = true
end
end
end
else
for _,d in ipairs(elt) do
if not d['path'] then
found_path = true
end
if query and d['query'] and query == d['query'] then
found_query = true
elseif not d['query'] then
found_query = true
end
end
end
if found_path then
local args
if type(data) == 'table' then
args = {
data['tld'],
data['sector'],
data['brand'],
}
elseif type(data) == 'string' then
args = data
else
args = host
end
if found_query then
-- Query + path match
task:insert_result(phish_symbol, 1.0, args)
else
-- Host + path match
if path then
task:insert_result(phish_symbol, 0.3, args)
end
-- No path, no symbol
end
else
if url:is_phished() then
-- Only host matches
task:insert_result(phish_symbol, 0.1, host)
end
end
end
end
end
local function check_phishing_dns(dns_suffix, url, phish_symbol)
local function compose_dns_query(elts)
local cr = require "rspamd_cryptobox_hash"
local h = cr.create()
for _,elt in ipairs(elts) do h:update(elt) end
return string.format("%s.%s", h:base32():sub(1, 32), dns_suffix)
end
local r = task:get_resolver()
local host = url:get_host()
local path = url:get_path()
local query = url:get_query()
if host and path then
local function host_host_path_cb(_, _, results, err)
if not err and results then
task:insert_result(phish_symbol, 0.3, results)
end
end
r:resolve_a({
task = task,
name = compose_dns_query({host, path}),
callback = host_host_path_cb})
if query then
local function host_host_path_query_cb(_, _, results, err)
if not err and results then
task:insert_result(phish_symbol, 1.0, results)
end
end
r:resolve_a({
task = task,
name = compose_dns_query({host, path, query}),
callback = host_host_path_query_cb})
end
end
end
local urls = task:get_urls()
if urls then
for _,url in ipairs(urls) do
if generic_service_hash then
check_phishing_map(generic_service_data, url, generic_service_symbol)
end
if openphish_hash then
check_phishing_map(openphish_data, url, openphish_symbol)
end
if phishtank_enabled then
check_phishing_dns(phishtank_suffix, url, phishtank_symbol)
end
if url:is_phished() and not url:is_redirected() then
local purl = url:get_phished()
local tld = url:get_tld()
local ptld = purl:get_tld()
if not ptld or not tld then
return
end
-- Now we can safely remove the last dot component if it is the same
local b,_ = string.find(tld, '%.[^%.]+$')
local b1,_ = string.find(ptld, '%.[^%.]+$')
if b1 and b then
if string.sub(tld, b) == string.sub(ptld, b1) then
ptld = string.gsub(ptld, '%.[^%.]+$', '')
tld = string.gsub(tld, '%.[^%.]+$', '')
end
if #ptld == 0 or #tld == 0 then
return false
end
end
local weight = 1.0
local spoofed,why = util.is_utf_spoofed(tld, ptld)
if spoofed then
rspamd_logger.debugm(N, task, "confusable: %1 -> %2: %3", tld, ptld, why)
weight = 1.0
else
local dist = util.levenshtein_distance(tld, ptld, 2)
dist = 2 * dist / (#tld + #ptld)
if dist > 0.3 and dist <= 1.0 then
-- Use distance to penalize the total weight
weight = util.tanh(3 * (1 - dist + 0.1))
elseif dist > 1 then
-- We also check if two labels are in the same ascii/non-ascii representation
local a1, a2 = false,false
if string.match(tld, '^[\001-\127]*$') then a1 = true end
if string.match(ptld, '^[\001-\127]*$') then a2 = true end
if a1 ~= a2 then
weight = 1
rspamd_logger.debugm(N, task, "confusable: %1 -> %2: different characters",
tld, ptld, why)
else
-- We have totally different strings in tld, so penalize it significantly
if dist > 2 then dist = 2 end
weight = util.tanh((2 - dist) * 0.5)
end
end
rspamd_logger.debugm(N, task, "distance: %1 -> %2: %3", tld, ptld, dist)
end
local function found_in_map(map, furl, sweight)
if not furl then furl = url end
if not sweight then sweight = weight end
if #map > 0 then
for _,rule in ipairs(map) do
for _,dn in ipairs({furl:get_tld(), furl:get_host()}) do
if rule['map']:get_key(dn) then
task:insert_result(rule['symbol'], sweight, ptld .. '->' .. dn)
return true
end
end
end
end
end
if not found_in_map(redirector_domains) then
if not found_in_map(strict_domains, purl, 1.0) then
if domains then
if domains:get_key(ptld) then
task:insert_result(symbol, weight, ptld .. '->' .. tld)
end
else
task:insert_result(symbol, weight, ptld .. '->' .. tld)
end
end
end
end
end
end
end
local function phishing_map(mapname, phishmap, id)
if opts[mapname] then
local xd = {}
if type(opts[mapname]) == 'table' then
xd = opts[mapname]
else
xd[1] = opts[mapname]
end
local found_maps = {}
for _,d in ipairs(xd) do
local s = string.find(d, ':[^:]+$')
if s then
local sym = string.sub(d, s + 1, -1)
local map = string.sub(d, 1, s - 1)
if found_maps[sym] then
table.insert(found_maps[sym], map)
else
found_maps[sym] = {map}
end
else
rspamd_logger.infox(rspamd_config, mapname .. ' option must be in format <map>:<symbol>')
end
end
for sym,urls in pairs(found_maps) do
local rmap = rspamd_config:add_map ({
type = 'set',
url = urls,
description = 'Phishing ' .. mapname .. ' map',
})
if rmap then
rspamd_config:register_virtual_symbol(sym, 1, id)
local rule = {symbol = sym, map = rmap}
table.insert(phishmap, rule)
else
rspamd_logger.infox(rspamd_config, 'cannot add map: %s for symbol: %s',
table.concat(urls, ";"), sym)
end
end
end
end
local function rspamd_str_split_fun(s, sep, func)
local lpeg = require "lpeg"
sep = lpeg.P(sep)
local elem = lpeg.P((1 - sep)^0 / func)
local p = lpeg.P(elem * (sep * elem)^0)
return p:match(s)
end
local function insert_url_from_string(pool, tbl, str, data)
local rspamd_url = require "rspamd_url"
local u = rspamd_url.create(pool, str)
if u then
local host = u:get_host()
if host then
local elt = {
data = data,
path = u:get_path(),
query = u:get_query()
}
if tbl[host] then
table.insert(tbl[host], elt)
else
tbl[host] = {elt}
end
return true
end
end
return false
end
local function generic_service_plain_cb(string)
local nelts = 0
local new_data = {}
local rspamd_mempool = require "rspamd_mempool"
local pool = rspamd_mempool.create()
local function generic_service_elt_parser(cap)
if insert_url_from_string(pool, new_data, cap, nil) then
nelts = nelts + 1
end
end
rspamd_str_split_fun(string, '\n', generic_service_elt_parser)
generic_service_data = new_data
rspamd_logger.infox(generic_service_hash, "parsed %s elements from %s feed",
nelts, generic_service_name)
pool:destroy()
end
local function openphish_json_cb(string)
local ucl = require "ucl"
local rspamd_mempool = require "rspamd_mempool"
local nelts = 0
local new_json_map = {}
local valid = true
local pool = rspamd_mempool.create()
local function openphish_elt_parser(cap)
if valid then
local parser = ucl.parser()
local res,err = parser:parse_string(cap)
if not res then
valid = false
rspamd_logger.warnx(openphish_hash, 'cannot parse openphish map: ' .. err)
else
local obj = parser:get_object()
if obj['url'] then
if insert_url_from_string(pool, new_json_map, obj['url'], obj) then
nelts = nelts + 1
end
end
end
end
end
rspamd_str_split_fun(string, '\n', openphish_elt_parser)
if valid then
openphish_data = new_json_map
rspamd_logger.infox(openphish_hash, "parsed %s elements from openphish feed",
nelts)
end
pool:destroy()
end
local function openphish_plain_cb(string)
local nelts = 0
local new_data = {}
local rspamd_mempool = require "rspamd_mempool"
local pool = rspamd_mempool.create()
local function openphish_elt_parser(cap)
if insert_url_from_string(pool, new_data, cap, nil) then
nelts = nelts + 1
end
end
rspamd_str_split_fun(string, '\n', openphish_elt_parser)
openphish_data = new_data
rspamd_logger.infox(openphish_hash, "parsed %s elements from openphish feed",
nelts)
pool:destroy()
end
if opts then
local id
if opts['symbol'] then
symbol = opts['symbol']
-- Register symbol's callback
id = rspamd_config:register_symbol({
name = symbol,
callback = phishing_cb
})
if opts['generic_service_symbol'] then
generic_service_symbol = opts['generic_service_symbol']
end
if opts['generic_service_map'] then
generic_service_map = opts['generic_service_map']
end
if opts['generic_service_url'] then
generic_service_map = opts['generic_service_url']
end
if opts['generic_service_name'] then
generic_service_name = opts['generic_service_name']
end
if opts['generic_service_enabled'] then
generic_service_hash = rspamd_config:add_map({
type = 'callback',
url = generic_service_map,
callback = generic_service_plain_cb,
description = 'Generic feed'
})
end
if opts['openphish_map'] then
openphish_map = opts['openphish_map']
end
if opts['openphish_url'] then
openphish_map = opts['openphish_url']
end
if opts['openphish_premium'] then
openphish_premium = true
end
if opts['openphish_enabled'] then
if not openphish_premium then
openphish_hash = rspamd_config:add_map({
type = 'callback',
url = openphish_map,
callback = openphish_plain_cb,
description = 'Open phishing feed map (see https://www.openphish.com for details)'
})
else
openphish_hash = rspamd_config:add_map({
type = 'callback',
url = openphish_map,
callback = openphish_json_cb,
description = 'Open phishing premium feed map (see https://www.openphish.com for details)'
})
end
end
if opts['phishtank_enabled'] then
phishtank_enabled = true
if opts['phishtank_suffix'] then
phishtank_suffix = opts['phishtank_suffix']
end
end
rspamd_config:register_symbol({
type = 'virtual',
parent = id,
name = generic_service_symbol,
})
rspamd_config:register_symbol({
type = 'virtual',
parent = id,
name = openphish_symbol,
})
rspamd_config:register_symbol({
type = 'virtual',
parent = id,
name = phishtank_symbol,
})
end
if opts['domains'] and type(opts['domains']) == 'string' then
domains = rspamd_config:add_map({
url = opts['domains'],
type = 'set',
description = 'Phishing domains'
})
end
phishing_map('strict_domains', strict_domains, id)
phishing_map('redirector_domains', redirector_domains, id)
end
|