puma 2.2.0 → 8.0.2

data/lib/puma/binder.rb

@@ -1,39 +1,65 @@
-require 'puma/const'
+# frozen_string_literal: true
+
+require 'uri'
+require 'socket'
+
+require_relative 'const'
+require_relative 'util'
 
 module Puma
+
+  if HAS_SSL
+    require_relative 'minissl'
+    require_relative 'minissl/context_builder'
+  end
+
   class Binder
     include Puma::Const
 
-    def initialize(events)
-      @events = events
+    RACK_VERSION = [1,6].freeze
+
+    def initialize(log_writer, options, env: ENV)
+      @log_writer = log_writer
+      @options = options
       @listeners = []
       @inherited_fds = {}
+      @activated_sockets = {}
       @unix_paths = []
+      @env = env
 
       @proto_env = {
-        "rack.version".freeze => Rack::VERSION,
-        "rack.errors".freeze => events.stderr,
-        "rack.multithread".freeze => true,
-        "rack.multiprocess".freeze => false,
+        "rack.version".freeze => RACK_VERSION,
+        "rack.errors".freeze => log_writer.stderr,
+        "rack.multithread".freeze => options[:max_threads] > 1,
+        "rack.multiprocess".freeze => options[:workers] >= 1,
         "rack.run_once".freeze => false,
-        "SCRIPT_NAME".freeze => ENV['SCRIPT_NAME'] || "",
+        RACK_URL_SCHEME => options[:rack_url_scheme],
+        "SCRIPT_NAME".freeze => env['SCRIPT_NAME'] || "",
 
-        # Rack blows up if this is an empty string, and Rack::Lint
-        # blows up if it's nil. So 'text/plain' seems like the most
-        # sensible default value.
-        "CONTENT_TYPE".freeze => "text/plain",
+        # I'd like to set a default CONTENT_TYPE here but some things
+        # depend on their not being a default set and inferring
+        # it from the content. And so if i set it here, it won't
+        # infer properly.
 
         "QUERY_STRING".freeze => "",
-        SERVER_PROTOCOL => HTTP_11,
-        SERVER_SOFTWARE => PUMA_VERSION,
-        GATEWAY_INTERFACE => CGI_VER
+        SERVER_SOFTWARE => PUMA_SERVER_STRING,
+        GATEWAY_INTERFACE => CGI_VER,
+
+        RACK_AFTER_REPLY => nil,
+        RACK_RESPONSE_FINISHED => nil,
       }
 
       @envs = {}
       @ios = []
     end
 
-    attr_reader :listeners, :ios
+    attr_reader :ios
+
+    # @version 5.0.0
+    attr_reader :activated_sockets, :envs, :inherited_fds, :listeners, :proto_env, :unix_paths
+
+    # @version 5.0.0
+    attr_writer :ios, :listeners
 
     def env(sock)
       @envs.fetch(sock, @proto_env)
@@ -41,130 +67,221 @@ module Puma
 
     def close
       @ios.each { |i| i.close }
-      @unix_paths.each { |i| File.unlink i }
     end
 
-    def import_from_env
-      remove = []
+    # @!attribute [r] connected_ports
+    # @version 5.0.0
+    def connected_ports
+      t = ios.map { |io| io.addr[1] }; t.uniq!; t
+    end
+
+    # @version 5.0.0
+    def create_inherited_fds(env_hash)
+      env_hash.select {|k,v| k =~ /PUMA_INHERIT_\d+/}.each do |_k, v|
+        fd, url = v.split(":", 2)
+        @inherited_fds[url] = fd.to_i
+      end.keys # pass keys back for removal
+    end
 
-      ENV.each do |k,v|
-        if k =~ /PUMA_INHERIT_\d+/
-          fd, url = v.split(":", 2)
-          @inherited_fds[url] = fd.to_i
-          remove << k
+    # systemd socket activation.
+    # LISTEN_FDS = number of listening sockets. e.g. 2 means accept on 2 sockets w/descriptors 3 and 4.
+    # LISTEN_PID = PID of the service process, aka us
+    # @see https://www.freedesktop.org/software/systemd/man/systemd-socket-activate.html
+    # @version 5.0.0
+    #
+    def create_activated_fds(env_hash)
+      @log_writer.debug { "ENV['LISTEN_FDS'] #{@env['LISTEN_FDS'].inspect}  env_hash['LISTEN_PID'] #{env_hash['LISTEN_PID'].inspect}" }
+      return [] unless env_hash['LISTEN_FDS'] && env_hash['LISTEN_PID'].to_i == $$
+      env_hash['LISTEN_FDS'].to_i.times do |index|
+        sock = TCPServer.for_fd(socket_activation_fd(index))
+        key = begin # Try to parse as a path
+          [:unix, Socket.unpack_sockaddr_un(sock.getsockname)]
+        rescue ArgumentError # Try to parse as a port/ip
+          port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
+          addr = "[#{addr}]" if addr&.include? ':'
+          [:tcp, addr, port]
         end
-        if k =~ /LISTEN_FDS/ && ENV['LISTEN_PID'].to_i == $$
-          v.to_i.times do |num|
-            fd = num + 3
-            sock = TCPServer.for_fd(fd)
-            begin
-              url = "unix://" + Socket.unpack_sockaddr_un(sock.getsockname)
-            rescue ArgumentError
-              port, addr = Socket.unpack_sockaddr_in(sock.getsockname)
-              if addr =~ /\:/
-                addr = "[#{addr}]"
-              end
-              url = "tcp://#{addr}:#{port}"
-            end
-            @inherited_fds[url] = sock
-          end
-          ENV.delete k
-          ENV.delete 'LISTEN_PID'
+        @activated_sockets[key] = sock
+        @log_writer.debug { "Registered #{key.join ':'} for activation from LISTEN_FDS" }
+      end
+      ["LISTEN_FDS", "LISTEN_PID"] # Signal to remove these keys from ENV
+    end
+
+    # Synthesize binds from systemd socket activation
+    #
+    # When systemd socket activation is enabled, it can be tedious to keep the
+    # binds in sync. This method can synthesize any binds based on the received
+    # activated sockets. Any existing matching binds will be respected.
+    #
+    # When only_matching is true in, all binds that do not match an activated
+    # socket is removed in place.
+    #
+    # It's a noop if no activated sockets were received.
+    def synthesize_binds_from_activated_fs(binds, only_matching)
+      return binds unless activated_sockets.any?
+
+      activated_binds = []
+
+      activated_sockets.keys.each do |proto, addr, port|
+        if port
+          tcp_url = "#{proto}://#{addr}:#{port}"
+          ssl_url = "ssl://#{addr}:#{port}"
+          ssl_url_prefix = "#{ssl_url}?"
+
+          existing = binds.find { |bind| bind == tcp_url || bind == ssl_url || bind.start_with?(ssl_url_prefix) }
+
+          activated_binds << (existing || tcp_url)
+        else
+          # TODO: can there be a SSL bind without a port?
+          activated_binds << "#{proto}://#{addr}"
         end
       end
 
-      remove.each do |k|
-        ENV.delete k
+      if only_matching
+        activated_binds
+      else
+        binds | activated_binds
       end
     end
 
-    def parse(binds, logger)
+    def before_parse(&block)
+      @before_parse ||= []
+      @before_parse << block if block
+      @before_parse
+    end
+
+    def parse(binds, log_writer = nil, log_msg = 'Listening')
+      before_parse.each(&:call)
+      log_writer ||= @log_writer
       binds.each do |str|
         uri = URI.parse str
         case uri.scheme
         when "tcp"
           if fd = @inherited_fds.delete(str)
-            logger.log "* Inherited #{str}"
             io = inherit_tcp_listener uri.host, uri.port, fd
+            log_writer.log "* Inherited #{str}"
+          elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ])
+            io = inherit_tcp_listener uri.host, uri.port, sock
+            log_writer.log "* Activated #{str}"
           else
-            logger.log "* Listening on #{str}"
-            io = add_tcp_listener uri.host, uri.port
+            ios_len = @ios.length
+            params = Util.parse_query uri.query
+
+            low_latency = params.key?('low_latency') && params['low_latency'] != 'false'
+            backlog = params.fetch('backlog', 1024).to_i
+
+            io = add_tcp_listener uri.host, uri.port, low_latency, backlog
+
+            @ios[ios_len..-1].each do |i|
+              addr = loc_addr_str i
+              log_writer.log "* #{log_msg} on http://#{addr}"
+            end
           end
 
-          @listeners << [str, io]
+          @listeners << [str, io] if io
         when "unix"
-          path = "#{uri.host}#{uri.path}"
+          path = "#{uri.host}#{uri.path}".gsub("%20", " ")
+          abstract = false
+          if str.start_with? 'unix://@'
+            raise "OS does not support abstract UNIXSockets" unless Puma.abstract_unix_socket?
+            abstract = true
+            path = "@#{path}"
+          end
 
           if fd = @inherited_fds.delete(str)
-            logger.log "* Inherited #{str}"
+            @unix_paths << path unless abstract || File.exist?(path)
             io = inherit_unix_listener path, fd
+            log_writer.log "* Inherited #{str}"
+          elsif sock = @activated_sockets.delete([ :unix, path ]) ||
+              !abstract && @activated_sockets.delete([ :unix, File.realdirpath(path) ])
+            @unix_paths << path unless abstract || File.exist?(path)
+            io = inherit_unix_listener path, sock
+            log_writer.log "* Activated #{str}"
           else
-            logger.log "* Listening on #{str}"
-
             umask = nil
+            mode = nil
+            backlog = 1024
 
             if uri.query
-              params = Rack::Utils.parse_query uri.query
+              params = Util.parse_query uri.query
               if u = params['umask']
                 # Use Integer() to respect the 0 prefix as octal
                 umask = Integer(u)
               end
+
+              if u = params['mode']
+                mode = Integer('0'+u)
+              end
+
+              if u = params['backlog']
+                backlog = Integer(u)
+              end
             end
 
-            io = add_unix_listener path, umask
+            @unix_paths << path unless abstract || File.exist?(path)
+            io = add_unix_listener path, umask, mode, backlog
+            log_writer.log "* #{log_msg} on #{str}"
           end
 
           @listeners << [str, io]
         when "ssl"
-          if IS_JRUBY
-            @events.error "SSL not supported on JRuby"
-            raise UnsupportedOption
-          end
-
-          params = Rack::Utils.parse_query uri.query
-          require 'puma/minissl'
+          cert_key = %w[cert key]
 
-          ctx = MiniSSL::Context.new
-          unless params['key']
-            @events.error "Please specify the SSL key via 'key='"
-          end
+          raise "Puma compiled without SSL support" unless HAS_SSL
 
-          ctx.key = params['key']
+          params = Util.parse_query uri.query
 
-          unless params['cert']
-            @events.error "Please specify the SSL cert via 'cert='"
+          # If key and certs are not defined and localhost gem is required.
+          # localhost gem will be used for self signed
+          # Load localhost authority if not loaded.
+          # Ruby 3 `values_at` accepts an array, earlier do not
+          if params.values_at(*cert_key).all? { |v| v.to_s.empty? }
+            ctx = localhost_authority && localhost_authority_context
           end
 
-          ctx.cert = params['cert']
-
-          ctx.verify_mode = MiniSSL::VERIFY_NONE
+          ctx ||=
+            begin
+              # Extract cert_pem and key_pem from options[:store] if present
+              cert_key.each do |v|
+                if params[v]&.start_with?('store:')
+                  index = Integer(params.delete(v).split('store:').last)
+                  params["#{v}_pem"] = @options[:store][index]
+                end
+              end
+              MiniSSL::ContextBuilder.new(params, @log_writer).context
+            end
 
           if fd = @inherited_fds.delete(str)
-            logger.log "* Inherited #{str}"
-            io = inherited_ssl_listener fd, ctx
+            log_writer.log "* Inherited #{str}"
+            io = inherit_ssl_listener fd, ctx
+          elsif sock = @activated_sockets.delete([ :tcp, uri.host, uri.port ])
+            io = inherit_ssl_listener sock, ctx
+            log_writer.log "* Activated #{str}"
           else
-            logger.log "* Listening on #{str}"
-            io = add_ssl_listener uri.host, uri.port, ctx
+            ios_len = @ios.length
+            backlog = params.fetch('backlog', 1024).to_i
+            low_latency = params['low_latency'] != 'false'
+            io = add_ssl_listener uri.host, uri.port, ctx, low_latency, backlog
+
+            @ios[ios_len..-1].each do |i|
+              addr = loc_addr_str i
+              log_writer.log "* #{log_msg} on ssl://#{addr}?#{uri.query}"
+            end
           end
 
-          @listeners << [str, io]
+          @listeners << [str, io] if io
         else
-          logger.error "Invalid URI: #{str}"
+          log_writer.error "Invalid URI: #{str}"
         end
       end
 
       # If we inherited fds but didn't use them (because of a
       # configuration change), then be sure to close them.
       @inherited_fds.each do |str, fd|
-        logger.log "* Closing unused inherited connection: #{str}"
+        log_writer.log "* Closing unused inherited connection: #{str}"
 
         begin
-          if fd.kind_of? TCPServer
-            fd.close
-          else
-            IO.for_fd(fd).close
-          end
-
+          IO.for_fd(fd).close
         rescue SystemCallError
         end
 
@@ -176,6 +293,36 @@ module Puma
         end
       end
 
+      # Also close any unused activated sockets
+      unless @activated_sockets.empty?
+        fds = @ios.map(&:to_i)
+        @activated_sockets.each do |key, sock|
+          next if fds.include? sock.to_i
+          log_writer.log "* Closing unused activated socket: #{key.first}://#{key[1..-1].join ':'}"
+          begin
+            sock.close
+          rescue SystemCallError
+          end
+          # We have to unlink a unix socket path that's not being used
+          File.unlink key[1] if key.first == :unix
+        end
+      end
+    end
+
+    def localhost_authority
+      @localhost_authority ||= Localhost::Authority.fetch if defined?(Localhost::Authority) && !Puma::IS_JRUBY
+    end
+
+    def localhost_authority_context
+      return unless localhost_authority
+
+      key_path, crt_path = if [:key_path, :certificate_path].all? { |m| localhost_authority.respond_to?(m) }
+        [localhost_authority.key_path, localhost_authority.certificate_path]
+      else
+        local_certificates_path = File.expand_path("~/.localhost")
+        [File.join(local_certificates_path, "localhost.key"), File.join(local_certificates_path, "localhost.crt")]
+      end
+      MiniSSL::ContextBuilder.new({ "key" => key_path, "cert" => crt_path }, @log_writer).context
     end
 
     # Tell the server to listen on host +host+, port +port+.
@@ -186,23 +333,28 @@ module Puma
     # allow to accumulate before returning connection refused.
     #
     def add_tcp_listener(host, port, optimize_for_latency=true, backlog=1024)
-      host = host[1..-2] if host[0..0] == '['
-      s = TCPServer.new(host, port)
+      if host == "localhost"
+        loopback_addresses.each do |addr|
+          add_tcp_listener addr, port, optimize_for_latency, backlog
+        end
+        return
+      end
+
+      host = host[1..-2] if host&.start_with? '['
+      tcp_server = TCPServer.new(host, port)
+
       if optimize_for_latency
-        s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
+        tcp_server.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
       end
-      s.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
-      s.listen backlog
-      @ios << s
-      s
+      tcp_server.setsockopt(Socket::SOL_SOCKET,Socket::SO_REUSEADDR, true)
+      tcp_server.listen backlog
+
+      @ios << tcp_server
+      tcp_server
     end
 
     def inherit_tcp_listener(host, port, fd)
-      if fd.kind_of? TCPServer
-        s = fd
-      else
-        s = TCPServer.for_fd(fd)
-      end
+      s = fd.kind_of?(::TCPServer) ? fd : ::TCPServer.for_fd(fd)
 
       @ios << s
       s
@@ -210,13 +362,19 @@ module Puma
 
     def add_ssl_listener(host, port, ctx,
                          optimize_for_latency=true, backlog=1024)
-      if IS_JRUBY
-        @events.error "SSL not supported on JRuby"
-        raise UnsupportedOption
-      end
 
-      require 'puma/minissl'
+      raise "Puma compiled without SSL support" unless HAS_SSL
+      # Puma will try to use local authority context if context is supplied nil
+      ctx ||= localhost_authority_context
+
+      if host == "localhost"
+        loopback_addresses.each do |addr|
+          add_ssl_listener addr, port, ctx, optimize_for_latency, backlog
+        end
+        return
+      end
 
+      host = host[1..-2] if host&.start_with? '['
       s = TCPServer.new(host, port)
       if optimize_for_latency
         s.setsockopt(Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1)
@@ -233,49 +391,121 @@ module Puma
       s
     end
 
-    def inherited_ssl_listener(fd, ctx)
-      if IS_JRUBY
-        @events.error "SSL not supported on JRuby"
-        raise UnsupportedOption
-      end
+    def inherit_ssl_listener(fd, ctx)
+      raise "Puma compiled without SSL support" unless HAS_SSL
+      # Puma will try to use local authority context if context is supplied nil
+      ctx ||= localhost_authority_context
+
+      s = fd.kind_of?(::TCPServer) ? fd : ::TCPServer.for_fd(fd)
+
+      ssl = MiniSSL::Server.new(s, ctx)
+
+      env = @proto_env.dup
+      env[HTTPS_KEY] = HTTPS
+      @envs[ssl] = env
+
+      @ios << ssl
 
-      require 'puma/minissl'
-      s = TCPServer.for_fd(fd)
-      @ios << MiniSSL::Server.new(s, ctx)
       s
     end
 
     # Tell the server to listen on +path+ as a UNIX domain socket.
     #
-    def add_unix_listener(path, umask=nil)
-      @unix_paths << path
-
+    def add_unix_listener(path, umask=nil, mode=nil, backlog=1024)
       # Let anyone connect by default
       umask ||= 0
 
       begin
         old_mask = File.umask(umask)
-        s = UNIXServer.new(path)
+
+        if File.exist? path
+          begin
+            old = UNIXSocket.new path
+          rescue SystemCallError, IOError
+            File.unlink path
+          else
+            old.close
+            raise "There is already a server bound to: #{path}"
+          end
+        end
+        s = UNIXServer.new path.sub(/\A@/, "\0") # check for abstract UNIXSocket
+        s.listen backlog
         @ios << s
       ensure
         File.umask old_mask
       end
 
+      if mode
+        File.chmod mode, path
+      end
+
+      env = @proto_env.dup
+      env[REMOTE_ADDR] = "127.0.0.1"
+      @envs[s] = env
+
       s
     end
 
     def inherit_unix_listener(path, fd)
-      @unix_paths << path
+      s = fd.kind_of?(::TCPServer) ? fd : ::UNIXServer.for_fd(fd)
 
-      if fd.kind_of? TCPServer
-        s = fd
-      else
-        s = UNIXServer.for_fd fd
-      end
       @ios << s
 
+      env = @proto_env.dup
+      env[REMOTE_ADDR] = "127.0.0.1"
+      @envs[s] = env
+
       s
     end
 
+    def close_listeners
+      @listeners.each do |l, io|
+        begin
+          io.close unless io.closed?
+          uri = URI.parse l
+          next unless uri.scheme == 'unix'
+          unix_path = "#{uri.host}#{uri.path}"
+          File.unlink unix_path if @unix_paths.include?(unix_path) && File.exist?(unix_path)
+        rescue Errno::EBADF
+        end
+      end
+    end
+
+    def redirects_for_restart
+      redirects = @listeners.map { |a| [a[1].to_i, a[1].to_i] }.to_h
+      redirects[:close_others] = true
+      redirects
+    end
+
+    # @version 5.0.0
+    def redirects_for_restart_env
+      @listeners.each_with_object({}).with_index do |(listen, memo), i|
+        memo["PUMA_INHERIT_#{i}"] = "#{listen[1].to_i}:#{listen[0]}"
+      end
+    end
+
+    private
+
+    # @!attribute [r] loopback_addresses
+    def loopback_addresses
+      t = Socket.ip_address_list.select do |addrinfo|
+        addrinfo.ipv6_loopback? || addrinfo.ipv4_loopback?
+      end
+      t.map! { |addrinfo| addrinfo.ip_address }; t.uniq!; t
+    end
+
+    def loc_addr_str(io)
+      loc_addr = io.to_io.local_address
+      if loc_addr.ipv6?
+        "[#{loc_addr.ip_unpack[0]}]:#{loc_addr.ip_unpack[1]}"
+      else
+        loc_addr.ip_unpack.join(':')
+      end
+    end
+
+    # @version 5.0.0
+    def socket_activation_fd(int)
+      int + 3 # 3 is the magic number you add to follow the SA protocol
+    end
   end
 end