serverengine 2.0.5-x64-mingw32 → 2.1.0-x64-mingw32

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: af50292c46f94c4f14230ba94e70f828f04a8e8f
-  data.tar.gz: 8bcfd9493b672567df33d150b79da68759bb9909
+  metadata.gz: b19cbdc7a46aab03ef5d5a68591f9766424c1d2a
+  data.tar.gz: fcad502cbe6d11ef8f1abddeb268de34c170cae1
 SHA512:
-  metadata.gz: 328b509b1417b3d2e9d66b2c5511d227cb8753955c8c11e4caf32750f0f2673afd5a2d91e43167341a6078351b13f24f897ae697df073e66c8c2bc69ef606b87
-  data.tar.gz: dffd9c7592a7f7fcb891b172c487ccce7cb94a29cb5b4f94f3ada0a16dfc55973b524c91837c8af9b8e630b39319ab9e2dbb35dd2bff979e06ae8c2e8aca287c
+  metadata.gz: 9e9b9f8fda192d2b7d7d7a9b4839b1ff396fcfa9af28ca5578ebd113f7d29bf84608161587c82a32fef4182778cc188343140cc9f4edde97722f2d79a5ed586a
+  data.tar.gz: 5f1731e924aa75071775b398b4fb49f54e6b12d41542467b5224eb4a36d273d1d95a54a4eed49d645d8f57d13eb4ec66730cd0891f3edb88f5df2f269b650d69

data/.travis.yml

@@ -2,9 +2,10 @@ language: ruby
 
 rvm:
   - 2.1.10
-  - 2.2.6
-  - 2.3.3
-  - 2.4.0
+  - 2.2.9
+  - 2.3.8
+  - 2.4.5
+  - 2.5.3
   - ruby-head
 
 branches:

data/Changelog

@@ -1,3 +1,15 @@
+2018-11-14 version 2.1.0:
+
+* Improve socket manager security
+
+2018-07-09 version 2.0.7:
+
+* Add disable_sigdump option
+
+2018-02-09 version 2.0.6:
+
+* Avoid thread error log in ruby 2.5
+
 2017-03-01 version 2.0.5:
 
 * Support SERVERENGINE_SOCKETMANAGER_SOCK_DIR environment variable to change

data/README.md

@@ -319,7 +319,8 @@ Send `USR2` signal to reload configuration file.
 - **HUP:** immediate restart (available only when `worker_type` is "process")
 - **USR2:** reload config file and reopen log file
 - **INT:** detach process for live restarting (available only when `supervisor` and `enable_detach` parameters are true. otherwise graceful shutdown)
-- **CONT:** dump stacktrace and memory information to /tmp/sigdump-<pid>.log file
+- **CONT:** dump stacktrace and memory information to /tmp/sigdump-<pid>.log file. This can be
+    disabled by including `disable_sigdump: true` in the configuration.
 
 Immediate shutdown and restart send SIGQUIT signal to worker processes which kills the processes.
 Graceful shutdown and restart call `Worker#stop` method and wait for completion of `Worker#run` method.
@@ -463,6 +464,7 @@ Available methods are different depending on `worker_type`. ServerEngine support
   - **daemonize** enables daemonize (default: false)
   - **pid_path** sets the path to pid file (default: don't create pid file)
   - **supervisor** enables supervisor if it's true (default: false)
+  - **disable_sigdump** disables the handling of the `SIGCONT` signal and dumping of the thread (default: false)
   - **daemon_process_name** changes process name ($0) of server or supervisor process
   - **chuser** changes execution user
   - **chgroup** changes execution group

data/lib/serverengine/process_manager.rb

@@ -16,6 +16,7 @@
 #    limitations under the License.
 #
 require 'fcntl'
+require 'serverengine/socket_manager'
 
 module ServerEngine
 
@@ -185,6 +186,7 @@ module ServerEngine
           @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

data/lib/serverengine/server.rb

@@ -70,6 +70,11 @@ module ServerEngine
       nil
     end
 
+    def dump
+      Sigdump.dump unless config[:disable_sigdump]
+      nil
+    end
+
     def install_signal_handlers
       s = self
       if @command_pipe
@@ -89,7 +94,7 @@ module ServerEngine
             when "DETACH"
               s.detach(true)
             when "DUMP"
-              Sigdump.dump
+              s.dump
             end
           end
         end
@@ -104,7 +109,7 @@ module ServerEngine
             st.trap(@config[:signal_graceful_restart] || Signals::GRACEFUL_RESTART) { s.restart(true) }
             st.trap(@config[:signal_immediate_restart] || Signals::IMMEDIATE_RESTART) { s.restart(false) }
             st.trap(@config[:signal_reload] || Signals::RELOAD) { s.reload }
-            st.trap(@config[:signal_dump] || Signals::DUMP) { Sigdump.dump }
+            st.trap(@config[:signal_dump] || Signals::DUMP) { s.dump }
           end
         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)
@@ -138,7 +147,10 @@ module ServerEngine
 
       def process_peer(peer)
         while true
-          pid, method, bind, port = *SocketManager.recv_peer(peer)
+          res = SocketManager.recv_peer(peer)
+          return if res.nil?
+
+          pid, method, bind, port = *res
           begin
             send_socket(peer, pid, method, bind, port)
           rescue => e
@@ -151,15 +163,22 @@ 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
 
     def self.recv_peer(peer)
-      len = peer.read(4).unpack('N').first
+      res = peer.read(4)
+      return nil if res.nil?
+
+      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

@@ -70,7 +70,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 +101,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/supervisor.rb

@@ -148,6 +148,10 @@ module ServerEngine
       end
     end
 
+    def dump
+      _dump
+    end
+
     def install_signal_handlers
       s = self
       if @command_pipe
@@ -167,7 +171,7 @@ module ServerEngine
             when "DETACH"
               s.detach(true)
             when "DUMP"
-              Sigdump.dump
+              s.dump
             end
           end
         end
@@ -179,7 +183,7 @@ module ServerEngine
           st.trap(Signals::IMMEDIATE_RESTART) { s.restart(false) }
           st.trap(Signals::RELOAD) { s.reload }
           st.trap(Signals::DETACH) { s.detach(true) }
-          st.trap(Signals::DUMP) { Sigdump.dump }
+          st.trap(Signals::DUMP) { s.dump }
         end
       end
     end

data/lib/serverengine/version.rb

@@ -1,3 +1,3 @@
 module ServerEngine
-  VERSION = "2.0.5"
+  VERSION = "2.1.0"
 end

data/lib/serverengine/worker.rb

@@ -54,6 +54,10 @@ module ServerEngine
     def after_start
     end
 
+    def dump
+      Sigdump.dump unless config[:disable_sigdump]
+    end
+
     def install_signal_handlers
       w = self
       SignalThread.new do |st|
@@ -69,7 +73,7 @@ module ServerEngine
         }
         st.trap(Signals::DETACH) { w.stop }
 
-        st.trap(Signals::DUMP) { Sigdump.dump }
+        st.trap(Signals::DUMP) { w.dump }
       end
     end
 
@@ -77,5 +81,4 @@ module ServerEngine
       run
     end
   end
-
 end

data/serverengine.gemspec

@@ -15,7 +15,6 @@ Gem::Specification.new do |gem|
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
-  gem.has_rdoc = false
 
   gem.required_ruby_version = ">= 2.1.0"
 

data/spec/daemon_spec.rb

@@ -44,6 +44,10 @@ describe ServerEngine::Daemon do
       wait_for_stop
       test_state(:server_restart_immediate).should == 1
 
+      dm.dump
+      wait_for_stop
+      test_state(:server_dump).should == 1
+
       dm.stop(false)
       wait_for_stop
       test_state(:server_stop_immediate).should == 1

data/spec/server_worker_context.rb

@@ -146,6 +146,11 @@ module TestServer
     incr_test_state :server_detach
     super
   end
+
+  def dump
+    incr_test_state :server_dump
+    super
+  end
 end
 
 module TestWorker

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverengine
 version: !ruby/object:Gem::Version
-  version: 2.0.5
+  version: 2.1.0
 platform: x64-mingw32
 authors:
 - Sadayuki Furuhashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-01 00:00:00.000000000 Z
+date: 2018-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sigdump
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.14.1
 signing_key: 
 specification_version: 4
 summary: ServerEngine - multiprocess server framework