protocol-hpack 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8842abc9eb7e88d37fc4ed8040b6f4c6c5ec290993fd342dcc22a7d46ffcee1d
-  data.tar.gz: 6a6a2e09a5ebf8b8e7d1a6aa0f95b3d4bfc167c0d19ca9c47535b08428bb6986
+  metadata.gz: b4f37a74f63435d104e330527a394230a528ac8e1739c0ec6dcab1e0d40ba2fa
+  data.tar.gz: 15e11514d7bf7dc987577272e73114ac0179c750f065ddde4eceb8b10f19e46a
 SHA512:
-  metadata.gz: c43f98660e1eb5dc2508bdc95ee874699e69b21c23e12344c91f34897d50da207564cba0a61082b55cc522ffddf97fb02c2a0d59ee5f217b76fddb24559d3447
-  data.tar.gz: 5328a19baee03e84dd3dbfec14ca5d36a7b0deaa822eadfc0bdae5e7439d73c1b12c6d9194a5202fc9ed4cf43c74a715a5e27bede8b298aa20e9ca2037d5706e
+  metadata.gz: 9c6cf113a2141feb408615117dfed35d13a61a297f47bd4cfd2bcc63d42b38c21f875ef1dc99a0542035a17b7cd630c05fb6fb885b9294f8dc46533efb5bb48d
+  data.tar.gz: d7f96e39202967a77c73a39a4ca65e582676e8b533f990e3bd02062e1fe279387d663918247aa4baf3a50ea3da42099068783359e2b0a21ed1bd94e08909a18b

data/.gitmodules

@@ -1,3 +1,3 @@
-[submodule "spec/http/hpack/hpack-test-case"]
-	path = spec/http/hpack/hpack-test-case
+[submodule "spec/protocol/hpack/fixtures"]
+	path = spec/protocol/hpack/fixtures
 	url = https://github.com/http2jp/hpack-test-case.git

data/lib/protocol/hpack/compressor.rb

@@ -100,7 +100,7 @@ module Protocol
 			end
 			
 			def huffman
-				@context.options[:huffman]
+				@context.huffman
 			end
 			
 			# Encodes provided value via string literal representation.
@@ -158,7 +158,7 @@ module Protocol
 				case command[:type]
 				when :indexed
 					write_integer(command[:name] + 1, representation[:prefix])
-				when :changetablesize
+				when :change_table_size
 					write_integer(command[:value], representation[:prefix])
 				else
 					if command[:name].is_a? Integer

data/lib/protocol/hpack/context.rb

@@ -31,9 +31,9 @@ module Protocol
 		HEADER_REPRESENTATION = {
 			indexed: {prefix: 7, pattern: 0x80},
 			incremental: {prefix: 6, pattern: 0x40},
-			noindex: {prefix: 4, pattern: 0x00},
-			neverindexed: {prefix: 4, pattern: 0x10},
-			changetablesize: {prefix: 5, pattern: 0x20},
+			no_index: {prefix: 4, pattern: 0x00},
+			never_indexed: {prefix: 4, pattern: 0x10},
+			change_table_size: {prefix: 5, pattern: 0x20},
 		}
 		
 		# To decompress header blocks, a decoder only needs to maintain a
@@ -105,48 +105,38 @@ module Protocol
 				['vary',                        ''],
 				['via',                         ''],
 				['www-authenticate',            ''],
-		 ].each {|pair| pair.each(&:freeze).freeze}.freeze
-
-			# 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
-
-			# Initializes compression context with appropriate client/server
-			# defaults and maximum size of the dynamic table.
+			].each {|pair| pair.each(&:freeze).freeze}.freeze
+			
+			# Initializes compression context with appropriate client/server defaults 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)
-				default_options = {
-					huffman: :shorter,
-					index: :all,
-					table_size: 4096,
-				}
+			# @param table [Array] Table of header key-value pairs.
+			# @option huffman [Symbol] One of `:always`, `:never`, `:shorter`. Controls use of compression.
+			# @option index [Symbol] One of `:all`, `:static`, `:never`. Controls use of static/dynamic tables.
+			# @option table_size [Integer] The current maximum dynamic table size.
+			def initialize(table = nil, huffman: :shorter, index: :all, table_size: 4096)
+				@huffman = huffman
+				@index = index
 				
-				@table = []
-				@options = default_options.merge(options)
-				@limit = @options[:table_size]
-			end
-
-			# Duplicates current compression context
-			# @return [Context]
-			def dup
-				other = Context.new(@options)
+				@table_size = table_size
 				
-				other.instance_variable_set :@table, @table.dup
-				other.instance_variable_set :@limit, @limit
+				@table = (table&.dup) || []
+			end
+			
+			def initialize_copy(other)
+				super
 				
-				return other
+				# This is the only mutable state:
+				@table = @table.dup
 			end
-
+			
+			# Current table of header key-value pairs.
+			attr :table
+			
+			attr :huffman
+			attr :index
+			
+			attr :table_size
+			
 			# Finds an entry in current dynamic table by index.
 			# Note that index is zero-based in this module.
 			#
@@ -175,7 +165,7 @@ module Protocol
 				emit = nil
 
 				case command[:type]
-				when :changetablesize
+				when :change_table_size
 					self.table_size = command[:value]
 
 				when :indexed
@@ -189,7 +179,7 @@ module Protocol
 					k, v = dereference(idx)
 					emit = [k, v]
 
-				when :incremental, :noindex, :neverindexed
+				when :incremental, :no_index, :never_indexed
 					# A _literal representation_ that is _not added_ to the dynamic table
 					# entails the following action:
 					# o  The header field is added to the decoded header list.
@@ -219,7 +209,7 @@ module Protocol
 				return emit
 			end
 
-			# Plan header compression according to +@options [:index]+
+			# Plan header compression according to +@index+
 			#  :never   Do not use dynamic table or static table reference at all.
 			#  :static  Use static table only.
 			#  :all     Use all of them.
@@ -229,12 +219,12 @@ module Protocol
 			def encode(headers)
 				commands = []
 				
-				# Literals commands are marked with :noindex when index is not used
-				noindex = [:static, :never].include?(@options[:index])
+				# Literals commands are marked with :no_index when index is not used
+				no_index = [:static, :never].include?(@index)
 				
 				headers.each do |field, value|
 					command = add_command(field, value)
-					command[:type] = :noindex if noindex && command[:type] == :incremental
+					command[:type] = :no_index if no_index && command[:type] == :incremental
 					commands << command
 					
 					decode(command)
@@ -247,7 +237,7 @@ module Protocol
 			# Prefer static table over dynamic table.
 			# Prefer exact match over name-only match.
 			#
-			# +@options [:index]+ controls whether to use the dynamic table,
+			# +@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.
@@ -259,7 +249,7 @@ module Protocol
 				exact = nil
 				name_only = nil
 
-				if [:all, :static].include?(@options[:index])
+				if [:all, :static].include?(@index)
 					STATIC_TABLE.each_index do |i|
 						if STATIC_TABLE[i] == header
 							exact ||= i
@@ -269,7 +259,7 @@ module Protocol
 						end
 					end
 				end
-				if [:all].include?(@options[:index]) && !exact
+				if [:all].include?(@index) && !exact
 					@table.each_index do |i|
 						if @table[i] == header
 							exact ||= i + STATIC_TABLE.size
@@ -291,8 +281,8 @@ module Protocol
 
 			# Alter dynamic table size.
 			#  When the size is reduced, some headers might be evicted.
-			def table_size=(size)
-				@limit = size
+			def table_size= size
+				@table_size = size
 				size_check(nil)
 			end
 
@@ -314,7 +304,7 @@ module Protocol
 				@table.unshift(command)
 			end
 
-			# To keep the dynamic table size lower than or equal to @limit,
+			# To keep the dynamic table size lower than or equal to @table_size,
 			# remove one or more entries at the end of the dynamic table.
 			#
 			# @param command [Hash]
@@ -323,14 +313,14 @@ module Protocol
 				cursize = current_table_size
 				cmdsize = command.nil? ? 0 : command[0].bytesize + command[1].bytesize + 32
 
-				while cursize + cmdsize > @limit
+				while cursize + cmdsize > @table_size
 					break if @table.empty?
 
 					e = @table.pop
 					cursize -= e[0].bytesize + e[1].bytesize + 32
 				end
 
-				cmdsize <= @limit
+				cmdsize <= @table_size
 			end
 		end
 	end

data/lib/protocol/hpack/decompressor.rb

@@ -28,16 +28,20 @@ module Protocol
 		# context of the opposing peer. Decompressor must be initialized with
 		# appropriate starting context based on local role: client or server.
 		class Decompressor
-			def initialize(buffer, context = Context.new)
+			def initialize(buffer, context = Context.new, table_size_limit: nil)
 				@buffer = buffer
 				@context = context
 				@offset = 0
+				
+				@table_size_limit = table_size_limit
 			end
 
 			attr :buffer
 			attr :context
 			attr :offset
-
+			
+			attr :table_size_limit
+			
 			def end?
 				@offset >= @buffer.bytesize
 			end
@@ -50,7 +54,6 @@ module Protocol
 				return byte
 			end
 			
-			
 			def peek_byte
 				@buffer.getbyte(@offset)
 			end
@@ -121,8 +124,12 @@ module Protocol
 				when :indexed
 					raise CompressionError if header[:name].zero?
 					header[:name] -= 1
-				when :changetablesize
+				when :change_table_size
 					header[:value] = header[:name]
+					
+					if @table_size_limit and header[:value] > @table_size_limit
+						raise CompressionError, "Table size #{header[:value]} exceeds limit #{@table_size_limit}!"
+					end
 				else
 					if (header[:name]).zero?
 						header[:name] = read_string

data/lib/protocol/hpack/huffman.rb

@@ -333,8 +333,8 @@ module Protocol
 				[0x7fffff0, 27],
 				[0x3ffffee, 26],
 				[0x3fffffff, 30],
-		 ].each(&:freeze).freeze
-
+			].each(&:freeze).freeze
+			
 			ENCODE_TABLE = CODES.map {|c, l| [c].pack('N').unpack('B*').first[-l..-1]}.each(&:freeze).freeze
 		end
 	end

data/lib/protocol/hpack/version.rb

@@ -20,6 +20,6 @@
 
 module Protocol
 	module HPACK
-		VERSION = "1.1.0"
+		VERSION = "1.2.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: protocol-hpack
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-11 00:00:00.000000000 Z
+date: 2019-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: covered