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
|
--[[
Copyright (c) 2018, 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.
]]--
local argparse = require "argparse"
local ansicolors = require "ansicolors"
--local rspamd_util = require "rspamd_util"
local rspamd_task = require "rspamd_task"
local rspamd_logger = require "rspamd_logger"
local lua_meta = require "lua_meta"
local rspamd_url = require "rspamd_url"
local lua_util = require "lua_util"
local ucl = require "ucl"
-- Define command line options
local parser = argparse()
:name "rspamadm mime"
:description "Mime manipulations provided by Rspamd"
:help_description_margin(30)
:command_target("command")
:require_command(true)
parser:option "-c --config"
:description "Path to config file"
:argname("<cfg>")
:default(rspamd_paths["CONFDIR"] .. "/" .. "rspamd.conf")
parser:mutex(
parser:flag "-j --json"
:description "JSON output",
parser:flag "-U --ucl"
:description "UCL output"
)
parser:flag "-C --compact"
:description "Use compactl format"
parser:flag "--no-file"
:description "Do not print filename"
-- Extract subcommand
local extract = parser:command "extract ex e"
:description "Extracts data from MIME messages"
extract:argument "file"
:description "File to process"
:argname "<file>"
:args "+"
extract:flag "-t --text"
:description "Extracts plain text data from a message"
extract:flag "-H --html"
:description "Extracts htm data from a message"
extract:option "-o --output"
:description "Output format ('raw', 'content', 'oneline', 'decoded', 'decoded_utf')"
:argname("<type>")
:convert {
raw = "raw",
content = "content",
oneline = "content_oneline",
decoded = "raw_parsed",
decoded_utf = "raw_utf"
}
:default "content"
extract:flag "-w --words"
:description "Extracts words"
extract:flag "-p --part"
:description "Show part info"
extract:flag "-s --structure"
:description "Show structure info (e.g. HTML tags)"
local stat = parser:command "stat st s"
:description "Extracts statistical data from MIME messages"
stat:argument "file"
:description "File to process"
:argname "<file>"
:args "+"
stat:mutex(
stat:flag "-m --meta"
:description "Lua metatokens",
stat:flag "-b --bayes"
:description "Bayes tokens",
stat:flag "-F --fuzzy"
:description "Fuzzy hashes"
)
local urls = parser:command "urls url u"
:description "Extracts URLs from MIME messages"
urls:argument "file"
:description "File to process"
:argname "<file>"
:args "+"
urls:mutex(
urls:flag "-t --tld"
:description "Get TLDs only",
urls:flag "-H --host"
:description "Get hosts only"
)
urls:flag "-u --unique"
:description "Print only unique urls"
urls:flag "-s --sort"
:description "Sort output"
urls:flag "--count"
:description "Print count of each printed element"
urls:flag "-r --reverse"
:description "Reverse sort order"
local function load_config(opts)
local _r,err = rspamd_config:load_ucl(opts['config'])
if not _r then
rspamd_logger.errx('cannot parse %s: %s', opts['config'], err)
os.exit(1)
end
_r,err = rspamd_config:parse_rcl({'logging', 'worker'})
if not _r then
rspamd_logger.errx('cannot process %s: %s', opts['config'], err)
os.exit(1)
end
end
local function load_task(opts, fname)
if not fname then
parser:error('no file specified')
end
local res,task = rspamd_task.load_from_file(fname, rspamd_config)
if not res then
parser:error(string.format('cannot read message from %s: %s', fname,
task))
end
if not task:process_message() then
parser:error(string.format('cannot read message from %s: %s', fname,
'failed to parse'))
end
return task
end
local function highlight(fmt, ...)
return ansicolors.white .. string.format(fmt, ...) .. ansicolors.reset
end
local function maybe_print_fname(opts, fname)
if not opts.json and not opts['no-file'] then
rspamd_logger.messagex(highlight('File: %s', fname))
end
end
-- Print elements in form
-- filename -> table of elements
local function print_elts(elts, opts, func)
local fun = require "fun"
if opts.json or opts.ucl then
local fmt = 'json'
if opts.compact then fmt = 'json-compact' end
if opts.ucl then fmt = 'ucl' end
io.write(ucl.to_format(elts, fmt))
else
fun.each(function(fname, elt)
if not opts.json and not opts.ucl then
if func then
elt = fun.map(func, elt)
end
maybe_print_fname(opts, fname)
fun.each(function(e)
io.write(e)
io.write("\n")
end, elt)
end
end, elts)
end
end
local function extract_handler(opts)
local out_elts = {}
local process_func
if opts.words then
-- Enable stemming
rspamd_config:init_subsystem('langdet')
end
local function maybe_print_part_info(part, out)
local fun = require "fun"
if opts.part then
local t = 'plain text'
if part:is_html() then
t = 'html'
end
if not opts.json and not opts.ucl then
table.insert(out,
rspamd_logger.slog('Part: %s: %s, language: %s, size: %s (%s raw), words: %s',
part:get_mimepart():get_digest():sub(1,8),
t,
part:get_language(),
part:get_length(), part:get_raw_length(),
part:get_words_count()))
table.insert(out,
rspamd_logger.slog('Stats: %s',
fun.foldl(function(acc, k, v)
if acc ~= '' then
return string.format('%s, %s:%s', acc, k, v)
else
return string.format('%s:%s', k,v)
end
end, '', part:get_stats())))
table.insert(out, '\n')
end
end
end
for _,fname in ipairs(opts.file) do
local task = load_task(opts, fname)
out_elts[fname] = {}
if not opts.text and not opts.html then
opts.text = true
opts.html = true
end
if opts.text or opts.html then
local tp = task:get_text_parts() or {}
for _,part in ipairs(tp) do
local how = opts.output
if opts.text and not part:is_html() then
maybe_print_part_info(part, out_elts[fname])
if opts.words then
table.insert(out_elts[fname], table.concat(part:get_words(), ' '))
else
table.insert(out_elts[fname], tostring(part:get_content(how)))
end
elseif opts.html and part:is_html() then
maybe_print_part_info(part, out_elts[fname])
if opts.words then
table.insert(out_elts[fname], table.concat(part:get_words(), ' '))
else
if opts.structure then
local hc = part:get_html()
local res = {}
process_func = function(k, v)
return rspamd_logger.slog("%s = %s", k, v)
end
hc:foreach_tag('any', function(tag)
local elt = {}
local ex = tag:get_extra()
elt.tag = tag:get_type()
if ex then
elt.extra = ex
end
local content = tag:get_content()
if content then
elt.content = content
end
table.insert(res, elt)
end)
out_elts[fname] = res
else
table.insert(out_elts[fname], tostring(part:get_content(how)))
end
end
end
end
end
table.insert(out_elts[fname], "")
task:destroy() -- No automatic dtor
end
print_elts(out_elts, opts, process_func)
end
local function stat_handler(opts)
local fun = require "fun"
local out_elts = {}
load_config(opts)
rspamd_url.init(rspamd_config:get_tld_path())
rspamd_config:init_subsystem('langdet,stat') -- Needed to gen stat tokens
local process_func
for _,fname in ipairs(opts.file) do
local task = load_task(opts, fname)
out_elts[fname] = {}
if opts.meta then
local mt = lua_meta.gen_metatokens_table(task)
out_elts[fname] = mt
process_func = function(k, v)
return string.format("%s = %s", k, v)
end
elseif opts.bayes then
local bt = task:get_stat_tokens()
out_elts[fname] = bt
process_func = function(e)
return string.format('%s (%d): "%s"+"%s", [%s]', e.data, e.win, e.t1 or "",
e.t2 or "", table.concat(fun.totable(
fun.map(function(k) return k end, e.flags)), ","))
end
end
task:destroy() -- No automatic dtor
end
print_elts(out_elts, opts, process_func)
end
local function urls_handler(opts)
load_config(opts)
rspamd_url.init(rspamd_config:get_tld_path())
local out_elts = {}
if opts.json then rspamd_logger.messagex('[') end
for _,fname in ipairs(opts.file) do
out_elts[fname] = {}
local task = load_task(opts, fname)
local elts = {}
local function process_url(u)
local s
if opts.tld then
s = u:get_tld()
elseif opts.host then
s = u:get_host()
else
s = u:get_text()
end
if opts.unique then
if elts[s] then
elts[s].count = elts[s].count + 1
else
elts[s] = {
count = 1,
url = u:to_table()
}
end
else
if opts.json then
table.insert(elts, u)
else
table.insert(elts, s)
end
end
end
for _,u in ipairs(task:get_urls(true)) do
process_url(u)
end
local json_elts = {}
local function process_elt(s, u)
if opts.unique then
-- s is string, u is {url = url, count = count }
if not opts.json then
if opts.count then
table.insert(json_elts, string.format('%s : %s', s, u.count))
else
table.insert(json_elts, s)
end
else
local tb = u.url
tb.count = u.count
table.insert(json_elts, tb)
end
else
-- s is index, u is url or string
if opts.json then
table.insert(json_elts, u)
else
table.insert(json_elts, u)
end
end
end
if opts.sort then
local sfunc
if opts.unique then
sfunc = function(t, a, b)
if t[a].count ~= t[b].count then
if opts.reverse then
return t[a].count > t[b].count
else
return t[a].count < t[b].count
end
else
-- Sort lexicography
if opts.reverse then
return a > b
else
return a < b
end
end
end
else
sfunc = function(t, a, b)
local va, vb
if opts.json then
va = t[a]:get_text()
vb = t[b]:get_text()
else
va = t[a]
vb = t[b]
end
if opts.reverse then
return va > vb
else
return va < vb
end
end
end
for s,u in lua_util.spairs(elts, sfunc) do
process_elt(s, u)
end
else
for s,u in pairs(elts) do
process_elt(s, u)
end
end
out_elts[fname] = json_elts
task:destroy() -- No automatic dtor
end
print_elts(out_elts, opts)
end
local function handler(args)
local opts = parser:parse(args)
local command = opts.command
if type(opts.file) == 'string' then
opts.file = {opts.file}
elseif type(opts.file) == 'none' then
opts.file = {}
end
if command == 'extract' then
extract_handler(opts)
elseif command == 'stat' then
stat_handler(opts)
elseif command == 'urls' then
urls_handler(opts)
else
parser:error('command %s is not implemented', command)
end
end
return {
name = 'mime',
aliases = {'mime_tool'},
handler = handler,
description = parser._description
}
|