src/doveadm/doveadm-settings.c

/* Copyright (c) 2010-2018 Dovecot authors, see the included COPYING file */

#include "lib.h"
#include "buffer.h"
#include "settings-parser.h"
#include "service-settings.h"
#include "mail-storage-settings.h"
#include "doveadm-settings.h"

static bool doveadm_settings_check(void *_set, pool_t pool, const char **error_r);

/* <settings checks> */
static struct file_listener_settings doveadm_unix_listeners_array[] = {
    { "doveadm-server", 0600, "", "" }
};
static struct file_listener_settings *doveadm_unix_listeners[] = {
    &doveadm_unix_listeners_array[0]
};
static buffer_t doveadm_unix_listeners_buf = {
    doveadm_unix_listeners, sizeof(doveadm_unix_listeners), { NULL, }
};
/* </settings checks> */

struct service_settings doveadm_service_settings = {
    .name = "doveadm",
    .protocol = "",
    .type = "",
    .executable = "doveadm-server",
    .user = "",
    .group = "",
    .privileged_group = "",
    .extra_groups = "$default_internal_group",
    .chroot = "",

    .drop_priv_before_exec = FALSE,

    .process_min_avail = 0,
    .process_limit = 0,
    .client_limit = 1,
    .service_count = 1,
    .idle_kill = 0,
    .vsz_limit = (uoff_t)-1,

    .unix_listeners = { { &doveadm_unix_listeners_buf,
                  sizeof(doveadm_unix_listeners[0]) } },
    .fifo_listeners = ARRAY_INIT,
    .inet_listeners = ARRAY_INIT
};

#undef DEF
#define DEF(type, name) \
    { type, #name, offsetof(struct doveadm_settings, name), NULL }

static const struct setting_define doveadm_setting_defines[] = {
    DEF(SET_STR, base_dir),
    DEF(SET_STR, libexec_dir),
    DEF(SET_STR, mail_plugins),
    DEF(SET_STR, mail_plugin_dir),
    DEF(SET_BOOL, auth_debug),
    DEF(SET_STR, auth_socket_path),
    DEF(SET_STR, doveadm_socket_path),
    DEF(SET_UINT, doveadm_worker_count),
    DEF(SET_IN_PORT, doveadm_port),
    { SET_ALIAS, "doveadm_proxy_port", 0, NULL },
    DEF(SET_STR, doveadm_username),
    DEF(SET_STR, doveadm_password),
    DEF(SET_STR, doveadm_allowed_commands),
    DEF(SET_STR, dsync_alt_char),
    DEF(SET_STR, dsync_remote_cmd),
    DEF(SET_STR, ssl_client_ca_dir),
    DEF(SET_STR, ssl_client_ca_file),
    DEF(SET_STR, director_username_hash),
    DEF(SET_STR, doveadm_api_key),
    DEF(SET_STR, dsync_features),
    DEF(SET_UINT, dsync_commit_msgs_interval),
    DEF(SET_STR, doveadm_http_rawlog_dir),
    DEF(SET_STR, dsync_hashed_headers),

    { SET_STRLIST, "plugin", offsetof(struct doveadm_settings, plugin_envs), NULL },

    SETTING_DEFINE_LIST_END
};

const struct doveadm_settings doveadm_default_settings = {
    .base_dir = PKG_RUNDIR,
    .libexec_dir = PKG_LIBEXECDIR,
    .mail_plugins = "",
    .mail_plugin_dir = MODULEDIR,
    .auth_debug = FALSE,
    .auth_socket_path = "auth-userdb",
    .doveadm_socket_path = "doveadm-server",
    .doveadm_worker_count = 0,
    .doveadm_port = 0,
    .doveadm_username = "doveadm",
    .doveadm_password = "",
    .doveadm_allowed_commands = "",
    .dsync_alt_char = "_",
    .dsync_remote_cmd = "ssh -l%{login} %{host} doveadm dsync-server -u%u -U",
    .dsync_features = "",
    .dsync_hashed_headers = "Date Message-ID",
    .dsync_commit_msgs_interval = 100,
    .ssl_client_ca_dir = "",
    .ssl_client_ca_file = "",
    .director_username_hash = "%Lu",
    .doveadm_api_key = "",
    .doveadm_http_rawlog_dir = "",

    .plugin_envs = ARRAY_INIT
};

static const struct setting_parser_info *doveadm_setting_dependencies[] = {
    &mail_user_setting_parser_info,
    NULL
};

const struct setting_parser_info doveadm_setting_parser_info = {
    .module_name = "doveadm",
    .defines = doveadm_setting_defines,
    .defaults = &doveadm_default_settings,

    .type_offset = (size_t)-1,
    .struct_size = sizeof(struct doveadm_settings),

    .parent_offset = (size_t)-1,
    .check_func = doveadm_settings_check,
    .dependencies = doveadm_setting_dependencies
};

struct doveadm_settings *doveadm_settings;
const struct master_service_settings *service_set;

static void
fix_base_path(struct doveadm_settings *set, pool_t pool, const char **str)
{
    if (*str != NULL && **str != '\0' && **str != '/')
        *str = p_strconcat(pool, set->base_dir, "/", *str, NULL);
}

/* <settings checks> */
struct dsync_feature_list {
    const char *name;
    enum dsync_features num;
};

static const struct dsync_feature_list dsync_feature_list[] = {
    { "empty-header-workaround", DSYNC_FEATURE_EMPTY_HDR_WORKAROUND },
    { NULL, 0 }
};

static int
dsync_settings_parse_features(struct doveadm_settings *set,
                  const char **error_r)
{
    enum dsync_features features = 0;
    const struct dsync_feature_list *list;
    const char *const *str;

    str = t_strsplit_spaces(set->dsync_features, " ,");
    for (; *str != NULL; str++) {
        list = dsync_feature_list;
        for (; list->name != NULL; list++) {
            if (strcasecmp(*str, list->name) == 0) {
                features |= list->num;
                break;
            }
        }
        if (list->name == NULL) {
            *error_r = t_strdup_printf("dsync_features: "
                "Unknown feature: %s", *str);
            return -1;
        }
    }
    set->parsed_features = features;
    return 0;
}

static bool doveadm_settings_check(void *_set, pool_t pool ATTR_UNUSED,
                   const char **error_r)
{
    struct doveadm_settings *set = _set;

#ifndef CONFIG_BINARY
    fix_base_path(set, pool, &set->auth_socket_path);
    fix_base_path(set, pool, &set->doveadm_socket_path);
#endif
    if (*set->dsync_hashed_headers == '\0') {
        *error_r = "dsync_hashed_headers must not be empty";
        return FALSE;
    }
    if (*set->dsync_alt_char == '\0') {
        *error_r = "dsync_alt_char must not be empty";
        return FALSE;
    }
    if (dsync_settings_parse_features(set, error_r) != 0)
        return FALSE;
    return TRUE;
}
/* </settings checks> */