diff options
Diffstat (limited to 'src/rspamadm/configtest.c')
| -rw-r--r-- | src/rspamadm/configtest.c | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/src/rspamadm/configtest.c b/src/rspamadm/configtest.c new file mode 100644 index 0000000..8f1482f --- /dev/null +++ b/src/rspamadm/configtest.c @@ -0,0 +1,190 @@ +/* + * Copyright 2023 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 "config.h" +#include "rspamadm.h" +#include "cfg_file.h" +#include "cfg_rcl.h" +#include "rspamd.h" +#include "lua/lua_common.h" + +static gboolean quiet = FALSE; +static gchar *config = NULL; +static gboolean strict = FALSE; +static gboolean skip_template = FALSE; +extern struct rspamd_main *rspamd_main; +/* Defined in modules.c */ +extern module_t *modules[]; +extern worker_t *workers[]; + +static void rspamadm_configtest(gint argc, gchar **argv, + const struct rspamadm_command *cmd); +static const char *rspamadm_configtest_help(gboolean full_help, + const struct rspamadm_command *cmd); + +struct rspamadm_command configtest_command = { + .name = "configtest", + .flags = 0, + .help = rspamadm_configtest_help, + .run = rspamadm_configtest, + .lua_subrs = NULL, +}; + +static GOptionEntry entries[] = { + {"quiet", 'q', 0, G_OPTION_ARG_NONE, &quiet, + "Suppress output", NULL}, + {"config", 'c', 0, G_OPTION_ARG_STRING, &config, + "Config file to test", NULL}, + {"strict", 's', 0, G_OPTION_ARG_NONE, &strict, + "Stop on any error in config", NULL}, + {"skip-template", 'T', 0, G_OPTION_ARG_NONE, &skip_template, + "Do not apply Jinja templates", NULL}, + {NULL, 0, 0, G_OPTION_ARG_NONE, NULL, NULL, NULL}}; + +static const char * +rspamadm_configtest_help(gboolean full_help, const struct rspamadm_command *cmd) +{ + const char *help_str; + + if (full_help) { + help_str = "Perform configuration file test\n\n" + "Usage: rspamadm configtest [-q -c <config_name>]\n" + "Where options are:\n\n" + "-q: quiet output\n" + "-c: config file to test\n" + "--help: shows available options and commands"; + } + else { + help_str = "Perform configuration file test"; + } + + return help_str; +} + +static void +config_logger(rspamd_mempool_t *pool, gpointer ud) +{ +} + +static void +rspamadm_configtest(gint argc, gchar **argv, const struct rspamadm_command *cmd) +{ + GOptionContext *context; + GError *error = NULL; + const gchar *confdir; + struct rspamd_config *cfg = rspamd_main->cfg; + gboolean ret = TRUE; + worker_t **pworker; + const guint64 *log_cnt; + + context = g_option_context_new( + "configtest - perform configuration file test"); + g_option_context_set_summary(context, + "Summary:\n Rspamd administration utility version " RVERSION + "\n Release id: " RID); + g_option_context_add_main_entries(context, entries, NULL); + + if (!g_option_context_parse(context, &argc, &argv, &error)) { + fprintf(stderr, "option parsing failed: %s\n", error->message); + g_error_free(error); + g_option_context_free(context); + exit(EXIT_FAILURE); + } + + g_option_context_free(context); + + if (config == NULL) { + static gchar fbuf[PATH_MAX]; + + if ((confdir = g_hash_table_lookup(ucl_vars, "CONFDIR")) == NULL) { + confdir = RSPAMD_CONFDIR; + } + + rspamd_snprintf(fbuf, sizeof(fbuf), "%s%c%s", + confdir, G_DIR_SEPARATOR, + "rspamd.conf"); + config = fbuf; + } + + pworker = &workers[0]; + while (*pworker) { + /* Init string quarks */ + (void) g_quark_from_static_string((*pworker)->name); + pworker++; + } + + cfg->compiled_modules = modules; + cfg->compiled_workers = workers; + cfg->cfg_name = config; + + if (!rspamd_config_read(cfg, cfg->cfg_name, config_logger, rspamd_main, + ucl_vars, skip_template, lua_env)) { + ret = FALSE; + } + else { + /* Do post-load actions */ + rspamd_lua_post_load_config(cfg); + + if (!rspamd_init_filters(rspamd_main->cfg, false, strict)) { + ret = FALSE; + } + + if (ret) { + ret = rspamd_config_post_load(cfg, RSPAMD_CONFIG_INIT_SYMCACHE); + } + + if (ret && !rspamd_symcache_validate(cfg->cache, + cfg, + FALSE)) { + ret = FALSE; + } + + if (ret) { + if (rspamd_lua_require_function(cfg->lua_state, "lua_cfg_utils", "check_configuration_errors")) { + GError *err = NULL; + + if (!rspamd_lua_universal_pcall(cfg->lua_state, -1, G_STRLOC, 1, "", &err)) { + msg_err_config("call to lua function failed: %s", + lua_tostring(cfg->lua_state, -1)); + lua_pop(cfg->lua_state, 2); + ret = FALSE; + } + else { + ret = lua_toboolean(cfg->lua_state, -1); + lua_pop(cfg->lua_state, 2); + } + } + } + } + + if (strict && ret) { + log_cnt = rspamd_log_counters(rspamd_main->logger); + + if (log_cnt && log_cnt[0] > 0) { + if (!quiet) { + rspamd_printf("%L errors found\n", log_cnt[0]); + } + ret = FALSE; + } + } + + if (!quiet) { + rspamd_printf("syntax %s\n", ret ? "OK" : "BAD"); + } + + if (!ret) { + exit(EXIT_FAILURE); + } +} |