biryani 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be854e5993fe96b137d1d4db219551155b3103b213a97058c64f756ad2971ba3
-  data.tar.gz: 2256eea9aee63134060398084d904651a1d0fde583564dc211e13ddb5b134e78
+  metadata.gz: 2a6614c6a74a069a08281c0f3846da8512f379e347ce77e3812c7cd22f2506bc
+  data.tar.gz: 5a0f61a32f576c0a693abeb2773490ddcbbdcc573b82dac16a6d3a3e82bf2e0e
 SHA512:
-  metadata.gz: 0abdc8a1ce8d2b0a4d149830e14c0435e08b884950c026ab7d67af0726aeff53eff9d8dc06da83c4819badd967d6e1f0f2fb0b5833432c508ec3874c117ceaf8
-  data.tar.gz: e11b1fdde4debd807fb8ddfd7c9b7eaec3be56510be8758e1c42b815589418c5711848ae2ded681247578509aad0f20951558ee54a0b0d6d92825f7704bb3256
+  metadata.gz: 0c0add40f15c4e1fa9110a295f9fda392aae21a6ad4dd062a0d3a31fd5dd208f8a384fbcf9009a6fc29e6a940f4fc755f9da0f3e244f68292ee41323cd10e82f
+  data.tar.gz: 1af73e5c917c095dfcb635fd7c09548b4330114125e00df539356fb270d8f083e76c0d25262652f6781e4b8415fc3c2da91083b0af19b20ac7175a70b5c28bc1

data/.ruby-version

@@ -1 +1 @@
-4.0.0
+4.0.1

data/Rakefile

@@ -5,4 +5,11 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new(:spec)
 
+desc 'conformance test using h2spec'
+RSpec::Core::RakeTask.new(:conformance) do |t|
+  t.pattern = 'conformance/server_spec.rb'
+  t.rspec_opts = %w[--out /dev/null]
+  t.verbose = false
+end
+
 task default: %i[rubocop spec]

data/conformance/server_spec.rb

@@ -0,0 +1,31 @@
+require_relative 'spec_helper'
+
+RSpec.describe Server do
+  before do
+    @tcpserver = TCPServer.open(PORT)
+
+    Ractor.new(@tcpserver) do |socket|
+      server = Server.new(
+        Ractor.shareable_proc do |_req, res|
+          res.status = 200
+          res.content = 'OK'
+        end
+      )
+
+      server.run(socket)
+    end
+  end
+
+  let(:client) do
+    which('h2spec')
+    "h2spec --port #{PORT} --verbose"
+  end
+
+  after do
+    @tcpserver.close
+  end
+
+  it 'should run' do
+    system(client)
+  end
+end

data/conformance/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'open3'
+require 'socket'
+require 'biryani'
+
+# rubocop: disable Style/MixinUsage
+include Biryani
+# rubocop: enable Style/MixinUsage
+
+PORT = 8888
+
+def which(cmd)
+  o, = Open3.capture3("which #{cmd}")
+  warn "conformance task require `#{cmd}`. Install `#{cmd}`." if o.empty?
+end

data/example/echo.rb

@@ -13,7 +13,6 @@ server = Biryani::Server.new(
   # @param res [Biryani::HTTPResponse]
   Ractor.shareable_proc do |req, res|
     res.status = 200
-
     res.content = if req.method.upcase == 'POST'
                     req.content
                   else

data/example/raise_error.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH << "#{__dir__}/../lib"
+
+require 'socket'
+require 'biryani'
+
+port = ARGV[0] || 8888
+socket = TCPServer.new(port)
+
+server = Biryani::Server.new(
+  Ractor.shareable_proc do
+    raise 'error'
+  end
+)
+server.run(socket)
+
+# $ bundle exec ruby example/raise_error.rb
+# $ curl -v --http2-prior-knowledge http://localhost:8888

data/lib/biryani/connection.rb

@@ -44,10 +44,11 @@ module Biryani
 
       recv_loop(io.clone)
       send_loop(io)
-    rescue StandardError
+    rescue StandardError => e
+      puts e.backtrace
       self.class.do_send(io, Frame::Goaway.new(0, @streams_ctx.last_stream_id, ErrorCode::INTERNAL_ERROR, 'internal error'), true)
     ensure
-      io&.close_write
+      io.close_write
     end
 
     # @param io [IO]
@@ -57,7 +58,7 @@ module Biryani
           obj = Frame.read(io_)
           break if obj.nil?
 
-          sock_ << obj
+          sock_.send(obj, move: true)
         end
       end
     end
@@ -71,15 +72,14 @@ module Biryani
     def send_loop(io)
       loop do
         ports = @streams_ctx.txs
-        ports << @sock
-        next if ports.empty?
+        break if ports.empty? && @sock.closed?
 
-        port, obj = Ractor.select(*ports)
+        port, obj = Ractor.select(@sock, *ports)
         if port == @sock
           if Biryani.err?(obj)
             reply_frame = Biryani.unwrap(obj, @streams_ctx.last_stream_id)
             self.class.do_send(io, reply_frame, true)
-            close if self.class.transition_state_send(reply_frame, @streams_ctx)
+            close if self.class.transition_stream_state_send(reply_frame, @streams_ctx)
           elsif obj.length > @settings[SettingsID::SETTINGS_MAX_FRAME_SIZE]
             self.class.do_send(io, Frame::Goaway.new(0, @streams_ctx.last_stream_id, ErrorCode::FRAME_SIZE_ERROR, 'payload length greater than SETTINGS_MAX_FRAME_SIZE'), true)
             close
@@ -93,7 +93,7 @@ module Biryani
                 @streams_ctx[reply_frame.stream_id].recv_window.increase!(reply_frame.window_size_increment)
               end
 
-              close if self.class.transition_state_send(reply_frame, @streams_ctx)
+              close if self.class.transition_stream_state_send(reply_frame, @streams_ctx)
             end
           end
         else
@@ -129,8 +129,12 @@ module Biryani
     #
     # @return [Array<Object>, Array<ConnectionError>, Array<StreamError>] frames or errors
     # rubocop: disable Metrics/CyclomaticComplexity
+    # rubocop: disable Metrics/PerceivedComplexity
     def handle_connection_frame(frame)
       typ = frame.f_type
+      return [ConnectionError.new(ErrorCode::PROTOCOL_ERROR, "invalid frame type #{format('0x%02x', typ)} for stream identifier #{format('0x%02x', stream_id)}")] \
+        if @streams_ctx.receiving_continuation? && ([FrameType::SETTINGS, FrameType::PING, FrameType::WINDOW_UPDATE].include?(typ) || FrameType.unknown?(typ))
+
       case typ
       when FrameType::DATA, FrameType::HEADERS, FrameType::PRIORITY, FrameType::RST_STREAM, FrameType::PUSH_PROMISE, FrameType::CONTINUATION
         [ConnectionError.new(ErrorCode::PROTOCOL_ERROR, "invalid frame type #{format('0x%02x', typ)} for stream identifier 0x00")]
@@ -163,6 +167,7 @@ module Biryani
       end
     end
     # rubocop: enable Metrics/CyclomaticComplexity
+    # rubocop: enable Metrics/PerceivedComplexity
 
     # @param frame [Object]
     #
@@ -179,7 +184,7 @@ module Biryani
       max_streams = @peer_settings[SettingsID::SETTINGS_MAX_CONCURRENT_STREAMS]
       send_initial_window_size = @peer_settings[SettingsID::SETTINGS_INITIAL_WINDOW_SIZE]
       recv_initial_window_size = @settings[SettingsID::SETTINGS_INITIAL_WINDOW_SIZE]
-      obj = self.class.transition_state_recv(frame, @streams_ctx, stream_id, max_streams, send_initial_window_size, recv_initial_window_size)
+      obj = self.class.transition_stream_state_recv(frame, @streams_ctx, stream_id, max_streams, send_initial_window_size, recv_initial_window_size)
       return [obj] if Biryani.err?(obj)
 
       ctx = obj
@@ -241,7 +246,7 @@ module Biryani
     # @return [StreamContext, StreamError, ConnectionError]
     # rubocop: disable Metrics/CyclomaticComplexity
     # rubocop: disable Metrics/PerceivedComplexity
-    def self.transition_state_recv(recv_frame, streams_ctx, stream_id, max_streams, send_initial_window_size, recv_initial_window_size)
+    def self.transition_stream_state_recv(recv_frame, streams_ctx, stream_id, max_streams, send_initial_window_size, recv_initial_window_size)
       ctx = streams_ctx[stream_id]
       return StreamError.new(ErrorCode::PROTOCOL_ERROR, stream_id, 'exceed max concurrent streams') if ctx.nil? && streams_ctx.count_active + 1 > max_streams
       return ConnectionError.new(ErrorCode::PROTOCOL_ERROR, 'even-numbered stream identifier') if ctx.nil? && stream_id.even?
@@ -260,7 +265,7 @@ module Biryani
     # @param streams_ctx [StreamsContext]
     #
     # @return [Boolean] should close connection?
-    def self.transition_state_send(send_frame, streams_ctx)
+    def self.transition_stream_state_send(send_frame, streams_ctx)
       stream_id = send_frame.stream_id
       typ = send_frame.f_type
       case typ
@@ -297,7 +302,7 @@ module Biryani
         do_send(io, frame, false)
         send_window.consume!(frame.length)
         streams_ctx[stream_id].send_window.consume!(frame.length)
-        transition_state_send(frame, streams_ctx)
+        transition_stream_state_send(frame, streams_ctx)
       end
 
       data_buffer.store(stream_id, remains) unless remains.empty?
@@ -322,7 +327,7 @@ module Biryani
 
       frames.each do |frame|
         do_send(io, frame, false)
-        transition_state_send(frame, streams_ctx)
+        transition_stream_state_send(frame, streams_ctx)
       end
     end
 
@@ -352,7 +357,7 @@ module Biryani
         obj = http_request(ctx.fragment, ctx.content, decoder)
         return obj if Biryani.err?(obj)
 
-        ctx.stream.rx << obj
+        ctx.stream.rx.send(obj, move: true)
       end
 
       window_updates = []
@@ -371,9 +376,9 @@ module Biryani
       ctx.fragment << headers.fragment
       if ctx.half_closed_remote?
         obj = http_request(ctx.fragment, ctx.content, decoder)
-        return [obj] if Biryani.err?(obj)
+        return obj if Biryani.err?(obj)
 
-        ctx.stream.rx << obj
+        ctx.stream.rx.send(obj, move: true)
       end
 
       nil

data/lib/biryani/error.rb

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

data/lib/biryani/frame/unknown.rb

@@ -21,9 +21,7 @@ module Biryani
 
       # @return [String]
       def to_binary_s
-        payload_length = length
-
-        Frame.to_binary_s_header(payload_length, @f_type, flags, @stream_id) + @payload
+        Frame.to_binary_s_header(length, @f_type, @flags, @stream_id) + @payload
       end
     end
   end

data/lib/biryani/frame.rb

@@ -10,6 +10,11 @@ module Biryani
     GOAWAY        = 0x07
     WINDOW_UPDATE = 0x08
     CONTINUATION  = 0x09
+
+    # @return [Boolean]
+    def self.unknown?(typ)
+      typ.negative? || typ > 0x09
+    end
   end
 
   module ErrorCode

data/lib/biryani/http_request.rb

@@ -65,7 +65,8 @@ module Biryani
     #
     # @return [HTTPRequest]
     def build(s)
-      self.class.http_request(@h, s)
+      h = @h.transform_values(&:dup)
+      self.class.http_request(h, s)
     end
 
     # @param fields [Hash<String, String>]

data/lib/biryani/http_response.rb

@@ -1,15 +1,37 @@
 module Biryani
   class HTTPResponse
+    FORBIDDEN_KEY_CHARS = (0x00..0x20).chain([0x3a]).chain(0x41..0x5a).chain(0x7f..0xff).to_a.freeze
+    FORBIDDEN_VALUE_CHARS = [0x00, 0x0a, 0x0d].freeze
+
     attr_accessor :status, :fields, :content
 
     # @param status [Integer]
     # @param fields [Hash]
-    # @param content [String]
+    # @param content [String, nil]
     def initialize(status, fields, content)
       @status = status
       @fields = fields
       @content = content
     end
+
+    # @raise [InvalidHTTPResponseError]
+    # rubocop: disable Metrics/CyclomaticComplexity
+    def validate
+      # https://datatracker.ietf.org/doc/html/rfc9113#section-8.2.1
+      raise Error::InvalidHTTPResponseError, 'invalid HTTP status' if @status < 100 || @status >= 600
+      raise Error::InvalidHTTPResponseError, 'HTTP field name contains invalid characters' if (@fields.keys.join.downcase.bytes.uniq & FORBIDDEN_KEY_CHARS).any?
+      raise Error::InvalidHTTPResponseError, 'HTTP field value contains NUL, LF or CR' if (@fields.values.join.bytes.uniq & FORBIDDEN_VALUE_CHARS).any?
+      raise Error::InvalidHTTPResponseError, 'HTTP field value starts/ends with SP or HTAB' if @fields.values.filter { |s| s.start_with?("\t", ' ') || s.end_with?("\t", ' ') }.any?
+    end
+    # rubocop: enable Metrics/CyclomaticComplexity
+
+    def self.default
+      HTTPResponse.new(0, {}, nil)
+    end
+
+    def self.internal_server_error
+      HTTPResponse.new(500, {}, 'Internal Server Error')
+    end
   end
 
   class HTTPResponseParser
@@ -22,7 +44,6 @@ module Biryani
     def fields
       fields = [[':status', @res.status.to_s]]
       @res.fields.each do |name, value|
-        # TODO: validate fields
         fields << [name.to_s.downcase, value.to_s]
       end
 

data/lib/biryani/server.rb

@@ -11,7 +11,7 @@ module Biryani
         Ractor.new(socket.accept, @proc) do |io, proc|
           conn = Connection.new(proc)
           conn.serve(io)
-          io&.close
+          io.close
         end
       end
     end

data/lib/biryani/state.rb

@@ -65,7 +65,7 @@ module Biryani
       in [:idle, FrameType::HEADERS, :recv] if frame.end_stream?
         :receiving_continuation
       in [:idle, FrameType::HEADERS, :recv]
-        :receiving_continuation_data
+        :receiving_continuation_and_data
       in [:idle, FrameType::PRIORITY, :recv]
         state
       in [:idle, FrameType::PUSH_PROMISE, :send]
@@ -73,16 +73,16 @@ module Biryani
       in [:idle, _, _]
         unexpected(ErrorCode::PROTOCOL_ERROR, state, typ, direction)
 
-      # receiving_continuation_data
-      in [:receiving_continuation_data, FrameType::RST_STREAM, _]
+      # receiving_continuation_and_data
+      in [:receiving_continuation_and_data, FrameType::RST_STREAM, _]
         :closed
-      in [:receiving_continuation_data, FrameType::WINDOW_UPDATE, :recv]
+      in [:receiving_continuation_and_data, FrameType::WINDOW_UPDATE, :recv]
         state
-      in [:receiving_continuation_data, FrameType::CONTINUATION, :recv] if frame.end_headers?
+      in [:receiving_continuation_and_data, FrameType::CONTINUATION, :recv] if frame.end_headers?
         :receiving_data
-      in [:receiving_continuation_data, FrameType::CONTINUATION, :recv]
+      in [:receiving_continuation_and_data, FrameType::CONTINUATION, :recv]
         state
-      in [:receiving_continuation_data, _, _]
+      in [:receiving_continuation_and_data, _, _]
         unexpected(ErrorCode::PROTOCOL_ERROR, state, typ, direction)
 
       # receiving_continuation
@@ -234,5 +234,10 @@ module Biryani
     def half_closed_remote?
       @state == :half_closed_remote
     end
+
+    # @return [Boolean]
+    def receiving_continuation?
+      %i[receiving_continuation receiving_continuation_and_data].include?(@state)
+    end
   end
 end

data/lib/biryani/stream.rb

@@ -8,10 +8,17 @@ module Biryani
     def initialize(tx, stream_id, proc)
       @rx = Ractor.new(tx, stream_id, proc) do |tx, stream_id, proc|
         unless (req = Ractor.recv).nil?
-          res = HTTPResponse.new(0, {}, '')
+          res = HTTPResponse.default
 
-          proc.call(req, res)
-          tx << [res, stream_id]
+          begin
+            proc.call(req, res)
+            res.validate
+          rescue StandardError => e
+            puts e.backtrace
+            res = HTTPResponse.internal_server_error
+          end
+
+          tx.send([res, stream_id], move: true)
         end
       end
     end

data/lib/biryani/streams_context.rb

@@ -47,6 +47,11 @@ module Biryani
       @h.values.filter(&:active?).length
     end
 
+    # @return [Boolean]
+    def receiving_continuation?
+      @h.values.any?(&:receiving_continuation?)
+    end
+
     # @return [Array<Integer>]
     def closed_stream_ids
       @h.filter { |_, ctx| ctx.closed? }.keys
@@ -131,5 +136,10 @@ module Biryani
     def half_closed_remote?
       @state.half_closed_remote?
     end
+
+    # @return [Boolean]
+    def receiving_continuation?
+      @state.receiving_continuation?
+    end
   end
 end

data/lib/biryani/version.rb

@@ -1,3 +1,3 @@
 module Biryani
-  VERSION = '0.0.5'.freeze
+  VERSION = '0.0.6'.freeze
 end

data/lib/biryani.rb

@@ -3,6 +3,7 @@ require 'uri'
 require_relative 'biryani/connection_error'
 require_relative 'biryani/connection'
 require_relative 'biryani/data_buffer'
+require_relative 'biryani/error'
 require_relative 'biryani/frame'
 require_relative 'biryani/hpack'
 require_relative 'biryani/http_request'

data/spec/connection/{transition_state_send_spec.rb → transition_stream_state_send_spec.rb}

@@ -1,7 +1,7 @@
 require_relative '../spec_helper'
 
 RSpec.describe Connection do
-  context 'transition_state_send' do
+  context 'transition_stream_state_send' do
     let(:streams_ctx) do
       streams_ctx = StreamsContext.new(do_nothing_proc)
       streams_ctx.new_context(1, 65_535, 65_535)
@@ -14,7 +14,7 @@ RSpec.describe Connection do
     end
     it 'should transition' do
       streams_ctx[2].state.transition!(headers, :recv)
-      Connection.transition_state_send(headers, streams_ctx)
+      Connection.transition_stream_state_send(headers, streams_ctx)
       expect(streams_ctx.length).to eq 2
     end
 
@@ -31,7 +31,7 @@ RSpec.describe Connection do
     end
     it 'should transition' do
       streams_ctx[2].state.transition!(headers, :recv)
-      Connection.transition_state_send(rst_stream, streams_ctx)
+      Connection.transition_stream_state_send(rst_stream, streams_ctx)
       expect { streams_ctx[1].tx << nil }.to_not raise_error
       expect { streams_ctx[2].tx << nil }.to_not raise_error
     end

data/spec/http_response_spec.rb

@@ -0,0 +1,12 @@
+require_relative 'spec_helper'
+
+RSpec.describe HTTPResponse do
+  it 'should validate' do
+    expect { HTTPResponse.new(600, {}, nil).validate }.to raise_error Error::InvalidHTTPResponseError
+    expect { HTTPResponse.new(200, { "\x00key" => 'value' }, nil).validate }.to raise_error Error::InvalidHTTPResponseError
+    expect { HTTPResponse.new(200, { 'key:' => 'value' }, nil).validate }.to raise_error Error::InvalidHTTPResponseError
+    expect { HTTPResponse.new(200, { 'key' =>  "one\ntwo" }, nil).validate }.to raise_error Error::InvalidHTTPResponseError
+    expect { HTTPResponse.new(200, { 'key' =>  ' value' }, nil).validate }.to raise_error Error::InvalidHTTPResponseError
+    expect { HTTPResponse.new(200, { 'key' =>  "value\t" }, nil).validate }.to raise_error Error::InvalidHTTPResponseError
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: biryani
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - thekuwayama
@@ -39,12 +39,16 @@ files:
 - README.md
 - Rakefile
 - biryani.gemspec
+- conformance/server_spec.rb
+- conformance/spec_helper.rb
 - example/echo.rb
 - example/hello_world.rb
+- example/raise_error.rb
 - lib/biryani.rb
 - lib/biryani/connection.rb
 - lib/biryani/connection_error.rb
 - lib/biryani/data_buffer.rb
+- lib/biryani/error.rb
 - lib/biryani/frame.rb
 - lib/biryani/frame/continuation.rb
 - lib/biryani/frame/data.rb
@@ -87,7 +91,7 @@ files:
 - spec/connection/handle_stream_window_update_spec.rb
 - spec/connection/read_http2_magic_spec.rb
 - spec/connection/send_spec.rb
-- spec/connection/transition_state_send_spec.rb
+- spec/connection/transition_stream_state_send_spec.rb
 - spec/data_buffer_spec.rb
 - spec/frame/continuation_spec.rb
 - spec/frame/data_spec.rb
@@ -108,6 +112,7 @@ files:
 - spec/hpack/integer_spec.rb
 - spec/hpack/string_spec.rb
 - spec/http_request_builder_spec.rb
+- spec/http_response_spec.rb
 - spec/spec_helper.rb
 - spec/streams_context_spec.rb
 - spec/utils_spec.rb
@@ -142,7 +147,7 @@ test_files:
 - spec/connection/handle_stream_window_update_spec.rb
 - spec/connection/read_http2_magic_spec.rb
 - spec/connection/send_spec.rb
-- spec/connection/transition_state_send_spec.rb
+- spec/connection/transition_stream_state_send_spec.rb
 - spec/data_buffer_spec.rb
 - spec/frame/continuation_spec.rb
 - spec/frame/data_spec.rb
@@ -163,6 +168,7 @@ test_files:
 - spec/hpack/integer_spec.rb
 - spec/hpack/string_spec.rb
 - spec/http_request_builder_spec.rb
+- spec/http_response_spec.rb
 - spec/spec_helper.rb
 - spec/streams_context_spec.rb
 - spec/utils_spec.rb