smailr 0.5.5 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c285dbbec224e60b52df63833918c88f7677a3d4
-  data.tar.gz: 85b06fd358341fd4f9a73f500fca51b352cb120a
+  metadata.gz: a210f85857566e3db628005398f0de0f9f0a512b
+  data.tar.gz: 86751942bbe91990eeb678238d64d581ae75bf53
 SHA512:
-  metadata.gz: f9011a18cb6cc2ac3f511c1fd91bc781d58e9ceae4ed9b47d05769b2113b06a0b635768178e489b2b91ac60670b41fbc12028510e4c929ee730d82565c7a0bc8
-  data.tar.gz: f0a7b9f172c6e50df96f07730eb47931a8cfd74ff5ddeddfdacf93ce17e933535c50ad19c875d7bc66379d5cb0c6c6963d9721efcd9925c6479efbb69a570c48
+  metadata.gz: 533d32daf44f0561363885a384ca062f78d93925bb3d687b04e9c9250f927d4fe6d80bc91b15c0a68e2decdeb1b6e459216824e61be94d931a264c2c75d5df3b
+  data.tar.gz: 84210fefd6cea9d4b30e34af42204fd2b77207ed5329e008594c6d1152274bffe1e231fb011afab0449b58de16e81ec9bbb52ef2664c88d6b001fc2305473ee0

data/README.md

@@ -1,13 +1,11 @@
-# Smailr - A Virtual Mail Hosting Management CLI (ALPHA)
+# Smailr - A Virtual Mail Hosting Management CLI
 
 Smailr is a small CLI application, which lets you manage the database for a
-typical Exim/Dovecot stack.
+typical mailserver (examples provided for Exim/Dovecot).
 
 Configuration files are provided within the contrib directory, so you should be
 able to get everything up and running within a couple of minutes.
 
-Please note, Smailr is still in development!
-
 ## Installation
 
 Install Packages

data/bin/commander

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'commander' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('commander', 'commander')

data/bin/sequel

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'sequel' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('sequel', 'sequel')

data/bin/smailr

@@ -56,7 +56,7 @@ command :add do |c|
                 if options.dkim
                     selector = options.dkim
                     key = Smailr::Dkim.add(address, selector)
-                    
+
                     puts "public-key " + key.to_a[1..-2].join.gsub(/\n/, '')
                 else
                     Smailr::Domain.add(address)
@@ -172,17 +172,32 @@ end
 
 
 command :mutt do |c|
+    base = Smailr.config["mail_spool_path"]
+
     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>"
+                    "Requires that mutt is installed and tries to find a suitable maildir in: " + base
     c.example       'Open test@example.com', 'smailr mutt test@example.com'
     c.action do |args,options|
         localpart, fqdn = args[0].split('@')
+
         mutt = `command -v mutt || { echo "Please install mutt first. Aborting." >&2; exit 1; }`
         if $?
-            exec "MAIL=/srv/mail/users/#{fqdn}/#{localpart} MAILDIR=$MAIL #{mutt} -mMaildir"
+
+          possibilities = [
+             "#{base}/#{fqdn}/#{localpart}/Maildir",
+             "#{base}/users/#{fqdn}/#{localpart}/Maildir",
+             "#{base}/users/#{fqdn}/#{localpart}/.maildir",
+             "#{base}/users/#{fqdn}/#{localpart}"
+          ]
+
+          possibilities.each do |path|
+              if File.readable?(path)
+                 puts "Opening maildir #{path} with mutt."
+                 exec "MAIL=#{path} MAILDIR=#{path} #{mutt} -mMaildir"
+              end
+          end
         end
     end
 end

data/contrib/dovecot-sql.conf

@@ -126,7 +126,7 @@ default_pass_scheme = MD5
 # string. For example:
 
 password_query = \
-  SELECT '{SHA}' || mailboxes.password AS password, \
+  SELECT mailboxes.password_scheme || mailboxes.password AS password, \
          mailboxes.localpart AS username, \
          domains.fqdn AS domain \
     FROM mailboxes, domains \

data/contrib/dovecot.conf

@@ -890,7 +890,7 @@ auth default {
   #   plain login digest-md5 cram-md5 ntlm rpa apop anonymous gssapi otp skey
   #   gss-spnego
   # NOTE: See also disable_plaintext_auth setting.
-  mechanisms = plain
+  mechanisms = plain login
 
   #
   # Password database is used to verify user's password (and nothing more).

data/contrib/exim4.conf

@@ -325,21 +325,18 @@ begin retry
 
 begin authenticators
 
+    login:
+        driver = dovecot
+        public_name = LOGIN
+        server_socket = /var/run/dovecot/auth-client
+        # setting server_set_id might break several headers in
+        # mails sent by authenticated smtp. So be careful.
+        server_set_id = $auth1
+        client_condition = ${if !eq{$tls_cipher}{}}
+
     plain:
-        driver = plaintext
+        driver = dovecot
         public_name = PLAIN
-        server_set_id = $2
-        server_debug_print = yes
-        server_prompts = :
-        server_condition = \
-                    "${if and { \
-                      {!eq{$2}{}} \
-                      {!eq{$3}{}} \
-                      {crypteq{$3}{\\{sha1\\}${lookup sqlite{SQLITE_DATABASE_FILE \
-                                                SELECT mailboxes.password \
-                                                  FROM mailboxes, domains \
-                                                 WHERE mailboxes.localpart = '${quote_sqlite:${local_part:$auth2}}' \
-                                                   AND domains.fqdn = '${quote_sqlite:${domain:$auth2}}' \
-                                                   AND domains.id = mailboxes.domain_id} \
-                      {$value}fail}} }} {yes}{no}}"
+        server_socket = /var/run/dovecot/auth-client
+        server_set_id = $auth1
         client_condition = ${if !eq{$tls_cipher}{}}

data/lib/smailr/alias.rb

@@ -13,6 +13,8 @@ module Smailr
             destinations.each do |dst|
                 dstlocalpart, dstdomain = dst.split('@')
 
+                puts "Adding alias: #{source} -> #{dst}"
+
                 Model::Alias.find_or_create(:domain       => Model::Domain[:fqdn => srcdomain],
                                             :localpart    => srclocalpart,
                                             :dstdomain    => dstdomain,
@@ -24,6 +26,8 @@ module Smailr
             srclocalpart, srcdomain = source.split('@')
 
             destinations.each do |dst|
+                puts "Removing alias: #{source} -> #{dst}"
+
                 dstlocalpart, dstdomain = dst.split('@')
 
                 Model::Alias.filter(:domain       => Model::Domain[:fqdn => srcdomain],

data/lib/smailr/mailbox.rb

@@ -1,6 +1,8 @@
 module Smailr
     module Mailbox
         def self.add(address, password)
+            puts "Adding mailbox: #{address}"
+
             fqdn = address.split('@')[1]
 
             if not Model::Domain[:fqdn => fqdn]
@@ -20,6 +22,8 @@ module Smailr
         end
 
         def self.rm(address, options)
+            puts "Removing mailbox (from database): #{address}"
+
             mbox = Model::Mailbox.for_address(address)
             mbox.rm_related
             mbox.destroy

data/lib/smailr/model.rb

@@ -31,6 +31,7 @@ module Smailr
 
             def password=(clear)
                 self[:password] = Digest::SHA1.hexdigest(clear)
+                self[:password_scheme] = "{SHA}"
             end
 
             def rm_related

data/lib/smailr.rb

@@ -6,7 +6,7 @@ require 'commander/import'
 require 'fileutils'
 
 module Smailr
-    VERSION = '0.5.5'
+    VERSION = '0.6.1'
 
     autoload :Model,   'smailr/model'
     autoload :Domain,  'smailr/domain'

data/migrations/005_mailboxes_add_digest_identifier_to_passwords.rb

@@ -0,0 +1,27 @@
+Sequel.migration do
+    up do
+        puts <<-MESSAGE
+
+        WARNING ---------------------------------------------------------------------------------
+
+        You need to adapt your mailserver configuration with this version of smailr, as
+        passwords are now stored including the hash scheme.
+
+        Select the hash from `mailboxes.password` and the scheme from `mailboxes.password_scheme`
+
+        --------------------------------------------------------------------------------- WARNING
+
+        MESSAGE
+
+        add_column :mailboxes, :password_scheme, String
+
+        from(:mailboxes).update(password_scheme: "{SHA}")
+
+        alter_table(:mailboxes) do
+            set_column_not_null(:password_scheme)
+        end
+    end
+
+    # Downgrade is not supported, as we would drop necessary information do do effective hashing
+    # in case this feature was already used to add various hashes to the database
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smailr
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.1
 platform: ruby
 authors:
 - Stefan Schlesinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -39,8 +39,8 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |-
-  Smailr is a CLI tool which lets you manage your Exim/Dovecot setup
-                             from the shell. It currently uses SQLite as a backend.
+  Smailr is a CLI tool which lets you manage your virtual mailhosting setup
+                             from the shell. It currently uses SQLite as a backend, samples for Dovecot/Exim provided.
 email: sts@ono.at
 executables:
 - smailr
@@ -48,6 +48,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- bin/commander
+- bin/sequel
 - bin/smailr
 - contrib/dovecot-sql.conf
 - contrib/dovecot.conf
@@ -63,6 +65,7 @@ files:
 - migrations/002_mailboxes.rb
 - migrations/003_aliases.rb
 - migrations/004_dkims.rb
+- migrations/005_mailboxes_add_digest_identifier_to_passwords.rb
 - smailr.yml
 homepage: http://github.com/sts/smailr
 licenses: []
@@ -106,7 +109,7 @@ requirements:
 - Dovecot
 - Debian
 rubyforge_project: 
-rubygems_version: 2.4.4
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Simple MAIL manageR - Virtual mail hosting management from the CLI