protocol-http2 0.1.0

data/lib/protocol/http2/headers_frame.rb

@@ -0,0 +1,83 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'frame'
+require_relative 'padded'
+require_relative 'continuation_frame'
+require_relative 'priority_frame'
+
+module Protocol
+	module HTTP2
+		# 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.
+		# 
+		# +---------------+
+		# |Pad Length? (8)|
+		# +-+-------------+-----------------------------------------------+
+		# |E|                 Stream Dependency? (31)                     |
+		# +-+-------------+-----------------------------------------------+
+		# |  Weight? (8)  |
+		# +-+-------------+-----------------------------------------------+
+		# |                   Header Block Fragment (*)                 ...
+		# +---------------------------------------------------------------+
+		# |                           Padding (*)                       ...
+		# +---------------------------------------------------------------+
+		#
+		class HeadersFrame < Frame
+			include Continued, Padded
+			
+			TYPE = 0x1
+			
+			def priority?
+				flag_set?(PRIORITY)
+			end
+			
+			def end_stream?
+				flag_set?(END_STREAM)
+			end
+			
+			def unpack
+				data = super
+				
+				if priority?
+					priority = Priority.unpack(data)
+					data = data.byteslice(5, data.bytesize - 5)
+				end
+				
+				return priority, data
+			end
+			
+			def pack(priority, data, *args)
+				buffer = String.new.b
+				
+				if priority
+					buffer << priority.pack
+				end
+				
+				buffer << data
+				
+				super(buffer, *args)
+			end
+			
+			def apply(connection)
+				connection.receive_headers(self)
+			end
+		end
+	end
+end

data/lib/protocol/http2/padded.rb

@@ -0,0 +1,79 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2013, by Ilya Grigorik.
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'frame'
+
+module Protocol
+	module HTTP2
+		# Certain frames can have padding:
+		# https://http2.github.io/http2-spec/#padding
+		#
+		# +---------------+
+		# |Pad Length? (8)|
+		# +---------------+-----------------------------------------------+
+		# |                            Data (*)                         ...
+		# +---------------------------------------------------------------+
+		# |                           Padding (*)                       ...
+		# +---------------------------------------------------------------+
+		#
+		module Padded
+			def padded?
+				flag_set?(PADDED)
+			end
+			
+			def pack(data, padding_size: nil, maximum_size: nil)
+				if padding_size
+					set_flags(PADDED)
+					
+					buffer = String.new.b
+					
+					buffer << padding_size.chr
+					buffer << data
+					
+					if padding_size > 1
+						buffer << "\0" * (padding_size - 1)
+					end
+					
+					super buffer
+				else
+					clear_flags(PADDED)
+					
+					super data
+				end
+			end
+			
+			def unpack
+				if padded?
+					padding_size = @payload[0].ord
+					data_size = (@payload.bytesize - 1) - padding_size
+					
+					if data_size < 0
+						raise ProtocolError, "Invalid padding length: #{padding_size}"
+					end
+					
+					return @payload.byteslice(1, data_size)
+				else
+					return @payload
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http2/ping_frame.rb

@@ -0,0 +1,80 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'frame'
+
+module Protocol
+	module HTTP2
+		ACKNOWLEDGEMENT = 0x1
+		
+		module Acknowledgement
+			def acknowledgement?
+				flag_set?(ACKNOWLEDGEMENT)
+			end
+			
+			def acknowledge
+				frame = self.class.new
+				
+				frame.length = 0
+				frame.set_flags(ACKNOWLEDGEMENT)
+				
+				return frame
+			end
+		end
+		
+		# The PING frame is a mechanism for measuring a minimal round-trip time from the sender, as well as determining whether an idle connection is still functional. PING frames can be sent from any endpoint.
+		#
+		# +---------------------------------------------------------------+
+		# |                                                               |
+		# |                      Opaque Data (64)                         |
+		# |                                                               |
+		# +---------------------------------------------------------------+
+		#
+		class PingFrame < Frame
+			TYPE = 0x6
+			
+			include Acknowledgement
+			
+			def connection?
+				true
+			end
+			
+			def apply(connection)
+				connection.receive_ping(self)
+			end
+			
+			def acknowledge
+				frame = super
+				
+				frame.pack self.unpack
+				
+				return frame
+			end
+			
+			def read_payload(stream)
+				super
+				
+				if @length > 8
+					raise FrameSizeError, "Invalid frame length"
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http2/priority_frame.rb

@@ -0,0 +1,80 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'frame'
+
+module Protocol
+	module HTTP2
+		Priority = Struct.new(:exclusive, :stream_dependency, :weight) do
+			FORMAT = "NC".freeze
+			EXCLUSIVE = 1 << 31
+			
+			def self.unpack(data)
+				stream_dependency, weight = data.unpack(FORMAT)
+				
+				return self.new(stream_dependency & EXCLUSIVE != 0, stream_dependency & ~EXCLUSIVE, weight)
+			end
+			
+			def pack
+				if exclusive
+					stream_dependency = self.stream_dependency | EXCLUSIVE
+				end
+				
+				return [stream_dependency, self.weight].pack(FORMAT)
+			end
+		end
+		
+		# The PRIORITY frame specifies the sender-advised priority of a stream. It can be sent in any stream state, including idle or closed streams.
+		#
+		# +-+-------------------------------------------------------------+
+		# |E|                  Stream Dependency (31)                     |
+		# +-+-------------+-----------------------------------------------+
+		# |   Weight (8)  |
+		# +-+-------------+
+		#
+		class PriorityFrame < Frame
+			TYPE = 0x2
+			
+			def priority
+				Priority.unpack(@payload)
+			end
+			
+			def pack priority
+				super priority.pack
+			end
+			
+			def unpack
+				Priority.unpack(super)
+			end
+			
+			def apply(connection)
+				connection.receive_priority(self)
+			end
+			
+			def read_payload(stream)
+				super
+				
+				if @length != 5
+					raise FrameSizeError, "Invalid frame length"
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http2/push_promise_frame.rb

@@ -0,0 +1,62 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'frame'
+require_relative 'padded'
+require_relative 'continuation_frame'
+
+module Protocol
+	module HTTP2
+		# The PUSH_PROMISE frame is used to notify the peer endpoint in advance of streams the sender intends to initiate. The PUSH_PROMISE frame includes the unsigned 31-bit identifier of the stream the endpoint plans to create along with a set of headers that provide additional context for the stream.
+		# 
+		# +---------------+
+		# |Pad Length? (8)|
+		# +-+-------------+-----------------------------------------------+
+		# |R|                  Promised Stream ID (31)                    |
+		# +-+-----------------------------+-------------------------------+
+		# |                   Header Block Fragment (*)                 ...
+		# +---------------------------------------------------------------+
+		# |                           Padding (*)                       ...
+		# +---------------------------------------------------------------+
+		#
+		class PushPromiseFrame < Frame
+			include Continued, Padded
+			
+			TYPE = 0x5
+			FORMAT = "N".freeze
+			
+			def unpack
+				data = super
+				
+				stream_id = data.unpack(FORMAT).first
+				
+				return stream_id, data.byteslice(4, data.bytesize - 4)
+			end
+			
+			def pack(stream_id, data, *args)
+				super([stream_id].pack(FORMAT) + data, *args)
+			end
+			
+			def apply(connection)
+				connection.receive_push_promise(self)
+			end
+		end
+	end
+end

data/lib/protocol/http2/reset_stream_frame.rb

@@ -0,0 +1,72 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'frame'
+
+module Protocol
+	module HTTP2
+		NO_ERROR = 0
+		PROTOCOL_ERROR = 1
+		INTERNAL_ERROR = 2
+		FLOW_CONTROL_ERROR = 3
+		TIMEOUT = 4
+		STREAM_CLOSED = 5
+		FRAME_SIZE_ERROR = 6
+		REFUSED_STREAM = 7
+		CANCEL = 8
+		COMPRESSION_ERROR = 9
+		CONNECT_ERROR = 10
+		ENHANCE_YOUR_CALM = 11
+		INADEQUATE_SECURITY = 12
+		HTTP_1_1_REQUIRED = 13
+		
+		# The RST_STREAM frame allows for immediate termination of a stream. RST_STREAM is sent to request cancellation of a stream or to indicate that an error condition has occurred.
+		#
+		# +---------------------------------------------------------------+
+		# |                        Error Code (32)                        |
+		# +---------------------------------------------------------------+
+		#
+		class ResetStreamFrame < Frame
+			TYPE = 0x3
+			FORMAT = "N".freeze
+			
+			def unpack
+				@payload.unpack(FORMAT).first
+			end
+			
+			def pack(error_code = NO_ERROR)
+				@payload = [error_code].pack(FORMAT)
+				@length = @payload.bytesize
+			end
+			
+			def apply(connection)
+				connection.receive_reset_stream(self)
+			end
+			
+			def read_payload(stream)
+				super
+				
+				if @length != 4
+					raise FrameSizeError, "Invalid frame length"
+				end
+			end
+		end
+	end
+end

data/lib/protocol/http2/server.rb

@@ -0,0 +1,53 @@
+# Copyright, 2018, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+require_relative 'connection'
+
+module Protocol
+	module HTTP2
+		class Server < Connection
+			def initialize(framer)
+				super(framer, 2)
+			end
+			
+			def read_connection_preface(settings = [])
+				if @state == :new
+					@framer.read_connection_preface
+					
+					send_settings(settings)
+					
+					read_frame do |frame|
+						raise ProtocolError, "First frame must be SettingsFrame, but got #{frame.class}" unless frame.is_a? SettingsFrame
+					end
+				else
+					raise ProtocolError, "Cannot send connection preface in state #{@state}"
+				end
+			end
+			
+			def enable_push?
+				@remote_settings.enable_push?
+			end
+			
+			def receive_push_promise
+				raise ProtocolError, "Server cannot receive push promises."
+			end
+		end
+	end
+end