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
|
--[[
Copyright (c) 2019, 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.
]]--
--[[[
-- @module lua_settings
-- This module contains internal helpers for the settings infrastructure in Rspamd
-- More details at https://rspamd.com/doc/configuration/settings.html
--]]
local exports = {}
local known_ids = {}
local on_load_added = false
local function register_settings_cb()
for _,set in pairs(known_ids) do
local s = set.settings
local enabled_symbols = {}
local disabled_symbols = {}
-- Enabled map
if s.symbols_enabled then
for _,sym in ipairs(s.symbols_enabled) do
enabled_symbols[sym] = true
end
end
if s.groups_enabled then
for _,gr in ipairs(s.groups_enabled) do
local syms = rspamd_config:get_group_symbols()
if syms then
for _,sym in ipairs(syms) do
enabled_symbols[sym] = true
end
end
end
end
-- Disabled map
if s.symbols_disabled then
for _,sym in ipairs(s.symbols_disabled) do
disabled_symbols[sym] = true
end
end
if s.groups_disabled then
for _,gr in ipairs(s.groups_disabled) do
local syms = rspamd_config:get_group_symbols()
if syms then
for _,sym in ipairs(syms) do
disabled_symbols[sym] = true
end
end
end
end
rspamd_config:register_settings_id(set.name, enabled_symbols, disabled_symbols)
-- Remove to avoid clash
s.symbols_disabled = nil
s.symbols_enabled = nil
s.groups_enabled = nil
s.groups_disabled = nil
end
end
-- Returns numeric representation of the settings id
local function numeric_settings_id(str)
local cr = require "rspamd_cryptobox_hash"
local util = require "rspamd_util"
local ret = util.unpack("I4",
cr.create_specific('xxh64'):update(str):bin())
return ret
end
local function register_settings_id(str, settings)
local numeric_id = numeric_settings_id(str)
if known_ids[numeric_id] then
-- Might be either rewrite or a collision
if known_ids[numeric_id].name ~= str then
local logger = require "rspamd_logger"
logger.errx(rspamd_config, 'settings ID clash! id %s maps to %s and conflicts with %s',
numeric_id, known_ids[numeric_id].name, str)
return nil
end
else
known_ids[numeric_id] = {
name = str,
settings = settings
}
end
if not on_load_added then
rspamd_config:add_on_load(register_settings_cb)
on_load_added = true
end
return numeric_id
end
exports.register_settings_id = register_settings_id
local function settings_by_id(id)
return known_ids[id]
end
exports.settings_by_id = settings_by_id
return exports
|