midi-smtp-server 3.0.3 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a57da18e0a784683fa297898113f75967fb3adb852270e22b733f7b8bd29e7d0
-  data.tar.gz: 95d9bdb5940ddcd8d49fbf3dd0f7b8f023235d58de00ee1c49be0aeb97da3101
+  metadata.gz: 2376ca7f3510ebe230523b2fd5629dc39a5c44f3415ce3980d1e27d156ac3397
+  data.tar.gz: eaeb5ae1fe8dd868b772d9dfa267665e2b0e8b6f63c4761cab2d861cac412499
 SHA512:
-  metadata.gz: 37260846efd563b0b66ecf25e50b61b521c21a653a100cac2b2bceb8d40ed02c622b056f2e7835715568fe82317e5527148a67da4ba7d2cb840c84dda655ca45
-  data.tar.gz: bc79e07e38642e758b3658a2776afcd9605d75e8061d77c5dd4ea21829330ac02e65c1db07faf45a7916f00996dcba2799842ec2e1aafdb1eea3518dcff7ffed
+  metadata.gz: da5d3c16c081cd3c34be74d1f745bcc015e5c1fa9bbcdf6d55552e1e2c30df831ad63c025c86e4ffda078dc37b1c7bcf16d14fe512dbb91bbabb54dd9b2ca944
+  data.tar.gz: acbdac6c519f20758e9af7922094032ce3d3bc67e4874d8b37bac283e408ca303cd3fc47ae51b360e3ef9d1bfddc68bc620f5a105e4a68ca4a3d0ca3fef73ef6

data/CHANGELOG.md

@@ -4,9 +4,30 @@ 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.
+
+
+#### 3.1.1 (2023-02-26)
+
+1. Add option to additional activate [pre-forking workers](https://midi-smtp-server.readthedocs.io/feature_load_balancing/#pre-forking) (beta) ([check issue 42](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/42))
+2. Adjust sleep idle time while in command and data loop to speedup processing ([check issue 47](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/47))
+3. Mark the current default value `0.1` for `io_waitreadable_sleep` as deprecated, will become `0.03` in a future version.
+4. Modify github workflow and apply testing of ruby 3.1 and ruby 3.2
+5. Generate updated openssl test certificates for TLS tests
+
+
 #### 3.0.3 (2022-02-12)
 
-1. Critical fix for thread safety ([check issue 29](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/39))
+1. Critical fix for thread safety ([check issue 39](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/39))
 2. Fix tests using net/smtp '>= 0.3.1'
 
 
@@ -29,14 +50,13 @@ For upgrades from previous versions or outdated _MiniSmtpServer_ gem you may fol
 10. Dropped deprecated empty wildcard `""` support on initialize - please use specific hostnames and / or ip-addresses or star wildcard `"*"` only
 11. Align tests with Rubocop style and coding enforcements
 12. Added `rake` tasks for testing and linting, checkout `bundle exec rake -T`
-13. Re-defined arguments of methods `new`, `join`, `stop` as keyword arguments, check [minor incompatability: upgrade to 3.x](https://midi-smtp-server.readthedocs.io/appendix_upgrade/#upgrade-to-3x)
+13. Re-defined arguments of methods `new`, `join`, `stop` as keyword arguments, check [minor incompatibility: upgrade to 3.x](https://midi-smtp-server.readthedocs.io/appendix_upgrade/#upgrade-to-3x)
 14. Enhance the slack recipe in cookbook for [Docker usage](https://github.com/4commerce-technologies-AG/midi-smtp-server/tree/master/cookbook/recipe-slack)
 
 
 #### 2.3.3 (2022-02-12)
 
-1. Critical fix for thread safety ([check issue 29](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/39))
-2. Fix tests using net/smtp '>= 0.3.1'
+1. Critical fix for thread safety ([check issue 39](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/39))
 
 
 #### 2.3.2 (2020-01-21)
@@ -61,7 +81,7 @@ For upgrades from previous versions or outdated _MiniSmtpServer_ gem you may fol
 
 1. Support [IPv4 and IPv6 (documentation)](https://midi-smtp-server.readthedocs.io/instantiate/#ipv4-and-ipv6-ready)
 2. Support binding of [multiple ports and hosts / ip addresses](https://midi-smtp-server.readthedocs.io/instantiate/#ports-and-addresses)
-3. Handle [utilization of connections and processings](https://midi-smtp-server.readthedocs.io/feature_utilization/)
+3. Handle [utilization of connections and processings](https://midi-smtp-server.readthedocs.io/feature_load_balancing/)
 4. Support of RFC(2)822 [CR LF modes](https://midi-smtp-server.readthedocs.io/feature_cr_lf_modes/)
 5. Support (optionally) SMTP [PIPELINING](https://tools.ietf.org/html/rfc2920) extension
 6. Support (optionally) SMTP [8BITMIME](https://midi-smtp-server.readthedocs.io/feature_8bitmime_smtputf8/) extension
@@ -104,7 +124,7 @@ For upgrades from previous versions or outdated _MiniSmtpServer_ gem you may fol
 
 #### 2.x
 
-1. Modulized
+1. Modularized
 2. Removed dependency to GServer
 3. Additional events to interact with
 4. Use logger to log several messages from severity :debug up to :fatal

data/MIT-LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2014 - 2022 Tom Freudenberg
+Copyright (c) 2014 - 2023 Tom Freudenberg
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -19,7 +19,7 @@ MidiSmtpServer is the highly customizable ruby SMTP-Server and SMTP-Service libr
 
 As a library it is mainly designed to be integrated into your projects as serving a SMTP-Server service. The lib will do nothing with your mail and you have to create your own event functions to handle and operate on incoming mails. We are using this in conjunction with [Mikel Lindsaar](https://github.com/mikel) great Mail component (https://github.com/mikel/mail). Time to run your own SMTP-Server service.
 
-Checkout all the features and improvements (3.0.1 Logging enhancement, 2.3.x Multiple ports and addresses, 2.2.x Encryption [StartTLS], 2.1.0 Authentication [AUTH], 2.1.1 significant speed improvement, etc.) and get more details from section [changes and updates](https://github.com/4commerce-technologies-AG/midi-smtp-server#changes-and-updates).
+Checkout all the features and improvements (3.1.1 Process parallelization, 3.0.1 Logging enhancement, 2.3.x Multiple ports and addresses, 2.2.x Encryption [StartTLS], 2.1.0 Authentication [AUTH], 2.1.1 significant speed improvement, etc.) and get more details from section [changes and updates](https://github.com/4commerce-technologies-AG/midi-smtp-server#changes-and-updates).
 
 MidiSmtpServer is an extremely flexible library and almost any aspect of SMTP communications can be handled by deriving its events and using its configuration options.
 
@@ -40,10 +40,10 @@ class MySmtpd < MidiSmtpServer::Smtpd
     logger.debug("[#{ctx[:envelope][:from]}] for recipient(s): [#{ctx[:envelope][:to]}]...")
 
     # Just decode message once to make sure, that this message ist readable
-    @mail = Mail.read_from_string(ctx[:message][:data])
+    mail = Mail.read_from_string(ctx[:message][:data])
 
     # handle incoming mail, just show the message subject
-    logger.debug(@mail.subject)
+    logger.debug(mail.subject)
   end
 
 end
@@ -64,10 +64,10 @@ This source code shows the example to receive messages via SMTP and store them t
   # get each message after DATA <message> .
   def on_message_data_event(ctx)
     # Just decode message once to make sure, that this message ist readable
-    @mail = Mail.read_from_string(ctx[:message])
+    mail = Mail.read_from_string(ctx[:message])
 
     # Publish to rabbit
-    @bunny_exchange.publish(@mail.to_s, :headers => { 'x-smtp' => @mail.header.to_s }, :routing_key => "to_queue")
+    @bunny_exchange.publish(mail.to_s, :headers => { 'x-smtp' => mail.header.to_s }, :routing_key => "to_queue")
   end
 ```
 
@@ -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>
 
 
@@ -96,35 +108,35 @@ Read the [MidiSmtpServer Documentation](https://midi-smtp-server.readthedocs.io/
 
 ## Reliable code
 
-Since version 2.3 implementation and integration tests by minitest framework are added to this repository. While the implementation tests are mostly checking the components, the integration tests try to verify the correct exchange of messages for different scenarios. In addtion all sources are checked by rubocop to ensure they fit to the style guides.
+Since version 2.3 implementation and integration tests by minitest framework are added to this repository. While the implementation tests are mostly checking the components, the integration tests try to verify the correct exchange of messages for different scenarios. Last but not least the stress tests do catch some rare conditions to make sure that no information is leaving its thread and process. In addition all sources are checked by rubocop to ensure they fit to the style guides.
 
 You may run all rubocop tests through the `rake` helper:
 
-``` bash
+```bash
   bundle exec rake rubocop
 ```
 
 You may also run all tests through the `rake` helper:
 
-``` bash
+```bash
   bundle exec rake test:all
 ```
 
 or with more verbose output:
 
-``` bash
+```bash
   bundle exec rake test:all v=1
 ```
 
-To just run just a part of the tests, you may select the `specs`, `unit` or `integration` tests:
+To just run just a part of the tests, you may select the `specs`, `unit`, `integration` or `stress` tests:
 
-``` bash
+```bash
   bundle exec rake test:specs
 ```
 
 To just run some selected (by regular expression) tests, you may use the `T=filter` option. The example will run only the tests and specs containing the word _connections_ in their method_name or describe_text:
 
-``` bash
+```bash
   bundle exec rake test:all v=1 T=connections
 ```
 
@@ -146,10 +158,11 @@ 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.0.3 (2022-02-12)
 
-1. Critical fix for thread safety ([check issue 29](https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/39))
-2. Fix tests using net/smtp '>= 0.3.1'
+#### Latest release: 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
 
 
 #### Changelog history
@@ -171,6 +184,7 @@ Checkout the [Appendix Upgrade](https://midi-smtp-server.readthedocs.io/appendix
 You may find, use and download the gem package on [RubyGems.org](http://rubygems.org/gems/midi-smtp-server).
 
 [![Gem Version](https://badge.fury.io/rb/midi-smtp-server.svg)](http://badge.fury.io/rb/midi-smtp-server) &nbsp;
+[![Ruby](https://github.com/4commerce-technologies-AG/midi-smtp-server/actions/workflows/push-and-pr-testing-ruby-ci.yml/badge.svg)](https://github.com/4commerce-technologies-AG/midi-smtp-server/actions/workflows/push-and-pr-testing-ruby-ci.yml) &nbsp;
 
 <br>
 
@@ -189,6 +203,6 @@ You may find, use and download the gem package on [RubyGems.org](http://rubygems
 
 Author: [Tom Freudenberg](http://about.me/tom.freudenberg)
 
-[MidiSmtpServer Class](https://github.com/4commerce-technologies-AG/midi-smtp-server/) is inspired from [MiniSmtpServer Class](https://github.com/aarongough/mini-smtp-server) and code written by [Aaron Gough](https://github.com/aarongough) and [Peter Cooper](http://peterc.org/)
+[MidiSmtpServer Class](https://github.com/4commerce-technologies-AG/midi-smtp-server/) is inspired from [MiniSmtpServer Class](https://github.com/aarongough/mini-smtp-server) and code written by [Aaron Gough](https://github.com/aarongough) and [Peter Cooper](https://github.com/4commerce-technologies-AG/midi-smtp-server#author--credits)
 
-Copyright (c) 2014-2022 [Tom Freudenberg](http://www.4commerce.de/), [4commerce technologies AG](http://www.4commerce.de/), released under the MIT license
+Copyright (c) 2014-2023 [Tom Freudenberg](https://github.com/TomFreudenberg), [4commerce technologies AG](https://www.4commerce.de/), released under the MIT license

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

@@ -10,7 +10,7 @@ module MidiSmtpServer
   class SmtpdIOTimeoutException < RuntimeError
   end
 
-  # special internal exception to signal buffer size exceedance
+  # special internal exception to signal buffer size exceeding
   # while waiting for incoming data line
   class SmtpdIOBufferOverrunException < RuntimeError
   end
@@ -286,7 +286,7 @@ module MidiSmtpServer
 
   end
 
-  # Status when expeting CRLF sequence as line breaks (RFC(2)822)
+  # Status when expecting CRLF sequence as line breaks (RFC(2)822)
 
   # 500 Bad input, missing CRLF line termination
   class Smtpd500CrLfSequenceException < SmtpdException

data/lib/midi-smtp-server/tls-transport.rb

@@ -69,9 +69,9 @@ module MidiSmtpServer
         @ssl_context.cert.sign @ssl_context.key, OpenSSL::Digest.new('SHA256')
         logger.debug("SSL: generated test certificate\r\n#{@ssl_context.cert.to_text}")
       else
-        # if any is set, test the pathes
-        raise "File \”#{@cert_path}\" does not exist or is not a regular file. Could not load certificate." unless File.file?(@cert_path.to_s)
-        raise "File \”#{@key_path}\" does not exist or is not a regular file. Could not load private key." unless @key_path.nil? || File.file?(@key_path.to_s)
+        # if any is set, test the paths
+        raise "File \"#{@cert_path}\" does not exist or is not a regular file. Could not load certificate." unless File.file?(@cert_path.to_s)
+        raise "File \"#{@key_path}\" does not exist or is not a regular file. Could not load private key." unless @key_path.nil? || File.file?(@key_path.to_s)
         # try to load certificate and key
         cert_lines = File.read(@cert_path.to_s).lines
         # check if the cert file contains a chain of certs

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

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

data/lib/midi-smtp-server.rb

@@ -17,24 +17,27 @@ module MidiSmtpServer
   # default values
   DEFAULT_SMTPD_HOST = '127.0.0.1'
   DEFAULT_SMTPD_PORT = 2525
+  DEFAULT_SMTPD_PRE_FORK = 0
   DEFAULT_SMTPD_MAX_PROCESSINGS = 4
 
-  # default values for conformity to RFC(2)822 and addtionals
+  # default values for conformity to RFC(2)822 and additional
   # if interested in details, checkout discussion on issue queue at:
   # https://github.com/4commerce-technologies-AG/midi-smtp-server/issues/16
   CRLF_MODES = [:CRLF_ENSURE, :CRLF_LEAVE, :CRLF_STRICT].freeze
   DEFAULT_CRLF_MODE = :CRLF_ENSURE
 
   # default values for IO operations
+  DEFAULT_IO_WAITREADABLE_SLEEP = 0.1
   DEFAULT_IO_CMD_TIMEOUT = 30
   DEFAULT_IO_BUFFER_CHUNK_SIZE = 4 * 1024
   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
 
-  # Authentification modes
+  # Authentication modes
   AUTH_MODES = [:AUTH_FORBIDDEN, :AUTH_OPTIONAL, :AUTH_REQUIRED].freeze
   DEFAULT_AUTH_MODE = :AUTH_FORBIDDEN
 
@@ -43,31 +46,42 @@ module MidiSmtpServer
 
     public
 
-    # Start the server
+    # Create the server
     def start
-      serve_service
+      create_service
+      # immediately attach the threads to running single master process (default)
+      attach_threads unless pre_fork?
     end
 
     # Stop the server
     def stop(wait_seconds_before_close: 2, gracefully: true)
-      # always signal shutdown
-      shutdown if gracefully
-      # wait if some connection(s) need(s) more time to handle shutdown
-      sleep wait_seconds_before_close if connections?
-      # drop tcp_servers while raising SmtpdStopServiceException
-      @connections_mutex.synchronize do
-        @tcp_server_threads.each do |tcp_server_thread|
-          # use safe navigation (&.) to make sure that obj exists like ... if tcp_server_thread
-          tcp_server_thread&.raise SmtpdStopServiceException
+      begin
+        # signal pre_forked workers to stop
+        @workers.each { |worker_pid| Process.kill(:TERM, worker_pid) } if pre_fork? && master?
+        # always signal shutdown
+        shutdown if gracefully
+        # wait if some connection(s) need(s) more time to handle shutdown
+        sleep wait_seconds_before_close if connections?
+        # drop tcp_servers while raising SmtpdStopServiceException
+        @connections_mutex.synchronize do
+          @tcp_server_threads.each do |tcp_server_thread|
+            # use safe navigation (&.) to make sure that obj exists like ... if tcp_server_thread
+            tcp_server_thread&.raise SmtpdStopServiceException
+          end
         end
+
+      ensure
+        # check for removing TCPServers
+        @tcp_servers.each { |tcp_server| remove_tcp_server(tcp_server) } if master?
       end
+
       # wait if some connection(s) still need(s) more time to come down
       sleep wait_seconds_before_close if connections? || !stopped?
     end
 
     # Returns true if the server has stopped.
     def stopped?
-      @tcp_server_threads.empty? && @tcp_servers.empty?
+      master? ? @workers.empty? && @tcp_server_threads.empty? && @tcp_servers.empty? : @tcp_server_threads.empty?
     end
 
     # Schedule a shutdown for the server
@@ -100,34 +114,67 @@ module MidiSmtpServer
       @processings.any?
     end
 
+    # Return if in pre-fork mode
+    def pre_fork?
+      @pre_fork > 1
+    end
+
+    # Return if this is the master process
+    def master?
+      !@is_forked
+    end
+
+    # Return if this is a forked worker process
+    def worker?
+      @is_forked
+    end
+
+    # Return number of forked worker processes
+    def workers
+      @workers.size
+    end
+
+    # Return if has active forked worker processes
+    def workers?
+      @workers.any?
+    end
+
     # Join with the server thread(s)
     # before joining the server threads, check and wait optionally a few seconds
     # to let the service(s) come up
     def join(sleep_seconds_before_join: 1)
       # check already existing TCPServers
       return if @tcp_servers.empty?
-      # wait some seconds before joininig the upcoming threads
-      # and check that all TCPServers gots one thread
-      while (@tcp_server_threads.length < @tcp_servers.length) && sleep_seconds_before_join.positive?
-        sleep_seconds_before_join -= 1
-        sleep 1
-      end
-      # try to join any thread
-      begin
-        @tcp_server_threads.each(&:join)
+      # check number of processes to pre-fork
+
+      if pre_fork?
+        # create a number of pre-fork processes and attach and join threads within workers
+        @pre_fork.times do
+          # append worker pid to list of workers
+          @workers << fork do
+            # set state for a forked process
+            @is_forked = true
+            # just attach and join the threads to forked worker process
+            attach_threads
+            join_threads(sleep_seconds_before_join: sleep_seconds_before_join)
+          end
+        end
+        # Blocking wait until each worker process has been finished
+        @workers.each { |pid| Process.waitpid(pid) }
 
-      # catch ctrl-c to stop service
-      rescue Interrupt
+      else
+        # just join the threads to running single master process (default)
+        join_threads(sleep_seconds_before_join: sleep_seconds_before_join)
       end
     end
 
-    # Array of ports on which to bind, set as string seperated by commata like '2525, 3535' or '2525:3535, 2525'
+    # Array of ports on which to bind, set as string separated by commata like '2525, 3535' or '2525:3535, 2525'
     def ports
       # prevent original array from being changed
       @ports.dup
     end
 
-    # Array of hosts / ip_addresses on which to bind, set as string seperated by commata like 'name.domain.com, 127.0.0.1, ::1'
+    # Array of hosts / ip_addresses on which to bind, set as string separated by commata like 'name.domain.com, 127.0.0.1, ::1'
     def hosts
       # prevent original array from being changed
       @hosts.dup
@@ -139,7 +186,7 @@ module MidiSmtpServer
       @addresses.dup
     end
 
-    # Current TLS OpenSSL::SSL::SSLContext when initalized by :TLS_OPTIONAL, :TLS_REQUIRED
+    # Current TLS OpenSSL::SSL::SSLContext when initialized by :TLS_OPTIONAL, :TLS_REQUIRED
     def ssl_context
       @tls&.ssl_context
     end
@@ -150,15 +197,17 @@ module MidiSmtpServer
     attr_reader :max_connections
     # CRLF handling based on conformity to RFC(2)822
     attr_reader :crlf_mode
+    # Time in seconds to sleep on IO::WaitReadable exception
+    attr_reader :io_waitreadable_sleep
     # Maximum time in seconds to wait for a complete incoming data line, as a FixNum
     attr_reader :io_cmd_timeout
     # Bytes to read non-blocking from socket into buffer, as a FixNum
     attr_reader :io_buffer_chunk_size
-    # Maximum bytes to read as buffer before expecting completet incoming data line, as a FixNum
+    # Maximum bytes to read as buffer before expecting completed incoming data line, as a FixNum
     attr_reader :io_buffer_max_size
     # Flag if should do reverse DNS lookups on incoming connections
     attr_reader :do_dns_reverse_lookup
-    # Authentification mode
+    # Authentication mode
     attr_reader :auth_mode
     # Encryption mode
     attr_reader :encrypt_mode
@@ -166,26 +215,31 @@ 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 overrriden by special loggers like YELL or others
+    # logging object, may be overridden by special loggers like YELL or others
     attr_reader :logger
 
     # Initialize SMTP Server class
     #
     # +ports+:: ports to listen on. Allows multiple ports like "2525, 3535" or "2525:3535, 2525". Default value = DEFAULT_SMTPD_PORT
     # +hosts+:: interface ip or hostname to listen on or "*" to listen on all interfaces, allows multiple hostnames and ip_addresses like "name.domain.com, 127.0.0.1, ::1". Default value = DEFAULT_SMTPD_HOST
+    # +pre_fork+:: number of processes to pre-fork to enable load balancing over multiple cores. Default value = DEFAULT_SMTPD_PRE_FORK
     # +max_processings+:: maximum number of simultaneous processed connections, this does not limit the number of concurrent TCP connections. Default value = DEFAULT_SMTPD_MAX_PROCESSINGS
     # +max_connections+:: maximum number of connections, this does limit the number of concurrent TCP connections (not set or nil => unlimited)
     # +crlf_mode+:: CRLF handling support (:CRLF_ENSURE [default], :CRLF_LEAVE, :CRLF_STRICT)
     # +do_dns_reverse_lookup+:: flag if this smtp server should do reverse DNS lookups on incoming connections
+    # +io_waitreadable_sleep+:: seconds to sleep in loop when no input data is available (DEFAULT_IO_WAITREADABLE_SLEEP)
     # +io_cmd_timeout+:: time in seconds to wait until complete line of data is expected (DEFAULT_IO_CMD_TIMEOUT, nil => disabled test)
     # +io_buffer_chunk_size+:: size of chunks (bytes) to read non-blocking from socket (DEFAULT_IO_BUFFER_CHUNK_SIZE)
     # +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 cerificate chain file
+    # +tls_cert_path+:: path to tls certificate chain file
     # +tls_key_path+:: path to tls key file
     # +tls_ciphers+:: allowed ciphers for connection
     # +tls_methods+:: allowed methods for protocol
@@ -196,15 +250,18 @@ module MidiSmtpServer
     def initialize(
       ports: DEFAULT_SMTPD_PORT,
       hosts: DEFAULT_SMTPD_HOST,
+      pre_fork: DEFAULT_SMTPD_PRE_FORK,
       max_processings: DEFAULT_SMTPD_MAX_PROCESSINGS,
       max_connections: nil,
       crlf_mode: nil,
       do_dns_reverse_lookup: nil,
+      io_waitreadable_sleep: nil,
       io_cmd_timeout: nil,
       io_buffer_chunk_size: nil,
       io_buffer_max_size: nil,
       pipelining_extension: nil,
       internationalization_extensions: nil,
+      proxy_extension: nil,
       auth_mode: nil,
       tls_mode: nil,
       tls_cert_path: nil,
@@ -216,7 +273,7 @@ module MidiSmtpServer
       logger: nil,
       logger_severity: nil
     )
-      # create an exposed logger to forward loggings to the on_logging_event
+      # create an exposed logger to forward logging to the on_logging_event
       @logger = MidiSmtpServer::ForwardingLogger.new(method(:on_logging_event))
 
       # external logging
@@ -231,6 +288,11 @@ module MidiSmtpServer
         logger.warn('Deprecated: "logger" was set on new! Please use "on_logging_event" instead.')
       end
 
+      # initialize as master process
+      @is_forked = false
+      # no forked worker processes
+      @workers = []
+
       # list of TCPServers
       @tcp_servers = []
       # list of running threads
@@ -311,12 +373,16 @@ module MidiSmtpServer
         end
       end
 
+      # read pre_fork
+      @pre_fork = pre_fork
+      raise 'Number of processes to pre-fork (pre_fork) must be zero or a positive integer greater than 1!' unless @pre_fork.is_a?(Integer) && (@pre_fork.zero? || pre_fork?)
       # read max_processings
       @max_processings = max_processings
       raise 'Number of simultaneous processings (max_processings) must be a positive integer!' unless @max_processings.is_a?(Integer) && @max_processings.positive?
       # check max_connections
       @max_connections = max_connections
-      raise 'Number of concurrent connections is lower than number of simultaneous processings!' if @max_connections && @max_connections < @max_processings
+      raise 'Number of concurrent connections (max_connections) must be nil or a positive integer!' unless @max_connections.nil? || (@max_connections.is_a?(Integer) && @max_connections.positive?)
+      raise 'Number of concurrent connections (max_connections) is lower than number of simultaneous processings (max_processings)!' if !@max_connections.nil? && @max_connections < @max_processings
 
       # check for crlf mode
       @crlf_mode = crlf_mode.nil? ? DEFAULT_CRLF_MODE : crlf_mode
@@ -328,6 +394,7 @@ module MidiSmtpServer
       @do_dns_reverse_lookup = do_dns_reverse_lookup.nil? ? true : do_dns_reverse_lookup
 
       # io and buffer settings
+      @io_waitreadable_sleep = io_waitreadable_sleep.nil? ? DEFAULT_IO_WAITREADABLE_SLEEP : io_waitreadable_sleep
       @io_cmd_timeout = io_cmd_timeout.nil? ? DEFAULT_IO_CMD_TIMEOUT : io_cmd_timeout
       @io_buffer_chunk_size = io_buffer_chunk_size.nil? ? DEFAULT_IO_BUFFER_CHUNK_SIZE : io_buffer_chunk_size
       @io_buffer_max_size = io_buffer_max_size.nil? ? DEFAULT_IO_BUFFER_MAX_SIZE : io_buffer_max_size
@@ -335,10 +402,12 @@ 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 authentification
+      # check for authentication
       @auth_mode = auth_mode.nil? ? DEFAULT_AUTH_MODE : auth_mode
-      raise "Unknown authentification mode #{@auth_mode} was given!" unless AUTH_MODES.include?(@auth_mode)
+      raise "Unknown authentication mode #{@auth_mode} was given!" unless AUTH_MODES.include?(@auth_mode)
 
       # check for encryption
       @encrypt_mode = tls_mode.nil? ? DEFAULT_ENCRYPT_MODE : tls_mode
@@ -409,7 +478,7 @@ module MidiSmtpServer
       on_logging_event(ctx, Logger::DEBUG, "Client connect from #{ctx[:server][:remote_ip]}:#{ctx[:server][:remote_port]} to #{ctx[:server][:local_ip]}:#{ctx[:server][:local_port]}")
     end
 
-    # event before DISONNECT
+    # event before DISCONNECT
     def on_disconnect_event(ctx)
       on_logging_event(ctx, Logger::DEBUG, "Client disconnect from #{ctx[:server][:remote_ip]}:#{ctx[:server][:remote_port]} on #{ctx[:server][:local_ip]}:#{ctx[:server][:local_port]}")
     end
@@ -420,13 +489,20 @@ 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
 
-    # check the authentification on AUTH
+    # 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
     def on_auth_event(ctx, authorization_id, authentication_id, authentication)
-      # if authentification is used, override this event
+      # if authentication is used, override this event
       # and implement your own user management.
-      # otherwise all authentifications are blocked per default
+      # otherwise all authentications are blocked per default
       on_logging_event(ctx, Logger::DEBUG, "Deny access from #{ctx[:server][:remote_ip]}:#{ctx[:server][:remote_port]} for #{authentication_id}" + (authorization_id == '' ? '' : "/#{authorization_id}") + " with #{authentication}")
       raise Smtpd535Exception
     end
@@ -473,8 +549,8 @@ module MidiSmtpServer
 
     protected
 
-    # Start the listeners for all hosts
-    def serve_service
+    # Prepare all listeners for all hosts
+    def create_service
       raise 'Service was already started' unless stopped?
 
       # set flag to signal shutdown by stop / shutdown command
@@ -485,12 +561,12 @@ module MidiSmtpServer
         # break address into ip_address and port and serve service
         ip_address = address.rpartition(':').first
         port = address.rpartition(':').last
-        serve_service_on_ip_address_and_port(ip_address, port)
+        create_service_on_ip_address_and_port(ip_address, port)
       end
     end
 
-    # Start the listener thread on single ip_address and port
-    def serve_service_on_ip_address_and_port(ip_address, port)
+    # Prepare a listener on single ip_address and port
+    def create_service_on_ip_address_and_port(ip_address, port)
       # log information
       logger.info("Starting service on #{ip_address}:#{port}")
       # check that there is a specific ip_address defined
@@ -499,7 +575,47 @@ module MidiSmtpServer
       tcp_server = TCPServer.new(ip_address, port)
       # append this server to the list of TCPServers
       @tcp_servers << tcp_server
+    end
+
+    # Close and remove the given tcp_server
+    def remove_tcp_server(tcp_server)
+      begin
+        # drop the service
+        tcp_server.close
+        # remove from list
+        @tcp_servers.delete(tcp_server)
+      rescue StandardError
+        # ignore any error from here
+      end
+    end
+
+    # Join with the server thread(s)
+    # before joining the server threads, wait optionally a few seconds
+    # to let the service(s) come up
+    def join_threads(sleep_seconds_before_join: 1)
+      # wait some seconds before joining the upcoming threads
+      # and check that all TCPServers got one thread
+      while (@tcp_server_threads.length < @tcp_servers.length) && sleep_seconds_before_join.positive?
+        sleep_seconds_before_join -= 1
+        sleep 1
+      end
+      # try to join any thread
+      begin
+        @tcp_server_threads.each(&:join)
+
+        # catch ctrl-c to stop service
+      rescue Interrupt
+      end
+    end
 
+    # Create and attach threads to all listeners
+    def attach_threads
+      # loop for all TCPServers listener
+      @tcp_servers.each { |tcp_server| attach_thread(tcp_server) }
+    end
+
+    # Create and attach a thread to a listener
+    def attach_thread(tcp_server)
       # run thread until shutdown
       @tcp_server_threads << Thread.new do
         begin
@@ -527,7 +643,7 @@ module MidiSmtpServer
               ensure
                 begin
                   # always gracefully shutdown connection.
-                  # if the io object was overriden by the
+                  # if the io object was overridden by the
                   # result from serve_client() due to ssl
                   # io, the ssl + io socket will be closed
                   io.close
@@ -552,16 +668,7 @@ module MidiSmtpServer
           # log fatal error while starting new thread
           on_logging_event(nil, Logger::FATAL, "#{e} (#{e.class})".strip, err: e.clone)
         ensure
-          begin
-            # drop the service
-            tcp_server.close
-            # remove from list
-            @tcp_servers.delete(tcp_server)
-            # reset local var
-            tcp_server = nil
-          rescue StandardError
-            # ignore any error from here
-          end
+          # proper connection down?
           if shutdown?
             # wait for finishing opened connections
             @connections_mutex.synchronize do
@@ -604,7 +711,7 @@ module MidiSmtpServer
           on_connect_event(session[:ctx])
 
           # drop connection (respond 421) if too busy
-          raise 'Abort connection while too busy, exceeding max_connections!' if max_connections && connections > max_connections
+          raise Smtpd421Exception, 'Abort connection while too busy, exceeding max_connections!' if !max_connections.nil? && connections > max_connections
 
           # check active processings for new client
           @connections_mutex.synchronize do
@@ -656,7 +763,7 @@ module MidiSmtpServer
                 raise SmtpdIOTimeoutException if @io_cmd_timeout && Time.now.to_i - timestamp_timeout > @io_cmd_timeout
                 # read chunks of input data until line-feed
                 io_buffer << io.read_nonblock(@io_buffer_chunk_size)
-                # check for buffersize
+                # check for buffer size
                 raise SmtpdIOBufferOverrunException if @io_buffer_max_size && io_buffer.length > @io_buffer_max_size
                 # check for lf in current io_buffer
                 io_buffer_line_lf = io_buffer.index("\n")
@@ -665,7 +772,7 @@ module MidiSmtpServer
             # ignore exception when no input data is available yet
             rescue IO::WaitReadable
               # but wait a few moment to slow down system utilization
-              sleep 0.1
+              sleep @io_waitreadable_sleep
             end
 
             # check if io_buffer is filled and contains already a line-feed
@@ -679,12 +786,12 @@ 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
                   when :CRLF_ENSURE
-                    # remove any \r or \n occurence from line
+                    # remove any \r or \n occurrence from line
                     line.delete!("\r\n")
                     # log line, verbosity based on log severity and command sequence
                     on_logging_event(session[:ctx], Logger::DEBUG, +'<<< ' << line << "\n") if session[:cmd_sequence] != :CMD_DATA
@@ -859,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
@@ -1201,6 +1390,7 @@ module MidiSmtpServer
             remote_host: +'',
             remote_ip: +'',
             remote_port: +'',
+            proxy: nil,
             helo: +'',
             helo_response: +'',
             connected: +'',
@@ -1235,7 +1425,7 @@ module MidiSmtpServer
       )
     end
 
-    # handle plain authentification
+    # handle plain authentication
     def process_auth_plain(session, encoded_auth_response)
       begin
         # extract auth id (and password)

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: midi-smtp-server
 version: !ruby/object:Gem::Version
-  version: 3.0.3
+  version: 3.2.1
 platform: ruby
 authors:
 - Tom Freudenberg
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-12 00:00:00.000000000 Z
+date: 2023-08-15 00:00:00.000000000 Z
 dependencies: []
-description: A small and highly customizable ruby SMTP-Server class with builtin support
-  for AUTH and SSL/STARTTLS.
+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
+  and IPv6 and additional features.
 email: develop.rb.midi-smtp-server@4commerce.net
 executables: []
 extensions: []
@@ -25,7 +26,7 @@ files:
 - lib/midi-smtp-server/logger.rb
 - lib/midi-smtp-server/tls-transport.rb
 - lib/midi-smtp-server/version.rb
-homepage:
+homepage: https://4commerce-technologies-ag.github.io/midi-smtp-server
 licenses:
 - MIT
 metadata:
@@ -33,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.0.3
+  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: []
@@ -50,7 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: MidiSmtpServer Class