openship 0.4.4 → 0.4.6

package/dist/server/engine/tools/backup_sogo.sh

@@ -0,0 +1,156 @@
+#!/usr/bin/env bash
+
+# Author:   Zhang Huangbin (zhb@iredmail.org)
+# Purpose:  Backup SOGo database with `sogo-tool` command.
+#           You can run this script manually or via crontab (recommended).
+#
+# Backing up SOGo data by dumping SQL database to a plain SQL file is not ideal
+# because:
+#
+#   - it's hard to restore single user's data
+#   - if SOGo changes some SQL structure, it's hard to restore all data.
+#
+# This script does backup with 'sogo-tool backup' command to avoid issues
+# mentioned above, it stores each user's data in a single file, so you can
+# restore a single user's data or all users data with 'sogo-tool restore'.
+
+# Required commands:
+#
+#       + sogo-tool
+#       + tar
+#       + bzip2
+
+# USAGE
+#
+#   * It stores backup copies under '/var/vmail/backup/sogo' by default,
+#     feel free to change it with variable BACKUP_ROOTDIR below.
+#
+#   * If you want to log a message in iRedAdmin database (`iredadmin.log`),
+#     please specify correct MySQL username in variable MYSQL_USER, and
+#     write the same MySQL username and password in file /root/.my.cnf.
+#
+#   * Add crontab job for root user:
+#
+#       # crontab -e -u root
+#       1   4   *   *   *   bash /var/vmail/backup/backup_sogo.sh
+
+# Keep backup for how many days. Defaults to 90 days.
+export KEEP_DAYS='90'
+
+# Where to store backup copies.
+export BACKUP_ROOTDIR='/var/vmail/backup'
+
+# MySQL username. Root user is required to dump all databases.
+export MYSQL_USER='root'
+
+# ~/.my.cnf
+export MYSQL_DOT_MY_CNF='/root/.my.cnf'
+
+export CMD_MYSQL="mysql --defaults-file=${MYSQL_DOT_MY_CNF} -u${MYSQL_USER}"
+
+#########################################################
+# You do *NOT* need to modify below lines.
+#########################################################
+# FreeBSD has 'sogo-tool' in different directory.
+export PATH=/usr/bin:/bin:/usr/sbin:/sbin:/usr/local/bin:/usr/local/sbin:/usr/local/GNUstep/Local/Tools/Admin:$PATH
+
+# Commands.
+export CMD_DATE='/bin/date'
+export CMD_DU='du -sh'
+export CMD_COMPRESS='bzip2 -9'
+export COMPRESS_SUFFIX='bz2'
+
+# Path to sogo-tool command.
+export CMD_SOGO_TOOL='sogo-tool'
+
+# Date.
+export YEAR="$(${CMD_DATE} +%Y)"
+export MONTH="$(${CMD_DATE} +%m)"
+export DAY="$(${CMD_DATE} +%d)"
+export TIME="$(${CMD_DATE} +%H-%M-%S)"
+export TIMESTAMP="${YEAR}-${MONTH}-${DAY}-${TIME}"
+
+# Pre-defined backup status
+export BACKUP_SUCCESS='YES'
+
+# Define, check, create directories.
+export BACKUP_DIR="${BACKUP_ROOTDIR}/sogo/${YEAR}/${MONTH}/${DAY}"
+
+# Find the old backup which should be removed.
+export REMOVE_OLD_BACKUP='YES'
+
+export KERNEL="$(uname -s)"
+if [[ X"${KERNEL}" == X'Linux' ]]; then
+    shift_year=$(date --date="${KEEP_DAYS} days ago" "+%Y")
+    shift_month=$(date --date="${KEEP_DAYS} days ago" "+%m")
+    shift_day=$(date --date="${KEEP_DAYS} days ago" "+%d")
+elif [[ X"${KERNEL}" == X'FreeBSD' ]]; then
+    shift_year=$(date -j -v-${KEEP_DAYS}d "+%Y")
+    shift_month=$(date -j -v-${KEEP_DAYS}d "+%m")
+    shift_day=$(date -j -v-${KEEP_DAYS}d "+%d")
+elif [[ X"${KERNEL}" == X'OpenBSD' ]]; then
+    epoch_seconds_now="$(date +%s)"
+    epoch_shift="$((${KEEP_DAYS} * 86400))"
+    epoch_seconds_old="$((epoch_seconds_now - epoch_shift))"
+
+    shift_year=$(date -r ${epoch_seconds_old} "+%Y")
+    shift_month=$(date -r ${epoch_seconds_old} "+%m")
+    shift_day=$(date -r ${epoch_seconds_old} "+%d")
+else
+    export REMOVE_OLD_BACKUP='NO'
+fi
+
+export REMOVED_BACKUP="${BACKUP_ROOTDIR}/sogo/${shift_year}/${shift_month}/${shift_day}.tar.bz2"
+export REMOVED_BACKUP_MONTH_DIR="${BACKUP_ROOTDIR}/sogo/${shift_year}/${shift_month}"
+export REMOVED_BACKUP_YEAR_DIR="${BACKUP_ROOTDIR}/sogo/${shift_year}"
+
+# Check and create directories.
+if [ ! -d ${BACKUP_DIR} ]; then
+    mkdir -p ${BACKUP_DIR} 2>/dev/null
+    chown -R root ${BACKUP_DIR}
+    chmod -R 0700 ${BACKUP_DIR}
+fi
+
+# Backup
+echo "* Backup all users' data under ${BACKUP_DIR}"
+${CMD_SOGO_TOOL} backup ${BACKUP_DIR} ALL
+
+dir_name="$(dirname ${BACKUP_DIR})"
+base_name="$(basename ${BACKUP_DIR})"
+
+if ls ${BACKUP_DIR} | grep -i '[a-z0-9]' &>/dev/null; then
+    # Backup is not empty.
+    chown -R root ${BACKUP_DIR}
+    chmod -R 0700 ${BACKUP_DIR}
+
+    # Get original size of backup files
+    original_size="$(${CMD_DU} ${BACKUP_DIR} | awk '{print $1}')"
+
+    # Compress the directory.
+    echo "* Compress backup files."
+    cd ${dir_name} &&\
+        tar cjf ${base_name}.tar.bz2 ${base_name} && \
+        chown root ${base_name}.tar.bz2 && \
+        chmod 0400 ${base_name}.tar.bz2 && \
+        rm -rf ${base_name}
+
+    compressed_size="$(${CMD_DU} ${base_name}.tar.bz2 | awk '{print $1}')"
+    if [ -n X"${MYSQL_USER}" -a -f ${MYSQL_DOT_MY_CNF} ]; then
+        sql_log_msg="INSERT INTO log (event, loglevel, msg, admin, ip, timestamp) VALUES ('backup', 'info', 'SOGo data. size: ${compressed_size} (original: ${original_size})', 'cron_backup_sogo', '127.0.0.1', UTC_TIMESTAMP());"
+        ${CMD_MYSQL} iredadmin -e "${sql_log_msg}"
+    fi
+else
+    echo "* Backup is empty, remove temporary backup directory: ${BACKUP_DIR}."
+    rm -rf ${BACKUP_DIR} &>/dev/null
+fi
+
+if [ X"${REMOVE_OLD_BACKUP}" == X'YES' -a -f ${REMOVED_BACKUP} ]; then
+    echo -e "* Old backup found. Deleting: ${REMOVED_BACKUP}."
+    rm -rf ${REMOVED_BACKUP} &>/dev/null
+
+    # Try to remove empty directory.
+    rmdir ${REMOVED_BACKUP_MONTH_DIR} 2>/dev/null
+    rmdir ${REMOVED_BACKUP_YEAR_DIR} 2>/dev/null
+fi
+
+exit 0

package/dist/server/engine/tools/create_mail_user_OpenLDAP.py

@@ -0,0 +1,335 @@
+#!/usr/bin/env python3
+# encoding: utf-8
+
+# Author: Zhang Huangbin <zhb _at_ iredmail.org>
+# Purpose: Add new OpenLDAP user for postfix mail server.
+# Project:  iRedMail (http://www.iredmail.org/)
+
+# --------------------------- WARNING ------------------------------
+# This script only works under iRedMail >= 0.4.0 due to ldap schema
+# changes.
+# ------------------------------------------------------------------
+
+# ---------------------------- USAGE -------------------------------
+# Put your user list in a csv format file, e.g. users.csv, and then
+# import users listed in the file:
+#
+#   $ python3 create_mail_user_OpenLDAP.py users.csv
+#
+# ------------------------------------------------------------------
+
+# ------------------------- SETTINGS -------------------------------
+# LDAP server address.
+LDAP_URI = 'ldap://127.0.0.1:389'
+
+# LDAP base dn.
+BASEDN = 'o=domains,dc=example,dc=com'
+
+# Bind dn/password
+BINDDN = 'cn=Manager,dc=example,dc=com'
+BINDPW = 'password'
+
+# Storage base directory.
+STORAGE_BASE_DIRECTORY = '/var/vmail/vmail1'
+
+# Append timestamp in maildir path.
+APPEND_TIMESTAMP_IN_MAILDIR = True
+
+# Get base directory and storage node.
+std = STORAGE_BASE_DIRECTORY.rstrip('/').split('/')
+STORAGE_NODE = std.pop()
+
+# Hashed maildir: True, False.
+# Example:
+#   domain: domain.ltd,
+#   user:   zhang (zhang@domain.ltd)
+#
+#       - hashed: d/do/domain.ltd/z/zh/zha/zhang/
+#       - normal: domain.ltd/zhang/
+HASHED_MAILDIR = True
+
+# Default password schemes.
+# Multiple passwords are supported if you separate schemes with '+'.
+# For example: 'SSHA+NTLM', 'CRAM-MD5+SSHA', 'CRAM-MD5+SSHA+MD5'.
+DEFAULT_PASSWORD_SCHEME = 'SSHA512'
+
+# Do not prefix password scheme name in password hash.
+HASHES_WITHOUT_PREFIXED_PASSWORD_SCHEME = ['NTLM']
+# ------------------------------------------------------------------
+
+import os
+import sys
+import time
+import datetime
+from subprocess import Popen, PIPE
+from typing import List, Dict
+import re
+
+try:
+    import ldif
+except ImportError:
+    print("""
+    Error: You don't have python-ldap installed, Please install it first.
+
+    You can install it like this:
+
+    - On RHEL/CentOS 5.x:
+
+        $ sudo yum install python-ldap
+
+    - On Debian & Ubuntu:
+
+        $ sudo apt install python-ldap
+    """)
+    sys.exit()
+
+
+def usage():
+    print("""
+CSV file format:
+
+    domain name, username, password, [common name], [quota_in_bytes], [groups]
+
+Example #1:
+    iredmail.org, zhang, plain_password, Zhang Huangbin, 104857600, group1:group2
+Example #2:
+    iredmail.org, zhang, plain_password, Zhang Huangbin, ,
+Example #3:
+    iredmail.org, zhang, plain_password, , 104857600, group1:group2
+
+Note:
+    - Domain name, username and password are REQUIRED, others are optional:
+        + common name.
+            * It will be the same as username if it's empty.
+            * Non-ascii character is allowed in this field, they will be
+              encoded automaticly. Such as Chinese, Korea, Japanese, etc.
+        + quota. It will be 0 (unlimited quota) if it's empty.
+        + groups.
+            * valid group name (hr@a.cn): hr
+            * incorrect group name: hr@a.cn
+            * Do *NOT* include domain name in group name, it will be
+              appended automaticly.
+            * Multiple groups must be seperated by colon.
+    - Leading and trailing Space will be ignored.
+    """)
+
+
+def __str2bytes(s) -> bytes:
+    """Convert `s` from string to bytes."""
+    if isinstance(s, bytes):
+        return s
+    elif isinstance(s, str):
+        return s.encode()
+    elif isinstance(s, (int, float)):
+        return str(s).encode()
+    else:
+        return bytes(s)
+
+def __attr_ldif(attr, value, default=None) -> List:
+    """Generate a list of LDIF data with given attribute name and value.
+    Returns empty list if no valid value.
+
+    Value is properly handled with str/bytes/list/tuple/set types, and
+    converted to list of bytes at the end.
+
+    To generate ldif list with ldap modification like `ldap.MOD_REPLACE`,
+    please use function `mod_replace()` instead.
+    """
+    _ldif = []
+    v = value or default
+    if v:
+        if isinstance(value, (list, tuple, set)):
+            lst = []
+            for i in v:
+                # Avoid duplicate element.
+                if i in lst:
+                    continue
+
+                if isinstance(i, bytes):
+                    lst.append(i)
+                else:
+                    lst.append(__str2bytes(i))
+
+            _ldif = [(attr, lst)]
+        else:
+            _ldif = [(attr, [__str2bytes(v)])]
+
+    return _ldif
+
+
+def __attrs_ldif(kvs: Dict) -> List:
+    lst = []
+    for (k, v) in kvs.items():
+        lst += __attr_ldif(k, v)
+
+    return lst
+
+
+# Return list of modification operation.
+def mail_to_user_dn(mail):
+    """Convert email address to ldap dn of normail mail user."""
+    if mail.count('@') != 1:
+        return ''
+
+    user, domain = mail.split('@')
+
+    # User DN format.
+    # mail=user@domain.ltd,domainName=domain.ltd,[LDAP_BASEDN]
+    dn = 'mail=%s,ou=Users,domainName=%s,%s' % (mail, domain, BASEDN)
+
+    return dn
+
+
+def generate_password_with_doveadmpw(plain_password, scheme=None):
+    """Generate password hash with `doveadm pw` command.
+    Return SSHA instead if no 'doveadm' command found or other error raised."""
+    if not scheme:
+        scheme = DEFAULT_PASSWORD_SCHEME
+
+    scheme = scheme.upper()
+    p = str(plain_password).strip()
+
+    pp = Popen(['doveadm', 'pw', '-s', scheme, '-p', p], stdout=PIPE)
+    pw = pp.communicate()[0]
+
+    if scheme in HASHES_WITHOUT_PREFIXED_PASSWORD_SCHEME:
+        pw.lstrip('{' + scheme + '}')
+
+    # remove '\n'
+    pw = pw.strip()
+
+    return pw
+
+def get_days_of_today():
+    """Return number of days since 1970-01-01."""
+    today = datetime.date.today()
+
+    try:
+        return (datetime.date(today.year, today.month, today.day) - datetime.date(1970, 1, 1)).days
+    except:
+        return 0
+
+def ldif_mailuser(domain, username, passwd, cn, quota, groups=''):
+    # Append timestamp in maildir path
+    DATE = time.strftime('%Y.%m.%d.%H.%M.%S')
+    TIMESTAMP_IN_MAILDIR = ''
+    if APPEND_TIMESTAMP_IN_MAILDIR:
+        TIMESTAMP_IN_MAILDIR = '-%s' % DATE
+
+    if quota == '':
+        quota = '0'
+
+    # Remove SPACE in username.
+    username = str(username).lower().strip().replace(' ', '')
+
+    if cn == '':
+        cn = username
+
+    mail = username + '@' + domain
+    dn = mail_to_user_dn(mail)
+
+    # Get group list.
+    if groups.strip() != '':
+        groups = groups.strip().split(':')
+        for i in range(len(groups)):
+            groups[i] = groups[i] + '@' + domain
+
+    maildir_domain = str(domain).lower()
+    if HASHED_MAILDIR is True:
+        str1 = str2 = str3 = username[0]
+        if len(username) >= 3:
+            str2 = username[1]
+            str3 = username[2]
+        elif len(username) == 2:
+            str2 = str3 = username[1]
+
+        maildir_user = "%s/%s/%s/%s%s/" % (str1, str2, str3, username, TIMESTAMP_IN_MAILDIR, )
+        mailMessageStore = maildir_domain + '/' + maildir_user
+    else:
+        mailMessageStore = "%s/%s%s/" % (domain, username, TIMESTAMP_IN_MAILDIR)
+
+    homeDirectory = STORAGE_BASE_DIRECTORY + '/' + mailMessageStore
+
+    _ldif = __attrs_ldif({
+        'objectClass': ['inetOrgPerson', 'mailUser', 'shadowAccount', 'amavisAccount'],
+        'mail': mail,
+        'userPassword': generate_password_with_doveadmpw(passwd),
+        'mailQuota': quota,
+        'cn': cn,
+        'sn': username,
+        'uid': username,
+        'homeDirectory': homeDirectory,
+        'accountStatus': 'active',
+        'enabledService': ['internal', 'doveadm', 'lib-storage',
+                           'indexer-worker', 'dsync', 'quota-status',
+                           'mail',
+                           'smtp', 'smtpsecured', 'smtptls',
+                           'pop3', 'pop3secured', 'pop3tls',
+                           'imap', 'imapsecured', 'imaptls',
+                           'managesieve', 'managesievesecured', 'managesievetls',
+                           'sieve', 'sievesecured', 'sievetls',
+                           'deliver', 'lda', 'lmtp', 'forward',
+                           'senderbcc', 'recipientbcc',
+                           'sogo', 'sogowebmail', 'sogocalendar', 'sogoactivesync',
+                           'shadowaddress',
+                           'displayedInGlobalAddressBook'],
+        'memberOfGroup': groups,
+        # shadowAccount integration.
+        'shadowLastChange': get_days_of_today(),
+        # Amavisd integration.
+        'amavisLocal': 'TRUE',
+    })
+
+    return dn, _ldif
+
+
+if len(sys.argv) != 2 or len(sys.argv) > 2:
+    print("""Usage: $ python3 %s users.csv""" % sys.argv[0])
+    usage()
+    sys.exit()
+else:
+    CSV = sys.argv[1]
+    if not os.path.exists(CSV):
+        print("Error: file not exist:", CSV)
+        sys.exit()
+
+ldif_file = CSV + '.ldif'
+
+# Remove exist LDIF file.
+if os.path.exists(ldif_file):
+    print("< INFO > Remove exist file:", ldif_file)
+    os.remove(ldif_file)
+
+# Read user list.
+userList = open(CSV, 'rb')
+
+# Convert to LDIF format.
+for entry in userList.readlines():
+    entry = entry.decode().rstrip()
+    domain, username, passwd, cn, quota, groups = re.split(r'\s?,\s?', entry)
+    dn, data = ldif_mailuser(domain, username, passwd, cn, quota, groups)
+
+    # Write LDIF data.
+    result = open(ldif_file, 'a')
+    ldif_writer = ldif.LDIFWriter(result)
+    ldif_writer.unparse(dn, data)
+
+
+ldif_file_path = os.path.abspath(ldif_file)
+print("< INFO > User data are stored in %s, you can verify it before importing it." % ldif_file_path)
+print("< INFO > You can import it with below command:")
+print("ldapadd -x -D %s -W -f %s" % (BINDDN, ldif_file_path))
+
+# Prompt to import user data.
+"""
+answer = raw_input("Would you like to import them now? [y|N]").lower().strip()
+
+if answer == 'y':
+    # Import data.
+    conn = ldap.initialize(LDAP_URI)
+    conn.set_option(ldap.OPT_PROTOCOL_VERSION, 3)   # Use LDAP v3
+    conn.bind_s(BINDDN, BINDPW)
+    conn.unbind()
+else:
+    pass
+"""