serverengine 2.0.7 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 849803d15dfe8e2b3e551b2849d8eb3d02deeffa271d4fa5f890ac4fb8db9a64
-  data.tar.gz: 703964e48ed203464b7d98eeaee0a161c88c4fc9597c2c1028e4cc3860b52476
+  metadata.gz: 2daf0f4af407a699df75677a6cdfdaa798b6c870acd77ee75bdaced9c3944eb7
+  data.tar.gz: 40d6299f178209b2207966ceea322f1b36efef63f897a54f0a815fb28a2af71d
 SHA512:
-  metadata.gz: 7b372a236fbb4861d6a1143c35a17466483d5e43730e6e6ce3a6dbe9c8a85cd560fbf7cb8a73e84edf7f0a56cecf9a1ec0e596cceed552c174d61d83765f2d49
-  data.tar.gz: '092f8d447cab9895701e566fe5185f6043ca483ff2cc905c57ae653f5551b80f6b080b9f0b51fb1fc42b8466eae463a5809e0941a27e770323479cf99e5e1f92'
+  metadata.gz: 95bd026a937bbf8ab666a9c89832e7c32d7b60c5a88ef91f61d08c6e6bf7595268e73c4eb03f09e972edd328f424304a17eb354d99e2caa7e14182f13bb76dd8
+  data.tar.gz: 0f6a91d444ae252cc232bd1151804c706a43415388a23e65b8861cd53dc5ac3a490f557d14b6aebcda03d12371c5220e2f30859b2300a3124b03781650c8ec7f

data/.travis.yml

@@ -2,9 +2,12 @@ language: ruby
 
 rvm:
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.2.9
+  - 2.3.8
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
   - ruby-head
 
 branches:

data/Changelog

@@ -1,3 +1,24 @@
+2020-11-02 version 2.2.2:
+
+* Fix incomplete Windows support in spawn based multi worker
+
+2020-01-24 version 2.2.1:
+
+* Fix IPv6 dual-stack mode issue for UDP
+* experimental: Add SERVERENGINE_USE_SOCKET_REUSEPORT envvar to enable SO_REUSEPORT
+
+2019-11-16 version 2.2.0:
+
+* Fix IPv6 dual-stack mode issue for TCP
+
+2019-04-22 version 2.1.1:
+
+* Fix bug to ignore SIGDUMP_SIGNAL
+
+2018-11-14 version 2.1.0:
+
+* Improve socket manager security
+
 2018-07-09 version 2.0.7:
 
 * Add disable_sigdump option

data/lib/serverengine/multi_process_server.rb

@@ -120,10 +120,19 @@ module ServerEngine
       end
 
       def send_reload
-        @pmon.send_signal(@reload_signal) if @pmon
+        return nil unless @pmon
+        if @pmon.command_sender_pipe
+          send_command("RELOAD\n")
+        else
+          @pmon.send_signal(@reload_signal)
+        end
         nil
       end
 
+      def send_command(command)
+        @pmon.send_command(command) if @pmon
+      end
+
       def join
         @pmon.join if @pmon
         nil

data/lib/serverengine/multi_spawn_server.rb

@@ -46,13 +46,6 @@ module ServerEngine
       @pm.command_sender = @command_sender
     end
 
-    def stop(stop_graceful)
-      if @command_sender == "pipe"
-        @pm.command_sender_pipe.write(stop_graceful ? "GRACEFUL_STOP\n" : "IMMEDIATE_STOP\n")
-      end
-      super
-    end
-
     def run
       super
     ensure

data/lib/serverengine/process_manager.rb

@@ -16,6 +16,7 @@
 #    limitations under the License.
 #
 require 'fcntl'
+require 'serverengine/socket_manager'
 
 module ServerEngine
 
@@ -70,7 +71,6 @@ module ServerEngine
     attr_reader :enable_heartbeat, :auto_heartbeat
 
     attr_accessor :command_sender
-    attr_reader :command_sender_pipe
 
     CONFIG_PARAMS = {
       heartbeat_interval: 1,
@@ -179,18 +179,21 @@ module ServerEngine
           end
         end
 
+        command_sender_pipe = nil
         if @command_sender == "pipe"
-          inpipe, @command_sender_pipe = IO.pipe
-          @command_sender_pipe.sync = true
-          @command_sender_pipe.binmode
+          inpipe, command_sender_pipe = IO.pipe
+          command_sender_pipe.sync = true
+          command_sender_pipe.binmode
           options[:in] = inpipe
         end
+        env['SERVERENGINE_SOCKETMANAGER_INTERNAL_TOKEN'] = SocketManager::INTERNAL_TOKEN
         pid = Process.spawn(env, *args, options)
         if @command_sender == "pipe"
           inpipe.close
         end
 
         m = Monitor.new(pid, monitor_options)
+        m.command_sender_pipe = command_sender_pipe
 
         @monitors << m
 
@@ -305,9 +308,11 @@ module ServerEngine
         @graceful_kill_start_time = nil
         @immediate_kill_start_time = nil
         @kill_count = 0
+
+        @command_sender_pipe = nil
       end
 
-      attr_accessor :last_heartbeat_time
+      attr_accessor :last_heartbeat_time, :command_sender_pipe
       attr_reader :pid
 
       def heartbeat_delay
@@ -327,6 +332,10 @@ module ServerEngine
         end
       end
 
+      def send_command(command)
+        @command_sender_pipe.write(command) if @command_sender_pipe
+      end
+
       def try_join
         pid = @pid
         return true unless pid
@@ -364,15 +373,25 @@ module ServerEngine
       end
 
       def start_graceful_stop!
-        now = Time.now
-        @next_kill_time ||= now
-        @graceful_kill_start_time ||= now
+        if ServerEngine.windows?
+          # heartbeat isn't supported on Windows
+          send_command("GRACEFUL_STOP\n")
+        else
+          now = Time.now
+          @next_kill_time ||= now
+          @graceful_kill_start_time ||= now
+        end
       end
 
       def start_immediate_stop!
-        now = Time.now
-        @next_kill_time ||= now
-        @immediate_kill_start_time ||= now
+        if ServerEngine.windows?
+          # heartbeat isn't supported on Windows
+          system("taskkill /f /pid #{@pid}")
+        else
+          now = Time.now
+          @next_kill_time ||= now
+          @immediate_kill_start_time ||= now
+        end
       end
 
       def tick(now=Time.now)

data/lib/serverengine/signal_thread.rb

@@ -67,7 +67,7 @@ module ServerEngine
 
     def signal_handler_main(sig)
       # here always creates new thread to avoid
-      # complicated race conditin in signal handlers
+      # complicated race condition in signal handlers
       Thread.new do
         begin
           enqueue(sig)

data/lib/serverengine/signals.rb

@@ -26,6 +26,6 @@ module ServerEngine
     IMMEDIATE_RESTART = :HUP
     RELOAD = :USR2
     DETACH = :INT
-    DUMP = :CONT
+    DUMP = ENV.has_key?('SIGDUMP_SIGNAL') ? ENV['SIGDUMP_SIGNAL'].to_sym : :CONT
   end
 end

data/lib/serverengine/socket_manager.rb

@@ -18,9 +18,18 @@
 require 'socket'
 require 'ipaddr'
 require 'time'
+require 'securerandom'
+require 'json'
+require 'base64'
 
 module ServerEngine
   module SocketManager
+    # This token is used for communication between peers. If token is mismatched, messages will be discarded
+    INTERNAL_TOKEN = if ENV.has_key?('SERVERENGINE_SOCKETMANAGER_INTERNAL_TOKEN')
+                       ENV['SERVERENGINE_SOCKETMANAGER_INTERNAL_TOKEN']
+                     else
+                       SecureRandom.hex
+                     end
 
     class Client
       def initialize(path)
@@ -154,7 +163,8 @@ module ServerEngine
     end
 
     def self.send_peer(peer, obj)
-      data = Marshal.dump(obj)
+      data = [SocketManager::INTERNAL_TOKEN, Base64.strict_encode64(Marshal.dump(obj))]
+      data = JSON.generate(data)
       peer.write [data.bytesize].pack('N')
       peer.write data
     end
@@ -165,7 +175,10 @@ module ServerEngine
 
       len = res.unpack('N').first
       data = peer.read(len)
-      Marshal.load(data)
+      data = JSON.parse(data)
+      return nil if SocketManager::INTERNAL_TOKEN != data.first
+
+      Marshal.load(Base64.strict_decode64(data.last))
     end
 
     if ServerEngine.windows?

data/lib/serverengine/socket_manager_unix.rb

@@ -50,19 +50,30 @@ module ServerEngine
       private
 
       def listen_tcp_new(bind_ip, port)
-        sock = TCPServer.new(bind_ip.to_s, port)
-        sock.listen(Socket::SOMAXCONN)  # TODO make backlog configurable if necessary
-        return sock
+        if ENV['SERVERENGINE_USE_SOCKET_REUSEPORT'] == '1'
+          # Based on Addrinfo#listen
+          tsock = Socket.new(bind_ip.ipv6? ? ::Socket::AF_INET6 : ::Socket::AF_INET, ::Socket::SOCK_STREAM, 0)
+          tsock.ipv6only! if bind_ip.ipv6?
+          tsock.setsockopt(:SOCKET, :REUSEPORT, true)
+          tsock.setsockopt(:SOCKET, :REUSEADDR, true)
+          tsock.bind(Addrinfo.tcp(bind_ip.to_s, port))
+          tsock.listen(::Socket::SOMAXCONN)
+          tsock.autoclose = false
+          TCPServer.for_fd(tsock.fileno)
+        else
+          # TCPServer.new doesn't set IPV6_V6ONLY flag, so use Addrinfo class instead.
+          # TODO: make backlog configurable if necessary
+          tsock = Addrinfo.tcp(bind_ip.to_s, port).listen(::Socket::SOMAXCONN)
+          tsock.autoclose = false
+          TCPServer.for_fd(tsock.fileno)
+        end
       end
 
       def listen_udp_new(bind_ip, port)
-        if bind_ip.ipv6?
-          sock = UDPSocket.new(Socket::AF_INET6)
-        else
-          sock = UDPSocket.new(Socket::AF_INET)
-        end
-        sock.bind(bind_ip.to_s, port)
-        return sock
+        # UDPSocket.new doesn't set IPV6_V6ONLY flag, so use Addrinfo class instead.
+        usock = Addrinfo.udp(bind_ip.to_s, port).bind
+        usock.autoclose = false
+        UDPSocket.for_fd(usock.fileno)
       end
 
       def start_server(path)
@@ -70,7 +81,12 @@ module ServerEngine
         # when client changed working directory
         path = File.expand_path(path)
 
-        @server = UNIXServer.new(path)
+        begin
+          old_umask = File.umask(0077) # Protect unix socket from other users
+          @server = UNIXServer.new(path)
+        ensure
+          File.umask(old_umask)
+        end
 
         @thread = Thread.new do
           begin
@@ -96,7 +112,14 @@ module ServerEngine
       end
 
       def send_socket(peer, pid, method, bind, port)
-        sock = send(method, bind, port)  # calls listen_tcp or listen_udp
+        sock = case method
+               when :listen_tcp
+                 listen_tcp(bind, port)
+               when :listen_udp
+                 listen_udp(bind, port)
+               else
+                 raise ArgumentError, "Unknown method: #{method.inspect}"
+               end
 
         SocketManager.send_peer(peer, nil)
 

data/lib/serverengine/version.rb

@@ -1,3 +1,3 @@
 module ServerEngine
-  VERSION = "2.0.7"
+  VERSION = "2.2.2"
 end

data/spec/socket_manager_spec.rb

@@ -155,7 +155,27 @@ describe ServerEngine::SocketManager do
         test_state(:is_udp_socket).should == 1
         test_state(:udp_data_sent).should == 1
       end
-    end if (TCPServer.open("::1",0) rescue nil)
+    end if (TCPServer.open("::1", 0) rescue nil)
+
+    unless ServerEngine.windows?
+      context 'using ipv4/ipv6' do
+        it 'can bind ipv4/ipv6 together' do
+          server = SocketManager::Server.open(server_path)
+          client = ServerEngine::SocketManager::Client.new(server_path)
+
+          tcp_v4 = client.listen_tcp('0.0.0.0', test_port)
+          udp_v4 = client.listen_udp('0.0.0.0', test_port)
+          tcp_v6 = client.listen_tcp('::', test_port)
+          udp_v6 = client.listen_udp('::', test_port)
+
+          tcp_v4.close
+          udp_v4.close
+          tcp_v6.close
+          udp_v6.close
+          server.close
+        end
+      end if (TCPServer.open("::", 0) rescue nil)
+    end
   end
 
   if ServerEngine.windows?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverengine
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.2.2
 platform: ruby
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-10 00:00:00.000000000 Z
+date: 2020-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sigdump
@@ -153,8 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ServerEngine - multiprocess server framework