http-2 1.2.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b41c25d0512d4056a38265801e7eef05df3cab5720ecbe11ff088c906752019
-  data.tar.gz: 0b7322ff7f49e8dd892a9804a1a710be23f3c7105f76f7c67f62b281843616fc
+  metadata.gz: 19c1750fca12fb4ff94e29361824fc7f64052b4a320adee6d739c1acffc3c4ab
+  data.tar.gz: cd41bb795576baae733b69a364444323b77702512a031d425ac1f8f62c402311
 SHA512:
-  metadata.gz: 32b4191d53effc33d5186da7093af95698809f2fec89fe37ce01898628d598e7a1215704875ec06ebd9fcaf84b11517310ee46631fb7a2c6b4a2a17fb3ad8b94
-  data.tar.gz: 5ce7ec0abedca471a25e45883ba4b8d315eb1e78879ed5a8c563dc6a58a7e128bbe9f78f878a8d9956dd90254718634bc67323b57039cb33e87d6e1552cac392
+  metadata.gz: 2a33812ab5c84f41d51b66ce93d0616ffed1592276df92f9be71fb714b2288d96e4b728222a80d5cd7501907259bbe924bdc332a6a61f18ab227e6bdeccfddca
+  data.tar.gz: d366d161f3a126e4a1394ccc13266fda028a1f7a949629a90a3ba1b86fb89a08971dc5f08cd3d03beef6f340444dd83d27b5110ca7ddca7aba3a80593115ced7

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 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.

data/lib/http/2/base64.rb

@@ -30,16 +30,16 @@ elsif !defined?(Base64)
         str.tr!("+/", "-_")
         str
       end
-    end
 
-    def urlsafe_decode64(str)
-      if !str.end_with?("=") && str.length % 4 != 0
-        str = str.ljust((str.length + 3) & ~3, "=")
-        str.tr!("-_", "+/")
-      else
-        str = str.tr("-_", "+/")
+      def urlsafe_decode64(str)
+        if !str.end_with?("=") && str.length % 4 != 0
+          str = str.ljust((str.length + 3) & ~3, "=")
+          str.tr!("-_", "+/")
+        else
+          str = str.tr("-_", "+/")
+        end
+        strict_decode64(str)
       end
-      strict_decode64(str)
     end
   end
 end

data/lib/http/2/client.rb

@@ -64,7 +64,7 @@ module HTTP2
       @state = :connected
       emit(:frame, CONNECTION_PREFACE_MAGIC)
 
-      payload = @local_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
+      payload = @local_settings.connection_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
       settings(payload)
     end
 

data/lib/http/2/connection.rb

@@ -10,28 +10,6 @@ module HTTP2
   # Default stream_limit
   DEFAULT_MAX_CONCURRENT_STREAMS = 100
 
-  # Default values for SETTINGS frame, as defined by the spec.
-  SPEC_DEFAULT_CONNECTION_SETTINGS = {
-    settings_header_table_size: 4096,
-    settings_enable_push: 1, # enabled for servers
-    settings_max_concurrent_streams: Framer::MAX_STREAM_ID, # unlimited
-    settings_initial_window_size: 65_535,
-    settings_max_frame_size: 16_384,
-    settings_max_header_list_size: (2 << 30) - 1 # unlimited
-  }.freeze
-
-  DEFAULT_CONNECTION_SETTINGS = {
-    settings_header_table_size: 4096,
-    settings_enable_push: 1, # enabled for servers
-    settings_max_concurrent_streams: 100,
-    settings_initial_window_size: 65_535,
-    settings_max_frame_size: 16_384,
-    settings_max_header_list_size: (2 << 30) - 1 # unlimited
-  }.freeze
-
-  # Default stream priority (lower values are higher priority).
-  DEFAULT_WEIGHT = 16
-
   # Default connection "fast-fail" preamble string as defined by the spec.
   CONNECTION_PREFACE_MAGIC = "PRI * HTTP/2.0\r\n\r\nSM\r\n\r\n"
 
@@ -78,27 +56,26 @@ module HTTP2
     attr_accessor :active_stream_count
 
     # Initializes new connection object.
-    #
     def initialize(settings = {})
-      @local_settings  = DEFAULT_CONNECTION_SETTINGS.merge(settings)
-      @remote_settings = SPEC_DEFAULT_CONNECTION_SETTINGS.dup
+      @local_settings  = Settings.new(**settings)
+      @remote_settings = Settings.new(settings_max_concurrent_streams: Framer::MAX_STREAM_ID)
 
-      @compressor   = Header::Compressor.new(settings)
-      @decompressor = Header::Decompressor.new(settings)
+      @compressor   = Header::Compressor.new(@local_settings)
+      @decompressor = Header::Decompressor.new(@local_settings)
 
-      @active_stream_count = 0
-      @last_stream_id = 0
+      @active_stream_count =
+        @promised_stream_count =
+          @last_promised_stream_id =
+            @last_stream_id = 0
       @streams = {}
       @streams_recently_closed = {}
       @oldest_stream_recently_closed = nil
       @pending_settings = []
 
-      @framer = Framer.new(@local_settings[:settings_max_frame_size])
+      @framer = Framer.new(@local_settings.settings_max_frame_size)
 
-      @local_window_limit = @local_settings[:settings_initial_window_size]
-      @local_window = @local_window_limit
-      @remote_window_limit = @remote_settings[:settings_initial_window_size]
-      @remote_window = @remote_window_limit
+      @local_window = @local_window_limit = @local_settings.settings_initial_window_size
+      @remote_window = @remote_window_limit = @remote_settings.settings_initial_window_size
 
       @recv_buffer = "".b
       @continuation = []
@@ -137,7 +114,7 @@ module HTTP2
 
       stream = activate_stream(
         id: @stream_id,
-        max_concurrent_streams: @remote_settings[:settings_max_concurrent_streams],
+        max_concurrent_streams: @remote_settings.settings_max_concurrent_streams,
         **args
       )
       @last_stream_id = stream.id
@@ -213,7 +190,7 @@ module HTTP2
         elsif read_str(@recv_buffer, 24) == CONNECTION_PREFACE_MAGIC
           # MAGIC is OK.  Send our settings
           @state = :waiting_connection_preface
-          payload = @local_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
+          payload = @local_settings.connection_settings.reject { |k, v| v == SPEC_DEFAULT_CONNECTION_SETTINGS[k] }
           settings(payload)
         else
           raise HandshakeError
@@ -254,7 +231,7 @@ module HTTP2
             # prevent HTTP/2 CONTINUATION FLOOD
             # same heuristic as the one from HAProxy: https://www.haproxy.com/blog/haproxy-is-resilient-to-the-http-2-continuation-flood
             # different mitigation (connection closed, instead of 400 response)
-            unless @continuation_size < @local_settings[:settings_max_frame_size]
+            unless @continuation_size < @local_settings.settings_max_frame_size
               connection_error(:protocol_error,
                                msg: "too many continuations received")
             end
@@ -311,20 +288,25 @@ module HTTP2
             # Skip only this frame: later ones may serve completing streams.
             next if closed? && (stream_id > @last_stream_id || !@streams.key?(stream_id))
 
-            stream = @streams[stream_id]
-            if stream.nil?
+            unless (stream = @streams[stream_id])
               verify_pseudo_headers(frame)
 
               verify_stream_order(stream_id)
-              stream = activate_stream(
-                id: stream_id,
-                weight: frame[:weight] || DEFAULT_WEIGHT,
-                dependency: frame[:dependency] || 0,
-                exclusive: frame[:exclusive] || false
-              )
-              emit(:stream, stream)
+
+              # TODO: remove EMPTY_HASH after dropping support for ruby < 3.4 (recent rubies can
+              # receive nil as kwarg splat)
+              priority = EMPTY_HASH
+              if frame[:flags].anybits?(PRIORITY)
+                connection_error(:protocol_error, msg: "stream can't depend on itself") if stream_id == frame[:dependency]
+
+                priority = frame.slice(:weight, :dependency, :exclusive)
+              end
+
+              stream = activate_stream(id: stream_id, **priority)
             end
 
+            # streams are only emitted in a non-idle state.
+            emit(:stream, stream)
             stream << frame
 
           when :push_promise
@@ -352,6 +334,8 @@ module HTTP2
             parent = @streams[stream_id]
             pid = frame[:promise_stream]
 
+            validate_push_promise(pid)
+
             # if PUSH parent is recently closed, RST_STREAM the push
             if @streams_recently_closed[stream_id]
               send(type: :rst_stream, stream: pid, error: :refused_stream)
@@ -377,6 +361,12 @@ module HTTP2
 
             _verify_pseudo_headers(frame, REQUEST_MANDATORY_HEADERS)
             verify_stream_order(pid)
+
+            if @promised_stream_count >= @local_settings.settings_max_concurrent_streams
+              send(type: :rst_stream, stream: pid, error: :refused_stream)
+              next
+            end
+
             stream = activate_stream(id: pid, parent: parent)
             emit(:promise, stream)
             stream << frame
@@ -391,7 +381,7 @@ module HTTP2
               case frame_type
               # Priority signaling is deprecated (RFC 9113 Section 5.3.2), but
               # a PRIORITY frame may still name a stream id not opened yet:
-              # activate it, so the priority sticks if the stream opens.
+              # retain its priority without creating a stream until it opens.
               when :priority
                 # After a GOAWAY, a PRIORITY for a stream already used and
                 # closed must not resurrect it: reprioritizing a closed
@@ -399,16 +389,12 @@ module HTTP2
                 # the draining connection open.
                 next if closed? && stream_id <= @last_stream_id
 
-                stream = activate_stream(
-                  id: stream_id,
-                  weight: frame[:weight] || DEFAULT_WEIGHT,
-                  dependency: frame[:dependency] || 0,
-                  exclusive: frame[:exclusive] || false
-                )
+                connection_error(:protocol_error, msg: "stream can't depend on itself") if frame[:stream] == frame[:dependency]
 
-                emit(:stream, stream)
-                stream << frame
+                priority = frame.slice(:weight, :dependency, :exclusive)
 
+                stream = activate_stream(id: stream_id, **priority)
+                stream << frame
               # WINDOW_UPDATE can be sent by a peer that has sent a frame
               # bearing the END_STREAM flag. This means that a receiver could
               # receive a WINDOW_UPDATE frame on a "half-closed (remote)" or
@@ -577,6 +563,16 @@ module HTTP2
       end
     end
 
+    def validate_push_promise(stream_id)
+      connection_error(:protocol_error, msg: "clients cannot send PUSH_PROMISE") if @remote_role == :client
+      connection_error(:protocol_error, msg: "push promises are disabled") if @local_settings.settings_enable_push.zero?
+      unless stream_id.positive? && stream_id.even? && stream_id > @last_promised_stream_id
+        connection_error(:protocol_error, msg: "invalid promised stream ID")
+      end
+
+      @last_promised_stream_id = stream_id
+    end
+
     # Validate settings parameters.  See sepc Section 6.5.2.
     #
     # @param role [Symbol] The sender's role: :client or :server
@@ -687,12 +683,15 @@ module HTTP2
           end
 
         when :settings_header_table_size
-          # Setting header table size might cause some headers evicted
+          # The value is the maximum table size for the encoder of the other
+          # side: our setting limits the peer's encoder (our decompressor),
+          # and the peer's setting limits our encoder (our compressor).
+          # The table itself changes with the next dynamic table size update.
           case side
           when :local
-            @compressor.table_size = v
+            @decompressor.max_table_size = v
           when :remote
-            @decompressor.table_size = v
+            @compressor.max_table_size = v
           end
 
         when :settings_enable_push
@@ -701,6 +700,13 @@ module HTTP2
         when :settings_max_frame_size
           @framer.remote_max_frame_size = v
 
+        when :settings_max_header_list_size
+          case side
+          when :remote
+            @decompressor.max_header_list_size = v
+            # when :local
+            # not enforcing this on the client side
+          end
           # else # ignore unknown settings
         end
       end
@@ -752,7 +758,7 @@ module HTTP2
       #: @type var payload: String
       headers_frame[:payload] = payload
 
-      max_frame_size = @remote_settings[:settings_max_frame_size]
+      max_frame_size = @remote_settings.settings_max_frame_size
 
       # if single frame, return immediately
       if payload.bytesize <= max_frame_size
@@ -796,7 +802,7 @@ module HTTP2
     # @param priority [Integer]
     # @param window [Integer]
     # @param parent [Stream]
-    def activate_stream(id:, max_concurrent_streams: @local_settings[:settings_max_concurrent_streams], **args)
+    def activate_stream(id:, max_concurrent_streams: @local_settings.settings_max_concurrent_streams, **args)
       connection_error(msg: "Stream ID already exists") if @streams.key?(id)
 
       # SETTINGS_MAX_CONCURRENT_STREAMS limits the number of concurrent streams that the sender
@@ -805,9 +811,11 @@ module HTTP2
       raise StreamLimitExceeded if @active_stream_count >= max_concurrent_streams
 
       stream = Stream.new(connection: self, id: id, **args)
+      @promised_stream_count += 1 if stream.parent
 
       stream.once(:close) do
         @streams.delete(id)
+        @promised_stream_count -= 1 if stream.parent
 
         # A graceful GOAWAY leaves the connection :closing until the
         # tracked streams complete (Section 6.8); the last one to close
@@ -835,6 +843,8 @@ module HTTP2
             true
           end
           @oldest_stream_recently_closed = new_oldest
+        else
+          @oldest_stream_recently_closed ||= now
         end
 
         @streams_recently_closed[id] = now

data/lib/http/2/framer.rb

@@ -130,10 +130,10 @@ module HTTP2
 
       stream_id = frame.fetch(:stream, 0)
 
-      raise CompressionError, "Stream ID (#{stream_id}) is too large" if stream_id > MAX_STREAM_ID
+      raise CompressionError, "Stream ID (#{stream_id}) is outside the valid range" unless stream_id.between?(0, MAX_STREAM_ID)
 
-      if type == :window_update && frame[:increment] > MAX_WINDOWINC
-        raise CompressionError, "Window increment (#{frame[:increment]}) is too large"
+      if type == :window_update && !frame[:increment].between?(1, MAX_WINDOWINC)
+        raise CompressionError, "Window increment (#{frame[:increment]}) is outside the valid range"
       end
 
       flags = frame[:flags]

data/lib/http/2/header/compressor.rb

@@ -7,18 +7,18 @@ module HTTP2
       include PackingExtensions
       include BufferUtils
 
-      # @param options [Hash] encoding options
-      def initialize(options = {})
-        @cc = EncodingContext.new(options)
+      def initialize(settings = Settings.new)
+        @cc = EncodingContext.new(settings)
       end
 
-      # Set dynamic table size in EncodingContext
-      # @param size [Integer] new dynamic table size
-      def table_size=(size)
-        @cc.table_size = size
+      # Set the maximum dynamic table +size+ allowed by the peer's
+      # SETTINGS_HEADER_TABLE_SIZE. The next header block starts with a
+      # dynamic table size update when the table size has to change.
+      def max_table_size=(size)
+        @cc.max_table_size = size
       end
 
-      # Encodes provided value via integer representation.
+      # Encodes +i+ via integer representation into +buffer+ at the offset set by +offset+.
       # - http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-10#section-5.1
       #
       #  If I < 2^N - 1, encode I on N bits
@@ -30,11 +30,6 @@ module HTTP2
       #           I = I / 128
       #      encode (I) on 8 bits
       #
-      # @param i [Integer] value to encode
-      # @param n [Integer] number of available bits
-      # @param buffer [String] buffer to pack bytes into
-      # @param offset [Integer] offset to insert packed bytes in buffer
-      # @return [String] binary string
       def integer(i, n, buffer:, offset: buffer.size)
         limit = (1 << n) - 1
         return pack([i], "C", buffer: buffer, offset: offset) if i < limit
@@ -65,16 +60,8 @@ module HTTP2
       # * If the bit 7 of the first byte is 0, the string value is
       #   represented as a list of UTF-8 encoded octets.
       #
-      # +@options [:huffman]+ controls whether to use Huffman encoding:
-      #  :never   Do not use Huffman encoding
-      #  :always  Always use Huffman encoding
-      #  :shorter Use Huffman when the result is strictly shorter
-      #
-      # @param str [String]
-      # @param buffer [String]
-      # @return [String] binary string
       def string(str, buffer = "".b)
-        case @cc.options[:huffman]
+        case @cc.settings.huffman
         when :always
           huffman_string(str, buffer)
         when :never
@@ -93,11 +80,7 @@ module HTTP2
         end
       end
 
-      # Encodes header command with appropriate header representation.
-      #
-      # @param h [Hash] header command
-      # @param buffer [String]
-      # @return [Buffer]
+      # Encodes +h+ header command with appropriate header representation into +buffer+.
       def header(h, buffer = "".b)
         type = h[:type]
         rep = HEADREP[type]
@@ -128,9 +111,6 @@ module HTTP2
       end
 
       # Encodes provided list of HTTP headers.
-      #
-      # @param headers [Array] +[[name, value], ...]+
-      # @return [Buffer]
       def encode(headers)
         buffer = "".b
         headers.partition { |f, _| f.start_with? ":" }.each do |hs|
@@ -144,9 +124,7 @@ module HTTP2
 
       private
 
-      # @param str [String]
-      # @param buffer [String]
-      # @return [String] binary string
+      # encodes +str+ into +buffer+ using Huffman encoding.
       def huffman_string(str, buffer = "".b)
         huffman_offset = buffer.bytesize
         buffer << "\x00".b
@@ -162,18 +140,14 @@ module HTTP2
         buffer
       end
 
-      # @param str [String]
-      # @param buffer [String]
-      # @return [String] binary string
+      # encodes +str+ into +buffer+.
       def plain_string(str, plain = "".b)
         integer(str.bytesize, 7, buffer: plain)
         append_str(plain, str)
         plain
       end
 
-      # @param buffer [String]
-      # @param huffman_offset [Integer] buffer offset where huffman string was introduced
-      # @return [String] binary string
+      # encodes the huffman string size from +buffer+ into the string at the offset indicated by +huffman_offset+
       def set_huffman_size(buffer, huffman_offset)
         integer(buffer.bytesize - huffman_offset, 7, buffer: buffer, offset: huffman_offset)
         buffer.setbyte(huffman_offset, buffer.getbyte(huffman_offset) | 0x80)

data/lib/http/2/header/decompressor.rb

@@ -5,32 +5,32 @@ module HTTP2
     # Responsible for decoding received headers and maintaining compression
     # context of the opposing peer. Decompressor must be initialized with
     # appropriate starting context based on local role: client or server.
-    #
-    # @example
-    #   server_role = Decompressor.new(:request)
-    #   client_role = Decompressor.new(:response)
     class Decompressor
       include Error
       include BufferUtils
 
       FORBIDDEN_HEADERS = %w[connection te].freeze
 
-      # @param options [Hash] decoding options.  Only :table_size is effective.
-      def initialize(options = {})
-        @cc = EncodingContext.new(options)
+      attr_writer :max_header_list_size
+
+      def initialize(settings = Settings.new)
+        @cc = EncodingContext.new(settings)
+        @max_header_list_size = settings.settings_max_header_list_size
+        @accept_invalid_headers = false
       end
 
-      # Set dynamic table size in EncodingContext
-      # @param size [Integer] new dynamic table size
-      def table_size=(size)
-        @cc.table_size = size
+      def accept_invalid_headers!
+        @accept_invalid_headers = true
       end
 
-      # Decodes integer value from provided buffer.
-      #
-      # @param buf [String]
-      # @param n [Integer] number of available bits
-      # @return [Integer]
+      # Set the maximum dynamic table +size+ allowed by our acknowledged
+      # SETTINGS_HEADER_TABLE_SIZE. When the current table is larger, the
+      # next header block has to start with a dynamic table size update.
+      def max_table_size=(size)
+        @cc.max_table_size = size
+      end
+
+      # Decodes integer value from provided +buffer+.
       def integer(buf, n)
         limit = (1 << n) - 1
         if n.zero?
@@ -55,11 +55,9 @@ module HTTP2
         i
       end
 
-      # Decodes string value from provided buffer.
+      # Decodes string value from provided +buf+.
       #
-      # @param buf [String]
-      # @return [String] UTF-8 encoded string
-      # @raise [CompressionError] when input is malformed
+      # raises CompressionError when input is malformed
       def string(buf)
         raise CompressionError, "invalid header block fragment" if buf.empty?
 
@@ -72,10 +70,7 @@ module HTTP2
         str.force_encoding(Encoding::UTF_8)
       end
 
-      # Decodes header command from provided buffer.
-      #
-      # @param buf [Buffer]
-      # @return [Hash] command
+      # Decodes header command from provided +buf+.
       def header(buf)
         peek = buf.getbyte(0)
 
@@ -109,13 +104,10 @@ module HTTP2
         end
       end
 
-      # Decodes and processes header commands within provided buffer.
-      #
-      # @param buf [Buffer]
-      # @param frame [HTTP2::Frame, nil]
-      # @return [Array] +[[name, value], ...]
+      # Decodes and processes header commands within provided +buf+.
       def decode(buf, frame = nil)
-        list = []
+        list = [] #: Array[header_pair]
+        header_list_size = 0
         decoding_pseudo_headers = true
         @cc.listen_on_table do
           until buf.empty?
@@ -123,12 +115,17 @@ module HTTP2
             next if field.nil?
 
             is_pseudo_header = field.start_with?(":")
-            if !decoding_pseudo_headers && is_pseudo_header
+            if !decoding_pseudo_headers && is_pseudo_header && !@accept_invalid_headers
               raise ProtocolError, "one or more pseudo headers encountered after regular headers"
             end
 
             decoding_pseudo_headers = is_pseudo_header
-            raise ProtocolError, "invalid header received: #{field}" if FORBIDDEN_HEADERS.include?(field)
+            if !@accept_invalid_headers && FORBIDDEN_HEADERS.include?(field)
+              raise ProtocolError, "invalid header received: #{field}"
+            end
+
+            header_list_size += field.bytesize + value.bytesize + 32
+            raise ProtocolError, "header list exceeds configured maximum" if header_list_size > @max_header_list_size
 
             if frame
               case field