smailr 0.3.0

data/bin/smailr

@@ -0,0 +1,165 @@
+#!/usr/bin/env ruby
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'smailr'
+
+DB = Sequel.connect("sqlite:///etc/exim4/smailr.sqlite")
+
+#
+# CLI Helpers
+#
+def determine_object(string)
+    return :domain  if string =~ /^[^@][A-Z0-9.-]+\.[A-Z]{2,6}$/i
+    return :address if string =~ /^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,6}$/i
+end
+
+def ask_password
+     min_password_length = 5
+     password = ask("Password: ") { |q| q.echo = "*" }
+     confirm  = ask("Confirm: ")  { |q| q.echo = "*" }
+
+    if password != confirm
+        say("Mismatch; try again.")
+        ask_password
+    end
+
+    if password.length < min_password_length
+        say("Too short; try again.")
+        ask_password
+    end
+
+    return password
+end
+
+program :version, Smailr::VERSION
+program :description, 'Simple MAIL mangaR - Virtual mail hosting management from the CLI'
+
+#
+# Commands
+#
+command :add do |c|
+    c.syntax = 'smailr add domain | mailbox | alias [options]'
+    c.summary = 'Add a new domain, mailbox or alias to the mail system.'
+    c.example 'Add a domain',  'smailr add example.com'
+    c.example 'Add a mailbox', 'smailr add user@example.com'
+    c.example 'Add an alias',  'smailr add alias@localdom.com --alias user@example.com,user1@example.com'
+    c.example 'Setup DKIM for a domain', 'smailr add ono.at --dkim'
+    c.option  '--alias STRING',    String,  'Specify the alias destination.'
+    c.option  '--password STRING', String,  'The password for a new mailbox. If you omit this option, it prompts for one.'
+    c.option  '--dkim',            String,  'Add a DKIM Key for a domain'
+    c.action do |args, options|
+        address = args[0]
+        type    = determine_object(address)
+
+        case type
+            when :domain
+                if options.dkim
+                    Smailr::Dkim.add(address, options)
+                else
+                    Smailr::Domain.add(address)
+                end
+
+            when :address
+                if options.alias
+                    source       = args[0]
+                    destinations = options.alias.split(',')
+                    Smailr::Alias.add(source, destinations)
+                else
+                    options.password ||= ask_password
+                    Smailr::Mailbox.add(address, options.password)
+                end
+
+        end
+    end
+end
+
+command :ls do |c|
+    c.syntax  = 'smailr ls [domain]'
+    c.summary = 'List domains or mailboxes of a specific domain.'
+    c.action do |args, options|
+        case args[0]
+            when /^[^@][A-Z0-9.-]+\.[A-Z]{2,6}$/i then
+                domain = Smailr::Model::Domain[:fqdn => args[0]]
+                domain.mailboxes.each do |mbox|
+                    puts "m: #{mbox.localpart}@#{args[0]}"
+                end
+                domain.aliases.each do |aliass|
+                    puts "a: #{aliass.localpart}@#{args[0]} > #{aliass.dstlocalpart}@#{aliass.dstdomain}"
+                end
+            when nil
+                domains = DB[:domains]
+                domains.all.each do |d|
+                    domain = Smailr::Model::Domain[:fqdn => d[:fqdn]]
+                    puts d[:fqdn]
+                end
+            else
+                error "You can either list a domains or a domains addresses."
+                exit 1
+        end
+    end
+end
+
+command :rm do |c|
+    c.syntax  = 'smailr rm domain | mailbox [options]'
+    c.summary = 'Remove a domain, mailbox or alias known to the mail system.'
+    c.example 'Remove a domain', 'smailr rm example.com'
+    c.option '--force', 'Force the operation, do not ask for confirmation.'
+    c.option '--dkim',  'Remove a dkim key.' 
+    c.option '--alias STRING',    String, 'Specify the alias which you want to remove.'
+    c.action do |args, options|
+        address = args[0]
+        type    = determine_object(address)
+        case type
+            when :domain
+                if options.dkim
+                    Smailr::Dkim.rm(address, options)
+                else
+                    Smailr::Domain.rm(address, options.force)
+                end
+
+            when :address
+                if options.alias
+                    source       = args[0]
+                    destinations = options.alias.split(',')
+
+                    Smailr::Alias.rm(source, destinations)
+                else
+                    Smailr::Mailbox.rm(address, options)
+                end
+        end
+    end
+end
+
+
+command :migrate do |c|
+    c.syntax  = 'smailr migrate [options]'
+    c.summary = 'Create database and run migrations'
+    c.option '--to VERSION', String, 'Migrate the database to a specifict version.'
+    c.action do |args,options|
+        require 'sequel/extensions/migration'
+        raise "Database not configured" unless DB
+
+        if options.version.nil?
+            Sequel::Migrator.apply(DB, Smailr.migrations_directory)
+        else
+            Sequel::Migrator.apply(DB, Smailr.migrations_directory, :target => options.version.to_i)
+        end
+    end
+end
+
+
+command :mutt do |c|
+    c.syntax      = "smailr mutt address"
+    c.summary     = "View the mailbox of the specified address in mutt."
+    c.description = "Open the mailbox of the specified address in mutt.\n\n    " +
+                    "Requires that mutt is installed and assumes the default mail\n    " +
+                    "storage directory structure: /srv/mail/users/<fqdn>/<localpart>"
+    c.example       'Open test@example.com', 'smailr mutt test@example.com'
+    c.action do |args,options|
+        localpart, fqdn = args[0].split('@')
+        `command -v mutt >/dev/null 2>&1 || { echo "Please install mutt first. Aborting." >&2; exit 1; }`
+        if not $?
+            exec "MAIL=/srv/mail/users/#{fqdn}/#{localpart} MAILDIR=$MAIL mutt -mMaildir]"
+        end
+    end
+end

data/contrib/dovecot-sql.conf

@@ -0,0 +1,135 @@
+# This file is opened as root, so it should be owned by root and mode 0600.
+#
+# http://wiki.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 = sqlite
+
+# Database connection string. This is driver-specific setting.
+#
+# pgsql:
+#   For available options, see the PostgreSQL documention for the
+#   PQconnectdb function of libpq.
+#
+# 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/mysqld/mysqld.sock
+#   Note that currently you can't use spaces in parameters.
+#
+#   MySQL supports multiple host parameters for load balancing / HA.
+#
+# 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 = /etc/exim4/smailr.sqlite
+
+# Default password scheme.
+#
+# List of supported schemes is in
+# http://wiki.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://wiki.dovecot.org/PasswordDatabase/ExtraFields
+#
+# Commonly used available substitutions (see http://wiki.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://wiki.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'
+
+# 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 mailboxes.password AS password, \
+         mailboxes.localpart AS username, \
+         domains.fqdn AS domain \
+    FROM mailboxes, domains \
+   WHERE mailboxes.localpart = '%n' \
+     AND domains.fqdn = '%d' \
+     AND domains.id = mailboxes.domain_id