h1p 0.6.1 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96197142deeb30d27fe9b3fc9de21a07ed1de8f0a1d3db9b8d967310056bdd12
-  data.tar.gz: aa71893e95f7a7e8ba8de8123987445262edd6dbcad7efba12337091a2421d14
+  metadata.gz: 33974d5940b6a9ad9282df7d946486a1ee265ed67e2d5004bbe3e3572c4233db
+  data.tar.gz: a0b175ce9eb77d83457376902ab71cf597eedc41009c6094564e8de20e8532f5
 SHA512:
-  metadata.gz: 9380e218a2433f61a88676fb807ecb742391dff2c6d7e4937d24ff1385839ed897eaf81eb3d8d1f916bcf53f30cd2fd9c31f0c78fcd6c0e35d3753dc1d3a1252
-  data.tar.gz: 2ce69a5e542390018f779e9ba0a73263b362b3a6d69838494da73d18cb6f84a3262ed98fd086bb098ffa253f264db4d3e1d40e5ae8f9757ca1928c36ce9f02ce
+  metadata.gz: b8826e6c0039d1721ba0d662fb542a19ed9349bdc0ec6aadc976b172266284955c0d6784da9b1d1b9d8e5ef76181cc8b1299eb2164ab1b56817899e66ae1ec53
+  data.tar.gz: 6d9343d65ffc31dadaa7fd9a01e5221d183a830d7d79fa82d79381832160ad1c342ffa6f1a4892f8aad78f7f1adde161517b79f571fdb5efc098cc4e55c99781

data/.github/workflows/test.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-latest]
-        ruby: [2.7, 3.0, 3.1, 3.2]
+        ruby: ['3.0', '3.1', '3.2', 'head']
 
     name: >-
       ${{matrix.os}}, ${{matrix.ruby}}
@@ -24,8 +24,6 @@ jobs:
       run: |
         gem install bundler
         bundle install
-    - name: Show Linux kernel version
-      run: uname -r
     - name: Compile C-extension
       run: bundle exec rake compile
     - name: Run tests

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.1 2023-07-01
+
+- Rescue `ArgumentError` in `#parse_headers` (#4)
+
+## 1.0 2023-06-07
+
+- Add support for array as header value (#2)
+
 ## 0.6.1 2023-05-28
 
 - Fix sending response with frozen headers hash

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    h1p (0.6.1)
+    h1p (1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    minitest (5.17.0)
+    minitest (5.18.0)
     rake (13.0.6)
-    rake-compiler (1.2.1)
+    rake-compiler (1.2.3)
       rake
 
 PLATFORMS
@@ -16,9 +16,9 @@ PLATFORMS
 
 DEPENDENCIES
   h1p!
-  minitest (~> 5.17.0)
+  minitest (~> 5.18.0)
   rake (~> 13.0.6)
-  rake-compiler (= 1.2.1)
+  rake-compiler (= 1.2.3)
 
 BUNDLED WITH
    2.2.26

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Digital Fabric
+Copyright (c) 2023 Digital Fabric
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/ext/h1p/h1p.c

@@ -1,3 +1,4 @@
+#include <stdnoreturn.h>
 #include "h1p.h"
 
 // Security-related limits are defined in limits.rb and injected as
@@ -22,6 +23,7 @@ ID ID_call;
 ID ID_downcase;
 ID ID_eof_p;
 ID ID_eq;
+ID ID_join;
 ID ID_read_method;
 ID ID_read;
 ID ID_readpartial;
@@ -56,6 +58,7 @@ VALUE STR_transfer_encoding_capitalized;
 
 VALUE STR_CRLF;
 VALUE STR_EMPTY_CHUNK;
+VALUE STR_COMMA_SPACE;
 
 VALUE SYM_backend_read;
 VALUE SYM_backend_recv;
@@ -722,20 +725,7 @@ eof:
   return 0;
 }
 
-/* call-seq: parser.parse_headers -> headers
- *
- * Parses headers from the associated IO instance, returning a hash mapping
- * header keys to their respective values. Header keys are downcased and dashes
- * are converted to underscores. The returned headers will also include the
- * following pseudo-headers:
- * 
- * - `':protocol'` - the protocol as specified in the query line / status line
- * - `':path'` - the query path (for HTTP requests)
- * - `':method'` - the HTTP method (for HTTP requests)
- * - `':status'` - the HTTP status (for HTTP responses)
- * - `':rx'` - the total number of bytes read by the parser
- */
-VALUE Parser_parse_headers(VALUE self) {
+VALUE Parser_parse_headers_safe(VALUE self) {
   Parser_t *parser;
   GetParser(self, parser);
   parser->headers = rb_hash_new();
@@ -773,6 +763,31 @@ done:
   return parser->headers;
 }
 
+noreturn VALUE Parser_parse_headers_rescue(VALUE args, VALUE error) {
+  RAISE_BAD_REQUEST("Invalid character sequences in method or header name");
+}
+
+/* call-seq: parser.parse_headers -> headers
+ *
+ * Parses headers from the associated IO instance, returning a hash mapping
+ * header keys to their respective values. Header keys are downcased and dashes
+ * are converted to underscores. The returned headers will also include the
+ * following pseudo-headers:
+ * 
+ * - `':protocol'` - the protocol as specified in the query line / status line
+ * - `':path'` - the query path (for HTTP requests)
+ * - `':method'` - the HTTP method (for HTTP requests)
+ * - `':status'` - the HTTP status (for HTTP responses)
+ * - `':rx'` - the total number of bytes read by the parser
+ */
+VALUE Parser_parse_headers(VALUE self) {
+  return rb_rescue2(
+    Parser_parse_headers_safe, self,
+    Parser_parse_headers_rescue, self,
+    eArgumentError, (VALUE)0
+  );
+}
+
 ////////////////////////////////////////////////////////////////////////////////
 
 static inline int str_to_int(VALUE value, const char *error_msg) {
@@ -1176,12 +1191,24 @@ void send_response_write_status_line(send_response_ctx *ctx, VALUE protocol, VAL
   ctx->buffer_len += partlen + 2;
 }
 
+inline static VALUE format_comma_separated_header_values(VALUE array) {
+  return rb_funcall(array, ID_join, 1, STR_COMMA_SPACE);
+}
+
 int send_response_write_header(VALUE key, VALUE val, VALUE arg) {
   if (TYPE(key) != T_STRING) key = rb_funcall(key, ID_to_s, 0);
   char *keyptr = RSTRING_PTR(key);
   if (RSTRING_LEN(key) < 1 || keyptr[0] == ':') return 0;
 
-  if (TYPE(val) != T_STRING) val = rb_funcall(val, ID_to_s, 0);
+  switch (TYPE(val)) {
+    case T_STRING:
+      break;
+    case T_ARRAY:
+      val = format_comma_separated_header_values(val);
+      break;
+    default:
+      val = rb_funcall(val, ID_to_s, 0);
+  }
   unsigned int keylen = RSTRING_LEN(key);
   char *valptr = RSTRING_PTR(val);
   unsigned int vallen = RSTRING_LEN(val);
@@ -1377,6 +1404,7 @@ void Init_H1P(void) {
   ID_downcase               = rb_intern("downcase");
   ID_eof_p                  = rb_intern("eof?");
   ID_eq                     = rb_intern("==");
+  ID_join                   = rb_intern("join");
   ID_read_method            = rb_intern("__read_method__");
   ID_read                   = rb_intern("read");
   ID_readpartial            = rb_intern("readpartial");
@@ -1405,8 +1433,9 @@ void Init_H1P(void) {
   GLOBAL_STR(STR_transfer_encoding,             "transfer-encoding");
   GLOBAL_STR(STR_transfer_encoding_capitalized, "Transfer-Encoding");
 
-  GLOBAL_STR(STR_CRLF,                        "\r\n");
-  GLOBAL_STR(STR_EMPTY_CHUNK,                 "0\r\n\r\n");
+  GLOBAL_STR(STR_CRLF,                          "\r\n");
+  GLOBAL_STR(STR_EMPTY_CHUNK,                   "0\r\n\r\n");
+  GLOBAL_STR(STR_COMMA_SPACE,                   ", ");
 
   SYM_backend_read  = ID2SYM(ID_backend_read);
   SYM_backend_recv  = ID2SYM(ID_backend_recv);

data/h1p.gemspec

@@ -16,9 +16,9 @@ Gem::Specification.new do |s|
   s.extra_rdoc_files = ["README.md"]
   s.extensions = ["ext/h1p/extconf.rb"]
   s.require_paths = ["lib"]
-  s.required_ruby_version = '>= 2.7'
+  s.required_ruby_version = '>= 3.0'
 
-  s.add_development_dependency  'rake-compiler',        '1.2.1'
+  s.add_development_dependency  'rake-compiler',        '1.2.3'
   s.add_development_dependency  'rake',               '~>13.0.6'
-  s.add_development_dependency  'minitest',           '~>5.17.0'
+  s.add_development_dependency  'minitest',           '~>5.18.0'
 end

data/lib/h1p/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module H1P
-  VERSION = '0.6.1'
+  VERSION = '1.1'
 end

data/test/test_h1p.rb

@@ -35,6 +35,14 @@ class SendResponseTest < MiniTest::Test
     assert_equal "HTTP/1.1 200 OK\r\nFoo: Bar\r\nX-Blah: 123\r\nContent-Length: 0\r\n\r\n", response
   end
 
+  def test_send_response_multiple_header_values
+    i, o = IO.pipe
+    H1P.send_response(o, { :Foo => ['Bar', 'Baz'], 'X-Blah' => 123 })
+    o.close
+    response = i.read
+    assert_equal "HTTP/1.1 200 OK\r\nFoo: Bar, Baz\r\nX-Blah: 123\r\nContent-Length: 0\r\n\r\n", response
+  end
+
   def test_send_response_with_body
     i, o = IO.pipe
     H1P.send_response(o, {}, "foobar")
@@ -97,7 +105,7 @@ class SendBodyChunkTest < MiniTest::Test
       len = H1P.send_body_chunk(o, chunk)
       o.close
     end
-    
+
     response = i.read
     assert_equal "#{chunk.bytesize.to_s(16)}\r\n#{chunk}\r\n", response
     assert_equal chunk.bytesize + chunk.bytesize.to_s(16).bytesize + 4, len

data/test/test_h1p_server.rb

@@ -88,6 +88,11 @@ class H1PServerTest < MiniTest::Test
     assert_raises(Error) { @parser.parse_headers }
   end
 
+  def test_invalid_method_string
+    @o << "\x02\x78\x83\x2 / HTTP/1.1\r\n\r\n"
+    assert_raises(Error) { @parser.parse_headers }
+  end
+
   def test_path_characters
     @o << "GET /äBçDé¤23~{@€ HTTP/1.1\r\n\r\n"
     headers = @parser.parse_headers
@@ -191,6 +196,11 @@ class H1PServerTest < MiniTest::Test
     assert_equal 'ddd', headers['c']
   end
 
+  def test_invalid_headers
+    @o << "GET / HTTP/1.1\r\n\foo\x02\x78\x83\x02: bar\n\r\n"
+    assert_raises(Error) { @parser.parse_headers }
+  end
+
   def test_headers_multiple_values
     @o << "GET / HTTP/1.1\r\nFoo: Bar\r\nfoo: baz\r\n\r\n"
     headers = @parser.parse_headers
@@ -471,7 +481,7 @@ class H1PServerTest < MiniTest::Test
       @o.close
     end
     def w.__write_method__; :backend_write; end
-    
+
     headers = @parser.parse_headers
     @parser.splice_body_to(w)
     w.close
@@ -492,7 +502,7 @@ class H1PServerTest < MiniTest::Test
       @o.close
     end
     def w.__write_method__; :backend_write; end
-    
+
     headers = @parser.parse_headers
     @parser.splice_body_to(w)
     w.close

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: h1p
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: '1.1'
 platform: ruby
 authors:
 - Sharon Rosner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-28 00:00:00.000000000 Z
+date: 2023-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.17.0
+        version: 5.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.17.0
+        version: 5.18.0
 description: 
 email: sharon@noteflakes.com
 executables: []
@@ -102,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="