maildiode 0.0.2

data/README

@@ -0,0 +1,85 @@
+MailDiode README
+A simple incoming mail MTA SMTP daemon
+Copyright 2007-2008 Kevin B. Smith
+Released under the GNU GPL v3
+
+*** NOTE *** 
+This code is NOT ready for production use.
+You will probably lose email if you use it on a real server!!
+************
+
+PROJECT GOALS:
+1. Simplicity (Ruby, incoming only, minimal core plus plugins)
+2. Trivial to install and configure (GEM, easy .conf file)
+3. Security (Ruby, tainting, unit tested, lack of features)
+4. Modest performance (fine for personal servers)
+5. Modularity (plugins for non-core features)
+
+FEATURES:
+1. Unix/Linux Daemon
+2. Implements SMTP protocol
+3. Hands off messages to non-core extensions
+4. Full unit test suite
+
+NON-FEATURES:
+1. No outgoing mail
+2. No TLS/SSL
+3. No filtering, greylisting, aliases, etc. in the core
+4. Not expected to handle hundreds of users
+
+REQUIREMENTS:
+1. POSIX (only tested on Ubuntu Linux)
+2. Ruby 1.8
+3. Gems:
+   a. gurgitate-mail (for maildir)
+   b. kirbybase (for greylisting)
+
+INSTALLATION AND CONFIGURATION
+  gem install <local maildiode gem>
+
+  <edit conf file and copy to /etc/maildiode/maildiode.conf>
+
+  Optional: symlink or copy maildiode executable to /etc/init.d/
+  and add to runlevels as appropriate.
+
+  To run in the foreground, for debugging:
+    maildiode run
+
+  To start as a daemon:
+    maildiode start
+
+  Check status of running daemon:
+    maildiode status
+
+  Stop the daemon:
+    maildiode stop
+
+  Check version:
+    maildiode -- --version
+
+TODO
+- Split into multiple gems (maildiode, -greylist)
+- Drop privileges
+- Add debounce filter to reject bounces for mail we didn't send
+- Implement greylist exemptions (see below)
+- Periodically clear out old greylist entries
+- Properly handle multiple recipients where some work and some fail
+   (Reply OK but send bounces to the failures)
+- Add a return path header?
+- Create SPF filter?
+- Allow integrating milters and/or other external filters
+
+
+SEE ALSO
+
+Official SMTP spec:
+http://rfc.net/rfc2821.html
+
+Great SMTP implementation notes by D. J. Bernstein:
+http://cr.yp.to/smtp.html
+
+"Spam filtering for Mail Exchangers":
+http://www.tldp.org/HOWTO/Spam-Filtering-for-MX/index.html
+
+List of IP addresses that should be exempt from greylisting:
+http://cvs.puremagic.com/viewcvs/greylisting/schema/whitelist_ip.txt?view=markup

data/bin/maildiode

@@ -0,0 +1,142 @@
+#!/usr/bin/env ruby
+# Copyright 2007-2008 Kevin B. Smith
+# This file is part of MailDiode.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3, as 
+# published by the Free Software Foundation.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'optparse'
+require 'util'
+require 'settings'
+require 'server'
+require 'maildir'
+require 'daemons'
+
+module MailDiode
+	class EngineFactory
+		def initialize(plugins_to_use, settings)
+			@plugins = plugins_to_use
+			@settings = settings
+		end
+		
+		def create_engine(hostname)
+		
+			engine = Engine.new(hostname)
+			
+			engine.set_mail_handler(MaildirMessageHandler.new(@settings))
+			@plugins.each do | plugin |
+			    engine.add_filter(plugin)
+			end
+			  
+			return engine
+		end
+	end
+
+	def self.create_option_parser
+		opts = OptionParser.new do |o|
+		  o.on_tail("-l", "--logfile PATH_TO_LOGFILE", "Set destination logfile (default #{$log_filename})") do |name|
+        $log_filename = name
+		  end
+		  
+			o.on_tail("-v", "--verbose", "Verbose debugging (defaults false)") do
+				set_log_level(Logger::DEBUG)
+			end
+			
+			o.on_tail("-h", "--help", "Show this message") do
+				puts "MailDiode, a very simple incoming SMTP MTA"
+				puts "  See #{Settings.default_file}"
+				puts ""
+				puts opts
+				exit(0)
+			end
+
+			o.on_tail("--version", "Display version number") do
+				puts "$VERSION"
+				exit(0)
+			end
+			 
+		end
+		
+		return opts
+	end
+
+	def self.load_plugins(settings)
+		plugins = []
+		settings.get_settings('plugin').each do | setting |
+			plugins << create_plugin(setting[0], settings)
+		end
+		return plugins
+	end	
+	
+	def self.create_plugin(plugin_name, settings)
+	    MailDiode::log_info("Initializing plugin: [#{plugin_name}]")
+		case plugin_name
+			when 'blacklist'
+				require 'blacklist'
+				return BlacklistFilter.new(settings)
+			when 'delay'
+				require 'delay'
+				return DelayFilter.new(settings)
+			when 'alias'
+				require 'alias'
+				return AliasFilter.new(settings)
+			when 'greylist'
+				require 'greylist'
+				return GreylistFilter.new(settings)
+			else
+				raise "Unrecognized plugin: #{plugin_name}"				
+		end
+	end
+
+  $log_filename = '/var/log/maildiode'
+  
+	begin
+		create_option_parser.parse(ARGV)
+	rescue OptionParser::InvalidOption => e
+		puts e
+		exit(1)
+	rescue OptionParser::AmbiguousOption => e
+		puts e
+		exit(1)
+	end
+
+end
+
+def start
+  $SAFE = 1
+
+  puts "***********************************************************"
+  puts "This application has NOT been tested much, so PLEASE do not "
+  puts "use it on a production server with real incoming email!!"
+  puts "***********************************************************"
+
+  MailDiode::log_to_file($log_filename)
+	MailDiode::set_log_level(Logger::INFO)
+
+  config_file = MailDiode::Settings.default_file
+	settings = MailDiode::Settings.new(config_file)
+
+	plugins = MailDiode::load_plugins(settings)
+	factory = MailDiode::EngineFactory.new(plugins, settings)
+	MailDiode::log_info "Starting server..."
+	MailDiode::log_debug "Debug logging enabled"
+	server = MailDiode::Server.new(factory, settings)
+	server.start
+	server.join
+end
+
+
+
+Daemons.run_proc('maildiode', {:dir_mode => :system}) do
+  start
+end
+

data/doc/index.html

@@ -0,0 +1,83 @@
+<html>
+<head>
+<title>MailDiode - Really Simple Incoming SMTP Email Server</title>
+</head>
+<body>
+<h1>MailDiode</h1>
+<h2>What is it?</h2>
+MailDiode is an SMTP daemon that accepts incoming email and delivers
+it to maildirs.
+<h2>Why another SMTP server?</h2>
+<p>Because all the others I have found are either too hard to configure, 
+or are written in insecure languages (C). 
+</p>
+<p>SMTP servers like sendmail, postfix, and exim serve two
+<strong>completely</strong> different purposes:
+</p>
+<ul>
+<li>Outgoing mail, from you to anyone else in the world</li>
+<li>Incoming mail, to you from anyone else in the world</li>
+</ul>
+<p>It turns out that handling outgoing mail is <strong>really hard</strong>, 
+while handling incoming mail is really simple. 
+So MailDiode handles incoming mail and not outgoing mail.
+</p>
+<h2>Who might use MailDiode?</h2>
+Someone who wants to run their own incoming email server, and who 
+can rely on some other server to handle outgoing mail. 
+Or perhaps someone who runs both incoming and outgoing mail servers, 
+but realizes that allowing each daemon to handle one specific task 
+is simpler and (hopefully) more secure than having one service try 
+to handle both.
+<h2>What is the status of MailDiode?</h2>
+As of 2008-12-02 it is (still) in alpha test. 
+That is, I am starting to use it for some of my own production email.
+Mostly it works pretty well.
+It cannot yet be run as a daemon.
+After that feature works, I'll probably publish a gem.
+<h2>When you say "simple", what do you mean?</h2>
+MailDiode supports virtual domains, aliasing, and greylisting.
+Here is a sample config file demonstrating all those features:
+<pre>
+#debug warn # error warn info debug
+
+server hostname localhost
+server ip 0.0.0.0
+server port 10025
+server maxconnections 20
+
+maildir kevin     /home/kevins/TestMail/main/
+maildir catchall  /home/kevins/TestMail/other/
+
+plugin alias
+alias kevin     ^kevin@qualitycode.com$
+alias other   	@qualitycode.com$
+alias other     @example.com$
+
+plugin blacklist
+blacklist to	\d{6,}.*@qualitycode.com$
+
+plugin delay
+delay helo 5
+delay mail 6
+delay rcpt 7
+
+plugin greylist
+greylist delayminutes 5
+</pre>
+
+<p>
+The first section has general information about the server.  
+The second section sets up two maildir destinations, each identified 
+by an arbitrary string. (These could be local accounts, full email 
+addresses, or anything else). 
+The alias section uses regular expressions to create multiple 
+aliases and "catchall accounts" that route to the destinations set up 
+in the earlier section.
+The rest of the file is used to configure any optional plugins.
+</p>
+<p>
+That's it. Simple.
+</p>
+</body>
+</html>

data/lib/alias.rb

@@ -0,0 +1,47 @@
+# Copyright 2007-2008 Kevin B. Smith
+# This file is part of MailDiode.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3, as 
+# published by the Free Software Foundation.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module MailDiode
+	class AliasFilter < Filter
+		def initialize(settings)
+			@aliases = []
+			load_settings(settings)
+		end
+		
+		def process(filterable_data)
+			recipient = filterable_data.recipient
+			@aliases.each do | pattern_and_target |
+				pattern = pattern_and_target[0]
+				target = pattern_and_target[1]
+				MailDiode::log_debug "alias checking: #{pattern}"
+				re = Regexp.new(pattern, Regexp::IGNORECASE)
+				if(recipient.match(re))
+					MailDiode::log_info "Alias #{recipient} --> #{target}"
+					filterable_data.recipient = target
+					return
+				end
+			end
+			
+			MailDiode::log_info "No alias for #{recipient}"
+		end
+
+		def load_settings(settings)
+			settings.get_settings('alias').each do | setting |
+				target, pattern = setting
+				@aliases << [pattern, target]
+			end
+		end
+	end
+end

data/lib/blacklist.rb

@@ -0,0 +1,50 @@
+# Copyright 2007-2008 Kevin B. Smith
+# This file is part of MailDiode.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3, as 
+# published by the Free Software Foundation.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module MailDiode
+	class BlacklistFilter < Filter
+		def initialize(settings)
+			@blacklisted_recipients = []
+			load_settings(settings)
+		end
+		
+		def helo(helo)
+		end
+
+		def mail(from)
+		end
+
+		def rcpt(recipient)
+			@blacklisted_recipients.each do | pattern |
+				re = Regexp.new(pattern, Regexp::IGNORECASE)
+				if(recipient.match(re))
+					raise MailDiode::SMTPError.new(MailDiode::SMTPError::UNKNOWN_RECIPIENT)
+				end
+			end
+		end
+		
+		def load_settings(settings)
+			settings.get_settings('blacklist').each do | setting |
+				key, value = setting
+				case key
+					when 'to'
+						@blacklisted_recipients << value
+					else
+						MailDiode::log_warning "Blacklist ignoring unknown: #{key}"
+				end
+			end
+		end
+	end
+end

data/lib/delay.rb

@@ -0,0 +1,48 @@
+# Copyright 2007-2008 Kevin B. Smith
+# This file is part of MailDiode.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License version 3, as 
+# published by the Free Software Foundation.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module MailDiode
+	class DelayFilter < Filter
+		def initialize(settings)
+			@delay_helo = 0
+			@delay_mail = 0
+			@delay_rcpt = 0
+			load_settings(settings)
+		end
+		
+		def helo(helo)
+			delay('helo', @settings.delay_helo)
+		end
+
+		def mail(from)
+			delay('mail', @settings.delay_mail)
+		end
+
+		def rcpt(recipient)
+			delay('rcpt', @settings.delay_rcpt)
+		end
+		
+		def delay(name, seconds)
+			MailDiode::log_debug "Delaying #{name} for #{seconds} seconds..."
+			sleep(seconds)
+		end
+
+		def load_settings(settings)
+			@delay_helo = settings.get_setting('delay', 'helo').to_i
+			@delay_mail = settings.get_setting('delay', 'mail').to_i
+			@delay_rcpt = settings.get_setting('delay', 'rcpt').to_i
+		end
+	end
+end