groat-smtpd 0.1.0

data/lib/groat/smtpd/base.rb

@@ -0,0 +1,159 @@
+# vim: set sw=2 sts=2 ts=2 et syntax=ruby: #
+=begin license
+  Copyright 2011 Novell, Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  Author(s):
+    Peter Bowen <pzbowen@gmail.com> Ottawa, Ontario, Canada
+=end
+
+require 'rubygems'
+require 'hooks'
+require 'timeout'
+
+module Groat
+module SMTPD
+  class Response < Exception
+    def initialize(args = {})
+      @message = args[:message] || "Unknown"
+      @terminate = args[:terminate] || false
+    end
+
+    def terminate?
+      @terminate
+    end
+
+    def reply_text
+      if @message.is_a? Array
+        @message.join("\r\n") + "\r\n"
+      else
+        @message.to_s + "\r\n"
+      end
+    end
+  end
+
+  class Base
+    include Hooks
+
+    @@numinstances = 0
+
+    def initialize
+      @response_class = Response
+      @instanceid = @@numinstances = @@numinstances + 1
+      @s = nil
+      @remote_address = nil
+      @remote_port = nil
+      reset_connection
+    end
+
+    def reply(args)
+      raise @response_class, args
+    end
+
+    def run(method, *args, &block)
+      if block_given?
+        yield
+      else
+        send method, *args
+      end
+    rescue Response => r
+      toclient r.reply_text
+      not r.terminate?
+    end
+
+    def process_line(line)
+    end
+
+    def send_greeting
+    end
+
+    def service_shutdown
+    end
+
+    def reset_connection
+    end
+
+    # Nothing in the base implements security
+    def secure?
+      false
+    end
+
+    def set_socket(io)
+      @s = io
+      x, @remote_port, x, @remote_address = io.peeraddr
+    end
+
+    def serve(io)
+      set_socket io
+      reset_connection
+      run :send_greeting
+      continue = true
+      while continue do
+        line = fromclient
+        break if line.nil?
+        continue = process_line line
+      end
+    rescue TimeoutError
+      run :service_shutdown
+    end
+
+    def sockop_timeout(method, arg, wait = 30)
+      begin
+        timeout(wait){
+          return @s.__send__(method, arg)
+        }
+      end
+    end
+
+    def getline
+      sockop_timeout(:gets, "\n")
+    end
+
+    def getdata(size)
+      sockop_timeout(:read, size)
+    end
+
+    def fromclient
+      line = getline
+      log_line(:in, line)
+    end
+
+    def log_line(direction, line)
+      if direction == :in
+        if line.nil?
+          puts "#{@instanceid}>/nil"
+        else
+          puts "#{@instanceid}>>" + line
+        end
+      else
+        if line.nil?
+          puts "#{@instanceid}</nil"
+        else
+          puts "#{@instanceid}<<" + line
+        end
+      end
+      line
+    end
+
+    def toclient(msg)
+      log_line(:out, msg)
+      @s.print(msg)
+    end
+
+    def clientdata?
+      IO.select([@s], nil, nil, 0.1)
+    end
+  end
+end
+end

data/lib/groat/smtpd/extensions/authentication.rb

@@ -0,0 +1,164 @@
+# vim: set sw=2 sts=2 ts=2 et syntax=ruby: #
+=begin license
+  Copyright 2011 Novell, Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  Author(s):
+    Peter Bowen <pzbowen@gmail.com> Ottawa, Ontario, Canada
+=end
+
+require 'base64'
+
+module Groat
+module SMTPD
+  module Extensions
+    module Authentication
+      module ClassMethods
+        def auth_mechanism(name, method, condition = nil)
+          sym = name.to_s.upcase.intern
+          auth_mechanisms[sym] = {} unless auth_mechanisms.has_key? sym
+          auth_mechanisms[sym] = {:method => method, :condition => condition}
+        end
+      end 
+
+      def reset_connection
+        @authenticated = false
+        super
+      end
+
+      def reset_buffers
+        @mail_auth = nil
+        super
+      end
+
+      def authenticated?
+        @authenticated
+      end
+
+      def auth_params
+        list = []
+        self.class.auth_mechanisms.each do |k, v|
+          valid = false
+
+          if v[:condition].nil?
+            valid = true
+          else
+            valid = send v[:condition]
+          end
+
+          list << k if valid
+        end
+        list
+      end
+
+      def show_auth_keyword?
+        not authenticated?
+      end
+
+      def response_auth_ok(args = {})
+        defaults = {:code => 235, :message => "Authentication Succeeded"}
+        reply defaults.merge(args)
+      end
+
+      def response_auth_temp_fail(args = {})
+        defaults = {:code => 454, :message => "Temporary Failure"}
+        reply defaults.merge(args)
+      end
+
+      def response_auth_required(args = {})
+        defaults = {:code => 530, :message => "Authentication required"}
+        reply defaults.merge(args)
+      end
+
+      def response_auth_failure(args = {})
+        defaults = {:code => 535, :message => "Credentials Invalid"}
+        reply defaults.merge(args)
+      end
+
+      def self.included mod
+        puts "Included RFC 4954: Authentication"
+        mod.extend ClassMethods
+        mod.inheritable_attr(:auth_mechanisms)
+        mod.auth_mechanisms = {}
+        mod.ehlo_keyword :auth, :auth_params, :show_auth_keyword?
+        mod.verb :auth, :smtp_verb_auth
+        mod.mail_param :auth, :mail_param_auth
+        mod.auth_mechanism :plain, :auth_mech_plain, :secure?
+        super
+      end
+
+
+      def validate_auth_plain(cid, zid, pass)
+        response_auth_temp_fail
+      end
+
+      # RFC 4616
+      def auth_mech_plain(arg)
+        response_bad_command_parameter(:message => "Encrypted session required", 
+                                       :terminate => false) unless secure?
+        pipelinable unless arg.nil?
+        check_command_group
+        if arg.nil?
+          toclient "334 \r\n"
+          arg = fromclient
+          arg.chomp!
+        end
+        if arg.eql? '*'
+          response_syntax_error(:message => "Authentication Quit")
+        end
+        if arg !~ BASE64_VALID
+          response_syntax_error(:message => "Bad response")
+        end
+        decoded = Base64.decode64(arg) 
+        cid, zid, pass = decoded.split("\000")
+        res = validate_auth_plain(cid, zid, pass)
+        if res
+          @authenticated = true
+          response_auth_ok
+        end
+      end
+
+      def auth_mechanism_method(name)
+        mech = self.class.auth_mechanisms[name]
+        unless mech.nil?
+          self.class.auth_mechanisms[name][:method]
+        end
+      end
+
+      BASE64_VALID = /\A[A-Z0-9\/+]*=*\Z/i
+
+      def smtp_verb_auth(args)
+        response_bad_syntax unless esmtp?
+        response_bad_sequence(:message => 'Already authenticated', 
+                              :terminate=> false) if authenticated?
+        response_bad_sequence if in_mail_transaction? 
+        mechanism, *initial_response = args.split(" ")
+        response_bad_command_parameter if mechanism.nil?
+        response_bad_command_parameter if initial_response.count > 1
+        if initial_response.count == 1 and initial_response[0] !~ BASE64_VALID
+          response_bad_command_parameter
+        end
+        mechanism = mechanism.to_s.upcase.intern
+        response_bad_command_parameter if auth_mechanism_method(mechanism).nil?
+        send auth_mechanism_method(mechanism), initial_response[0]
+      end
+
+      def mail_param_auth(param)
+        @mail_auth = from_xtext param
+        puts "MAIL AUTH=#{@mail_auth}"
+      end
+    end
+  end
+end
+end

data/lib/groat/smtpd/extensions/binarymime.rb

@@ -0,0 +1,48 @@
+# vim: set sw=2 sts=2 ts=2 et syntax=ruby: #
+=begin license
+  Copyright 2011 Novell, Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  Author(s):
+    Peter Bowen <pzbowen@gmail.com> Ottawa, Ontario, Canada
+=end
+
+module Groat
+module SMTPD
+  module Extensions
+    module BinaryMIME
+      def self.included mod
+        puts "Included RFC 3030: BINARYMIME"
+        raise SMTPExtensionError.new("BINARYMIME requires CHUNKING") unless mod.ehlo_keyword_known? :chunking
+        mod.ehlo_keyword :binarymime
+        mod.mail_param :body, :mail_param_body
+        @body_encodings = [] if @body_encodings.nil?
+        @body_encodings << "BINARYMIME" unless @body_encodings.include? "BINARYMIME"
+        @body_encodings << "7BIT" unless @body_encodings.include? "7BIT"
+        super
+      end
+
+      def mail_param_body(param)
+        param.upcase!
+        unless @body_encodings.include? param
+          response_bad_parameter(:message => "Unown mail body type")
+        end
+        end
+        @mail_body = param
+        puts "MAIL BODY=#{@mail_body}"
+      end
+    end
+  end
+end
+end

data/lib/groat/smtpd/extensions/chunking.rb

@@ -0,0 +1,57 @@
+# vim: set sw=2 sts=2 ts=2 et syntax=ruby: #
+=begin license
+  Copyright 2011 Novell, Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  Author(s):
+    Peter Bowen <pzbowen@gmail.com> Ottawa, Ontario, Canada
+=end
+
+module Groat
+module SMTPD
+  module Extensions
+    module Chunking
+      def self.included mod
+        puts "Included RFC 3030: CHUNKING"
+        mod.ehlo_keyword :chunking
+        mod.verb :bdat, :smtp_verb_bdat
+      end
+
+      # BDAT is unusual in that the sender just shoves data at us
+      # We need to grab that data before we response so as not to
+      # try to parse it as commands
+      def smtp_verb_bdat(args)
+        arglist = args.split(' ')
+        # No size means nothing to do
+        if arglist.count < 1
+          response_syntax_error :message => "Chunk size must be specified"
+        end
+        # The chunk size must be numeric
+        if arglist[0] !~ /\A[0-9]+\Z/
+          response_syntax_error :message => "Bad chunk size"
+        end
+        # Basic sanity passed, we must grab the data
+        data = getdata(arglist[0].to_i)
+        return response_no_valid_rcpt if @rcptto.count < 1
+        if arglist.count > 2
+          response_syntax_error
+        elsif arglist.count == 2 and arglist[1].upcase != "LAST"
+          response_syntax_error :message => "Bad end marker"
+        end
+        response_ok
+      end
+    end
+  end
+end
+end

data/lib/groat/smtpd/extensions/eightbitmime.rb

@@ -0,0 +1,47 @@
+# vim: set sw=2 sts=2 ts=2 et syntax=ruby: #
+=begin license
+  Copyright 2011 Novell, Inc.
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+
+  Author(s):
+    Peter Bowen <pzbowen@gmail.com> Ottawa, Ontario, Canada
+=end
+
+module Groat
+module SMTPD
+  module Extensions
+    module EightBitMIME
+      def self.included mod
+        puts "Included RFC 1652: 8bit-MIMEtransport"
+        mod.ehlo_keyword :"8bitmime"
+        mod.mail_param :body, :mail_param_body
+        @body_encodings = [] if @body_encodings.nil?
+        @body_encodings << "8BITMIME" unless @body_encodings.include? "8BITMIME"
+        @body_encodings << "7BIT" unless @body_encodings.include? "7BIT"
+        super
+      end
+
+
+      def mail_param_body(param)
+        param.upcase!
+        unless @body_encodings.include? param
+          response_bad_parameter(:message => "Unown mail body type")
+        end
+        @mail_body = param
+        puts "MAIL BODY=#{@mail_body}"
+      end
+    end
+  end
+end
+end