smailr 0.6.2 → 0.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 137f8c287a816f8de1cc332745f1b7a7e7c6248d
-  data.tar.gz: 20e72c156dc8fdc41c17778c0436eadbf8187d0b
+SHA256:
+  metadata.gz: 6effb269294c6ec1f81fc25e2e05ee1e3f4ae6d98eef3d44a0fa64e939d8a8bc
+  data.tar.gz: 8a2e12d33594449fdacf111a06a4813e65454b45141af4bd884de25edb5c3c06
 SHA512:
-  metadata.gz: ce459c937af2283a0411329fc04f5369d2894557fb288b3a501d2c20d10ffebf9fbbd382a4d12fd06163f34e25daa395f5789c4b101a4c26b9dd1b8be84ae56e
-  data.tar.gz: 3166aba8a9629e697c316c64e72a938c3c784b150911b784fb2ec39ab28dbf6fcad23ac8979befddd2f48cf1022567d9bdc0b7b3ef71e10a0fcbffd89e495c81
+  metadata.gz: 13a0e5bb2fb7d5d3e0e92c87a774a44750015d6daf8feb579ed1391490893f866ce45ef38d692b8473fc41b024977b476c0fc02c84cf3183b23b33c6107341e8
+  data.tar.gz: 847ef00e13a7d0e5624ad2f5b3609fcdbb94a3170cda4245eb7c4cfc7e23d77460ff8d368f6b4372123af23309f0c867ad7e1ba960932b49b97461db8a78f54e

data/README.md

@@ -157,9 +157,9 @@ automatically. Open mutt for the specified mailbox:
 ### Verify
 
 Smailr generates a report via the Port25 SMTP Verifier. It generates a test,
-sends it to  check-auth-user=eaxmple.comt@verifier.port25.com, which will in
-return generate a echo message with a report about a results from many SMTP
-combonents: SPF, SenderID, DomainKeys, DKIM and Spamassassin.
+sends it to check-auth-user=eaxmple.comt@verifier.port25.com, which will in
+return generate a echo message with a report about results of many SMTP
+components: SPF, SenderID, DomainKeys, DKIM and Spamassassin.
 
 To generate a message, sent from user@example.com and return the report to the
 same address simply call the following command:

data/bin/smailr

@@ -1,241 +1,15 @@
 #!/usr/bin/env ruby
-$: << File.expand_path('../../lib', __FILE__)
-
-require 'smailr'
-
+#$: << File.expand_path('../../lib', __FILE__)
 #
-# CLI Helpers
+#require 'pathname'
+#ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+#  Pathname.new(__FILE__).realpath)
 #
-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 = Smailr.config["password_policy"]["length"]
-    
-    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.to_i
-        say("Too short; try again.")
-        ask_password
-    end
-
-    password
-end
-
-program :version, Smailr::VERSION
-program :description, 'Simple MAIL manageR - 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 DESTINATION', String, 'Specify the alias destination.'
-    c.option  '--password PASSWORD', String, 'The password for a new mailbox. If you omit this option, it prompts for one.'
-    c.option  '--dkim SELECTOR',     String, 'Add a DKIM Key with the specified selector for domain.'
-    c.action do |args, options|
-        address = args[0]
-        type    = determine_object(address)
-
-        case type
-            when :domain
-                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)
-                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 = Smailr::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 SELECTOR',  String, 'Remove a dkim key.' 
-    c.option '--alias DESTINATION', String, 'Specify the destination you want to remove from the alias.'
-    c.action do |args, options|
-        address = args[0]
-        type    = determine_object(address)
-        case type
-            when :domain
-                if options.dkim
-                    selecotr = options.dkim
-                    Smailr::Dkim.rm(address, selector)
-                else
-                    Smailr::Domain.rm(address, options.force)
-                end
-
-            when :address
-                if options.alias
-                    source       = args[0]
-                    destinations = options.alias.split(',')
+#require 'rubygems'
+#require 'bundler/setup'
 
-                    Smailr::Alias.rm(source, destinations)
-                else
-                    Smailr::Mailbox.rm(address, options)
-                end
-        end
-    end
-end
-
-command :passwd do |c|
-    c.syntax  = 'smailr passwd mailbox'
-    c.summary = 'Update a users password.'
-    c.action do |args,options|
-        address  = args[0]
-        password = ask_password
-        Smailr::Mailbox.update_password(address, password)
-    end
-end
-
-
-command :setup do |c|
-    c.syntax  = 'smailr setup'
-    c.summary = 'Install all required components on a mailserver'
-    c.action do |args,options|
-        Smailr::Setup.run
-    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 Smailr::DB
-
-        if options.version.nil?
-            Sequel::Migrator.apply(Smailr::DB, Smailr.migrations_directory)
-        else
-            Sequel::Migrator.apply(Smailr::DB, Smailr.migrations_directory, :target => options.version.to_i)
-        end
-    end
-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 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 $?
-
-          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
-
-command :verify do |c|
-    c.syntax      = "smailr verify address"
-    c.summary     = "Send out a test message to verify a domains configuration via verifier.port25.com"
-    c.description = "A reply email will be sent back to you with an analysis of the message’s authentication" +
-                    "status.  The report will perform the following checks: SPF, SenderID, DomainKeys, DKIM " +
-                    "and Spamassassin.\n\n"
-    c.example       'Verify test@example.com (report will be sent to test@example.com)', 'smailr verify test@example.com'
-    c.example       'Verify test@example.com, send report to root@example.com', 'smailr verify test@example.com --report-to root@example.com'
-
-    c.option        '-r DESTINATION', '--report-to DESTINATION', String, 'Send the report to the specified address instead.'
-
-    c.action do |args,options|
-        from = args[0]
-        options.default :report_to => from
-
-        dstlocalpart, dstfqdn = options.report_to.split('@')
-
-        require 'socket'
-        require 'date'
-        require 'net/smtp'
-        Net::SMTP.start('localhost', 25) do |smtp|
-            to = "check-auth-#{dstlocalpart}=#{dstfqdn}@verifier.port25.com"
-
-            message = [
-                "From: #{from}",
-                "To: #{to}",
-                "Subject: Port25 Mail Verification Test",
-                "Date: #{DateTime.now.strftime("%a, %d %b %Y %H:%M:%S %z")}",
-                "",
-                "This is a test message for the port25 mail verification test, it was",
-                "sent from the following server: #{Socket.gethostname}."
-            ].join("\r\n")
+require 'smailr'
+require 'smailr/cli'
+require 'smailr/setup'
 
-            smtp.send_message(message, from, to)
-        end
-    end
-end
+Smailr::Cli.new.run

data/lib/smailr/alias.rb

@@ -1,40 +1,39 @@
 module Smailr
-    module Alias
-        def self.add(source, destinations)
-            srclocalpart, srcdomain = source.split('@')
+  class Alias
+    def self.add(source, destinations)
+      srclocalpart, srcdomain = source.split('@')
 
-            # We don't want aliases for non-local domains, since the
-            # exim router won't accept it.
-            if not Model::Domain[:fqdn => srcdomain].exists?
-                say_error "You are trying to add an alias for a non-local domain: #{source}"
-                exit 1
-            end
+      # We don't want aliases for non-local domains, since the
+      # exim router won't accept it.
+      if not Model::Domain[:fqdn => srcdomain].exists?
+        raise MissingDomain, "You are trying to add an alias for a non existing domain: #{source}"
+      end
 
-            destinations.each do |dst|
-                dstlocalpart, dstdomain = dst.split('@')
+      destinations.each do |dst|
+        dstlocalpart, dstdomain = dst.split('@')
 
-                puts "Adding alias: #{source} -> #{dst}"
+        Smailr::logger.warn("Adding alias: #{source} -> #{dst}")
 
-                Model::Alias.find_or_create(:domain       => Model::Domain[:fqdn => srcdomain],
-                                            :localpart    => srclocalpart,
-                                            :dstdomain    => dstdomain,
-                                            :dstlocalpart => dstlocalpart)
-            end
-        end
+        Model::Alias.find_or_create(:domain       => Model::Domain[:fqdn => srcdomain],
+                                    :localpart    => srclocalpart,
+                                    :dstdomain    => dstdomain,
+                                    :dstlocalpart => dstlocalpart)
+      end
+    end
 
-        def self.rm(source, destinations)
-            srclocalpart, srcdomain = source.split('@')
+    def self.rm(source, destinations)
+      srclocalpart, srcdomain = source.split('@')
 
-            destinations.each do |dst|
-                puts "Removing alias: #{source} -> #{dst}"
+      destinations.each do |dst|
+        Smailr::logger.warn("Removing alias: #{source} -> #{dst}")
 
-                dstlocalpart, dstdomain = dst.split('@')
+        dstlocalpart, dstdomain = dst.split('@')
 
-                Model::Alias.filter(:domain       => Model::Domain[:fqdn => srcdomain],
-                                    :localpart    => srclocalpart,
-                                    :dstdomain    => dstdomain,
-                                    :dstlocalpart => dstlocalpart).delete
-            end
-        end
+        Model::Alias.filter(:domain       => Model::Domain[:fqdn => srcdomain],
+                            :localpart    => srclocalpart,
+                            :dstdomain    => dstdomain,
+                            :dstlocalpart => dstlocalpart).delete
+      end
     end
+  end
 end

data/lib/smailr/cli.rb

@@ -0,0 +1,276 @@
+require 'commander'
+
+class String
+  def unindent
+    gsub(/^#{scan(/^\s*/).min_by{|l|l.length}}/, "")
+  end
+end
+
+module Smailr
+  class Cli
+
+    include Commander::Methods
+
+    ## Our own CLI Helpers
+
+    # Determine whether we the passed string is a domain or a mail
+    # address.
+    #
+    # Returns either :domain or :address
+    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
+
+    # Run an interactive cli dialog to enter and confirm a password.
+    #
+    # Returns a string containing the entered password if password and
+    # confirmation match.
+    def ask_password
+        min_password_length = Smailr.config["password_policy"]["length"]
+
+        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.to_i
+            say("Too short; try again.")
+            ask_password
+        end
+
+        password
+    end
+
+    # Initialize the Cli
+    def run
+      program :description, 'smailr - Virtual Mail Hosting Management CLI'
+      program :version, Smailr::VERSION
+
+      ### 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 mail'
+        c.option  '--alias DESTINATION', String, 'Specify the alias destination.'
+        c.option  '--password PASSWORD', String, 'The password for a new mailbox. If you omit this option, it prompts for one.'
+        c.option  '--dkim SELECTOR',     String, 'Add a DKIM Key with the specified selector for domain.'
+        c.action do |args, options|
+          address = args[0]
+          type    = determine_object(address)
+
+          case type
+            when :domain
+              if options.dkim
+                selector = options.dkim
+                key = Smailr::Dkim.add(address, selector)
+                key_fmt = key.split("\n").slice(1..-2).join
+
+                puts <<-EOM.unindent
+                .
+                  DKIM is active now, please setup domainkey records in zone #{address}:
+
+                          _domainkey IN TXT "t=y\; o=~\;"
+                  #{selector}._domainkey IN TXT "v=DKIM1\; t=y\; k=rsa\; p=#{key_fmt}
+                .
+                EOM
+              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 and aliases 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 = Smailr::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 SELECTOR',  String, 'Remove a dkim key.' 
+        c.option '--alias DESTINATION', String, 'Specify the destination you want to remove from the alias.'
+        c.action do |args, options|
+          address = args[0]
+          type    = determine_object(address)
+          case type
+          when :domain
+            if options.dkim
+              selector = options.dkim
+              Smailr::Dkim.rm(address, selector)
+            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 :passwd do |c|
+        c.syntax  = 'smailr passwd mailbox'
+        c.summary = 'Update a users password.'
+        c.action do |args,options|
+          address  = args[0]
+          password = ask_password
+          Smailr::Mailbox.update_password(address, password)
+        end
+      end
+
+
+      command :setup do |c|
+        c.syntax  = 'smailr setup'
+        c.summary = 'Install all required components on a mailserver'
+        c.action do |args,options|
+          Smailr::Setup.new.run
+        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 Smailr::DB
+
+          if options.to.nil?
+            if Sequel::Migrator.is_current?(Smailr::DB, Smailr.migrations_directory)
+              puts "Database schema already up to date. Exiting"
+              exit 0
+            end
+
+            puts "Running database migrations to latest version."
+            Sequel::Migrator.apply(Smailr::DB, Smailr.migrations_directory)
+          else
+            puts "Running database migrations to version: #{options.to}"
+            Sequel::Migrator.apply(Smailr::DB, Smailr.migrations_directory, options.to.to_i)
+          end
+        end
+      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 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 $?
+
+            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
+
+      command :verify do |c|
+        c.syntax      = "smailr verify address"
+        c.summary     = "Send out a test message to verify a domains configuration via verifier.port25.com"
+        c.description = "A reply email will be sent back to you with an analysis of the message’s authentication" +
+          "status.  The report will perform the following checks: SPF, SenderID, DomainKeys, DKIM " +
+          "and Spamassassin.\n\n"
+        c.example       'Verify test@example.com (report will be sent to test@example.com)', 'smailr verify test@example.com'
+        c.example       'Verify test@example.com, send report to root@example.com', 'smailr verify test@example.com --report-to root@example.com'
+
+        c.option        '-r DESTINATION', '--report-to DESTINATION', String, 'Send the report to the specified address instead.'
+
+        c.action do |args,options|
+          from = args[0]
+          options.default :report_to => from
+
+          dstlocalpart, dstfqdn = options.report_to.split('@')
+
+          require 'socket'
+          require 'date'
+          require 'net/smtp'
+          Net::SMTP.start('localhost', 25) do |smtp|
+            to = "check-auth-#{dstlocalpart}=#{dstfqdn}@verifier.port25.com"
+
+            message = [
+              "From: #{from}",
+              "To: #{to}",
+              "Subject: Port25 Mail Verification Test",
+                "Date: #{DateTime.now.strftime("%a, %d %b %Y %H:%M:%S %z")}",
+              "",
+                "This is a test message for the port25 mail verification test, it was",
+                "sent from the following server: #{Socket.gethostname}."
+            ].join("\r\n")
+
+            smtp.send_message(message, from, to)
+          end
+        end
+      end
+
+      run!
+    end
+  end
+end

data/lib/smailr/dkim.rb

@@ -1,37 +1,33 @@
-require 'date'
-require 'openssl'
-
 module Smailr
-    module Dkim
-        def self.add(fqdn, selector)
-            if not Model::Domain[:fqdn => fqdn]
-                say_error "You trying to add a DKIM key for a non existing domain: #{fqdn}"
-                exit 1
-            end
+  class Dkim
+    def self.add(fqdn, selector)
+      unless Model::Domain[:fqdn => fqdn]
+        raise MissingDomain, "You trying to add a DKIM key for a non existing domain: #{fqdn}"
+      end
 
-            private_key, public_key = generate_rsa_key
+      private_key, public_key = generate_rsa_key
 
-            dkim = Model::Dkim.for_domain!(fqdn, selector)
-            dkim.private_key = private_key
-            dkim.public_key  = public_key
-            dkim.selector    = selector
-            dkim.save
+      dkim = Model::Dkim.for_domain!(fqdn, selector)
+      dkim.private_key = private_key
+      dkim.public_key  = public_key
+      dkim.selector    = selector
+      dkim.save
 
-            # Return the key so it can be used for automation
-            dkim.public_key
-        end
+      # Return the key so it can be used for automation
+      dkim.public_key
+    end
 
-        def self.rm(fqdn, selector)
-            dkim = Model::Dkim.for_domain(fqdn, selector)
-            dkim.destroy
-        end
+    def self.rm(fqdn, selector)
+      dkim = Model::Dkim.for_domain(fqdn, selector)
+      dkim.destroy
+    end
 
-        private
+    private
 
-            def self.generate_rsa_key(length = 1024)
-                rsa_key     = OpenSSL::PKey::RSA.new(length)
-                [ rsa_key.to_pem,
-                  rsa_key.public_key.to_pem ]
-            end
+    def self.generate_rsa_key(length = 1024)
+      rsa_key = OpenSSL::PKey::RSA.new(length)
+      [ rsa_key.to_pem,
+        rsa_key.public_key.to_pem ]
     end
+  end
 end

data/lib/smailr/domain.rb

@@ -1,18 +1,17 @@
 module Smailr
-    module Domain
-        def self.add(fqdn)
-            puts "Adding domain: #{fqdn}"
-            Model::Domain.create(:fqdn => fqdn)
-        end
-
-        def self.rm(fqdn, force = false)
-            if force or
-                agree("Do you want to remove the domain #{fqdn} and all related items? (yes/no) ")
+  class Domain
+    def self.add(fqdn)
+      Smailr::logger.warn("Adding domain: #{fqdn}")
+      Model::Domain.create(:fqdn => fqdn)
+    end
 
-                domain = Model::Domain[:fqdn => fqdn]
-                domain.rm_related
-                domain.destroy
-            end
-        end
+    def self.rm(fqdn, force = false)
+      # TODO - only require force, if related entries exist
+      if force
+        domain = Model::Domain[:fqdn => fqdn]
+        domain.rm_related
+        domain.destroy
+      end
     end
+  end
 end

data/lib/smailr/mailbox.rb

@@ -1,32 +1,31 @@
 module Smailr
-    module Mailbox
-        def self.add(address, password)
-            puts "Adding mailbox: #{address}"
+  class Mailbox
+    def self.add(address, password)
+      Smailr::logger.warn("Adding mailbox: #{address}")
 
-            fqdn = address.split('@')[1]
+      fqdn = address.split('@')[1]
 
-            if not Model::Domain[:fqdn => fqdn]
-                say_error "Trying to add a mailbox for a non existing domain: #{fqdn}"
-                exit 1
-            end
+      if not Model::Domain[:fqdn => fqdn]
+        raise MissingDomain, "Trying to add a mailbox for a non existing domain: #{fqdn}"
+      end
 
-            mbox = Model::Mailbox.for_address!(address)
-            mbox.password = password
-            mbox.save
-        end
+      mbox = Model::Mailbox.for_address!(address)
+      mbox.password = password
+      mbox.save
+    end
 
-        def self.update_password(address, password)
-            mbox = Model::Mailbox.for_address(address)
-            mbox.password = password
-            mbox.save
-        end
+    def self.update_password(address, password)
+      mbox = Model::Mailbox.for_address(address)
+      mbox.password = password
+      mbox.save
+    end
 
-        def self.rm(address, options)
-            puts "Removing mailbox (from database): #{address}"
+    def self.rm(address, options)
+      Smailr::logger.warn("Removing mailbox (from database): #{address}")
 
-            mbox = Model::Mailbox.for_address(address)
-            mbox.rm_related
-            mbox.destroy
-        end
+      mbox = Model::Mailbox.for_address(address)
+      mbox.rm_related
+      mbox.destroy
     end
+  end
 end

data/lib/smailr/model.rb

@@ -1,68 +1,74 @@
-require 'digest/sha1'
+require 'bcrypt'
 
 module Smailr
-    module Model
-        class Domain < Sequel::Model
-            one_to_many :mailboxes
-            one_to_many :aliases
-            one_to_many :dkims
+  module Model
+    class Domain < Sequel::Model
+      one_to_many :mailboxes
+      one_to_many :aliases
+      one_to_many :dkims
 
-            def rm_related
-                self.remove_all_mailboxes
-                self.remove_all_aliases
-                self.remove_all_dkims
-            end
-        end
+      def rm_related
+        self.remove_all_mailboxes
+        self.remove_all_aliases
+        self.remove_all_dkims
+      end
+    end
+
+    class Dkim < Sequel::Model
+      many_to_one :domain
 
-        class Dkim < Sequel::Model
-            many_to_one :domain
+      def self.for_domain(fqdn, selector)
+        self[:domain => Domain[:fqdn => fqdn], :selector => selector]
+      end
 
-            def self.for_domain(fqdn, selector)
-                self[:domain => Domain[:fqdn => fqdn], :selector => selector]
-            end
+      def self.for_domain!(fqdn, selector)
+        find_or_create(:domain => Domain[:fqdn => fqdn], :selector => selector)
+      end
+    end
 
-            def self.for_domain!(fqdn, selector)
-                find_or_create(:domain => Domain[:fqdn => fqdn], :selector => selector)
-            end
-         end
+    class Mailbox < Sequel::Model
+      many_to_one :domain
 
-        class Mailbox < Sequel::Model
-            many_to_one :domain
+      def password=(clear)
+        crypted = BCrypt::Password.create(
+          clear,
+          cost: BCrypt::Engine::DEFAULT_COST,
+          salt: BCrypt::Engine.generate_salt
+        )
 
-            def password=(clear)
-                self[:password] = Digest::SHA1.hexdigest(clear)
-                self[:password_scheme] = "{SHA}"
-            end
+        self[:password_scheme] = '{BLF-CRYPT}'
+        self[:password] = crypted
+      end
 
-            def rm_related
-                self.aliases.destroy
-            end
+      def rm_related
+        self.aliases.destroy
+      end
 
-            def aliases
-                Model::Alias.where(
-                    :dstlocalpart => self.localpart,
-                    :dstdomain   => self.domain.fqdn
-                )
-            end
+      def aliases
+        Model::Alias.where(
+          :dstlocalpart => self.localpart,
+          :dstdomain   => self.domain.fqdn
+        )
+      end
 
-            def self.domain(fqdn)
-                Domain[:fqdn => fqdn]
-            end
+      def self.domain(fqdn)
+        Domain[:fqdn => fqdn]
+      end
 
-            def self.for_address(address)
-                localpart, fqdn = address.split('@')
-                self[:localpart => localpart, :domain => domain(fqdn)]
-            end
+      def self.for_address(address)
+        localpart, fqdn = address.split('@')
+        self[:localpart => localpart, :domain => domain(fqdn)]
+      end
 
-            def self.for_address!(address)
-                localpart, fqdn = address.split('@')
-                find_or_create(:localpart => localpart, :domain => domain(fqdn))
-            end
+      def self.for_address!(address)
+        localpart, fqdn = address.split('@')
+        find_or_create(:localpart => localpart, :domain => domain(fqdn))
+      end
 
-        end
+    end
 
-        class Alias < Sequel::Model
-            many_to_one :domain
-        end
+    class Alias < Sequel::Model
+      many_to_one :domain
     end
+  end
 end

data/lib/smailr/setup.rb

@@ -1,6 +1,10 @@
+require 'commander'
+
 module Smailr
-    module Setup
-        def self.run
+    class Setup
+        include Commander::Methods
+
+        def run
 
             if Process.euid != 0
                 say "ERROR: YOU ARE NOT RUNNING THIS SCRIPT WITH ROOT PRIVILEGES, EXITING."

data/lib/smailr/version.rb

@@ -0,0 +1,3 @@
+module Smailr
+  VERSION = '0.8.1'
+end

data/lib/smailr.rb

@@ -1,47 +1,72 @@
 require 'rubygems'
-require 'yaml'
-require 'sqlite3'
-require 'sequel'
-require 'commander/import'
+require 'smailr/version'
+
 require 'fileutils'
+require 'logger'
+require 'sequel'
+require 'sqlite3'
+require 'yaml'
+
+# dkim
+require 'date'
+require 'openssl'
+
+require 'smailr/alias'
+require 'smailr/dkim'
+require 'smailr/domain'
+require 'smailr/mailbox'
 
 module Smailr
-    VERSION = '0.6.2'
-
-    autoload :Model,   'smailr/model'
-    autoload :Domain,  'smailr/domain'
-    autoload :Mailbox, 'smailr/mailbox'
-    autoload :Alias,   'smailr/alias'
-    autoload :Dkim,    'smailr/dkim'
-    autoload :Setup,   'smailr/setup'
-
-    class << self;
-        attr_accessor :config
-        attr_accessor :config_files
-        attr_accessor :load_config
-        attr_accessor :contrib_directory
-        attr_accessor :migrations_directory
-    end
 
-    def self.load_config
-        config = {}
-        config_files.each do |f|
-            if File.readable?(f)
-                config.merge!(YAML.load_file(f))
-            end
-        end
-        self.config = config
-    end
+  # Exception Classes
+  class MissingDomain < StandardError ; end
 
-    def self.db_connect
-        Sequel.connect(self.config['database'])
+  class << self;
+    attr_accessor :config
+    attr_accessor :config_files
+    attr_accessor :load_config
+    attr_accessor :contrib_directory
+    attr_accessor :migrations_directory
+  end
+
+  def self.load_config
+    config = {}
+    config_files.each do |f|
+      if File.readable?(f)
+        config.merge!(YAML.load_file(f))
+      end
     end
+    self.config = config
+  end
+
+  def self.db_connect
+    Sequel.connect(self.config['database'])
+  end
 
+  def self.logger
+    unless @logger
+      @logger = Logger.new(STDOUT)
+      @logger.level = Logger::Severity::DEBUG
+      @logger.formatter = proc do |severity, datetime, progname, msg|
+        if severity == "ERROR"
+            "ERROR: #{msg}\n"
+        else
+            "#{msg}\n"
+        end
+      end
+    end
+    @logger
+  end
 
+  def self.logger=(logger)
+    @logger = logger
+  end
 end
 
-Smailr.contrib_directory    ||=   File.expand_path('../../contrib', __FILE__)
-Smailr.migrations_directory ||=   File.expand_path('../../migrations', __FILE__)
-Smailr.config_files         ||=  [ File.expand_path('../../smailr.yml', __FILE__),  '/etc/smailr.yml']
+Smailr.contrib_directory    ||= File.expand_path('../../contrib', __FILE__)
+Smailr.migrations_directory ||= File.expand_path('../../migrations', __FILE__)
+Smailr.config_files         ||= [ File.expand_path('../../smailr.yml', __FILE__),  '/etc/smailr.yml']
 Smailr.load_config
 Smailr::DB = Smailr::db_connect
+require 'smailr/model'
+Smailr::DB.sql_log_level = :debug

data/migrations/005_mailboxes_add_digest_identifier_to_passwords.rb

@@ -1,27 +1,27 @@
 Sequel.migration do
-    up do
-        puts <<-MESSAGE
+  up do
+    puts <<-MESSAGE
 
-        WARNING ---------------------------------------------------------------------------------
+    WARNING ---------------------------------------------------------------------------------
 
-        You need to adapt your mailserver configuration with this version of smailr, as
-        passwords are now stored including the hash scheme.
+    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`
+    Select the hash from `mailboxes.password` and the scheme from `mailboxes.password_scheme`
 
-        --------------------------------------------------------------------------------- WARNING
+    --------------------------------------------------------------------------------- WARNING
 
-        MESSAGE
+    MESSAGE
 
-        add_column :mailboxes, :password_scheme, String
+    add_column :mailboxes, :password_scheme, String
 
-        from(:mailboxes).update(password_scheme: "{SHA}")
+    from(:mailboxes).update(password_scheme: "{SHA}")
 
-        alter_table(:mailboxes) do
-            set_column_not_null(:password_scheme)
-        end
+    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
+  # 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

data/migrations/006_mailboxes_password_schema_allow_null.rb

@@ -0,0 +1,12 @@
+Sequel.migration do
+    up do
+        # Remove this until we figured out whats wrong with error handling
+        # and we can do it for all fields
+        alter_table(:mailboxes) do
+            set_column_allow_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,17 +1,64 @@
 --- !ruby/object:Gem::Specification
 name: smailr
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.8.1
 platform: ruby
 authors:
 - Stefan Schlesinger
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2026-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bcrypt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: net-smtp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,13 +72,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sequel
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-mock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -48,27 +109,29 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- bin/commander
-- bin/sequel
 - bin/smailr
 - contrib/dovecot-sql.conf
 - contrib/dovecot.conf
 - contrib/exim4.conf
 - lib/smailr.rb
 - lib/smailr/alias.rb
+- lib/smailr/cli.rb
 - lib/smailr/dkim.rb
 - lib/smailr/domain.rb
 - lib/smailr/mailbox.rb
 - lib/smailr/model.rb
 - lib/smailr/setup.rb
+- lib/smailr/version.rb
 - migrations/001_domains.rb
 - migrations/002_mailboxes.rb
 - migrations/003_aliases.rb
 - migrations/004_dkims.rb
 - migrations/005_mailboxes_add_digest_identifier_to_passwords.rb
+- migrations/006_mailboxes_password_schema_allow_null.rb
 - smailr.yml
 homepage: http://github.com/sts/smailr
-licenses: []
+licenses:
+- Apache-2.0
 metadata: {}
 post_install_message: |2+
 
@@ -81,7 +144,7 @@ post_install_message: |2+
 
     * Install Dovecot with SQlite support
 
-    * run export PATH="/var/lib/gems/1.8/bin:${PATH}"
+    * run ln -s `gem contents smailr|grep bin/smailr` /usr/local/sbin
 
     * run "smailr setup" to create exim, dovecot and smailr configuration (you
       can edit the configuration in an editor window before everyting is
@@ -107,10 +170,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements:
 - Exim
 - Dovecot
-- Debian
-rubyforge_project: 
-rubygems_version: 2.4.6
-signing_key: 
+rubygems_version: 4.0.6
 specification_version: 4
 summary: Simple MAIL manageR - Virtual mail hosting management from the CLI
 test_files: []
+...

data/bin/commander

@@ -1,16 +0,0 @@
-#!/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

@@ -1,16 +0,0 @@
-#!/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')