eventmachine-email_server 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 45064a738c416e1fce2c8726b3bab01c10f55860
+  data.tar.gz: 25c163465275237d7caf9f48d257d20348a812c9
+SHA512:
+  metadata.gz: cecf95b16f4d4e38cf83a65c2f4f9a69c5d4807b71a31a37fbc1cf4f723eb7476c95b7450adef582e8939019c5b4d6b96e8449a4070cb2ff0b78fa5b5bab4aa0
+  data.tar.gz: 3cb06186363faef276e41cd92ea2127938d1d1bd3109a2bcf50f343a3d844b021e8969bd4213d3e01976547b8e8b8292482d8157bbf440cc27e45380b38a2e93

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/test/*.sqlite3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in eventmachine-email_server.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 chrislee35
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,90 @@
+# EventMachine::EmailServer
+
+This provides an EventMachine-based implementation of POP3 and SMTP services--primarily for use within the Rubot framework.  However, as I add features, this might come in handy for other people as well.
+ 
+There are several email and user backends so that the POP3 and SMTP servers can share: Memory, Sqlite3, and Null.
+
+The SMTP server currently only receives mail as an end-host (no relay or sending) and does no fancy routing of email (e.g., aliases and procmail).  It does, however, have graylisting, DNS PTR checks, DNSBL checks, rate limiting, and simple filters.
+
+Writing a full-featured mail server is a multi-year, multi-person project.  I would need some help.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'eventmachine-email_server'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install eventmachine-email_server
+
+## Usage
+
+Simple usage:
+
+	require 'eventmachine/email_server'
+	include EventMachine::EmailServer
+    EM.run {
+      pop3 = EventMachine::start_server "0.0.0.0", 2110, POP3Server, "example.org", userstore, emailstore
+      smtp = EventMachine::start_server "0.0.0.0", 2025, SMTPServer, "example.org", userstore, emailstore
+	}
+
+Everything turned on:
+
+    require 'eventmachine/email_server'
+    include EventMachine::EmailServer
+    require 'ratelimit/bucketbased'
+    require 'dnsbl/client'
+    require 'sqlite3'
+	
+    s = SQLite3::Database.new("test/test.sqlite3")
+    userstore = Sqlite3UserStore.new(s)
+    emailstore = Sqlite3EmailStore.new(s)
+    userstore << User.new(1, "chris", "chris", "chris@example.org")
+    
+    config = {
+      'default' => RateLimit::Config.new('default', 2, 2, -2, 1, 1, 1),
+    }
+    storage = RateLimit::Memory.new
+    rl = RateLimit::BucketBased.new(storage, config, 'default')
+    
+    dnsbl = DNSBL::Client.new
+    
+    SMTPServer.reverse_ptr_check(true)
+    SMTPServer.graylist(Hash.new)
+    SMTPServer.ratelimiter(rl)
+    SMTPServer.dnsbl(dnsbl)  
+    SMTPServer.reject_filters << /viagra/i
+    
+    EM.run {
+      pop3 = EventMachine::start_server "0.0.0.0", 2110, POP3Server, "example.org", userstore, emailstore
+      smtp = EventMachine::start_server "0.0.0.0", 2025, SMTPServer, "example.org", userstore, emailstore
+    }
+
+
+## Contributing
+
+If we want this to be "professional":
+*EventMachine-based SPF Checking
+*EventMachine-based DNSBL::Client
+*Abstract filtering into a class with a callback so that all sorts of filtering (e.g., baysian) could be done
+*Create a launcher in bin/ and parse configuration files
+*StartTLS
+*SSL
+*CRAM-MD5
+*Domain-Keys
+*Relay (this is easy to implement, but hard to get right)
+*Aliases
+*Logging
+
+1. Fork it ( https://github.com/[my-github-username]/eventmachine-email_server/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << 'lib'
+	t.test_files = FileList['test/test_*.rb']
+	t.verbose = true
+end
+
+task :default => :test

data/eventmachine-email_server.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eventmachine/email_server/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "eventmachine-email_server"
+  spec.version       = EventMachine::EmailServer::VERSION
+  spec.authors       = ["chrislee35"]
+  spec.email         = ["rubygems@chrislee.dhs.org"]
+  spec.summary       = %q{EventMachine-based implementations of a POP3 and SMTP server}
+  spec.description   = %q{Simple POP3 and SMTP implementation in EventMachine for use in the Rubot framework}
+  spec.homepage      = "https://github.com/chrislee35/eventmachine-email_server/"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency "eventmachine", ">= 0.12.10"
+  spec.add_runtime_dependency "sqlite3", ">= 1.3.6"
+  spec.add_runtime_dependency "ratelimit-bucketbased", ">= 0.0.1"
+  spec.add_runtime_dependency "eventmachine-dnsbl", ">= 0.0.2"
+  spec.add_development_dependency "minitest", "~> 5.5"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/eventmachine/email_server/base.rb

@@ -0,0 +1,66 @@
+module EventMachine
+  module EmailServer
+    class User < Struct.new(:id,:username,:password,:address); end
+    class Email < Struct.new(:id,:from,:to,:subject,:body,:uid,:marked); end
+    
+    class AbstractUserStore
+      def add_user(user)
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+      
+      def <<(user)
+        add_user(user)
+      end
+
+      def delete_user(user)
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+      
+      def -(user)
+        delete_user(user)
+      end
+
+      def user_by_username(username)
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+      
+      def user_by_emailaddress(email)
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+    end
+        
+    class AbstractEmailStore
+      def emails_by_userid(id)
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+      
+      def save_email(email)
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+      
+      def <<(email)
+        save_email(email)
+      end
+      
+      def delete_email(email)
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+      
+      def -(email)
+        delete_email(email)
+      end
+
+      def delete_id(id)
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+      
+      def delete_user(uid)
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+      
+      def count
+        raise "Unimplemented, please use a subclass of #{self.class}"
+      end
+    end
+  end
+end

data/lib/eventmachine/email_server/eventmachine_dns_monkeypatch.rb

@@ -0,0 +1,55 @@
+module EventMachine
+  module DNS
+    class Resolver
+      def self.resolve(hostname, qclass=Resolv::DNS::Resource::IN::A)
+        Request.new(socket, hostname, qclass)
+      end
+    end
+    class Request
+      def initialize(socket, hostname, qclass)
+        @socket = socket
+        @hostname = hostname
+        @qclass = qclass
+        @tries = 0
+        @last_send = Time.at(0)
+        @retry_interval = 3
+        @max_tries = 5
+        if addrs = Resolver.hosts[hostname]
+          succeed addrs
+        else
+          EM.next_tick { tick }
+        end
+      end
+      
+      def receive_answer(msg)
+        addrs = []
+        msg.each_answer do |name,ttl,data|
+          if data.respond_to? :address
+            addrs << data.address.to_s
+          elsif data.respond_to? :name
+            addrs << data.name.to_s
+          elsif data.respond_to? :strings
+            addrs << data.strings.join("\n")
+          else
+            addrs << data.to_s
+          end
+        end
+        if addrs.empty?
+          fail "rcode=#{msg.rcode}"
+        else
+          succeed addrs
+        end
+      end      
+      
+      private
+
+      def packet
+        msg = Resolv::DNS::Message.new
+        msg.id = id
+        msg.rd = 1
+        msg.add_question @hostname, @qclass
+        msg
+      end
+    end
+  end
+end

data/lib/eventmachine/email_server/memory.rb

@@ -0,0 +1,61 @@
+require_relative 'base'
+
+module EventMachine
+  module EmailServer
+    class MemoryUserStore < AbstractUserStore
+      def initialize
+        @users = Array.new
+      end
+      
+      def add_user(user)
+        @users << user
+      end
+      
+      def delete_user(user)
+        @users -= [user]
+      end
+
+      def user_by_username(username)
+        @users.find {|user| user.username == username}
+      end
+      
+      def user_by_emailaddress(address)
+        @users.find {|user| user.address == address}
+      end
+      
+      def user_by_id(id)
+        @users.find {|user| user.id == id}
+      end
+    end
+    
+    class MemoryEmailStore < AbstractEmailStore
+      def initialize
+        @emails = Array.new
+      end
+      
+      def emails_by_userid(uid)
+        @emails.find_all {|email| email.uid == uid}
+      end
+      
+      def save_email(email)
+        @emails << email
+      end
+      
+      def delete_email(email)
+        @emails -= [email]
+      end
+      
+      def delete_id(id)
+        @emails.delete_if {|email| email.id == id}
+      end
+      
+      def delete_user(uid)
+        @emails.delete_if {|email| email.uid == uid}
+      end
+      
+      def count
+        @emails.length
+      end
+    end
+  end
+end

data/lib/eventmachine/email_server/null.rb

@@ -0,0 +1,56 @@
+require_relative 'base'
+
+module EventMachine
+  module EmailServer
+    class NullUserStore < AbstractUserStore
+      def initialize
+        @user = User.new(1,"null","null","null")
+      end
+      
+      def add_user(user)
+      end
+      
+      def delete_user(user)
+      end
+
+      def user_by_username(username)
+        u = @user.clone
+        u.userame = username
+        u
+      end
+      
+      def user_by_emailaddress(address)
+        u = @user.clone
+        u.address = address
+        u
+      end
+      
+      def user_by_id(id)
+        u = @user.clone
+        u.id = id
+        u
+      end
+    end
+    
+    class NullEmailStore < AbstractEmailStore
+      def initialize
+      end
+      
+      def emails_by_userid(uid)
+        []
+      end
+      
+      def save_email(email)
+      end
+      
+      def delete_email(email)
+      end
+      
+      def delete_id(id)
+      end
+      
+      def delete_user(uid)
+      end
+    end
+  end
+end

data/lib/eventmachine/email_server/pop3_server.rb

@@ -0,0 +1,250 @@
+require 'eventmachine'
+require 'digest/md5'
+
+module EventMachine
+	module EmailServer
+		class POP3Server < EventMachine::Connection
+      @@capabilities = [ "TOP", "USER", "UIDL" ]
+      def initialize(hostname, userstore, emailstore)
+        @hostname = hostname
+        @userstore = userstore
+        @emailstore = emailstore
+        @state = 'auth' # 'trans' and 'data'
+        @auth_attempts = 0
+        @apop_challenge = "<#{rand(10**4 - 1)}.#{rand(10**9 - 1)}@#{@hostname}>"
+        @debug = true
+        @emails = Array.new
+      end
+      
+      def post_init
+        puts ">> +OK POP3 server ready #{@apop_challenge}" if @debug
+        send_data("+OK POP3 server ready #{@apop_challenge}\r\n")
+      end
+      
+			def receive_data(data)
+        puts ">> #{data}" if @debug
+        ok, op = process_line(data)
+        if ok
+          puts "<< #{op}" if @debug
+          send_data(op+"\r\n")
+        end
+      end
+      
+      def unbind(reason=nil)
+        @emails.find_all {|e| e.marked}.each do |email|
+          @emailstore.delete_email(email)
+          puts "deleted #{email.id}" if @debug
+        end
+      end
+      
+    	def process_line(line)
+    		line.chomp!
+    		case @state 
+    		when 'auth'
+    			case line
+    			when /^QUIT$/
+    				return false, "+OK dewey POP3 server signing off"
+          when /^CAPA$/
+            return true, "+OK Capability list follows\r\n"+@@capabilities.join("\r\n")+"\r\n."
+    			when /^USER (.+)$/
+    				user($1)
+    				if @user
+    					return true, "+OK #{@user.username} is most welcome here"
+    				else
+    					@failed += 1
+    					if @failed > 2
+    						return false, "-ERR you're out!"
+    					end
+    					return true, "-ERR sorry, no mailbox for #{$1} here"
+    				end
+    			when /^PASS (.+)$/
+    				if pass($1)
+    					@state = 'trans'
+    					emails
+    					msgs, bytes = stat
+    					return true, "+OK #{@user.username}'s maildrop has #{msgs} messages (#{bytes} octets)"
+    				else
+    					@failed += 1
+    					if @failed > 2
+    						return false, "-ERR you're out!"
+    					end
+    					return true, "-ERR no dope."
+    				end
+    			when /^APOP ([^\s]+) (.+)$/
+    				if apop($1,$2)
+    					@state = 'trans'
+    					emails
+    					return true, "+OK #{@user.username} is most welcome here"
+    				else
+    					@failed += 1
+    					if @failed > 2
+    						return false, "-ERR you're out!"
+    					end
+    					return true, "-ERR sorry, no mailbox for #{$1} here"
+    				end
+    			end
+    		when 'trans'
+    			case line
+    			when /^NOOP$/
+    				return true, "+OK"
+    			when /^STAT$/
+    				msgs, bytes = stat
+    				return true, "+OK #{msgs} #{bytes}"
+    			when /^LIST$/
+    				msgs, bytes = stat
+    				msg = "+OK #{msgs} messages (#{bytes} octets)\r\n"
+    				list.each do |num, bytes|
+    					msg += "#{num} #{bytes}\r\n"
+    				end
+    				msg += "."
+    				return true, msg
+    			when /^LIST (\d+)$/
+    				msgs, bytes = stat
+    				num, bytes = list($1)
+    				if num
+    					return true, "+OK #{num} #{bytes}"
+    				else
+    					return true, "-ERR no such message, only #{msgs} messages in maildrop"
+    				end
+    			when /^RETR (\d+)$/
+    				msg = retr($1)
+    				if msg
+    					msg = "+OK #{msg.length} octets\r\n" + msg + "\r\n."
+    				else
+    					msg = "-ERR no such message"
+    				end
+    				return true, msg
+    			when /^DELE (\d+)$/
+    				if dele($1)
+    					return true, "+OK message #{$1} marked"
+    				else
+    					return true, "-ERR message #{$1} already marked"
+    				end
+    			when /^RSET$/
+    				rset
+    				msgs, bytes = stat
+    				return true, "+OK maildrop has #{msgs} messages (#{bytes} octets)"
+    			when /^QUIT$/
+    				@state = 'update'
+    				quit
+    				msgs, bytes = stat
+    				if msgs > 0
+    					return true, "+OK dewey POP3 server signing off (#{msgs} messages left)"
+    				else
+    					return true, "+OK dewey POP3 server signing off (maildrop empty)"
+    				end
+    			when /^TOP (\d+) (\d+)$/
+    				lines = $2
+    				msg = retr($1)
+    				unless msg
+    					return true, "-ERR no such message"
+    				end
+    				cnt = nil
+    				final = ""
+    				msg.split(/\n/).each do |l|
+    					final += l+"\n"
+    					if cnt
+    						cnt += 1
+    						break if cnt > lines
+    					end
+    					if l !~ /\w/
+    						cnt = 0
+    					end
+    				end
+    				return true, "+OK\r\n"+final+"\r\n."
+    			when /^UIDL$/
+    				msgid = 0
+    				msg = ''
+    				@emails.each do |e|
+    					msgid += 1
+    					next if e.marked
+    					msg += "#{msgid} #{Digest::MD5.new.update(msg).hexdigest}"
+    				end
+    				return true, "+OK\r\n#{msg}\r\n.";
+    			end
+    		when 'update'
+    			case line
+    			when /^QUIT$/
+    				return true, "+OK dewey POP3 server signing off"
+    			end
+    		end
+    		return true, "-ERR unknown command"
+    	end
+
+    	def user(username)
+    		@user = @userstore.user_by_username(username)
+    	end
+      
+    	def pass(password)
+    		return false unless @user
+    		return false unless @user.password == password
+    		true
+    	end
+      
+    	def emails
+        @emails = @emailstore.emails_by_userid(@user.id)
+    	end
+      
+    	def stat
+    		msgs = bytes = 0
+    		@emails.each do |e|
+    			p e
+    			p e.body.length
+    			next if e.marked
+    			msgs += 1
+    			bytes += e.body.length
+    		end
+    		[msgs, bytes]
+    	end
+      
+    	def list(msgid = nil)
+    		msgid = msgid.to_i if msgid
+    		if msgid
+    			return false if msgid > @emails.length or @emails[msgid-1].marked
+    			return [ [msgid, @emails[msgid].body.length] ]
+    		else
+    			msgs = []
+    			@emails.each_with_index do |e,i|
+    				msgs << [ i + 1, e.body.length ]
+    			end
+    			msgs
+    		end
+    	end
+      
+    	def retr(msgid)
+    		msgid = msgid.to_i
+    		return false if msgid > @emails.length or @emails[msgid-1].marked
+    		@emails[msgid-1].body
+    	end
+      
+    	def dele(msgid)
+    		msgid = msgid.to_i
+    		return false if msgid > @emails.length
+    		@emails[msgid-1].marked = true
+    	end
+      
+    	def rset
+    		@emails.each do |e|
+    			e.marked = false
+    		end
+    	end
+      
+    	def quit
+        @emails.find_all {|e| e.marked}.each do |email|
+          @emailstore.delete_email(email)
+        end
+    	end
+      
+    	def apop(username, hash)
+    		user(username)
+    		return false unless @user
+    		if Digest::MD5.new.update("#{@apop_challenge}#{@user.password}").hexdigest == hash
+    			return true
+    		end
+    		false
+    	end
+
+    end
+  end
+end
+