puma 5.6.0-java → 5.6.4-java

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c9604a002b072d351254eef56c4cc52bc7ac1c73750546f0408a7bd21f91705
-  data.tar.gz: 24919b065100d37b1f43b7465a9464e6b5492a0256d7880ea6f519a482deafe5
+  metadata.gz: 00fb5299edf47cd69e241fc63a66cb98ef7180e0df430651bab94adeec19bc9f
+  data.tar.gz: 70089c146221037a050001dbeca34da0be535268994214eace5d9f1c670684b6
 SHA512:
-  metadata.gz: ab900da240f92390b6f4235bef4f0358cc03d13cb795b44c878d9b96d0ea2865d35419cbe8c31f2fc18cb272b9df716273959391b85a6455aaebdadd03b2922b
-  data.tar.gz: 2daeb82d068ebd639a27699f670df828417069eba86fb3c4c599371898079cafcae7c0d5ac7256b562b8b0629f4e236ff9e62a17efc80ba0c00fca8ca3cfcae8
+  metadata.gz: da00b1d9d4d509cbe4f5da700091188b6559a61c932331cf7e4aef8f424b426846296df0804cb5b06f23033a3d5b6d8d31dcb512444ae276b0071b3e653f5f2e
+  data.tar.gz: efe8517f061dc996c83cec30110c3b8a84e6563dcba33e6416ad98799f685e0145bbd6856c7b7941cbf5682de44c73b56221022ca8231b8cbee7afe5faa78c15

data/History.md

@@ -1,3 +1,18 @@
+## 5.6.4 / 2022-03-30
+
+* Security
+  * Close several HTTP Request Smuggling exploits (CVE-2022-24790)
+
+## 5.6.2 / 2022-02-11
+
+* Bugfix/Security
+  * Response body will always be `close`d. (GHSA-rmj8-8hhh-gv5h, related to [#2809])
+
+## 5.6.1 / 2022-01-26
+
+* Bugfixes
+  * Reverted a commit which appeared to be causing occasional blank header values ([#2809])
+
 ## 5.6.0 / 2022-01-25
 
 * Features
@@ -1830,6 +1845,7 @@ be added back in a future date when a java Puma::MiniSSL is added.
 * Bugfixes
   * Your bugfix goes here <Most recent on the top, like GitHub> (#Github Number)
 
+[#2809]:https://github.com/puma/puma/pull/2809     "PR by @dentarg, merged 2022-01-26"
 [#2764]:https://github.com/puma/puma/pull/2764     "PR by @dentarg, merged 2022-01-18"
 [#2708]:https://github.com/puma/puma/issues/2708   "Issue by @erikaxel, closed 2022-01-18"
 [#2780]:https://github.com/puma/puma/pull/2780     "PR by @dalibor, merged 2022-01-01"

data/lib/puma/client.rb

@@ -23,6 +23,8 @@ module Puma
 
   class ConnectionError < RuntimeError; end
 
+  class HttpParserError501 < IOError; end
+
   # An instance of this class represents a unique request from a client.
   # For example, this could be a web request from a browser or from CURL.
   #
@@ -35,7 +37,21 @@ module Puma
   # Instances of this class are responsible for knowing if
   # the header and body are fully buffered via the `try_to_finish` method.
   # They can be used to "time out" a response via the `timeout_at` reader.
+  #
   class Client
+
+    # this tests all values but the last, which must be chunked
+    ALLOWED_TRANSFER_ENCODING = %w[compress deflate gzip].freeze
+
+    # chunked body validation
+    CHUNK_SIZE_INVALID = /[^\h]/.freeze
+    CHUNK_VALID_ENDING = "\r\n".freeze
+
+    # Content-Length header value validation
+    CONTENT_LENGTH_VALUE_INVALID = /[^\d]/.freeze
+
+    TE_ERR_MSG = 'Invalid Transfer-Encoding'
+
     # The object used for a request with no body. All requests with
     # no body share this one object since it has no state.
     EmptyBody = NullIO.new
@@ -302,16 +318,27 @@ module Puma
       body = @parser.body
 
       te = @env[TRANSFER_ENCODING2]
-
       if te
-        if te.include?(",")
-          te.split(",").each do |part|
-            if CHUNKED.casecmp(part.strip) == 0
-              return setup_chunked_body(body)
-            end
+        te_lwr = te.downcase
+        if te.include? ','
+          te_ary = te_lwr.split ','
+          te_count = te_ary.count CHUNKED
+          te_valid = te_ary[0..-2].all? { |e| ALLOWED_TRANSFER_ENCODING.include? e }
+          if te_ary.last == CHUNKED && te_count == 1 && te_valid
+            @env.delete TRANSFER_ENCODING2
+            return setup_chunked_body body
+          elsif te_count >= 1
+            raise HttpParserError   , "#{TE_ERR_MSG}, multiple chunked: '#{te}'"
+          elsif !te_valid
+            raise HttpParserError501, "#{TE_ERR_MSG}, unknown value: '#{te}'"
           end
-        elsif CHUNKED.casecmp(te) == 0
-          return setup_chunked_body(body)
+        elsif te_lwr == CHUNKED
+          @env.delete TRANSFER_ENCODING2
+          return setup_chunked_body body
+        elsif ALLOWED_TRANSFER_ENCODING.include? te_lwr
+          raise HttpParserError     , "#{TE_ERR_MSG}, single value must be chunked: '#{te}'"
+        else
+          raise HttpParserError501  , "#{TE_ERR_MSG}, unknown value: '#{te}'"
         end
       end
 
@@ -319,7 +346,12 @@ module Puma
 
       cl = @env[CONTENT_LENGTH]
 
-      unless cl
+      if cl
+        # cannot contain characters that are not \d
+        if cl =~ CONTENT_LENGTH_VALUE_INVALID
+          raise HttpParserError, "Invalid Content-Length: #{cl.inspect}"
+        end
+      else
         @buffer = body.empty? ? nil : body
         @body = EmptyBody
         set_ready
@@ -478,7 +510,13 @@ module Puma
       while !io.eof?
         line = io.gets
         if line.end_with?("\r\n")
-          len = line.strip.to_i(16)
+          # Puma doesn't process chunk extensions, but should parse if they're
+          # present, which is the reason for the semicolon regex
+          chunk_hex = line.strip[/\A[^;]+/]
+          if chunk_hex =~ CHUNK_SIZE_INVALID
+            raise HttpParserError, "Invalid chunk size: '#{chunk_hex}'"
+          end
+          len = chunk_hex.to_i(16)
           if len == 0
             @in_last_chunk = true
             @body.rewind
@@ -509,7 +547,12 @@ module Puma
 
           case
           when got == len
-            write_chunk(part[0..-3]) # to skip the ending \r\n
+            # proper chunked segment must end with "\r\n"
+            if part.end_with? CHUNK_VALID_ENDING
+              write_chunk(part[0..-3]) # to skip the ending \r\n
+            else
+              raise HttpParserError, "Chunk size mismatch"
+            end
           when got <= len - 2
             write_chunk(part)
             @partial_part_left = len - part.size

data/lib/puma/const.rb

@@ -76,7 +76,7 @@ module Puma
     508 => 'Loop Detected',
     510 => 'Not Extended',
     511 => 'Network Authentication Required'
-  }
+  }.freeze
 
   # For some HTTP status codes the client only expects headers.
   #
@@ -85,7 +85,7 @@ module Puma
     204 => true,
     205 => true,
     304 => true
-  }
+  }.freeze
 
   # Frequently used constants when constructing requests or responses.  Many times
   # the constant just refers to a string with the same contents.  Using these constants
@@ -100,7 +100,7 @@ module Puma
   # too taxing on performance.
   module Const
 
-    PUMA_VERSION = VERSION = "5.6.0".freeze
+    PUMA_VERSION = VERSION = "5.6.4".freeze
     CODE_NAME = "Birdie's Version".freeze
 
     PUMA_SERVER_STRING = ['puma', PUMA_VERSION, CODE_NAME].join(' ').freeze
@@ -145,9 +145,11 @@ module Puma
       408 => "HTTP/1.1 408 Request Timeout\r\nConnection: close\r\nServer: Puma #{PUMA_VERSION}\r\n\r\n".freeze,
       # Indicate that there was an internal error, obviously.
       500 => "HTTP/1.1 500 Internal Server Error\r\n\r\n".freeze,
+      # Incorrect or invalid header value
+      501 => "HTTP/1.1 501 Not Implemented\r\n\r\n".freeze,
       # A common header for indicating the server is too busy.  Not used yet.
       503 => "HTTP/1.1 503 Service Unavailable\r\n\r\nBUSY".freeze
-    }
+    }.freeze
 
     # The basic max request size we'll try to read.
     CHUNK_SIZE = 16 * 1024

data/lib/puma/request.rb

@@ -46,7 +46,11 @@ module Puma
       env[HIJACK_P] = true
       env[HIJACK] = client
 
-      env[RACK_INPUT] = client.body
+      body = client.body
+
+      head = env[REQUEST_METHOD] == HEAD
+
+      env[RACK_INPUT] = body
       env[RACK_URL_SCHEME] ||= default_server_port(env) == PORT_443 ? HTTPS : HTTP
 
       if @early_hints
@@ -65,58 +69,36 @@ module Puma
       # A rack extension. If the app writes #call'ables to this
       # array, we will invoke them when the request is done.
       #
-      env[RACK_AFTER_REPLY] = []
+      after_reply = env[RACK_AFTER_REPLY] = []
 
       begin
-        status, headers, res_body = @thread_pool.with_force_shutdown do
-          @app.call(env)
-        end
-
-        return :async if client.hijacked
-
-        status = status.to_i
-
-        if status == -1
-          unless headers.empty? and res_body == []
-            raise "async response must have empty headers and body"
+        begin
+          status, headers, res_body = @thread_pool.with_force_shutdown do
+            @app.call(env)
           end
 
-          return :async
-        end
-      rescue ThreadPool::ForceShutdown => e
-        @events.unknown_error e, client, "Rack app"
-        @events.log "Detected force shutdown of a thread"
+          return :async if client.hijacked
 
-        status, headers, res_body = lowlevel_error(e, env, 503)
-      rescue Exception => e
-        @events.unknown_error e, client, "Rack app"
-
-        status, headers, res_body = lowlevel_error(e, env, 500)
-      end
+          status = status.to_i
 
-      write_response(status, headers, res_body, lines, requests, client)
-    end
+          if status == -1
+            unless headers.empty? and res_body == []
+              raise "async response must have empty headers and body"
+            end
 
-    # Does the actual response writing for Request#handle_request and Server#client_error
-    #
-    # @param status [Integer] the status returned by the Rack application
-    # @param headers [Hash] the headers returned by the Rack application
-    # @param res_body [Array] the body returned by the Rack application
-    # @param lines [Puma::IOBuffer] modified in place
-    # @param requests [Integer] number of inline requests handled
-    # @param client [Puma::Client]
-    # @return [Boolean,:async]
-    def write_response(status, headers, res_body, lines, requests, client)
-      env = client.env
-      io  = client.io
+            return :async
+          end
+        rescue ThreadPool::ForceShutdown => e
+          @events.unknown_error e, client, "Rack app"
+          @events.log "Detected force shutdown of a thread"
 
-      return false if closed_socket?(io)
-      lines.clear
+          status, headers, res_body = lowlevel_error(e, env, 503)
+        rescue Exception => e
+          @events.unknown_error e, client, "Rack app"
 
-      head = env[REQUEST_METHOD] == HEAD
-      after_reply = env[RACK_AFTER_REPLY] || []
+          status, headers, res_body = lowlevel_error(e, env, 500)
+        end
 
-      begin
         res_info = {}
         res_info[:content_length] = nil
         res_info[:no_body] = head
@@ -167,9 +149,9 @@ module Puma
           res_body.each do |part|
             next if part.bytesize.zero?
             if chunked
-                fast_write io, (part.bytesize.to_s(16) << line_ending)
-                fast_write io, part            # part may have different encoding
-                fast_write io, line_ending
+               fast_write io, (part.bytesize.to_s(16) << line_ending)
+               fast_write io, part            # part may have different encoding
+               fast_write io, line_ending
             else
               fast_write io, part
             end
@@ -185,11 +167,16 @@ module Puma
         end
 
       ensure
-        uncork_socket io
-
-        client.body.close if client.body
-        client.tempfile.unlink if client.tempfile
-        res_body.close if res_body.respond_to? :close
+        begin
+          uncork_socket io
+
+          body.close
+          client.tempfile.unlink if client.tempfile
+        ensure
+          # Whatever happens, we MUST call `close` on the response body.
+          # Otherwise Rack::BodyProxy callbacks may not fire and lead to various state leaks
+          res_body.close if res_body.respond_to? :close
+        end
 
         after_reply.each { |o| o.call }
       end

data/lib/puma/server.rb

@@ -476,7 +476,7 @@ module Puma
         end
         true
       rescue StandardError => e
-        client_error(e, client, buffer, requests)
+        client_error(e, client)
         # The ensure tries to close +client+ down
         requests > 0
       ensure
@@ -504,36 +504,37 @@ module Puma
     # :nocov:
 
     # Handle various error types thrown by Client I/O operations.
-    def client_error(e, client, buffer = ::Puma::IOBuffer.new, requests = 1)
+    def client_error(e, client)
       # Swallow, do not log
       return if [ConnectionError, EOFError].include?(e.class)
 
+      lowlevel_error(e, client.env)
       case e
       when MiniSSL::SSLError
         @events.ssl_error e, client.io
       when HttpParserError
-        status, headers, res_body = lowlevel_error(e, client.env, 400)
-        write_response(status, headers, res_body, buffer, requests, client)
+        client.write_error(400)
+        @events.parse_error e, client
+      when HttpParserError501
+        client.write_error(501)
         @events.parse_error e, client
       else
-        status, headers, res_body = lowlevel_error(e, client.env)
-        write_response(status, headers, res_body, buffer, requests, client)
+        client.write_error(500)
         @events.unknown_error e, nil, "Read"
       end
     end
 
     # A fallback rack response if +@app+ raises as exception.
     #
-    def lowlevel_error(e, env, status = 500)
+    def lowlevel_error(e, env, status=500)
       if handler = @options[:lowlevel_error_handler]
         if handler.arity == 1
-          handler_status, headers, res_body = handler.call(e)
+          return handler.call(e)
         elsif handler.arity == 2
-          handler_status, headers, res_body = handler.call(e, env)
+          return handler.call(e, env)
         else
-          handler_status, headers, res_body = handler.call(e, env, status)
+          return handler.call(e, env, status)
         end
-        return [handler_status || status, headers || {}, res_body || []]
       end
 
       if @leak_stack_on_error

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: puma
 version: !ruby/object:Gem::Version
-  version: 5.6.0
+  version: 5.6.4
 platform: java
 authors:
 - Evan Phoenix