# Copyright, 2018, by Samuel G. D. Williams. # # 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 'framer' require_relative 'flow_control' require 'protocol/hpack' module Protocol module HTTP2 class Connection include FlowControl def initialize(framer, local_stream_id) @state = :new @streams = {} @framer = framer @local_stream_id = local_stream_id @remote_stream_id = 0 @local_settings = PendingSettings.new @remote_settings = Settings.new @decoder = HPACK::Context.new @encoder = HPACK::Context.new @local_window = Window.new(@local_settings.initial_window_size) @remote_window = Window.new(@remote_settings.initial_window_size) end def id 0 end def maximum_frame_size @remote_settings.maximum_frame_size end def maximum_concurrent_streams [@local_settings.maximum_concurrent_streams, @remote_settings.maximum_concurrent_streams].min end attr :framer # Connection state (:new, :open, :closed). attr_accessor :state # Current settings value for local and peer attr_accessor :local_settings attr_accessor :remote_settings # Our window for receiving data. When we receive data, it reduces this window. # If the window gets too small, we must send a window update. attr :local_window # Our window for sending data. When we send data, it reduces this window. attr :remote_window def closed? @state == :closed end def close send_goaway @framer.close end def encode_headers(headers, buffer = String.new.b) HPACK::Compressor.new(buffer, @encoder).encode(headers) return buffer end def decode_headers(data) HPACK::Decompressor.new(data, @decoder).decode end # Streams are identified with an unsigned 31-bit integer. Streams initiated by a client MUST use odd-numbered stream identifiers; those initiated by the server MUST use even-numbered stream identifiers. A stream identifier of zero (0x0) is used for connection control messages; the stream identifier of zero cannot be used to establish a new stream. def next_stream_id id = @local_stream_id @local_stream_id += 2 return id end attr :streams def read_frame frame = @framer.read_frame(@local_settings.maximum_frame_size) # puts "#{self.class} #{@state} read_frame: class=#{frame.class} flags=#{frame.flags} length=#{frame.length}" # puts "Windows: local_window=#{@local_window.inspect}; remote_window=#{@remote_window.inspect}" yield frame if block_given? frame.apply(self) return frame rescue ProtocolError => error send_goaway(error.code || PROTOCOL_ERROR, error.message) raise rescue HPACK::CompressionError => error send_goaway(COMPRESSION_ERROR, error.message) raise rescue send_goaway(PROTOCOL_ERROR, $!.message) raise end def send_settings(changes) @local_settings.append(changes) frame = SettingsFrame.new frame.pack(changes) write_frame(frame) end def send_goaway(error_code = 0, message = "") frame = GoawayFrame.new frame.pack @remote_stream_id, error_code, message write_frame(frame) @state = :closed end def receive_goaway(frame) @state = :closed last_stream_id, error_code, message = frame.unpack if error_code != 0 raise GoawayError.new message, error_code end end def write_frame(frame) # puts "#{self.class} #{@state} write_frame: class=#{frame.class} flags=#{frame.flags} length=#{frame.length}" @framer.write_frame(frame) end def send_ping(data) if @state != :closed frame = PingFrame.new frame.pack data write_frame(frame) else raise ProtocolError, "Cannot send ping in state #{@state}" end end def update_local_settings(changes) capacity = @local_settings.initial_window_size @streams.each_value do |stream| stream.local_window.capacity = capacity end end def update_remote_settings(changes) capacity = @remote_settings.initial_window_size @streams.each_value do |stream| stream.remote_window.capacity = capacity end end # In addition to changing the flow-control window for streams that are not yet active, a SETTINGS frame can alter the initial flow-control window size for streams with active flow-control windows (that is, streams in the "open" or "half-closed (remote)" state). When the value of SETTINGS_INITIAL_WINDOW_SIZE changes, a receiver MUST adjust the size of all stream flow-control windows that it maintains by the difference between the new value and the old value. # # @return [Boolean] whether the frame was an acknowledgement def process_settings(frame) if frame.acknowledgement? # The remote end has confirmed the settings have been received: changes = @local_settings.acknowledge update_local_settings(changes) return true else # The remote end is updating the settings, we reply with acknowledgement: reply = frame.acknowledge write_frame(reply) changes = frame.unpack @remote_settings.update(changes) update_remote_settings(changes) return false end end def open! @state = :open return self end def receive_settings(frame) if @state == :new # We transition to :open when we receive acknowledgement of first settings frame: open! if process_settings(frame) elsif @state != :closed process_settings(frame) else raise ProtocolError, "Cannot receive settings in state #{@state}" end end def receive_ping(frame) if @state != :closed unless frame.acknowledgement? reply = frame.acknowledge write_frame(reply) end else raise ProtocolError, "Cannot receive ping in state #{@state}" end end def receive_data(frame) consume_local_window(frame) if stream = @streams[frame.stream_id] stream.receive_data(frame) if stream.closed? @streams.delete(stream.id) end else raise ProtocolError, "Bad stream" end end def create_stream(stream_id = next_stream_id) Stream.new(self, stream_id) end def receive_headers(frame) if frame.stream_id == 0 raise ProtocolError, "Cannot receive headers for stream 0!" end 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 if @streams.count < self.maximum_concurrent_streams stream = create_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.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" end end def receive_window_update(frame) if frame.connection? super elsif stream = @streams[frame.stream_id] stream.receive_window_update(frame) elsif deleted_stream? frame # ignore else raise ProtocolError, "Cannot update window of non-existant stream: #{frame.stream_id}" end end def window_updated # This is very inefficient, but workable. @streams.each_value do |stream| stream.window_updated unless stream.closed? end end def receive_frame(frame) warn "Unhandled frame #{frame.inspect}" end end end end