http-2 1.2.2 → 1.3.0

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

@@ -86,12 +86,6 @@ module HTTP2
 
       STATIC_TABLE_SIZE = STATIC_TABLE.size
 
-      DEFAULT_OPTIONS = {
-        huffman: :shorter,
-        index: :all,
-        table_size: 4096
-      }.freeze
-
       STATIC_ALL = %i[all static].freeze
 
       STATIC_NEVER = %i[never static].freeze
@@ -99,60 +93,59 @@ module HTTP2
       # Current table of header key-value pairs.
       attr_reader :table
 
-      # Current encoding options
-      #
-      #   :table_size  Integer  maximum dynamic table size in bytes
-      #   :huffman     Symbol   :always, :never, :shorter
-      #   :index       Symbol   :all, :static, :never
-      attr_reader :options
+      # Current encoding settings
+      attr_reader :settings
 
       # Current table size in octets
       attr_reader :current_table_size
 
       # Initializes compression context with appropriate client/server
-      # defaults and maximum size of the dynamic table.
+      # +settings+ and maximum size of the dynamic table.
       #
-      # @param options [Hash] encoding options
-      #   :table_size  Integer  maximum dynamic table size in bytes
-      #   :huffman     Symbol   :always, :never, :shorter
-      #   :index       Symbol   :all, :static, :never
-      def initialize(options = {})
+      # The dynamic table starts at +settings.table_size+ octets. The same
+      # value is the initial maximum size allowed for the table.
+      def initialize(settings = Settings.new)
         @table = []
         @table_by_field = Hash.new { |hs, k| hs[k] = [] }
         @unshifts = 0
-        @options = DEFAULT_OPTIONS.merge(options)
-        @limit = @options[:table_size]
-        @_table_updated = false
+        @settings = settings
+        # Current dynamic table size, as known to both encoder and decoder.
+        @limit = settings.table_size
+        # Maximum dynamic table size allowed by SETTINGS_HEADER_TABLE_SIZE.
+        @max_size_limit =
+          # Smallest maximum size set since the last dynamic table size update.
+          @lowest_max_size_limit = MAX_HEADER_TABLE_SIZE
+        @_table_updated = @_max_table_size_updated = false
         @current_table_size = 0
       end
 
       # Duplicates current compression context
-      # @return [EncodingContext]
       def dup
-        other = EncodingContext.new(@options)
+        other = EncodingContext.new(@settings)
         t = @table
         tbf = @table_by_field.transform_values(&:dup)
         unshifts = @unshifts
         l = @limit
+        ml = @max_size_limit
+        lml = @lowest_max_size_limit
         other.instance_eval do
           @table = t.dup # shallow copy
           @table_by_field = tbf
           @unshifts = unshifts
           @limit = l
+          @max_size_limit = ml
+          @lowest_max_size_limit = lml
         end
         other
       end
 
-      # Finds an entry in current dynamic table by index.
-      # Note that index is zero-based in this module.
+      # Finds an entry in current dynamic table by +index+.
+      # Note that +index+ is zero-based in this module.
       #
-      # If the index is greater than the last index in the static table,
+      # If the +index+ is greater than the last index in the static table,
       # an entry in the dynamic table is dereferenced.
       #
-      # If the index is greater than the last header index, an error is raised.
-      #
-      # @param index [Integer] zero-based index in the dynamic table.
-      # @return [Array] +[key, value]+
+      # If the +index+ is greater than the last header index, an error is raised.
       def dereference(index)
         # NOTE: index is zero-based in this module.
         return STATIC_TABLE[index] if index < STATIC_TABLE_SIZE
@@ -166,12 +159,16 @@ module HTTP2
 
       # Header Block Processing
       # - http://tools.ietf.org/html/draft-ietf-httpbis-header-compression-10#section-4.1
-      #
-      # @param cmd [Hash] { type:, name:, value:, index: }
-      # @return [Array, nil] +[name, value]+ header field that is added to the decoded header list,
-      #                                      or nil if +cmd[:type]+ is +:changetablesize+
       def process(cmd)
         type = cmd[:type]
+
+        # The maximum size was reduced below the current table size and the
+        # encoder has not signalled a size that fits into it.
+        if type != :changetablesize && @lowest_max_size_limit < @limit
+          raise CompressionError,
+                "dynamic table size update required"
+        end
+
         name = cmd[:name]
         value = cmd[:value]
 
@@ -179,12 +176,13 @@ module HTTP2
         when :changetablesize
           raise CompressionError, "tried to change table size after adding elements to table" if @_table_updated
 
-          # we can receive multiple table size change commands inside a header frame. However,
-          # we should blow up if we receive another frame where the new table size is bigger.
-          table_size_updated = @limit != @options[:table_size]
-
-          raise CompressionError, "dynamic table size update exceed limit" if !table_size_updated && value > @limit
+          # The new maximum size MUST be lower than or equal to the limit set
+          # by SETTINGS_HEADER_TABLE_SIZE.
+          # - https://www.rfc-editor.org/rfc/rfc7541#section-6.3
+          raise CompressionError, "dynamic table size update exceed limit" if value > @max_size_limit
 
+          # The smallest maximum size set since the last update is signalled.
+          @lowest_max_size_limit = @max_size_limit if value <= @lowest_max_size_limit
           self.table_size = value
 
           nil
@@ -217,11 +215,12 @@ module HTTP2
           emit = [name, value]
 
           # add to table
-          if type == :incremental && size_check?(name.bytesize + value.bytesize + 32)
+          cmdsize = name.bytesize + value.bytesize + 32
+          if type == :incremental && size_check?(cmdsize)
             @table.unshift(emit)
             @unshifts += 1
             @table_by_field[name].unshift([value, @unshifts])
-            @current_table_size += name.bytesize + value.bytesize + 32
+            @current_table_size += cmdsize
             @_table_updated = true
           end
 
@@ -231,16 +230,18 @@ module HTTP2
         end
       end
 
-      # Plan header compression according to +@options [:index]+
-      #  :never   Do not use dynamic table or static table reference at all.
-      #  :static  Use static table only.
-      #  :all     Use all of them.
+      # Plan +headers+ compression.
       #
-      # @param headers [Array] +[[name, value], ...]+
-      # @return [Array] array of commands
-      def encode(headers)
+      # Emits dynamic table size updates first when the table size has to
+      # change. See #max_table_size=.
+      def encode(headers, &block)
         # Literals commands are marked with :noindex when index is not used
-        noindex = STATIC_NEVER.include?(@options[:index])
+        noindex = STATIC_NEVER.include?(@settings.index)
+
+        if @_max_table_size_updated
+          encode_change_table_size(&block)
+          @_max_table_size_updated = false
+        end
 
         headers.each do |field, value|
           # Literal header names MUST be translated to lowercase before
@@ -254,26 +255,17 @@ module HTTP2
         end
       end
 
-      # Emits command for a header.
+      # Emits command for a +field+/+value+ header.
       # Prefer static table over dynamic table.
       # Prefer exact match over name-only match.
       #
-      # +@options [:index]+ controls whether to use the dynamic table,
-      # static table, or both.
-      #  :never   Do not use dynamic table or static table reference at all.
-      #  :static  Use static table only.
-      #  :all     Use all of them.
-      #
-      # @param field [String] the header field
-      # @param value [String] the header value
-      # @return [Hash] command
       def addcmd(field, value)
         # @type var exact: Integer?
         exact = nil
         # @type var name_only: Integer?
         name_only = nil
 
-        index_type = @options[:index]
+        index_type = @settings.index
 
         if STATIC_ALL.include?(index_type) &&
            STATIC_TABLE_BY_FIELD.key?(field)
@@ -313,6 +305,26 @@ module HTTP2
         resize_table(0)
       end
 
+      # Set the maximum dynamic table +size+ allowed by
+      # SETTINGS_HEADER_TABLE_SIZE.
+      #
+      # The current table size does not change here. It changes only with a
+      # dynamic table size update at the beginning of a header block:
+      # - an encoder emits the update in the next #encode call. It uses
+      #   +settings.table_size+, capped by this maximum.
+      # - a decoder requires the update in the next header block when the
+      #   current table size exceeds this maximum.
+      #
+      # When the maximum is reduced and then increased again before the next
+      # header block, the smallest maximum has to be signalled first.
+      # - https://www.rfc-editor.org/rfc/rfc7541#section-4.2
+      def max_table_size=(size)
+        @max_size_limit = size
+        # alternative: clamp size based on @max_size_limit, instead of failing later on #process
+        @lowest_max_size_limit = size if size < @lowest_max_size_limit
+        @_max_table_size_updated = true
+      end
+
       def listen_on_table
         yield
       ensure
@@ -321,6 +333,22 @@ module HTTP2
 
       private
 
+      def encode_change_table_size
+        if @lowest_max_size_limit < @limit
+          self.table_size = @lowest_max_size_limit
+          yield({ type: :changetablesize, value: @lowest_max_size_limit })
+        end
+        @lowest_max_size_limit = @max_size_limit
+
+        max_table_size = MAX_HEADER_TABLE_SIZE
+        max_table_size = @max_size_limit if @max_size_limit < max_table_size
+
+        return unless max_table_size != @limit
+
+        self.table_size = max_table_size
+        yield({ type: :changetablesize, value: max_table_size })
+      end
+
       def resize_table(cmdsize)
         return if @table.empty?
 
@@ -337,11 +365,10 @@ module HTTP2
         end
       end
 
+      # whether +cmd+ fits in the dynamic table.
+      #
       # To keep the dynamic table size lower than or equal to @limit,
       # remove one or more entries at the end of the dynamic table.
-      #
-      # @param cmdsize [Integer]
-      # @return [Boolean] whether +cmd+ fits in the dynamic table.
       def size_check?(cmdsize)
         resize_table(cmdsize)
         cmdsize <= @limit

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

@@ -22,12 +22,7 @@ module HTTP2
 
       EOS_PADDING = (0..7).map { |n| ("1" * n).b.freeze }.freeze
 
-      # Encodes provided value via huffman encoding.
-      # Length is not encoded in this method.
-      #
-      # @param str [String]
-      # @param buffer [String]
-      # @return [String] binary string
+      # Encodes provided +str+ via huffman encoding into +buffer+ .
       def encode(str, buffer = "".b)
         bitstring = String.new("", encoding: Encoding::BINARY, capacity: (str.bytesize * 30) + ((8 - str.size) % 8))
         str.each_byte { |chr| append_str(bitstring, ENCODE_TABLE[chr]) }
@@ -35,11 +30,9 @@ module HTTP2
         pack([bitstring], "B*", buffer: buffer)
       end
 
-      # Decodes provided Huffman coded string.
+      # Decodes provided Huffman coded string in +buf+.
       #
-      # @param buf [Buffer]
-      # @return [String] binary string
-      # @raise [CompressionError] when Huffman coded string is malformed
+      # raises CompressionError when Huffman coded string is malformed
       def decode(buf)
         emit = "".b
         state = 0 # start state

data/lib/http/2/server.rb

@@ -93,14 +93,11 @@ module HTTP2
         type: :headers,
         flags: END_HEADERS,
         stream: 1,
-        weight: DEFAULT_WEIGHT,
-        dependency: 0,
-        exclusive: false,
         payload: headers
-      }
+      } #: headers_frame
 
       if body.empty?
-        headers_frame[:flags] |= END_HEADERS
+        headers_frame[:flags] |= END_STREAM
         stream << headers_frame
       else
         stream << headers_frame

data/lib/http/2/settings.rb

@@ -1,39 +1,56 @@
 # frozen_string_literal: true
 
 module HTTP2
+  MAX_HEADER_LIST_SIZE = (2 << 30) - 1
+  MAX_HEADER_TABLE_SIZE = 4096
+
   # Default values for SETTINGS frame, as defined by the spec.
   SPEC_DEFAULT_CONNECTION_SETTINGS = {
-    settings_header_table_size: 4096,
+    settings_header_table_size: MAX_HEADER_TABLE_SIZE,
     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
+    settings_max_header_list_size: MAX_HEADER_LIST_SIZE # unlimited
   }.freeze
 
+  ENCODING_CONTEXT_SETTINGS = %i[huffman index table_size].freeze
+
   Settings = Struct.new(
+    # connection settings
     :settings_header_table_size,
     :settings_enable_push,
     :settings_max_concurrent_streams,
     :settings_initial_window_size,
     :settings_max_frame_size,
     :settings_max_header_list_size,
+    # encoding context settings
+    :huffman,
+    :index,
+    :table_size,
     keyword_init: true
   ) do
     def initialize(
-      settings_header_table_size: 4096,
+      # connection settings
+      settings_header_table_size: MAX_HEADER_TABLE_SIZE,
       settings_enable_push: 1,
       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
+      settings_max_header_list_size: MAX_HEADER_LIST_SIZE,
+      # encoding context settings
+      huffman: :shorter,
+      index: :all,
+      table_size: MAX_HEADER_TABLE_SIZE
     )
       super
     end
 
-    def each_setting
+    def connection_settings
+      return enum_for(__method__) unless block_given?
+
       each_pair do |k, v|
-        next if v == SPEC_DEFAULT_CONNECTION_SETTINGS[k]
+        next if ENCODING_CONTEXT_SETTINGS.include?(k)
 
         yield k, v
       end

data/lib/http/2/stream.rb

@@ -40,6 +40,9 @@ module HTTP2
     include Emitter
     include Error
 
+    # Default stream priority (lower values are higher priority).
+    DEFAULT_WEIGHT = 16
+
     STREAM_OPEN_STATES = %i[open half_closed_local half_closing closing].freeze
 
     # Stream ID (odd for client initiated streams, even otherwise).
@@ -75,9 +78,7 @@ module HTTP2
     # @param window [Integer]
     # @param parent [Stream]
     # @param state [Symbol]
-    def initialize(connection:, id:, weight: 16, dependency: 0, exclusive: false, parent: nil, state: :idle)
-      stream_error(:protocol_error, msg: "stream can't depend on itself") if id == dependency
-
+    def initialize(connection:, id:, weight: DEFAULT_WEIGHT, dependency: 0, exclusive: false, parent: nil, state: :idle)
       @connection = connection
       @id = id
       @weight = weight
@@ -88,9 +89,9 @@ module HTTP2
       @send_buffer = FrameBuffer.new
 
       process_priority(weight: weight, dependency: dependency, exclusive: exclusive)
-      @local_window_max_size = connection.local_settings[:settings_initial_window_size]
-      @local_window = connection.local_settings[:settings_initial_window_size]
-      @remote_window = connection.remote_settings[:settings_initial_window_size]
+      @local_window_max_size = connection.local_settings.settings_initial_window_size
+      @local_window = connection.local_settings.settings_initial_window_size
+      @remote_window = connection.remote_settings.settings_initial_window_size
       @parent = parent
       @state  = state
       @error  = false

data/lib/http/2/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module HTTP2
-  VERSION = "1.2.2"
+  VERSION = "1.3.0"
 end

data/lib/http/2.rb

@@ -4,6 +4,7 @@ require "http/2/version"
 
 module HTTP2
   EMPTY = [].freeze
+  EMPTY_HASH = {}.freeze
 end
 
 require "http/2/extensions"
@@ -13,6 +14,7 @@ require "http/2/emitter"
 require "http/2/flow_buffer"
 require "http/2/header"
 require "http/2/framer"
+require "http/2/settings"
 require "http/2/connection"
 require "http/2/client"
 require "http/2/server"

data/sig/2.rbs

@@ -8,34 +8,26 @@ module HTTP2
   DEFAULT_MAX_CONCURRENT_STREAMS: Integer
 
   EMPTY: []
+  EMPTY_HASH: {}
 
   type connection_opts = Hash[Symbol, untyped]
 
-  type settings_hash = {
-    settings_header_table_size: Integer,
-    settings_enable_push: Integer,
-    settings_max_concurrent_streams:  Integer,
-    settings_initial_window_size: Integer,
-    settings_max_frame_size: Integer,
-    settings_max_header_list_size: Integer
-  }
-
   type settings_ary = Array[settings_enum]
 
   type settings_enum = Enumerable[[Symbol, Integer]]
 
-  SPEC_DEFAULT_CONNECTION_SETTINGS: settings_hash
-
-  DEFAULT_CONNECTION_SETTINGS: settings_hash
-
-  DEFAULT_WEIGHT: Integer
-
   CONNECTION_PREFACE_MAGIC: String
 
   REQUEST_MANDATORY_HEADERS: Array[String]
 
   RESPONSE_MANDATORY_HEADERS: Array[String]
 
+  CONNECTION_FRAME_TYPES: Array[Symbol]
+
+  STREAM_OPEN_STATES: Array[Symbol]
+
+  HEADERS_FRAME_TYPES: Array[Symbol]
+
   # Frame flags
   END_STREAM: Integer
   ACK: Integer

data/sig/connection.rbs

@@ -4,16 +4,6 @@ module HTTP2
     include Emitter
     include BufferUtils
 
-    REQUEST_MANDATORY_HEADERS: Array[String]
-
-    RESPONSE_MANDATORY_HEADERS: Array[String]
-
-    CONNECTION_FRAME_TYPES: Array[Symbol]
-
-    HEADERS_FRAME_TYPES: Array[Symbol]
-
-    STREAM_OPEN_STATES: Array[Symbol]
-
     attr_reader state: Symbol
 
     attr_reader local_window: Integer
@@ -21,19 +11,21 @@ module HTTP2
 
     alias window local_window
 
-    attr_reader remote_settings: settings_hash
-    attr_reader local_settings: settings_hash
+    attr_reader remote_settings: Settings
+    attr_reader local_settings: Settings
     attr_reader pending_settings: settings_ary
 
     attr_accessor active_stream_count: Integer
 
     @stream_id: Integer
     @active_stream_count: Integer
+    @promised_stream_count: Integer
     @last_stream_id: Integer
 
     @streams: Hash[Integer, Stream]
     @streams_recently_closed: Hash[Integer, Numeric]
     @oldest_stream_recently_closed: Numeric
+    @last_promised_stream_id: Integer
 
     @framer: Framer
 
@@ -87,10 +79,12 @@ module HTTP2
 
     def connection_frame?: (frame) -> bool
 
-    def connection_management: (connection_frame frame) -> void
+    def connection_management: (frame frame) -> void
 
     def ping_management: (frame) -> void
 
+    def validate_push_promise: (Integer stream_id) -> void
+
     def validate_settings: (role_type, settings_enum) -> void
 
     def connection_settings: (settings_frame) -> void

data/sig/header/compressor.rbs

@@ -6,19 +6,19 @@ module HTTP2
 
       @cc: EncodingContext
 
-      def table_size=: (Integer) -> void
+      def max_table_size=: (Integer) -> void
 
       def integer: (Integer, Integer, buffer: String, ?offset: Integer) -> String
 
       def string: (String, ?String buffer) -> String
 
-      def header: (header_command, ?String) -> String
+      def header: (change_table_size_command | header_command, ?String) -> String
 
       def encode: (Enumerable[header_pair]) -> String
 
       private
 
-      def initialize: (?connection_opts options) -> void
+      def initialize: (?Settings settings) -> void
 
       def huffman_string: (String str, ?String buffer) -> String
 

data/sig/header/decompressor.rbs

@@ -7,19 +7,26 @@ module HTTP2
 
       @cc: EncodingContext
 
-      def table_size=: (Integer) -> void
+      @accept_invalid_headers: bool
+
+      attr_writer max_header_list_size: Integer
+
+      def max_table_size=: (Integer) -> void
 
       def integer: (String, Integer) -> Integer
 
       def string: (String) -> String
 
-      def header: (String) -> header_command
+      def header: (String) -> (change_table_size_command | header_command)
 
       def decode: (String, frame?) -> Array[header_pair]
                 | (String) -> Array[header_pair]
+
+      def accept_invalid_headers!: () -> void
+
       private
 
-      def initialize: (?connection_opts options) -> void
+      def initialize: (?Settings settings) -> void
     end
   end
 end

data/sig/header/encoding_context.rbs

@@ -11,14 +11,12 @@ module HTTP2
 
       STATIC_NEVER: Array[Symbol]
 
-      DEFAULT_OPTIONS: context_hash
-
       UPPER: Regexp
 
 
       attr_reader table: Array[header_pair]
 
-      attr_reader options: context_hash
+      attr_reader settings: Settings
 
       attr_reader current_table_size: Integer
 
@@ -28,25 +26,35 @@ module HTTP2
 
       @limit: Integer
 
+      @max_size_limit: Integer
+
+      @lowest_max_size_limit: Integer
+
       @_table_updated: bool
 
+      @_max_table_size_updated: bool
+
       def dup: () -> EncodingContext
 
       def dereference: (Integer) -> header_pair
 
-      def process: (header_command cmd) -> header_pair?
+      def process: (change_table_size_command | header_command cmd) -> header_pair?
 
-      def encode: (_Each[header_pair]) { (header_command) -> void } -> void
+      def encode: (_Each[header_pair]) { (change_table_size_command | header_command) -> void } -> void
 
       def addcmd: (String name, String value) -> header_command
 
       def table_size=: (Integer) -> void
 
+      def max_table_size=: (Integer) -> void
+
       def listen_on_table: { () -> void } -> void
 
       private
 
-      def initialize: (?connection_opts options) -> void
+      def initialize: (?Settings settings) -> void
+
+      def encode_change_table_size: () { (change_table_size_command) -> void } -> void
 
       def add_to_table: (string name, string value) -> void
 

data/sig/header.rbs

@@ -11,9 +11,10 @@ module HTTP2
 
     type header_type = :indexed | :incremental | :noindex | :neverindexed | :changetablesize
 
+    type change_table_size_command = { type: :changetablesize, ?name: Integer, value: Integer }
+
     type header_command = { type: :indexed , name: Integer } |
-                          { type: (:incremental | :noindex | :neverindexed), name: Integer | String, value: String } |
-                          { type: :changetablesize, ?name: Integer, value: Integer }
+                          { type: (:incremental | :noindex | :neverindexed), name: Integer | String, value: String }
 
     HEADREP: Hash[header_type, { prefix: Integer, pattern: Integer }]
 

data/sig/server.rbs

@@ -1,5 +1,7 @@
 module HTTP2
   class Server < Connection
+    @origin_set: Array[String]
+    @origins_sent: bool
 
     def upgrade: (String settings, Enumerable[header_pair] headers, String body) -> void