123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889 |
- /*
- * Copyright 2024 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.
- */
-
- #ifndef CFG_FILE_H
- #define CFG_FILE_H
-
- #include "config.h"
- #include "mem_pool.h"
- #include "upstream.h"
- #include "rspamd_symcache.h"
- #include "cfg_rcl.h"
- #include "ucl.h"
- #include "regexp.h"
- #include "libserver/re_cache.h"
- #include "libutil/ref.h"
- #include "libutil/radix.h"
- #include "monitored.h"
- #include "redis_pool.h"
-
- #define DEFAULT_BIND_PORT 11333
- #define DEFAULT_CONTROL_PORT 11334
-
- /* Default metric name */
- #define DEFAULT_METRIC "default"
-
- #ifdef __cplusplus
- extern "C" {
- #endif
-
- struct expression;
- struct tokenizer;
- struct rspamd_stat_classifier;
- struct module_s;
- struct worker_s;
- struct rspamd_external_libs_ctx;
- struct rspamd_cryptobox_pubkey;
- struct rspamd_dns_resolver;
-
- /**
- * Logging type
- */
- enum rspamd_log_type {
- RSPAMD_LOG_CONSOLE,
- RSPAMD_LOG_SYSLOG,
- RSPAMD_LOG_FILE
- };
-
- enum rspamd_log_cfg_flags {
- RSPAMD_LOG_FLAG_DEFAULT = 0u,
- RSPAMD_LOG_FLAG_SYSTEMD = (1u << 0u),
- RSPAMD_LOG_FLAG_COLOR = (1u << 1u),
- RSPAMD_LOG_FLAG_RE_CACHE = (1u << 2u),
- RSPAMD_LOG_FLAG_USEC = (1u << 3u),
- RSPAMD_LOG_FLAG_RSPAMADM = (1u << 4u),
- RSPAMD_LOG_FLAG_ENFORCED = (1u << 5u),
- RSPAMD_LOG_FLAG_SEVERITY = (1u << 6u),
- RSPAMD_LOG_FLAG_JSON = (1u << 7u),
- };
-
- struct rspamd_worker_log_pipe {
- int fd;
- int type;
- struct rspamd_worker_log_pipe *prev, *next;
- };
-
- /**
- * script module list item
- */
- struct script_module {
- char *name; /**< name of module */
- char *path; /**< path to module */
- char *digest;
- };
-
- enum rspamd_symbol_group_flags {
- RSPAMD_SYMBOL_GROUP_NORMAL = 0u,
- RSPAMD_SYMBOL_GROUP_DISABLED = (1u << 0u),
- RSPAMD_SYMBOL_GROUP_ONE_SHOT = (1u << 1u),
- RSPAMD_SYMBOL_GROUP_UNGROUPED = (1u << 2u),
- RSPAMD_SYMBOL_GROUP_PUBLIC = (1u << 3u),
- };
-
- /**
- * Symbols group
- */
- struct rspamd_symbol;
- struct rspamd_symbols_group {
- char *name;
- char *description;
- GHashTable *symbols;
- double max_score;
- unsigned int flags;
- };
-
- enum rspamd_symbol_flags {
- RSPAMD_SYMBOL_FLAG_NORMAL = 0,
- RSPAMD_SYMBOL_FLAG_IGNORE_METRIC = (1 << 1),
- RSPAMD_SYMBOL_FLAG_ONEPARAM = (1 << 2),
- RSPAMD_SYMBOL_FLAG_UNGROUPED = (1 << 3),
- RSPAMD_SYMBOL_FLAG_DISABLED = (1 << 4),
- RSPAMD_SYMBOL_FLAG_UNSCORED = (1 << 5),
- };
-
- /**
- * Symbol config definition
- */
- struct rspamd_symbol {
- char *name;
- char *description;
- double *weight_ptr;
- double score;
- unsigned int priority;
- struct rspamd_symbols_group *gr; /* Main group */
- GPtrArray *groups; /* Other groups */
- unsigned int flags;
- void *cache_item;
- int nshots;
- };
-
- /**
- * Statfile config definition
- */
- struct rspamd_statfile_config {
- char *symbol; /**< symbol of statfile */
- char *label; /**< label of this statfile */
- ucl_object_t *opts; /**< other options */
- gboolean is_spam; /**< spam flag */
- struct rspamd_classifier_config *clcf; /**< parent pointer of classifier configuration */
- gpointer data; /**< opaque data */
- };
-
- struct rspamd_tokenizer_config {
- const ucl_object_t *opts; /**< other options */
- const char *name; /**< name of tokenizer */
- };
-
-
- /* Classifier has all integer values (e.g. bayes) */
- #define RSPAMD_FLAG_CLASSIFIER_INTEGER (1 << 0)
- /*
- * Set if backend for a classifier is intended to increment and not set values
- * (e.g. redis)
- */
- #define RSPAMD_FLAG_CLASSIFIER_INCREMENTING_BACKEND (1 << 1)
- /*
- * No backend required for classifier
- */
- #define RSPAMD_FLAG_CLASSIFIER_NO_BACKEND (1 << 2)
-
- /**
- * Classifier config definition
- */
- struct rspamd_classifier_config {
- GList *statfiles; /**< statfiles list */
- GHashTable *labels; /**< statfiles with labels */
- char *metric; /**< metric of this classifier */
- char *classifier; /**< classifier interface */
- struct rspamd_tokenizer_config *tokenizer; /**< tokenizer used for classifier */
- const char *backend; /**< name of statfile's backend */
- ucl_object_t *opts; /**< other options */
- GList *learn_conditions; /**< list of learn condition callbacks */
- GList *classify_conditions; /**< list of classify condition callbacks */
- char *name; /**< unique name of classifier */
- uint32_t min_tokens; /**< minimal number of tokens to process classifier */
- uint32_t max_tokens; /**< maximum number of tokens */
- unsigned int min_token_hits; /**< minimum number of hits for a token to be considered */
- double min_prob_strength; /**< use only tokens with probability in [0.5 - MPS, 0.5 + MPS] */
- unsigned int min_learns; /**< minimum number of learns for each statfile */
- unsigned int flags;
- };
-
- struct rspamd_worker_bind_conf {
- GPtrArray *addrs;
- unsigned int cnt;
- char *name;
- char *bind_line;
- gboolean is_systemd;
- struct rspamd_worker_bind_conf *next;
- };
-
- struct rspamd_worker_lua_script {
- int cbref;
- struct rspamd_worker_lua_script *prev, *next;
- };
-
- /**
- * Config params for rspamd worker
- */
- struct rspamd_worker_conf {
- struct worker_s *worker; /**< pointer to worker type */
- GQuark type; /**< type of worker */
- struct rspamd_worker_bind_conf *bind_conf; /**< bind configuration */
- int16_t count; /**< number of workers */
- GList *listen_socks; /**< listening sockets descriptors */
- uint64_t rlimit_nofile; /**< max files limit */
- uint64_t rlimit_maxcore; /**< maximum core file size */
- GHashTable *params; /**< params for worker */
- GQueue *active_workers; /**< linked list of spawned workers */
- gpointer ctx; /**< worker's context */
- ucl_object_t *options; /**< other worker's options */
- struct rspamd_worker_lua_script *scripts; /**< registered lua scripts */
- gboolean enabled;
- ref_entry_t ref;
- };
-
- enum rspamd_log_format_type {
- RSPAMD_LOG_STRING = 0,
- RSPAMD_LOG_MID,
- RSPAMD_LOG_QID,
- RSPAMD_LOG_USER,
- RSPAMD_LOG_ISSPAM,
- RSPAMD_LOG_ACTION,
- RSPAMD_LOG_SCORES,
- RSPAMD_LOG_SYMBOLS,
- RSPAMD_LOG_IP,
- RSPAMD_LOG_LEN,
- RSPAMD_LOG_DNS_REQ,
- RSPAMD_LOG_SMTP_FROM,
- RSPAMD_LOG_MIME_FROM,
- RSPAMD_LOG_SMTP_RCPT,
- RSPAMD_LOG_MIME_RCPT,
- RSPAMD_LOG_SMTP_RCPTS,
- RSPAMD_LOG_MIME_RCPTS,
- RSPAMD_LOG_TIME_REAL,
- RSPAMD_LOG_TIME_VIRTUAL,
- RSPAMD_LOG_LUA,
- RSPAMD_LOG_DIGEST,
- RSPAMD_LOG_FILENAME,
- RSPAMD_LOG_FORCED_ACTION,
- RSPAMD_LOG_SETTINGS_ID,
- RSPAMD_LOG_GROUPS,
- RSPAMD_LOG_PUBLIC_GROUPS,
- RSPAMD_LOG_MEMPOOL_SIZE,
- RSPAMD_LOG_MEMPOOL_WASTE,
- };
-
- enum rspamd_log_format_flags {
- RSPAMD_LOG_FMT_FLAG_DEFAULT = 0,
- RSPAMD_LOG_FMT_FLAG_OPTIONAL = (1 << 0),
- RSPAMD_LOG_FMT_FLAG_MIME_ALTERNATIVE = (1 << 1),
- RSPAMD_LOG_FMT_FLAG_CONDITION = (1 << 2),
- RSPAMD_LOG_FMT_FLAG_SYMBOLS_SCORES = (1 << 3),
- RSPAMD_LOG_FMT_FLAG_SYMBOLS_PARAMS = (1 << 4)
- };
-
- struct rspamd_log_format {
- enum rspamd_log_format_type type;
- unsigned int flags;
- gsize len;
- gpointer data;
- struct rspamd_log_format *prev, *next;
- };
-
- /**
- * Standard actions
- */
- enum rspamd_action_type {
- METRIC_ACTION_REJECT = 0,
- METRIC_ACTION_SOFT_REJECT,
- METRIC_ACTION_REWRITE_SUBJECT,
- METRIC_ACTION_ADD_HEADER,
- METRIC_ACTION_GREYLIST,
- METRIC_ACTION_NOACTION,
- METRIC_ACTION_MAX,
- METRIC_ACTION_CUSTOM = 999,
- METRIC_ACTION_DISCARD,
- METRIC_ACTION_QUARANTINE
- };
-
- enum rspamd_action_flags {
- RSPAMD_ACTION_NORMAL = 0u,
- RSPAMD_ACTION_NO_THRESHOLD = (1u << 0u),
- RSPAMD_ACTION_THRESHOLD_ONLY = (1u << 1u),
- RSPAMD_ACTION_HAM = (1u << 2u),
- RSPAMD_ACTION_MILTER = (1u << 3u),
- };
-
-
- struct rspamd_action;
-
- struct rspamd_config_cfg_lua_script {
- int cbref;
- int priority;
- char *lua_src_pos;
- struct rspamd_config_cfg_lua_script *prev, *next;
- };
-
- struct rspamd_config_post_init_script {
- int cbref;
- struct rspamd_config_post_init_script *prev, *next;
- };
-
- struct rspamd_lang_detector;
- struct rspamd_rcl_sections_map;
-
- enum rspamd_config_settings_policy {
- RSPAMD_SETTINGS_POLICY_DEFAULT = 0,
- RSPAMD_SETTINGS_POLICY_IMPLICIT_ALLOW = 1,
- RSPAMD_SETTINGS_POLICY_IMPLICIT_DENY = 2,
- };
-
- enum rspamd_gtube_patterns_policy {
- RSPAMD_GTUBE_DISABLED = 0, /* Disabled */
- RSPAMD_GTUBE_REJECT, /* Reject message with GTUBE pattern */
- RSPAMD_GTUBE_ALL /* Check all GTUBE like patterns */
- };
-
- struct rspamd_config_settings_elt {
- uint32_t id;
- enum rspamd_config_settings_policy policy;
- const char *name;
- ucl_object_t *symbols_enabled;
- ucl_object_t *symbols_disabled;
- struct rspamd_config_settings_elt *prev, *next;
- ref_entry_t ref;
- };
-
- /**
- * Structure that stores all config data
- */
- struct rspamd_config {
- char *rspamd_user; /**< user to run as */
- char *rspamd_group; /**< group to run as */
- rspamd_mempool_t *cfg_pool; /**< memory pool for config */
- char *cfg_name; /**< name of config file */
- char *pid_file; /**< name of pid file */
- char *temp_dir; /**< dir for temp files */
- char *control_socket_path; /**< path to the control socket */
- const ucl_object_t *local_addrs; /**< tree of local addresses */
- #ifdef WITH_GPERF_TOOLS
- char *profile_path;
- #endif
- double unknown_weight; /**< weight of unknown symbols */
- double grow_factor; /**< grow factor for metric */
- GHashTable *symbols; /**< weights of symbols in metric */
- const char *subject; /**< subject rewrite string */
- GHashTable *groups; /**< groups of symbols */
- void *actions; /**< all actions of the metric (opaque type) */
-
- gboolean one_shot_mode; /**< rules add only one symbol */
- gboolean check_text_attachements; /**< check text attachements as text */
- gboolean check_all_filters; /**< check all filters */
- gboolean allow_raw_input; /**< scan messages with invalid mime */
- gboolean disable_hyperscan; /**< disable hyperscan usage */
- gboolean vectorized_hyperscan; /**< use vectorized hyperscan matching */
- gboolean enable_shutdown_workaround; /**< enable workaround for legacy SA clients (exim) */
- gboolean ignore_received; /**< Ignore data from the first received header */
- gboolean enable_sessions_cache; /**< Enable session cache for debug */
- gboolean enable_experimental; /**< Enable experimental plugins */
- gboolean disable_pcre_jit; /**< Disable pcre JIT */
- gboolean own_lua_state; /**< True if we have created lua_state internally */
- gboolean soft_reject_on_timeout; /**< If true emit soft reject on task timeout (if not reject) */
- gboolean public_groups_only; /**< Output merely public groups everywhere */
- enum rspamd_gtube_patterns_policy gtube_patterns_policy; /**< Enable test patterns */
- gboolean enable_css_parser; /**< Enable css parsing in HTML */
-
- gsize max_cores_size; /**< maximum size occupied by rspamd core files */
- gsize max_cores_count; /**< maximum number of core files */
- char *cores_dir; /**< directory for core files */
- gsize max_message; /**< maximum size for messages */
- gsize max_pic_size; /**< maximum size for a picture to process */
- gsize images_cache_size; /**< size of LRU cache for DCT data from images */
- double task_timeout; /**< maximum message processing time */
- int default_max_shots; /**< default maximum count of symbols hits permitted (-1 for unlimited) */
- int32_t heartbeats_loss_max; /**< number of heartbeats lost to consider worker's termination */
- double heartbeat_interval; /**< interval for heartbeats for workers */
-
- enum rspamd_log_type log_type; /**< log type */
- int log_facility; /**< log facility in case of syslog */
- int log_level; /**< log level trigger */
- char *log_file; /**< path to logfile in case of file logging */
- gboolean log_buffered; /**< whether logging is buffered */
- gboolean log_silent_workers; /**< silence info messages from workers */
- uint32_t log_buf_size; /**< length of log buffer */
- const ucl_object_t *debug_ip_map; /**< turn on debugging for specified ip addresses */
- gboolean log_urls; /**< whether we should log URLs */
- GHashTable *debug_modules; /**< logging modules to debug */
- struct rspamd_cryptobox_pubkey *log_encryption_key; /**< encryption key for logs */
- unsigned int log_flags; /**< logging flags */
- unsigned int log_error_elts; /**< number of elements in error logbuf */
- unsigned int log_error_elt_maxlen; /**< maximum size of error log element */
- unsigned int log_task_max_elts; /**< maximum number of elements in task logging */
- struct rspamd_worker_log_pipe *log_pipes;
-
- gboolean compat_messages; /**< use old messages in the protocol (array) */
-
- GPtrArray *script_modules; /**< a list of script modules to load */
- GHashTable *explicit_modules; /**< modules that should be always loaded */
-
- GList *filters; /**< linked list of all filters */
- GList *workers; /**< linked list of all workers params */
- struct rspamd_rcl_sections_map *rcl_top_section; /**< top section for RCL config */
- ucl_object_t *cfg_ucl_obj; /**< ucl object */
- ucl_object_t *config_comments; /**< comments saved from the config */
- ucl_object_t *doc_strings; /**< documentation strings for config options */
- GPtrArray *c_modules; /**< list of C modules */
- void *composites_manager; /**< hash of composite symbols indexed by its name */
- GList *classifiers; /**< list of all classifiers defined */
- GList *statfiles; /**< list of all statfiles in config file order */
- GHashTable *classifiers_symbols; /**< hashtable indexed by symbol name of classifiers */
- GHashTable *cfg_params; /**< all cfg params indexed by its name in this structure */
- char *dynamic_conf; /**< path to dynamic configuration */
- ucl_object_t *current_dynamic_conf; /**< currently loaded dynamic configuration */
- int clock_res; /**< resolution of clock used */
-
- GList *maps; /**< maps active */
- double map_timeout; /**< maps watch timeout */
- double map_file_watch_multiplier; /**< multiplier for watch timeout when maps are files */
- char *maps_cache_dir; /**< where to save HTTP cached data */
-
- double monitored_interval; /**< interval between monitored checks */
- gboolean disable_monitored; /**< disable monitoring completely */
- gboolean fips_mode; /**< turn on fips mode for openssl */
-
- struct rspamd_symcache *cache; /**< symbols cache object */
- char *cache_filename; /**< filename of cache file */
- double cache_reload_time; /**< how often cache reload should be performed */
- char *checksum; /**< real checksum of config file */
- gpointer lua_state; /**< pointer to lua state */
- gpointer lua_thread_pool; /**< pointer to lua thread (coroutine) pool */
-
- char *rrd_file; /**< rrd file to store statistics */
- char *history_file; /**< file to save rolling history */
- char *stats_file; /**< file to save stats */
- char *tld_file; /**< file to load effective tld list from */
- char *hs_cache_dir; /**< directory to save hyperscan databases */
- char *events_backend; /**< string representation of the events backend used */
-
- double dns_timeout; /**< timeout in milliseconds for waiting for dns reply */
- uint32_t dns_retransmits; /**< maximum retransmits count */
- uint32_t dns_io_per_server; /**< number of sockets per DNS server */
- const ucl_object_t *nameservers; /**< list of nameservers or NULL to parse resolv.conf */
- uint32_t dns_max_requests; /**< limit of DNS requests per task */
- gboolean enable_dnssec; /**< enable dnssec stub resolver */
-
- unsigned int upstream_max_errors; /**< upstream max errors before shutting off */
- double upstream_error_time; /**< rate of upstream errors */
- double upstream_revive_time; /**< revive timeout for upstreams */
- double upstream_lazy_resolve_time; /**< lazy resolve time for upstreams */
- struct upstream_ctx *ups_ctx; /**< upstream context */
- struct rspamd_dns_resolver *dns_resolver; /**< dns resolver if loaded */
-
- unsigned int min_word_len; /**< minimum length of the word to be considered */
- unsigned int max_word_len; /**< maximum length of the word to be considered */
- unsigned int words_decay; /**< limit for words for starting adaptive ignoring */
- unsigned int history_rows; /**< number of history rows stored */
- unsigned int max_sessions_cache; /**< maximum number of sessions cache elts */
- unsigned int lua_gc_step; /**< lua gc step */
- unsigned int lua_gc_pause; /**< lua gc pause */
- unsigned int full_gc_iters; /**< iterations between full gc cycle */
- unsigned int max_lua_urls; /**< maximum number of urls to be passed to Lua */
- unsigned int max_urls; /**< maximum number of urls to be processed in general */
- int max_recipients; /**< maximum number of recipients to be processed */
- unsigned int max_blas_threads; /**< maximum threads for openblas when learning ANN */
- unsigned int max_opts_len; /**< maximum length for all options for a symbol */
- gsize max_html_len; /**< maximum length of HTML document */
-
- struct module_s **compiled_modules; /**< list of compiled C modules */
- struct worker_s **compiled_workers; /**< list of compiled C modules */
- struct rspamd_log_format *log_format; /**< parsed log format */
- char *log_format_str; /**< raw log format string */
-
- struct rspamd_external_libs_ctx *libs_ctx; /**< context for external libraries */
- struct rspamd_monitored_ctx *monitored_ctx; /**< context for monitored resources */
- void *redis_pool; /**< redis connection pool */
-
- struct rspamd_re_cache *re_cache; /**< static regexp cache */
-
- GHashTable *trusted_keys; /**< list of trusted public keys */
-
- struct rspamd_config_cfg_lua_script *on_load_scripts; /**< list of scripts executed on workers load */
- struct rspamd_config_cfg_lua_script *post_init_scripts; /**< list of scripts executed on config being fully loaded */
- struct rspamd_config_cfg_lua_script *on_term_scripts; /**< list of callbacks called on worker's termination */
- struct rspamd_config_cfg_lua_script *config_unload_scripts; /**< list of scripts executed on config unload */
-
- char *ssl_ca_path; /**< path to CA certs */
- char *ssl_ciphers; /**< set of preferred ciphers */
- char *zstd_input_dictionary; /**< path to zstd input dictionary */
- char *zstd_output_dictionary; /**< path to zstd output dictionary */
- ucl_object_t *neighbours; /**< other servers in the cluster */
-
- struct rspamd_config_settings_elt *setting_ids; /**< preprocessed settings ids */
- struct rspamd_lang_detector *lang_det; /**< language detector */
- struct rspamd_worker *cur_worker; /**< set dynamically by each worker */
-
- ref_entry_t ref; /**< reference counter */
- };
-
-
- /**
- * Parse bind credits
- * @param cf config file to use
- * @param str line that presents bind line
- * @param type type of credits
- * @return 1 if line was successfully parsed and 0 in case of error
- */
- gboolean rspamd_parse_bind_line(struct rspamd_config *cfg,
- struct rspamd_worker_conf *cf, const char *str);
-
-
- enum rspamd_config_init_flags {
- RSPAMD_CONFIG_INIT_DEFAULT = 0u,
- RSPAMD_CONFIG_INIT_SKIP_LUA = (1u << 0u),
- RSPAMD_CONFIG_INIT_WIPE_LUA_MEM = (1u << 1u),
- };
-
- /**
- * Init default values
- * @param cfg config file
- */
- struct rspamd_config *rspamd_config_new(enum rspamd_config_init_flags flags);
-
- /**
- * Free memory used by config structure
- * @param cfg config file
- */
- void rspamd_config_free(struct rspamd_config *cfg);
-
- /**
- * Gets module option with specified name
- * @param cfg config file
- * @param module_name name of module
- * @param opt_name name of option to get
- * @return module value or NULL if option does not defined
- */
- const ucl_object_t *rspamd_config_get_module_opt(struct rspamd_config *cfg,
- const char *module_name,
- const char *opt_name) G_GNUC_WARN_UNUSED_RESULT;
-
-
- /**
- * Parse flag
- * @param str string representation of flag (eg. 'on')
- * @return numeric value of flag (0 or 1)
- */
- int rspamd_config_parse_flag(const char *str, unsigned int len);
-
- enum rspamd_post_load_options {
- RSPAMD_CONFIG_INIT_URL = 1 << 0,
- RSPAMD_CONFIG_INIT_LIBS = 1 << 1,
- RSPAMD_CONFIG_INIT_SYMCACHE = 1 << 2,
- RSPAMD_CONFIG_INIT_VALIDATE = 1 << 3,
- RSPAMD_CONFIG_INIT_NO_TLD = 1 << 4,
- RSPAMD_CONFIG_INIT_PRELOAD_MAPS = 1 << 5,
- RSPAMD_CONFIG_INIT_POST_LOAD_LUA = 1 << 6,
- };
-
- #define RSPAMD_CONFIG_LOAD_ALL (RSPAMD_CONFIG_INIT_URL | \
- RSPAMD_CONFIG_INIT_LIBS | \
- RSPAMD_CONFIG_INIT_SYMCACHE | \
- RSPAMD_CONFIG_INIT_VALIDATE | \
- RSPAMD_CONFIG_INIT_PRELOAD_MAPS | \
- RSPAMD_CONFIG_INIT_POST_LOAD_LUA)
-
- /**
- * Do post load actions for config
- * @param cfg config file
- */
- gboolean rspamd_config_post_load(struct rspamd_config *cfg,
- enum rspamd_post_load_options opts);
-
- /*
- * Return a new classifier_config structure, setting default and non-conflicting attributes
- */
- struct rspamd_classifier_config *rspamd_config_new_classifier(
- struct rspamd_config *cfg,
- struct rspamd_classifier_config *c);
-
- /*
- * Return a new worker_conf structure, setting default and non-conflicting attributes
- */
- struct rspamd_worker_conf *rspamd_config_new_worker(struct rspamd_config *cfg,
- struct rspamd_worker_conf *c);
-
- /*
- * Return a new metric structure, setting default and non-conflicting attributes
- */
- void rspamd_config_init_metric(struct rspamd_config *cfg);
-
- /*
- * Return new symbols group definition
- */
- struct rspamd_symbols_group *rspamd_config_new_group(
- struct rspamd_config *cfg,
- const char *name);
-
- /*
- * Return a new statfile structure, setting default and non-conflicting attributes
- */
- struct rspamd_statfile_config *rspamd_config_new_statfile(
- struct rspamd_config *cfg,
- struct rspamd_statfile_config *c);
-
- /*
- * Register symbols of classifiers inside metrics
- */
- void rspamd_config_insert_classify_symbols(struct rspamd_config *cfg);
-
- /*
- * Check statfiles inside a classifier
- */
- gboolean rspamd_config_check_statfiles(struct rspamd_classifier_config *cf);
-
- /*
- * Find classifier config by name
- */
- struct rspamd_classifier_config *rspamd_config_find_classifier(
- struct rspamd_config *cfg,
- const char *name);
-
- void rspamd_ucl_add_conf_macros(struct ucl_parser *parser,
- struct rspamd_config *cfg);
-
- void rspamd_ucl_add_conf_variables(struct ucl_parser *parser, GHashTable *vars);
-
- /**
- * Initialize rspamd filtering system (lua and C filters)
- * @param cfg
- * @param reconfig
- * @return
- */
- gboolean rspamd_init_filters(struct rspamd_config *cfg, bool reconfig, bool strict);
-
- /**
- * Add new symbol to the metric
- * @param cfg
- * @param metric metric's name (or NULL for the default metric)
- * @param symbol symbol's name
- * @param score symbol's score
- * @param description optional description
- * @param group optional group name
- * @param one_shot TRUE if symbol can add its score once
- * @param rewrite_existing TRUE if we need to rewrite the existing symbol
- * @param priority use the following priority for a symbol
- * @param nshots means maximum number of hits for a symbol in metric (-1 for unlimited)
- * @return TRUE if symbol has been inserted or FALSE if symbol already exists with higher priority
- */
- gboolean rspamd_config_add_symbol(struct rspamd_config *cfg,
- const char *symbol,
- double score,
- const char *description,
- const char *group,
- unsigned int flags,
- unsigned int priority,
- int nshots);
-
- /**
- * Adds new group for a symbol
- * @param cfg
- * @param symbol
- * @param group
- * @return
- */
- gboolean rspamd_config_add_symbol_group(struct rspamd_config *cfg,
- const char *symbol,
- const char *group);
-
- /**
- * Sets action score for a specified metric with the specified priority
- * @param cfg config file
- * @param metric metric name (or NULL for default metric)
- * @param action_name symbolic name of action
- * @param obj data to set for action
- * @return TRUE if symbol has been inserted or FALSE if action already exists with higher priority
- */
- gboolean rspamd_config_set_action_score(struct rspamd_config *cfg,
- const char *action_name,
- const ucl_object_t *obj);
-
- /**
- * Check priority and maybe disable action completely
- * @param cfg
- * @param action_name
- * @param priority
- * @return
- */
- gboolean rspamd_config_maybe_disable_action(struct rspamd_config *cfg,
- const char *action_name,
- unsigned int priority);
-
- /**
- * Checks if a specified C or lua module is enabled or disabled in the config.
- * The logic of check is the following:
- *
- * - For C modules, we check `filters` line and enable module only if it is found there
- * - For LUA modules we check the corresponding configuration section:
- * - if section exists, then we check `enabled` key and check its value
- * - if section is absent, we consider module as disabled
- * - For both C and LUA modules we check if the group with the module name is disabled in the default metric
- * @param cfg config file
- * @param module_name module name
- * @return TRUE if a module is enabled
- */
- gboolean rspamd_config_is_module_enabled(struct rspamd_config *cfg,
- const char *module_name);
-
- /**
- * Verifies enabled/disabled combination in the specified object
- * @param obj
- * @return TRUE if there is no explicit disable in the object found
- */
- gboolean rspamd_config_is_enabled_from_ucl(rspamd_mempool_t *pool,
- const ucl_object_t *obj);
-
- /*
- * Get action from a string
- */
- gboolean rspamd_action_from_str(const char *data, enum rspamd_action_type *result);
-
- /*
- * Return textual representation of action enumeration
- */
- const char *rspamd_action_to_str(enum rspamd_action_type action);
-
- const char *rspamd_action_to_str_alt(enum rspamd_action_type action);
-
- /**
- * Parse radix tree or radix map from ucl object
- * @param cfg configuration object
- * @param obj ucl object with parameter
- * @param target target radix tree
- * @param err error pointer
- * @return
- */
- struct rspamd_radix_map_helper;
-
- gboolean rspamd_config_radix_from_ucl(struct rspamd_config *cfg, const ucl_object_t *obj, const char *description,
- struct rspamd_radix_map_helper **target, GError **err,
- struct rspamd_worker *worker, const char *map_name);
-
- /**
- * Adds new settings id to be preprocessed
- * @param cfg
- * @param name
- * @param symbols_enabled (ownership is transferred to callee)
- * @param symbols_disabled (ownership is transferred to callee)
- */
- void rspamd_config_register_settings_id(struct rspamd_config *cfg,
- const char *name,
- ucl_object_t *symbols_enabled,
- ucl_object_t *symbols_disabled,
- enum rspamd_config_settings_policy policy);
-
- /**
- * Convert settings name to settings id
- * @param name
- * @param namelen
- * @return
- */
- uint32_t rspamd_config_name_to_id(const char *name, gsize namelen);
-
- /**
- * Finds settings id element and obtain reference count (must be unrefed by caller)
- * @param cfg
- * @param id
- * @return
- */
- struct rspamd_config_settings_elt *rspamd_config_find_settings_id_ref(
- struct rspamd_config *cfg,
- uint32_t id);
-
- /**
- * Finds settings id element and obtain reference count (must be unrefed by callee)
- * @param cfg
- * @param id
- * @return
- */
- struct rspamd_config_settings_elt *rspamd_config_find_settings_name_ref(
- struct rspamd_config *cfg,
- const char *name, gsize namelen);
-
- /**
- * Returns action object by name
- * @param cfg
- * @param name
- * @return
- */
- struct rspamd_action *rspamd_config_get_action(struct rspamd_config *cfg,
- const char *name);
-
- struct rspamd_action *rspamd_config_get_action_by_type(struct rspamd_config *cfg,
- enum rspamd_action_type type);
-
- /**
- * Iterate over all actions
- * @param cfg
- * @param func
- * @param data
- */
- void rspamd_config_actions_foreach(struct rspamd_config *cfg,
- void (*func)(struct rspamd_action *act, void *d),
- void *data);
- /**
- * Iterate over all actions with index
- * @param cfg
- * @param func
- * @param data
- */
- void rspamd_config_actions_foreach_enumerate(struct rspamd_config *cfg,
- void (*func)(int idx, struct rspamd_action *act, void *d),
- void *data);
-
- /**
- * Returns number of actions defined in the config
- * @param cfg
- * @return
- */
- gsize rspamd_config_actions_size(struct rspamd_config *cfg);
-
- int rspamd_config_ev_backend_get(struct rspamd_config *cfg);
- const char *rspamd_config_ev_backend_to_string(int ev_backend, gboolean *effective);
-
- struct rspamd_external_libs_ctx;
-
- /**
- * Initialize rspamd libraries
- */
- struct rspamd_external_libs_ctx *rspamd_init_libs(void);
-
- /**
- * Reset and initialize decompressor
- * @param ctx
- */
- gboolean rspamd_libs_reset_decompression(struct rspamd_external_libs_ctx *ctx);
-
- /**
- * Reset and initialize compressor
- * @param ctx
- */
- gboolean rspamd_libs_reset_compression(struct rspamd_external_libs_ctx *ctx);
-
- /**
- * Destroy external libraries context
- */
- void rspamd_deinit_libs(struct rspamd_external_libs_ctx *ctx);
-
- /**
- * Returns TRUE if an address belongs to some local address
- */
- gboolean rspamd_ip_is_local_cfg(struct rspamd_config *cfg,
- const rspamd_inet_addr_t *addr);
-
- /**
- * Configure libraries
- */
- gboolean rspamd_config_libs(struct rspamd_external_libs_ctx *ctx,
- struct rspamd_config *cfg);
-
-
- #define msg_err_config(...) rspamd_default_log_function(G_LOG_LEVEL_CRITICAL, \
- cfg->cfg_pool->tag.tagname, cfg->checksum, \
- RSPAMD_LOG_FUNC, \
- __VA_ARGS__)
- #define msg_err_config_forced(...) rspamd_default_log_function((int) G_LOG_LEVEL_CRITICAL | (int) RSPAMD_LOG_FORCED, \
- cfg->cfg_pool->tag.tagname, cfg->checksum, \
- RSPAMD_LOG_FUNC, \
- __VA_ARGS__)
- #define msg_warn_config(...) rspamd_default_log_function(G_LOG_LEVEL_WARNING, \
- cfg->cfg_pool->tag.tagname, cfg->checksum, \
- RSPAMD_LOG_FUNC, \
- __VA_ARGS__)
- #define msg_info_config(...) rspamd_default_log_function(G_LOG_LEVEL_INFO, \
- cfg->cfg_pool->tag.tagname, cfg->checksum, \
- RSPAMD_LOG_FUNC, \
- __VA_ARGS__)
- extern unsigned int rspamd_config_log_id;
- #define msg_debug_config(...) rspamd_conditional_debug_fast(NULL, NULL, \
- rspamd_config_log_id, "config", cfg->checksum, \
- RSPAMD_LOG_FUNC, \
- __VA_ARGS__)
-
- #ifdef __cplusplus
- }
- #endif
-
- #endif /* ifdef CFG_FILE_H */
|