midi-smtp-server 3.1.2 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c84077c17fd5b68cffd37292da0e473245f16662041fb9a17218cd897961730
-  data.tar.gz: 299e676ad777d512b53d6c81a2a3b696eca00fb2d11adcaf2a3f24b6075c5fe1
+  metadata.gz: 2376ca7f3510ebe230523b2fd5629dc39a5c44f3415ce3980d1e27d156ac3397
+  data.tar.gz: eaeb5ae1fe8dd868b772d9dfa267665e2b0e8b6f63c4761cab2d861cac412499
 SHA512:
-  metadata.gz: 68446f6bb248f579689091fa094752f95db702ca6fc9f6de5588b68c1c564ee45499d71acee7b674b8784b78403a275e15afb5249e867571542e96c93ae608bd
-  data.tar.gz: 65c78a6d3ec2241756befc2a80a03691e74b37eed18093c0796ebd5a420f522b44f514e77b904f1a2ab7a97fb5862daaf7da2bcc3a5c2ba20000079111c3e994
+  metadata.gz: da5d3c16c081cd3c34be74d1f745bcc015e5c1fa9bbcdf6d55552e1e2c30df831ad63c025c86e4ffda078dc37b1c7bcf16d14fe512dbb91bbabb54dd9b2ca944
+  data.tar.gz: acbdac6c519f20758e9af7922094032ce3d3bc67e4874d8b37bac283e408ca303cd3fc47ae51b360e3ef9d1bfddc68bc620f5a105e4a68ca4a3d0ca3fef73ef6

data/CHANGELOG.md

@@ -5,6 +5,12 @@ We suggest everybody using MidiSmtpServer to switch at least to latest 2.3.y. or
 For upgrades from previous versions or outdated _MiniSmtpServer_ gem you may follow the guides at [Appendix Upgrade](https://midi-smtp-server.readthedocs.io/appendix_upgrade/) to get your code ready for the latest releases.
 
 
+#### 3.2.1 (2023-08-15)
+
+1. New feature [proxy](https://midi-smtp-server.readthedocs.io/feature_proxy) ([check issue 49](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/49))
+2. mkdocs update for readthedocs
+
+
 #### 3.1.2 (2023-05-06)
 
 1. Minor fix for backwards compatibility to method `start` when not using pre_fork options.

data/README.md

@@ -76,7 +76,11 @@ This source code shows the example to receive messages via SMTP and store them t
 
 ## Installation
 
-MidiSmtpServer is packaged as a RubyGem so that you can easily install by entering following at your command line:
+MidiSmtpServer is packaged as a RubyGem and hosted on rubygems.
+
+#### CLI
+
+You can easily install the package by entering following at your command line:
 
   `gem install midi-smtp-server`
 
@@ -84,6 +88,14 @@ Use the component in your project sources by:
 
   `require 'midi-smtp-server'`
 
+#### Gemfile
+
+When a `Gemfile` handles your dependencies, please consider to use the [pessimistic operator](https://thoughtbot.com/blog/rubys-pessimistic-operator) at least:
+
+  `gem 'midi-smtp-server', '~> 3.1.2''`
+
+All changes by PATCH versions are always functional and compatible with no issues on update!
+
 <br>
 
 
@@ -147,9 +159,10 @@ We suggest everybody using MidiSmtpServer to switch at least to latest 2.3.y. or
 For upgrades from previous versions or outdated _MiniSmtpServer_ gem you may follow the guides (see appendix) how to change your existing code to be compatible with the latest releases.
 
 
-#### Latest release: 3.1.2 (2023-05-06)
+#### Latest release: 3.2.1 (2023-08-15)
 
-1. Minor fix for backwards compatibility to method `start` when not using pre_fork options.
+1. New feature [proxy](https://midi-smtp-server.readthedocs.io/feature_proxy) ([check issue 49](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/49))
+2. mkdocs update for readthedocs
 
 
 #### Changelog history

data/lib/midi-smtp-server/version.rb

@@ -6,12 +6,12 @@ module MidiSmtpServer
   module VERSION
 
     MAJOR = 3
-    MINOR = 1
-    TINY = 2
+    MINOR = 2
+    TINY = 1
 
     STRING = [MAJOR, MINOR, TINY].compact.join('.')
 
-    DATE = '2023-05-06'
+    DATE = '2023-08-15'
 
   end
 

data/lib/midi-smtp-server.rb

@@ -33,6 +33,7 @@ module MidiSmtpServer
   DEFAULT_IO_BUFFER_MAX_SIZE = 1 * 1024 * 1024
 
   # default value for SMTPD extensions support
+  DEFAULT_PROXY_EXTENSION_ENABLED = false
   DEFAULT_PIPELINING_EXTENSION_ENABLED = false
   DEFAULT_INTERNATIONALIZATION_EXTENSIONS_ENABLED = false
 
@@ -214,6 +215,8 @@ module MidiSmtpServer
     attr_reader :pipelining_extension
     # handle SMTP 8BITMIME and SMTPUTF8 extension
     attr_reader :internationalization_extensions
+    # handle PROXY connections
+    attr_reader :proxy_extension
 
     # logging object, may be overridden by special loggers like YELL or others
     attr_reader :logger
@@ -233,6 +236,7 @@ module MidiSmtpServer
     # +io_buffer_max_size+:: max size of buffer (max line length) until \lf ist expected (DEFAULT_IO_BUFFER_MAX_SIZE, nil => disabled test)
     # +pipelining_extension+:: set to true for support of SMTP PIPELINING extension (DEFAULT_PIPELINING_EXTENSION_ENABLED)
     # +internationalization_extensions+:: set to true for support of SMTP 8BITMIME and SMTPUTF8 extensions (DEFAULT_INTERNATIONALIZATION_EXTENSIONS_ENABLED)
+    # +proxy_extension+:: set to true for supporting PROXY connections (DEFAULT_PROXY_EXTENSION_ENABLED)
     # +auth_mode+:: enable builtin authentication support (:AUTH_FORBIDDEN [default], :AUTH_OPTIONAL, :AUTH_REQUIRED)
     # +tls_mode+:: enable builtin TLS support (:TLS_FORBIDDEN [default], :TLS_OPTIONAL, :TLS_REQUIRED)
     # +tls_cert_path+:: path to tls certificate chain file
@@ -257,6 +261,7 @@ module MidiSmtpServer
       io_buffer_max_size: nil,
       pipelining_extension: nil,
       internationalization_extensions: nil,
+      proxy_extension: nil,
       auth_mode: nil,
       tls_mode: nil,
       tls_cert_path: nil,
@@ -397,6 +402,8 @@ module MidiSmtpServer
       # smtp extensions
       @pipelining_extension = pipelining_extension.nil? ? DEFAULT_PIPELINING_EXTENSION_ENABLED : pipelining_extension
       @internationalization_extensions = internationalization_extensions.nil? ? DEFAULT_INTERNATIONALIZATION_EXTENSIONS_ENABLED : internationalization_extensions
+      @proxy_extension = proxy_extension.nil? ? DEFAULT_PROXY_EXTENSION_ENABLED : proxy_extension
+      require 'ipaddr' if @proxy_extension
 
       # check for authentication
       @auth_mode = auth_mode.nil? ? DEFAULT_AUTH_MODE : auth_mode
@@ -482,6 +489,13 @@ module MidiSmtpServer
     # the value is not allowed to return CR nor LF chars and will be stripped
     def on_helo_event(ctx, helo_data) end
 
+    # event on PROXY
+    # you may raise an exception if you want to block some addresses
+    # you also may change or add any value of the hash:
+    # {proto, source_ip, source_host, source_port, dest_ip, dest_host, dest_port}
+    # a returned value hash is set as ctx[:server][:proxy]
+    def on_proxy_event(ctx, proxy_data) end
+
     # check the authentication on AUTH
     # if any value returned, that will be used for ongoing processing
     # otherwise the original value will be used for authorization_id
@@ -772,7 +786,7 @@ module MidiSmtpServer
               # process commands and handle special SmtpdExceptions
               begin
                 # check for pipelining extension or violation
-                raise Smtpd500PipeliningException unless @pipelining_extension || !io_buffer_line_lf || (session[:cmd_sequence] == :CMD_DATA)
+                raise Smtpd500PipeliningException unless !io_buffer_line_lf || @pipelining_extension || (proxy_extension && (session[:cmd_sequence] == :CMD_HELO)) || (session[:cmd_sequence] == :CMD_DATA)
 
                 # handle input line based on @crlf_mode
                 case crlf_mode
@@ -952,6 +966,88 @@ module MidiSmtpServer
                 return "250 OK #{session[:ctx][:server][:helo_response].to_s.strip}".strip
             end
 
+          when @proxy_extension && (/^PROXY(\s+)/i)
+            # PROXY
+            # 250 Requested mail action okay, completed
+            # 421 <domain> Service not available, closing transmission channel
+            # 500 Syntax error, command unrecognised
+            # 501 Syntax error in parameters or arguments
+            # ---------
+            # Documentation at https://github.com/haproxy/haproxy/blob/master/doc/proxy-protocol.txt
+            # syntax
+            # PROXY PROTO source-ip dest-ip source-port dest-port
+            # supported commands:
+            # PROXY TCP4 255.255.255.255 255.255.255.255 65535 65535
+            # PROXY TCP6 ffff:f...f:ffff ffff:f...f:ffff 65535 65535
+            # PROXY UNKNOWN
+            # PROXY UNKNOWN ffff:f...f:ffff ffff:f...f:ffff 65535 65535
+            # ---------
+            # check valid command sequence
+            raise Smtpd503Exception if session[:cmd_sequence] != :CMD_HELO
+            # check valid command
+            raise Smtpd421Exception, 'Abort connection while illegal PROXY command!' unless line.match?(/^PROXY(\s+)(UNKNOWN(|(\s+).*)|TCP(4|6)(\s+)([0-9a-f.:]+)(\s+)([0-9a-f.:]+)(\s+)([0-9]+)(\s+)([0-9]+)(\s*))$/i)
+            # check command usage is allowed only once
+            raise Smtpd421Exception, 'Abort connection while PROXY already set!' if session[:ctx][:server][:proxy]
+            # get values from proxy command
+            cmd_data = line.gsub(/^PROXY\ /i, '').strip.gsub(/\s+/, ' ').split
+            # create an empty hash to inspect by event
+            proxy_data = {
+              proto: cmd_data[0].upcase,
+              source_ip: nil,
+              source_host: nil,
+              source_port: nil,
+              dest_ip: nil,
+              dest_host: nil,
+              dest_port: nil
+            }
+            # test proto
+            unless proxy_data[:proto] == 'UNKNOWN'
+              begin
+                # try to build valid addresses from given strings
+                proxy_data[:source_ip] = IPAddr.new(cmd_data[1])
+                proxy_data[:source_port] = cmd_data[3].to_i
+                proxy_data[:dest_ip] = IPAddr.new(cmd_data[2])
+                proxy_data[:dest_port] = cmd_data[4].to_i
+                # check that given addresses correct by type
+                if proxy_data[:proto] == 'TCP4'
+                  raise unless proxy_data[:source_ip].ipv4?
+                  raise unless proxy_data[:dest_ip].ipv4?
+                else
+                  raise unless proxy_data[:source_ip].ipv6?
+                  raise unless proxy_data[:dest_ip].ipv6?
+                end
+                # check that ports within valid ranges
+                raise unless proxy_data[:source_port].between?(1, 65_535)
+                raise unless proxy_data[:dest_port].between?(1, 65_535)
+
+                # update hash to inspect by event
+                # normalize ip addresses
+                proxy_data[:source_ip] = proxy_data[:source_ip].to_s
+                proxy_data[:source_host] = proxy_data[:source_ip]
+                proxy_data[:dest_ip] = proxy_data[:dest_ip].to_s
+                proxy_data[:dest_host] = proxy_data[:dest_ip]
+
+              rescue StandardError
+                # change exception into Smtpd exception and drop connection
+                raise Smtpd421Exception, 'Abort connection for unsupported PROXY parameters!'
+              end
+            end
+
+            # call event to handle data
+            return_value = on_proxy_event(session[:ctx], proxy_data)
+            if return_value
+              # overwrite data with returned value
+              proxy_data = return_value
+            end
+            # if no error raised, append to server hash
+            session[:ctx][:server][:proxy] = proxy_data
+
+            # reply nothing
+            # otherwise on buffering clients or enabled feature pipelining
+            # the original client will receive unhandleable responses
+            # and gets interrupted
+            return ''
+
           when /^STARTTLS\s*$/i
             # STARTTLS
             # 220 Ready to start TLS
@@ -1294,6 +1390,7 @@ module MidiSmtpServer
             remote_host: +'',
             remote_ip: +'',
             remote_port: +'',
+            proxy: nil,
             helo: +'',
             helo_response: +'',
             connected: +'',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: midi-smtp-server
 version: !ruby/object:Gem::Version
-  version: 3.1.2
+  version: 3.2.1
 platform: ruby
 authors:
 - Tom Freudenberg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-08-15 00:00:00.000000000 Z
 dependencies: []
 description: MidiSmtpServer is the highly customizable ruby SMTP-Server and SMTP-Service
   library with builtin support for AUTH and SSL/STARTTLS, 8BITMIME and SMTPUTF8, IPv4
@@ -34,7 +34,7 @@ metadata:
   source_code_uri: https://github.com/4commerce-technologies-AG/midi-smtp-server
   changelog_uri: https://github.com/4commerce-technologies-AG/midi-smtp-server#changes-and-updates
   bug_tracker_uri: https://github.com/4commerce-technologies-AG/midi-smtp-server/issues
-  documentation_uri: https://www.rubydoc.info/gems/midi-smtp-server/3.1.2
+  documentation_uri: https://www.rubydoc.info/gems/midi-smtp-server/3.2.1
   wiki_uri: https://midi-smtp-server.readthedocs.io/
 post_install_message:
 rdoc_options: []
@@ -51,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: MidiSmtpServer Class