post_office 0.1.0

data/README.md

@@ -0,0 +1,10 @@
+PostOffice mock SMTP/POP3 server
+================================
+
+By Rene van Lieshout <rene@bluerail.nl>
+
+Usage:
+
+    sudo post_office
+
+Listens on port 25 and 110. Configure your POP3 client with any username and password.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/post_office

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'thread'
+require 'smtp_server.rb'
+require 'pop_server.rb'
+
+begin
+  smtp_server = Thread.new{ SMTPServer.new }
+  pop_server  = Thread.new{ POPServer.new  }
+
+  smtp_server.join
+  pop_server.join
+rescue Interrupt
+  puts "Interrupt..."
+rescue Errno::EACCES
+  puts "I need root access to open ports 25 and 110. Please sudo #{__FILE__}"
+end

data/lib/generic_server.rb

@@ -0,0 +1,64 @@
+require 'socket'
+require 'thread'
+
+# This class starts a generic server, accepting connections
+# on options[:port]
+#
+# When extending this class make sure you:
+#
+# * def greet(client)
+# * def process(client, command, full_data)
+# * client.close when you're done
+#
+# You can respond to the client using:
+#
+# * respond(client, text)
+#
+# The command given to process equals the first word
+# of full_data in upcase, e.g. QUIT or LIST
+#
+# It's possible for multiple clients to connect at the same
+# time, so use client.object_id when storing local data
+
+class GenericServer
+  
+  def initialize(options)
+    @port = options[:port]
+    server = TCPServer.open(@port)
+    puts "#{self.class.to_s} listening on port #{@port}"
+    
+    # Accept connections until infinity and beyond
+    loop do
+      Thread.start(server.accept) do |client|
+        begin
+          greet client
+
+          # Keep processing commands until somebody closed the connection
+          begin
+            input = client.gets
+
+            # The first word of a line should contain the command
+            command = input.to_s.gsub(/ .*/,"").upcase.gsub(/[\r\n]/,"")
+
+            puts "#{client.object_id}:#{@port} < #{input}"
+
+            process(client, command, input)
+          end until client.closed?
+        rescue => detail
+          puts "#{client.object_id}:#{@port} ! #{$!}"
+          client.close
+        end
+      end
+    end
+  end
+  
+  # Respond to client by sending back text
+  def respond(client, text)
+    puts "#{client.object_id}:#{@port} > #{text}"
+    client.puts text
+  rescue
+    puts "#{client.object_id}:#{@port} ! #{$!}"
+    client.close
+  end
+  
+end

data/lib/pop_server.rb

@@ -0,0 +1,182 @@
+require 'generic_server.rb'
+require 'store.rb'
+require 'digest/md5'
+
+# Basic POP server
+
+class POPServer < GenericServer
+  # Create new server listening on port 110
+  def initialize
+    super(:port => 110)
+  end
+  
+  # Send a greeting to client
+  def greet(client)
+    # truncate messages for this session
+    Store.instance.truncate
+    
+    respond(client, true, "Hello there")
+  end
+  
+  # Process command
+  def process(client, command, full_data)
+    case command
+      when "CAPA" then capa(client)
+      when "DELE" then dele(client, message_number(full_data))
+      when "LIST" then list(client, message_number(full_data))
+      when "NOOP" then respond(client, true, "Yup.")
+      when "PASS" then pass(client, full_data)
+      when "QUIT" then quit(client)
+      when "RETR" then retr(client, message_number(full_data))
+      when "RSET" then respond(client, true, "Resurrected.")
+      when "STAT" then stat(client)
+      when "TOP"  then top(client, full_data)
+      when "UIDL" then uidl(client, message_number(full_data))
+      when "USER" then user(client, full_data)
+      else respond(client, false, "Invalid command.")
+    end
+  end
+  
+  # Show the client what we can do
+  def capa(client)
+    respond(client, true, "Here's what I can do:\r\n" +
+                          "USER\r\n" +
+                          "IMPLEMENTATION Bluerail Post Office POP3 Server\r\n" +
+                          ".")
+  end
+
+  # Accepts username
+  def user(client, full_data)
+    respond(client, true, "Password required.")
+  end
+  
+  # Authenticates client
+  def pass(client, full_data)
+    respond(client, true, "Logged in.")
+  end
+  
+  # Shows list of messages
+  # 
+  # When a message id is specified only list
+  # the size of that message
+  def list(client, message)
+    if message == :invalid
+      respond(client, false, "Invalid message number.")
+    elsif message == :all
+      messages = ""
+      Store.instance.get.each.with_index do |message, index|
+        messages << "#{index + 1} #{message.size}\r\n"
+      end
+      respond(client, true, "POP3 clients that break here, they violate STD53.\r\n#{messages}.")
+    else
+      message_data = Store.instance.get[message - 1]
+      respond(client, true, "#{message} #{message_data.size}")
+    end
+  end
+  
+  # Retreives message
+  def retr(client, message)
+    if message == :invalid
+      respond(client, false, "Invalid message number.")
+    elsif message == :all
+      respond(client, false, "Invalid message number.")
+    else
+      message_data = Store.instance.get[message - 1]
+      respond(client, true, "#{message_data.size} octets to follow.\r\n" + message_data + "\r\n.")
+    end
+  end
+  
+  # Shows list of message uid
+  #
+  # When a message id is specified only list
+  # the uid of that message
+  def uidl(client, message)
+    if message == :invalid
+      respond(client, false, "Invalid message number.")
+    elsif message == :all
+      messages = ""
+      Store.instance.get.each.with_index do |message, index|
+        messages << "#{index + 1} #{message_uid(message)}\r\n"
+      end
+      respond(client, true, "unique-id listing follows.\r\n#{messages}.")
+    else
+      message_data = Store.instance.get[message - 1]
+      respond(client, true, "#{message} #{message_uid(message_data)}")
+    end
+  end
+  
+  # Shows total number of messages and size
+  def stat(client)
+    messages = Store.instance.get
+    total_size = messages.collect{ |m| m.size }.inject(0) { |sum,x| sum+x }
+    respond(client, true, "#{messages.length} #{total_size}")
+  end
+  
+  # Display headers of message
+  def top(client, full_data)
+    full_data = full_data.split(/TOP\s(\d*)/)
+    messagenum = full_data[1].to_i
+    number_of_lines = full_data[2].to_i
+
+    messages = Store.instance.get
+    if messages.length >= messagenum && messagenum > 0
+      headers = ""
+      line_number = -2
+      messages[messagenum - 1].split(/\r\n/).each do |line|
+        line_number = line_number + 1 if line.gsub(/\r\n/, "") == "" || line_number > -2
+        headers += "#{line}\r\n" if line_number < number_of_lines
+      end
+      respond(client, true, "headers follow.\r\n" + headers + "\r\n.")
+    else
+      respond(client, false, "Invalid message number.")
+    end
+  end
+  
+  # Quits
+  def quit(client)
+    respond(client, true, "Better luck next time.")
+    client.close
+  end
+  
+  # Deletes message
+  def dele(client, message)
+    if message == :invalid
+      respond(client, false, "Invalid message number.")
+    elsif message == :all
+      respond(client, false, "Invalid message number.")
+    else
+      Store.instance.remove(message - 1)
+      respond(client, true, "Message deleted.")
+    end
+  end
+  
+  protected
+  
+  # Returns message number parsed from full_data:
+  #
+  # * No message number => :all
+  # * Message does not exists => :invalid
+  # * valid message number => some fixnum
+  def message_number(full_data)
+    if /\w*\s*\d/ =~ full_data
+      messagenum = full_data.gsub(/\D/,"").to_i
+      messages = Store.instance.get
+      if messages.length >= messagenum && messagenum > 0
+        return messagenum
+      else
+        return :invalid
+      end
+    else
+      return :all
+    end
+  end
+  
+  # Respond to client with a POP3 prefix (+OK or -ERR)
+  def respond(client, status, message)
+    super(client, "#{status ? "+OK" : "-ERR"} #{message}\r\n")
+  end
+
+  def message_uid(message)
+    Digest::MD5.hexdigest(message)
+  end
+end

data/lib/smtp_server.rb

@@ -0,0 +1,134 @@
+require 'generic_server.rb'
+require 'store.rb'
+
+# Basic SMTP server
+
+class SMTPServer < GenericServer
+  attr_accessor :client_data
+  
+  # Create new server listening on port 25
+  def initialize
+    self.client_data = Hash.new
+    super(:port => 25)
+  end
+  
+  # Send a greeting to client
+  def greet(client)
+    respond(client, 220)
+  end
+  
+  # Process command
+  def process(client, command, full_data)
+    case command
+      when 'DATA' then data(client)
+      when 'HELO', 'EHLO' then respond(client, 250)
+      when 'MAIL' then mail_from(client, full_data)
+      when 'QUIT' then quit(client)
+      when 'RCPT' then rcpt_to(client, full_data)
+      when 'RSET' then rset(client)
+      else begin
+        if get_client_data(client, :sending_data)
+          append_data(client, full_data)
+        else
+          respond(client, 500)
+        end
+      end
+    end
+  end
+  
+  # Closes connection
+  def quit(client)
+    respond(client, 221)
+    client.close
+  end
+  
+  # Stores sender address
+  def mail_from(client, full_data)
+    if /^MAIL FROM:/ =~ full_data.upcase
+      set_client_data(client, :from, full_data.gsub(/^MAIL FROM:/i,""))
+      respond(client, 250)
+    else
+      respond(client, 500)
+    end
+  end
+  
+  # Stores recepient address
+  def rcpt_to(client, full_data)
+    if /^RCPT TO:/ =~ full_data.upcase
+      set_client_data(client, :to, full_data.gsub(/^RCPT TO:/i,""))
+      respond(client, 250)
+    else
+      respond(client, 500)
+    end
+  end
+  
+  # Markes client sending data
+  def data(client)
+    set_client_data(client, :sending_data, true)
+    respond(client, 354)
+  end
+  
+  # Resets local client store
+  def rset(client)
+    self.client_data[client.object_id] = Hash.new
+  end
+  
+  # Adds full_data to incoming mail message
+  #
+  # We'll store the mail when full_data == "."
+  def append_data(client, full_data)
+    if full_data.gsub(/[\r\n]/,"") == "."
+      Store.instance.add(
+        get_client_data(client, :from).to_s,
+        get_client_data(client, :to).to_s,
+        get_client_data(client, :data).to_s
+      )
+      respond(client, 250)
+    else
+      set_client_data(client, :data, get_client_data(client, :data).to_s + full_data)
+    end
+  end
+  
+  protected
+  
+  # Store key value combination for this client
+  def set_client_data(client, key, value)
+    self.client_data[client.object_id] = Hash.new unless self.client_data.include?(client.object_id)
+    self.client_data[client.object_id][key] = value
+  end
+  
+  # Retreive key from local client store
+  def get_client_data(client, key)
+    self.client_data[client.object_id][key] if self.client_data.include?(client.object_id)
+  end
+  
+  # Respond to client using a standard SMTP response code
+  def respond(client, code)
+    super(client, "#{code} #{SMTPServer::RESPONSES[code].to_s}")
+  end
+  
+  # Standard SMTP response codes
+  RESPONSES = {
+    500 => "Syntax error, command unrecognized",
+    501 => "Syntax error in parameters or arguments",
+    502 => "Command not implemented",
+    503 => "Bad sequence of commands",
+    504 => "Command parameter not implemented",
+    211 => "System status, or system help respond",
+    214 => "Help message",
+    220 => "Bluerail Post Office Service ready",
+    221 => "Bluerail Post Office Service closing transmission channel",
+    421 => "Bluerail Post Office Service not available,",
+    250 => "Requested mail action okay, completed",
+    251 => "User not local; will forward to <forward-path>",
+    450 => "Requested mail action not taken: mailbox unavailable",
+    550 => "Requested action not taken: mailbox unavailable",
+    451 => "Requested action aborted: error in processing",
+    551 => "User not local; please try <forward-path>",
+    452 => "Requested action not taken: insufficient system storage",
+    552 => "Requested mail action aborted: exceeded storage allocation",
+    553 => "Requested action not taken: mailbox name not allowed",
+    354 => "Start mail input; end with <CRLF>.<CRLF>",
+    554 => "Transaction failed"
+  }.freeze
+end

data/lib/store.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+require 'singleton'
+
+# Message storage
+
+class Store
+  include Singleton
+  attr_accessor :messages
+  
+  def initialize
+    self.messages = []
+  end
+
+  # Returns array of messages
+  def get
+    return messages
+  end
+  
+  # Saves message in storage
+  def add(mail_from, rcpt_to, message_data)
+    messages.push message_data
+  end
+  
+  # Removes message from storage
+  def remove(index)
+    self.messages[index] = nil
+  end
+  
+  # Remove empty messages
+  def truncate
+    self.messages = self.messages.reject{ |message| message.nil? }
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: post_office
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rene van Lieshout
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 +02:00
+default_executable: post_office
+dependencies: []
+
+description: A mock SMTP/POP3 server to aid in the development of applications with mail functionality.
+email: rene@bluerail.nl
+executables: 
+- post_office
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- README.md
+- VERSION
+- lib/generic_server.rb
+- lib/pop_server.rb
+- lib/smtp_server.rb
+- lib/store.rb
+- bin/post_office
+has_rdoc: true
+homepage: http://github.com/bluerail/post_office
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: PostOffice mock SMTP/POP3 server
+test_files: []
+