diff --git a/README.md b/README.rst similarity index 100% rename from README.md rename to README.rst diff --git a/installer.cfg b/installer.cfg new file mode 100644 index 0000000..9f1bf51 --- /dev/null +++ b/installer.cfg @@ -0,0 +1,76 @@ +[general] +tls_key_file = /etc/ssl/private/ssl-cert-snakeoil.key +tls_cert_file = /etc/ssl/certs/ssl-cert-snakeoil.pem + +[database] +host = 127.0.0.1 +engine = postgres +install = true + +[postgres] +user = postgres +password = + +[mysql] +user = root +password = password + +[modoboa] +user = modoboa +home_dir = /srv/modoboa +venv_path = %(home_dir)s/env +instance_path = %(home_dir)s/instance +timezone = Europe/Paris + +dbname = modoboa +dbuser = modoboa +dbpassword = password + +[amavis] +enabled = true +user = amavis +home_dir = /var/lib/amavis +config_dir = /etc/amavis/conf.d +max_servers = 1 + +dbname = amavis +dbuser = amavis +dbpassword = password + +[clamav] +enabled = true +user = clamav + +[dovecot] +enabled = true +config_dir = /etc/dovecot +user = vmail +home_dir = /srv/vmail +mailboxes_owner = vmail + +[nginx] +enabled = true +config_dir = /etc/nginx + +[razor] +enabled = true +config_dir = /etc/razor + +[postfix] +enabled = true +config_dir = /etc/postfix +message_size_limit = 11534336 + +[spamassassin] +enabled = true +config_dir = /etc/spamassassin + +dbname = spamassassin +dbuser = spamassassin +dbpassword = password + +[uwsgi] +enabled = true +config_dir = /etc/uwsgi +nb_processes = 2 +socket_path = /var/run/uwsgi/app/modoboa_instance/socket diff --git a/modoboa_installer/__init__.py b/modoboa_installer/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/modoboa_installer/database.py b/modoboa_installer/database.py new file mode 100644 index 0000000..7797bb1 --- /dev/null +++ b/modoboa_installer/database.py @@ -0,0 +1,171 @@ +"""Database related tools.""" + +import os +import pwd +import stat + +from . import utils + + +class Database(object): + + """Common database backend.""" + + package = None + service = None + + def __init__(self, config): + """Install if necessary.""" + self.config = config + engine = self.config.get("database", "engine") + self.dbuser = config.get(engine, "user") + self.dbpassword = config.get(engine, "password") + if self.config.getboolean("database", "install"): + self.install_package() + + def install_package(self): + """Install database package if required.""" + utils.install_system_package(self.package) + name = self.service if self.service else self.package + utils.exec_cmd("service {} start".format(name)) + + +class PostgreSQL(Database): + + """Postgres.""" + + package = "postgresql" + + def __init__(self, config): + super(PostgreSQL, self).__init__(config) + self._pgpass_done = False + + def _exec_query(self, query): + """Exec a postgresql query.""" + utils.exec_cmd( + """psql -c "{}" """.format(query), sudo_user=self.dbuser) + + def create_user(self, name, password): + """Create a user.""" + query = "SELECT 1 FROM pg_roles WHERE rolname='{}'".format(name) + code, output = utils.exec_cmd( + """psql -tAc "{}" | grep -q 1""".format(query), + sudo_user=self.dbuser) + if not code: + return + query = "CREATE USER {} PASSWORD '{}'".format(name, password) + self._exec_query(query) + + def create_database(self, name, owner): + """Create a database.""" + code, output = utils.exec_cmd( + "psql -lqt | cut -d \| -f 1 | grep -w {} | wc -l" + .format(name), sudo_user=self.dbuser) + if code: + return + utils.exec_cmd( + "createdb {} -O {}".format(name, owner), + sudo_user=self.dbuser) + + def grant_access(self, dbname, user): + """Grant access to dbname.""" + query = "GRANT ALL ON DATABASE {} TO {}".format(dbname, user) + self._exec_query(query) + + def _setup_pgpass(self, dbname, dbuser, dbpasswd): + """Setup .pgpass file.""" + if self._pgpass_done: + return + pw = pwd.getpwnam(self.dbuser) + target = os.path.join(pw[5], ".pgpass") + with open(target, "w") as fp: + fp.write("127.0.0.1:*:{}:{}:{}\n".format( + dbname, dbname, dbpasswd)) + mode = stat.S_IRUSR | stat.S_IWUSR + os.chmod(target, mode) + os.chown(target, pw[2], pw[3]) + self._pgpass_done = True + + def load_sql_file(self, dbname, dbuser, dbpassword, path): + """Load SQL file.""" + self._setup_pgpass(dbname, dbuser, dbpassword) + utils.exec_cmd( + "psql -h {} -d {} -U {} -w < {}".format( + "127.0.0.1", dbname, dbuser, path), + sudo_user=self.dbuser) + + +class MySQL(Database): + + """MySQL backend.""" + + package = "mysql-server" + service = "mysql" + + def install_package(self): + """Preseed package installation.""" + cfg = ( + "mysql-server mysql-server/root_password password {}" + .format(self.dbpassword)) + utils.exec_cmd("echo '{}' | debconf-set-selections".format(cfg)) + cfg = ( + "mysql-server mysql-server/root_password_again password {}" + .format(self.dbpassword)) + utils.exec_cmd("echo '{}' | debconf-set-selections".format(cfg)) + super(MySQL, self).install_package() + + def _exec_query(self, query): + """Exec a postgresql query.""" + utils.exec_cmd( + """mysql -u {} -p{} -e "{}" """ + .format(self.dbuser, self.dbpassword, query)) + + def create_user(self, name, password): + """Create a user.""" + self._exec_query( + "CREATE USER '{}'@'localhost' IDENTIFIED BY '{}'".format( + name, password)) + + def create_database(self, name, owner): + """Create a database.""" + self._exec_query( + "CREATE DATABASE IF NOT EXISTS {}".format(name)) + self.grant_access(name, owner) + + def grant_access(self, dbname, user): + """Grant access to dbname.""" + self._exec_query( + "GRANT ALL PRIVILEGES ON {}.* to '{}'@'localhost'" + .format(dbname, user)) + + def load_sql_file(self, dbname, dbuser, dbpassword, path): + """Load SQL file.""" + dbhost = self.config.get("database", "host") + utils.exec_cmd( + "mysql -h {} -u {} -p{} {} < {}".format( + dbhost, dbuser, dbpassword, dbname, path) + ) + + +def get_backend(config): + """Return appropriate backend.""" + engine = config.get("database", "engine") + if engine == "postgres": + backend = PostgreSQL + elif engine == "mysql": + backend = MySQL + else: + raise utils.FatalError("database engine not supported") + return backend(config) + + +def create(config, name, password): + """Create a database and a user.""" + backend = get_backend(config) + backend.create_user(name, password) + backend.create_database(name) + + +def grant_database_access(config, name, user): + """Grant access to a database.""" + get_backend(config).grant_access(name, user) diff --git a/modoboa_installer/python.py b/modoboa_installer/python.py new file mode 100644 index 0000000..060b7b7 --- /dev/null +++ b/modoboa_installer/python.py @@ -0,0 +1,37 @@ +"""Python related tools.""" + +import os + +from . import utils + + +def get_pip_path(venv): + """Return the full path to pip command.""" + binpath = "pip" + if venv: + binpath = os.path.join(venv, "bin", binpath) + return binpath + + +def install_package(name, venv=None, upgrade=False, **kwargs): + """Install a Python package using pip.""" + cmd = "{} install {}{}".format( + get_pip_path(venv), " -U " if upgrade else "", name) + utils.exec_cmd(cmd, **kwargs) + + +def install_packages(names, venv=None, upgrade=False, **kwargs): + """Install a Python package using pip.""" + cmd = "{} install {}{}".format( + get_pip_path(venv), " -U " if upgrade else "", " ".join(names)) + utils.exec_cmd(cmd, **kwargs) + + +def setup_virtualenv(path, sudo_user=None): + """Install a virtualenv if needed.""" + if os.path.exists(path): + return + utils.install_system_package("python-virtualenv") + with utils.settings(sudo_user=sudo_user): + utils.exec_cmd("virtualenv {}".format(path)) + install_package("pip", venv=path, upgrade=True) diff --git a/modoboa_installer/scripts/__init__.py b/modoboa_installer/scripts/__init__.py new file mode 100644 index 0000000..55b8b73 --- /dev/null +++ b/modoboa_installer/scripts/__init__.py @@ -0,0 +1,21 @@ +"""Installation scripts management.""" + +import importlib +import sys + +from .. import utils + + +def install(appname, config): + """Install an application.""" + if (config.has_option(appname, "enabled") and + not config.getboolean(appname, "enabled")): + return + utils.printcolor("Installing {}".format(appname), utils.YELLOW) + try: + script = importlib.import_module( + "modoboa_installer.scripts.{}".format(appname)) + except ImportError: + print("Unknown application {}".format(appname)) + sys.exit(1) + getattr(script, appname.capitalize())(config).run() diff --git a/modoboa_installer/scripts/amavis.py b/modoboa_installer/scripts/amavis.py new file mode 100644 index 0000000..6e60a84 --- /dev/null +++ b/modoboa_installer/scripts/amavis.py @@ -0,0 +1,57 @@ +"""Amavis related functions.""" + +import re + +from .. import utils + +from . import base +from . import install + + +class Amavis(base.Installer): + + """Amavis installer.""" + + appname = "amavis" + packages = ["libdbi-perl", "amavisd-new"] + with_db = True + config_files = ["05-node_id", "15-content_filter_mode", "50-user"] + + def get_packages(self): + """Additional packages.""" + db_driver = "pg" if self.db_driver == "pgsql" else self.db_driver + return self.packages + ["libdbd-{}-perl".format(db_driver)] + + @property + def installed_version(self): + """Check the installed version.""" + name = "amavisd-new" + code, output = utils.exec_cmd( + """dpkg -s {} | grep Version""".format(name), + capture_output=True + ) + match = re.match(r"Version: \d:(.+)-\d", output.decode()) + if match: + return match.group(1) + return None + + def get_sql_schema_path(self): + """Return schema path.""" + version = self.installed_version + if version is None: + raise utils.FatalError("Amavis is not installed") + return self.get_file_path( + "amavis_{}_{}.sql".format(self.dbengine, version)) + + def setup_database(self): + """Additional config.""" + super(Amavis, self).setup_database() + self.backend.grant_access( + self.dbname, self.config.get("modoboa", "dbuser")) + + def post_run(self): + """Additional tasks.""" + with open("/etc/mailname", "w") as fp: + fp.write("{}\n".format(self.config.get("general", "hostname"))) + install("spamassassin", self.config) + install("clamav", self.config) diff --git a/modoboa_installer/scripts/base.py b/modoboa_installer/scripts/base.py new file mode 100644 index 0000000..5efa338 --- /dev/null +++ b/modoboa_installer/scripts/base.py @@ -0,0 +1,137 @@ +"""Base classes.""" + +import os + +from .. import database +from .. import system +from .. import utils + + +class Installer(object): + + """Simple installer for one application.""" + + appname = None + no_daemon = False + daemon_name = None + packages = [] + with_user = False + with_db = False + config_files = [] + + def __init__(self, config): + """Get configuration.""" + self.config = config + self.dbengine = self.config.get("database", "engine") + # Used to install system packages + self.db_driver = ( + "pgsql" if self.dbengine == "postgres" else self.dbengine) + self.dbhost = self.config.get("database", "host") + if self.config.has_option(self.appname, "config_dir"): + self.config_dir = self.config.get(self.appname, "config_dir") + if not self.with_db: + return + self.dbname = self.config.get(self.appname, "dbname") + self.dbuser = self.config.get(self.appname, "dbuser") + self.dbpasswd = self.config.get(self.appname, "dbpassword") + + def get_sql_schema_path(self): + """Return a schema to install.""" + return None + + def get_file_path(self, fname): + """Return the absolute path of this file.""" + return os.path.abspath( + os.path.join( + os.path.dirname(__file__), "files", self.appname, fname) + ) + + def setup_database(self): + """Setup a database.""" + if not self.with_db: + return + self.backend = database.get_backend(self.config) + self.backend.create_user(self.dbuser, self.dbpasswd) + self.backend.create_database(self.dbname, self.dbuser) + schema = self.get_sql_schema_path() + if schema: + self.backend.load_sql_file( + self.dbname, self.dbuser, self.dbpasswd, schema) + + def create_user(self): + """Create a system user.""" + if not self.with_user: + return + self.user = self.config.get(self.appname, "user") + if self.config.has_option(self.appname, "home_dir"): + self.home_dir = self.config.get(self.appname, "home_dir") + else: + self.home_dir = None + system.create_user(self.user, self.home_dir) + + def get_template_context(self): + """Return context used for template rendering.""" + context = { + "dbengine": ( + "Pg" if self.dbengine == "postgres" else self.dbengine), + "dbhost": self.dbhost, + } + for option, value in self.config.items("general"): + context[option] = value + for option, value in self.config.items(self.appname): + context[option] = value + for section in self.config.sections(): + if section == self.appname: + continue + if self.config.has_option(section, "enabled"): + val = "" if self.config.getboolean(section, "enabled") else "#" + context["{}_enabled".format(section)] = val + return context + + def get_packages(self): + """Return the list of packages to install.""" + return self.packages + + def install_packages(self): + """Install required packages.""" + packages = self.get_packages() + if not packages: + return + utils.install_system_packages(packages) + + def get_config_files(self): + """Return the list of configuration files to copy.""" + return self.config_files + + def install_config_files(self): + """Install configuration files.""" + config_files = self.get_config_files() + if not config_files: + return + context = self.get_template_context() + for ftpl in config_files: + src = self.get_file_path("{}.tpl".format(ftpl)) + dst = os.path.join(self.config_dir, ftpl) + utils.copy_from_template(src, dst, context) + + def restart_daemon(self): + """Restart daemon process.""" + if self.no_daemon: + return + name = self.daemon_name if self.daemon_name else self.appname + code, output = utils.exec_cmd("service {} status".format(name)) + action = "start" if code else "restart" + utils.exec_cmd("service {} {}".format(name, action)) + + def run(self): + """Run the installer.""" + self.install_packages() + self.create_user() + self.setup_database() + self.install_config_files() + self.post_run() + self.restart_daemon() + + def post_run(self): + """Additionnal tasks.""" + pass diff --git a/modoboa_installer/scripts/clamav.py b/modoboa_installer/scripts/clamav.py new file mode 100644 index 0000000..167a647 --- /dev/null +++ b/modoboa_installer/scripts/clamav.py @@ -0,0 +1,23 @@ +"""ClamAV related tools.""" + +from .. import utils +from .. import system + +from . import base + + +class Clamav(base.Installer): + + """ClamAV installer.""" + + appname = "clamav" + daemon_name = "clamav-daemon" + packages = ["clamav-daemon"] + + def post_run(self): + """Additional tasks.""" + user = self.config.get(self.appname, "user") + system.add_user_to_group( + user, self.config.get("amavis", "user") + ) + utils.exec_cmd("freshclam", sudo_user=user) diff --git a/modoboa_installer/scripts/dovecot.py b/modoboa_installer/scripts/dovecot.py new file mode 100644 index 0000000..2ff234c --- /dev/null +++ b/modoboa_installer/scripts/dovecot.py @@ -0,0 +1,80 @@ +"""Dovecot related tools.""" + +import glob +import pwd +import shutil + +from .. import database +from .. import utils + +from . import base + + +class Dovecot(base.Installer): + + """Dovecot installer.""" + + appname = "dovecot" + packages = [ + "dovecot-imapd", "dovecot-lmtpd", "dovecot-managesieved", + "dovecot-sieve" + ] + config_files = [ + "dovecot.conf", "dovecot-dict-sql.conf.ext", "conf.d/10-ssl.conf"] + with_user = True + + def get_config_files(self): + """Additional config files.""" + return self.config_files + [ + "dovecot-sql-{}.conf.ext".format(self.dbengine)] + + def get_packages(self): + """Additional packages.""" + return self.packages + ["dovecot-{}".format(self.db_driver)] + + def get_template_context(self): + """Additional variables.""" + context = super(Dovecot, self).get_template_context() + pw = pwd.getpwnam(self.user) + context.update({ + "db_driver": self.db_driver, + "mailboxes_owner_uid": pw[2], + "mailboxes_owner_gid": pw[3], + "modoboa_dbname": self.config.get("modoboa", "dbname"), + "modoboa_dbuser": self.config.get("modoboa", "dbuser"), + "modoboa_dbpassword": self.config.get("modoboa", "dbpassword"), + }) + return context + + def post_run(self): + """Additional tasks.""" + if self.dbengine != "postgres": + return + dbname = self.config.get("modoboa", "dbname") + dbuser = self.config.get("modoboa", "dbuser") + dbpassword = self.config.get("modoboa", "dbpassword") + backend = database.get_backend(self.config) + backend.load_sql_file( + dbname, dbuser, dbpassword, + self.get_file_path("install_modoboa_postgres_trigger.sql") + ) + backend.load_sql_file( + dbname, dbuser, dbpassword, + self.get_file_path("fix_modoboa_postgres_schema.sql") + ) + for f in glob.glob("{}/*".format(self.get_file_path("conf.d"))): + shutil.copy(f, "{}/conf.d".format(self.config_dir)) + + def restart_daemon(self): + """Restart daemon process. + + Note: we don't capture output and manually redirect stdout to + /dev/null since this command may hang depending on the process + being restarted (dovecot for example)... + + """ + code, output = utils.exec_cmd("service dovecot status") + action = "start" if code else "restart" + utils.exec_cmd( + "service dovecot {} > /dev/null 2>&1".format(action), + capture_output=False) diff --git a/modoboa_installer/scripts/files/amavis/05-node_id.tpl b/modoboa_installer/scripts/files/amavis/05-node_id.tpl new file mode 100644 index 0000000..3e11d05 --- /dev/null +++ b/modoboa_installer/scripts/files/amavis/05-node_id.tpl @@ -0,0 +1,13 @@ +use strict; + +# $myhostname is used by amavisd-new for node identification, and it is +# important to get it right (e.g. for ESMTP EHLO, loop detection, and so on). + +# chomp($myhostname = `hostname --fqdn`); + +# To manually set $myhostname, edit the following line with the correct Fully +# Qualified Domain Name (FQDN) and remove the # at the beginning of the line. +# +$myhostname = "%hostname"; + +1; # ensure a defined return diff --git a/modoboa_installer/scripts/files/amavis/15-content_filter_mode.tpl b/modoboa_installer/scripts/files/amavis/15-content_filter_mode.tpl new file mode 100644 index 0000000..8733697 --- /dev/null +++ b/modoboa_installer/scripts/files/amavis/15-content_filter_mode.tpl @@ -0,0 +1,25 @@ +use strict; + +# You can modify this file to re-enable SPAM checking through spamassassin +# and to re-enable antivirus checking. + +# +# Default antivirus checking mode +# Please note, that anti-virus checking is DISABLED by +# default. +# If You wish to enable it, please uncomment the following lines: + +%{clamav_enabled}@bypass_virus_checks_maps = ( +%{clamav_enabled} \%%bypass_virus_checks, \@bypass_virus_checks_acl, \$bypass_virus_checks_re); + +# +# Default SPAM checking mode +# Please note, that anti-spam checking is DISABLED by +# default. +# If You wish to enable it, please uncomment the following lines: + + +@bypass_spam_checks_maps = ( + \%%bypass_spam_checks, \@bypass_spam_checks_acl, \$bypass_spam_checks_re); + +1; # ensure a defined return diff --git a/modoboa_installer/scripts/files/amavis/50-user.tpl b/modoboa_installer/scripts/files/amavis/50-user.tpl new file mode 100644 index 0000000..e1ef878 --- /dev/null +++ b/modoboa_installer/scripts/files/amavis/50-user.tpl @@ -0,0 +1,43 @@ +use strict; + +# General settings +# +$inet_socket_port = [9998, 10024, 10026]; +$max_servers = %max_servers; + +# SQL configuration +# +@lookup_sql_dsn = ( [ 'DBI:%dbengine:database=%dbname;host=%dbhost', '%dbuser', '%dbpassword' ]); +@storage_sql_dsn = @lookup_sql_dsn; +$sql_allow_8bit_address = 1; + +# Quarantine methods +# +$virus_quarantine_method = 'sql:'; +$spam_quarantine_method = 'sql:'; +$banned_files_quarantine_method = 'sql:'; +$bad_header_quarantine_method = 'sql:'; + +# Discard spam +$final_spam_destiny = D_DISCARD; + +# Policy banks +# +$interface_policy{'9998'} = 'AM.PDP-INET'; + +$policy_bank{'AM.PDP-INET'} = { + protocol => 'AM.PDP', + inet_acl => [qw( 127.0.0.1 )], +}; + +# switch policy bank to 'ORIGINATING' for mail received on port 10026: +$interface_policy{'10026'} = 'ORIGINATING'; + +$policy_bank{'ORIGINATING'} = { # mail originating from our users + originating => 1, # indicates client is ours, allows signing + # force MTA to convert mail to 7-bit before DKIM signing + # to avoid later conversions which could destroy signature: + smtpd_discard_ehlo_keywords => ['8BITMIME'], +}; + +1; # ensure a defined return; diff --git a/modoboa_installer/scripts/files/amavis/amavis_mysql_2.10.1.sql b/modoboa_installer/scripts/files/amavis/amavis_mysql_2.10.1.sql new file mode 100644 index 0000000..0cb3d82 --- /dev/null +++ b/modoboa_installer/scripts/files/amavis/amavis_mysql_2.10.1.sql @@ -0,0 +1,222 @@ +-- Amavis 2.10.1 MySQL schema +-- Provided by Modoboa +-- Warning: foreign key creations are enabled + +-- local users +CREATE TABLE users ( + id int unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY, -- unique id + priority integer NOT NULL DEFAULT '7', -- sort field, 0 is low prior. + policy_id integer unsigned NOT NULL DEFAULT '1', -- JOINs with policy.id + email varbinary(255) NOT NULL UNIQUE, + fullname varchar(255) DEFAULT NULL -- not used by amavisd-new + -- local char(1) -- Y/N (optional field, see note further down) +); + +-- any e-mail address (non- rfc2822-quoted), external or local, +-- used as senders in wblist +CREATE TABLE mailaddr ( + id int unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY, + priority integer NOT NULL DEFAULT '7', -- 0 is low priority + email varbinary(255) NOT NULL UNIQUE +); + +-- per-recipient whitelist and/or blacklist, +-- puts sender and recipient in relation wb (white or blacklisted sender) +CREATE TABLE wblist ( + rid integer unsigned NOT NULL, -- recipient: users.id + sid integer unsigned NOT NULL, -- sender: mailaddr.id + wb varchar(10) NOT NULL, -- W or Y / B or N / space=neutral / score + PRIMARY KEY (rid,sid) +); + +CREATE TABLE policy ( + id int unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY, + -- 'id' this is the _only_ required field + policy_name varchar(32), -- not used by amavisd-new, a comment + + virus_lover char(1) default NULL, -- Y/N + spam_lover char(1) default NULL, -- Y/N + unchecked_lover char(1) default NULL, -- Y/N + banned_files_lover char(1) default NULL, -- Y/N + bad_header_lover char(1) default NULL, -- Y/N + + bypass_virus_checks char(1) default NULL, -- Y/N + bypass_spam_checks char(1) default NULL, -- Y/N + bypass_banned_checks char(1) default NULL, -- Y/N + bypass_header_checks char(1) default NULL, -- Y/N + + virus_quarantine_to varchar(64) default NULL, + spam_quarantine_to varchar(64) default NULL, + banned_quarantine_to varchar(64) default NULL, + unchecked_quarantine_to varchar(64) default NULL, + bad_header_quarantine_to varchar(64) default NULL, + clean_quarantine_to varchar(64) default NULL, + archive_quarantine_to varchar(64) default NULL, + + spam_tag_level float default NULL, -- higher score inserts spam info headers + spam_tag2_level float default NULL, -- inserts 'declared spam' header fields + spam_tag3_level float default NULL, -- inserts 'blatant spam' header fields + spam_kill_level float default NULL, -- higher score triggers evasive actions + -- e.g. reject/drop, quarantine, ... + -- (subject to final_spam_destiny setting) + spam_dsn_cutoff_level float default NULL, + spam_quarantine_cutoff_level float default NULL, + + addr_extension_virus varchar(64) default NULL, + addr_extension_spam varchar(64) default NULL, + addr_extension_banned varchar(64) default NULL, + addr_extension_bad_header varchar(64) default NULL, + + warnvirusrecip char(1) default NULL, -- Y/N + warnbannedrecip char(1) default NULL, -- Y/N + warnbadhrecip char(1) default NULL, -- Y/N + newvirus_admin varchar(64) default NULL, + virus_admin varchar(64) default NULL, + banned_admin varchar(64) default NULL, + bad_header_admin varchar(64) default NULL, + spam_admin varchar(64) default NULL, + spam_subject_tag varchar(64) default NULL, + spam_subject_tag2 varchar(64) default NULL, + spam_subject_tag3 varchar(64) default NULL, + message_size_limit integer default NULL, -- max size in bytes, 0 disable + banned_rulenames varchar(64) default NULL, -- comma-separated list of ... + -- names mapped through %banned_rules to actual banned_filename tables + disclaimer_options varchar(64) default NULL, + forward_method varchar(64) default NULL, + sa_userconf varchar(64) default NULL, + sa_username varchar(64) default NULL +); + + +-- R/W part of the dataset (optional) +-- May reside in the same or in a separate database as lookups database; +-- REQUIRES SUPPORT FOR TRANSACTIONS; specified in @storage_sql_dsn +-- +-- MySQL note ( http://dev.mysql.com/doc/mysql/en/storage-engines.html ): +-- ENGINE is the preferred term, but cannot be used before MySQL 4.0.18. +-- TYPE is available beginning with MySQL 3.23.0, the first version of +-- MySQL for which multiple storage engines were available. If you omit +-- the ENGINE or TYPE option, the default storage engine is used. +-- By default this is MyISAM. +-- +-- Please create additional indexes on keys when needed, or drop suggested +-- ones as appropriate to optimize queries needed by a management application. +-- See your database documentation for further optimization hints. With MySQL +-- see Chapter 15 of the reference manual. For example the chapter 15.17 says: +-- InnoDB does not keep an internal count of rows in a table. To process a +-- SELECT COUNT(*) FROM T statement, InnoDB must scan an index of the table, +-- which takes some time if the index is not entirely in the buffer pool. +-- +-- Wayne Smith adds: When using MySQL with InnoDB one might want to +-- increase buffer size for both pool and log, and might also want +-- to change flush settings for a little better performance. Example: +-- innodb_buffer_pool_size = 384M +-- innodb_log_buffer_size = 8M +-- innodb_flush_log_at_trx_commit = 0 +-- The big performance increase is the first two, the third just helps with +-- lowering disk activity. Consider also adjusting the key_buffer_size. + +-- provide unique id for each e-mail address, avoids storing copies +CREATE TABLE maddr ( + partition_tag integer DEFAULT 0, -- see $partition_tag + id bigint unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY, + email varbinary(255) NOT NULL, -- full mail address + domain varchar(255) NOT NULL, -- only domain part of the email address + -- with subdomain fields in reverse + CONSTRAINT part_email UNIQUE (partition_tag,email) +) ENGINE=InnoDB; + +-- information pertaining to each processed message as a whole; +-- NOTE: records with NULL msgs.content should be ignored by utilities, +-- as such records correspond to messages just being processes, or were lost +-- NOTE: instead of a character field time_iso, one might prefer: +-- time_iso TIMESTAMP NOT NULL DEFAULT 0, +-- but the following MUST then be set in amavisd.conf: $timestamp_fmt_mysql=1 +CREATE TABLE msgs ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id varbinary(16) NOT NULL, -- long-term unique mail id, dflt 12 ch + secret_id varbinary(16) DEFAULT '', -- authorizes release of mail_id, 12 ch + am_id varchar(20) NOT NULL, -- id used in the log + time_num integer unsigned NOT NULL, -- rx_time: seconds since Unix epoch + time_iso char(16) NOT NULL, -- rx_time: ISO8601 UTC ascii time + sid bigint unsigned NOT NULL, -- sender: maddr.id + policy varchar(255) DEFAULT '', -- policy bank path (like macro %p) + client_addr varchar(255) DEFAULT '', -- SMTP client IP address (IPv4 or v6) + size integer unsigned NOT NULL, -- message size in bytes + originating char(1) DEFAULT ' ' NOT NULL, -- sender from inside or auth'd + content char(1), -- content type: V/B/U/S/Y/M/H/O/T/C + -- virus/banned/unchecked/spam(kill)/spammy(tag2)/ + -- /bad-mime/bad-header/oversized/mta-err/clean + -- is NULL on partially processed mail + -- (prior to 2.7.0 the CC_SPAMMY was logged as 's', now 'Y' is used; + -- to avoid a need for case-insenstivity in queries) + quar_type char(1), -- quarantined as: ' '/F/Z/B/Q/M/L + -- none/file/zipfile/bsmtp/sql/ + -- /mailbox(smtp)/mailbox(lmtp) + quar_loc varbinary(255) DEFAULT '', -- quarantine location (e.g. file) + dsn_sent char(1), -- was DSN sent? Y/N/q (q=quenched) + spam_level float, -- SA spam level (no boosts) + message_id varchar(255) DEFAULT '', -- mail Message-ID header field + from_addr varchar(255) CHARACTER SET utf8 COLLATE utf8_bin DEFAULT '', + -- mail From header field, UTF8 + subject varchar(255) CHARACTER SET utf8 COLLATE utf8_bin DEFAULT '', + -- mail Subject header field, UTF8 + host varchar(255) NOT NULL, -- hostname where amavisd is running + PRIMARY KEY (partition_tag,mail_id) + FOREIGN KEY (sid) REFERENCES maddr(id) ON DELETE RESTRICT +) ENGINE=InnoDB; +CREATE INDEX msgs_idx_sid ON msgs (sid); +CREATE INDEX msgs_idx_mess_id ON msgs (message_id); -- useful with pen pals +CREATE INDEX msgs_idx_time_num ON msgs (time_num); +-- alternatively when purging based on time_iso (instead of msgs_idx_time_num): +CREATE INDEX msgs_idx_time_iso ON msgs (time_iso); +-- When using FOREIGN KEY contraints, InnoDB requires index on a field +-- (an the field must be the first field in the index). Hence create it: +CREATE INDEX msgs_idx_mail_id ON msgs (mail_id); + +-- per-recipient information related to each processed message; +-- NOTE: records in msgrcpt without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE msgrcpt ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id varbinary(16) NOT NULL, -- (must allow duplicates) + rseqnum integer DEFAULT 0 NOT NULL, -- recip's enumeration within msg + rid bigint unsigned NOT NULL, -- recipient: maddr.id (dupl. allowed) + is_local char(1) DEFAULT ' ' NOT NULL, -- recip is: Y=local, N=foreign + content char(1) DEFAULT ' ' NOT NULL, -- content type V/B/U/S/Y/M/H/O/T/C + ds char(1) NOT NULL, -- delivery status: P/R/B/D/T + -- pass/reject/bounce/discard/tempfail + rs char(1) NOT NULL, -- release status: initialized to ' ' + bl char(1) DEFAULT ' ', -- sender blacklisted by this recip + wl char(1) DEFAULT ' ', -- sender whitelisted by this recip + bspam_level float, -- per-recipient (total) spam level + smtp_resp varchar(255) DEFAULT '', -- SMTP response given to MTA + PRIMARY KEY (partition_tag,mail_id,rseqnum) + FOREIGN KEY (rid) REFERENCES maddr(id) ON DELETE RESTRICT, + FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +) ENGINE=InnoDB; +CREATE INDEX msgrcpt_idx_mail_id ON msgrcpt (mail_id); +CREATE INDEX msgrcpt_idx_rid ON msgrcpt (rid); +-- Additional index on rs since Modoboa uses it to filter its quarantine +CREATE INDEX msgrcpt_idx_rs ON msgrcpt (rs); + +-- mail quarantine in SQL, enabled by $*_quarantine_method='sql:' +-- NOTE: records in quarantine without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE quarantine ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id varbinary(16) NOT NULL, -- long-term unique mail id + chunk_ind integer unsigned NOT NULL, -- chunk number, starting with 1 + mail_text blob NOT NULL, -- store mail as chunks of octets + PRIMARY KEY (partition_tag,mail_id,chunk_ind) + FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +) ENGINE=InnoDB; + +-- field msgrcpt.rs is primarily intended for use by quarantine management +-- software; the value assigned by amavisd is a space; +-- a short _preliminary_ list of possible values: +-- 'V' => viewed (marked as read) +-- 'R' => released (delivered) to this recipient +-- 'p' => pending (a status given to messages when the admin received the +-- request but not yet released; targeted to banned parts) +-- 'D' => marked for deletion; a cleanup script may delete it diff --git a/modoboa_installer/scripts/files/amavis/amavis_mysql_2.7.1.sql b/modoboa_installer/scripts/files/amavis/amavis_mysql_2.7.1.sql new file mode 100644 index 0000000..710d290 --- /dev/null +++ b/modoboa_installer/scripts/files/amavis/amavis_mysql_2.7.1.sql @@ -0,0 +1,221 @@ +-- Amavis 2.7.1 MySQL schema +-- Provided by Modoboa +-- Warning: foreign key creations are enabled + +-- local users +CREATE TABLE users ( + id int unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY, -- unique id + priority integer NOT NULL DEFAULT '7', -- sort field, 0 is low prior. + policy_id integer unsigned NOT NULL DEFAULT '1', -- JOINs with policy.id + email varbinary(255) NOT NULL UNIQUE, + fullname varchar(255) DEFAULT NULL -- not used by amavisd-new + -- local char(1) -- Y/N (optional field, see note further down) +); + +-- any e-mail address (non- rfc2822-quoted), external or local, +-- used as senders in wblist +CREATE TABLE mailaddr ( + id int unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY, + priority integer NOT NULL DEFAULT '7', -- 0 is low priority + email varbinary(255) NOT NULL UNIQUE +); + +-- per-recipient whitelist and/or blacklist, +-- puts sender and recipient in relation wb (white or blacklisted sender) +CREATE TABLE wblist ( + rid integer unsigned NOT NULL, -- recipient: users.id + sid integer unsigned NOT NULL, -- sender: mailaddr.id + wb varchar(10) NOT NULL, -- W or Y / B or N / space=neutral / score + PRIMARY KEY (rid,sid) +); + +CREATE TABLE policy ( + id int unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY, + -- 'id' this is the _only_ required field + policy_name varchar(32), -- not used by amavisd-new, a comment + + virus_lover char(1) default NULL, -- Y/N + spam_lover char(1) default NULL, -- Y/N + unchecked_lover char(1) default NULL, -- Y/N + banned_files_lover char(1) default NULL, -- Y/N + bad_header_lover char(1) default NULL, -- Y/N + + bypass_virus_checks char(1) default NULL, -- Y/N + bypass_spam_checks char(1) default NULL, -- Y/N + bypass_banned_checks char(1) default NULL, -- Y/N + bypass_header_checks char(1) default NULL, -- Y/N + + spam_modifies_subj char(1) default NULL, -- Y/N + + virus_quarantine_to varchar(64) default NULL, + spam_quarantine_to varchar(64) default NULL, + banned_quarantine_to varchar(64) default NULL, + unchecked_quarantine_to varchar(64) default NULL, + bad_header_quarantine_to varchar(64) default NULL, + clean_quarantine_to varchar(64) default NULL, + archive_quarantine_to varchar(64) default NULL, + + spam_tag_level float default NULL, -- higher score inserts spam info headers + spam_tag2_level float default NULL, -- inserts 'declared spam' header fields + spam_tag3_level float default NULL, -- inserts 'blatant spam' header fields + spam_kill_level float default NULL, -- higher score triggers evasive actions + -- e.g. reject/drop, quarantine, ... + -- (subject to final_spam_destiny setting) + spam_dsn_cutoff_level float default NULL, + spam_quarantine_cutoff_level float default NULL, + + addr_extension_virus varchar(64) default NULL, + addr_extension_spam varchar(64) default NULL, + addr_extension_banned varchar(64) default NULL, + addr_extension_bad_header varchar(64) default NULL, + + warnvirusrecip char(1) default NULL, -- Y/N + warnbannedrecip char(1) default NULL, -- Y/N + warnbadhrecip char(1) default NULL, -- Y/N + newvirus_admin varchar(64) default NULL, + virus_admin varchar(64) default NULL, + banned_admin varchar(64) default NULL, + bad_header_admin varchar(64) default NULL, + spam_admin varchar(64) default NULL, + spam_subject_tag varchar(64) default NULL, + spam_subject_tag2 varchar(64) default NULL, + spam_subject_tag3 varchar(64) default NULL, + message_size_limit integer default NULL, -- max size in bytes, 0 disable + banned_rulenames varchar(64) default NULL, -- comma-separated list of ... + -- names mapped through %banned_rules to actual banned_filename tables + disclaimer_options varchar(64) default NULL, + forward_method varchar(64) default NULL, + sa_userconf varchar(64) default NULL, + sa_username varchar(64) default NULL +); + + +-- R/W part of the dataset (optional) +-- May reside in the same or in a separate database as lookups database; +-- REQUIRES SUPPORT FOR TRANSACTIONS; specified in @storage_sql_dsn +-- +-- MySQL note ( http://dev.mysql.com/doc/mysql/en/storage-engines.html ): +-- ENGINE is the preferred term, but cannot be used before MySQL 4.0.18. +-- TYPE is available beginning with MySQL 3.23.0, the first version of +-- MySQL for which multiple storage engines were available. If you omit +-- the ENGINE or TYPE option, the default storage engine is used. +-- By default this is MyISAM. +-- +-- Please create additional indexes on keys when needed, or drop suggested +-- ones as appropriate to optimize queries needed by a management application. +-- See your database documentation for further optimization hints. With MySQL +-- see Chapter 15 of the reference manual. For example the chapter 15.17 says: +-- InnoDB does not keep an internal count of rows in a table. To process a +-- SELECT COUNT(*) FROM T statement, InnoDB must scan an index of the table, +-- which takes some time if the index is not entirely in the buffer pool. +-- +-- Wayne Smith adds: When using MySQL with InnoDB one might want to +-- increase buffer size for both pool and log, and might also want +-- to change flush settings for a little better performance. Example: +-- innodb_buffer_pool_size = 384M +-- innodb_log_buffer_size = 8M +-- innodb_flush_log_at_trx_commit = 0 +-- The big performance increase is the first two, the third just helps with +-- lowering disk activity. Consider also adjusting the key_buffer_size. + +-- provide unique id for each e-mail address, avoids storing copies +CREATE TABLE maddr ( + partition_tag integer DEFAULT 0, -- see $partition_tag + id bigint unsigned NOT NULL AUTO_INCREMENT PRIMARY KEY, + email varbinary(255) NOT NULL, -- full mail address + domain varchar(255) NOT NULL, -- only domain part of the email address + -- with subdomain fields in reverse + CONSTRAINT part_email UNIQUE (partition_tag,email) +) ENGINE=InnoDB; + +-- information pertaining to each processed message as a whole; +-- NOTE: records with NULL msgs.content should be ignored by utilities, +-- as such records correspond to messages just being processes, or were lost +-- NOTE: instead of a character field time_iso, one might prefer: +-- time_iso TIMESTAMP NOT NULL DEFAULT 0, +-- but the following MUST then be set in amavisd.conf: $timestamp_fmt_mysql=1 +CREATE TABLE msgs ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id varbinary(16) NOT NULL, -- long-term unique mail id, dflt 12 ch + secret_id varbinary(16) DEFAULT '', -- authorizes release of mail_id, 12 ch + am_id varchar(20) NOT NULL, -- id used in the log + time_num integer unsigned NOT NULL, -- rx_time: seconds since Unix epoch + time_iso char(16) NOT NULL, -- rx_time: ISO8601 UTC ascii time + sid bigint unsigned NOT NULL, -- sender: maddr.id + policy varchar(255) DEFAULT '', -- policy bank path (like macro %p) + client_addr varchar(255) DEFAULT '', -- SMTP client IP address (IPv4 or v6) + size integer unsigned NOT NULL, -- message size in bytes + originating char(1) DEFAULT ' ' NOT NULL, -- sender from inside or auth'd + content char(1), -- content type: V/B/U/S/Y/M/H/O/T/C + -- virus/banned/unchecked/spam(kill)/spammy(tag2)/ + -- /bad-mime/bad-header/oversized/mta-err/clean + -- is NULL on partially processed mail + -- (prior to 2.7.0 the CC_SPAMMY was logged as 's', now 'Y' is used; + -- to avoid a need for case-insenstivity in queries) + quar_type char(1), -- quarantined as: ' '/F/Z/B/Q/M/L + -- none/file/zipfile/bsmtp/sql/ + -- /mailbox(smtp)/mailbox(lmtp) + quar_loc varbinary(255) DEFAULT '', -- quarantine location (e.g. file) + dsn_sent char(1), -- was DSN sent? Y/N/q (q=quenched) + spam_level float, -- SA spam level (no boosts) + message_id varchar(255) DEFAULT '', -- mail Message-ID header field + from_addr varchar(255) CHARACTER SET utf8 COLLATE utf8_bin DEFAULT '', + -- mail From header field, UTF8 + subject varchar(255) CHARACTER SET utf8 COLLATE utf8_bin DEFAULT '', + -- mail Subject header field, UTF8 + host varchar(255) NOT NULL, -- hostname where amavisd is running + PRIMARY KEY (partition_tag,mail_id), + FOREIGN KEY (sid) REFERENCES maddr(id) ON DELETE RESTRICT +) ENGINE=InnoDB; +CREATE INDEX msgs_idx_sid ON msgs (sid); +CREATE INDEX msgs_idx_mess_id ON msgs (message_id); -- useful with pen pals +CREATE INDEX msgs_idx_time_num ON msgs (time_num); +-- alternatively when purging based on time_iso (instead of msgs_idx_time_num): +CREATE INDEX msgs_idx_time_iso ON msgs (time_iso); + +-- per-recipient information related to each processed message; +-- NOTE: records in msgrcpt without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE msgrcpt ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id varbinary(16) NOT NULL, -- (must allow duplicates) + rseqnum integer DEFAULT 0 NOT NULL, -- recip's enumeration within msg + rid bigint unsigned NOT NULL, -- recipient: maddr.id (dupl. allowed) + is_local char(1) DEFAULT ' ' NOT NULL, -- recip is: Y=local, N=foreign + content char(1) DEFAULT ' ' NOT NULL, -- content type V/B/U/S/Y/M/H/O/T/C + ds char(1) NOT NULL, -- delivery status: P/R/B/D/T + -- pass/reject/bounce/discard/tempfail + rs char(1) NOT NULL, -- release status: initialized to ' ' + bl char(1) DEFAULT ' ', -- sender blacklisted by this recip + wl char(1) DEFAULT ' ', -- sender whitelisted by this recip + bspam_level float, -- per-recipient (total) spam level + smtp_resp varchar(255) DEFAULT '', -- SMTP response given to MTA + PRIMARY KEY (partition_tag,mail_id,rseqnum), + FOREIGN KEY (rid) REFERENCES maddr(id) ON DELETE RESTRICT, + FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +) ENGINE=InnoDB; +CREATE INDEX msgrcpt_idx_mail_id ON msgrcpt (mail_id); +CREATE INDEX msgrcpt_idx_rid ON msgrcpt (rid); +-- Additional index on rs since Modoboa uses it to filter its quarantine +CREATE INDEX msgrcpt_idx_rs ON msgrcpt (rs); + +-- mail quarantine in SQL, enabled by $*_quarantine_method='sql:' +-- NOTE: records in quarantine without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE quarantine ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id varbinary(16) NOT NULL, -- long-term unique mail id + chunk_ind integer unsigned NOT NULL, -- chunk number, starting with 1 + mail_text blob NOT NULL, -- store mail as chunks of octets + PRIMARY KEY (partition_tag,mail_id,chunk_ind), + FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +) ENGINE=InnoDB; + +-- field msgrcpt.rs is primarily intended for use by quarantine management +-- software; the value assigned by amavisd is a space; +-- a short _preliminary_ list of possible values: +-- 'V' => viewed (marked as read) +-- 'R' => released (delivered) to this recipient +-- 'p' => pending (a status given to messages when the admin received the +-- request but not yet released; targeted to banned parts) +-- 'D' => marked for deletion; a cleanup script may delete it diff --git a/modoboa_installer/scripts/files/amavis/amavis_postgres_2.10.1.sql b/modoboa_installer/scripts/files/amavis/amavis_postgres_2.10.1.sql new file mode 100644 index 0000000..06cb3b0 --- /dev/null +++ b/modoboa_installer/scripts/files/amavis/amavis_postgres_2.10.1.sql @@ -0,0 +1,187 @@ +CREATE TABLE policy ( + id serial PRIMARY KEY, -- 'id' is the _only_ required field + policy_name varchar(32), -- not used by amavisd-new, a comment + + virus_lover char(1) default NULL, -- Y/N + spam_lover char(1) default NULL, -- Y/N + unchecked_lover char(1) default NULL, -- Y/N + banned_files_lover char(1) default NULL, -- Y/N + bad_header_lover char(1) default NULL, -- Y/N + + bypass_virus_checks char(1) default NULL, -- Y/N + bypass_spam_checks char(1) default NULL, -- Y/N + bypass_banned_checks char(1) default NULL, -- Y/N + bypass_header_checks char(1) default NULL, -- Y/N + + virus_quarantine_to varchar(64) default NULL, + spam_quarantine_to varchar(64) default NULL, + banned_quarantine_to varchar(64) default NULL, + unchecked_quarantine_to varchar(64) default NULL, + bad_header_quarantine_to varchar(64) default NULL, + clean_quarantine_to varchar(64) default NULL, + archive_quarantine_to varchar(64) default NULL, + + spam_tag_level real default NULL, -- higher score inserts spam info headers + spam_tag2_level real default NULL, -- inserts 'declared spam' header fields + spam_tag3_level real default NULL, -- inserts 'blatant spam' header fields + spam_kill_level real default NULL, -- higher score triggers evasive actions + -- e.g. reject/drop, quarantine, ... + -- (subject to final_spam_destiny setting) + + spam_dsn_cutoff_level real default NULL, + spam_quarantine_cutoff_level real default NULL, + + addr_extension_virus varchar(64) default NULL, + addr_extension_spam varchar(64) default NULL, + addr_extension_banned varchar(64) default NULL, + addr_extension_bad_header varchar(64) default NULL, + + warnvirusrecip char(1) default NULL, -- Y/N + warnbannedrecip char(1) default NULL, -- Y/N + warnbadhrecip char(1) default NULL, -- Y/N + newvirus_admin varchar(64) default NULL, + virus_admin varchar(64) default NULL, + banned_admin varchar(64) default NULL, + bad_header_admin varchar(64) default NULL, + spam_admin varchar(64) default NULL, + spam_subject_tag varchar(64) default NULL, + spam_subject_tag2 varchar(64) default NULL, + spam_subject_tag3 varchar(64) default NULL, + message_size_limit integer default NULL, -- max size in bytes, 0 disable + banned_rulenames varchar(64) default NULL, -- comma-separated list of ... + -- names mapped through %banned_rules to actual banned_filename tables + disclaimer_options varchar(64) default NULL, + forward_method varchar(64) default NULL, + sa_userconf varchar(64) default NULL, + sa_username varchar(64) default NULL +); + +-- local users +CREATE TABLE users ( + id serial PRIMARY KEY, -- unique id + priority integer NOT NULL DEFAULT 7, -- sort field, 0 is low prior. + policy_id integer NOT NULL DEFAULT 1 CHECK (policy_id >= 0) REFERENCES policy(id), + email bytea NOT NULL UNIQUE, -- email address, non-rfc2822-quoted + fullname varchar(255) DEFAULT NULL -- not used by amavisd-new + -- local char(1) -- Y/N (optional, see SQL section in README.lookups) +); + +-- any e-mail address (non- rfc2822-quoted), external or local, +-- used as senders in wblist +CREATE TABLE mailaddr ( + id serial PRIMARY KEY, + priority integer NOT NULL DEFAULT 9, -- 0 is low priority + email bytea NOT NULL UNIQUE +); + +-- per-recipient whitelist and/or blacklist, +-- puts sender and recipient in relation wb (white or blacklisted sender) +CREATE TABLE wblist ( + rid integer NOT NULL CHECK (rid >= 0) REFERENCES users(id), + sid integer NOT NULL CHECK (sid >= 0) REFERENCES mailaddr(id), + wb varchar(10) NOT NULL, -- W or Y / B or N / space=neutral / score + PRIMARY KEY (rid,sid) +); + +-- grant usage rights: +GRANT select ON policy TO amavis; +GRANT select ON users TO amavis; +GRANT select ON mailaddr TO amavis; +GRANT select ON wblist TO amavis; + + +-- R/W part of the dataset (optional) +-- May reside in the same or in a separate database as lookups database; +-- REQUIRES SUPPORT FOR TRANSACTIONS; specified in @storage_sql_dsn +-- +-- Please create additional indexes on keys when needed, or drop suggested +-- ones as appropriate to optimize queries needed by a management application. +-- See your database documentation for further optimization hints. + +-- provide unique id for each e-mail address, avoids storing copies +CREATE TABLE maddr ( + id serial PRIMARY KEY, + partition_tag integer DEFAULT 0, -- see $partition_tag + email bytea NOT NULL, -- full e-mail address + domain varchar(255) NOT NULL, -- only domain part of the email address + -- with subdomain fields in reverse + CONSTRAINT part_email UNIQUE (partition_tag,email) +); + +-- information pertaining to each processed message as a whole; +-- NOTE: records with a NULL msgs.content should be ignored by utilities, +-- as such records correspond to messages just being processed, or were lost +CREATE TABLE msgs ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id bytea NOT NULL, -- long-term unique mail id, dflt 12 ch + secret_id bytea DEFAULT '', -- authorizes release of mail_id, 12 ch + am_id varchar(20) NOT NULL, -- id used in the log + time_num integer NOT NULL CHECK (time_num >= 0), + -- rx_time: seconds since Unix epoch + time_iso timestamp WITH TIME ZONE NOT NULL,-- rx_time: ISO8601 UTC ascii time + sid integer NOT NULL CHECK (sid >= 0), -- sender: maddr.id + policy varchar(255) DEFAULT '', -- policy bank path (like macro %p) + client_addr varchar(255) DEFAULT '', -- SMTP client IP address (IPv4 or v6) + size integer NOT NULL CHECK (size >= 0), -- message size in bytes + originating char(1) DEFAULT ' ' NOT NULL, -- sender from inside or auth'd + content char(1), -- content type: V/B/U/S/Y/M/H/O/T/C + -- virus/banned/unchecked/spam(kill)/spammy(tag2)/ + -- /bad-mime/bad-header/oversized/mta-err/clean + -- is NULL on partially processed mail + -- (prior to 2.7.0 the CC_SPAMMY was logged as 's', now 'Y' is used; + --- to avoid a need for case-insenstivity in queries) + quar_type char(1), -- quarantined as: ' '/F/Z/B/Q/M/L + -- none/file/zipfile/bsmtp/sql/ + -- /mailbox(smtp)/mailbox(lmtp) + quar_loc varchar(255) DEFAULT '', -- quarantine location (e.g. file) + dsn_sent char(1), -- was DSN sent? Y/N/q (q=quenched) + spam_level real, -- SA spam level (no boosts) + message_id varchar(255) DEFAULT '', -- mail Message-ID header field + from_addr varchar(255) DEFAULT '', -- mail From header field, UTF8 + subject varchar(255) DEFAULT '', -- mail Subject header field, UTF8 + host varchar(255) NOT NULL, -- hostname where amavisd is running + CONSTRAINT msgs_partition_mail UNIQUE (partition_tag,mail_id), + PRIMARY KEY (partition_tag,mail_id) +--FOREIGN KEY (sid) REFERENCES maddr(id) ON DELETE RESTRICT +); +CREATE INDEX msgs_idx_sid ON msgs (sid); +CREATE INDEX msgs_idx_mess_id ON msgs (message_id); -- useful with pen pals +CREATE INDEX msgs_idx_time_iso ON msgs (time_iso); +CREATE INDEX msgs_idx_time_num ON msgs (time_num); -- optional + +-- per-recipient information related to each processed message; +-- NOTE: records in msgrcpt without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE msgrcpt ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id bytea NOT NULL, -- (must allow duplicates) + rseqnum integer DEFAULT 0 NOT NULL, -- recip's enumeration within msg + rid integer NOT NULL, -- recipient: maddr.id (duplicates allowed) + is_local char(1) DEFAULT ' ' NOT NULL, -- recip is: Y=local, N=foreign + content char(1) DEFAULT ' ' NOT NULL, -- content type V/B/U/S/Y/M/H/O/T/C + ds char(1) NOT NULL, -- delivery status: P/R/B/D/T + -- pass/reject/bounce/discard/tempfail + rs char(1) NOT NULL, -- release status: initialized to ' ' + bl char(1) DEFAULT ' ', -- sender blacklisted by this recip + wl char(1) DEFAULT ' ', -- sender whitelisted by this recip + bspam_level real, -- per-recipient (total) spam level + smtp_resp varchar(255) DEFAULT '', -- SMTP response given to MTA + CONSTRAINT msgrcpt_partition_mail_rseq UNIQUE (partition_tag,mail_id,rseqnum), + PRIMARY KEY (partition_tag,mail_id,rseqnum) +--FOREIGN KEY (rid) REFERENCES maddr(id) ON DELETE RESTRICT, +--FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +); +CREATE INDEX msgrcpt_idx_mail_id ON msgrcpt (mail_id); +CREATE INDEX msgrcpt_idx_rid ON msgrcpt (rid); + +-- mail quarantine in SQL, enabled by $*_quarantine_method='sql:' +-- NOTE: records in quarantine without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE quarantine ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id bytea NOT NULL, -- long-term unique mail id + chunk_ind integer NOT NULL CHECK (chunk_ind >= 0), -- chunk number, 1.. + mail_text bytea NOT NULL, -- store mail as chunks of octects + PRIMARY KEY (partition_tag,mail_id,chunk_ind) +--FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +); diff --git a/modoboa_installer/scripts/files/amavis/amavis_postgres_2.7.0.sql b/modoboa_installer/scripts/files/amavis/amavis_postgres_2.7.0.sql new file mode 100644 index 0000000..9139be9 --- /dev/null +++ b/modoboa_installer/scripts/files/amavis/amavis_postgres_2.7.0.sql @@ -0,0 +1,197 @@ +-- Amavis 2.7.0 PostgreSQL schema +-- Provided by Modoboa +-- Warning: foreign key creations are enabled + +-- policies +CREATE TABLE policy ( + id serial PRIMARY KEY, -- 'id' is the _only_ required field + policy_name varchar(32), -- not used by amavisd-new, a comment + + virus_lover char(1) default NULL, -- Y/N + spam_lover char(1) default NULL, -- Y/N + unchecked_lover char(1) default NULL, -- Y/N + banned_files_lover char(1) default NULL, -- Y/N + bad_header_lover char(1) default NULL, -- Y/N + + bypass_virus_checks char(1) default NULL, -- Y/N + bypass_spam_checks char(1) default NULL, -- Y/N + bypass_banned_checks char(1) default NULL, -- Y/N + bypass_header_checks char(1) default NULL, -- Y/N + + virus_quarantine_to varchar(64) default NULL, + spam_quarantine_to varchar(64) default NULL, + banned_quarantine_to varchar(64) default NULL, + unchecked_quarantine_to varchar(64) default NULL, + bad_header_quarantine_to varchar(64) default NULL, + clean_quarantine_to varchar(64) default NULL, + archive_quarantine_to varchar(64) default NULL, + + spam_tag_level real default NULL, -- higher score inserts spam info headers + spam_tag2_level real default NULL, -- inserts 'declared spam' header fields + spam_tag3_level real default NULL, -- inserts 'blatant spam' header fields + spam_kill_level real default NULL, -- higher score triggers evasive actions + -- e.g. reject/drop, quarantine, ... + -- (subject to final_spam_destiny setting) + + spam_dsn_cutoff_level real default NULL, + spam_quarantine_cutoff_level real default NULL, + + addr_extension_virus varchar(64) default NULL, + addr_extension_spam varchar(64) default NULL, + addr_extension_banned varchar(64) default NULL, + addr_extension_bad_header varchar(64) default NULL, + + warnvirusrecip char(1) default NULL, -- Y/N + warnbannedrecip char(1) default NULL, -- Y/N + warnbadhrecip char(1) default NULL, -- Y/N + newvirus_admin varchar(64) default NULL, + virus_admin varchar(64) default NULL, + banned_admin varchar(64) default NULL, + bad_header_admin varchar(64) default NULL, + spam_admin varchar(64) default NULL, + spam_subject_tag varchar(64) default NULL, + spam_subject_tag2 varchar(64) default NULL, + spam_subject_tag3 varchar(64) default NULL, + message_size_limit integer default NULL, -- max size in bytes, 0 disable + banned_rulenames varchar(64) default NULL, -- comma-separated list of ... + -- names mapped through %banned_rules to actual banned_filename tables + disclaimer_options varchar(64) default NULL, + forward_method varchar(64) default NULL, + sa_userconf varchar(64) default NULL, + sa_username varchar(64) default NULL +); + +-- local users +CREATE TABLE users ( + id serial PRIMARY KEY, -- unique id + priority integer NOT NULL DEFAULT 7, -- sort field, 0 is low prior. + policy_id integer NOT NULL DEFAULT 1 CHECK (policy_id >= 0) REFERENCES policy(id), + email bytea NOT NULL UNIQUE, -- email address, non-rfc2822-quoted + fullname varchar(255) DEFAULT NULL -- not used by amavisd-new + -- local char(1) -- Y/N (optional, see SQL section in README.lookups) +); + +-- any e-mail address (non- rfc2822-quoted), external or local, +-- used as senders in wblist +CREATE TABLE mailaddr ( + id serial PRIMARY KEY, + priority integer NOT NULL DEFAULT 9, -- 0 is low priority + email bytea NOT NULL UNIQUE +); + +-- per-recipient whitelist and/or blacklist, +-- puts sender and recipient in relation wb (white or blacklisted sender) +CREATE TABLE wblist ( + rid integer NOT NULL CHECK (rid >= 0) REFERENCES users(id), + sid integer NOT NULL CHECK (sid >= 0) REFERENCES mailaddr(id), + wb varchar(10) NOT NULL, -- W or Y / B or N / space=neutral / score + PRIMARY KEY (rid,sid) +); + + +-- R/W part of the dataset (optional) +-- May reside in the same or in a separate database as lookups database; +-- REQUIRES SUPPORT FOR TRANSACTIONS; specified in @storage_sql_dsn +-- +-- Please create additional indexes on keys when needed, or drop suggested +-- ones as appropriate to optimize queries needed by a management application. +-- See your database documentation for further optimization hints. + +-- provide unique id for each e-mail address, avoids storing copies +CREATE TABLE maddr ( + id serial PRIMARY KEY, + partition_tag integer DEFAULT 0, -- see $partition_tag + email bytea NOT NULL, -- full e-mail address + domain varchar(255) NOT NULL, -- only domain part of the email address + -- with subdomain fields in reverse + CONSTRAINT part_email UNIQUE (partition_tag,email) +); + +-- information pertaining to each processed message as a whole; +-- NOTE: records with a NULL msgs.content should be ignored by utilities, +-- as such records correspond to messages just being processed, or were lost +CREATE TABLE msgs ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id bytea NOT NULL, -- long-term unique mail id, dflt 12 ch + secret_id bytea DEFAULT '', -- authorizes release of mail_id, 12 ch + am_id varchar(20) NOT NULL, -- id used in the log + time_num integer NOT NULL CHECK (time_num >= 0), + -- rx_time: seconds since Unix epoch + time_iso timestamp WITH TIME ZONE NOT NULL,-- rx_time: ISO8601 UTC ascii time + sid integer NOT NULL CHECK (sid >= 0), -- sender: maddr.id + policy varchar(255) DEFAULT '', -- policy bank path (like macro %p) + client_addr varchar(255) DEFAULT '', -- SMTP client IP address (IPv4 or v6) + size integer NOT NULL CHECK (size >= 0), -- message size in bytes + originating char(1) DEFAULT ' ' NOT NULL, -- sender from inside or auth'd + content char(1), -- content type: V/B/U/S/Y/M/H/O/T/C + -- virus/banned/unchecked/spam(kill)/spammy(tag2)/ + -- /bad-mime/bad-header/oversized/mta-err/clean + -- is NULL on partially processed mail + -- (prior to 2.7.0 the CC_SPAMMY was logged as 's', now 'Y' is used; + --- to avoid a need for case-insenstivity in queries) + quar_type char(1), -- quarantined as: ' '/F/Z/B/Q/M/L + -- none/file/zipfile/bsmtp/sql/ + -- /mailbox(smtp)/mailbox(lmtp) + quar_loc varchar(255) DEFAULT '', -- quarantine location (e.g. file) + dsn_sent char(1), -- was DSN sent? Y/N/q (q=quenched) + spam_level real, -- SA spam level (no boosts) + message_id varchar(255) DEFAULT '', -- mail Message-ID header field + from_addr varchar(255) DEFAULT '', -- mail From header field, UTF8 + subject varchar(255) DEFAULT '', -- mail Subject header field, UTF8 + host varchar(255) NOT NULL, -- hostname where amavisd is running + CONSTRAINT msgs_partition_mail UNIQUE (partition_tag,mail_id), + PRIMARY KEY (partition_tag,mail_id) + -- FOREIGN KEY (sid) REFERENCES maddr(id) ON DELETE RESTRICT +); +CREATE INDEX msgs_idx_sid ON msgs (sid); +CREATE INDEX msgs_idx_mess_id ON msgs (message_id); -- useful with pen pals +CREATE INDEX msgs_idx_time_iso ON msgs (time_iso); +CREATE INDEX msgs_idx_time_num ON msgs (time_num); -- optional + +-- per-recipient information related to each processed message; +-- NOTE: records in msgrcpt without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE msgrcpt ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id bytea NOT NULL, -- (must allow duplicates) + rseqnum integer DEFAULT 0 NOT NULL, -- recip's enumeration within msg + rid integer NOT NULL, -- recipient: maddr.id (duplicates allowed) + is_local char(1) DEFAULT ' ' NOT NULL, -- recip is: Y=local, N=foreign + content char(1) DEFAULT ' ' NOT NULL, -- content type V/B/U/S/Y/M/H/O/T/C + ds char(1) NOT NULL, -- delivery status: P/R/B/D/T + -- pass/reject/bounce/discard/tempfail + rs char(1) NOT NULL, -- release status: initialized to ' ' + bl char(1) DEFAULT ' ', -- sender blacklisted by this recip + wl char(1) DEFAULT ' ', -- sender whitelisted by this recip + bspam_level real, -- per-recipient (total) spam level + smtp_resp varchar(255) DEFAULT '', -- SMTP response given to MTA + CONSTRAINT msgrcpt_partition_mail_rseq UNIQUE (partition_tag,mail_id,rseqnum), + PRIMARY KEY (partition_tag,mail_id,rseqnum) + -- FOREIGN KEY (rid) REFERENCES maddr(id) ON DELETE RESTRICT, + -- FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +); +CREATE INDEX msgrcpt_idx_mail_id ON msgrcpt (mail_id); +CREATE INDEX msgrcpt_idx_rid ON msgrcpt (rid); +-- Additional index on rs since Modoboa uses it to filter its quarantine +CREATE INDEX msgrcpt_idx_rs ON msgrcpt (rs); + +-- mail quarantine in SQL, enabled by $*_quarantine_method='sql:' +-- NOTE: records in quarantine without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE quarantine ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id bytea NOT NULL, -- long-term unique mail id + chunk_ind integer NOT NULL CHECK (chunk_ind >= 0), -- chunk number, 1.. + mail_text bytea NOT NULL, -- store mail as chunks of octects + PRIMARY KEY (partition_tag,mail_id,chunk_ind) + -- FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +); + +-- field msgrcpt.rs is primarily intended for use by quarantine management +-- software; the value assigned by amavisd is a space; +-- a short _preliminary_ list of possible values: +-- 'V' => viewed (marked as read) +-- 'R' => released (delivered) to this recipient +-- 'p' => pending (a status given to messages when the admin received the +-- request but not yet released; targeted to banned parts) +-- 'D' => marked for deletion; a cleanup script may delete it diff --git a/modoboa_installer/scripts/files/amavis/amavis_postgres_2.7.1.sql b/modoboa_installer/scripts/files/amavis/amavis_postgres_2.7.1.sql new file mode 100644 index 0000000..44d4b95 --- /dev/null +++ b/modoboa_installer/scripts/files/amavis/amavis_postgres_2.7.1.sql @@ -0,0 +1,197 @@ +-- Amavis 2.7.1 PostgreSQL schema +-- Provided by Modoboa +-- Warning: foreign key creations are enabled + +-- policies +CREATE TABLE policy ( + id serial PRIMARY KEY, -- 'id' is the _only_ required field + policy_name varchar(32), -- not used by amavisd-new, a comment + + virus_lover char(1) default NULL, -- Y/N + spam_lover char(1) default NULL, -- Y/N + unchecked_lover char(1) default NULL, -- Y/N + banned_files_lover char(1) default NULL, -- Y/N + bad_header_lover char(1) default NULL, -- Y/N + + bypass_virus_checks char(1) default NULL, -- Y/N + bypass_spam_checks char(1) default NULL, -- Y/N + bypass_banned_checks char(1) default NULL, -- Y/N + bypass_header_checks char(1) default NULL, -- Y/N + + virus_quarantine_to varchar(64) default NULL, + spam_quarantine_to varchar(64) default NULL, + banned_quarantine_to varchar(64) default NULL, + unchecked_quarantine_to varchar(64) default NULL, + bad_header_quarantine_to varchar(64) default NULL, + clean_quarantine_to varchar(64) default NULL, + archive_quarantine_to varchar(64) default NULL, + + spam_tag_level real default NULL, -- higher score inserts spam info headers + spam_tag2_level real default NULL, -- inserts 'declared spam' header fields + spam_tag3_level real default NULL, -- inserts 'blatant spam' header fields + spam_kill_level real default NULL, -- higher score triggers evasive actions + -- e.g. reject/drop, quarantine, ... + -- (subject to final_spam_destiny setting) + + spam_dsn_cutoff_level real default NULL, + spam_quarantine_cutoff_level real default NULL, + + addr_extension_virus varchar(64) default NULL, + addr_extension_spam varchar(64) default NULL, + addr_extension_banned varchar(64) default NULL, + addr_extension_bad_header varchar(64) default NULL, + + warnvirusrecip char(1) default NULL, -- Y/N + warnbannedrecip char(1) default NULL, -- Y/N + warnbadhrecip char(1) default NULL, -- Y/N + newvirus_admin varchar(64) default NULL, + virus_admin varchar(64) default NULL, + banned_admin varchar(64) default NULL, + bad_header_admin varchar(64) default NULL, + spam_admin varchar(64) default NULL, + spam_subject_tag varchar(64) default NULL, + spam_subject_tag2 varchar(64) default NULL, + spam_subject_tag3 varchar(64) default NULL, + message_size_limit integer default NULL, -- max size in bytes, 0 disable + banned_rulenames varchar(64) default NULL, -- comma-separated list of ... + -- names mapped through %banned_rules to actual banned_filename tables + disclaimer_options varchar(64) default NULL, + forward_method varchar(64) default NULL, + sa_userconf varchar(64) default NULL, + sa_username varchar(64) default NULL +); + +-- local users +CREATE TABLE users ( + id serial PRIMARY KEY, -- unique id + priority integer NOT NULL DEFAULT 7, -- sort field, 0 is low prior. + policy_id integer NOT NULL DEFAULT 1 CHECK (policy_id >= 0) REFERENCES policy(id), + email bytea NOT NULL UNIQUE, -- email address, non-rfc2822-quoted + fullname varchar(255) DEFAULT NULL -- not used by amavisd-new + -- local char(1) -- Y/N (optional, see SQL section in README.lookups) +); + +-- any e-mail address (non- rfc2822-quoted), external or local, +-- used as senders in wblist +CREATE TABLE mailaddr ( + id serial PRIMARY KEY, + priority integer NOT NULL DEFAULT 9, -- 0 is low priority + email bytea NOT NULL UNIQUE +); + +-- per-recipient whitelist and/or blacklist, +-- puts sender and recipient in relation wb (white or blacklisted sender) +CREATE TABLE wblist ( + rid integer NOT NULL CHECK (rid >= 0) REFERENCES users(id), + sid integer NOT NULL CHECK (sid >= 0) REFERENCES mailaddr(id), + wb varchar(10) NOT NULL, -- W or Y / B or N / space=neutral / score + PRIMARY KEY (rid,sid) +); + + +-- R/W part of the dataset (optional) +-- May reside in the same or in a separate database as lookups database; +-- REQUIRES SUPPORT FOR TRANSACTIONS; specified in @storage_sql_dsn +-- +-- Please create additional indexes on keys when needed, or drop suggested +-- ones as appropriate to optimize queries needed by a management application. +-- See your database documentation for further optimization hints. + +-- provide unique id for each e-mail address, avoids storing copies +CREATE TABLE maddr ( + id serial PRIMARY KEY, + partition_tag integer DEFAULT 0, -- see $partition_tag + email bytea NOT NULL, -- full e-mail address + domain varchar(255) NOT NULL, -- only domain part of the email address + -- with subdomain fields in reverse + CONSTRAINT part_email UNIQUE (partition_tag,email) +); + +-- information pertaining to each processed message as a whole; +-- NOTE: records with a NULL msgs.content should be ignored by utilities, +-- as such records correspond to messages just being processed, or were lost +CREATE TABLE msgs ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id bytea NOT NULL, -- long-term unique mail id, dflt 12 ch + secret_id bytea DEFAULT '', -- authorizes release of mail_id, 12 ch + am_id varchar(20) NOT NULL, -- id used in the log + time_num integer NOT NULL CHECK (time_num >= 0), + -- rx_time: seconds since Unix epoch + time_iso timestamp WITH TIME ZONE NOT NULL,-- rx_time: ISO8601 UTC ascii time + sid integer NOT NULL CHECK (sid >= 0), -- sender: maddr.id + policy varchar(255) DEFAULT '', -- policy bank path (like macro %p) + client_addr varchar(255) DEFAULT '', -- SMTP client IP address (IPv4 or v6) + size integer NOT NULL CHECK (size >= 0), -- message size in bytes + originating char(1) DEFAULT ' ' NOT NULL, -- sender from inside or auth'd + content char(1), -- content type: V/B/U/S/Y/M/H/O/T/C + -- virus/banned/unchecked/spam(kill)/spammy(tag2)/ + -- /bad-mime/bad-header/oversized/mta-err/clean + -- is NULL on partially processed mail + -- (prior to 2.7.0 the CC_SPAMMY was logged as 's', now 'Y' is used; + --- to avoid a need for case-insenstivity in queries) + quar_type char(1), -- quarantined as: ' '/F/Z/B/Q/M/L + -- none/file/zipfile/bsmtp/sql/ + -- /mailbox(smtp)/mailbox(lmtp) + quar_loc varchar(255) DEFAULT '', -- quarantine location (e.g. file) + dsn_sent char(1), -- was DSN sent? Y/N/q (q=quenched) + spam_level real, -- SA spam level (no boosts) + message_id varchar(255) DEFAULT '', -- mail Message-ID header field + from_addr varchar(255) DEFAULT '', -- mail From header field, UTF8 + subject varchar(255) DEFAULT '', -- mail Subject header field, UTF8 + host varchar(255) NOT NULL, -- hostname where amavisd is running + CONSTRAINT msgs_partition_mail UNIQUE (partition_tag,mail_id), + PRIMARY KEY (partition_tag,mail_id) + -- FOREIGN KEY (sid) REFERENCES maddr(id) ON DELETE RESTRICT +); +CREATE INDEX msgs_idx_sid ON msgs (sid); +CREATE INDEX msgs_idx_mess_id ON msgs (message_id); -- useful with pen pals +CREATE INDEX msgs_idx_time_iso ON msgs (time_iso); +CREATE INDEX msgs_idx_time_num ON msgs (time_num); -- optional + +-- per-recipient information related to each processed message; +-- NOTE: records in msgrcpt without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE msgrcpt ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id bytea NOT NULL, -- (must allow duplicates) + rseqnum integer DEFAULT 0 NOT NULL, -- recip's enumeration within msg + rid integer NOT NULL, -- recipient: maddr.id (duplicates allowed) + is_local char(1) DEFAULT ' ' NOT NULL, -- recip is: Y=local, N=foreign + content char(1) DEFAULT ' ' NOT NULL, -- content type V/B/U/S/Y/M/H/O/T/C + ds char(1) NOT NULL, -- delivery status: P/R/B/D/T + -- pass/reject/bounce/discard/tempfail + rs char(1) NOT NULL, -- release status: initialized to ' ' + bl char(1) DEFAULT ' ', -- sender blacklisted by this recip + wl char(1) DEFAULT ' ', -- sender whitelisted by this recip + bspam_level real, -- per-recipient (total) spam level + smtp_resp varchar(255) DEFAULT '', -- SMTP response given to MTA + CONSTRAINT msgrcpt_partition_mail_rseq UNIQUE (partition_tag,mail_id,rseqnum), + PRIMARY KEY (partition_tag,mail_id,rseqnum) + -- FOREIGN KEY (rid) REFERENCES maddr(id) ON DELETE RESTRICT, + -- FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +); +CREATE INDEX msgrcpt_idx_mail_id ON msgrcpt (mail_id); +CREATE INDEX msgrcpt_idx_rid ON msgrcpt (rid); +-- Additional index on rs since Modoboa uses it to filter its quarantine +CREATE INDEX msgrcpt_idx_rs ON msgrcpt (rs); + +-- mail quarantine in SQL, enabled by $*_quarantine_method='sql:' +-- NOTE: records in quarantine without corresponding msgs.mail_id record are +-- orphaned and should be ignored and eventually deleted by external utilities +CREATE TABLE quarantine ( + partition_tag integer DEFAULT 0, -- see $partition_tag + mail_id bytea NOT NULL, -- long-term unique mail id + chunk_ind integer NOT NULL CHECK (chunk_ind >= 0), -- chunk number, 1.. + mail_text bytea NOT NULL, -- store mail as chunks of octects + PRIMARY KEY (partition_tag,mail_id,chunk_ind) + -- FOREIGN KEY (mail_id) REFERENCES msgs(mail_id) ON DELETE CASCADE +); + +-- field msgrcpt.rs is primarily intended for use by quarantine management +-- software; the value assigned by amavisd is a space; +-- a short _preliminary_ list of possible values: +-- 'V' => viewed (marked as read) +-- 'R' => released (delivered) to this recipient +-- 'p' => pending (a status given to messages when the admin received the +-- request but not yet released; targeted to banned parts) +-- 'D' => marked for deletion; a cleanup script may delete it diff --git a/modoboa_installer/scripts/files/dovecot/conf.d/10-auth.conf b/modoboa_installer/scripts/files/dovecot/conf.d/10-auth.conf new file mode 100644 index 0000000..96c6738 --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/conf.d/10-auth.conf @@ -0,0 +1,127 @@ +## +## Authentication processes +## + +# Disable LOGIN command and all other plaintext authentications unless +# SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP +# matches the local IP (ie. you're connecting from the same computer), the +# connection is considered secure and plaintext authentication is allowed. +#disable_plaintext_auth = yes + +# Authentication cache size (e.g. 10M). 0 means it's disabled. Note that +# bsdauth, PAM and vpopmail require cache_key to be set for caching to be used. +#auth_cache_size = 0 +# Time to live for cached data. After TTL expires the cached record is no +# longer used, *except* if the main database lookup returns internal failure. +# We also try to handle password changes automatically: If user's previous +# authentication was successful, but this one wasn't, the cache isn't used. +# For now this works only with plaintext authentication. +#auth_cache_ttl = 1 hour +# TTL for negative hits (user not found, password mismatch). +# 0 disables caching them completely. +#auth_cache_negative_ttl = 1 hour + +# Space separated list of realms for SASL authentication mechanisms that need +# them. You can leave it empty if you don't want to support multiple realms. +# Many clients simply use the first one listed here, so keep the default realm +# first. +#auth_realms = + +# Default realm/domain to use if none was specified. This is used for both +# SASL realms and appending @domain to username in plaintext logins. +#auth_default_realm = + +# List of allowed characters in username. If the user-given username contains +# a character not listed in here, the login automatically fails. This is just +# an extra check to make sure user can't exploit any potential quote escaping +# vulnerabilities with SQL/LDAP databases. If you want to allow all characters, +# set this value to empty. +#auth_username_chars = abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ01234567890.-_@ + +# Username character translations before it's looked up from databases. The +# value contains series of from -> to characters. For example "#@/@" means +# that '#' and '/' characters are translated to '@'. +#auth_username_translation = + +# Username formatting before it's looked up from databases. You can use +# the standard variables here, eg. %Lu would lowercase the username, %n would +# drop away the domain if it was given, or "%n-AT-%d" would change the '@' into +# "-AT-". This translation is done after auth_username_translation changes. +#auth_username_format = %Lu + +# If you want to allow master users to log in by specifying the master +# username within the normal username string (ie. not using SASL mechanism's +# support for it), you can specify the separator character here. The format +# is then . UW-IMAP uses "*" as the +# separator, so that could be a good choice. +#auth_master_user_separator = + +# Username to use for users logging in with ANONYMOUS SASL mechanism +#auth_anonymous_username = anonymous + +# Maximum number of dovecot-auth worker processes. They're used to execute +# blocking passdb and userdb queries (eg. MySQL and PAM). They're +# automatically created and destroyed as needed. +#auth_worker_max_count = 30 + +# Host name to use in GSSAPI principal names. The default is to use the +# name returned by gethostname(). Use "$ALL" (with quotes) to allow all keytab +# entries. +#auth_gssapi_hostname = + +# Kerberos keytab to use for the GSSAPI mechanism. Will use the system +# default (usually /etc/krb5.keytab) if not specified. You may need to change +# the auth service to run as root to be able to read this file. +#auth_krb5_keytab = + +# Do NTLM and GSS-SPNEGO authentication using Samba's winbind daemon and +# ntlm_auth helper. +#auth_use_winbind = no + +# Path for Samba's ntlm_auth helper binary. +#auth_winbind_helper_path = /usr/bin/ntlm_auth + +# Time to delay before replying to failed authentications. +#auth_failure_delay = 2 secs + +# Require a valid SSL client certificate or the authentication fails. +#auth_ssl_require_client_cert = no + +# Take the username from client's SSL certificate, using +# X509_NAME_get_text_by_NID() which returns the subject's DN's +# CommonName. +#auth_ssl_username_from_cert = no + +# Space separated list of wanted authentication mechanisms: +# plain login digest-md5 cram-md5 ntlm rpa apop anonymous gssapi otp skey +# gss-spnego +# NOTE: See also disable_plaintext_auth setting. +auth_mechanisms = plain + +## +## Password and user databases +## + +# +# Password database is used to verify user's password (and nothing more). +# You can have multiple passdbs and userdbs. This is useful if you want to +# allow both system users (/etc/passwd) and virtual users to login without +# duplicating the system users into virtual database. +# +# +# +# User database specifies where mails are located and what user/group IDs +# own them. For single-UID configuration use "static" userdb. +# +# + +#!include auth-deny.conf.ext +#!include auth-master.conf.ext + +#!include auth-system.conf.ext +!include auth-sql.conf.ext +#!include auth-ldap.conf.ext +#!include auth-passwdfile.conf.ext +#!include auth-checkpassword.conf.ext +#!include auth-vpopmail.conf.ext +#!include auth-static.conf.ext diff --git a/modoboa_installer/scripts/files/dovecot/conf.d/10-mail.conf b/modoboa_installer/scripts/files/dovecot/conf.d/10-mail.conf new file mode 100644 index 0000000..8e555ea --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/conf.d/10-mail.conf @@ -0,0 +1,363 @@ +## +## Mailbox locations and namespaces +## + +# Location for users' mailboxes. The default is empty, which means that Dovecot +# tries to find the mailboxes automatically. This won't work if the user +# doesn't yet have any mail, so you should explicitly tell Dovecot the full +# location. +# +# If you're using mbox, giving a path to the INBOX file (eg. /var/mail/%u) +# isn't enough. You'll also need to tell Dovecot where the other mailboxes are +# kept. This is called the "root mail directory", and it must be the first +# path given in the mail_location setting. +# +# There are a few special variables you can use, eg.: +# +# %u - username +# %n - user part in user@domain, same as %u if there's no domain +# %d - domain part in user@domain, empty if there's no domain +# %h - home directory +# +# See doc/wiki/Variables.txt for full list. Some examples: +# +# mail_location = maildir:~/Maildir +# mail_location = mbox:~/mail:INBOX=/var/mail/%u +# mail_location = mbox:/var/mail/%d/%1n/%n:INDEX=/var/indexes/%d/%1n/%n +# +# +# +#mail_location = mbox:~/mail:INBOX=/var/mail/%u +mail_location = maildir:~/Maildir + +# If you need to set multiple mailbox locations or want to change default +# namespace settings, you can do it by defining namespace sections. +# +# You can have private, shared and public namespaces. Private namespaces +# are for user's personal mails. Shared namespaces are for accessing other +# users' mailboxes that have been shared. Public namespaces are for shared +# mailboxes that are managed by sysadmin. If you create any shared or public +# namespaces you'll typically want to enable ACL plugin also, otherwise all +# users can access all the shared mailboxes, assuming they have permissions +# on filesystem level to do so. +namespace inbox { + # Namespace type: private, shared or public + #type = private + + # Hierarchy separator to use. You should use the same separator for all + # namespaces or some clients get confused. '/' is usually a good one. + # The default however depends on the underlying mail storage format. + #separator = + + # Prefix required to access this namespace. This needs to be different for + # all namespaces. For example "Public/". + #prefix = + + # Physical location of the mailbox. This is in same format as + # mail_location, which is also the default for it. + #location = + + # There can be only one INBOX, and this setting defines which namespace + # has it. + inbox = yes + + # If namespace is hidden, it's not advertised to clients via NAMESPACE + # extension. You'll most likely also want to set list=no. This is mostly + # useful when converting from another server with different namespaces which + # you want to deprecate but still keep working. For example you can create + # hidden namespaces with prefixes "~/mail/", "~%u/mail/" and "mail/". + #hidden = no + + # Show the mailboxes under this namespace with LIST command. This makes the + # namespace visible for clients that don't support NAMESPACE extension. + # "children" value lists child mailboxes, but hides the namespace prefix. + #list = yes + + # Namespace handles its own subscriptions. If set to "no", the parent + # namespace handles them (empty prefix should always have this as "yes") + #subscriptions = yes +} + +# Example shared namespace configuration +#namespace { + #type = shared + #separator = / + + # Mailboxes are visible under "shared/user@domain/" + # %%n, %%d and %%u are expanded to the destination user. + #prefix = shared/%%u/ + + # Mail location for other users' mailboxes. Note that %variables and ~/ + # expands to the logged in user's data. %%n, %%d, %%u and %%h expand to the + # destination user's data. + #location = maildir:%%h/Maildir:INDEX=~/Maildir/shared/%%u + + # Use the default namespace for saving subscriptions. + #subscriptions = no + + # List the shared/ namespace only if there are visible shared mailboxes. + #list = children +#} +# Should shared INBOX be visible as "shared/user" or "shared/user/INBOX"? +#mail_shared_explicit_inbox = yes + +# System user and group used to access mails. If you use multiple, userdb +# can override these by returning uid or gid fields. You can use either numbers +# or names. +#mail_uid = +#mail_gid = + +# Group to enable temporarily for privileged operations. Currently this is +# used only with INBOX when either its initial creation or dotlocking fails. +# Typically this is set to "mail" to give access to /var/mail. +#mail_privileged_group = + +# Grant access to these supplementary groups for mail processes. Typically +# these are used to set up access to shared mailboxes. Note that it may be +# dangerous to set these if users can create symlinks (e.g. if "mail" group is +# set here, ln -s /var/mail ~/mail/var could allow a user to delete others' +# mailboxes, or ln -s /secret/shared/box ~/mail/mybox would allow reading it). +#mail_access_groups = + +# Allow full filesystem access to clients. There's no access checks other than +# what the operating system does for the active UID/GID. It works with both +# maildir and mboxes, allowing you to prefix mailboxes names with eg. /path/ +# or ~user/. +#mail_full_filesystem_access = no + +## +## Mail processes +## + +# Don't use mmap() at all. This is required if you store indexes to shared +# filesystems (NFS or clustered filesystem). +#mmap_disable = no + +# Rely on O_EXCL to work when creating dotlock files. NFS supports O_EXCL +# since version 3, so this should be safe to use nowadays by default. +#dotlock_use_excl = yes + +# When to use fsync() or fdatasync() calls: +# optimized (default): Whenever necessary to avoid losing important data +# always: Useful with e.g. NFS when write()s are delayed +# never: Never use it (best performance, but crashes can lose data) +#mail_fsync = optimized + +# Mail storage exists in NFS. Set this to yes to make Dovecot flush NFS caches +# whenever needed. If you're using only a single mail server this isn't needed. +#mail_nfs_storage = no +# Mail index files also exist in NFS. Setting this to yes requires +# mmap_disable=yes and fsync_disable=no. +#mail_nfs_index = no + +# Locking method for index files. Alternatives are fcntl, flock and dotlock. +# Dotlocking uses some tricks which may create more disk I/O than other locking +# methods. NFS users: flock doesn't work, remember to change mmap_disable. +#lock_method = fcntl + +# Directory in which LDA/LMTP temporarily stores incoming mails >128 kB. +#mail_temp_dir = /tmp + +# Valid UID range for users, defaults to 500 and above. This is mostly +# to make sure that users can't log in as daemons or other system users. +# Note that denying root logins is hardcoded to dovecot binary and can't +# be done even if first_valid_uid is set to 0. +#first_valid_uid = 500 +#last_valid_uid = 0 + +# Valid GID range for users, defaults to non-root/wheel. Users having +# non-valid GID as primary group ID aren't allowed to log in. If user +# belongs to supplementary groups with non-valid GIDs, those groups are +# not set. +#first_valid_gid = 1 +#last_valid_gid = 0 + +# Maximum allowed length for mail keyword name. It's only forced when trying +# to create new keywords. +#mail_max_keyword_length = 50 + +# ':' separated list of directories under which chrooting is allowed for mail +# processes (ie. /var/mail will allow chrooting to /var/mail/foo/bar too). +# This setting doesn't affect login_chroot, mail_chroot or auth chroot +# settings. If this setting is empty, "/./" in home dirs are ignored. +# WARNING: Never add directories here which local users can modify, that +# may lead to root exploit. Usually this should be done only if you don't +# allow shell access for users. +#valid_chroot_dirs = + +# Default chroot directory for mail processes. This can be overridden for +# specific users in user database by giving /./ in user's home directory +# (eg. /home/./user chroots into /home). Note that usually there is no real +# need to do chrooting, Dovecot doesn't allow users to access files outside +# their mail directory anyway. If your home directories are prefixed with +# the chroot directory, append "/." to mail_chroot. +#mail_chroot = + +# UNIX socket path to master authentication server to find users. +# This is used by imap (for shared users) and lda. +#auth_socket_path = /var/run/dovecot/auth-userdb + +# Directory where to look up mail plugins. +#mail_plugin_dir = /usr/lib/dovecot/modules + +# Space separated list of plugins to load for all services. Plugins specific to +# IMAP, LDA, etc. are added to this list in their own .conf files. +mail_plugins = quota + +## +## Mailbox handling optimizations +## + +# The minimum number of mails in a mailbox before updates are done to cache +# file. This allows optimizing Dovecot's behavior to do less disk writes at +# the cost of more disk reads. +#mail_cache_min_mail_count = 0 + +# When IDLE command is running, mailbox is checked once in a while to see if +# there are any new mails or other changes. This setting defines the minimum +# time to wait between those checks. Dovecot can also use dnotify, inotify and +# kqueue to find out immediately when changes occur. +#mailbox_idle_check_interval = 30 secs + +# Save mails with CR+LF instead of plain LF. This makes sending those mails +# take less CPU, especially with sendfile() syscall with Linux and FreeBSD. +# But it also creates a bit more disk I/O which may just make it slower. +# Also note that if other software reads the mboxes/maildirs, they may handle +# the extra CRs wrong and cause problems. +#mail_save_crlf = no + +# Max number of mails to keep open and prefetch to memory. This only works with +# some mailbox formats and/or operating systems. +#mail_prefetch_count = 0 + +# How often to scan for stale temporary files and delete them (0 = never). +# These should exist only after Dovecot dies in the middle of saving mails. +#mail_temp_scan_interval = 1w + +## +## Maildir-specific settings +## + +# By default LIST command returns all entries in maildir beginning with a dot. +# Enabling this option makes Dovecot return only entries which are directories. +# This is done by stat()ing each entry, so it causes more disk I/O. +# (For systems setting struct dirent->d_type, this check is free and it's +# done always regardless of this setting) +#maildir_stat_dirs = no + +# When copying a message, do it with hard links whenever possible. This makes +# the performance much better, and it's unlikely to have any side effects. +#maildir_copy_with_hardlinks = yes + +# Assume Dovecot is the only MUA accessing Maildir: Scan cur/ directory only +# when its mtime changes unexpectedly or when we can't find the mail otherwise. +#maildir_very_dirty_syncs = no + +# If enabled, Dovecot doesn't use the S= in the Maildir filenames for +# getting the mail's physical size, except when recalculating Maildir++ quota. +# This can be useful in systems where a lot of the Maildir filenames have a +# broken size. The performance hit for enabling this is very small. +#maildir_broken_filename_sizes = no + +## +## mbox-specific settings +## + +# Which locking methods to use for locking mbox. There are four available: +# dotlock: Create .lock file. This is the oldest and most NFS-safe +# solution. If you want to use /var/mail/ like directory, the users +# will need write access to that directory. +# dotlock_try: Same as dotlock, but if it fails because of permissions or +# because there isn't enough disk space, just skip it. +# fcntl : Use this if possible. Works with NFS too if lockd is used. +# flock : May not exist in all systems. Doesn't work with NFS. +# lockf : May not exist in all systems. Doesn't work with NFS. +# +# You can use multiple locking methods; if you do the order they're declared +# in is important to avoid deadlocks if other MTAs/MUAs are using multiple +# locking methods as well. Some operating systems don't allow using some of +# them simultaneously. +#mbox_read_locks = fcntl +#mbox_write_locks = dotlock fcntl + +# Maximum time to wait for lock (all of them) before aborting. +#mbox_lock_timeout = 5 mins + +# If dotlock exists but the mailbox isn't modified in any way, override the +# lock file after this much time. +#mbox_dotlock_change_timeout = 2 mins + +# When mbox changes unexpectedly we have to fully read it to find out what +# changed. If the mbox is large this can take a long time. Since the change +# is usually just a newly appended mail, it'd be faster to simply read the +# new mails. If this setting is enabled, Dovecot does this but still safely +# fallbacks to re-reading the whole mbox file whenever something in mbox isn't +# how it's expected to be. The only real downside to this setting is that if +# some other MUA changes message flags, Dovecot doesn't notice it immediately. +# Note that a full sync is done with SELECT, EXAMINE, EXPUNGE and CHECK +# commands. +#mbox_dirty_syncs = yes + +# Like mbox_dirty_syncs, but don't do full syncs even with SELECT, EXAMINE, +# EXPUNGE or CHECK commands. If this is set, mbox_dirty_syncs is ignored. +#mbox_very_dirty_syncs = no + +# Delay writing mbox headers until doing a full write sync (EXPUNGE and CHECK +# commands and when closing the mailbox). This is especially useful for POP3 +# where clients often delete all mails. The downside is that our changes +# aren't immediately visible to other MUAs. +#mbox_lazy_writes = yes + +# If mbox size is smaller than this (e.g. 100k), don't write index files. +# If an index file already exists it's still read, just not updated. +#mbox_min_index_size = 0 + +# Mail header selection algorithm to use for MD5 POP3 UIDLs when +# pop3_uidl_format=%m. For backwards compatibility we use apop3d inspired +# algorithm, but it fails if the first Received: header isn't unique in all +# mails. An alternative algorithm is "all" that selects all headers. +#mbox_md5 = apop3d + +## +## mdbox-specific settings +## + +# Maximum dbox file size until it's rotated. +#mdbox_rotate_size = 2M + +# Maximum dbox file age until it's rotated. Typically in days. Day begins +# from midnight, so 1d = today, 2d = yesterday, etc. 0 = check disabled. +#mdbox_rotate_interval = 0 + +# When creating new mdbox files, immediately preallocate their size to +# mdbox_rotate_size. This setting currently works only in Linux with some +# filesystems (ext4, xfs). +#mdbox_preallocate_space = no + +## +## Mail attachments +## + +# sdbox and mdbox support saving mail attachments to external files, which +# also allows single instance storage for them. Other backends don't support +# this for now. + +# WARNING: This feature hasn't been tested much yet. Use at your own risk. + +# Directory root where to store mail attachments. Disabled, if empty. +#mail_attachment_dir = + +# Attachments smaller than this aren't saved externally. It's also possible to +# write a plugin to disable saving specific attachments externally. +#mail_attachment_min_size = 128k + +# Filesystem backend to use for saving attachments: +# posix : No SiS done by Dovecot (but this might help FS's own deduplication) +# sis posix : SiS with immediate byte-by-byte comparison during saving +# sis-queue posix : SiS with delayed comparison and deduplication +#mail_attachment_fs = sis posix + +# Hash format to use in attachment filenames. You can add any text and +# variables: %{md4}, %{md5}, %{sha1}, %{sha256}, %{sha512}, %{size}. +# Variables can be truncated, e.g. %{sha256:80} returns only first 80 bits +#mail_attachment_hash = %{sha1} diff --git a/modoboa_installer/scripts/files/dovecot/conf.d/10-master.conf b/modoboa_installer/scripts/files/dovecot/conf.d/10-master.conf new file mode 100644 index 0000000..4757a4e --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/conf.d/10-master.conf @@ -0,0 +1,127 @@ +#default_process_limit = 100 +#default_client_limit = 1000 + +# Default VSZ (virtual memory size) limit for service processes. This is mainly +# intended to catch and kill processes that leak memory before they eat up +# everything. +#default_vsz_limit = 256M + +# Login user is internally used by login processes. This is the most untrusted +# user in Dovecot system. It shouldn't have access to anything at all. +#default_login_user = dovenull + +# Internal user is used by unprivileged processes. It should be separate from +# login user, so that login processes can't disturb other processes. +#default_internal_user = dovecot + +service imap-login { + inet_listener imap { + #port = 143 + } + inet_listener imaps { + #port = 993 + #ssl = yes + } + + # Number of connections to handle before starting a new process. Typically + # the only useful values are 0 (unlimited) or 1. 1 is more secure, but 0 + # is faster. + #service_count = 1 + + # Number of processes to always keep waiting for more connections. + #process_min_avail = 0 + + # If you set service_count=0, you probably need to grow this. + #vsz_limit = $default_vsz_limit +} + +service pop3-login { + inet_listener pop3 { + #port = 110 + } + inet_listener pop3s { + #port = 995 + #ssl = yes + } +} + +service lmtp { + unix_listener lmtp { + #mode = 0666 + } + + # Create inet listener only if you can't use the above UNIX socket + #inet_listener lmtp { + # Avoid making LMTP visible for the entire internet + #address = + #port = + #} + + unix_listener /var/spool/postfix/private/dovecot-lmtp { + mode = 0600 + user = postfix + group = postfix + } +} + +service imap { + # Most of the memory goes to mmap()ing files. You may need to increase this + # limit if you have huge mailboxes. + #vsz_limit = $default_vsz_limit + + # Max. number of IMAP processes (connections) + #process_limit = 1024 +} + +service pop3 { + # Max. number of POP3 processes (connections) + #process_limit = 1024 +} + +service auth { + # auth_socket_path points to this userdb socket by default. It's typically + # used by dovecot-lda, doveadm, possibly imap process, etc. Users that have + # full permissions to this socket are able to get a list of all usernames and + # get the results of everyone's userdb lookups. + # + # The default 0666 mode allows anyone to connect to the socket, but the + # userdb lookups will succeed only if the userdb returns an "uid" field that + # matches the caller process's UID. Also if caller's uid or gid matches the + # socket's uid or gid the lookup succeeds. Anything else causes a failure. + # + # To give the caller full permissions to lookup all users, set the mode to + # something else than 0666 and Dovecot lets the kernel enforce the + # permissions (e.g. 0777 allows everyone full permissions). + unix_listener auth-userdb { + #mode = 0666 + #user = + #group = + } + + # Postfix smtp-auth + unix_listener /var/spool/postfix/private/auth { + mode = 0666 + user = postfix + group = postfix + } + + # Auth process is run as this user. + #user = $default_internal_user +} + +service auth-worker { + # Auth worker process is run as root by default, so that it can access + # /etc/shadow. If this isn't necessary, the user should be changed to + # $default_internal_user. + #user = root +} + +service dict { + # If dict proxy is used, mail processes should have access to its socket. + # For example: mode=0660, group=vmail and global mail_access_groups=vmail + unix_listener dict { + mode = 0600 + user = vmail + #group = + } +} diff --git a/modoboa_installer/scripts/files/dovecot/conf.d/10-ssl.conf.tpl b/modoboa_installer/scripts/files/dovecot/conf.d/10-ssl.conf.tpl new file mode 100644 index 0000000..a368d5c --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/conf.d/10-ssl.conf.tpl @@ -0,0 +1,50 @@ +## +## SSL settings +## + +# SSL/TLS support: yes, no, required. +#ssl = yes + +# PEM encoded X.509 SSL/TLS certificate and private key. They're opened before +# dropping root privileges, so keep the key file unreadable by anyone but +# root. Included doc/mkcert.sh can be used to easily generate self-signed +# certificate, just make sure to update the domains in dovecot-openssl.cnf +ssl_cert = <%tls_cert_file +ssl_key = <%tls_key_file + +# If key file is password protected, give the password here. Alternatively +# give it when starting dovecot with -p parameter. Since this file is often +# world-readable, you may want to place this setting instead to a different +# root owned 0600 file by using ssl_key_password = + #service_count = 1 + + # Number of processes to always keep waiting for more connections. + #process_min_avail = 0 + + # If you set service_count=0, you probably need to grow this. + #vsz_limit = 64M +} + +service managesieve { + # Max. number of ManageSieve processes (connections) + #process_count = 1024 +} + +# Service configuration + +protocol sieve { + # Maximum ManageSieve command line length in bytes. ManageSieve usually does + # not involve overly long command lines, so this setting will not normally + # need adjustment + #managesieve_max_line_length = 65536 + + # Maximum number of ManageSieve connections allowed for a user from each IP + # address. + # NOTE: The username is compared case-sensitively. + #mail_max_userip_connections = 10 + + # Space separated list of plugins to load (none known to be useful so far). + # Do NOT try to load IMAP plugins here. + #mail_plugins = + + # MANAGESIEVE logout format string: + # %i - total number of bytes read from client + # %o - total number of bytes sent to client + #managesieve_logout_format = bytes=%i/%o + + # To fool ManageSieve clients that are focused on CMU's timesieved you can + # specify the IMPLEMENTATION capability that Dovecot reports to clients. + # For example: 'Cyrus timsieved v2.2.13' + #managesieve_implementation_string = Dovecot Pigeonhole + + # Explicitly specify the SIEVE and NOTIFY capability reported by the server + # before login. If left unassigned these will be reported dynamically + # according to what the Sieve interpreter supports by default (after login + # this may differ depending on the user). + #managesieve_sieve_capability = + #managesieve_notify_capability = + + # The maximum number of compile errors that are returned to the client upon + # script upload or script verification. + #managesieve_max_compile_errors = 5 + + # Refer to 90-sieve.conf for script quota configuration and configuration of + # Sieve execution limits. +} diff --git a/modoboa_installer/scripts/files/dovecot/conf.d/90-quota.conf b/modoboa_installer/scripts/files/dovecot/conf.d/90-quota.conf new file mode 100644 index 0000000..e6c4eff --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/conf.d/90-quota.conf @@ -0,0 +1,75 @@ +## +## Quota configuration. +## + +# Note that you also have to enable quota plugin in mail_plugins setting. +# + +## +## Quota limits +## + +# Quota limits are set using "quota_rule" parameters. To get per-user quota +# limits, you can set/override them by returning "quota_rule" extra field +# from userdb. It's also possible to give mailbox-specific limits, for example +# to give additional 100 MB when saving to Trash: + +plugin { + #quota_rule = *:storage=1G + #quota_rule2 = Trash:storage=+100M +} + +## +## Quota warnings +## + +# You can execute a given command when user exceeds a specified quota limit. +# Each quota root has separate limits. Only the command for the first +# exceeded limit is excecuted, so put the highest limit first. +# The commands are executed via script service by connecting to the named +# UNIX socket (quota-warning below). +# Note that % needs to be escaped as %%, otherwise "% " expands to empty. + +plugin { + #quota_warning = storage=95%% quota-warning 95 %u + #quota_warning2 = storage=80%% quota-warning 80 %u +} + +# Example quota-warning service. The unix listener's permissions should be +# set in a way that mail processes can connect to it. Below example assumes +# that mail processes run as vmail user. If you use mode=0666, all system users +# can generate quota warnings to anyone. +#service quota-warning { +# executable = script /usr/local/bin/quota-warning.sh +# user = dovecot +# unix_listener quota-warning { +# user = vmail +# } +#} + +## +## Quota backends +## + +# Multiple backends are supported: +# dirsize: Find and sum all the files found from mail directory. +# Extremely SLOW with Maildir. It'll eat your CPU and disk I/O. +# dict: Keep quota stored in dictionary (eg. SQL) +# maildir: Maildir++ quota +# fs: Read-only support for filesystem quota + +plugin { + #quota = dirsize:User quota + #quota = maildir:User quota + quota = dict:User quota::proxy::quota + #quota = fs:User quota +} + +# Multiple quota roots are also possible, for example this gives each user +# their own 100MB quota and one shared 1GB quota within the domain: +plugin { + #quota = dict:user::proxy::quota + #quota2 = dict:domain:%d:proxy::quota_domain + #quota_rule = *:storage=102400 + #quota2_rule = *:storage=1048576 +} diff --git a/modoboa_installer/scripts/files/dovecot/conf.d/90-sieve.conf b/modoboa_installer/scripts/files/dovecot/conf.d/90-sieve.conf new file mode 100644 index 0000000..35a9f5d --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/conf.d/90-sieve.conf @@ -0,0 +1,104 @@ +## +## Settings for the Sieve interpreter +## + +# Do not forget to enable the Sieve plugin in 15-lda.conf and 20-lmtp.conf +# by adding it to the respective mail_plugins= settings. + +plugin { + # The path to the user's main active script. If ManageSieve is used, this the + # location of the symbolic link controlled by ManageSieve. + sieve = ~/.dovecot.sieve + + # The default Sieve script when the user has none. This is a path to a global + # sieve script file, which gets executed ONLY if user's private Sieve script + # doesn't exist. Be sure to pre-compile this script manually using the sievec + # command line tool. + # --> See sieve_before fore executing scripts before the user's personal + # script. + #sieve_default = /var/lib/dovecot/sieve/default.sieve + + # Directory for :personal include scripts for the include extension. This + # is also where the ManageSieve service stores the user's scripts. + sieve_dir = ~/sieve + + # Directory for :global include scripts for the include extension. + #sieve_global_dir = + + # Path to a script file or a directory containing script files that need to be + # executed before the user's script. If the path points to a directory, all + # the Sieve scripts contained therein (with the proper .sieve extension) are + # executed. The order of execution within a directory is determined by the + # file names, using a normal 8bit per-character comparison. Multiple script + # file or directory paths can be specified by appending an increasing number. + #sieve_before = + #sieve_before2 = + #sieve_before3 = (etc...) + + # Identical to sieve_before, only the specified scripts are executed after the + # user's script (only when keep is still in effect!). Multiple script file or + # directory paths can be specified by appending an increasing number. + #sieve_after = + #sieve_after2 = + #sieve_after2 = (etc...) + + # Which Sieve language extensions are available to users. By default, all + # supported extensions are available, except for deprecated extensions or + # those that are still under development. Some system administrators may want + # to disable certain Sieve extensions or enable those that are not available + # by default. This setting can use '+' and '-' to specify differences relative + # to the default. For example `sieve_extensions = +imapflags' will enable the + # deprecated imapflags extension in addition to all extensions were already + # enabled by default. + #sieve_extensions = +notify +imapflags + + # Which Sieve language extensions are ONLY available in global scripts. This + # can be used to restrict the use of certain Sieve extensions to administrator + # control, for instance when these extensions can cause security concerns. + # This setting has higher precedence than the `sieve_extensions' setting + # (above), meaning that the extensions enabled with this setting are never + # available to the user's personal script no matter what is specified for the + # `sieve_extensions' setting. The syntax of this setting is similar to the + # `sieve_extensions' setting, with the difference that extensions are + # enabled or disabled for exclusive use in global scripts. Currently, no + # extensions are marked as such by default. + #sieve_global_extensions = + + # The Pigeonhole Sieve interpreter can have plugins of its own. Using this + # setting, the used plugins can be specified. Check the Dovecot wiki + # (wiki2.dovecot.org) or the pigeonhole website + # (http://pigeonhole.dovecot.org) for available plugins. + #sieve_plugins = + + # The separator that is expected between the :user and :detail + # address parts introduced by the subaddress extension. This may + # also be a sequence of characters (e.g. '--'). The current + # implementation looks for the separator from the left of the + # localpart and uses the first one encountered. The :user part is + # left of the separator and the :detail part is right. This setting + # is also used by Dovecot's LMTP service. + #recipient_delimiter = + + + # The maximum size of a Sieve script. The compiler will refuse to compile any + # script larger than this limit. If set to 0, no limit on the script size is + # enforced. + #sieve_max_script_size = 1M + + # The maximum number of actions that can be performed during a single script + # execution. If set to 0, no limit on the total number of actions is enforced. + #sieve_max_actions = 32 + + # The maximum number of redirect actions that can be performed during a single + # script execution. If set to 0, no redirect actions are allowed. + #sieve_max_redirects = 4 + + # The maximum number of personal Sieve scripts a single user can have. If set + # to 0, no limit on the number of scripts is enforced. + # (Currently only relevant for ManageSieve) + #sieve_quota_max_scripts = 0 + + # The maximum amount of disk storage a single user's scripts may occupy. If + # set to 0, no limit on the used amount of disk storage is enforced. + # (Currently only relevant for ManageSieve) + #sieve_quota_max_storage = 0 +} diff --git a/modoboa_installer/scripts/files/dovecot/conf.d/auth-sql.conf.ext b/modoboa_installer/scripts/files/dovecot/conf.d/auth-sql.conf.ext new file mode 100644 index 0000000..9ba585b --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/conf.d/auth-sql.conf.ext @@ -0,0 +1,30 @@ +# Authentication for SQL users. Included from auth.conf. +# +# + +passdb { + driver = sql + + # Path for SQL configuration file, see example-config/dovecot-sql.conf.ext + args = /etc/dovecot/dovecot-sql.conf.ext +} + +# "prefetch" user database means that the passdb already provided the +# needed information and there's no need to do a separate userdb lookup. +# +#userdb { +# driver = prefetch +#} + +userdb { + driver = sql + args = /etc/dovecot/dovecot-sql.conf.ext +} + +# If you don't have any user-specific settings, you can avoid the user_query +# by using userdb static instead of userdb sql, for example: +# +#userdb { + #driver = static + #args = uid=vmail gid=vmail home=/var/vmail/%u +#} diff --git a/modoboa_installer/scripts/files/dovecot/dovecot-dict-sql.conf.ext.tpl b/modoboa_installer/scripts/files/dovecot/dovecot-dict-sql.conf.ext.tpl new file mode 100644 index 0000000..8221655 --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/dovecot-dict-sql.conf.ext.tpl @@ -0,0 +1,39 @@ +connect = host=%dbhost dbname=%modoboa_dbname user=%modoboa_dbuser password=%modoboa_dbpassword + +# CREATE TABLE quota ( +# username varchar(100) not null, +# bytes bigint not null default 0, +# messages integer not null default 0, +# primary key (username) +# ); + +map { + pattern = priv/quota/storage + table = admin_quota + username_field = username + value_field = bytes +} +map { + pattern = priv/quota/messages + table = admin_quota + username_field = username + value_field = messages +} + +# CREATE TABLE expires ( +# username varchar(100) not null, +# mailbox varchar(255) not null, +# expire_stamp integer not null, +# primary key (username, mailbox) +# ); + +map { + pattern = shared/expire/$user/$mailbox + table = expires + value_field = expire_stamp + + fields { + username = $user + mailbox = $mailbox + } +} diff --git a/modoboa_installer/scripts/files/dovecot/dovecot-sql-mysql.conf.ext.tpl b/modoboa_installer/scripts/files/dovecot/dovecot-sql-mysql.conf.ext.tpl new file mode 100644 index 0000000..f370cfd --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/dovecot-sql-mysql.conf.ext.tpl @@ -0,0 +1,140 @@ +# This file is opened as root, so it should be owned by root and mode 0600. +# +# http://wiki2.dovecot.org/AuthDatabase/SQL +# +# For the sql passdb module, you'll need a database with a table that +# contains fields for at least the username and password. If you want to +# use the user@domain syntax, you might want to have a separate domain +# field as well. +# +# If your users all have the same uig/gid, and have predictable home +# directories, you can use the static userdb module to generate the home +# dir based on the username and domain. In this case, you won't need fields +# for home, uid, or gid in the database. +# +# If you prefer to use the sql userdb module, you'll want to add fields +# for home, uid, and gid. Here is an example table: +# +# CREATE TABLE users ( +# username VARCHAR(128) NOT NULL, +# domain VARCHAR(128) NOT NULL, +# password VARCHAR(64) NOT NULL, +# home VARCHAR(255) NOT NULL, +# uid INTEGER NOT NULL, +# gid INTEGER NOT NULL, +# active CHAR(1) DEFAULT 'Y' NOT NULL +# ); + +# Database driver: mysql, pgsql, sqlite +driver = %db_driver + +# Database connection string. This is driver-specific setting. +# +# HA / round-robin load-balancing is supported by giving multiple host +# settings, like: host=sql1.host.org host=sql2.host.org +# +# pgsql: +# For available options, see the PostgreSQL documention for the +# PQconnectdb function of libpq. +# Use maxconns=n (default 5) to change how many connections Dovecot can +# create to pgsql. +# +# mysql: +# Basic options emulate PostgreSQL option names: +# host, port, user, password, dbname +# +# But also adds some new settings: +# client_flags - See MySQL manual +# ssl_ca, ssl_ca_path - Set either one or both to enable SSL +# ssl_cert, ssl_key - For sending client-side certificates to server +# ssl_cipher - Set minimum allowed cipher security (default: HIGH) +# option_file - Read options from the given file instead of +# the default my.cnf location +# option_group - Read options from the given group (default: client) +# +# You can connect to UNIX sockets by using host: host=/var/run/mysql.sock +# Note that currently you can't use spaces in parameters. +# +# sqlite: +# The path to the database file. +# +# Examples: +# connect = host=192.168.1.1 dbname=users +# connect = host=sql.example.com dbname=virtual user=virtual password=blarg +# connect = /etc/dovecot/authdb.sqlite +# +#connect = +connect = host=%dbhost dbname=%modoboa_dbname user=%modoboa_dbuser password=%modoboa_dbpassword + +# Default password scheme. +# +# List of supported schemes is in +# http://wiki2.dovecot.org/Authentication/PasswordSchemes +# +#default_pass_scheme = MD5 + +# passdb query to retrieve the password. It can return fields: +# password - The user's password. This field must be returned. +# user - user@domain from the database. Needed with case-insensitive lookups. +# username and domain - An alternative way to represent the "user" field. +# +# The "user" field is often necessary with case-insensitive lookups to avoid +# e.g. "name" and "nAme" logins creating two different mail directories. If +# your user and domain names are in separate fields, you can return "username" +# and "domain" fields instead of "user". +# +# The query can also return other fields which have a special meaning, see +# http://wiki2.dovecot.org/PasswordDatabase/ExtraFields +# +# Commonly used available substitutions (see http://wiki2.dovecot.org/Variables +# for full list): +# %%u = entire user@domain +# %%n = user part of user@domain +# %%d = domain part of user@domain +# +# Note that these can be used only as input to SQL query. If the query outputs +# any of these substitutions, they're not touched. Otherwise it would be +# difficult to have eg. usernames containing '%%' characters. +# +# Example: +# password_query = SELECT userid AS user, pw AS password \ +# FROM users WHERE userid = '%%u' AND active = 'Y' +# +#password_query = \ +# SELECT username, domain, password \ +# FROM users WHERE username = '%%n' AND domain = '%%d' + +# userdb query to retrieve the user information. It can return fields: +# uid - System UID (overrides mail_uid setting) +# gid - System GID (overrides mail_gid setting) +# home - Home directory +# mail - Mail location (overrides mail_location setting) +# +# None of these are strictly required. If you use a single UID and GID, and +# home or mail directory fits to a template string, you could use userdb static +# instead. For a list of all fields that can be returned, see +# http://wiki2.dovecot.org/UserDatabase/ExtraFields +# +# Examples: +# user_query = SELECT home, uid, gid FROM users WHERE userid = '%%u' +# user_query = SELECT dir AS home, user AS uid, group AS gid FROM users where userid = '%%u' +# user_query = SELECT home, 501 AS uid, 501 AS gid FROM users WHERE userid = '%%u' +# +#user_query = \ +# SELECT home, uid, gid \ +# FROM users WHERE username = '%%n' AND domain = '%%d' +user_query = SELECT '%{home_dir}/%%d/%%n' AS home, %mailboxes_owner_uid as uid, %mailboxes_owner_gid as gid, CONCAT('*:bytes=', mb.quota, 'M') AS quota_rule FROM admin_mailbox mb INNER JOIN admin_domain dom ON mb.domain_id=dom.id WHERE mb.address='%%n' AND dom.name='%%d' + +# If you wish to avoid two SQL lookups (passdb + userdb), you can use +# userdb prefetch instead of userdb sql in dovecot.conf. In that case you'll +# also have to return userdb fields in password_query prefixed with "userdb_" +# string. For example: +#password_query = \ +# SELECT userid AS user, password, \ +# home AS userdb_home, uid AS userdb_uid, gid AS userdb_gid \ +# FROM users WHERE userid = '%%u' +password_query = SELECT email AS user, password FROM core_user WHERE email='%%u' and is_active=1 + +# Query to get a list of all usernames. +#iterate_query = SELECT username AS user FROM users +iterate_query = SELECT email AS username FROM core_user diff --git a/modoboa_installer/scripts/files/dovecot/dovecot-sql-postgres.conf.ext.tpl b/modoboa_installer/scripts/files/dovecot/dovecot-sql-postgres.conf.ext.tpl new file mode 100644 index 0000000..2b4a160 --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/dovecot-sql-postgres.conf.ext.tpl @@ -0,0 +1,140 @@ +# This file is opened as root, so it should be owned by root and mode 0600. +# +# http://wiki2.dovecot.org/AuthDatabase/SQL +# +# For the sql passdb module, you'll need a database with a table that +# contains fields for at least the username and password. If you want to +# use the user@domain syntax, you might want to have a separate domain +# field as well. +# +# If your users all have the same uig/gid, and have predictable home +# directories, you can use the static userdb module to generate the home +# dir based on the username and domain. In this case, you won't need fields +# for home, uid, or gid in the database. +# +# If you prefer to use the sql userdb module, you'll want to add fields +# for home, uid, and gid. Here is an example table: +# +# CREATE TABLE users ( +# username VARCHAR(128) NOT NULL, +# domain VARCHAR(128) NOT NULL, +# password VARCHAR(64) NOT NULL, +# home VARCHAR(255) NOT NULL, +# uid INTEGER NOT NULL, +# gid INTEGER NOT NULL, +# active CHAR(1) DEFAULT 'Y' NOT NULL +# ); + +# Database driver: mysql, pgsql, sqlite +driver = %db_driver + +# Database connection string. This is driver-specific setting. +# +# HA / round-robin load-balancing is supported by giving multiple host +# settings, like: host=sql1.host.org host=sql2.host.org +# +# pgsql: +# For available options, see the PostgreSQL documention for the +# PQconnectdb function of libpq. +# Use maxconns=n (default 5) to change how many connections Dovecot can +# create to pgsql. +# +# mysql: +# Basic options emulate PostgreSQL option names: +# host, port, user, password, dbname +# +# But also adds some new settings: +# client_flags - See MySQL manual +# ssl_ca, ssl_ca_path - Set either one or both to enable SSL +# ssl_cert, ssl_key - For sending client-side certificates to server +# ssl_cipher - Set minimum allowed cipher security (default: HIGH) +# option_file - Read options from the given file instead of +# the default my.cnf location +# option_group - Read options from the given group (default: client) +# +# You can connect to UNIX sockets by using host: host=/var/run/mysql.sock +# Note that currently you can't use spaces in parameters. +# +# sqlite: +# The path to the database file. +# +# Examples: +# connect = host=192.168.1.1 dbname=users +# connect = host=sql.example.com dbname=virtual user=virtual password=blarg +# connect = /etc/dovecot/authdb.sqlite +# +#connect = +connect = host=%dbhost dbname=%modoboa_dbname user=%modoboa_dbuser password=%modoboa_dbpassword + +# Default password scheme. +# +# List of supported schemes is in +# http://wiki2.dovecot.org/Authentication/PasswordSchemes +# +#default_pass_scheme = MD5 + +# passdb query to retrieve the password. It can return fields: +# password - The user's password. This field must be returned. +# user - user@domain from the database. Needed with case-insensitive lookups. +# username and domain - An alternative way to represent the "user" field. +# +# The "user" field is often necessary with case-insensitive lookups to avoid +# e.g. "name" and "nAme" logins creating two different mail directories. If +# your user and domain names are in separate fields, you can return "username" +# and "domain" fields instead of "user". +# +# The query can also return other fields which have a special meaning, see +# http://wiki2.dovecot.org/PasswordDatabase/ExtraFields +# +# Commonly used available substitutions (see http://wiki2.dovecot.org/Variables +# for full list): +# %%u = entire user@domain +# %%n = user part of user@domain +# %%d = domain part of user@domain +# +# Note that these can be used only as input to SQL query. If the query outputs +# any of these substitutions, they're not touched. Otherwise it would be +# difficult to have eg. usernames containing '%%' characters. +# +# Example: +# password_query = SELECT userid AS user, pw AS password \ +# FROM users WHERE userid = '%%u' AND active = 'Y' +# +#password_query = \ +# SELECT username, domain, password \ +# FROM users WHERE username = '%%n' AND domain = '%%d' + +# userdb query to retrieve the user information. It can return fields: +# uid - System UID (overrides mail_uid setting) +# gid - System GID (overrides mail_gid setting) +# home - Home directory +# mail - Mail location (overrides mail_location setting) +# +# None of these are strictly required. If you use a single UID and GID, and +# home or mail directory fits to a template string, you could use userdb static +# instead. For a list of all fields that can be returned, see +# http://wiki2.dovecot.org/UserDatabase/ExtraFields +# +# Examples: +# user_query = SELECT home, uid, gid FROM users WHERE userid = '%%u' +# user_query = SELECT dir AS home, user AS uid, group AS gid FROM users where userid = '%%u' +# user_query = SELECT home, 501 AS uid, 501 AS gid FROM users WHERE userid = '%%u' +# +#user_query = \ +# SELECT home, uid, gid \ +# FROM users WHERE username = '%%n' AND domain = '%%d' +user_query = SELECT '%{home_dir}/%%d/%%n' AS home, %mailboxes_owner_uid as uid, %mailboxes_owner_gid as gid, '*:bytes=' || mb.quota || 'M' AS quota_rule FROM admin_mailbox mb INNER JOIN admin_domain dom ON mb.domain_id=dom.id WHERE mb.address='%%n' AND dom.name='%%d' + +# If you wish to avoid two SQL lookups (passdb + userdb), you can use +# userdb prefetch instead of userdb sql in dovecot.conf. In that case you'll +# also have to return userdb fields in password_query prefixed with "userdb_" +# string. For example: +#password_query = \ +# SELECT userid AS user, password, \ +# home AS userdb_home, uid AS userdb_uid, gid AS userdb_gid \ +# FROM users WHERE userid = '%%u' +password_query = SELECT email AS user, password FROM core_user WHERE email='%%u' and is_active + +# Query to get a list of all usernames. +#iterate_query = SELECT username AS user FROM users +iterate_query = SELECT email AS username FROM core_user diff --git a/modoboa_installer/scripts/files/dovecot/dovecot.conf.tpl b/modoboa_installer/scripts/files/dovecot/dovecot.conf.tpl new file mode 100644 index 0000000..84b37bf --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/dovecot.conf.tpl @@ -0,0 +1,98 @@ +## Dovecot configuration file + +# If you're in a hurry, see http://wiki2.dovecot.org/QuickConfiguration + +# "doveconf -n" command gives a clean output of the changed settings. Use it +# instead of copy&pasting files when posting to the Dovecot mailing list. + +# '#' character and everything after it is treated as comments. Extra spaces +# and tabs are ignored. If you want to use either of these explicitly, put the +# value inside quotes, eg.: key = "# char and trailing whitespace " + +# Default values are shown for each setting, it's not required to uncomment +# those. These are exceptions to this though: No sections (e.g. namespace {}) +# or plugin settings are added by default, they're listed only as examples. +# Paths are also just examples with the real defaults being based on configure +# options. The paths listed here are for configure --prefix=/usr +# --sysconfdir=/etc --localstatedir=/var + +# Enable installed protocols +!include_try /usr/share/dovecot/protocols.d/*.protocol + +# A comma separated list of IPs or hosts where to listen in for connections. +# "*" listens in all IPv4 interfaces, "::" listens in all IPv6 interfaces. +# If you want to specify non-default ports or anything more complex, +# edit conf.d/master.conf. +#listen = *, :: + +# Base directory where to store runtime data. +#base_dir = /var/run/dovecot/ + +# Name of this instance. In multi-instance setup doveadm and other commands +# can use -i to select which instance is used (an alternative +# to -c ). The instance name is also added to Dovecot processes +# in ps output. +#instance_name = dovecot + +# Greeting message for clients. +#login_greeting = Dovecot ready. + +# Space separated list of trusted network ranges. Connections from these +# IPs are allowed to override their IP addresses and ports (for logging and +# for authentication checks). disable_plaintext_auth is also ignored for +# these networks. Typically you'd specify your IMAP proxy servers here. +#login_trusted_networks = + +# Sepace separated list of login access check sockets (e.g. tcpwrap) +#login_access_sockets = + +# With proxy_maybe=yes if proxy destination matches any of these IPs, don't do +# proxying. This isn't necessary normally, but may be useful if the destination +# IP is e.g. a load balancer's IP. +#auth_proxy_self = + +# Show more verbose process titles (in ps). Currently shows user name and +# IP address. Useful for seeing who are actually using the IMAP processes +# (eg. shared mailboxes or if same uid is used for multiple accounts). +#verbose_proctitle = no + +# Should all processes be killed when Dovecot master process shuts down. +# Setting this to "no" means that Dovecot can be upgraded without +# forcing existing client connections to close (although that could also be +# a problem if the upgrade is e.g. because of a security fix). +#shutdown_clients = yes + +# If non-zero, run mail commands via this many connections to doveadm server, +# instead of running them directly in the same process. +#doveadm_worker_count = 0 +# UNIX socket or host:port used for connecting to doveadm server +#doveadm_socket_path = doveadm-server + +# Space separated list of environment variables that are preserved on Dovecot +# startup and passed down to all of its child processes. You can also give +# key=value pairs to always set specific settings. +#import_environment = TZ + +## +## Dictionary server settings +## + +# Dictionary can be used to store key=value lists. This is used by several +# plugins. The dictionary can be accessed either directly or though a +# dictionary server. The following dict block maps dictionary names to URIs +# when the server is used. These can then be referenced using URIs in format +# "proxy::". + +dict { + quota = %{db_driver}:/etc/dovecot/dovecot-dict-sql.conf.ext + #expire = sqlite:/etc/dovecot/dovecot-dict-sql.conf.ext +} + +# Most of the actual configuration gets included below. The filenames are +# first sorted by their ASCII value and parsed in that order. The 00-prefixes +# in filenames are intended to make it easier to understand the ordering. +!include conf.d/*.conf + +# A config file can also tried to be included without giving an error if +# it's not found: +!include_try local.conf diff --git a/modoboa_installer/scripts/files/dovecot/fix_modoboa_postgres_schema.sql b/modoboa_installer/scripts/files/dovecot/fix_modoboa_postgres_schema.sql new file mode 100644 index 0000000..8a83eb7 --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/fix_modoboa_postgres_schema.sql @@ -0,0 +1,2 @@ +ALTER TABLE admin_quota ALTER COLUMN bytes SET DEFAULT 0; +ALTER TABLE admin_quota ALTER COLUMN messages SET DEFAULT 0; diff --git a/modoboa_installer/scripts/files/dovecot/install_modoboa_postgres_trigger.sql b/modoboa_installer/scripts/files/dovecot/install_modoboa_postgres_trigger.sql new file mode 100644 index 0000000..d5d7eb6 --- /dev/null +++ b/modoboa_installer/scripts/files/dovecot/install_modoboa_postgres_trigger.sql @@ -0,0 +1,37 @@ +CREATE OR REPLACE FUNCTION merge_quota() RETURNS TRIGGER AS $$ +BEGIN + IF NEW.messages < 0 OR NEW.messages IS NULL THEN + -- ugly kludge: we came here from this function, really do try to insert + IF NEW.messages IS NULL THEN + NEW.messages = 0; + ELSE + NEW.messages = -NEW.messages; + END IF; + return NEW; + END IF; + + LOOP + UPDATE admin_quota SET bytes = bytes + NEW.bytes, + messages = messages + NEW.messages + WHERE username = NEW.username; + IF found THEN + RETURN NULL; + END IF; + + BEGIN + IF NEW.messages = 0 THEN + RETURN NEW; + ELSE + NEW.messages = - NEW.messages; + return NEW; + END IF; + EXCEPTION WHEN unique_violation THEN + -- someone just inserted the record, update it + END; + END LOOP; +END; +$$ LANGUAGE plpgsql; + +DROP TRIGGER IF EXISTS mergequota ON admin_quota; +CREATE TRIGGER mergequota BEFORE INSERT ON admin_quota + FOR EACH ROW EXECUTE PROCEDURE merge_quota(); diff --git a/modoboa_installer/scripts/files/nginx/nginx.conf.tpl b/modoboa_installer/scripts/files/nginx/nginx.conf.tpl new file mode 100644 index 0000000..18d9703 --- /dev/null +++ b/modoboa_installer/scripts/files/nginx/nginx.conf.tpl @@ -0,0 +1,41 @@ +upstream modoboa { + server unix:%uwsgi_socket_path fail_timeout=0; +} + +server { + listen 80; + server_name %hostname; + rewrite ^ https://$server_name$request_uri? permanent; +} + +server { + listen 443 ssl; + server_name %hostname; + root %modoboa_instance_path; + + ssl_certificate %tls_cert_file; + ssl_certificate_key %tls_key_file; + ssl_protocols TLSv1 TLSv1.1 TLSv1.2; + ssl_ciphers RC4:HIGH:!aNULL:!MD5; + ssl_prefer_server_ciphers on; + ssl_verify_depth 3; + + client_max_body_size 10M; + + access_log /var/log/nginx/%{hostname}-access.log; + error_log /var/log/nginx/%{hostname}-error.log; + + location /sitestatic/ { + autoindex on; + } + + location /media/ { + autoindex on; + } + + location / { + include uwsgi_params; + uwsgi_param UWSGI_SCRIPT instance.wsgi:application; + uwsgi_pass modoboa; + } +} \ No newline at end of file diff --git a/modoboa_installer/scripts/files/postfix/main.cf.tpl b/modoboa_installer/scripts/files/postfix/main.cf.tpl new file mode 100644 index 0000000..5420598 --- /dev/null +++ b/modoboa_installer/scripts/files/postfix/main.cf.tpl @@ -0,0 +1,127 @@ +inet_interfaces = all +inet_protocols = ipv4 +myhostname = %hostname +myorigin = $myhostname +mydestination = +mynetworks = 127.0.0.0/8 [::ffff:127.0.0.0]/104 [::1]/128 +smtpd_banner = $myhostname ESMTP +biff = no +unknown_local_recipient_reject_code = 550 +unverified_recipient_reject_code = 550 + +# appending .domain is the MUA's job. +append_dot_mydomain = no + +# Uncomment the next line to generate "delayed mail" warnings +#delay_warning_time = 4h + +readme_directory = no + +mailbox_size_limit = 0 +message_size_limit = %message_size_limit +recipient_delimiter = + + +alias_maps = hash:/etc/aliases +alias_database = hash:/etc/aliases + +## TLS settings +# +smtpd_use_tls = yes +smtpd_tls_auth_only = no +smtpd_tls_key_file = %tls_key_file +smtpd_tls_cert_file = %tls_cert_file +smtpd_tls_loglevel = 1 +smtpd_tls_session_cache_database = btree:$data_directory/smtpd_tls_session_cache +smtpd_tls_security_level = may +smtpd_tls_received_header = yes + +## Virtual transport settings +# +%{dovecot_enabled}virtual_transport = lmtp:unix:private/dovecot-lmtp + +virtual_mailbox_domains = %{db_driver}:/etc/postfix/sql-domains.cf +virtual_alias_domains = %{db_driver}:/etc/postfix/sql-domain-aliases.cf +virtual_alias_maps = + %{db_driver}:/etc/postfix/sql-aliases.cf + %{db_driver}:/etc/postfix/sql-domain-aliases-mailboxes.cf + %{db_driver}:/etc/postfix/sql-autoreplies.cf + %{db_driver}:/etc/postfix/sql-mailboxes-self-aliases.cf + %{db_driver}:/etc/postfix/sql-catchall-aliases.cf + +## Relay domains +# +relay_domains = + %{db_driver}:/etc/postfix/sql-relaydomains.cf +transport_maps = + %{db_driver}:/etc/postfix/sql-relaydomains-transport.cf + %{db_driver}:/etc/postfix/sql-relaydomain-aliases-transport.cf + %{db_driver}:/etc/postfix/sql-autoreplies-transport.cf + +## SASL authentication through Dovecot +# +%{dovecot_enabled}smtpd_sasl_type = dovecot +%{dovecot_enabled}smtpd_sasl_path = private/auth +%{dovecot_enabled}smtpd_sasl_auth_enable = yes +%{dovecot_enabled}broken_sasl_auth_clients = yes +%{dovecot_enabled}smtpd_sasl_security_options = noanonymous + +## SMTP session policies +# + +# We require HELO to check it later +smtpd_helo_required = yes + +# We do not let others find out which recipients are valid +disable_vrfy_command = yes + +# MTA to MTA communication on Port 25. We expect (!) the other party to +# specify messages as required by RFC 821. +strict_rfc821_envelopes = yes + +# Verify cache setup +%{dovecot_enabled}address_verify_map = proxy:btree:$data_directory/verify_cache + +%{dovecot_enabled}proxy_write_maps = +%{dovecot_enabled} $smtp_sasl_auth_cache_name +%{dovecot_enabled} $lmtp_sasl_auth_cache_name +%{dovecot_enabled} $address_verify_map + +# Recipient restriction rules +smtpd_recipient_restrictions = + permit_mynetworks + permit_sasl_authenticated + check_recipient_access + %{db_driver}:/etc/postfix/sql-maintain.cf + %{db_driver}:/etc/postfix/sql-relay-recipient-verification.cf + reject_unverified_recipient + reject_unauth_destination + reject_non_fqdn_sender + reject_non_fqdn_recipient + reject_non_fqdn_helo_hostname + +## Postcreen settings +# +postscreen_access_list = + permit_mynetworks +postscreen_blacklist_action = enforce + +postscreen_dnsbl_sites = + zen.spamhaus.org*3 + bl.spameatingmonkey.net*2 + dnsbl.habl.org + bl.spamcop.net + dnsbl.sorbs.net +postscreen_dnsbl_threshold = 3 +postscreen_dnsbl_action = enforce + +postscreen_greet_banner = Welcome, please wait... +postscreen_greet_action = enforce + +postscreen_pipelining_enable = yes +postscreen_pipelining_action = enforce + +postscreen_non_smtp_command_enable = yes +postscreen_non_smtp_command_action = enforce + +postscreen_bare_newline_enable = yes +postscreen_bare_newline_action = enforce diff --git a/modoboa_installer/scripts/files/postfix/master.cf.tpl b/modoboa_installer/scripts/files/postfix/master.cf.tpl new file mode 100644 index 0000000..281bc93 --- /dev/null +++ b/modoboa_installer/scripts/files/postfix/master.cf.tpl @@ -0,0 +1,152 @@ +# +# Postfix master process configuration file. For details on the format +# of the file, see the master(5) manual page (command: "man 5 master" or +# on-line: http://www.postfix.org/master.5.html). +# +# Do not forget to execute "postfix reload" after editing this file. +# +# ========================================================================== +# service type private unpriv chroot wakeup maxproc command + args +# (yes) (yes) (yes) (never) (100) +# ========================================================================== +smtp inet n - - - 1 postscreen +smtpd pass - - - - - smtpd +%{amavis_enabled} -o smtpd_proxy_filter=inet:[127.0.0.1]:10024 +%{amavis_enabled} -o smtpd_proxy_options=speed_adjust +dnsblog unix - - - - 0 dnsblog + +#tlsproxy unix - - - - 0 tlsproxy +submission inet n - - - - smtpd + -o syslog_name=postfix/submission + -o smtpd_tls_security_level=encrypt + -o smtpd_sasl_auth_enable=yes + -o smtpd_reject_unlisted_recipient=no + -o smtpd_client_restrictions=permit_sasl_authenticated,reject + -o smtpd_helo_restrictions= + -o smtpd_sender_restrictions= + -o smtpd_recipient_restrictions= + -o milter_macro_daemon_name=ORIGINATING + -o smtpd_proxy_filter=inet:[127.0.0.1]:10026 +#smtps inet n - - - - smtpd +# -o syslog_name=postfix/smtps +# -o smtpd_tls_wrappermode=yes +# -o smtpd_sasl_auth_enable=yes +# -o smtpd_reject_unlisted_recipient=no +# -o smtpd_client_restrictions=$mua_client_restrictions +# -o smtpd_helo_restrictions=$mua_helo_restrictions +# -o smtpd_sender_restrictions=$mua_sender_restrictions +# -o smtpd_recipient_restrictions= +# -o smtpd_relay_restrictions=permit_sasl_authenticated,reject +# -o milter_macro_daemon_name=ORIGINATING +#628 inet n - - - - qmqpd +pickup unix n - - 60 1 pickup +cleanup unix n - - - 0 cleanup +qmgr unix n - n 300 1 qmgr +#qmgr unix n - n 300 1 oqmgr +tlsmgr unix - - - 1000? 1 tlsmgr +rewrite unix - - - - - trivial-rewrite +bounce unix - - - - 0 bounce +defer unix - - - - 0 bounce +trace unix - - - - 0 bounce +verify unix - - - - 1 verify +flush unix n - - 1000? 0 flush +proxymap unix - - n - - proxymap +proxywrite unix - - n - 1 proxymap +smtp unix - - - - - smtp +relay unix - - - - - smtp +# -o smtp_helo_timeout=5 -o smtp_connect_timeout=5 +showq unix n - - - - showq +error unix - - - - - error +retry unix - - - - - error +discard unix - - - - - discard +local unix - n n - - local +virtual unix - n n - - virtual +lmtp unix - - - - - lmtp +anvil unix - - - - 1 anvil +scache unix - - - - 1 scache +# +# ==================================================================== +# Interfaces to non-Postfix software. Be sure to examine the manual +# pages of the non-Postfix software to find out what options it wants. +# +# Many of the following services use the Postfix pipe(8) delivery +# agent. See the pipe(8) man page for information about ${recipient} +# and other message envelope options. +# ==================================================================== +# +# maildrop. See the Postfix MAILDROP_README file for details. +# Also specify in main.cf: maildrop_destination_recipient_limit=1 +# +maildrop unix - n n - - pipe + flags=DRhu user=vmail argv=/usr/bin/maildrop -d ${recipient} +# +# ==================================================================== +# +# Recent Cyrus versions can use the existing "lmtp" master.cf entry. +# +# Specify in cyrus.conf: +# lmtp cmd="lmtpd -a" listen="localhost:lmtp" proto=tcp4 +# +# Specify in main.cf one or more of the following: +# mailbox_transport = lmtp:inet:localhost +# virtual_transport = lmtp:inet:localhost +# +# ==================================================================== +# +# Cyrus 2.1.5 (Amos Gouaux) +# Also specify in main.cf: cyrus_destination_recipient_limit=1 +# +#cyrus unix - n n - - pipe +# user=cyrus argv=/cyrus/bin/deliver -e -r ${sender} -m ${extension} ${user} +# +# ==================================================================== +# Old example of delivery via Cyrus. +# +#old-cyrus unix - n n - - pipe +# flags=R user=cyrus argv=/cyrus/bin/deliver -e -m ${extension} ${user} +# +# ==================================================================== +# +# See the Postfix UUCP_README file for configuration details. +# +uucp unix - n n - - pipe + flags=Fqhu user=uucp argv=uux -r -n -z -a$sender - $nexthop!rmail ($recipient) +# +# Other external delivery methods. +# +ifmail unix - n n - - pipe + flags=F user=ftn argv=/usr/lib/ifmail/ifmail -r $nexthop ($recipient) +bsmtp unix - n n - - pipe + flags=Fq. user=bsmtp argv=/usr/lib/bsmtp/bsmtp -t$nexthop -f$sender $recipient +scalemail-backend unix - n n - 2 pipe + flags=R user=scalemail argv=/usr/lib/scalemail/bin/scalemail-store ${nexthop} ${user} ${extension} +mailman unix - n n - - pipe + flags=FR user=list argv=/usr/lib/mailman/bin/postfix-to-mailman.py + ${nexthop} ${user} + +# Modoboa autoreply service +# +autoreply unix - n n - - pipe + flags= user=%{dovecot_mailboxes_owner}:%{dovecot_mailboxes_owner} argv=%{modoboa_venv_path}/bin/python %{modoboa_instance_path}/manage.py autoreply $sender $mailbox + +# Amavis return path +# +%{amavis_enabled}127.0.0.1:10025 inet n - n - - smtpd +%{amavis_enabled} -o content_filter= +%{amavis_enabled} -o smtpd_authorized_xforward_hosts=127.0.0.0/8 +%{amavis_enabled} -o smtpd_delay_reject=no +%{amavis_enabled} -o smtpd_client_restrictions=permit_mynetworks,reject +%{amavis_enabled} -o smtpd_helo_restrictions= +%{amavis_enabled} -o smtpd_sender_restrictions= +%{amavis_enabled} -o smtpd_recipient_restrictions=permit_mynetworks,reject +%{amavis_enabled} -o smtpd_data_restrictions=reject_unauth_pipelining +%{amavis_enabled} -o smtpd_end_of_data_restrictions= +%{amavis_enabled} -o smtpd_restriction_classes= +%{amavis_enabled} -o mynetworks=127.0.0.0/8 +%{amavis_enabled} -o smtpd_error_sleep_time=0 +%{amavis_enabled} -o smtpd_soft_error_limit=1001 +%{amavis_enabled} -o smtpd_hard_error_limit=1000 +%{amavis_enabled} -o smtpd_client_connection_count_limit=0 +%{amavis_enabled} -o smtpd_client_connection_rate_limit=0 +%{amavis_enabled} -o receive_override_options=no_header_body_checks,no_unknown_recipient_checks +%{amavis_enabled} -o local_header_rewrite_clients= diff --git a/modoboa_installer/scripts/files/spamassassin/local.cf.tpl b/modoboa_installer/scripts/files/spamassassin/local.cf.tpl new file mode 100644 index 0000000..c673cb2 --- /dev/null +++ b/modoboa_installer/scripts/files/spamassassin/local.cf.tpl @@ -0,0 +1,99 @@ +# This is the right place to customize your installation of SpamAssassin. +# +# See 'perldoc Mail::SpamAssassin::Conf' for details of what can be +# tweaked. +# +# Only a small subset of options are listed below +# +########################################################################### + +# Add *****SPAM***** to the Subject header of spam e-mails +# +# rewrite_header Subject *****SPAM***** + + +# Save spam messages as a message/rfc822 MIME attachment instead of +# modifying the original message (0: off, 2: use text/plain instead) +# +# report_safe 1 + + +# Set which networks or hosts are considered 'trusted' by your mail +# server (i.e. not spammers) +# +# trusted_networks 212.17.35. + + +# Set file-locking method (flock is not safe over NFS, but is faster) +# +# lock_method flock + + +# Set the threshold at which a message is considered spam (default: 5.0) +# +# required_score 5.0 + + +# Use Bayesian classifier (default: 1) +# +# use_bayes 1 + + +# Bayesian classifier auto-learning (default: 1) +# +# bayes_auto_learn 1 + +bayes_store_module %store_module +bayes_sql_dsn %dsn +bayes_sql_username %dbname +bayes_sql_password %dbpassword + +# Set headers which may provide inappropriate cues to the Bayesian +# classifier +# +# bayes_ignore_header X-Bogosity +# bayes_ignore_header X-Spam-Flag +# bayes_ignore_header X-Spam-Status + + +# Some shortcircuiting, if the plugin is enabled +# +ifplugin Mail::SpamAssassin::Plugin::Shortcircuit +# +# default: strongly-whitelisted mails are *really* whitelisted now, if the +# shortcircuiting plugin is active, causing early exit to save CPU load. +# Uncomment to turn this on +# +# shortcircuit USER_IN_WHITELIST on +# shortcircuit USER_IN_DEF_WHITELIST on +# shortcircuit USER_IN_ALL_SPAM_TO on +# shortcircuit SUBJECT_IN_WHITELIST on + +# the opposite; blacklisted mails can also save CPU +# +# shortcircuit USER_IN_BLACKLIST on +# shortcircuit USER_IN_BLACKLIST_TO on +# shortcircuit SUBJECT_IN_BLACKLIST on + +# if you have taken the time to correctly specify your "trusted_networks", +# this is another good way to save CPU +# +# shortcircuit ALL_TRUSTED on + +# and a well-trained bayes DB can save running rules, too +# +# shortcircuit BAYES_99 spam +# shortcircuit BAYES_00 ham + +endif # Mail::SpamAssassin::Plugin::Shortcircuit + +# Razor +use_razor2 1 +razor_config /etc/razor/razor-agent.conf + +# Pyzor +use_pyzor 1 +pyzor_path /usr/bin/pyzor + +# DCC +%{dcc_enabled}use_dcc 1 diff --git a/modoboa_installer/scripts/files/spamassassin/v310.pre.tpl b/modoboa_installer/scripts/files/spamassassin/v310.pre.tpl new file mode 100644 index 0000000..9f0efef --- /dev/null +++ b/modoboa_installer/scripts/files/spamassassin/v310.pre.tpl @@ -0,0 +1,81 @@ +# This is the right place to customize your installation of SpamAssassin. +# +# See 'perldoc Mail::SpamAssassin::Conf' for details of what can be +# tweaked. +# +# This file was installed during the installation of SpamAssassin 3.1.0, +# and contains plugin loading commands for the new plugins added in that +# release. It will not be overwritten during future SpamAssassin installs, +# so you can modify it to enable some disabled-by-default plugins below, +# if you so wish. +# +# There are now multiple files read to enable plugins in the +# /etc/mail/spamassassin directory; previously only one, "init.pre" was +# read. Now both "init.pre", "v310.pre", and any other files ending in +# ".pre" will be read. As future releases are made, new plugins will be +# added to new files, named according to the release they're added in. +########################################################################### + +# DCC - perform DCC message checks. +# +# DCC is disabled here because it is not open source. See the DCC +# license for more details. +# +%{dcc_enabled}loadplugin Mail::SpamAssassin::Plugin::DCC + +# Pyzor - perform Pyzor message checks. +# +loadplugin Mail::SpamAssassin::Plugin::Pyzor + +# Razor2 - perform Razor2 message checks. +# +loadplugin Mail::SpamAssassin::Plugin::Razor2 + +# SpamCop - perform SpamCop message reporting +# +loadplugin Mail::SpamAssassin::Plugin::SpamCop + +# AntiVirus - some simple anti-virus checks, this is not a replacement +# for an anti-virus filter like Clam AntiVirus +# +#loadplugin Mail::SpamAssassin::Plugin::AntiVirus + +# AWL - do auto-whitelist checks +# +#loadplugin Mail::SpamAssassin::Plugin::AWL + +# AutoLearnThreshold - threshold-based discriminator for Bayes auto-learning +# +loadplugin Mail::SpamAssassin::Plugin::AutoLearnThreshold + +# TextCat - language guesser +# +#loadplugin Mail::SpamAssassin::Plugin::TextCat + +# AccessDB - lookup from-addresses in access database +# +#loadplugin Mail::SpamAssassin::Plugin::AccessDB + +# WhitelistSubject - Whitelist/Blacklist certain subject regular expressions +# +loadplugin Mail::SpamAssassin::Plugin::WhiteListSubject + +########################################################################### +# experimental plugins + +# DomainKeys - perform DomainKeys verification +# +# This plugin has been removed as of v3.3.0. Use the DKIM plugin instead, +# which supports both Domain Keys and DKIM. + +# MIMEHeader - apply regexp rules against MIME headers in the message +# +loadplugin Mail::SpamAssassin::Plugin::MIMEHeader + +# ReplaceTags +# +loadplugin Mail::SpamAssassin::Plugin::ReplaceTags + +# DCC - perform DCC message checks. +# +loadplugin Mail::SpamAssassin::Plugin::DCC diff --git a/modoboa_installer/scripts/files/uwsgi/uwsgi.ini.tpl b/modoboa_installer/scripts/files/uwsgi/uwsgi.ini.tpl new file mode 100644 index 0000000..1d26124 --- /dev/null +++ b/modoboa_installer/scripts/files/uwsgi/uwsgi.ini.tpl @@ -0,0 +1,12 @@ +[uwsgi] +uid = %modoboa_user +gid = %modoboa_user +plugins = python +home = %modoboa_venv_path +chdir = %modoboa_instance_path +module = instance.wsgi:application +master = true +harakiri = 60 +processes = %nb_processes +vhost = true +no-default-app = true \ No newline at end of file diff --git a/modoboa_installer/scripts/modoboa.py b/modoboa_installer/scripts/modoboa.py new file mode 100644 index 0000000..cff7f95 --- /dev/null +++ b/modoboa_installer/scripts/modoboa.py @@ -0,0 +1,77 @@ +"""Modoboa related tasks.""" + +import os + +from .. import database +from .. import python +from .. import utils + +from . import base +from . import install + + +class Modoboa(base.Installer): + + """Modoboa installation.""" + + appname = "modoboa" + no_daemon = True + packages = ["python-dev"] + with_db = True + with_user = True + + def __init__(self, config): + """Get configuration.""" + super(Modoboa, self).__init__(config) + self.venv_path = config.get("modoboa", "venv_path") + + def setup_database(self): + """Additional config.""" + super(Modoboa, self).setup_database() + if self.config.getboolean("amavis", "enabled"): + database.grant_database_access( + self.config, self.config.get("amavis", "dbname"), self.dbname) + + def _setup_venv(self): + """Prepare a dedicated virtuelenv.""" + python.setup_virtualenv(self.venv_path, sudo_user=self.user) + packages = ["modoboa"] + if self.dbengine == "postgres": + packages.append("psycopg2") + else: + packages.append("MYSQL-Python") + python.install_packages(packages, self.venv_path, sudo_user=self.user) + + def _deploy_instance(self): + """Deploy Modoboa.""" + prefix = ". {}; ".format( + os.path.join(self.venv_path, "bin", "activate")) + args = [ + "--collectstatic", + "--timezone", self.config.get("modoboa", "timezone"), + "--domain", self.config.get("general", "hostname"), + "--extensions", "all", + "--dburl", "default:{0}://{1}:{2}@localhost/{1}".format( + self.config.get("database", "engine"), self.dbname, + self.dbpasswd) + ] + if self.config.getboolean("amavis", "enabled"): + args += [ + "amavis:{}://{}:{}@localhost/{}".format( + self.config.get("database", "engine"), + self.user, self.dbpasswd, + self.config.get("amavis", "dbname") + ) + ] + + utils.exec_cmd( + "bash -c '{} modoboa-admin.py deploy instance {}'".format( + prefix, " ".join(args)), + sudo_user=self.user, cwd=self.home_dir) + + def post_run(self): + """Additional tasks.""" + self._setup_venv() + self._deploy_instance() + install("uwsgi", self.config) + install("nginx", self.config) diff --git a/modoboa_installer/scripts/nginx.py b/modoboa_installer/scripts/nginx.py new file mode 100644 index 0000000..9458502 --- /dev/null +++ b/modoboa_installer/scripts/nginx.py @@ -0,0 +1,39 @@ +"""Nginx related tools.""" + +import os + +from .. import utils + +from . import base + + +class Nginx(base.Installer): + + """Nginx installer.""" + + appname = "nginx" + packages = ["nginx", "ssl-cert"] + + def get_template_context(self): + """Additionnal variables.""" + context = super(Nginx, self).get_template_context() + context.update({ + "modoboa_instance_path": ( + self.config.get("modoboa", "instance_path")), + "uwsgi_socket_path": self.config.get("uwsgi", "socket_path") + }) + return context + + def post_run(self): + """Additionnal tasks.""" + hostname = self.config.get("general", "hostname") + context = self.get_template_context() + src = self.get_file_path("nginx.conf.tpl") + dst = os.path.join( + self.config_dir, "sites-available", "{}.conf".format(hostname)) + utils.copy_from_template(src, dst, context) + link = os.path.join( + self.config_dir, "sites-enabled", os.path.basename(dst)) + if os.path.exists(link): + return + os.symlink(dst, link) diff --git a/modoboa_installer/scripts/postfix.py b/modoboa_installer/scripts/postfix.py new file mode 100644 index 0000000..35746d0 --- /dev/null +++ b/modoboa_installer/scripts/postfix.py @@ -0,0 +1,55 @@ +"""Postfix related tools.""" + +import os + +from .. import utils + +from . import base + + +class Postfix(base.Installer): + + """Postfix installer.""" + + appname = "postfix" + packages = ["postfix"] + config_files = ["main.cf", "master.cf"] + + def get_packages(self): + """Additional packages.""" + return self.packages + ["postfix-{}".format(self.db_driver)] + + def install_packages(self): + """Preconfigure postfix package installation.""" + cfg = "postfix postfix/main_mailer_type select No configuration" + utils.exec_cmd("echo '{}' | debconf-set-selections".format(cfg)) + super(Postfix, self).install_packages() + + def get_template_context(self): + """Additional variables.""" + context = super(Postfix, self).get_template_context() + context.update({ + "db_driver": self.db_driver, + "dovecot_mailboxes_owner": self.config.get( + "dovecot", "mailboxes_owner"), + "modoboa_venv_path": self.config.get( + "modoboa", "venv_path"), + "modoboa_instance_path": self.config.get( + "modoboa", "instance_path"), + }) + return context + + def post_run(self): + """Additional tasks.""" + venv_path = self.config.get("modoboa", "venv_path") + python_path = os.path.join(venv_path, "bin", "python") + script_path = os.path.join(venv_path, "bin", "modoboa-admin.py") + db_url = "{}://{}:{}@{}/{}".format( + self.dbengine, self.config.get("modoboa", "dbuser"), + self.config.get("modoboa", "dbpassword"), + self.dbhost, self.config.get("modoboa", "dbname")) + cmd = ( + "{} {} postfix_maps --dbtype {} --extensions all --dburl {} {}" + .format(python_path, script_path, self.dbengine, db_url, + self.config_dir)) + utils.exec_cmd(cmd) diff --git a/modoboa_installer/scripts/razor.py b/modoboa_installer/scripts/razor.py new file mode 100644 index 0000000..91b3fcd --- /dev/null +++ b/modoboa_installer/scripts/razor.py @@ -0,0 +1,39 @@ +"""Razor related functions.""" + +import os +import pwd +import shutil +import stat + +from .. import utils + +from . import base + + +class Razor(base.Installer): + + """Razor installer.""" + + appname = "razor" + no_daemon = True + packages = ["razor"] + + def post_run(self): + """Additional tasks.""" + user = self.config.get("amavis", "user") + pw = pwd.getpwnam(user) + utils.mkdir( + "/var/log/razor", + stat.S_IRWXU | stat.S_IRGRP | stat.S_IXGRP | + stat.S_IROTH | stat.S_IXOTH, + pw[2], pw[3] + ) + path = os.path.join(self.config.get("amavis", "home_dir"), ".razor") + utils.mkdir(path, stat.S_IRWXU, pw[2], pw[3]) + utils.exec_cmd("razor-admin -home {} -create".format(path)) + shutil.copy(os.path.join(path, "razor-agent.conf"), self.config_dir) + utils.exec_cmd("razor-admin -home {} -discover".format(path), + sudo_user=user) + utils.exec_cmd("razor-admin -home {} -register".format(path), + sudo_user=user) + # FIXME: move log file to /var/log ? diff --git a/modoboa_installer/scripts/spamassassin.py b/modoboa_installer/scripts/spamassassin.py new file mode 100644 index 0000000..365901f --- /dev/null +++ b/modoboa_installer/scripts/spamassassin.py @@ -0,0 +1,44 @@ +"""Spamassassin related functions.""" + +from .. import utils + +from . import base +from . import install + + +class Spamassassin(base.Installer): + + """SpamAssassin installer.""" + + appname = "spamassassin" + no_daemon = True + packages = ["spamassassin", "pyzor"] + with_db = True + config_files = ["v310.pre", "local.cf"] + + def get_sql_schema_path(self): + """Return SQL schema.""" + if self.dbengine == "postgres": + schema = "/usr/share/doc/spamassassin/sql/bayes_pg.sql" + else: + schema = "/usr/share/doc/spamassassin/sql/bayes_mysql.sql" + return schema + + def get_template_context(self): + """Add additional variables to context.""" + context = super(Spamassassin, self).get_template_context() + if self.dbengine == "postgres": + store_module = "Mail::SpamAssassin::BayesStore::PgSQL" + dsn = "DBI:Pg:db_name={};host={}".format(self.dbname, self.dbhost) + else: + store_module = "Mail::SpamAssassin::BayesStore::MySQL" + dsn = "DBI:mysql:{}:{}".format(self.dbname, self.dbhost) + context.update({ + "store_module": store_module, "dsn": dsn, "dcc_enabled": "#"}) + return context + + def post_run(self): + """Additional tasks.""" + utils.exec_cmd( + "pyzor discover", sudo_user=self.config.get("amavis", "user")) + install("razor", self.config) diff --git a/modoboa_installer/scripts/uwsgi.py b/modoboa_installer/scripts/uwsgi.py new file mode 100644 index 0000000..ea07198 --- /dev/null +++ b/modoboa_installer/scripts/uwsgi.py @@ -0,0 +1,46 @@ +"""uWSGI related tools.""" + +import os + +from .. import utils + +from . import base + + +class Uwsgi(base.Installer): + + """uWSGI installer.""" + + appname = "uwsgi" + packages = ["uwsgi", "uwsgi-plugin-python"] + + def get_template_context(self): + """Additionnal variables.""" + context = super(Uwsgi, self).get_template_context() + context.update({ + "modoboa_user": self.config.get("modoboa", "user"), + "modoboa_venv_path": self.config.get("modoboa", "venv_path"), + "modoboa_instance_path": ( + self.config.get("modoboa", "instance_path")), + "uwsgi_socket_path": self.config.get("uwsgi", "socket_path") + }) + return context + + def post_run(self): + """Additionnal tasks.""" + context = self.get_template_context() + src = self.get_file_path("uwsgi.ini.tpl") + dst = os.path.join( + self.config_dir, "apps-available", "modoboa_instance.ini") + utils.copy_from_template(src, dst, context) + link = os.path.join( + self.config_dir, "apps-enabled", os.path.basename(dst)) + if os.path.exists(link): + return + os.symlink(dst, link) + + def restart_daemon(self): + """Restart daemon process.""" + code, output = utils.exec_cmd("service uwsgi status modoboa_instance") + action = "start" if code else "restart" + utils.exec_cmd("service uwsgi {}".format(action)) diff --git a/modoboa_installer/system.py b/modoboa_installer/system.py new file mode 100644 index 0000000..ba84878 --- /dev/null +++ b/modoboa_installer/system.py @@ -0,0 +1,36 @@ +"""System related functions.""" + +import grp +import pwd +import sys + +from . import utils + + +def create_user(name, home=None): + """Create a new system user.""" + try: + pwd.getpwnam(name) + except KeyError: + pass + else: + return + cmd = "useradd -m " + if home: + cmd += "-d {} ".format(home) + utils.exec_cmd("{} {}".format(cmd, name)) + + +def add_user_to_group(user, group): + """Add system user to group.""" + try: + pwd.getpwnam(user) + except KeyError: + print("User {} does not exist".format(user)) + sys.exit(1) + try: + grp.getgrnam(group) + except KeyError: + print("Group {} does not exist".format(group)) + sys.exit(1) + utils.exec_cmd("usermod -a -G {} {}".format(group, user)) diff --git a/modoboa_installer/utils.py b/modoboa_installer/utils.py new file mode 100644 index 0000000..e2defc2 --- /dev/null +++ b/modoboa_installer/utils.py @@ -0,0 +1,137 @@ +"""Utility functions.""" + +import contextlib +import datetime +import os +import string +import subprocess +import sys + + +ENV = {} +BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE = range(8) + + +class FatalError(Exception): + + """A simple exception.""" + + pass + + +def user_input(message): + """Ask something to the user.""" + try: + from builtins import input + except ImportError: + answer = raw_input(message) + else: + answer = input(message) + return answer + + +def exec_cmd(cmd, sudo_user=None, pinput=None, **kwargs): + """Execute a shell command. + Run a command using the current user. Set :keyword:`sudo_user` if + you need different privileges. + :param str cmd: the command to execute + :param str sudo_user: a valid system username + :param str pinput: data to send to process's stdin + :rtype: tuple + :return: return code, command output + """ + sudo_user = ENV.get("sudo_user", sudo_user) + if sudo_user is not None: + cmd = "sudo -u %s %s" % (sudo_user, cmd) + if "shell" not in kwargs: + kwargs["shell"] = True + if pinput is not None: + kwargs["stdin"] = subprocess.PIPE + capture_output = False + if "capture_output" in kwargs: + capture_output = kwargs.pop("capture_output") + elif not ENV.get("debug"): + capture_output = True + if capture_output: + kwargs.update(stdout=subprocess.PIPE, stderr=subprocess.PIPE) + output = None + process = subprocess.Popen(cmd, **kwargs) + if pinput or capture_output: + c_args = [pinput] if pinput is not None else [] + output = process.communicate(*c_args)[0] + else: + process.wait() + return process.returncode, output + + +def install_system_package(name, update=False): + """Install a package system-wide.""" + if update: + exec_cmd("apt-get update --quiet") + exec_cmd("apt-get install --quiet --assume-yes {}".format(name)) + + +def install_system_packages(names): + """Install some packages system-wide.""" + exec_cmd("apt-get install --quiet --assume-yes {}".format(" ".join(names))) + + +def mkdir(path, mode, uid, gid): + """Create a directory.""" + if not os.path.exists(path): + os.mkdir(path, mode) + else: + os.chmod(path, mode) + os.chown(path, uid, gid) + + +@contextlib.contextmanager +def settings(**kwargs): + """Context manager to declare temporary settings.""" + for key, value in kwargs.items(): + ENV[key] = value + yield + for key in kwargs.keys(): + del ENV[key] + + +class ConfigFileTemplate(string.Template): + + """Custom class for configuration files.""" + + delimiter = "%" + + +def copy_from_template(template, dest, context): + """Create and copy a configuration file from a template.""" + with open(template) as fp: + buf = fp.read() + with open(dest, "w") as fp: + now = datetime.datetime.now() + fp.write( + "# This file was automatically installed on {}\n" + .format(now.isoformat())) + fp.write(ConfigFileTemplate(buf).substitute(context)) + + +def has_colours(stream): + """Check if terminal supports colors.""" + if not hasattr(stream, "isatty"): + return False + if not stream.isatty(): + return False # auto color only on TTYs + try: + import curses + curses.setupterm() + return curses.tigetnum("colors") > 2 + except: + # guess false in case of error + return False +has_colours = has_colours(sys.stdout) + + +def printcolor(message, color): + """Print a message using a green color.""" + if has_colours: + message = "\x1b[1;{}m{}\x1b[0m".format(30 + color, message) + print(message) diff --git a/run.py b/run.py new file mode 100755 index 0000000..c5e0774 --- /dev/null +++ b/run.py @@ -0,0 +1,64 @@ +#!/usr/bin/env python + +"""An installer for Modoboa.""" + +import argparse +try: + import configparser +except ImportError: + import ConfigParser as configparser + +from modoboa_installer import scripts +from modoboa_installer import utils + + +def main(): + """Install process.""" + parser = argparse.ArgumentParser() + parser.add_argument("--debug", action="store_true", default=False, + help="Enable debug output") + parser.add_argument("--force", action="store_true", default=False, + help="Force installation") + parser.add_argument("hostname", type=str, + help="The hostname of your future mail server") + args = parser.parse_args() + + if args.debug: + utils.ENV["debug"] = True + utils.printcolor("Welcome to Modoboa installer!", utils.GREEN) + config = configparser.SafeConfigParser() + with open("installer.cfg") as fp: + config.readfp(fp) + config.set("general", "hostname", args.hostname) + utils.printcolor( + "Your mail server {} will be installed with the following components:" + .format(args.hostname), utils.BLUE) + components = [] + for section in config.sections(): + if section in ["general", "database", "mysql", "postgres"]: + continue + if (config.has_option(section, "enabled") and + not config.getboolean(section, "enabled")): + continue + components.append(section) + utils.printcolor(" ".join(components), utils.YELLOW) + if not args.force: + answer = utils.user_input("Do you confirm? (Y/n) ") + if answer.lower().startswith("n"): + return + utils.printcolor( + "The process can be long, feel free to take a coffee " + "and come back later ;)", utils.BLUE) + utils.printcolor("Starting...", utils.GREEN) + utils.install_system_package("sudo", update=True) + scripts.install("modoboa", config) + scripts.install("postfix", config) + scripts.install("amavis", config) + scripts.install("dovecot", config) + utils.printcolor( + "Congratulations! You can enjoy Modoboa at https://{}" + .format(args.hostname), + utils.GREEN) + +if __name__ == "__main__": + main()