biryani 0.0.1

data/lib/biryani/hpack/dynamic_table.rb

@@ -0,0 +1,65 @@
+module Biryani
+  module HPACK
+    class DynamicTable
+      attr_reader :size, :limit
+
+      # @param limit [Integer]
+      def initialize(limit)
+        @table = []
+        @size = 0
+        @limit = limit
+      end
+
+      # @return [Integer]
+      def count_entries
+        @table.length
+      end
+
+      # @param name [String]
+      # @param value [String]
+      def store(name, value)
+        @table.unshift([name, value])
+        @size += name.bytesize + value.bytesize + 32
+        chomp!(@limit)
+      end
+
+      # @param name [String]
+      # @param value [String]
+      #
+      # @return [Array]
+      # @return [Integer]
+      def find_field(name, value)
+        @table.each_with_index.find { |nv, _| nv[0] == name && nv[1] == value }
+      end
+
+      # @param name [String]
+      #
+      # @return [Array]
+      # @return [Integer]
+      def find_name(name)
+        @table.each_with_index.find { |nv, _| nv[0] == name }
+      end
+
+      # @param name [Integer]
+      #
+      # @return [Array, nil]
+      def [](index)
+        @table[index]
+      end
+
+      # @param new_limit [Integer]
+      def chomp!(new_limit)
+        while @size > new_limit
+          n, v = @table.pop
+          @size -= n.bytesize + v.bytesize + 32
+        end
+      end
+
+      # @param new_limit [Integer]
+      def limit!(new_limit)
+        chomp!(new_limit)
+        @limit = new_limit
+      end
+    end
+  end
+end

data/lib/biryani/hpack/encoder.rb

@@ -0,0 +1,22 @@
+module Biryani
+  module HPACK
+    class Encoder
+      # @param dynamic_table_limit [Integer]
+      def initialize(dynamic_table_limit)
+        @dynamic_table = DynamicTable.new(dynamic_table_limit)
+      end
+
+      # @param fields [Array]
+      #
+      # @return [String]
+      def encode(fields)
+        Fields.encode(fields, @dynamic_table).force_encoding(Encoding::ASCII_8BIT)
+      end
+
+      # @param new_limit [Integer]
+      def limit!(new_limit)
+        @dynamic_table.limit!(new_limit)
+      end
+    end
+  end
+end

data/lib/biryani/hpack/error.rb

@@ -0,0 +1,12 @@
+module Biryani
+  module HPACK
+    module Error
+      # Generic error, common for all classes under Biryani::HPACK::Error module.
+      class Error < StandardError; end
+
+      class HuffmanDecodeError < Error; end
+
+      class HPACKDecodeError < Error; end
+    end
+  end
+end

data/lib/biryani/hpack/field.rb

@@ -0,0 +1,357 @@
+module Biryani
+  module HPACK
+    # rubocop: disable Metrics/ModuleLength
+    module Field
+      # @param name [String]
+      # @param value [String]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [String]
+      def self.encode(name, value, dynamic_table)
+        case find(name, value, dynamic_table)
+        in Some(index, v) if v.nil?
+          res = encode_indexed(index)
+        in Some(index, v)
+          res = encode_literal_value(index, v)
+          dynamic_table.store(name, v)
+        in None
+          res = encode_literal_field(name, value)
+          dynamic_table.store(name, value)
+        end
+
+        res
+      end
+
+      # @param name [String]
+      # @param value [String]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [Some, None]
+      # rubocop: disable Metrics/CyclomaticComplexity
+      def self.find(name, value, dynamic_table)
+        found, i = STATIC_TABLE.each_with_index.find { |nv, _| nv[0] == name && nv[1] == value }
+        return Some.new(i + 1, nil) unless found.nil?
+
+        found, i = dynamic_table.find_field(name, value)
+        return Some.new(i + 1 + STATIC_TABLE_SIZE, nil) unless found.nil?
+
+        found, i = STATIC_TABLE.each_with_index.find { |nv, _| nv[0] == name }
+        return Some.new(i + 1, value) unless found.nil?
+
+        found, i = dynamic_table.find_name(name)
+        return Some.new(i + 1 + STATIC_TABLE_SIZE, value) unless found.nil?
+
+        None.new
+      end
+      # rubocop: enable Metrics/CyclomaticComplexity
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 1 |        Index (7+)         |
+      # +---+---------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.1
+      #
+      # @param index [Integer]
+      #
+      # @return [String]
+      def self.encode_indexed(index)
+        Integer.encode(index, 7, 0b10000000)
+      end
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 0 | 1 |      Index (6+)       |
+      # +---+---+-----------------------+
+      # | H |     Value Length (7+)     |
+      # +---+---------------------------+
+      # | Value String (Length octets)  |
+      # +-------------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.2.1
+      #
+      # @param index [Integer]
+      # @param value [String]
+      #
+      # @return [String]
+      def self.encode_literal_value(index, value)
+        Integer.encode(index, 6, 0b01000000) + String.encode(value)
+      end
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 0 | 1 |           0           |
+      # +---+---+-----------------------+
+      # | H |     Name Length (7+)      |
+      # +---+---------------------------+
+      # |  Name String (Length octets)  |
+      # +---+---------------------------+
+      # | H |     Value Length (7+)     |
+      # +---+---------------------------+
+      # | Value String (Length octets)  |
+      # +-------------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.2.1
+      #
+      # @param name [String]
+      # @param value [String]
+      #
+      # @return [String]
+      def self.encode_literal_field(name, value)
+        "\x40#{String.encode(name)}#{String.encode(value)}"
+      end
+
+      # @param s [String]
+      # @param cursor [Integer]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [Array]
+      # @return [Integer]
+      # rubocop: disable Metrics/CyclomaticComplexity
+      # rubocop: disable Metrics/PerceivedComplexity
+      def self.decode(s, cursor, dynamic_table)
+        byte = s.getbyte(cursor)
+        if (byte & 0b10000000).positive?
+          decode_indexed(s, cursor, dynamic_table)
+        elsif byte == 0b01000000
+          decode_literal_field_incremental_indexing(s, cursor, dynamic_table)
+        elsif (byte & 0b01000000).positive?
+          decode_literal_value_incremental_indexing(s, cursor, dynamic_table)
+        elsif (byte & 0b00100000).positive?
+          decode_dynamic_table_size_update(s, cursor, dynamic_table)
+        elsif byte == 0b00010000
+          decode_literal_field_never_indexed(s, cursor)
+        elsif (byte & 0b00010000).positive?
+          decode_literal_value_never_indexed(s, cursor, dynamic_table)
+        elsif byte.zero?
+          decode_literal_field_without_indexing(s, cursor)
+        elsif (byte & 0b11110000).zero?
+          decode_literal_value_without_indexing(s, cursor, dynamic_table)
+        else
+          raise 'unreachable'
+        end
+      end
+      # rubocop: enable Metrics/CyclomaticComplexity
+      # rubocop: enable Metrics/PerceivedComplexity
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 1 |        Index (7+)         |
+      # +---+---------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.1
+      #
+      # @param s [String]
+      # @param cursor [Integer]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [Array]
+      # @return [Integer]
+      def self.decode_indexed(s, cursor, dynamic_table)
+        index, c = Integer.decode(s, 7, cursor)
+        raise Error::HPACKDecodeError if index.zero?
+        raise Error::HPACKDecodeError if index > STATIC_TABLE_SIZE + dynamic_table.count_entries
+
+        field = if index <= STATIC_TABLE_SIZE
+                  STATIC_TABLE[index - 1]
+                else
+                  dynamic_table[index - 1 - STATIC_TABLE_SIZE]
+                end
+
+        [field, c]
+      end
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 0 | 1 |           0           |
+      # +---+---+-----------------------+
+      # | H |     Name Length (7+)      |
+      # +---+---------------------------+
+      # |  Name String (Length octets)  |
+      # +---+---------------------------+
+      # | H |     Value Length (7+)     |
+      # +---+---------------------------+
+      # | Value String (Length octets)  |
+      # +-------------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.2.1
+      #
+      # @param s [String]
+      # @param cursor [Integer]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [Array]
+      # @return [Integer]
+      def self.decode_literal_field_incremental_indexing(s, cursor, dynamic_table)
+        name, c = String.decode(s, cursor + 1)
+        value, c = String.decode(s, c)
+        dynamic_table.store(name, value)
+
+        [[name, value], c]
+      end
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 0 | 1 |      Index (6+)       |
+      # +---+---+-----------------------+
+      # | H |     Value Length (7+)     |
+      # +---+---------------------------+
+      # | Value String (Length octets)  |
+      # +-------------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.2.1
+      #
+      # @param s [String]
+      # @param cursor [Integer]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [Array]
+      # @return [Integer]
+      def self.decode_literal_value_incremental_indexing(s, cursor, dynamic_table)
+        index, c = Integer.decode(s, 6, cursor)
+        raise Error::HPACKDecodeError if index.zero?
+        raise Error::HPACKDecodeError if index > STATIC_TABLE_SIZE + dynamic_table.count_entries
+
+        name = if index <= STATIC_TABLE_SIZE
+                 STATIC_TABLE[index - 1][0]
+               else
+                 dynamic_table[index - 1 - STATIC_TABLE_SIZE][0]
+               end
+        value, c = String.decode(s, c)
+        dynamic_table.store(name, value)
+
+        [[name, value], c]
+      end
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 0 | 0 | 1 |   Max size (5+)   |
+      # +---+---------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.3
+      #
+      # @param s [String]
+      # @param cursor [Integer]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [nil]
+      # @return [Integer]
+      def self.decode_dynamic_table_size_update(s, cursor, dynamic_table)
+        raise Error::HPACKDecodeError unless cursor.zero? || (s.getbyte(0) & 0b00100000).positive? && Integer.decode(s, 5, 0)[1] == cursor
+
+        max_size, c = Integer.decode(s, 5, cursor)
+        raise Error::HPACKDecodeError if max_size > dynamic_table.limit
+
+        dynamic_table.chomp!(max_size)
+        [nil, c]
+      end
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 0 | 0 | 0 | 1 |       0       |
+      # +---+---+-----------------------+
+      # | H |     Name Length (7+)      |
+      # +---+---------------------------+
+      # |  Name String (Length octets)  |
+      # +---+---------------------------+
+      # | H |     Value Length (7+)     |
+      # +---+---------------------------+
+      # | Value String (Length octets)  |
+      # +-------------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.2.3
+      #
+      # @param s [String]
+      # @param cursor [Integer]
+      #
+      # @return [Array]
+      # @return [Integer]
+      def self.decode_literal_field_never_indexed(s, cursor)
+        name, c = String.decode(s, cursor + 1)
+        value, c = String.decode(s, c)
+
+        [[name, value], c]
+      end
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 0 | 0 | 0 | 1 |  Index (4+)   |
+      # +---+---+-----------------------+
+      # | H |     Value Length (7+)     |
+      # +---+---------------------------+
+      # | Value String (Length octets)  |
+      # +-------------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.2.3
+      #
+      # @param s [String]
+      # @param cursor [Integer]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [Array]
+      # @return [Integer]
+      def self.decode_literal_value_never_indexed(s, cursor, dynamic_table)
+        index, c = Integer.decode(s, 4, cursor)
+        raise Error::HPACKDecodeError if index.zero?
+        raise Error::HPACKDecodeError if index > STATIC_TABLE_SIZE + dynamic_table.count_entries
+
+        name = if index <= STATIC_TABLE_SIZE
+                 STATIC_TABLE[index - 1][0]
+               else
+                 dynamic_table[index - 1 - STATIC_TABLE_SIZE][0]
+               end
+        value, c = String.decode(s, c)
+
+        [[name, value], c]
+      end
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 0 | 0 | 0 | 1 |       0       |
+      # +---+---+-----------------------+
+      # | H |     Name Length (7+)      |
+      # +---+---------------------------+
+      # |  Name String (Length octets)  |
+      # +---+---------------------------+
+      # | H |     Value Length (7+)     |
+      # +---+---------------------------+
+      # | Value String (Length octets)  |
+      # +-------------------------------+
+      # https://datatracker.ietf.org/doc/html/rfc7541#section-6.2.2
+      #
+      # @param s [String]
+      # @param cursor [Integer]
+      #
+      # @return [Array]
+      # @return [Integer]
+      def self.decode_literal_field_without_indexing(s, cursor)
+        name, c = String.decode(s, cursor + 1)
+        value, c = String.decode(s, c)
+
+        [[name, value], c]
+      end
+
+      #   0   1   2   3   4   5   6   7
+      # +---+---+---+---+---+---+---+---+
+      # | 0 | 0 | 0 | 0 |  Index (4+)   |
+      # +---+---+-----------------------+
+      # | H |     Value Length (7+)     |
+      # +---+---------------------------+
+      # | Value String (Length octets)  |
+      # +-------------------------------+
+      #
+      # @param s [String]
+      # @param cursor [Integer]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [Array]
+      # @return [Integer]
+      def self.decode_literal_value_without_indexing(s, cursor, dynamic_table)
+        index, c = Integer.decode(s, 4, cursor)
+        raise Error::HPACKDecodeError if index.zero?
+        raise Error::HPACKDecodeError if index > STATIC_TABLE_SIZE + dynamic_table.count_entries
+
+        name = if index <= STATIC_TABLE_SIZE
+                 STATIC_TABLE[index - 1][0]
+               else
+                 dynamic_table[index - 1 - STATIC_TABLE_SIZE][0]
+               end
+        value, c = String.decode(s, c)
+
+        [[name, value], c]
+      end
+    end
+    # rubocop: enable Metrics/ModuleLength
+  end
+end

data/lib/biryani/hpack/fields.rb

@@ -0,0 +1,28 @@
+module Biryani
+  module HPACK
+    module Fields
+      # @param fields [Array]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [String]
+      def self.encode(fields, dynamic_table)
+        fields.each_with_object(''.b) { |nv, acc| acc << Field.encode(nv[0].to_s, nv[1].to_s, dynamic_table) }
+      end
+
+      # @param s [String]
+      # @param dynamic_table [DynamicTable]
+      #
+      # @return [Array]
+      def self.decode(s, dynamic_table)
+        cursor = 0
+        fields = []
+        while cursor < s.bytesize
+          field, cursor = Field.decode(s, cursor, dynamic_table)
+          fields << field unless field.nil?
+        end
+
+        fields
+      end
+    end
+  end
+end