protocol-http2 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aea99dc493ccb40d8116646387ff26724010de491bd248e8d925d0dead5d60d3
-  data.tar.gz: 1ee5cb421bfd1674181ddf079534bf793c69ae328bbd1e80fe7ab7a154cca9f3
+  metadata.gz: 59f70b2d8905a24deb2b5f6400347631c226dea2814f23a0701d64ca343c8e7e
+  data.tar.gz: b6370e82f47701f4eb7ad21049524cf559d7c1303a839a802a88dfc8f2808c16
 SHA512:
-  metadata.gz: a6bae8dd0f45b18b0430158c844ef4c6eddc0a5b6233215663f61c9628021a4213f1d1e2cfa6dede159845f3216d27b25dba47e78b51cfa7fcacf56fc8c08cfb
-  data.tar.gz: 43d2b449bad3864708bcb68219999ecc058f633c2866d73331c09d1bb7c2f2ab9c4922313b6124f239bf19a8dc38d4c26638aa7c3563fd9fada4dfe29374bc2b
+  metadata.gz: f2c32cb5174ed643a415b836a2faa53a325a5e3252e1db55be9fafbc117fd78beb3768b467879f27b146da001caf3a92c74137924e5cf4c9eb86006b7d5a4a42
+  data.tar.gz: 05a417ab4821acb8e0db930440f8a7583ae265f1dd14363eea42963cc4fb313e413aa91d3c81ca4453a413f5db42ef6934e6c4d76cef5f9ac7b757f5f7c6a67e

data/lib/protocol/http2/client.rb

@@ -27,6 +27,10 @@ module Protocol
 				super(framer, 1)
 			end
 			
+			def valid_remote_stream_id?(stream_id)
+				stream_id.even?
+			end
+			
 			def send_connection_preface(settings = [])
 				if @state == :new
 					@framer.write_connection_preface

data/lib/protocol/http2/connection.rb

@@ -50,6 +50,7 @@ module Protocol
 				0
 			end
 			
+			# The size of a frame payload is limited by the maximum size that a receiver advertises in the SETTINGS_MAX_FRAME_SIZE setting.
 			def maximum_frame_size
 				@remote_settings.maximum_frame_size
 			end
@@ -78,11 +79,15 @@ module Protocol
 				@state == :closed
 			end
 			
-			def close
+			def connection_error!(error, message)
 				return if @framer.closed?
 				
-				send_goaway unless closed?
+				send_goaway(error, message)
 				
+				self.close
+			end
+			
+			def close
 				@framer.close
 			end
 			
@@ -117,16 +122,21 @@ module Protocol
 				frame.apply(self)
 				
 				return frame
+			rescue GoawayError
+				# This is not a connection error. We are done.
+				self.close
+				
+				raise
 			rescue ProtocolError => error
-				send_goaway(error.code || PROTOCOL_ERROR, error.message)
+				connection_error!(error.code || PROTOCOL_ERROR, error.message)
 				
 				raise
 			rescue HPACK::CompressionError => error
-				send_goaway(COMPRESSION_ERROR, error.message)
+				connection_error!(COMPRESSION_ERROR, error.message)
 				
 				raise
 			rescue
-				send_goaway(PROTOCOL_ERROR, $!.message)
+				connection_error!(PROTOCOL_ERROR, $!.message)
 				
 				raise
 			end
@@ -236,6 +246,10 @@ module Protocol
 			
 			def receive_ping(frame)
 				if @state != :closed
+					if frame.stream_id != 0
+						raise ProtocolError, "Ping received for non-zero stream!"
+					end
+					
 					unless frame.acknowledgement?
 						reply = frame.acknowledge
 						
@@ -251,17 +265,32 @@ module Protocol
 				
 				if stream = @streams[frame.stream_id]
 					stream.receive_data(frame)
-					
-					if stream.closed?
-						@streams.delete(stream.id)
-					end
 				else
-					raise ProtocolError, "Bad stream"
+					raise ProtocolError, "Cannot receive data for idle stream #{frame.stream_id}"
 				end
 			end
 			
+			def valid_remote_stream_id?
+				false
+			end
+			
+			# Accept a stream from the other side of the connnection.
+			def accept_stream(stream_id)
+				unless valid_remote_stream_id?(stream_id)
+					raise ProtocolError, "Invalid remote stream id: #{stream_id}"
+				end
+				
+				if stream_id <= @remote_stream_id
+					raise ProtocolError, "Invalid stream id: #{stream_id} <= #{@remote_stream_id}!"
+				end
+				
+				@remote_stream_id = stream_id
+				create_stream(stream_id)
+			end
+			
+			# Create a stream on this side of the connection.
 			def create_stream(stream_id = next_stream_id)
-				Stream.new(self, stream_id)
+				@streams[stream_id] = Stream.new(self, stream_id)
 			end
 			
 			def receive_headers(frame)
@@ -271,49 +300,30 @@ module Protocol
 				
 				if stream = @streams[frame.stream_id]
 					stream.receive_headers(frame)
-					
-					if stream.closed?
-						@streams.delete(stream.id)
-					end
-				elsif frame.stream_id > @remote_stream_id
+				else
 					if @streams.count < self.maximum_concurrent_streams
-						stream = create_stream(frame.stream_id)
+						stream = accept_stream(frame.stream_id)
 						stream.receive_headers(frame)
-						
-						@remote_stream_id = stream.id
-						@streams[stream.id] = stream
 					else
 						raise ProtocolError, "Exceeded maximum concurrent streams"
 					end
 				end
 			end
 			
-			def deleted_stream? frame
-				frame.stream_id <= @local_stream_id or frame.stream_id <= @remote_stream_id
-			end
-			
 			def receive_priority(frame)
 				if stream = @streams[frame.stream_id]
 					stream.receive_priority(frame)
-				elsif deleted_stream? frame
-					# ignore
 				else
-					stream = create_stream(frame.stream_id)
+					stream = accept_stream(frame.stream_id)
 					stream.receive_priority(frame)
-					
-					@streams[frame.stream_id] = stream
 				end
 			end
 			
 			def receive_reset_stream(frame)
 				if stream = @streams[frame.stream_id]
 					stream.receive_reset_stream(frame)
-					
-					@streams.delete(stream.id)
-				elsif deleted_stream? frame
-					# ignore
 				else
-					raise ProtocolError, "Bad stream"
+					raise StreamClosed, "Cannot reset stream #{frame.stream_id}"
 				end
 			end
 			
@@ -321,11 +331,14 @@ module Protocol
 				if frame.connection?
 					super
 				elsif stream = @streams[frame.stream_id]
-					stream.receive_window_update(frame)
-				elsif deleted_stream? frame
-					# ignore
+					begin
+						stream.receive_window_update(frame)
+					rescue ProtocolError => error
+						stream.send_reset_stream(error.code)
+					end
 				else
-					raise ProtocolError, "Cannot update window of non-existant stream: #{frame.stream_id}"
+					# Receiving any frame other than HEADERS or PRIORITY on a stream in this state MUST be treated as a connection error of type PROTOCOL_ERROR.
+					raise ProtocolError, "Cannot update window of idle stream #{frame.stream_id}"
 				end
 			end
 			
@@ -336,8 +349,12 @@ module Protocol
 				end
 			end
 			
+			def receive_continuation(frame)
+				raise ProtocolError, "Received unexpected continuation: #{frame.class}"
+			end
+			
 			def receive_frame(frame)
-				warn "Unhandled frame #{frame.inspect}"
+				# ignore.
 			end
 		end
 	end

data/lib/protocol/http2/continuation_frame.rb

@@ -37,9 +37,21 @@ module Protocol
 				super
 				
 				unless end_headers?
-					@continuation = ContinuationFrame.new
+					continuation = ContinuationFrame.new
+					continuation.read_header(stream)
+					
+					# We validate the frame type here:
+					unless continuation.valid_type?
+						raise ProtocolError, "Invalid frame type: #{@type}!"
+					end
+					
+					if continuation.stream_id != @stream_id
+						raise ProtocolError, "Invalid stream id: #{continuation.stream_id} for continuation of stream id: #{@stream_id}!"
+					end
 					
-					@continuation.read(stream, maximum_frame_size)
+					continuation.read(stream, maximum_frame_size)
+					
+					@continuation = continuation
 				end
 			end
 			
@@ -93,6 +105,11 @@ module Protocol
 			include Continued
 			
 			TYPE = 0x9
+			
+			# This is only invoked if the continuation is received out of the normal flow.
+			def apply(connection)
+				connection.receive_continuation(self)
+			end
 		end
 	end
 end

data/lib/protocol/http2/error.rb

@@ -86,6 +86,12 @@ module Protocol
 			attr :code
 		end
 		
+		class StreamClosed < ProtocolError
+			def initialize(message)
+				super message, STREAM_CLOSED
+			end
+		end
+		
 		class GoawayError < ProtocolError
 		end
 		

data/lib/protocol/http2/flow_control.rb

@@ -27,6 +27,8 @@ module Protocol
 				maximum_frame_size = self.maximum_frame_size
 				available_size = @remote_window.available
 				
+				# puts "available_size=#{available_size} maximum_frame_size=#{maximum_frame_size}"
+				
 				if available_size < maximum_frame_size
 					return available_size
 				else
@@ -71,8 +73,14 @@ module Protocol
 			def receive_window_update(frame)
 				was_full = @remote_window.full?
 				
-				# puts "expand remote_window=#{@remote_window} by #{frame.unpack}"
-				@remote_window.expand(frame.unpack)
+				amount = frame.unpack
+				# puts "expand remote_window=#{@remote_window} by #{amount}"
+				
+				if amount != 0
+					@remote_window.expand(amount)
+				else
+					raise ProtocolError, "Invalid window size increment: #{amount}!"
+				end
 				
 				self.window_updated if was_full
 			end

data/lib/protocol/http2/frame.rb

@@ -29,6 +29,7 @@ module Protocol
 		PRIORITY = 0x20
 		
 		MAXIMUM_ALLOWED_WINDOW_SIZE = 0x7FFFFFFF
+		MINIMUM_ALLOWED_FRAME_SIZE = 0x4000
 		MAXIMUM_ALLOWED_FRAME_SIZE = 0xFFFFFF
 		
 		class Frame
@@ -46,7 +47,7 @@ module Protocol
 			LENGTH_LOMASK  = 0xFFFF
 			
 			# @param length [Integer] the length of the payload, or nil if the header has not been read yet.
-			def initialize(stream_id = 0, flags = 0, type = self.class.const_get(:TYPE), length = nil, payload = nil)
+			def initialize(stream_id = 0, flags = 0, type = self.class::TYPE, length = nil, payload = nil)
 				@length = length
 				@type = type
 				@flags = flags
@@ -54,6 +55,10 @@ module Protocol
 				@payload = payload
 			end
 			
+			def valid_type?
+				@type == self.class::TYPE
+			end
+			
 			def <=> other
 				to_ary <=> other.to_ary
 			end
@@ -147,11 +152,18 @@ module Protocol
 				length = (length_hi << LENGTH_HISHIFT) | length_lo
 				stream_id = stream_id & STREAM_ID_MASK
 				
+				# puts "parse_header: length=#{length} type=#{type} flags=#{flags} stream_id=#{stream_id}"
+				
 				return length, type, flags, stream_id
 			end
 			
 			def read_header(stream)
-				@length, @type, @flags, @stream_id = Frame.parse_header(stream.read(9))
+				if buffer = stream.read(9)
+					@length, @type, @flags, @stream_id = Frame.parse_header(buffer)
+					# puts "read_header: #{@length} #{@type} #{@flags} #{@stream_id}"
+				else
+					raise EOFError, "Could not read frame header!"
+				end
 			end
 			
 			def read_payload(stream)

data/lib/protocol/http2/framer.rb

@@ -82,11 +82,12 @@ module Protocol
 			def read_frame(maximum_frame_size = MAXIMUM_ALLOWED_FRAME_SIZE)
 				# Read the header:
 				length, type, flags, stream_id = read_header
-				
-				# puts "framer: read_frame #{type} #{length}"
+				# puts "read_frame: length=#{length} type=#{type} flags=#{flags} stream_id=#{stream_id} -> klass=#{@frames[type].inspect}"
 				
 				# Allocate the frame:
 				klass = @frames[type] || Frame
+				# puts "read_frame #{klass} id=#{stream_id} length=#{length} flags=#{flags}"
+				
 				frame = klass.new(stream_id, flags, type, length)
 				
 				# Read the payload:

data/lib/protocol/http2/ping_frame.rb

@@ -71,8 +71,8 @@ module Protocol
 			def read_payload(stream)
 				super
 				
-				if @length > 8
-					raise FrameSizeError, "Invalid frame length"
+				if @length != 8
+					raise FrameSizeError, "Invalid frame length: #{@length} != 8!"
 				end
 			end
 		end

data/lib/protocol/http2/server.rb

@@ -27,6 +27,10 @@ module Protocol
 				super(framer, 2)
 			end
 			
+			def valid_remote_stream_id?(stream_id)
+				stream_id.odd?
+			end
+			
 			def read_connection_preface(settings = [])
 				if @state == :new
 					@framer.read_connection_preface

data/lib/protocol/http2/settings_frame.rb

@@ -68,10 +68,12 @@ module Protocol
 			attr :maximum_frame_size
 			
 			def maximum_frame_size= value
-				if value <= MAXIMUM_ALLOWED_FRAME_SIZE
-					@maximum_frame_size = value
-				else
+				if value > MAXIMUM_ALLOWED_FRAME_SIZE
 					raise ProtocolError, "Invalid value for maximum_frame_size: #{value} > #{MAXIMUM_ALLOWED_FRAME_SIZE}"
+				elsif value < MINIMUM_ALLOWED_FRAME_SIZE
+					raise ProtocolError, "Invalid value for maximum_frame_size: #{value} < #{MINIMUM_ALLOWED_FRAME_SIZE}"
+				else
+					@maximum_frame_size = value
 				end
 			end
 			

data/lib/protocol/http2/stream.rb

@@ -77,8 +77,6 @@ module Protocol
 				@connection = connection
 				@id = id
 				
-				@connection.streams[@id] = self
-				
 				@state = :idle
 				
 				@priority = nil
@@ -101,6 +99,14 @@ module Protocol
 			attr :local_window
 			attr :remote_window
 			
+			def priority= priority
+				if priority.stream_id == @id
+					raise ProtocolError, "Stream #{@id} cannot depend on itself!"
+				end
+				
+				@priority = priority
+			end
+			
 			def maximum_frame_size
 				@connection.available_frame_size
 			end
@@ -141,7 +147,7 @@ module Protocol
 				return frame
 			end
 			
-			#The HEADERS frame is used to open a stream, and additionally carries a header block fragment.  HEADERS frames can be sent on a stream in the "idle", "reserved (local)", "open", or "half-closed (remote)" state.
+			# The HEADERS frame is used to open a stream, and additionally carries a header block fragment. HEADERS frames can be sent on a stream in the "idle", "reserved (local)", "open", or "half-closed (remote)" state.
 			def send_headers(*args)
 				if @state == :idle
 					frame = write_headers(*args)
@@ -165,7 +171,7 @@ module Protocol
 					frame = write_headers(*args)
 					
 					if frame.end_stream?
-						close!
+						close
 					end
 				else
 					raise ProtocolError, "Cannot send headers in state: #{@state}"
@@ -201,17 +207,15 @@ module Protocol
 					frame = write_data(*args)
 					
 					if frame.end_stream?
-						close!
+						close
 					end
 				else
 					raise ProtocolError, "Cannot send data in state: #{@state}"
 				end
 			end
 			
-			def close!(state = :closed)
+			def close(state = :closed)
 				@state = state
-				
-				@connection.streams.delete(@id)
 			end
 			
 			def send_reset_stream(error_code = 0)
@@ -221,7 +225,7 @@ module Protocol
 					
 					write_frame(frame)
 					
-					close!(:reset)
+					close(:reset)
 				else
 					raise ProtocolError, "Cannot reset stream in state: #{@state}"
 				end
@@ -232,7 +236,7 @@ module Protocol
 				priority, data = frame.unpack
 				
 				if priority
-					@priority = priority
+					self.priority = priority
 				end
 				
 				@connection.decode_headers(data)
@@ -259,7 +263,7 @@ module Protocol
 					@headers = process_headers(frame)
 				elsif @state == :half_closed_local
 					if frame.end_stream?
-						close!
+						close
 					end
 					
 					@headers = process_headers(frame)
@@ -284,7 +288,7 @@ module Protocol
 					consume_local_window(frame)
 					
 					if frame.end_stream?
-						close!
+						close
 					end
 					
 					@data = frame.unpack
@@ -296,12 +300,12 @@ module Protocol
 			end
 			
 			def receive_priority(frame)
-				@priority = frame.unpack
+				self.priority = frame.unpack
 			end
 			
 			def receive_reset_stream(frame)
 				if @state != :idle and @state != :closed
-					close!
+					close
 					
 					return frame.unpack
 				else
@@ -367,6 +371,10 @@ module Protocol
 				
 				return stream, headers
 			end
+			
+			def inspect
+				"\#<#{self.class} id=#{@id} state=#{@state}>"
+			end
 		end
 	end
 end

data/lib/protocol/http2/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module HTTP2
-		VERSION = "0.3.0"
+		VERSION = "0.4.1"
 	end
 end

data/lib/protocol/http2/window_update_frame.rb

@@ -31,8 +31,6 @@ module Protocol
 				# These two fields are primarily used for efficiently sending window updates:
 				@used = 0
 				@capacity = capacity
-				
-				fail unless capacity
 			end
 			
 			def dup
@@ -41,7 +39,7 @@ module Protocol
 			
 			# The window is completely full?
 			def full?
-				@available.zero?
+				@available <= 0
 			end
 			
 			attr :used
@@ -67,6 +65,10 @@ module Protocol
 			def expand(amount)
 				@available += amount
 				@used -= amount
+				
+				if @available > MAXIMUM_ALLOWED_WINDOW_SIZE
+					raise FlowControlError, "Expanding window by #{amount} caused overflow: #{@available} > #{MAXIMUM_ALLOWED_WINDOW_SIZE}!"
+				end
 			end
 			
 			def limited?

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-http2
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-23 00:00:00.000000000 Z
+date: 2019-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: protocol-hpack
@@ -150,7 +150,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A low level implementation of the HTTP/2 protocol.