net-receiver 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57dd413a29c66bd22d3180358883ec568e373c28
-  data.tar.gz: 4bb6ee9f711267d8b21c541c6436a04729c3c2d9
+  metadata.gz: ef9bf25b367b217a2f1f8a3da082c3edefcf8621
+  data.tar.gz: 507779eff98d8a1c03d980824c37e8bd8e54416a
 SHA512:
-  metadata.gz: 3bb7ccee9c50eb0d09e55eca0a4f7c6f9fa5a45d975c0d3393d48a62b5dc622a7d77cba6c5ad9d3625c9e1d347f1634986588c2c075319b565ab62e67b3e80e3
-  data.tar.gz: 0bc5705a43c46d1200130385e787a448b10af74431ed38767f30339b999c960a94de3cf4a8ec23aedb3f42597be91798e1d0a161f245af9d05eb97c514ff1f67
+  metadata.gz: c293edb6d7d16915411e33838781290137ab4b3fd3ac7ee14e48b8ac9dff01e174dc5baa412bdb046cac9c02554f5e54e89864c9e39b53df5f39b179bbc5b12e
+  data.tar.gz: 89be49e4cfecfed76a66ec46ed80394b13f1b2db4887ac37a30888548ec594544cadfd13c0a10535662a7c4a73602e4cf8e69104ddc32c11c55a589b36d75e05

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# v1.2.0
+Simplified the send_text and recv_text by moving the error handling to the end of Receiver#receive, and removing redundent statements. Removed the code which handled those errors (SLAM and TIMEOUT) from the Patterns list, and removed the associated handler code.
+
+Fixed the accept logic to accept the email if one or more RCPT TO commands were valid (as opposed to requiring all to be valid).
+
+Added an SPF check for the MAIL FROM address. To learn more about SPF, go to `http://www.openspf.org/`. The SPF check result goes to `@mail[:mailfrom][:spf]`.
+
 # v1.1.0
 Changed the defaults for :sender_mx_check and recipient_mx_check to true because the cost is low and we need to know if the sender has a mail server (remote-->local), or if the recipient has a mail server (local-->remote). You can still turn off these checks, if you don't want them.
 
@@ -11,7 +18,5 @@ In `psych_value`, added a test for "MAIL FROM: <>" (a bounce message). In the ca
   },
 ````
 
-
-
 # v1.0.0
 This is the initial load of the gem. If you find a problem, report it to me at mjwelchphd@gmail.com, or FORK the library, fix the bug, then add a Pull Request.

data/lib/net/item_of_mail.rb

@@ -14,6 +14,7 @@
 # See the README.md for documentation.
 
 require 'sequel'
+require 'spf'
 
 module Net
   class ItemOfMail < Hash
@@ -33,45 +34,11 @@ module Net
       self[:time] = Time.now.strftime("%Y-%m-%d %H:%M:%S %z")
     end
 
-    def parse_headers
-      self[:data][:headers] = {}
-      header = ""
-      self[:data][:text].each do |line|
-        case
-        when line.nil?
-          break
-        when line =~ /^[ \t]/
-          header << String::new(line)
-        when line.empty?
-          break
-        when !header.empty?
-          keyword, value = header.split(":", 2)
-          self[:data][:headers][keyword.downcase.gsub("-","_").to_sym] = value.strip
-          header = String::new(line)
-        else
-          header = String::new(line)
-        end
-      end
-      if !header.empty?
-        keyword, value = header.split(":", 2)
-        self[:data][:headers][keyword.downcase.gsub("-","_").to_sym] = if !value.nil? then value.strip else "" end
-      end
-    end
-
-    def spf_check(scope,identity,ip,ehlo)
-      spf_server = SPF::Server.new
-      begin
-        request = SPF::Request.new(
-          versions:      [1, 2],
-          scope:         scope,
-          identity:      identity,
-          ip_address:    ip,
-          helo_identity: ehlo)
-        spf_server.process(request).code
-      rescue SPF::OptionRequiredError => e
-        @log.info("%06d"%Process::pid) {"SPF check failed: #{e.to_s}"}
-        :fail
-      end
+    def reconstituted_email
+      text = []
+      self[:data][:headers].each { |k,v| text << "#{k}:#{v}" }
+      text.concat(self[:data][:text])
+      text.join(CRLF)+CRLF
     end
   end
 end

data/lib/net/receiver.rb

@@ -17,8 +17,9 @@ require 'net/server'
 require 'net/item_of_mail'
 require 'net/extended_classes'
 require 'pdkim'
+require 'spf'
 
-class Quit < Exception; end
+class Slam < Exception; end
 
 module Net
 
@@ -27,8 +28,6 @@ module Net
     CRLF = "\r\n"
     Patterns = [
       [0, "[ /t]*QUIT[ /t]*", :do_quit],
-      [0, "[ /t]*SLAM[ /t]*", :do_slam],
-      [0, "[ /t]*TIMEOUT[ /t]*", :do_timeout],
       [1, "[ /t]*AUTH[ /t]*(.+)", :do_auth],
       [1, "[ /t]*EHLO(.*)", :do_ehlo],
       [1, "[ /t]*EXPN[ /t]*", :do_expn],
@@ -36,7 +35,6 @@ module Net
       [1, "[ /t]*HELP[ /t]*", :do_help],
       [1, "[ /t]*NOOP[ /t]*", :do_noop],
       [1, "[ /t]*RSET[ /t]*", :do_rset],
-      [1, "[ /t]*TIMEOUT[ /t]*", :do_timeout],
       [1, "[ /t]*VFRY[ /t]*", :do_vfry],
       [2, "[ /t]*STARTTLS[ /t]*", :do_starttls],
       [2, "[ /t]*MAIL FROM[ /t]*:[ \t]*(.+)", :do_mail_from],
@@ -67,7 +65,8 @@ module Net
       @connection = connection
       @option_list = [[:ehlo_validation_check, false], [:sender_character_check, true],
         [:recipient_character_check, true], [:sender_mx_check, true],
-        [:recipient_mx_check, true],[:max_failed_msgs_per_period,3]]
+        [:recipient_mx_check, true],[:max_failed_msgs_per_period,3],
+        [:copy_to_sysout, false]]
       @options = options
       @option_list.each do |key,value|
         @options[key] = value if !options.has_key?(key)
@@ -75,80 +74,41 @@ module Net
       @enc_ind = '-'
     end
 
-#-------------------------------------------------------#
-#--- Send text to the client ---------------------------#
-#-------------------------------------------------------#
-    def log_msg_if_level_5(msg)
-      if msg[0]=='5'
-        m = msg.match(/^([0-9]{3} [0-9]\.[0-9]\.[0-9] )/)
-        start = if !m then 0 else m[1].size end
-        LOG.error("%06d"%Process::pid) {msg[start..-1]}
-      end
-    end
-
-    def write_text(text, echo)
-puts "<#{@enc_ind}  #{text.inspect}" # DEBUG!
-      @connection.write(text)
-      @connection.write(CRLF)
-      @has_level_5_warnings = true if text[0]=='5'
-      LOG.info("%06d"%Process::pid) {"<#{@enc_ind}  #{text}"} if echo && LogConversation
-      log_msg_if_level_5(text)
-    end
+#=======================================================================
+# send text to the client
 
     def send_text(text,echo=true)
-      begin
-        case
-        when text.nil?
-          # do nothing
-        when text.class==Array
-          text.each { |line| write_text(line, echo) }
-        when text.class==String
-          write_text(text, echo)
+      if !text.nil?
+        text = [ text ] if text.class==String
+        text.each do |line|
+          puts "<#{@enc_ind}  #{text.inspect}" if @options[:copy_to_sysout]
+          @connection.write(line)
+          @connection.write(CRLF)
+          @has_level_5_warnings = true if line[0]=='5'
+          LOG.info("%06d"%Process::pid) {"<#{@enc_ind}  #{text}"} if echo && LogConversation
+          m = line.match(/^5[0-9]{2} [0-9]\.[0-9]\.[0-9] (.*)$/)
+          LOG.error("%06d"%Process::pid) {m[1]} if m
         end
-      rescue Errno::EPIPE => e
-        LOG.error("%06d"%Process::pid) {"#{e.to_s}#{Unexpectedly}"}
-        raise Quit
-      rescue Errno::EIO => e
-        LOG.error("%06d"%Process::pid) {"#{e.to_s}#{Unexpectedly}"}
-        raise Quit
       end
+      return nil
     end
 
-#-------------------------------------------------------#
-#--- Receive text from the client ----------------------#
-#-------------------------------------------------------#
+#=======================================================================
+# receive text from the client
+
     def recv_text(echo=true)
-      begin
-        Timeout.timeout(ReceiverTimeout) do
-          begin
-            temp = @connection.gets
-            if temp.nil?
-              LOG.warn("%06d"%Process::pid) {"The client abruptly closed the connection"}
-              text = "QUIT"
-            else
-              text = temp.chomp
-            end
-          rescue Errno::ECONNRESET => e
-            LOG.warn("%06d"%Process::pid) {"The client slammed the connection shut"}
-            text = "SLAM"
-          end
-          LOG.info("%06d"%Process::pid) {" #{@enc_ind}> #{text}"} if echo && LogConversation
-puts " #{@enc_ind}> #{text.inspect}" # DEBUG!
-          return text
-        end
-      rescue Errno::EIO => e
-        LOG.error("%06d"%Process::pid) {"#{e.to_s}"}
-        raise Quit
-      rescue Timeout::Error => e
-puts " #{@enc_ind}> \"TIMEOUT\"" # DEBUG!
-        return "TIMEOUT"
+      Timeout.timeout(ReceiverTimeout) do
+        raise Slam if (temp = @connection.gets).nil?
+        text = temp.chomp
+        LOG.info("%06d"%Process::pid) {" #{@enc_ind}> #{text}"} if echo && LogConversation
+        puts " #{@enc_ind}> #{text.inspect}" if @options[:copy_to_sysout]
+        return text
       end
-puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
     end
 
-#-------------------------------------------------------#
-#--- Parse the email address and investigate it --------#
-#-------------------------------------------------------#
+#=======================================================================
+# parse the email address and investigate it
+
     def psych_value(kind, part, value)
       # the value gets set in both MAIL FROM and RCPT TO
       part[:value] = value
@@ -206,9 +166,9 @@ puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
       return nil
     end
 
-#-------------------------------------------------------#
-#--- Receive the connection ----------------------------#
-#-------------------------------------------------------#
+#=======================================================================
+# receive the connection
+
     def receive(local_port, local_hostname, remote_port, remote_hostname, remote_ip)
       # Start a hash to collect the information gathered from the receive process
       @mail = Net::ItemOfMail::new(local_port, local_hostname, remote_port, remote_hostname, remote_ip)
@@ -234,8 +194,6 @@ puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
             case
             when pattern[2]==:do_quit
               send_text(do_quit(m[1]))
-            when pattern[2]==:do_slam
-              send_text(do_slam(m[1]))
             when @mail[:prohibited]
               send_text("450 4.7.1 Sender IP #{@mail[:remote_ip]} is temporarily prohibited from sending")
             when pattern[0]>@level
@@ -251,18 +209,18 @@ puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
           response = "500 5.5.1 Unrecognized command #{text.inspect}, incorrectly formatted command, or command out of sequence"
           send_text(response)
         end
-      rescue OpenSSL::SSL::SSLError => e
-        LOG.error("%06d"%Process::pid) {"SSL error: #{e.inspect}"}
-        e.backtrace.each { |line| LOG.error("%06d"%Process::pid) {line} }
-        @done = true
       end until @done
 
-    rescue Quit => e
+    rescue OpenSSL::SSL::SSLError, Errno::ECONNRESET, Errno::EIO, Errno::EPIPE, Timeout::Error => e
+      LOG.error("%06d"%Process::pid) {e}
+      @mail[:accepted] = false
+
+    rescue Slam
+      LOG.info("%06d"%Process::pid) {"Sender slammed the connection shut IP=#{@mail[:remote_ip]}"}
       @mail[:accepted] = false
-      # nothing to do but exit
 
     rescue => e
-      # this is the "rescue of last resort"... "for when sh*t happens"
+      # this is the "rescue of last resort"... for "when sh*t happens"
       LOG.fatal("%06d"%Process::pid) {e.inspect}
       e.backtrace.each { |line| LOG.fatal("%06d"%Process::pid) {line} }
       @mail[:accepted] = false
@@ -280,7 +238,8 @@ puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
     end
 
 #=======================================================================
-# these methods provide all the basic processing
+# these methods provide all the basic processing that needs to be done
+# regardless of any additional checks that you make want to make
 
     def ok?(msg)
       msg[0]!='4' && msg[0]!='5'
@@ -318,19 +277,6 @@ puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
       return msg
     end
 
-    def do_slam(value)
-      LOG.info("%06d"%Process::pid) {"Sender slammed the connection shut IP=#{@mail[:remote_ip]}"}
-      @done = true
-      @mail[:accepted] = false
-      return nil
-    end
-
-    def do_timeout(value)
-      @done = true
-      @mail[:accepted] = false
-      return ("501 5.4.7 Closing connection due to inactivity--#{@mail[:id]} was NOT saved")
-    end
-
     def do_auth(value)
       auth_type, auth_encoded = value.split
       # auth_encoded contains both username and password
@@ -387,7 +333,6 @@ puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
     def do_mail_from(value)
       @mail[:mailfrom] = p = {:accepted=>false}
       @mail[:rcptto] = []
-# TODO! A special case is the NULL envelope sender address (i.e. MAIL FROM: <>)
       msg = psych_value(:mailfrom, p, value)
       return (msg) if msg
 
@@ -413,33 +358,36 @@ puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
     end
 
     def do_data(value)
-# http://www.tldp.org/HOWTO/Spam-Filtering-for-MX/datachecks.html
       @mail[:data] = body = {}
       body[:accepted] = false
       # receive the body of the mail
       body[:value] = value # this should be nil -- no argument on the DATA command
+      body[:headers] = headers = {}
       body[:text] = lines = []
       send_text("354 3.0.0 Enter message, ending with \".\" on a line by itself", false)
       LOG.info("%06d"%Process::pid) {" -> (email message)"} if LogConversation
+
+      # get the headers into a hash
       while true
         text = recv_text(false)
-        break if text.nil? # the  client closed the channel abruptly
-        lines << text
-        if text=="."
+        if text.strip.empty?
           body[:accepted] = true
           break
         end
+        m = text.match(/^(.+?):(.+)$/)
+        return "501 5.5.2 Malformed header" if m.nil?
+        headers[m[1]] = m[2]
       end
-      @mail.parse_headers
-# should contain:
-# To: ...
-# Date: ...
-# From: ...
-# Subject: ...
-# Message-ID: ...
 
-# DKIM
-# SPF
+      # get the body into an array of strings
+      while true
+        text = recv_text(false)
+        if text=="."
+          body[:accepted] = true
+          break
+        end
+        lines << text
+      end
 
       # check the DKIM headers, if any
       ok, signatures = pdkim_verify_an_email(PDKIM_INPUT_NORMAL, @mail[:data][:text])
@@ -449,13 +397,28 @@ puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
         @mail[:signatures] << [signature[:domain], signature[:verify_status], DkimOutcomes[signature[:verify_status]]]
       end if ok==PDKIM_OK
 
+      # check the SPF, if any
+      begin
+        spf_server = SPF::Server.new
+        request = SPF::Request.new(
+          versions:      [1, 2],
+          scope:         'mfrom',
+          identity:      @mail[:mailfrom][:url],
+          ip_address:    @mail[:remote_ip],
+          helo_identity: @mail[:ehlo][:domain])
+        @mail[:mailfrom][:spf] = spf_server.process(request).code
+      rescue SPF::OptionRequiredError => e
+        @log.info("%06d"%Process::pid) {"SPF check failed: #{e.to_s}"}
+        @mail[:mailfrom][:spf] = :fail
+      end
+
       # test all the RCPT TOs
-      all_rcptto_accepted = true
-      @mail[:rcptto].each { |p| all_rcptto_accepted = false if !p[:accepted] } if @mail.has_key?(:rcptto)
+      any_rcptto_accepted = false
+      @mail[:rcptto].each { |p| any_rcptto_accepted = true if p[:accepted] } if @mail.has_key?(:rcptto)
       # passed thru the guantlet with no failures
       @mail[:accepted] = true \
         if @mail[:mailfrom][:accepted] &&
-          all_rcptto_accepted &&
+          any_rcptto_accepted &&
           @mail[:data][:accepted] &&
           @has_level_5_warnings==false
 
@@ -465,7 +428,8 @@ puts " #{@enc_ind}> *669* Investigate why this got here" # DEBUG!
     end
 
 #=======================================================================
-# these are the defaults, in case the user doesn't override
+# these are the defaults, in case the user doesn't override--you can
+# override these in your Receiver class in order to add tests
 
     def connect(remote_ip)
       return "220 2.0.0 ESMTP RubyMTA 0.01 #{Time.new.strftime("%^a, %d %^b %Y %H:%M:%S %z")}"

data/lib/net/version.rb

@@ -1,4 +1,4 @@
 module Net
-  BUILD_VERSION = "1.1.0"
-  BUILD_DATE = "2016-09-27"
+  BUILD_VERSION = "1.2.0"
+  BUILD_DATE = "2016-09-30"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: net-receiver
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Michael J. Welch, Ph.D.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-27 00:00:00.000000000 Z
+date: 2016-09-30 00:00:00.000000000 Z
 dependencies: []
 description: Ruby Net Receiver.
 email: