maildiode 0.0.2

data/lib/settings.rb

@@ -0,0 +1,66 @@
+# 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 Settings
+		def initialize(config_file)
+			@settings = {}
+			File.foreach(config_file) do | line |
+				line = line.gsub(/#.*/, '').strip
+				if !line.empty?
+					component, keyword, args = line.split(' ', 3)
+					load_setting(component.downcase, keyword.downcase, args)
+				end
+			end
+		end
+		
+		def load_setting(component, keyword, args)
+			component_settings = get_settings(component)
+			component_settings[keyword] = args
+		end
+		
+		def get_settings(component)
+			component_settings = @settings[component]
+			if(!component_settings)
+				component_settings = {}
+				@settings[component] = component_settings
+			end
+			return component_settings
+		end
+		
+		def get_setting(component, keyword)
+			component_settings = get_settings(component)
+			if(!component_settings)
+				return nil
+			end
+			return component_settings[keyword]
+		end
+		
+		def get_int(component, keyword, default_value)
+			value = get_setting(component, keyword)
+			if(!value)
+				return default_value
+			end
+			return value.to_i
+		end
+		
+		def Settings.default_file
+			'/etc/maildiode/maildiode.conf'
+		end
+	end
+
+end

data/lib/util.rb

@@ -0,0 +1,107 @@
+# 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 'logger'
+
+module MailDiode
+	NEWLINE = "\r\n"
+end
+
+
+module MailDiode
+  class UTCFormatter < Logger::Formatter
+    def initialize
+    	@datetime_format = '%Y-%m-%d %H:%M:%SZ'
+    end
+    
+    def call(severity, time, progname, msg)
+      time.utc
+      super(severity, time, progname, msg)
+    end
+  end
+
+	def self.log_to_string
+		@log_buffer = StringIO.new('', 'w')
+		log_to_stream(@log_buffer)
+	end
+
+	def self.log_to_console
+		@log_buffer = nil
+		log_to_stream(STDERR)
+	end
+
+	def self.log_to_file(file_path)
+	  is_safe = !file_path.index('..')
+	  if !is_safe
+	    raise "Log file path cannot contain .."
+    end
+    file_path.untaint
+	  @log_buffer = nil
+    out = File.open(file_path, 'a')
+    log_to_stream(out)
+	end
+
+	def self.log_to_stream(destination)
+		level = @log ? @log.level : Logger::WARN
+		@log_stream = destination
+		@log = Logger.new(destination, 'monthly')
+  	@log.formatter = UTCFormatter.new
+		@log.level = level
+	end
+
+	def self.get_log
+		return @log_buffer.string
+	end
+
+	def self.clear_log
+		@log_buffer.truncate(0)
+	end
+
+	def self.flush_log
+    @log_stream.flush
+	end
+
+	def self.log_error(message)
+		@log.error(message)
+		flush_log
+	end
+	
+	def self.log_warning(message)
+		@log.warn(message)
+		flush_log
+	end
+
+	def self.log_info(message)
+		@log.info(message)
+		flush_log
+	end
+	
+	def self.log_debug(message)
+		@log.debug(message)
+		flush_log
+	end
+
+	def self.log_success(command, args, result)
+		log_info("#{result}: #{command} #{args}")
+	end
+
+	def self.set_log_level(level)
+		@log.level = level
+	end
+
+	log_to_console
+
+end

data/test/test_engine.rb

@@ -0,0 +1,239 @@
+#!/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 'test/unit'
+require 'stringio'
+
+require 'util'
+require 'engine'
+
+FAKE_IP = '10.10.10.10'
+
+class DummyFilter < MailDiode::Filter
+	attr_accessor :reject
+	attr_reader :data
+	
+	def process(filterable_data)
+		if(reject)
+			raise MailDiode::SMTPError.new(reject)
+		end
+		@data = filterable_data
+	end
+end
+
+class DummyMailHandler < MailDiode::MailHandler
+	attr_reader :message_text
+	attr_accessor :reject
+	
+	SAMPLE_ID = '12345'
+	
+	def initialize
+		@to = []
+		valid = true
+	end
+	
+	def valid_recipient?(to_address)
+		return !reject
+	end
+	
+	def process_message(recipient, text_lines)
+		@message_text = text_lines
+		return SAMPLE_ID
+	end
+	
+	def message_without_first_line
+		return message_text.split("\r\n")[1..-1].join("\r\n")
+	end
+end
+	
+class TestEngine < Test::Unit::TestCase
+  def setup
+    MailDiode::set_log_level(Logger::WARN)
+    MailDiode::log_to_console
+    
+    @engine = MailDiode::Engine.new('woohoo')
+    @handler = DummyMailHandler.new
+    @engine.set_mail_handler(@handler)
+    
+    @greeting = @engine.start(FAKE_IP)
+  end
+
+  def teardown
+  end
+  
+  def test_greeting
+    assert_equal(0, @greeting.index('220 '), "Missing 220?")
+    assert_match('woohoo', @greeting, "missing hostname?")
+  end
+
+  def test_unknown_commands
+    assert_equal(0, @engine.process_line('').index(MailDiode::SMTPError::BAD_COMMAND), "Blank cmd accepted?")
+    assert_equal(0, @engine.process_line('xxx').index(MailDiode::SMTPError::BAD_COMMAND), "Bogus cmd accepted?")
+  end
+  
+  def test_noop
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('noop'), "noop failed?")
+    assert_equal(MailDiode::SMTPError::SYNTAX_NOOP, @engine.process_line('noop x'), "noop allowed a parameter?")
+  end
+  
+  def test_quit
+    assert(!@engine.terminate?, 'terminating before QUIT?')
+    assert_equal(MailDiode::RESULT_BYE, @engine.process_line('quit'), "didn't say bye?")
+    assert(@engine.terminate?, 'not terminating after QUIT?')
+    assert_equal(MailDiode::SMTPError::SYNTAX_QUIT, @engine.process_line('quit x'), "quit allowed a parameter?")
+  end
+  
+  def test_helo
+    assert_equal(MailDiode::SMTPError::SYNTAX_HELO, @engine.process_line('helo'), "helo without arg worked?")
+    assert_equal(MailDiode::SMTPError::SYNTAX_HELO, @engine.process_line('ehlo'), "ehlo without arg worked?")
+
+  	helo_result = @engine.process_line('helo localhost')
+    assert_equal(0, helo_result.index('250'), "helo failed?")
+    assert_equal(helo_result, @engine.process_line('helo localhost'), "second helo failed?")
+    assert_equal(helo_result, @engine.process_line('ehlo localhost'), "ehlo failed?")
+    assert_equal(helo_result, @engine.process_line('ehlo [1.2.3.4]'), "ehlo failed?")
+    assert_equal(helo_result, @engine.process_line('ehlo winnie.the.poo'), "ehlo failed?")
+  end
+  
+  def test_rset
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('rset'), "rset failed?")
+    assert_equal(MailDiode::SMTPError::SYNTAX_RSET, @engine.process_line('rset x'), "rset allowed a parameter?")
+
+    @engine.process_line('mail From:<sender@example.com>')
+    @engine.process_line('rset')
+    assert_equal(MailDiode::SMTPError::NEED_MAIL_BEFORE_RCPT, @engine.process_line('rcpt To:<recipient@example.com>'), "rset didn't clear from?")
+  end
+  
+  def test_vrfy
+    assert_equal(MailDiode::SMTPError::SYNTAX_VRFY, @engine.process_line('vrfy'), "vrfy without arg worked?")
+
+    assert_equal(MailDiode::RESULT_UNSURE, @engine.process_line('vrfy anything'), "vrfy failed?")
+  end
+
+  def test_mail
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('mail From:<correct@example.com>'), "mail rejected good from?")
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('mail From: <correct@example.com>'), "mail rejected because of space after from?")
+    assert_equal(MailDiode::SMTPError::SYNTAX_MAIL, @engine.process_line('mail'), "mail without arg worked?")
+    assert_equal(MailDiode::SMTPError::SYNTAX_MAIL, @engine.process_line('mail foo'), "mail without From: worked?")
+    assert_equal(MailDiode::SMTPError::SYNTAX_MAIL, @engine.process_line('mail from:'), "mail without from arg worked?")
+  end
+
+  def test_rcpt
+    assert_equal(MailDiode::SMTPError::NEED_MAIL_BEFORE_RCPT, @engine.process_line('rcpt To:<correct@example.com>'), "rcpt before mail worked?")
+
+    @engine.process_line('mail From:<correct@example.com>')
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('rcpt To:<correct@example.com>'), "mail rejected good from?")
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('rcpt To: <correct@example.com>'), "mail rejected because of space after to?")
+    assert_equal(MailDiode::SMTPError::SYNTAX_RCPT, @engine.process_line('rcpt'), "mail without arg worked?")
+    assert_equal(MailDiode::SMTPError::SYNTAX_RCPT, @engine.process_line('rcpt foo'), "mail without To: worked?")
+    assert_equal(MailDiode::SMTPError::SYNTAX_RCPT, @engine.process_line('rcpt to:'), "mail without to arg worked?")
+    
+    @engine.process_line('mail From:<correct@example.com>')
+    99.times do
+      @engine.process_line('rcpt To:<correct@example.com>')
+    end
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('rcpt To:<correct@example.com>'), "100th recipient rejected?")
+    assert_equal(MailDiode::SMTPError::TOO_MANY_RECIPIENTS, @engine.process_line('rcpt To:<correct@example.com>'), "101st recipient not rejected?")
+  end
+  
+  def test_data
+    assert_equal(MailDiode::SMTPError::NEED_RCPT_BEFORE_DATA, @engine.process_line('data'), "data before rcpt worked?")
+
+    @engine.process_line('mail From:<sender@example.com>')
+    @engine.process_line('rcpt To:<recipient@example.com>')
+    assert_equal(MailDiode::SMTPError::SYNTAX_DATA, @engine.process_line('data xxx'), "data with arg accepted?")
+    assert_equal(MailDiode::RESULT_DATA_OK, @engine.process_line('data'), "data rejected?")
+    assert_equal(nil, @engine.process_line('This is message data'), "responded to message data?")
+    @engine.process_line('Second line')
+    assert_equal(0, @engine.process_line('.').index(MailDiode::RESULT_OK), "didn't pretend to save?")
+  end
+
+
+
+
+
+  def test_filter
+    filter = DummyFilter.new
+    @engine.add_filter(filter)
+    @engine.process_line('mail From:<sender@example.com>')
+    @engine.process_line('rcpt To:<recipient@example.com>')
+    assert_equal('sender@example.com', filter.data.sender, "didn't call handler validate_sender?")
+    assert_equal('recipient@example.com', filter.data.recipient, "didn't call handler validate_recipient?")
+
+    filter.reject = "450 Try Later"
+    assert_equal(filter.reject, @engine.process_line('rcpt To:<recipient@example.com>'), "filter rejection not propagated?")
+  end
+  
+  def test_mail_handler
+    @engine.process_line('mail From:<sender@example.com>')
+    @engine.process_line('rcpt To:<recipient@example.com>')
+
+    sample_text = ['First line', 'Second', '', ' . not a dot line', 'After blank']
+    @engine.process_line('DATA')
+    sample_text.each do | line |
+      @engine.process_line(line)
+    end
+    assert_equal(0, @engine.process_line('.').index(MailDiode::RESULT_OK), "handler didn't accept?")
+    assert_equal(sample_text.join("\r\n"), @handler.message_without_first_line, "bad message data?")
+    
+    assert_equal(MailDiode::SMTPError::NEED_RCPT_BEFORE_DATA, @engine.process_line('data'), "didn't reset after .?")
+
+    MailDiode::set_log_level(Logger::INFO)
+    MailDiode::log_to_string
+	
+    @handler.reject = true
+    @engine.process_line('mail From:<sender@example.com>')
+    assert_equal(MailDiode::SMTPError::UNKNOWN_RECIPIENT, @engine.process_line('rcpt To:<recipient@example.com>'), "reject to not propagated?")
+  end
+  
+  def test_dot_in_data
+    @engine.process_line('mail From:<sender@example.com>')
+    @engine.process_line('rcpt To:<recipient@example.com>')
+    @engine.process_line('data')
+    line_with_dot = '..Line with a dot'
+    @engine.process_line(line_with_dot)
+    @engine.process_line('.')
+    assert_equal(line_with_dot[1..-1], @handler.message_without_first_line, "didn't unescape the dot?")
+  end
+  
+  def test_args
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('noop '), "choked on trailing space?")
+    assert_equal(0, @engine.process_line("helo\tx").index('250'), "choked on tab?")
+  end
+  
+  def test_case_insensitive_commands
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('noop'), "lower case failed?")
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('NOOP'), "upper case failed?")
+    assert_equal(MailDiode::RESULT_OK, @engine.process_line('nOOp'), "mixed case failed?")
+  end
+
+  def test_normal_logging
+    MailDiode::log_to_string
+    @engine.process_line('noop')
+    assert_equal('', MailDiode::get_log)
+    MailDiode::clear_log
+    @engine.process_line('xxx')
+    assert_equal('', MailDiode::get_log)
+  end
+  
+  def test_verbose_logging
+    MailDiode::set_log_level(Logger::INFO)
+    MailDiode::log_to_string
+    @engine.process_line('noop')
+    assert(MailDiode::get_log.index('INFO'))
+  end  
+end

data/test/test_suite.rb

@@ -0,0 +1,20 @@
+#!/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 'test/unit'
+
+require 'test_engine.rb'

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification 
+name: maildiode
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Kevin Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-03 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: daemons
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.10
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gurgitate-mail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.10.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: KirbyBase
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.6.0
+    version: 
+description: 
+email: kevins@qualitycode.com
+executables: 
+- maildiode
+extensions: []
+
+extra_rdoc_files: 
+- README
+- doc/index.html
+files: 
+- bin/maildiode
+- lib/alias.rb
+- lib/blacklist.rb
+- lib/delay.rb
+- lib/engine.rb
+- lib/greylist.rb
+- lib/maildir.rb
+- lib/server.rb
+- lib/util.rb
+- lib/settings.rb
+- test/test_engine.rb
+- test/test_suite.rb
+- README
+- doc/index.html
+has_rdoc: false
+homepage: http://maildiode.rubyforge.org/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.1
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: maildiode
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: MailDiode is a simple incoming SMTP server daemon.
+test_files: 
+- test/test_suite.rb