postfix_admin 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 03fe6501c97e53bf66c3fa2f783e8b2e40cc18da
-  data.tar.gz: 0a7c400bee5d1f953ea9f2d03475b8c1e182653f
+  metadata.gz: afa77157060260499b49c44b35270deaf01ffde5
+  data.tar.gz: 00bc7f9dfb7e8b6b628b9dbe0b3660b6f6d52828
 SHA512:
-  metadata.gz: b976ae17e338b7bd8154a092bb1d9ed91274b3cb1f008fc1d98e0b55b045dd28966e1d912cd35315bd75ce3005d2bad2e286d29d869967038e461c6867ad31e2
-  data.tar.gz: 56b944669124660d726addfcd2258543845b61170ea68cae3189d7ff87b45e4d2809ba2a0bfbea274d8338ada8e10e64408e672713531043614c28dd6bc07275
+  metadata.gz: 3a82010397e072cfd3ab056a908b943ebc5f0aff711977944768e32fdf60ae7dd81651416a08e97fcd27114ed230ffacb9ebb3e1c4790719c1a3ecf801ef8bf2
+  data.tar.gz: 89bea8924bb55e225d4b286c28f10c97e5a8218481896fab6c6c8e2359171dc5391d334ad44bec814bc9214d76f1a50c7b459e2589194aaa0322a9a3f947b964

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.1.2
+ * Support password hash by doveadm (external command)
+ * Show active status
+ * Don't show passwords using list format
+
+## 0.1.1, release 2013-05-10
+ * Fixed string length of password
+
+

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/postfix_admin.png)](https://rubygems.org/gems/postfix_admin)
+
 # PostfixAdmin
 
 Command Line Tools of Postfix Admin
@@ -26,23 +28,29 @@ List the postfix_admin subcommands as:
     $ postfix_admin
 
 ```
-  postfix_admin account_passwd user@example.com new_password    # Change password of account
-  postfix_admin add_account user@example.com password           # Add an account
-  postfix_admin add_admin admin@example.com password            # Add an admin user
-  postfix_admin add_admin_domain admin@example.com example.com  # Add admin_domain
-  postfix_admin add_alias alias@example.com goto@example.net    # Add an alias
-  postfix_admin add_domain example.com                          # Add a domain
-  postfix_admin admin_passwd admin@example.com new_password     # Change password of admin
-  postfix_admin delete_account user@example.com                 # Delete an account
-  postfix_admin delete_admin admin@example.com                  # Delete an admin
-  postfix_admin delete_alias alias@example.com                  # Delete an alias
-  postfix_admin delete_domain example.com                       # Delete a domain
-  postfix_admin help [TASK]                                     # Describe available tasks or one specific task
-  postfix_admin setup example.com password                      # Setup a domain
-  postfix_admin show                                            # List of domains
-  postfix_admin summary [example.com]                           # Summarize the usage of PostfixAdmin
-  postfix_admin super_admin admin@example.com                   # Enable super admin flag of an admin
-  postfix_admin version                                         # Show postfix_admin version
+Commands:
+  postfix_admin account_passwd user@example.com new_password               # Change password of account
+  postfix_admin add_account user@example.com password                      # Add an account
+  postfix_admin add_admin admin@example.com password                       # Add an admin user
+  postfix_admin add_admin_domain admin@example.com example.com             # Add admin_domain
+  postfix_admin add_alias alias@example.com goto@example.net               # Add an alias
+  postfix_admin add_domain example.com                                     # Add a domain
+  postfix_admin admin_passwd admin@example.com new_password                # Change password of admin
+  postfix_admin delete_account user@example.com                            # Delete an account
+  postfix_admin delete_admin admin@example.com                             # Delete an admin
+  postfix_admin delete_admin_domain admin@example.com example.com          # Delete admin_domain
+  postfix_admin delete_alias alias@example.com                             # Delete an alias
+  postfix_admin delete_domain example.com                                  # Delete a domain
+  postfix_admin dump                                                       # Dump all data
+  postfix_admin edit_account user@example.com                              # Edit an account
+  postfix_admin edit_domain example.com                                    # Edit a domain limitation
+  postfix_admin help [COMMAND]                                             # Describe available commands or one specific command
+  postfix_admin schemes                                                    # List all supported password schemes
+  postfix_admin setup example.com password                                 # Setup a domain
+  postfix_admin show [example.com | admin@example.com | user@example.com]  # Show domains or admins or mailboxes
+  postfix_admin summary [example.com]                                      # Summarize the usage of PostfixAdmin
+  postfix_admin super_admin admin@example.com                              # Enable super admin flag of an admin
+  postfix_admin version                                                    # Show postfix_admin version
 ```
 
 ## Contributing

data/lib/postfix_admin/base.rb

@@ -12,16 +12,26 @@ module PostfixAdmin
       'database'  => 'mysql://postfix:password@localhost/postfix',
       'aliases'   => 30,
       'mailboxes' => 30,
-      'maxquota'  => 100
+      'maxquota'  => 100,
+      'scheme'    => 'CRAM-MD5',
     }
 
     def initialize(config)
       db_setup(config['database'])
+      if local_part_required?
+        eval <<"EOS"
+class ::PostfixAdmin::Mailbox
+    property :local_part, String
+end
+EOS
+        DataMapper.finalize
+      end
       @config = {}
       @config[:aliases]   = config['aliases']   || 30
       @config[:mailboxes] = config['mailboxes'] || 30
       @config[:maxquota]  = config['maxquota']  || 100
       @config[:mailbox_quota] = @config[:maxquota] * KB_TO_MB
+      @config[:scheme]    = config['scheme']    || 'CRAM-MD5'
     end
 
     def db_setup(database)
@@ -56,6 +66,8 @@ module PostfixAdmin
     end
 
     def add_admin(username, password)
+      password_check(password)
+
       if Admin.exist?(username)
         raise Error, "#{username} is already resistered as admin."
       end
@@ -69,7 +81,10 @@ module PostfixAdmin
       end
     end
 
-    def add_account(address, password)
+    def add_account(address, password, in_name=nil)
+      name = in_name || ''
+      password_check(password)
+
       if address !~ /.+\@.+\..+/
         raise Error, "Invalid mail address #{address}"
       end
@@ -88,14 +103,20 @@ module PostfixAdmin
       domain.aliases << Alias.mailbox(address)
 
       mailbox = Mailbox.new
-      mailbox.attributes = {
+      attributes = {
         :username => address,
         :password => password,
-        :name     => '',
+        :name     => name,
         :maildir  => path,
         :quota    => @config[:mailbox_quota],
-        # :local_part => user,
       }
+
+      if local_part_required?
+        attributes[:local_part] = user
+      end
+
+      mailbox.attributes = attributes
+
       domain.mailboxes << mailbox
       unless domain.save
         raise "Could not save Mailbox and Domain #{mailbox.errors.map{|e| e.to_s}.join} #{domain.errors.map{|e| e.to_s}.join}"
@@ -197,10 +218,18 @@ module PostfixAdmin
 
     private
 
+    # postfixadmin DB upgrade Number 495 loca_part added
+    def local_part_required?
+      Config.first.value.to_i >= 495
+    end
+
     def admin_domain_check(user_name, domain_name)
       raise Error, "#{user_name} is not resistered as admin." unless Admin.exist?(user_name)
       raise Error, "Could not find domain #{domain_name}"     unless Domain.exist?(domain_name)
     end
 
+    def password_check(password)
+      raise Error, "Empty password" if password.nil? || password.empty?
+    end
   end
 end

data/lib/postfix_admin/cli.rb

@@ -1,5 +1,6 @@
 require 'yaml'
 require 'postfix_admin'
+require 'postfix_admin/doveadm'
 
 module PostfixAdmin
   class CLI
@@ -23,7 +24,16 @@ module PostfixAdmin
       name = name.downcase if name
 
       if name =~ /@/
-        show_account(name)
+        if Admin.exist?(name)
+          show_admin_details(name)
+        end
+
+        if Mailbox.exist?(name)
+          show_account_details(name)
+        elsif Alias.exist?(name)
+          show_alias_details(name)
+        end
+
         return
       end
 
@@ -69,21 +79,44 @@ module PostfixAdmin
       add_admin_domain(admin, domain_name)
     end
 
-    def show_account(user_name)
+    def show_account_details(user_name)
       account_check(user_name)
       mailbox    = Mailbox.find(user_name)
       mail_alias = Alias.find(user_name)
 
       report("Mailbox") do
         puts "Address  : %s" % mailbox.username
+        puts "Name     : %s" % mailbox.name
         puts "Password : %s" % mailbox.password
         puts "Quota    : %d MB" % max_str(mailbox.quota / KB_TO_MB)
         puts "Go to    : %s" % mail_alias.goto
+        puts "Active   : %s" % mailbox.active_str
+      end
+    end
+
+    def show_admin_details(name)
+      admin_check(name)
+      admin = Admin.find(name)
+
+      report("Admin") do
+        puts "Name     : %s" % admin.username
+        puts "Password : %s" % admin.password
+        puts "Active   : %s" % admin.active_str
+      end
+    end
+
+    def show_alias_details(name)
+      alias_check(name)
+      mail_alias = Alias.find(name)
+      report("Alias") do
+        puts "Address  : %s" % mail_alias.address
+        puts "Go to    : %s" % mail_alias.goto
+        puts "Active   : %s" % mail_alias.active_str
       end
     end
 
     def show_domain
-      index = " No. Domain                          Aliases   Mailboxes     Quota (MB)"
+      index = " No. Domain                          Aliases   Mailboxes     Quota (MB)  Active"
       report('Domains', index) do
         if Domain.all_without_special_domain.empty?
           puts " No domains"
@@ -91,9 +124,9 @@ module PostfixAdmin
         end
 
         Domain.all_without_special_domain.each_with_index do |d, i|
-          puts "%4d %-30s %3d /%3s   %3d /%3s %10d" %
+          puts "%4d %-30s %3d /%3s   %3d /%3s %10d         %-3s" %
             [i+1, d.domain_name, d.num_total_aliases, max_str(d.maxaliases),
-             d.mailboxes.count, max_str(d.maxmailboxes), d.maxquota]
+             d.mailboxes.count, max_str(d.maxmailboxes), d.maxquota, d.active_str]
         end
       end
 
@@ -143,7 +176,7 @@ module PostfixAdmin
 
     def show_admin(domain_name=nil)
       admins = domain_name ? Admin.select{|a| a.has_domain?(domain_name)} : Admin.all
-      index = " No. Admin                                        Domains Password"
+      index = " No. Admin                                        Domains Active"
       report("Admins", index) do
         if admins.empty?
           puts " No admins"
@@ -152,7 +185,7 @@ module PostfixAdmin
 
         admins.each_with_index do |a, i|
           domains = a.super_admin? ? 'Super admin' : a.domains.count
-          puts "%4d %-40s %11s %s" % [i+1, a.username, domains, a.password]
+          puts "%4d %-40s %11s   %-3s" % [i+1, a.username, domains, a.active_str]
         end
       end
 
@@ -162,7 +195,7 @@ module PostfixAdmin
       domain_check(domain_name)
 
       mailboxes = Domain.find(domain_name).mailboxes
-      index = " No. Email                                     Quota (MB) Password        Maildir"
+      index = " No. Email                           Name                 Quota (MB) Active         Maildir"
       report("Addresses", index) do
         if mailboxes.empty?
           puts " No addresses"
@@ -171,7 +204,7 @@ module PostfixAdmin
 
         mailboxes.each_with_index do |m, i|
           quota = m.quota.to_f/ KB_TO_MB.to_f
-          puts "%4d %-40s  %10s %-15s %s" % [i+1, m.username, max_str(quota.to_i), m.password, m.maildir]
+          puts "%4d %-30s  %-20s %10s   %-3s  %s" % [i+1, m.username, m.name, max_str(quota.to_i), m.active_str, m.maildir]
         end
       end
 
@@ -204,9 +237,10 @@ module PostfixAdmin
       end
     end
 
-    def add_admin(user_name, password, super_admin=false)
+    def add_admin(user_name, password, super_admin=false, scheme=nil)
       validate_password(password)
-      @base.add_admin(user_name, password)
+
+      @base.add_admin(user_name, hashed_password(password, scheme))
       if super_admin
         Admin.find(user_name).super_admin = true
         puts_registered(user_name, "a super admin")
@@ -225,10 +259,12 @@ module PostfixAdmin
       puts "#{domain_name} was successfully deleted from #{user_name}"
     end
 
-    def add_account(address, password)
+    def add_account(address, password, scheme=nil, name=nil)
       validate_password(password)
-      @base.add_account(address, password)
+
+      @base.add_account(address, hashed_password(password, scheme), name)
       puts_registered(address, "an account")
+      show_account_details(address)
     end
 
     def add_alias(address, goto)
@@ -239,11 +275,12 @@ module PostfixAdmin
     def edit_account(address, options)
       mailbox_check(address)
       mailbox = Mailbox.find(address)
+      mailbox.name = options[:name] if options[:name]
       mailbox.quota = options[:quota] * KB_TO_MB if options[:quota]
       mailbox.save or raise "Could not save Mailbox"
 
       puts "Successfully updated #{address}"
-      show_account(address)
+      show_account_details(address)
     end
 
     def delete_alias(address)
@@ -261,17 +298,49 @@ module PostfixAdmin
       puts_deleted(address)
     end
 
+    def dump
+      puts "Admins"
+      puts "User Name,Password,Super Admin,Active"
+      Admin.all.each do |a|
+        puts [a.username, %Q!"#{a.password}"!, a.super_admin?, a.active].join(',')
+      end
+      puts
+      puts "Domains"
+      puts "Domain Name,Max Quota,Active"
+      Domain.all_without_special_domain.each do |d|
+        puts [d.domain_name, d.maxquota, d.active].join(',')
+      end
+      puts
+      puts "Mailboxes"
+      puts "User Name,Name,Password,Quota,Maildir,Active"
+      Mailbox.all.each do |m|
+        puts [m.username, %Q!"#{m.name}"!, %Q!"#{m.password}"!, m.quota, %Q!"#{m.maildir}"!, m.active].join(',')
+      end
+      puts
+      puts "Aliases"
+      puts "Address,Go to,Active"
+      Alias.all.select{|a| !a.mailbox? }.each do |a|
+        puts [a.address, %Q!"#{a.goto}"!, a.active].join(',')
+      end
+      puts
+      puts "Forwards"
+      puts "Address,Go to,Active"
+      Alias.all.select{|a| a.mailbox? && a.goto != a.address }.each do |a|
+        puts [a.address, %Q!"#{a.goto}"!, a.active].join(',')
+      end
+    end
+
     private
 
     def show_alias_base(title, addresses)
-      report(title, " No. Address                                  Go to") do
+      report(title, " No. Address                                  Active Go to") do
         if addresses.empty?
           puts " No #{title.downcase}"
           next
         end
 
         addresses.each_with_index do |a, i|
-          puts "%4d %-40s %s" % [i+1, a.address, a.goto]
+          puts "%4d %-40s   %-3s  %s" % [i+1, a.address, a.active_str, a.goto]
         end
       end
     end
@@ -333,6 +402,10 @@ module PostfixAdmin
       klass_check(Mailbox, address)
     end
 
+    def alias_check(address)
+      klass_check(Alias, address)
+    end
+
     def admin_check(user_name)
       klass_check(Admin, user_name)
     end
@@ -354,7 +427,7 @@ module PostfixAdmin
       validate_password(password)
 
       obj = klass.find(user_name)
-      obj.password = password
+      obj.password = hashed_password(password)
       if obj.save
         puts "the password of #{user_name} was successfully changed."
       else
@@ -373,5 +446,13 @@ module PostfixAdmin
       end
     end
 
+    private
+
+    def hashed_password(password, in_scheme=nil)
+      scheme = in_scheme || @base.config[:scheme]
+      puts "scheme: #{scheme}"
+      PostfixAdmin::Doveadm.password(password, scheme)
+    end
+
   end
 end

data/lib/postfix_admin/doveadm.rb

@@ -0,0 +1,32 @@
+
+require 'open3'
+require 'shellwords'
+
+module PostfixAdmin
+  class Doveadm
+    def self.schemes
+      result = `#{self.command_name} -l`
+      result.split
+    end
+
+    def self.password(in_password, in_scheme)
+      password = Shellwords.escape(in_password)
+      scheme  = Shellwords.escape(in_scheme)
+      stdin, stdout, stderr = Open3.popen3("#{self.command_name} -s #{scheme} -p #{password}")
+      if stderr.readlines.to_s =~ /Fatal:/
+        raise Error, stderr.readlines
+      else
+        stdout.readlines.first.chomp.gsub("{#{scheme}}", "")
+      end
+    end
+
+    def self.command_name
+      begin
+        Open3.capture3("doveadm pw -l")[2].exited?
+        "doveadm pw"
+      rescue Errno::ENOENT
+        "dovecotpw"
+      end
+    end
+  end
+end

data/lib/postfix_admin/models.rb

@@ -1,10 +1,23 @@
 require 'data_mapper'
 
 module PostfixAdmin
+  def self.flag_str(flag)
+    flag ? "YES" : "NO"
+  end
+
+  class Config
+    include ::DataMapper::Resource
+    property :id,    Integer, :key => true
+    property :name,  String
+    property :value, String
+    storage_names[:default] = 'config'
+  end
+
   class Admin
     include ::DataMapper::Resource
-    property :username, String, :key => true
+    property :username, String, :key => true, :length => 0..255
     property :password, String, :length => 0..255
+    property :active, Boolean, :default  => true
     property :created, DateTime, :default => DateTime.now
     property :modified, DateTime, :default => DateTime.now
 
@@ -12,6 +25,10 @@ module PostfixAdmin
     has n, :domains, :model => 'Domain', :through => :domain_admins, :via => :domain
     storage_names[:default] = 'admin'
 
+    def active_str
+      PostfixAdmin.flag_str(active)
+    end
+
     def has_domain?(domain_name)
       if super_admin?
         Domain.exist?(domain_name)
@@ -55,13 +72,14 @@ module PostfixAdmin
 
   class Domain
     include ::DataMapper::Resource
-    property :domain_name, String, :field => 'domain', :key => true
+    property :domain_name, String, :field => 'domain', :key => true, :length => 0..255
     property :maxaliases, Integer, :field => 'aliases'
     property :maxmailboxes, Integer, :field => 'mailboxes'
     property :maxquota, Integer
-    property :transport, String, :default => 'virtual'
+    property :transport, String, :default => 'virtual', :length => 0..255
     property :backupmx, Integer, :default => 0
-    property :description, String
+    property :description, String, :length => 0..255
+    property :active, Boolean, :default  => true
     property :created,  DateTime, :default => DateTime.now
     property :modified, DateTime, :default => DateTime.now
 
@@ -96,13 +114,17 @@ module PostfixAdmin
       admins.clear
       save or raise "Could not save Domain"
     end
+
+    def active_str
+      PostfixAdmin.flag_str(active)
+    end
   end
 
   class DomainAdmin
     include ::DataMapper::Resource
     property :created, DateTime, :default => DateTime.now
-    property :domain_name, String, :field => 'domain', :key => true
-    property :username, String, :key => true
+    property :domain_name, String, :field => 'domain', :key => true, :length => 0..255
+    property :username, String, :key => true, :length => 0..255
 
     belongs_to :domain, :model => 'Domain', :child_key => :domain_name
     belongs_to :admin, :model => 'Admin', :child_key => :username
@@ -111,19 +133,22 @@ module PostfixAdmin
 
   class Mailbox
     include ::DataMapper::Resource
-    property :username, String, :key => true
-    property :name, String
+    property :username, String, :key => true, :length => 0..255
+    property :name, String, :length => 0..255
     property :domain_name, String, :field => 'domain'
     property :password, String, :length => 0..255
-    property :maildir, String
+    property :maildir, String, :length => 0..255
     property :quota, Integer
-    #  property :local_part, String
+    property :active, Boolean, :default  => true
     property :created, DateTime, :default => DateTime.now
     property :modified, DateTime, :default => DateTime.now
 
     belongs_to :domain, :model => 'Domain', :child_key => :domain_name
 
     storage_names[:default] = 'mailbox'
+    def active_str
+      PostfixAdmin.flag_str(active)
+    end
 
     def self.find(username)
       Mailbox.first(:username => username)
@@ -136,9 +161,10 @@ module PostfixAdmin
 
   class Alias
     include ::DataMapper::Resource
-    property :address, String, :key => true
+    property :address, String, :key => true, :length => 0..255
     property :goto, Text
-    property :domain_name, String, :field => 'domain'
+    property :domain_name, String, :field => 'domain', :length => 0..255
+    property :active, Boolean, :default  => true
     property :created, DateTime, :default => DateTime.now
     property :modified, DateTime, :default => DateTime.now
 
@@ -146,6 +172,10 @@ module PostfixAdmin
 
     storage_names[:default] = 'alias'
 
+    def active_str
+      PostfixAdmin.flag_str(active)
+    end
+
     def self.mailbox(address)
       mail_alias = Alias.new
       mail_alias.attributes = {