protocol-http1 0.39.0 → 0.40.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e973bb5fe97e0766eccc257775e2549397eb1fa8f308851e653987e90f05d66
-  data.tar.gz: a688b1894c1eeb0dc5c0dd08eb40259b16e6e4b749d6d35939cd3468b5011393
+  metadata.gz: f9a61dc65b4fee0a9cca3509493160ae14b9b3268ae3134fb8e39ee8afe126df
+  data.tar.gz: 3e04a81cdf3d40a6a95b2cdda1d44d32521d68885a48e35592b498ec61779551
 SHA512:
-  metadata.gz: a2fb5ee2311c5536d3d3e75e609a7a577f69854dc5449a04755ac4a0efea07d042b5d0f13b4c42563ad1d762f1ffed421889ab29f1b3392bada9e0a03e314726
-  data.tar.gz: d9ad14658632916da00953025fac66e6644be9e1e9504d5ad7e5a2bd74577c7ea21ce2073194ff2e9034e865172b609da3f03323d52ff4176f70957f44a2cb4c
+  metadata.gz: bf4886e4fba31c3d001ee1edfbb6ca68390969153441a253e251d8f8ab116d28ff4b089adb82a6ec79a97465a0c190887d64dd025d090879f591ef8c90a73c3b
+  data.tar.gz: 37eb313331d6f6af51eab12400118662fa408200456fbaa54cd9908c63b598e95f97304f559e72c4a0459239c06938e2e5261da6ff6a39a379920f844886a3cf

data/lib/protocol/http1/body/chunked.rb

@@ -15,6 +15,9 @@ module Protocol
 			class Chunked < HTTP::Body::Readable
 				CRLF = "\r\n"
 				
+				# The maximum amount of body data returned by a single read.
+				BLOCK_SIZE = 1024 * 64
+				
 				# Initialize the chunked body.
 				#
 				# @parameter connection [Protocol::HTTP1::Connection] the connection to read the body from.
@@ -27,6 +30,7 @@ module Protocol
 					
 					@length = 0
 					@count = 0
+					@remaining = nil
 				end
 				
 				# @attribute [Integer] the number of chunks read so far.
@@ -69,15 +73,39 @@ module Protocol
 				# @returns [String | Nil] the next chunk of data, or `nil` if the body is finished.
 				# @raises [EOFError] if the connection is closed before the expected length is read.
 				def read
-					if !@finished
-						if @connection
+					while !@finished
+						unless @connection
+							raise EOFError, "Connection closed before expected length was read!"
+						end
+						
+						if @remaining
+							if @remaining > 0
+								chunk = @connection.readpartial([@remaining, BLOCK_SIZE].min)
+								@remaining -= chunk.bytesize
+								@length += chunk.bytesize
+								
+								return chunk
+							end
+							
+							terminator = @connection.read(CRLF.bytesize)
+							
+							unless terminator&.bytesize == CRLF.bytesize
+								raise EOFError, "Connection closed before expected length was read!"
+							end
+							
+							unless terminator == CRLF
+								raise BadRequest, "Invalid chunk terminator: #{terminator.inspect}"
+							end
+							
+							@remaining = nil
+							@count += 1
+						else
 							length, _extensions = @connection.read_line.split(";", 2)
 							
 							unless length =~ VALID_CHUNK_LENGTH
 								raise BadRequest, "Invalid chunk length: #{length.inspect}"
 							end
 							
-							# It is possible this line contains chunk extension, so we use `to_i` to only consider the initial integral part:
 							length = Integer(length, 16)
 							
 							if length == 0
@@ -91,27 +119,16 @@ module Protocol
 								return nil
 							end
 							
-							# Read trailing CRLF:
-							chunk = @connection.read(length + 2)
-							
-							if chunk.bytesize == length + 2
-								# ...and chomp it off:
-								chunk.chomp!(CRLF)
-								
-								@length += length
-								@count += 1
-								
-								return chunk
-							else
-								# The connection has been closed before we have read the requested length:
-								@connection.close_read
-								@connection = nil
-							end
+							@remaining = length
 						end
-						
-						# If the connection has been closed before we have read the final chunk, raise an error:
-						raise EOFError, "connection closed before expected length was read!"
 					end
+				rescue EOFError
+					if connection = @connection
+						@connection = nil
+						connection.close_read
+					end
+					
+					raise EOFError, "Connection closed before expected length was read!"
 				end
 				
 				# @returns [String] a human-readable representation of the body.

data/lib/protocol/http1/body/fixed.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2025, by Samuel Williams.
+# Copyright, 2019-2026, by Samuel Williams.
 
 require "protocol/http/body/readable"
 
@@ -10,6 +10,9 @@ module Protocol
 		module Body
 			# Represents a fixed length body.
 			class Fixed < HTTP::Body::Readable
+				# The maximum amount of body data returned by a single read.
+				BLOCK_SIZE = 1024 * 64
+				
 				# Initialize the body with the given connection and length.
 				#
 				# @parameter connection [Protocol::HTTP1::Connection] the connection to read the body from.
@@ -55,7 +58,7 @@ module Protocol
 					if @remaining > 0
 						if @connection
 							# `readpartial` will raise `EOFError` if the connection is finished, or `IOError` if the connection is closed.
-							chunk = @connection.readpartial(@remaining)
+							chunk = @connection.readpartial([@remaining, BLOCK_SIZE].min)
 							
 							@remaining -= chunk.bytesize
 							
@@ -68,7 +71,7 @@ module Protocol
 						end
 						
 						# If the connection has been closed before we have read the expected length, raise an error:
-						raise EOFError, "connection closed before expected length was read!"
+						raise EOFError, "Connection closed before expected length was read!"
 					end
 				end
 				

data/lib/protocol/http1/connection.rb

@@ -8,8 +8,8 @@
 # Copyright, 2024, by Anton Zhuravsky.
 
 require "protocol/http/headers"
+require "protocol/http/status"
 
-require_relative "reason"
 require_relative "error"
 require_relative "body"
 
@@ -277,7 +277,7 @@ module Protocol
 			# @parameter headers [Hash] the HTTP headers.
 			# @parameter reason [String] the reason phrase, defaults to the standard reason phrase for the status code.
 			def write_response(version, status, headers, reason = nil)
-				reason ||= Reason::DESCRIPTIONS[status]
+				reason ||= Protocol::HTTP::Status.description(status)
 				
 				unless @state == :open or @state == :half_closed_remote
 					raise ProtocolError, "Cannot write response in state: #{@state}!"
@@ -297,7 +297,7 @@ module Protocol
 			# @parameter reason [String] the reason phrase, defaults to the standard reason phrase for the status code.
 			# @raises [ProtocolError] if the connection is not in the open or half-closed remote state.
 			def write_interim_response(version, status, headers, reason = nil)
-				reason ||= Reason::DESCRIPTIONS[status]
+				reason ||= Protocol::HTTP::Status.description(status)
 				
 				unless @state == :open or @state == :half_closed_remote
 					raise ProtocolError, "Cannot write interim response in state: #{@state}!"

data/lib/protocol/http1/version.rb

@@ -5,6 +5,6 @@
 
 module Protocol
 	module HTTP1
-		VERSION = "0.39.0"
+		VERSION = "0.40.1"
 	end
 end

data/readme.md

@@ -30,6 +30,14 @@ Please see the [project documentation](https://socketry.github.io/protocol-http1
 
 Please see the [project releases](https://socketry.github.io/protocol-http1/releases/index) for all releases.
 
+### v0.40.1
+
+  - Bound fixed-length and chunked body reads, and validate chunk terminators.
+
+### v0.40.0
+
+  - Use `Protocol::HTTP::Status` for standard HTTP status descriptions and remove the duplicate `Protocol::HTTP1::Reason` table.
+
 ### v0.39.0
 
   - Rename `RequestRefusedError` -\> `RefusedError`.
@@ -64,14 +72,6 @@ Please see the [project releases](https://socketry.github.io/protocol-http1/rele
   - Fix connection state handling to allow idempotent response body closing.
   - Add `kisaten` fuzzing integration for improved security testing.
 
-### v0.34.0
-
-  - Support empty header values in HTTP parsing for better compatibility.
-
-### v0.33.0
-
-  - Support high-byte characters in HTTP headers for improved international compatibility.
-
 ## Contributing
 
 We welcome contributions to this project.
@@ -82,6 +82,22 @@ We welcome contributions to this project.
 4.  Push to the branch (`git push origin my-new-feature`).
 5.  Create new Pull Request.
 
+### Running Tests
+
+To run the test suite:
+
+``` shell
+bundle exec sus
+```
+
+### Making Releases
+
+To make a new release:
+
+``` shell
+bundle exec bake gem:release:patch # or minor or major
+```
+
 ### Developer Certificate of Origin
 
 In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.

data/releases.md

@@ -1,5 +1,13 @@
 # Releases
 
+## v0.40.1
+
+  - Bound fixed-length and chunked body reads, and validate chunk terminators.
+
+## v0.40.0
+
+  - Use `Protocol::HTTP::Status` for standard HTTP status descriptions and remove the duplicate `Protocol::HTTP1::Reason` table.
+
 ## v0.39.0
 
   - Rename `RequestRefusedError` -\> `RefusedError`.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http1
 version: !ruby/object:Gem::Version
-  version: 0.39.0
+  version: 0.40.1
 platform: ruby
 authors:
 - Samuel Williams
@@ -49,14 +49,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.62'
+        version: '0.68'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.62'
+        version: '0.68'
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -70,7 +70,6 @@ files:
 - lib/protocol/http1/body/remainder.rb
 - lib/protocol/http1/connection.rb
 - lib/protocol/http1/error.rb
-- lib/protocol/http1/reason.rb
 - lib/protocol/http1/version.rb
 - lib/traces/provider/protocol/http1.rb
 - lib/traces/provider/protocol/http1/connection.rb
@@ -97,7 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.6
+rubygems_version: 4.0.10
 specification_version: 4
 summary: A low level implementation of the HTTP/1 protocol.
 test_files: []

data/lib/protocol/http1/reason.rb

@@ -1,84 +0,0 @@
-# frozen_string_literal: true
-
-# Released under the MIT License.
-# Copyright, 2019-2025, by Samuel Williams.
-
-require "protocol/http/error"
-
-module Protocol
-	module HTTP1
-		# Reason phrases for HTTP status codes.
-		module Reason
-			# Get the reason phrase for the given status code.
-			DESCRIPTIONS = {
-				100 => "Continue",
-				101 => "Switching Protocols",
-				102 => "Processing",
-				103 => "Early Hints",
-				
-				200 => "OK",
-				201 => "Created",
-				202 => "Accepted",
-				203 => "Non-Authoritative Information",
-				204 => "No Content",
-				205 => "Reset Content",
-				206 => "Partial Content",
-				207 => "Multi-Status",
-				208 => "Already Reported",
-				226 => "IM Used",
-				
-				300 => "Multiple Choices",
-				301 => "Moved Permanently",
-				302 => "Found",
-				303 => "See Other",
-				304 => "Not Modified",
-				305 => "Use Proxy",
-				
-				# no longer used, but included for completeness
-				306 => "Switch Proxy",
-				307 => "Temporary Redirect",
-				308 => "Permanent Redirect",
-				
-				400 => "Bad Request",
-				401 => "Unauthorized",
-				402 => "Payment Required",
-				403 => "Forbidden",
-				404 => "Not Found",
-				405 => "Method Not Allowed",
-				406 => "Not Acceptable",
-				407 => "Proxy Authentication Required",
-				408 => "Request Timeout",
-				409 => "Conflict",
-				410 => "Gone",
-				411 => "Length Required",
-				412 => "Precondition Failed",
-				413 => "Payload Too Large",
-				414 => "URI Too Long",
-				415 => "Unsupported Media Type",
-				416 => "Range Not Satisfiable",
-				417 => "Expectation Failed",
-				421 => "Misdirected Request",
-				422 => "Unprocessable Entity",
-				423 => "Locked",
-				424 => "Failed Dependency",
-				426 => "Upgrade Required",
-				428 => "Precondition Required",
-				429 => "Too Many Requests",
-				431 => "Request Header Fields Too Large",
-				451 => "Unavailable for Legal Reasons",
-				
-				500 => "Internal Server Error",
-				501 => "Not Implemented",
-				502 => "Bad Gateway",
-				503 => "Service Unavailable",
-				504 => "Gateway Timeout",
-				505 => "HTTP Version Not Supported",
-				506 => "Variant Also Negotiates",
-				507 => "Insufficient Storage",
-				508 => "Loop Detected",
-				510 => "Not Extended",
-				511 => "Network Authentication Required"
-			}.freeze
-		end
-	end
-end