/*- * Copyright 2016 Vsevolod Stakhov * * 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. */ #include "lua_common.h" #include "libmime/message.h" #include "libutil/expression.h" #include "libserver/composites.h" #include "libmime/lang_detection.h" #include "lua/lua_map.h" #include "utlist.h" #include /*** * This module is used to configure rspamd and is normally available as global * variable named `rspamd_config`. Unlike other modules, it is not necessary to * require it before usage. * @module rspamd_config * @example -- Register some callback symbol local function foo(task) -- do something end rspamd_config:register_symbol('SYMBOL', 1.0, foo) -- Get configuration local tab = rspamd_config:get_all_opt('module') -- get table for module's options local opts = rspamd_config:get_key('options') -- get content of the specified key in rspamd configuration */ /* Config file methods */ /*** * @method rspamd_config:get_module_opt(mname, optname) * Returns value of specified option `optname` for a module `mname`, * @param {string} mname name of module * @param {string} optname option to get * @return {string or table} value of the option or `nil` if option is not found */ LUA_FUNCTION_DEF (config, get_module_opt); /*** * @method rspamd_config:get_all_opt(mname) * Returns value of all options for a module `mname`, flattening values into a single table consisting * of all sections with such a name. * @param {string} mname name of module * @return {table} table of all options for `mname` or `nil` if a module's configuration is not found */ LUA_FUNCTION_DEF (config, get_all_opt); /*** * @method rspamd_config:get_ucl() * Returns full configuration as a native Lua object (ucl to lua conversion). * This method uses caching if possible. * @return {table} table of all options in the configuration */ LUA_FUNCTION_DEF (config, get_ucl); /*** * @method rspamd_config:get_mempool() * Returns static configuration memory pool. * @return {mempool} [memory pool](mempool.md) object */ LUA_FUNCTION_DEF (config, get_mempool); /*** * @method rspamd_config:get_resolver() * Returns DNS resolver. * @return {dns_resolver} opaque DNS resolver pointer if any */ LUA_FUNCTION_DEF (config, get_resolver); /*** * @method rspamd_config:add_radix_map(mapline[, description]) * Creates new dynamic map of IP/mask addresses. * @param {string} mapline URL for a map * @param {string} description optional map description * @return {map} radix tree object * @example local ip_map = rspamd_config:add_radix_map ('file:///path/to/file', 'my radix map') ... local function foo(task) local ip = task:get_from_ip() if ip_map:get_key(ip) then return true end return false end */ /*** * @method rspamd_config:radix_from_config(mname, optname) * Creates new embedded map of IP/mask addresses from config. * @param {string} mname name of module * @param {string} optname option to get * @return {map} radix tree object * @example local ip_map = rspamd_config:radix_from_config ('mymodule', 'ips') ... local function foo(task) local ip = task:get_from_ip() if ip_map:get_key(ip) then return true end return false end */ /*** * @method rspamd_config:radix_from_ucl(obj) * Creates new embedded map of IP/mask addresses from object. * @param {ucl} obj object * @return {map} radix tree object */ /*** * @method rspamd_config:add_hash_map(mapline[, description]) * Creates new dynamic map string objects. * @param {string} mapline URL for a map * @param {string} description optional map description * @return {map} hash set object * @example local hash_map = rspamd_config:add_hash_map ('file:///path/to/file', 'my hash map') ... local function foo(task) local from = task:get_from() if hash_map:get_key(from['user']) then return true end return false end */ /*** * @method rspamd_config:add_kv_map(mapline[, description]) * Creates new dynamic map of key/values associations. * @param {string} mapline URL for a map * @param {string} description optional map description * @return {map} hash table object * @example local kv_map = rspamd_config:add_kv_map ('file:///path/to/file', 'my kv map') ... local function foo(task) local from = task:get_from() if from then local value = kv_map:get_key(from['user']) if value then return true,value end end return false end */ /*** * @method rspamd_config:add_map({args}) * Creates new dynamic map according to the attributes passed. * * - `type`: type of map to be created, can be one of the following set: * + `set`: set of strings * + `radix`: map of IP addresses to strings * + `map`: map of strings to strings * + `regexp`: map of regexps to strings * + `callback`: map processed by lua callback * - `url`: url to load map from * - `description`: map's description * - `callback`: lua callback for the map * * @return {map} `true` if map has been added * @example local str = '' local function process_map(in) str = in end rspamd_config:add_map('http://example.com/map', "settings map", process_map) */ /*** * @method rspamd_config:get_maps() * Get all maps defined as an array of rspamd{map} objects * * @return {table|rspamd{map}} */ /*** * @method rspamd_config:get_classifier(name) * Returns classifier config. * @param {string} name name of classifier (e.g. `bayes`) * @return {classifier} classifier object or `nil` */ LUA_FUNCTION_DEF (config, get_classifier); /*** * @method rspamd_config:register_symbol(table) * Register symbol of a specified type in rspamd. This function accepts table of arguments: * * - `name`: name of symbol (can be missing for callback symbols) * - `callback`: function to be called for symbol's check (can be absent for virtual symbols) * - `weight`: weight of symbol (should normally be 1 or missing) * - `priority`: priority of symbol (normally 0 or missing) * - `type`: type of symbol: `normal` (default), `virtual` or `callback` * - `flags`: various flags split by commas or spaces: * + `nice` if symbol can produce negative score; * + `empty` if symbol can be called for empty messages * + `skip` if symbol should be skipped now * + `nostat` if symbol should be excluded from stat tokens * + `trivial` symbol is trivial (e.g. no network requests) * - `parent`: id of parent symbol (useful for virtual symbols) * * @return {number} id of symbol registered */ LUA_FUNCTION_DEF (config, register_symbol); /*** * @method rspamd_config:register_symbols(callback, [weight], callback_name, [, symbol, ...]) * Register callback function to be called for a set of symbols with initial weight. * @param {function} callback callback function to be called for a specified symbol * @param {number} weight initial weight of symbol (can be less than zero to specify non-spam symbols) * @param {string} callback_name symbolic name of callback * @param {list of strings} symbol list of symbols registered by this function */ LUA_FUNCTION_DEF (config, register_symbols); /*** * @method rspamd_config:register_virtual_symbol(name, weight,) * Register virtual symbol that is not associated with any callback. * * **This method is deprecated and should not be used in newly written code ** * @param {string} virtual name symbol's name * @param {number} weight initial weight of symbol (can be less than zero to specify non-spam symbols) */ LUA_FUNCTION_DEF (config, register_virtual_symbol); /*** * @method rspamd_config:register_callback_symbol(name, weight, callback) * Register callback function to be called for a specified symbol with initial weight. Symbol itself is * not registered in the metric and is not intended to be visible by a user. * * **This method is deprecated and should not be used in newly written code ** * @param {string} name symbol's name (just for unique id purposes) * @param {number} weight initial weight of symbol (can be less than zero to specify non-spam symbols) * @param {function} callback callback function to be called for a specified symbol */ LUA_FUNCTION_DEF (config, register_callback_symbol); LUA_FUNCTION_DEF (config, register_callback_symbol_priority); /*** * @method rspamd_config:register_dependency(id, dep) * Create a dependency between symbol identified by `id` and a symbol identified * by some symbolic name `dep` * @param {number|string} id id or name of source (numeric id is returned by all register_*_symbol) * @param {string} dep dependency name * @example local function cb(task) ... end local id = rspamd_config:register_symbol('SYM', 1.0, cb) rspamd_config:register_dependency(id, 'OTHER_SYM') -- Alternative form rspamd_config:register_dependency('SYMBOL_FROM', 'SYMBOL_TO') */ LUA_FUNCTION_DEF (config, register_dependency); /** * @method rspamd_config:set_symbol({table}) * Sets the value of a specified symbol in a metric. This function accepts table with the following elements: * * - `name`: name of symbol (string) * - `score`: score for symbol (number) * - `metric`: name of metric (string, optional) * - `description`: description of symbol (string, optional) * - `group`: name of group for symbol (string, optional) * - `one_shot`: turn off multiple hits for a symbol (boolean, optional) * - `one_param`: turn off multiple options for a symbol (boolean, optional) * - `flags`: comma separated string of flags: * + `ignore`: do not strictly check validity of symbol and corresponding rule * + `one_shot`: turn off multiple hits for a symbol * + `one_param`: allow only one parameter for a symbol * - `priority`: priority of symbol's definition */ LUA_FUNCTION_DEF (config, set_metric_symbol); /** * @method rspamd_config:set_action({table}) * Sets the score of a specified action in a metric. This function accepts table with the following elements: * * - `action`: name of action (string) * - `score`: score for action (number) * - `metric`: name of metric (string, optional) * - `priority`: priority of action's definition */ LUA_FUNCTION_DEF (config, set_metric_action); /** * @method rspamd_config:get_symbol(name) * Gets metric data for a specific symbol identified by `name`: * * - `score`: score for symbol (number) * - `description`: description of symbol (string, optional) * - `group`: name of group for symbol (string, optional) * - `one_shot`: turn off multiple hits for a symbol (boolean, optional) * - `flags`: comma separated string of flags: * + `ignore`: do not strictly check validity of symbol and corresponding rule * + `one_shot`: turn off multiple hits for a symbol * * @param {string} name name of symbol * @return {table} symbol's definition or nil in case of undefined symbol */ LUA_FUNCTION_DEF (config, get_metric_symbol); /** * @method rspamd_config:get_action(name) * Gets data for a specific action in config. This function returns number reperesenting action's score * * @param {string} name name of action * @return {number} action's score or nil in case of undefined score or action */ LUA_FUNCTION_DEF (config, get_metric_action); /** * @method rspamd_config:get_all_actions() * Gets data for all action in config * @return {table|str->num} action's score or nil in case of undefined score or action */ LUA_FUNCTION_DEF (config, get_all_actions); /** * @method rspamd_config:add_composite(name, expression) * @param {string} name name of composite symbol * @param {string} expression symbolic expression of the composite rule * @return {bool} true if a composite has been added successfully */ LUA_FUNCTION_DEF (config, add_composite); /*** * @method rspamd_config:register_pre_filter(callback[, order]) * Register function to be called prior to symbols processing. * @param {function} callback callback function * @param {number} order filters are called from lower orders to higher orders, order is equal to 0 by default * @example local function check_function(task) -- It is possible to manipulate the task object here: set settings, set pre-action and so on ... end rspamd_config:register_pre_filter(check_function) */ LUA_FUNCTION_DEF (config, register_pre_filter); /*** * @method rspamd_config:register_post_filter(callback[, order]) * Register function to be called after symbols are processed. * * @param {function} callback callback function * @param {number} order filters are called from lower orders to higher orders, order is equal to 0 by default */ LUA_FUNCTION_DEF (config, register_post_filter); /* XXX: obsoleted */ LUA_FUNCTION_DEF (config, register_module_option); /* XXX: not needed now */ LUA_FUNCTION_DEF (config, get_api_version); /*** * @method rspamd_config:get_key(name) * Returns configuration section with the specified `name`. * @param {string} name name of config section * @return {variant} specific value of section * @example local set_section = rspamd_config:get_key("settings") if type(set_section) == "string" then -- Just a map of ucl if rspamd_config:add_map(set_section, "settings map", process_settings_map) then rspamd_config:register_pre_filter(check_settings) end elseif type(set_section) == "table" then if process_settings_table(set_section) then rspamd_config:register_pre_filter(check_settings) end end */ LUA_FUNCTION_DEF (config, get_key); /*** * @method rspamd_config:add_condition(symbol, condition) * Adds condition callback for specified symbol * @param {string} symbol symbol's name * @param {function} condition condition callback * @return {boolean} true if condition has been added * @example rspamd_config:add_condition('FUZZY_DENIED', function(task) if some_map:find_key(task:get_from()) then return false end return true end) */ LUA_FUNCTION_DEF (config, add_condition); /*** * @method rspamd_config:enable_symbol(symbol) * Enables execution for the specified symbol * @param {string} symbol symbol's name */ LUA_FUNCTION_DEF (config, enable_symbol); /*** * @method rspamd_config:disable_symbol(symbol) * Disables execution for the specified symbol * @param {string} symbol symbol's name */ LUA_FUNCTION_DEF (config, disable_symbol); /*** * @method rspamd_config:__newindex(name, callback) * This metamethod is called if new indicies are added to the `rspamd_config` object. * Technically, it is the equivalent of @see rspamd_config:register_symbol where `weight` is 1.0. * There is also table form invocation that allows to control more things: * * - `callback`: has the same meaning and acts as function of task * - `score`: default score for a symbol * - `group`: default group for a symbol * - `description`: default symbol's description * - `priority`: additional priority value * - `one_shot`: default value for one shot attribute * - `condition`: function of task that can enable or disable this specific rule's execution * @param {string} name index name * @param {function/table} callback callback to be called * @return {number} id of the new symbol added * @example rspamd_config.R_EMPTY_IMAGE = function (task) parts = task:get_text_parts() if parts then for _,part in ipairs(parts) do if part:is_empty() then images = task:get_images() if images then -- Symbol `R_EMPTY_IMAGE` is inserted return true end return false end end end return false end rspamd_config.SYMBOL = { callback = function(task) ... end, score = 5.1, description = 'sample symbol', group = 'sample symbols', condition = function(task) if task:get_from()[1]['addr'] == 'user@example.com' then return false end return true end } */ LUA_FUNCTION_DEF (config, newindex); /*** * @method rspamd_config:register_regexp(params) * Registers new re for further cached usage * Params is the table with the following fields (mandatory fields are marked with `*`): * - `re`* : regular expression object * - `type`*: type of regular expression: * + `mime`: mime regexp * + `rawmime`: raw mime regexp * + `header`: header regexp * + `rawheader`: raw header expression * + `body`: raw body regexp * + `url`: url regexp * - `header`: for header and rawheader regexp means the name of header * - `pcre_only`: flag regexp as pcre only regexp */ LUA_FUNCTION_DEF (config, register_regexp); /*** * @method rspamd_config:replace_regexp(params) * Replaces regexp with a new one * Params is the table with the following fields (mandatory fields are marked with `*`): * - `old_re`* : old regular expression object (must be in the cache) * - `new_re`* : old regular expression object (must not be in the cache) */ LUA_FUNCTION_DEF (config, replace_regexp); /*** * @method rspamd_config:register_worker_script(worker_type, script) * Registers the following script for workers of a specified type. The exact type * of script function depends on worker type * @param {string} worker_type worker type (e.g. "normal") * @param {function} script script for a worker * @return {boolean} `true` if a script has been registered */ LUA_FUNCTION_DEF (config, register_worker_script); /*** * @method rspamd_config:add_on_load(function(cfg, ev_base) ... end) * Registers the following script to be executed when configuration is completely loaded * @param {function} script function to be executed * @example rspamd_config:add_on_load(function(cfg, ev_base) rspamd_config:add_periodic(ev_base, 1.0, function(cfg, ev_base) local logger = require "rspamd_logger" logger.infox(cfg, "periodic function") return true end) end) */ LUA_FUNCTION_DEF (config, add_on_load); /*** * @method rspamd_config:add_periodic(event_base, timeout, function(cfg, ev_base) ... end, [jitter = false]) * Registers function to be periodically executed by Rspamd * @param {ev_base} event_base event base that is needed for async events * @param {number} timeout time in seconds (could be fractional) * @param {function} script function to be executed * @param {boolean} jitter `true` if timeout jittering is needed * @example rspamd_config:add_on_load(function(cfg, ev_base) rspamd_config:add_periodic(ev_base, 1.0, function(cfg, ev_base) local logger = require "rspamd_logger" logger.infox(cfg, "periodic function") return true -- if return false, then the periodic event is removed end) end) */ LUA_FUNCTION_DEF (config, add_periodic); /*** * @method rspamd_config:get_symbols_count() * Returns number of symbols registered in rspamd configuration * @return {number} number of symbols registered in the configuration */ LUA_FUNCTION_DEF (config, get_symbols_count); /*** * @method rspamd_config:get_symbols_cksum() * Returns checksum for all symbols in the cache * @return {int64} boxed value of the 64 bit checksum */ LUA_FUNCTION_DEF (config, get_symbols_cksum); /*** * @method rspamd_config:get_symbols_counters() * Returns table of all counters in the cache (weights, frequencies etc) * @return {table|tables} all symbols indexed by name */ LUA_FUNCTION_DEF (config, get_symbols_counters); /*** * @method rspamd_config:get_symbols_scores() * Returns table of all scores defined in config * @return {table|tables} all symbols indexed by name */ LUA_FUNCTION_DEF (config, get_symbols_scores); /*** * @method rspamd_config:get_symbol_callback(name) * Returns callback function for the specified symbol if it is a lua registered callback * @return {function} callback function or nil */ LUA_FUNCTION_DEF (config, get_symbol_callback); /*** * @method rspamd_config:get_symbol_stat(name) * Returns table with statistics for a specific symbol: * - `frequency`: frequency for symbol's hits * - `stddev`: standard deviation of `frequency` * - `time`: average time in seconds (floating point) * - `count`: total number of hits * @return {table} symbol stats */ LUA_FUNCTION_DEF (config, get_symbol_stat); /*** * @method rspamd_config:set_symbol_callback(name, callback) * Sets callback for the specified symbol * @return {boolean} true if function has been replaced */ LUA_FUNCTION_DEF (config, set_symbol_callback); /*** * @method rspamd_config:register_finish_script(callback) * Adds new callback that is called on worker process termination when all * tasks pending are processed * * @param callback {function} a function with one argument (rspamd_task) */ LUA_FUNCTION_DEF (config, register_finish_script); /*** * @method rspamd_config:register_monitored(url, type, [{params}]) * Registers monitored resource to watch its availability. Supported types: * * - `dns`: DNS monitored object * * Params are optional table specific for each type. For DNS it supports the * following options: * * - `prefix`: prefix to add before making request * - `type`: type of request (e.g. 'a' or 'txt') * - `ipnet`: array of ip/networks to expect on reply * - `rcode`: expected return code (e.g. `nxdomain`) * * Returned object has the following methods: * * - `alive`: returns `true` if monitored resource is alive * - `offline`: returns number of seconds of the current offline period (or 0 if alive) * - `total_offline`: returns number of seconds of the overall offline * - `latency`: returns the current average latency in seconds (or 0 if offline) * * @param {string} url resource to monitor * @param {string} type type of monitoring * @param {table} opts optional parameters * @return {rspamd_monitored} rspamd monitored object */ LUA_FUNCTION_DEF (config, register_monitored); /*** * @method rspamd_config:add_doc(path, option, doc_string, [{params}]) * Adds new documentation string for an option `option` at path `path` * Options defines optional params, such as: * * - `default`: default option value * - `type`: type of an option (`string`, `number`, `object`, `array` etc) * - `reqired`: if an option is required * * @param {string} path documentation path (e.g. module name) * @param {string} option name of the option * @param {string} doc_string documentation string * @param {table} params optional parameters */ LUA_FUNCTION_DEF (config, add_doc); /*** * @method rspamd_config:add_example(path, option, doc_string, example) * Adds new documentation * * @param {string} path documentation path (e.g. module name or nil for top) * @param {string} option name of the option * @param {string} doc_string documentation string * @param {string} example example in ucl format, comments are also parsed */ LUA_FUNCTION_DEF (config, add_example); /*** * @method rspamd_config:set_peak_cb(function) * Sets a function that will be called when frequency of some symbol goes out of * stddev * 2 over the last period of refreshment. * * @example rspamd_config:set_peak_cb(function(ev_base, sym, mean, stddev, value, error) -- ev_base: event base for async events (e.g. redis) -- sym: symbol's name -- mean: mean frequency value -- stddev: standard deviation of frequency -- value: current frequency value -- error: squared error local logger = require "rspamd_logger" logger.infox(rspamd_config, "symbol %s has changed frequency significantly: %s(%s) over %s(%s)", sym, value, error, mean, stddev) end) */ LUA_FUNCTION_DEF (config, set_peak_cb); /*** * @method rspamd_config:get_cpu_flags() * Returns architecture dependent flags supported by the CPU * Currently, only x86 flags are supported: * - 'ssse3' * - 'sse42' * - 'avx' * - 'avx2' * @return {table} flag -> true table */ LUA_FUNCTION_DEF (config, get_cpu_flags); /*** * @method rspamd_config:has_torch() * Returns true if Rspamd is compiled with torch support and the runtime CPU * supports sse4.2 required for torch. * @return {boolean} true if torch is compiled and supported */ LUA_FUNCTION_DEF (config, has_torch); /*** * @method rspamd_config:experimental_enabled() * Returns true if experimental plugins are enabled * @return {boolean} true if experimental plugins are enabled */ LUA_FUNCTION_DEF (config, experimental_enabled); /*** * @method rspamd_config:load_ucl(filename) * Loads config from the UCL file (but does not perform parsing using rcl) * @param {string} filename file to load * @return true or false + error message */ LUA_FUNCTION_DEF (config, load_ucl); /*** * @method rspamd_config:parse_rcl([skip_sections]) * Parses RCL using loaded ucl file * @param {table|string} sections to skip * @return true or false + error message */ LUA_FUNCTION_DEF (config, parse_rcl); /*** * @method rspamd_config:init_modules() * Initialize lua and internal modules * @return true or false */ LUA_FUNCTION_DEF (config, init_modules); /*** * @method rspamd_config:init_subsystem(str) * Initialize config subsystem from a comma separated list: * - `modules` - init modules * - `langdet` - language detector * - TODO: add more */ LUA_FUNCTION_DEF (config, init_subsystem); /*** * @method rspamd_config:get_tld_path() * Returns path to TLD file * @return {string} path to tld file */ LUA_FUNCTION_DEF (config, get_tld_path); static const struct luaL_reg configlib_m[] = { LUA_INTERFACE_DEF (config, get_module_opt), LUA_INTERFACE_DEF (config, get_mempool), LUA_INTERFACE_DEF (config, get_resolver), LUA_INTERFACE_DEF (config, get_all_opt), LUA_INTERFACE_DEF (config, get_ucl), LUA_INTERFACE_DEF (config, add_radix_map), LUA_INTERFACE_DEF (config, radix_from_config), LUA_INTERFACE_DEF (config, radix_from_ucl), LUA_INTERFACE_DEF (config, add_hash_map), LUA_INTERFACE_DEF (config, add_kv_map), LUA_INTERFACE_DEF (config, add_map), LUA_INTERFACE_DEF (config, get_maps), LUA_INTERFACE_DEF (config, get_classifier), LUA_INTERFACE_DEF (config, register_symbol), LUA_INTERFACE_DEF (config, register_symbols), LUA_INTERFACE_DEF (config, register_virtual_symbol), LUA_INTERFACE_DEF (config, register_callback_symbol), LUA_INTERFACE_DEF (config, register_callback_symbol_priority), LUA_INTERFACE_DEF (config, register_dependency), LUA_INTERFACE_DEF (config, set_metric_symbol), {"set_symbol", lua_config_set_metric_symbol}, LUA_INTERFACE_DEF (config, set_metric_action), {"set_action", lua_config_set_metric_action}, LUA_INTERFACE_DEF (config, get_metric_symbol), {"get_symbol", lua_config_get_metric_symbol}, LUA_INTERFACE_DEF (config, get_metric_action), {"get_action", lua_config_get_metric_action}, LUA_INTERFACE_DEF (config, get_all_actions), LUA_INTERFACE_DEF (config, add_composite), LUA_INTERFACE_DEF (config, register_module_option), LUA_INTERFACE_DEF (config, register_pre_filter), LUA_INTERFACE_DEF (config, register_post_filter), LUA_INTERFACE_DEF (config, get_api_version), LUA_INTERFACE_DEF (config, get_key), LUA_INTERFACE_DEF (config, add_condition), LUA_INTERFACE_DEF (config, enable_symbol), LUA_INTERFACE_DEF (config, disable_symbol), LUA_INTERFACE_DEF (config, register_regexp), LUA_INTERFACE_DEF (config, replace_regexp), LUA_INTERFACE_DEF (config, register_worker_script), LUA_INTERFACE_DEF (config, add_on_load), LUA_INTERFACE_DEF (config, add_periodic), LUA_INTERFACE_DEF (config, get_symbols_count), LUA_INTERFACE_DEF (config, get_symbols_cksum), LUA_INTERFACE_DEF (config, get_symbols_counters), LUA_INTERFACE_DEF (config, get_symbols_scores), LUA_INTERFACE_DEF (config, get_symbol_callback), LUA_INTERFACE_DEF (config, set_symbol_callback), LUA_INTERFACE_DEF (config, get_symbol_stat), LUA_INTERFACE_DEF (config, register_finish_script), LUA_INTERFACE_DEF (config, register_monitored), LUA_INTERFACE_DEF (config, add_doc), LUA_INTERFACE_DEF (config, add_example), LUA_INTERFACE_DEF (config, set_peak_cb), LUA_INTERFACE_DEF (config, get_cpu_flags), LUA_INTERFACE_DEF (config, has_torch), LUA_INTERFACE_DEF (config, experimental_enabled), LUA_INTERFACE_DEF (config, load_ucl), LUA_INTERFACE_DEF (config, parse_rcl), LUA_INTERFACE_DEF (config, init_modules), LUA_INTERFACE_DEF (config, init_subsystem), LUA_INTERFACE_DEF (config, get_tld_path), {"__tostring", rspamd_lua_class_tostring}, {"__newindex", lua_config_newindex}, {NULL, NULL} }; LUA_FUNCTION_DEF (monitored, alive); LUA_FUNCTION_DEF (monitored, latency); LUA_FUNCTION_DEF (monitored, offline); LUA_FUNCTION_DEF (monitored, total_offline); static const struct luaL_reg monitoredlib_m[] = { LUA_INTERFACE_DEF (monitored, alive), LUA_INTERFACE_DEF (monitored, latency), LUA_INTERFACE_DEF (monitored, offline), LUA_INTERFACE_DEF (monitored, total_offline), {"__tostring", rspamd_lua_class_tostring}, {NULL, NULL} }; static const guint64 rspamd_lua_callback_magic = 0x32c118af1e3263c7ULL; struct rspamd_config * lua_check_config (lua_State * L, gint pos) { void *ud = rspamd_lua_check_udata (L, pos, "rspamd{config}"); luaL_argcheck (L, ud != NULL, pos, "'config' expected"); return ud ? *((struct rspamd_config **)ud) : NULL; } static struct rspamd_monitored * lua_check_monitored (lua_State * L, gint pos) { void *ud = rspamd_lua_check_udata (L, pos, "rspamd{monitored}"); luaL_argcheck (L, ud != NULL, pos, "'monitored' expected"); return ud ? *((struct rspamd_monitored **)ud) : NULL; } /*** Config functions ***/ static gint lua_config_get_api_version (lua_State *L) { msg_warn ("get_api_version is deprecated, do not use it"); lua_pushnumber (L, 100); return 1; } static gint lua_config_get_module_opt (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *mname, *optname; const ucl_object_t *obj; if (cfg) { mname = luaL_checkstring (L, 2); optname = luaL_checkstring (L, 3); if (mname && optname) { obj = rspamd_config_get_module_opt (cfg, mname, optname); if (obj) { return ucl_object_push_lua (L, obj, TRUE); } } } lua_pushnil (L); return 1; } static int lua_config_get_mempool (lua_State * L) { LUA_TRACE_POINT; rspamd_mempool_t **ppool; struct rspamd_config *cfg = lua_check_config (L, 1); if (cfg != NULL) { ppool = lua_newuserdata (L, sizeof (rspamd_mempool_t *)); rspamd_lua_setclass (L, "rspamd{mempool}", -1); *ppool = cfg->cfg_pool; } else { lua_pushnil (L); } return 1; } static int lua_config_get_resolver (lua_State * L) { LUA_TRACE_POINT; struct rspamd_dns_resolver **pres; struct rspamd_config *cfg = lua_check_config (L, 1); if (cfg != NULL && cfg->dns_resolver) { pres = lua_newuserdata (L, sizeof (*pres)); rspamd_lua_setclass (L, "rspamd{resolver}", -1); *pres = cfg->dns_resolver; } else { lua_pushnil (L); } return 1; } static gint lua_config_get_all_opt (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *mname; const ucl_object_t *obj, *cur, *cur_elt; ucl_object_iter_t it = NULL; gint i; if (cfg) { mname = luaL_checkstring (L, 2); if (mname) { obj = ucl_obj_get_key (cfg->rcl_obj, mname); /* Flatten object */ if (obj != NULL && (ucl_object_type (obj) == UCL_OBJECT || ucl_object_type (obj) == UCL_ARRAY)) { lua_newtable (L); it = ucl_object_iterate_new (obj); LL_FOREACH (obj, cur) { it = ucl_object_iterate_reset (it, cur); while ((cur_elt = ucl_object_iterate_safe (it, true))) { lua_pushstring (L, ucl_object_key (cur_elt)); ucl_object_push_lua (L, cur_elt, true); lua_settable (L, -3); } } ucl_object_iterate_free (it); return 1; } else if (obj != NULL) { lua_newtable (L); i = 1; LL_FOREACH (obj, cur) { lua_pushnumber (L, i++); ucl_object_push_lua (L, cur, true); lua_settable (L, -3); } return 1; } } } lua_pushnil (L); return 1; } struct rspamd_lua_cached_config { lua_State *L; gint ref; }; static void lua_config_ucl_dtor (gpointer p) { struct rspamd_lua_cached_config *cached = p; luaL_unref (cached->L, LUA_REGISTRYINDEX, cached->ref); } static gint lua_config_get_ucl (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_lua_cached_config *cached; if (cfg) { cached = rspamd_mempool_get_variable (cfg->cfg_pool, "ucl_cached"); if (cached) { lua_rawgeti (L, LUA_REGISTRYINDEX, cached->ref); } else { ucl_object_push_lua (L, cfg->rcl_obj, true); lua_pushvalue (L, -1); cached = rspamd_mempool_alloc (cfg->cfg_pool, sizeof (*cached)); cached->L = L; cached->ref = luaL_ref (L, LUA_REGISTRYINDEX); rspamd_mempool_set_variable (cfg->cfg_pool, "ucl_cached", cached, lua_config_ucl_dtor); } } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_get_classifier (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_classifier_config *clc = NULL, **pclc = NULL; const gchar *name; GList *cur; if (cfg) { name = luaL_checkstring (L, 2); cur = g_list_first (cfg->classifiers); while (cur) { clc = cur->data; if (g_ascii_strcasecmp (clc->name, name) == 0) { pclc = &clc; break; } cur = g_list_next (cur); } if (pclc) { pclc = lua_newuserdata (L, sizeof (struct rspamd_classifier_config *)); rspamd_lua_setclass (L, "rspamd{classifier}", -1); *pclc = clc; return 1; } } lua_pushnil (L); return 1; } struct lua_callback_data { guint64 magic; lua_State *L; gchar *symbol; union { gchar *name; gint ref; } callback; gboolean cb_is_ref; gint order; }; struct lua_watcher_data { struct lua_callback_data *cbd; gint cb_ref; }; /* * Unref symbol if it is local reference */ static void lua_destroy_cfg_symbol (gpointer ud) { struct lua_callback_data *cd = ud; /* Unref callback */ if (cd->cb_is_ref) { luaL_unref (cd->L, LUA_REGISTRYINDEX, cd->callback.ref); } } static gint lua_config_register_module_option (lua_State *L) { return 0; } static gint rspamd_compare_order_func (gconstpointer a, gconstpointer b) { const struct lua_callback_data *cb1 = a, *cb2 = b; /* order of call goes from lower to higher */ return cb2->order - cb1->order; } static void lua_watcher_callback (gpointer session_data, gpointer ud) { struct rspamd_task *task = session_data, **ptask; struct lua_watcher_data *wd = ud; lua_State *L; gint level, nresults, err_idx, ret; GString *tb; struct rspamd_symbol_result *s; L = wd->cbd->L; level = lua_gettop (L); lua_pushcfunction (L, &rspamd_lua_traceback); err_idx = lua_gettop (L); level ++; lua_rawgeti (L, LUA_REGISTRYINDEX, wd->cb_ref); ptask = lua_newuserdata (L, sizeof (struct rspamd_task *)); rspamd_lua_setclass (L, "rspamd{task}", -1); *ptask = task; if ((ret = lua_pcall (L, 1, LUA_MULTRET, err_idx)) != 0) { tb = lua_touserdata (L, -1); msg_err_task ("call to (%s) failed (%d): %v", wd->cbd->symbol, ret, tb); if (tb) { g_string_free (tb, TRUE); } } else { nresults = lua_gettop (L) - level; if (nresults >= 1) { /* Function returned boolean, so maybe we need to insert result? */ gint res = 0; gint i; gdouble flag = 1.0; gint type; struct lua_watcher_data *nwd; type = lua_type (L, level + 1); if (type == LUA_TBOOLEAN) { res = lua_toboolean (L, level + 1); } else if (type == LUA_TFUNCTION) { /* Function returned a closure that should be watched for */ nwd = rspamd_mempool_alloc (task->task_pool, sizeof (*nwd)); lua_pushvalue (L, level + 1); nwd->cb_ref = luaL_ref (L, LUA_REGISTRYINDEX); nwd->cbd = wd->cbd; rspamd_session_watcher_push_callback (task->s, rspamd_session_get_watcher (task->s), lua_watcher_callback, nwd); /* * We immediately pop watcher since we have not registered * any async events from here */ rspamd_session_watcher_pop (task->s, rspamd_session_get_watcher (task->s)); } else { res = lua_tonumber (L, level + 1); } if (res) { gint first_opt = 2; if (lua_type (L, level + 2) == LUA_TNUMBER) { flag = lua_tonumber (L, level + 2); /* Shift opt index */ first_opt = 3; } else { flag = res; } s = rspamd_task_insert_result (task, wd->cbd->symbol, flag, NULL); if (s) { guint last_pos = lua_gettop (L); for (i = level + first_opt; i <= last_pos; i++) { if (lua_type (L, i) == LUA_TSTRING) { const char *opt = lua_tostring (L, i); rspamd_task_add_result_option (task, s, opt); } else if (lua_type (L, i) == LUA_TTABLE) { lua_pushvalue (L, i); for (lua_pushnil (L); lua_next (L, -2); lua_pop (L, 1)) { const char *opt = lua_tostring (L, -1); rspamd_task_add_result_option (task, s, opt); } lua_pop (L, 1); } } } } } } lua_settop (L, err_idx - 1); } static void lua_metric_symbol_callback (struct rspamd_task *task, gpointer ud) { struct lua_callback_data *cd = ud; struct rspamd_task **ptask; gint level = lua_gettop (cd->L), nresults, err_idx, ret; lua_State *L = cd->L; GString *tb; struct rspamd_symbol_result *s; lua_pushcfunction (L, &rspamd_lua_traceback); err_idx = lua_gettop (L); level ++; if (cd->cb_is_ref) { lua_rawgeti (L, LUA_REGISTRYINDEX, cd->callback.ref); } else { lua_getglobal (L, cd->callback.name); } ptask = lua_newuserdata (L, sizeof (struct rspamd_task *)); rspamd_lua_setclass (L, "rspamd{task}", -1); *ptask = task; if ((ret = lua_pcall (L, 1, LUA_MULTRET, err_idx)) != 0) { tb = lua_touserdata (L, -1); msg_err_task ("call to (%s) failed (%d): %v", cd->symbol, ret, tb); if (tb) { g_string_free (tb, TRUE); lua_pop (L, 1); } } else { nresults = lua_gettop (L) - level; if (nresults >= 1) { /* Function returned boolean, so maybe we need to insert result? */ gint res = 0; gint i; gdouble flag = 1.0; gint type; struct lua_watcher_data *wd; type = lua_type (cd->L, level + 1); if (type == LUA_TBOOLEAN) { res = lua_toboolean (L, level + 1); } else if (type == LUA_TFUNCTION) { /* Function returned a closure that should be watched for */ wd = rspamd_mempool_alloc (task->task_pool, sizeof (*wd)); lua_pushvalue (cd->L, level + 1); wd->cb_ref = luaL_ref (L, LUA_REGISTRYINDEX); wd->cbd = cd; rspamd_session_watcher_push_callback (task->s, rspamd_session_get_watcher (task->s), lua_watcher_callback, wd); /* * We immediately pop watcher since we have not registered * any async events from here */ rspamd_session_watcher_pop (task->s, rspamd_session_get_watcher (task->s)); } else { res = lua_tonumber (L, level + 1); } if (res) { gint first_opt = 2; if (lua_type (L, level + 2) == LUA_TNUMBER) { flag = lua_tonumber (L, level + 2); /* Shift opt index */ first_opt = 3; } else { flag = res; } s = rspamd_task_insert_result (task, cd->symbol, flag, NULL); if (s) { guint last_pos = lua_gettop (L); for (i = level + first_opt; i <= last_pos; i++) { if (lua_type (L, i) == LUA_TSTRING) { const char *opt = lua_tostring (L, i); rspamd_task_add_result_option (task, s, opt); } else if (lua_type (L, i) == LUA_TTABLE) { lua_pushvalue (L, i); for (lua_pushnil (L); lua_next (L, -2); lua_pop (L, 1)) { const char *opt = lua_tostring (L, -1); rspamd_task_add_result_option (task, s, opt); } lua_pop (L, 1); } } } } lua_pop (L, nresults); } } lua_pop (L, 1); /* Error function */ } static gint rspamd_register_symbol_fromlua (lua_State *L, struct rspamd_config *cfg, const gchar *name, gint ref, gdouble weight, gint priority, enum rspamd_symbol_type type, gint parent, gboolean optional, gboolean no_squeeze) { struct lua_callback_data *cd; gint ret = -1, err_idx; if (priority == 0 && weight < 0) { priority = 1; } if ((ret = rspamd_symbols_cache_find_symbol (cfg->cache, name)) != -1) { if (optional) { msg_debug_config ("duplicate symbol: %s, skip registering", name); return ret; } else { msg_err_config ("duplicate symbol: %s, skip registering", name); return -1; } } if (ref != -1) { /* * We call for routine called lua_squeeze_rules.squeeze_rule if it exists */ lua_pushcfunction (L, &rspamd_lua_traceback); err_idx = lua_gettop (L); if (!no_squeeze && (type & (SYMBOL_TYPE_CALLBACK|SYMBOL_TYPE_NORMAL)) && rspamd_lua_require_function (L, "lua_squeeze_rules", "squeeze_rule")) { if (name) { lua_pushstring (L, name); } else { lua_pushnil (L); } /* Push function reference */ lua_rawgeti (L, LUA_REGISTRYINDEX, ref); /* Now call for squeeze function */ if (lua_pcall (L, 2, 1, err_idx) != 0) { GString *tb = lua_touserdata (L, -1); msg_err_config ("call to squeeze_rule failed: %v", tb); if (tb) { g_string_free (tb, TRUE); } } ret = lua_tonumber (L, -1); if (ret == -1) { /* Do direct registration */ cd = rspamd_mempool_alloc0 (cfg->cfg_pool, sizeof (struct lua_callback_data)); cd->magic = rspamd_lua_callback_magic; cd->cb_is_ref = TRUE; cd->callback.ref = ref; cd->L = L; if (name) { cd->symbol = rspamd_mempool_strdup (cfg->cfg_pool, name); } ret = rspamd_symbols_cache_add_symbol (cfg->cache, name, priority, lua_metric_symbol_callback, cd, type, parent); rspamd_mempool_add_destructor (cfg->cfg_pool, (rspamd_mempool_destruct_t)lua_destroy_cfg_symbol, cd); } } else { cd = rspamd_mempool_alloc0 (cfg->cfg_pool, sizeof (struct lua_callback_data)); cd->magic = rspamd_lua_callback_magic; cd->cb_is_ref = TRUE; cd->callback.ref = ref; cd->L = L; if (name) { cd->symbol = rspamd_mempool_strdup (cfg->cfg_pool, name); } ret = rspamd_symbols_cache_add_symbol (cfg->cache, name, priority, lua_metric_symbol_callback, cd, type, parent); rspamd_mempool_add_destructor (cfg->cfg_pool, (rspamd_mempool_destruct_t)lua_destroy_cfg_symbol, cd); } /* Cleanup lua stack */ lua_settop (L, err_idx - 1); } else { ret = rspamd_symbols_cache_add_symbol (cfg->cache, name, priority, NULL, NULL, type, parent); } return ret; } static gint lua_config_register_post_filter (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); gint order = 0, cbref, ret; if (cfg) { if (lua_type (L, 3) == LUA_TNUMBER) { order = lua_tonumber (L, 3); } if (lua_type (L, 2) == LUA_TFUNCTION) { lua_pushvalue (L, 2); /* Get a reference */ cbref = luaL_ref (L, LUA_REGISTRYINDEX); } else { return luaL_error (L, "invalid type for callback: %s", lua_typename (L, lua_type (L, 2))); } msg_warn_config ("register_post_filter function is deprecated, " "use register_symbol instead"); ret = rspamd_register_symbol_fromlua (L, cfg, NULL, cbref, 1.0, order, SYMBOL_TYPE_POSTFILTER|SYMBOL_TYPE_CALLBACK, -1, FALSE, TRUE); lua_pushboolean (L, ret); } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_register_pre_filter (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); gint order = 0, cbref, ret; if (cfg) { if (lua_type (L, 3) == LUA_TNUMBER) { order = lua_tonumber (L, 3); } if (lua_type (L, 2) == LUA_TFUNCTION) { lua_pushvalue (L, 2); /* Get a reference */ cbref = luaL_ref (L, LUA_REGISTRYINDEX); } else { return luaL_error (L, "invalid type for callback: %s", lua_typename (L, lua_type (L, 2))); } msg_warn_config ("register_pre_filter function is deprecated, " "use register_symbol instead"); ret = rspamd_register_symbol_fromlua (L, cfg, NULL, cbref, 1.0, order, SYMBOL_TYPE_PREFILTER|SYMBOL_TYPE_CALLBACK, -1, FALSE, TRUE); lua_pushboolean (L, ret); } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_get_key (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *name; size_t namelen; const ucl_object_t *val; name = luaL_checklstring(L, 2, &namelen); if (name && cfg) { val = ucl_object_lookup_len(cfg->rcl_obj, name, namelen); if (val != NULL) { ucl_object_push_lua (L, val, val->type != UCL_ARRAY); } else { lua_pushnil (L); } } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_parse_symbol_flags (const gchar *str) { int ret = 0; if (str) { if (strstr (str, "fine") != NULL) { ret |= SYMBOL_TYPE_FINE; } if (strstr (str, "nice") != NULL) { ret |= SYMBOL_TYPE_FINE; } if (strstr (str, "empty") != NULL) { ret |= SYMBOL_TYPE_EMPTY; } if (strstr (str, "skip") != NULL) { ret |= SYMBOL_TYPE_SKIPPED; } if (strstr (str, "nostat") != NULL) { ret |= SYMBOL_TYPE_NOSTAT; } if (strstr (str, "idempotent") != NULL) { ret |= SYMBOL_TYPE_IDEMPOTENT; } if (strstr (str, "squeezed") != NULL) { ret |= SYMBOL_TYPE_SQUEEZED; } if (strstr (str, "trivial") != NULL) { ret |= SYMBOL_TYPE_TRIVIAL; } } return ret; } static gint lua_parse_symbol_type (const gchar *str) { gint ret = SYMBOL_TYPE_NORMAL; gchar **vec; guint i, l; if (str) { vec = g_strsplit_set (str, ",;", -1); if (vec) { l = g_strv_length (vec); for (i = 0; i < l; i ++) { str = vec[i]; if (g_ascii_strcasecmp (str, "virtual") == 0) { ret = SYMBOL_TYPE_VIRTUAL; } else if (g_ascii_strcasecmp (str, "callback") == 0) { ret = SYMBOL_TYPE_CALLBACK; } else if (g_ascii_strcasecmp (str, "normal") == 0) { ret = SYMBOL_TYPE_NORMAL; } else if (g_ascii_strcasecmp (str, "prefilter") == 0) { ret = SYMBOL_TYPE_PREFILTER | SYMBOL_TYPE_GHOST; } else if (g_ascii_strcasecmp (str, "postfilter") == 0) { ret = SYMBOL_TYPE_POSTFILTER | SYMBOL_TYPE_GHOST; } else if (g_ascii_strcasecmp (str, "idempotent") == 0) { ret = SYMBOL_TYPE_POSTFILTER | SYMBOL_TYPE_GHOST | SYMBOL_TYPE_IDEMPOTENT; } else { gint fl = 0; fl = lua_parse_symbol_flags (str); if (fl == 0) { msg_warn ("bad type: %s", str); } else { ret |= fl; } } } g_strfreev (vec); } } return ret; } static gint lua_config_register_symbol (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *name = NULL, *flags_str = NULL, *type_str = NULL, *description = NULL, *group = NULL; double weight = 0, score = NAN, parent_float = NAN; gboolean one_shot = FALSE, no_squeeze = FALSE; gint ret = -1, cbref = -1, type, flags = 0; gint64 parent = 0, priority = 0, nshots = 0; GError *err = NULL; if (cfg) { if (!rspamd_lua_parse_table_arguments (L, 2, &err, "name=S;weight=N;callback=F;flags=S;type=S;priority=I;parent=D;" "score=D;description=S;group=S;one_shot=B;nshots=I;no_squeeze=B", &name, &weight, &cbref, &flags_str, &type_str, &priority, &parent_float, &score, &description, &group, &one_shot, &nshots, &no_squeeze)) { msg_err_config ("bad arguments: %e", err); g_error_free (err); return luaL_error (L, "invalid arguments"); } if (!no_squeeze) { no_squeeze = cfg->disable_lua_squeeze; } if (nshots == 0) { nshots = cfg->default_max_shots; } type = lua_parse_symbol_type (type_str); if (!name && !(type & SYMBOL_TYPE_CALLBACK)) { return luaL_error (L, "no symbol name but type is not callback"); } else if (!(type & SYMBOL_TYPE_VIRTUAL) && cbref == -1) { return luaL_error (L, "no callback for symbol %s", name); } if (flags_str) { /* Turn off squeezing as well for now */ /* TODO: deal with it */ no_squeeze = TRUE; type |= lua_parse_symbol_flags (flags_str); } if (isnan (parent_float)) { parent = -1; } else { parent = parent_float; } ret = rspamd_register_symbol_fromlua (L, cfg, name, cbref, weight == 0 ? 1.0 : weight, priority, type, parent, FALSE, no_squeeze); if (!isnan (score)) { if (one_shot) { nshots = 1; } rspamd_config_add_symbol (cfg, name, score, description, group, flags, (guint) priority, nshots); lua_pushstring (L, "groups"); lua_gettable (L, 2); if (lua_istable (L, -1)) { for (lua_pushnil (L); lua_next (L, -2); lua_pop (L, 1)) { if (lua_isstring (L, -1)) { rspamd_config_add_symbol_group (cfg, name, lua_tostring (L, -1)); } else { return luaL_error (L, "invalid groups element"); } } } lua_pop (L, 1); } } else { return luaL_error (L, "invalid arguments"); } lua_pushnumber (L, ret); return 1; } static gint lua_config_register_symbols (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); gint i, top, idx, ret = -1; const gchar *sym; gdouble weight = 1.0; if (lua_gettop (L) < 3) { if (cfg) { msg_err_config ("not enough arguments to register a function"); } lua_error (L); return 0; } if (cfg) { if (lua_type (L, 2) == LUA_TSTRING) { lua_getglobal (L, luaL_checkstring (L, 2)); } else { lua_pushvalue (L, 2); } idx = luaL_ref (L, LUA_REGISTRYINDEX); if (lua_type (L, 3) == LUA_TNUMBER) { weight = lua_tonumber (L, 3); top = 4; } else { top = 3; } sym = luaL_checkstring (L, top ++); ret = rspamd_register_symbol_fromlua (L, cfg, sym, idx, weight, 0, SYMBOL_TYPE_CALLBACK, -1, FALSE, FALSE); for (i = top; i <= lua_gettop (L); i++) { if (lua_type (L, i) == LUA_TTABLE) { lua_pushvalue (L, i); lua_pushnil (L); while (lua_next (L, -2)) { lua_pushvalue (L, -2); sym = luaL_checkstring (L, -2); rspamd_symbols_cache_add_symbol (cfg->cache, sym, 0, NULL, NULL, SYMBOL_TYPE_VIRTUAL, ret); lua_pop (L, 2); } lua_pop (L, 1); } else if (lua_type (L, i) == LUA_TSTRING) { sym = luaL_checkstring (L, i); rspamd_symbols_cache_add_symbol (cfg->cache, sym, 0, NULL, NULL, SYMBOL_TYPE_VIRTUAL, ret); } } } lua_pushnumber (L, ret); return 1; } static gint lua_config_register_virtual_symbol (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *name; double weight; gint ret = -1, parent = -1; if (cfg) { name = luaL_checkstring (L, 2); weight = luaL_checknumber (L, 3); if (lua_gettop (L) > 3) { parent = lua_tonumber (L, 4); } if (name) { ret = rspamd_symbols_cache_add_symbol (cfg->cache, name, weight > 0 ? 0 : -1, NULL, NULL, SYMBOL_TYPE_VIRTUAL, parent); } } lua_pushnumber (L, ret); return 1; } static gint lua_config_register_callback_symbol (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *name = NULL; double weight; gint ret = -1, top = 2; if (cfg) { if (lua_type (L, 2) == LUA_TSTRING) { /* Legacy syntax */ name = luaL_checkstring (L, 2); top ++; } weight = luaL_checknumber (L, top); if (lua_type (L, top + 1) == LUA_TSTRING) { lua_getglobal (L, luaL_checkstring (L, top + 1)); } else { lua_pushvalue (L, top + 1); } ret = rspamd_register_symbol_fromlua (L, cfg, name, luaL_ref (L, LUA_REGISTRYINDEX), weight, 0, SYMBOL_TYPE_CALLBACK, -1, FALSE, lua_type (L, top + 1) == LUA_TSTRING); } lua_pushnumber (L, ret); return 1; } static gint lua_config_register_callback_symbol_priority (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *name = NULL; double weight; gint priority, ret = -1, top = 2; if (cfg) { if (lua_type (L, 2) == LUA_TSTRING) { /* Legacy syntax */ name = luaL_checkstring (L, 2); top ++; } weight = luaL_checknumber (L, top); priority = luaL_checknumber (L, top + 1); if (lua_type (L, top + 2) == LUA_TSTRING) { lua_getglobal (L, luaL_checkstring (L, top + 2)); } else { lua_pushvalue (L, top + 2); } ret = rspamd_register_symbol_fromlua (L, cfg, name, luaL_ref (L, LUA_REGISTRYINDEX), weight, priority, SYMBOL_TYPE_CALLBACK, -1, FALSE, lua_type (L, top + 2) == LUA_TSTRING); } lua_pushnumber (L, ret); return 1; } static gboolean rspamd_lua_squeeze_dependency (lua_State *L, struct rspamd_config *cfg, const gchar *child, const gchar *parent) { gint err_idx; gboolean ret = FALSE; g_assert (parent != NULL); g_assert (child != NULL); lua_pushcfunction (L, &rspamd_lua_traceback); err_idx = lua_gettop (L); if (rspamd_lua_require_function (L, "lua_squeeze_rules", "squeeze_dependency")) { lua_pushstring (L, child); lua_pushstring (L, parent); if (lua_pcall (L, 2, 1, err_idx) != 0) { GString *tb = lua_touserdata (L, -1); msg_err_config ("call to squeeze_dependency script failed: %v", tb); if (tb) { g_string_free (tb, TRUE); } } else { ret = lua_toboolean (L, -1); } } lua_settop (L, err_idx - 1); return ret; } static gint lua_config_register_dependency (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *parent = NULL, *child = NULL; gint child_id; gboolean skip_squeeze; if (cfg == NULL) { lua_error (L); return 0; } skip_squeeze = cfg->disable_lua_squeeze; if (lua_type (L, 2) == LUA_TNUMBER) { child_id = luaL_checknumber (L, 2); parent = luaL_checkstring (L, 3); if (!skip_squeeze && lua_isboolean (L, 4)) { skip_squeeze = lua_toboolean (L, 4); } msg_warn_config ("calling for obsolete method to register deps for symbol %d->%s", child_id, parent); if (child_id > 0 && parent != NULL) { if (skip_squeeze || !rspamd_lua_squeeze_dependency (L, cfg, rspamd_symbols_cache_symbol_by_id (cfg->cache, child_id), parent)) { rspamd_symbols_cache_add_dependency (cfg->cache, child_id, parent); } } } else { child = luaL_checkstring (L,2); parent = luaL_checkstring (L, 3); if (!skip_squeeze && lua_isboolean (L, 4)) { skip_squeeze = lua_toboolean (L, 4); } if (child != NULL && parent != NULL) { if (skip_squeeze || !rspamd_lua_squeeze_dependency (L, cfg, child, parent)) { rspamd_symbols_cache_add_delayed_dependency (cfg->cache, child, parent); } } } return 0; } static gint lua_config_set_metric_symbol (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *description = NULL, *group = NULL, *name = NULL, *flags_str = NULL; double weight; gboolean one_shot = FALSE, one_param = FALSE; GError *err = NULL; gdouble priority = 0.0; guint flags = 0; gint64 nshots = 0; if (cfg) { if (lua_type (L, 2) == LUA_TTABLE) { if (!rspamd_lua_parse_table_arguments (L, 2, &err, "*name=S;score=N;description=S;" "group=S;one_shot=B;one_param=B;priority=N;flags=S;" "nshots=I", &name, &weight, &description, &group, &one_shot, &one_param, &priority, &flags_str, &nshots)) { msg_err_config ("bad arguments: %e", err); g_error_free (err); return 0; } } else { name = luaL_checkstring (L, 2); weight = luaL_checknumber (L, 3); if (lua_gettop (L) > 3 && lua_type (L, 4) == LUA_TSTRING) { description = luaL_checkstring (L, 4); } if (lua_gettop (L) > 4 && lua_type (L, 5) == LUA_TSTRING) { /* XXX: metrics */ } if (lua_gettop (L) > 5 && lua_type (L, 6) == LUA_TSTRING) { group = luaL_checkstring (L, 6); } if (lua_gettop (L) > 6 && lua_type (L, 7) == LUA_TBOOLEAN) { one_shot = lua_toboolean (L, 7); } } if (nshots == 0) { nshots = cfg->default_max_shots; } if (one_shot) { nshots = 1; } if (one_param) { flags |= RSPAMD_SYMBOL_FLAG_ONEPARAM; } if (flags_str) { if (strstr (flags_str, "one_shot") != NULL) { nshots = 1; } if (strstr (flags_str, "ignore") != NULL) { flags |= RSPAMD_SYMBOL_FLAG_IGNORE; } if (strstr (flags_str, "one_param") != NULL) { flags |= RSPAMD_SYMBOL_FLAG_ONEPARAM; } } rspamd_config_add_symbol (cfg, name, weight, description, group, flags, (guint) priority, nshots); if (lua_type (L, 2) == LUA_TTABLE) { lua_pushstring (L, "groups"); lua_gettable (L, 2); if (lua_istable (L, -1)) { for (lua_pushnil (L); lua_next (L, -2); lua_pop (L, 1)) { if (lua_isstring (L, -1)) { rspamd_config_add_symbol_group (cfg, name, lua_tostring (L, -1)); } else { return luaL_error (L, "invalid groups element"); } } } lua_pop (L, 1); } } else { return luaL_error (L, "invalid arguments, rspamd_config expected"); } return 0; } static gint lua_config_get_metric_symbol (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *sym_name = luaL_checkstring (L, 2); struct rspamd_symbol *sym_def; struct rspamd_symbols_group *sym_group; guint i; if (cfg && sym_name) { sym_def = g_hash_table_lookup (cfg->symbols, sym_name); if (sym_def == NULL) { lua_pushnil (L); } else { lua_createtable (L, 0, 3); lua_pushstring (L, "score"); lua_pushnumber (L, sym_def->score); lua_settable (L, -3); if (sym_def->description) { lua_pushstring (L, "description"); lua_pushstring (L, sym_def->description); lua_settable (L, -3); } if (sym_def->gr) { lua_pushstring (L, "group"); lua_pushstring (L, sym_def->gr->name); lua_settable (L, -3); } lua_pushstring (L, "groups"); lua_createtable (L, sym_def->groups->len, 0); PTR_ARRAY_FOREACH (sym_def->groups, i, sym_group) { lua_pushstring (L, sym_group->name); lua_rawseti (L, -2, i + 1); } lua_settable (L, -3); } } else { luaL_error (L, "Invalid arguments"); } return 1; } static gint lua_config_set_metric_action (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *name = NULL; double weight; GError *err = NULL; gdouble priority = 0.0; if (cfg) { if (lua_type (L, 2) == LUA_TTABLE) { if (!rspamd_lua_parse_table_arguments (L, 2, &err, "*action=S;score=N;" "priority=N", &name, &weight, &priority)) { msg_err_config ("bad arguments: %e", err); g_error_free (err); return 0; } } else { return luaL_error (L, "invalid arguments, table expected"); } if (name != NULL && weight != 0) { rspamd_config_set_action_score (cfg, name, weight, (guint)priority); } } else { return luaL_error (L, "invalid arguments, rspamd_config expected"); } return 0; } static gint lua_config_get_metric_action (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *act_name = luaL_checkstring (L, 2); gint act = 0; if (cfg && act_name) { if (rspamd_action_from_str (act_name, &act)) { if (!isnan (cfg->actions[act].score)) { lua_pushnumber (L, cfg->actions[act].score); } else { lua_pushnil (L); } } else { lua_pushnil (L); } } else { return luaL_error (L, "invalid arguments, rspamd_config expected"); } return 1; } static gint lua_config_get_all_actions (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); gint act = 0; if (cfg) { lua_newtable (L); for (act = METRIC_ACTION_REJECT; act < METRIC_ACTION_MAX; act ++) { if (!isnan (cfg->actions[act].score)) { lua_pushstring (L, rspamd_action_to_str (act)); lua_pushnumber (L, cfg->actions[act].score); lua_settable (L, -3); } } } else { return luaL_error (L, "invalid arguments, rspamd_config expected"); } return 1; } static gint lua_config_add_composite (lua_State * L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_expression *expr; gchar *name; const gchar *expr_str; struct rspamd_composite *composite; gboolean ret = FALSE, new = TRUE; GError *err = NULL; if (cfg) { name = rspamd_mempool_strdup (cfg->cfg_pool, luaL_checkstring (L, 2)); expr_str = luaL_checkstring (L, 3); if (name && expr_str) { if (!rspamd_parse_expression (expr_str, 0, &composite_expr_subr, NULL, cfg->cfg_pool, &err, &expr)) { msg_err_config ("cannot parse composite expression %s: %e", expr_str, err); g_error_free (err); } else { if (g_hash_table_lookup (cfg->composite_symbols, name) != NULL) { msg_warn_config ("composite %s is redefined", name); new = FALSE; } composite = rspamd_mempool_alloc0 (cfg->cfg_pool, sizeof (struct rspamd_composite)); composite->expr = expr; composite->id = g_hash_table_size (cfg->composite_symbols); composite->str_expr = rspamd_mempool_strdup (cfg->cfg_pool, expr_str); composite->sym = name; g_hash_table_insert (cfg->composite_symbols, (gpointer)name, composite); if (new) { rspamd_symbols_cache_add_symbol (cfg->cache, name, 0, NULL, NULL, SYMBOL_TYPE_COMPOSITE, -1); } ret = TRUE; } } } lua_pushboolean (L, ret); return 1; } static gint lua_config_newindex (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *name; gint id, nshots; gboolean optional = FALSE, no_squeeze = FALSE; name = luaL_checkstring (L, 2); if (cfg != NULL && name != NULL && lua_gettop (L) == 3) { no_squeeze = cfg->disable_lua_squeeze; if (lua_type (L, 3) == LUA_TFUNCTION) { /* Normal symbol from just a function */ lua_pushvalue (L, 3); rspamd_register_symbol_fromlua (L, cfg, name, luaL_ref (L, LUA_REGISTRYINDEX), 1.0, 0, SYMBOL_TYPE_NORMAL, -1, FALSE, no_squeeze); } else if (lua_type (L, 3) == LUA_TTABLE) { gint type = SYMBOL_TYPE_NORMAL, priority = 0, idx; gdouble weight = 1.0, score; const char *type_str, *group = NULL, *description = NULL; guint flags = 0; no_squeeze = cfg->disable_lua_squeeze; /* * Table can have the following attributes: * "callback" - should be a callback function * "weight" - optional weight * "priority" - optional priority * "type" - optional type (normal, virtual, callback) * -- Metric options * "score" - optional default score (overridden by metric) * "group" - optional default group * "one_shot" - optional one shot mode * "description" - optional description */ lua_pushvalue (L, 3); lua_pushstring (L, "callback"); lua_gettable (L, -2); if (lua_type (L, -1) != LUA_TFUNCTION) { lua_pop (L, 2); msg_info_config ("cannot find callback definition for %s", name); return 0; } idx = luaL_ref (L, LUA_REGISTRYINDEX); /* Optional fields */ lua_pushstring (L, "weight"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TNUMBER) { weight = lua_tonumber (L, -1); } lua_pop (L, 1); lua_pushstring (L, "priority"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TNUMBER) { priority = lua_tonumber (L, -1); } lua_pop (L, 1); lua_pushstring (L, "optional"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TBOOLEAN) { optional = lua_toboolean (L, -1); } lua_pop (L, 1); lua_pushstring (L, "type"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TSTRING) { type_str = lua_tostring (L, -1); type = lua_parse_symbol_type (type_str); } lua_pop (L, 1); lua_pushstring (L, "condition"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TFUNCTION) { no_squeeze = TRUE; } lua_pop (L, 1); if (!no_squeeze) { lua_pushstring (L, "no_squeeze"); lua_gettable (L, -2); if (lua_toboolean (L, -1)) { no_squeeze = TRUE; } lua_pop (L, 1); } id = rspamd_register_symbol_fromlua (L, cfg, name, idx, weight, priority, type, -1, optional, no_squeeze); if (id != -1) { /* Check for condition */ lua_pushstring (L, "condition"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TFUNCTION) { gint condref; /* Here we pop function from the stack, so no lua_pop is required */ condref = luaL_ref (L, LUA_REGISTRYINDEX); rspamd_symbols_cache_add_condition (cfg->cache, id, L, condref); } else { lua_pop (L, 1); } } /* * Now check if a symbol has not been registered in any metric and * insert default value if applicable */ if (g_hash_table_lookup (cfg->symbols, name) == NULL) { nshots = cfg->default_max_shots; lua_pushstring (L, "score"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TNUMBER) { score = lua_tonumber (L, -1); lua_pop (L, 1); /* If score defined, then we can check other metric fields */ lua_pushstring (L, "group"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TSTRING) { group = lua_tostring (L, -1); } lua_pop (L, 1); lua_pushstring (L, "description"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TSTRING) { description = lua_tostring (L, -1); } lua_pop (L, 1); lua_pushstring (L, "one_shot"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TBOOLEAN) { if (lua_toboolean (L, -1)) { nshots = 1; } } lua_pop (L, 1); lua_pushstring (L, "one_param"); lua_gettable (L, -2); if (lua_type (L, -1) == LUA_TBOOLEAN) { if (lua_toboolean (L, -1)) { flags |= RSPAMD_SYMBOL_FLAG_ONEPARAM; } } lua_pop (L, 1); /* * Do not override the existing symbols (using zero priority), * since we are defining default values here */ rspamd_config_add_symbol (cfg, name, score, description, group, flags, 0, nshots); lua_pushstring (L, "groups"); lua_gettable (L, -2); if (lua_istable (L, -1)) { for (lua_pushnil (L); lua_next (L, -2); lua_pop (L, 1)) { if (lua_isstring (L, -1)) { rspamd_config_add_symbol_group (cfg, name, lua_tostring (L, -1)); } else { return luaL_error (L, "invalid groups element"); } } } lua_pop (L, 1); } else { lua_pop (L, 1); } } /* Remove table from stack */ lua_pop (L, 1); } } else { return luaL_error (L, "invalid arguments"); } return 0; } static gint lua_config_add_condition (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *sym = luaL_checkstring (L, 2); gboolean ret = FALSE; gint condref; if (cfg && sym && lua_type (L, 3) == LUA_TFUNCTION) { lua_pushvalue (L, 3); condref = luaL_ref (L, LUA_REGISTRYINDEX); ret = rspamd_symbols_cache_add_condition_delayed (cfg->cache, sym, L, condref); if (!ret) { luaL_unref (L, LUA_REGISTRYINDEX, condref); } } lua_pushboolean (L, ret); return 1; } static gint lua_config_set_peak_cb (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); gint condref; if (cfg && lua_type (L, 2) == LUA_TFUNCTION) { lua_pushvalue (L, 2); condref = luaL_ref (L, LUA_REGISTRYINDEX); rspamd_symbols_cache_set_peak_callback (cfg->cache, condref); } return 0; } static gint lua_config_enable_symbol (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *sym = luaL_checkstring (L, 2); if (cfg && sym) { rspamd_symbols_cache_enable_symbol (cfg->cache, sym); } else { return luaL_error (L, "invalid arguments"); } return 0; } static gint lua_config_disable_symbol (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *sym = luaL_checkstring (L, 2); if (cfg && sym) { rspamd_symbols_cache_disable_symbol (cfg->cache, sym); } else { return luaL_error (L, "invalid arguments"); } return 0; } static gint lua_config_register_regexp (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_lua_regexp *re = NULL; rspamd_regexp_t *cache_re; const gchar *type_str = NULL, *header_str = NULL; gsize header_len = 0; GError *err = NULL; enum rspamd_re_type type = RSPAMD_RE_BODY; gboolean pcre_only = FALSE; guint old_flags; /* * - `re`* : regular expression object * - `type`*: type of regular expression: * + `mime`: mime regexp * + `rawmime`: raw mime regexp * + `header`: header regexp * + `rawheader`: raw header expression * + `body`: raw body regexp * + `url`: url regexp * - `header`: for header and rawheader regexp means the name of header * - `pcre_only`: allow merely pcre for this regexp */ if (cfg != NULL) { if (!rspamd_lua_parse_table_arguments (L, 2, &err, "*re=U{regexp};*type=S;header=S;pcre_only=B", &re, &type_str, &header_str, &pcre_only)) { msg_err_config ("cannot get parameters list: %e", err); if (err) { g_error_free (err); } } else { type = rspamd_re_cache_type_from_string (type_str); if ((type == RSPAMD_RE_HEADER || type == RSPAMD_RE_RAWHEADER || type == RSPAMD_RE_MIMEHEADER) && header_str == NULL) { msg_err_config ( "header argument is mandatory for header/rawheader regexps"); } else { if (pcre_only) { old_flags = rspamd_regexp_get_flags (re->re); old_flags |= RSPAMD_REGEXP_FLAG_PCRE_ONLY; rspamd_regexp_set_flags (re->re, old_flags); } if (header_str != NULL) { /* Include the last \0 */ header_len = strlen (header_str) + 1; } cache_re = rspamd_re_cache_add (cfg->re_cache, re->re, type, (gpointer) header_str, header_len); /* * XXX: here are dragons! * Actually, lua regexp contains internal rspamd_regexp_t * and it owns it. * However, after this operation we have some OTHER regexp, * which we really would like to use. * So we do the following: * 1) Remove old re and unref it * 2) Replace the internal re with cached one * 3) Increase its refcount to share ownership between cache and * lua object */ if (cache_re != re->re) { rspamd_regexp_unref (re->re); re->re = rspamd_regexp_ref (cache_re); } } } } return 0; } static gint lua_config_replace_regexp (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_lua_regexp *old_re = NULL, *new_re = NULL; GError *err = NULL; if (cfg != NULL) { if (!rspamd_lua_parse_table_arguments (L, 2, &err, "*old_re=U{regexp};*new_re=U{regexp}", &old_re, &new_re)) { msg_err_config ("cannot get parameters list: %e", err); if (err) { g_error_free (err); } } else { rspamd_re_cache_replace (cfg->re_cache, old_re->re, new_re->re); } } return 0; } static gint lua_config_register_worker_script (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *worker_type = luaL_checkstring (L, 2), *wtype; struct rspamd_worker_conf *cf; GList *cur; struct rspamd_worker_lua_script *sc; gboolean found = FALSE; if (cfg == NULL || worker_type == NULL || lua_type (L, 3) != LUA_TFUNCTION) { return luaL_error (L, "invalid arguments"); } for (cur = g_list_first (cfg->workers); cur != NULL; cur = g_list_next (cur)) { cf = cur->data; wtype = g_quark_to_string (cf->type); if (g_ascii_strcasecmp (wtype, worker_type) == 0) { sc = rspamd_mempool_alloc0 (cfg->cfg_pool, sizeof (*sc)); lua_pushvalue (L, 3); sc->cbref = luaL_ref (L, LUA_REGISTRYINDEX); DL_APPEND (cf->scripts, sc); found = TRUE; } } lua_pushboolean (L, found); return 1; } static gint lua_config_add_on_load (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_config_post_load_script *sc; if (cfg == NULL || lua_type (L, 2) != LUA_TFUNCTION) { return luaL_error (L, "invalid arguments"); } sc = g_malloc0 (sizeof (*sc)); lua_pushvalue (L, 2); sc->cbref = luaL_ref (L, LUA_REGISTRYINDEX); DL_APPEND (cfg->on_load, sc); return 0; } struct rspamd_lua_periodic { struct event_base *ev_base; struct rspamd_config *cfg; lua_State *L; gdouble timeout; struct event ev; gint cbref; gboolean need_jitter; }; static void lua_periodic_callback (gint unused_fd, short what, gpointer ud) { gdouble timeout; struct timeval tv; struct rspamd_lua_periodic *periodic = ud; struct rspamd_config **pcfg, *cfg; struct event_base **pev_base; lua_State *L; gint err_idx; gboolean plan_more = FALSE; GString *tb; L = periodic->L; lua_pushcfunction (L, &rspamd_lua_traceback); err_idx = lua_gettop (L); lua_rawgeti (L, LUA_REGISTRYINDEX, periodic->cbref); pcfg = lua_newuserdata (L, sizeof (*pcfg)); rspamd_lua_setclass (L, "rspamd{config}", -1); cfg = periodic->cfg; *pcfg = cfg; pev_base = lua_newuserdata (L, sizeof (*pev_base)); rspamd_lua_setclass (L, "rspamd{ev_base}", -1); *pev_base = periodic->ev_base; if (lua_pcall (L, 2, 1, err_idx) != 0) { tb = lua_touserdata (L, -1); msg_err_config ("call to finishing script failed: %v", tb); g_string_free (tb, TRUE); lua_pop (L, 2); } else { if (lua_type (L, -1) == LUA_TBOOLEAN) { plan_more = lua_toboolean (L, -1); timeout = periodic->timeout; } else if (lua_type (L, -1) == LUA_TNUMBER) { timeout = lua_tonumber (L, -1); plan_more = timeout > 0 ? TRUE : FALSE; } lua_pop (L, 2); /* Return value + error function */ } event_del (&periodic->ev); if (plan_more) { if (periodic->need_jitter) { timeout = rspamd_time_jitter (timeout, 0.0); } double_to_tv (timeout, &tv); event_add (&periodic->ev, &tv); } else { luaL_unref (L, LUA_REGISTRYINDEX, periodic->cbref); g_free (periodic); } } static gint lua_config_add_periodic (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct event_base *ev_base = lua_check_ev_base (L, 2); gdouble timeout = lua_tonumber (L, 3); struct timeval tv; struct rspamd_lua_periodic *periodic; gboolean need_jitter = FALSE; if (cfg == NULL || timeout < 0 || lua_type (L, 4) != LUA_TFUNCTION) { return luaL_error (L, "invalid arguments"); } if (lua_type (L, 5) == LUA_TBOOLEAN) { need_jitter = lua_toboolean (L, 5); } periodic = g_malloc0 (sizeof (*periodic)); periodic->timeout = timeout; periodic->L = L; periodic->cfg = cfg; periodic->ev_base = ev_base; periodic->need_jitter = need_jitter; lua_pushvalue (L, 4); periodic->cbref = luaL_ref (L, LUA_REGISTRYINDEX); event_set (&periodic->ev, -1, EV_TIMEOUT, lua_periodic_callback, periodic); event_base_set (ev_base, &periodic->ev); if (need_jitter) { timeout = rspamd_time_jitter (timeout, 0.0); } double_to_tv (timeout, &tv); event_add (&periodic->ev, &tv); return 0; } static gint lua_config_get_symbols_count (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); guint res = 0; if (cfg != NULL) { res = rspamd_symbols_cache_stats_symbols_count (cfg->cache); } else { return luaL_error (L, "invalid arguments"); } lua_pushnumber (L, res); return 1; } static gint lua_config_get_symbols_cksum (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); guint64 res = 0, *pres; if (cfg != NULL) { res = rspamd_symbols_cache_get_cksum (cfg->cache); } else { return luaL_error (L, "invalid arguments"); } pres = lua_newuserdata (L, sizeof (res)); *pres = res; rspamd_lua_setclass (L, "rspamd{int64}", -1); return 1; } static gint lua_config_get_symbols_counters (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); ucl_object_t *counters; if (cfg != NULL) { counters = rspamd_symbols_cache_counters (cfg->cache); ucl_object_push_lua (L, counters, true); ucl_object_unref (counters); } else { return luaL_error (L, "invalid arguments"); } return 1; } static void lua_metric_symbol_inserter (gpointer k, gpointer v, gpointer ud) { lua_State *L = (lua_State *) ud; const gchar *sym = k; struct rspamd_symbol *s = (struct rspamd_symbol *) v; lua_pushstring (L, sym); lua_createtable (L, 0, 3); /* TODO: add more if needed */ lua_pushstring (L, "score"); lua_pushnumber (L, s->score); lua_settable (L, -3); lua_pushstring (L, "description"); lua_pushstring (L, s->description); lua_settable (L, -3); lua_settable (L, -3); } static gint lua_config_get_symbols_scores (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); if (cfg != NULL) { lua_createtable (L, 0, g_hash_table_size (cfg->symbols)); g_hash_table_foreach (cfg->symbols, lua_metric_symbol_inserter, L); } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_get_symbol_callback (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *sym = luaL_checkstring (L, 2); struct rspamd_abstract_callback_data *abs_cbdata; struct lua_callback_data *cbd; if (cfg != NULL && sym != NULL) { abs_cbdata = rspamd_symbols_cache_get_cbdata (cfg->cache, sym); if (abs_cbdata == NULL || abs_cbdata->magic != rspamd_lua_callback_magic) { lua_pushnil (L); } else { cbd = (struct lua_callback_data *)abs_cbdata; if (cbd->cb_is_ref) { lua_rawgeti (L, LUA_REGISTRYINDEX, cbd->callback.ref); } else { lua_getglobal (L, cbd->callback.name); } } } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_set_symbol_callback (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *sym = luaL_checkstring (L, 2); struct rspamd_abstract_callback_data *abs_cbdata; struct lua_callback_data *cbd; if (cfg != NULL && sym != NULL && lua_type (L, 3) == LUA_TFUNCTION) { abs_cbdata = rspamd_symbols_cache_get_cbdata (cfg->cache, sym); if (abs_cbdata == NULL || abs_cbdata->magic != rspamd_lua_callback_magic) { lua_pushboolean (L, FALSE); } else { cbd = (struct lua_callback_data *)abs_cbdata; if (cbd->cb_is_ref) { luaL_unref (L, LUA_REGISTRYINDEX, cbd->callback.ref); } else { cbd->cb_is_ref = TRUE; } lua_pushvalue (L, 3); cbd->callback.ref = luaL_ref (L, LUA_REGISTRYINDEX); lua_pushboolean (L, TRUE); } } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_get_symbol_stat (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *sym = luaL_checkstring (L, 2); gdouble freq, stddev, tm; guint hits; if (cfg != NULL && sym != NULL) { if (!rspamd_symbols_cache_stat_symbol (cfg->cache, sym, &freq, &stddev, &tm, &hits)) { lua_pushnil (L); } else { lua_createtable (L, 0, 4); lua_pushstring (L, "frequency"); lua_pushnumber (L, freq); lua_settable (L, -3); lua_pushstring (L, "sttdev"); lua_pushnumber (L, stddev); lua_settable (L, -3); lua_pushstring (L, "time"); lua_pushnumber (L, tm); lua_settable (L, -3); lua_pushstring (L, "hits"); lua_pushnumber (L, hits); lua_settable (L, -3); } } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_register_finish_script (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_config_post_load_script *sc; if (cfg != NULL && lua_type (L, 2) == LUA_TFUNCTION) { sc = g_malloc0 (sizeof (*sc)); lua_pushvalue (L, 2); sc->cbref = luaL_ref (L, LUA_REGISTRYINDEX); DL_APPEND (cfg->finish_callbacks, sc); } else { return luaL_error (L, "invalid arguments"); } return 0; } static gint lua_config_register_monitored (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_monitored *m, **pm; const gchar *url, *type; ucl_object_t *params = NULL; url = lua_tostring (L, 2); type = lua_tostring (L, 3); if (cfg != NULL && url != NULL && type != NULL) { if (g_ascii_strcasecmp (type, "dns") == 0) { lua_Debug ar; if (lua_type (L, 4) == LUA_TTABLE) { params = ucl_object_lua_import (L, 4); } /* Get lua line and source */ lua_getstack (L, 1, &ar); lua_getinfo (L, "nSl", &ar); m = rspamd_monitored_create_ (cfg->monitored_ctx, url, RSPAMD_MONITORED_DNS, RSPAMD_MONITORED_DEFAULT, params, ar.short_src); if (m) { pm = lua_newuserdata (L, sizeof (*pm)); *pm = m; rspamd_lua_setclass (L, "rspamd{monitored}", -1); } else { lua_pushnil (L); } if (params) { ucl_object_unref (params); } } else { return luaL_error (L, "invalid monitored type: %s", type); } } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_add_doc (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg; const gchar *path = NULL, *option, *doc_string; const gchar *type_str = NULL, *default_value = NULL; ucl_type_t type = UCL_NULL; gboolean required = FALSE; GError *err = NULL; cfg = lua_check_config (L, 1); if (lua_type (L, 2 ) == LUA_TSTRING) { path = luaL_checkstring (L, 2); } option = luaL_checkstring (L, 3); doc_string = luaL_checkstring (L, 4); if (cfg && option && doc_string) { if (lua_type (L, 5) == LUA_TTABLE) { if (!rspamd_lua_parse_table_arguments (L, 5, &err, "type=S;default=S;required=B", &type_str, &default_value, &required)) { msg_err_config ("cannot get parameters list: %e", err); if (err) { g_error_free (err); } if (type_str) { if (!ucl_object_string_to_type (type_str, &type)) { msg_err_config ("invalid type: %s", type_str); } } } } rspamd_rcl_add_doc_by_path (cfg, path, doc_string, option, type, NULL, 0, default_value, required); } else { return luaL_error (L, "invalid arguments"); } return 0; } static gint lua_config_add_example (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg; const gchar *path = NULL, *option, *doc_string, *example; gsize example_len; cfg = lua_check_config (L, 1); if (lua_type (L, 2 ) == LUA_TSTRING) { path = luaL_checkstring (L, 2); } option = luaL_checkstring (L, 3); doc_string = luaL_checkstring (L, 4); example = luaL_checklstring (L, 5, &example_len); if (cfg && option && doc_string && example) { rspamd_rcl_add_doc_by_example (cfg, path, doc_string, option, example, example_len); } else { return luaL_error (L, "invalid arguments"); } return 0; } static gint lua_config_get_cpu_flags (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_cryptobox_library_ctx *crypto_ctx; if (cfg != NULL) { crypto_ctx = cfg->libs_ctx->crypto_ctx; lua_newtable (L); if (crypto_ctx->cpu_config & CPUID_SSSE3) { lua_pushstring (L, "ssse3"); lua_pushboolean (L, true); lua_settable (L, -3); } if (crypto_ctx->cpu_config & CPUID_SSE41) { lua_pushstring (L, "sse41"); lua_pushboolean (L, true); lua_settable (L, -3); } if (crypto_ctx->cpu_config & CPUID_SSE42) { lua_pushstring (L, "sse42"); lua_pushboolean (L, true); lua_settable (L, -3); } if (crypto_ctx->cpu_config & CPUID_SSE2) { lua_pushstring (L, "sse2"); lua_pushboolean (L, true); lua_settable (L, -3); } if (crypto_ctx->cpu_config & CPUID_SSE3) { lua_pushstring (L, "sse3"); lua_pushboolean (L, true); lua_settable (L, -3); } if (crypto_ctx->cpu_config & CPUID_AVX) { lua_pushstring (L, "avx"); lua_pushboolean (L, true); lua_settable (L, -3); } if (crypto_ctx->cpu_config & CPUID_AVX2) { lua_pushstring (L, "avx2"); lua_pushboolean (L, true); lua_settable (L, -3); } } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_has_torch (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); struct rspamd_cryptobox_library_ctx *crypto_ctx; if (cfg != NULL) { crypto_ctx = cfg->libs_ctx->crypto_ctx; #if !defined(WITH_TORCH) || !defined(WITH_LUAJIT) lua_pushboolean (L, false); (void)crypto_ctx; #else if (crypto_ctx->cpu_config & CPUID_SSE2) { lua_pushboolean (L, true); } else { lua_pushboolean (L, false); } #endif } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_experimental_enabled (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); if (cfg != NULL) { lua_pushboolean (L, cfg->enable_experimental); } else { return luaL_error (L, "invalid arguments"); } return 1; } #define LUA_TABLE_TO_HASH(htb, idx) do { \ lua_pushstring (L, (idx)); \ lua_gettable (L, -2); \ if (lua_isstring (L, -1)) { \ g_hash_table_insert ((htb), (idx), g_strdup (lua_tostring (L, -1))); \ } \ lua_pop (L, 1); \ } while(0) static gint lua_config_load_ucl (lua_State *L) { struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *filename; GHashTable *paths = g_hash_table_new_full (rspamd_str_hash, rspamd_str_equal, NULL, g_free); GError *err = NULL; if (cfg) { if (lua_isstring (L, 2)) { filename = lua_tostring (L, 2); } else { filename = RSPAMD_CONFDIR "/rspamd.conf"; } /* Convert rspamd_paths */ lua_getglobal (L, "rspamd_paths"); if (lua_istable (L, -1)) { LUA_TABLE_TO_HASH(paths, RSPAMD_CONFDIR_INDEX); LUA_TABLE_TO_HASH(paths, RSPAMD_RUNDIR_INDEX); LUA_TABLE_TO_HASH(paths, RSPAMD_DBDIR_INDEX); LUA_TABLE_TO_HASH(paths, RSPAMD_LOGDIR_INDEX); LUA_TABLE_TO_HASH(paths, RSPAMD_WWWDIR_INDEX); LUA_TABLE_TO_HASH(paths, RSPAMD_PLUGINSDIR_INDEX); LUA_TABLE_TO_HASH(paths, RSPAMD_RULESDIR_INDEX); LUA_TABLE_TO_HASH(paths, RSPAMD_LUALIBDIR_INDEX); LUA_TABLE_TO_HASH(paths, RSPAMD_PREFIX_INDEX); } lua_pop (L, 1); if (!rspamd_config_parse_ucl (cfg, filename, paths, &err)) { lua_pushboolean (L, false); lua_pushfstring (L, "failed to load config: %s", err->message); g_error_free (err); g_hash_table_unref (paths); return 2; } rspamd_rcl_maybe_apply_lua_transform (cfg); rspamd_config_calculate_cksum (cfg); } else { return luaL_error (L, "invalid arguments"); } g_hash_table_unref (paths); lua_pushboolean (L, true); return 1; } #undef IDX_TO_HASH static gint lua_config_parse_rcl (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); GHashTable *excluded = g_hash_table_new_full (rspamd_str_hash, rspamd_str_equal, g_free, NULL); GError *err = NULL; struct rspamd_rcl_section *top; if (cfg) { if (lua_istable (L, 2)) { lua_pushvalue (L, 2); for (lua_pushnil (L); lua_next (L, -2); lua_pop (L, 1)) { g_hash_table_insert (excluded, g_strdup (lua_tostring (L, -1)), GINT_TO_POINTER (-1)); } lua_pop (L, 1); } top = rspamd_rcl_config_init (cfg, excluded); if (!rspamd_rcl_parse (top, cfg, cfg, cfg->cfg_pool, cfg->rcl_obj, &err)) { lua_pushboolean (L, false); lua_pushfstring (L, "failed to load config: %s", err->message); g_error_free (err); g_hash_table_unref (excluded); rspamd_rcl_section_free (top); return 2; } } else { return luaL_error (L, "invalid arguments"); } g_hash_table_unref (excluded); rspamd_rcl_section_free (top); lua_pushboolean (L, true); return 1; } static gint lua_config_init_modules (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); if (cfg != NULL) { rspamd_lua_post_load_config (cfg); lua_pushboolean (L, rspamd_init_filters (cfg, FALSE)); } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_config_init_subsystem (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); const gchar *subsystem = luaL_checkstring (L, 2); gchar **parts; guint nparts, i; if (cfg != NULL && subsystem != NULL) { parts = g_strsplit_set (subsystem, ";,", -1); nparts = g_strv_length (parts); for (i = 0; i < nparts; i ++) { if (strcmp (parts[i], "filters") == 0) { rspamd_lua_post_load_config (cfg); rspamd_init_filters (cfg, FALSE); } else if (strcmp (parts[i], "langdet") == 0) { cfg->lang_det = rspamd_language_detector_init (cfg); } else if (strcmp (parts[i], "stat") == 0) { rspamd_stat_init (cfg, NULL); } else { return luaL_error (L, "invalid param: %s", parts[i]); } } } else { return luaL_error (L, "invalid arguments"); } return 0; } static gint lua_config_get_tld_path (lua_State *L) { LUA_TRACE_POINT; struct rspamd_config *cfg = lua_check_config (L, 1); if (cfg != NULL) { lua_pushstring (L, cfg->tld_file); } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_monitored_alive (lua_State *L) { LUA_TRACE_POINT; struct rspamd_monitored *m = lua_check_monitored (L, 1); if (m) { lua_pushboolean (L, rspamd_monitored_alive (m)); } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_monitored_offline (lua_State *L) { LUA_TRACE_POINT; struct rspamd_monitored *m = lua_check_monitored (L, 1); if (m) { lua_pushnumber (L, rspamd_monitored_offline_time (m)); } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_monitored_total_offline (lua_State *L) { LUA_TRACE_POINT; struct rspamd_monitored *m = lua_check_monitored (L, 1); if (m) { lua_pushnumber (L, rspamd_monitored_total_offline_time (m)); } else { return luaL_error (L, "invalid arguments"); } return 1; } static gint lua_monitored_latency (lua_State *L) { LUA_TRACE_POINT; struct rspamd_monitored *m = lua_check_monitored (L, 1); if (m) { lua_pushnumber (L, rspamd_monitored_latency (m)); } else { return luaL_error (L, "invalid arguments"); } return 1; } void luaopen_config (lua_State * L) { rspamd_lua_new_class (L, "rspamd{config}", configlib_m); lua_pop (L, 1); rspamd_lua_new_class (L, "rspamd{monitored}", monitoredlib_m); lua_pop (L, 1); } void lua_call_finish_script (lua_State *L, struct rspamd_config_post_load_script *sc, struct rspamd_task *task) { struct rspamd_task **ptask; gint err_idx; GString *tb; lua_pushcfunction (L, &rspamd_lua_traceback); err_idx = lua_gettop (L); lua_rawgeti (L, LUA_REGISTRYINDEX, sc->cbref); ptask = lua_newuserdata (L, sizeof (struct rspamd_task *)); rspamd_lua_setclass (L, "rspamd{task}", -1); *ptask = task; if (lua_pcall (L, 1, 0, err_idx) != 0) { tb = lua_touserdata (L, -1); msg_err_task ("call to finishing script failed: %v", tb); g_string_free (tb, TRUE); lua_pop (L, 1); } lua_pop (L, 1); /* Error function */ return; }