summaryrefslogtreecommitdiffstats
path: root/src/plugins/lua/emails.lua
blob: 0e7705c5faccddd1b1b3b3be63d0692d9c5357e2 (plain)
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
-- Emails is module for different checks for emails inside messages

-- Rules format:
-- symbol = sym, map = file:///path/to/file, domain_only = yes
-- symbol = sym2, dnsbl = bl.somehost.com, domain_only = no
local rules = {}

function split(str, delim, maxNb)
	-- Eliminate bad cases...
	if string.find(str, delim) == nil then
		return { str }
	end
	if maxNb == nil or maxNb < 1 then
		maxNb = 0    -- No limit
	end
	local result = {}
	local pat = "(.-)" .. delim .. "()"
	local nb = 0
	local lastPos
	for part, pos in string.gmatch(str, pat) do
		nb = nb + 1
		result[nb] = part
		lastPos = pos
		if nb == maxNb then break end
	end
	-- Handle the last field
	if nb ~= maxNb then
		result[nb + 1] = string.sub(str, lastPos)
	end
	return result
end

function emails_dns_cb(task, to_resolve, results, err, symbol)
	if results then
		rspamd_logger.info(string.format('<%s> email: [%s] resolved for symbol: %s', task:get_message():get_message_id(), to_resolve, symbol))
		task:insert_result(symbol, 1)
	end
end

-- Check rule for a single email
function check_email_rule(task, rule, addr)
	if rule['dnsbl'] then
		local to_resolve = ''
		if rule['domain_only'] then
			to_resolve = string.format('%s.%s', addr:get_host(), rule['dnsbl'])
		else
			to_resolve = string.format('%s.%s.%s', addr:get_user(), addr:get_host(), rule['dnsbl'])
		end
		task:resolve_dns_a(to_resolve, 'emails_dns_cb', rule['symbol'])
	elseif rule['map'] then
		if rule['domain_only'] then
			local key = addr:get_host()
			if rule['map']:get_key(key) then
				task:insert_result(rule['symbol'], 1)
				rspamd_logger.info(string.format('<%s> email: \'%s\' is found in list: %s', task:get_message():get_message_id(), key, rule['symbol']))
			end
		else
			local key = string.format('%s@%s', addr:get_user(), addr:get_host())
			if rule['map']:get_key(key) then
				task:insert_result(rule['symbol'], 1)
				rspamd_logger.info(string.format('<%s> email: \'%s\' is found in list: %s', task:get_message():get_message_id(), key, rule['symbol']))
			end
		end
	end
end

-- Check email
function check_emails(task)
	local emails = task:get_emails()
	local checked = {}
	if emails then
		for _,addr in ipairs(emails) do
			local to_check = string.format('%s@%s', addr:get_user(), addr:get_host())
			if not checked['to_check'] then
				for _,rule in ipairs(rules) do
					check_email_rule(task, rule, addr)
				end
				checked[to_check] = true
			end 
		end
	end
end

-- Add rule to ruleset
local function add_emails_rule(key, obj)
	local newrule = {
		name = nil,
		dnsbl = nil,
		map = nil,
		domain_only = false,
		symbol = k
	}
	for name,value in pairs(obj) do
		if name == 'dnsbl' then
			newrule['dnsbl'] = value
			newrule['name'] = value
		elseif name == 'map' then
			newrule['name'] = value
			newrule['map'] = rspamd_config:add_hash_map (newrule['name'])
		elseif name == 'symbol' then
			newrule['symbol'] = value
		elseif name == 'domain_only' then
			if value == 'yes' or value == 'true' or value == '1' then
				newrule['domain_only'] = true
			end
		else	
			rspamd_logger.err('invalid rule option: '.. name)
			return nil
		end

	end
	if not newrule['symbol'] or (not newrule['map'] and not newrule['dnsbl']) then
		rspamd_logger.err('incomplete rule')
		return nil
	end
	table.insert(rules, newrule)
	return newrule
end


-- Registration
if type(rspamd_config.get_api_version) ~= 'nil' then
	if rspamd_config:get_api_version() >= 2 then
		rspamd_config:register_module_option('emails', 'rule', 'string')
	else
		rspamd_logger.err('Invalid rspamd version for this plugin')
	end
end

local opts =  rspamd_config:get_all_opt('emails')
if opts then
	for k,m in pairs(opts) do
		if type(m) ~= 'table' then
			rspamd_logger.err('parameter ' .. k .. ' is invalid, must be an object')
		else
			local rule = add_emails_rule(k, m)
			if not rule then
				rspamd_logger.err('cannot add rule: "'..k..'"')
			else
				if type(rspamd_config.get_api_version) ~= 'nil' then
					rspamd_config:register_virtual_symbol(m['symbol'], 1.0)
				end
			end
		end
	end
end

if table.maxn(rules) > 0 then
	-- add fake symbol to check all maps inside a single callback
	if type(rspamd_config.get_api_version) ~= 'nil' then
		rspamd_config:register_callback_symbol('EMAILS', 1.0, 'check_emails')
	else
		rspamd_config:register_symbol('EMAILS', 1.0, 'check_emails')
	end
end