brotli 0.9.2 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 035e04e32804b36b5525cf4ba7688e19a199288e0056fcfceeeac67f11f72c9f
-  data.tar.gz: 8ce5e925a781060c0d46dfebd69beb367c62622fb808ef247906e0bf2229aaa8
+  metadata.gz: 69c5177d348df73fc4a46b6885e0432228c9050a0c003daa70ac19ec8a161c33
+  data.tar.gz: 80b2f49422f8e77dec0c297f2c74e5d3ee8f326f06f958c86d215f4391150527
 SHA512:
-  metadata.gz: 70c2bdf0f5028d80f5f0c578f89bf2c6818de1c9c4f795fe61aeeffbbcf570353d97699ce02f9e44e713f54e34fd9c0a745d9b6f3ef9e7f9b62e5ffc6f1b0707
-  data.tar.gz: dd17edfde50109928ca623452044288b6d369cd6a29706727248623f8ad6d03ea89857fd668e67ca01b22a1baf39b27fbd47c86635a2455ec1c1d2400c4c5d77
+  metadata.gz: 4574d6aaeecfcd073d3bb8bdfa21a766f71843f52d9e7e8446549fb93748a79775a7f296dcf2756e28b796daaef229d696c900d68e159c0dc3cee74357c1b1da
+  data.tar.gz: 86002231379c75386cce7da64fadae167c04afb5d635fcc46d1bad0b6137d4921e65736463c8585d6c7c8f6b3818db1a453bf1c7091ab59d482c9d7940f270ae

data/README.md

@@ -192,6 +192,28 @@ You usually do not need `output_buffer_limit:` when:
 - you are using `Brotli::Reader`, which already handles incremental buffering for IO-style reads
 - you are happy for each `#process` call to return all currently available output
 
+### Large-window Brotli
+
+RFC 9841 large-window streams are rejected by default. Applications that require
+this extension, such as readers of the PDF Association Brotli extension, can opt
+in for a single decoder:
+
+```ruby
+Brotli.inflate(compressed, large_window: true)
+Brotli::Reader.new(io, large_window: true)
+Brotli::Decompressor.new(large_window: true)
+```
+
+The option does not enable shared dictionaries or a framing format and does not
+change the default for other decoders.
+
+**Memory warning:** with `large_window: true`, the stream header may request a
+window of up to 1 GiB (2^30 bytes), and the decoder allocates its ring buffer
+to match. A small untrusted input can therefore make a single decoder reserve
+close to 1 GiB. `output_buffer_limit:` does not bound this allocation. Enable
+the option only for trusted input, or enforce a memory limit at the process or
+container level.
+
 See test/brotli_test.rb for more examples.
 
 ## Development

data/ext/brotli/brotli.c

@@ -3,6 +3,7 @@
 static VALUE rb_eBrotli;
 static ID id_cmp;
 static ID id_dictionary;
+static ID id_large_window;
 static ID id_font;
 static ID id_generic;
 static ID id_lgblock;
@@ -144,6 +145,13 @@ brotli_inflate_take_result(VALUE arg)
     return rb_str_new(args->buffer->ptr, args->buffer->used);
 }
 
+static VALUE
+brotli_inflate_run(VALUE arg)
+{
+    rb_thread_call_without_gvl(brotli_inflate_no_gvl, (void *)arg, NULL, NULL);
+    return Qnil;
+}
+
 static VALUE
 brotli_inflate(int argc, VALUE *argv, VALUE self)
 {
@@ -153,6 +161,7 @@ brotli_inflate(int argc, VALUE *argv, VALUE self)
     VALUE dict = Qnil;
     const char *error = NULL;
     brotli_inflate_args_t args = {0};
+    int state = 0;
 
     (void)self;
 
@@ -178,6 +187,12 @@ brotli_inflate(int argc, VALUE *argv, VALUE self)
     }
     args.r = BROTLI_DECODER_RESULT_ERROR;
 
+    if (RTEST(brotli_hash_lookup(opts, id_large_window)) &&
+        !BrotliDecoderSetParameter(args.s, BROTLI_DECODER_PARAM_LARGE_WINDOW, 1)) {
+        brotli_inflate_cleanup(&args);
+        rb_raise(rb_eBrotli, "Failed to enable large-window decompression");
+    }
+
     if (!NIL_P(dict)) {
         args.dict = (uint8_t*)RSTRING_PTR(dict);
         args.dict_len = (size_t)RSTRING_LEN(dict);
@@ -186,9 +201,18 @@ brotli_inflate(int argc, VALUE *argv, VALUE self)
         args.dict_len = 0;
     }
 
-    rb_thread_call_without_gvl(brotli_inflate_no_gvl, &args, NULL, NULL);
+    /*
+     * rb_thread_call_without_gvl() handles pending interrupts (Thread#raise,
+     * Timeout, signals) around the worker and may raise from there. Catch it
+     * so the decoder state and output buffer are released before re-raising.
+     */
+    rb_protect(brotli_inflate_run, (VALUE)&args, &state);
     RB_GC_GUARD(str);
     RB_GC_GUARD(dict);
+    if (state) {
+        brotli_inflate_cleanup(&args);
+        rb_jump_tag(state);
+    }
 
     /* Check before args.r: a failed final append leaves r at SUCCESS. */
     if (args.oom) {
@@ -197,7 +221,6 @@ brotli_inflate(int argc, VALUE *argv, VALUE self)
     }
 
     if (args.r == BROTLI_DECODER_RESULT_SUCCESS) {
-        int state = 0;
         value = rb_protect(brotli_inflate_take_result, (VALUE)&args, &state);
         if (state) {
             brotli_inflate_cleanup(&args);
@@ -406,6 +429,13 @@ brotli_deflate_take_result(VALUE arg)
     return rb_str_new(args->buffer->ptr, args->buffer->used);
 }
 
+static VALUE
+brotli_deflate_run(VALUE arg)
+{
+    rb_thread_call_without_gvl(brotli_deflate_no_gvl, (void *)arg, NULL, NULL);
+    return Qnil;
+}
+
 static VALUE
 brotli_deflate(int argc, VALUE *argv, VALUE self)
 {
@@ -416,6 +446,7 @@ brotli_deflate(int argc, VALUE *argv, VALUE self)
     brotli_deflate_args_t args = {0};
     size_t max_compressed_size;
     const char *err;
+    int state = 0;
 
     (void)self;
 
@@ -465,15 +496,19 @@ brotli_deflate(int argc, VALUE *argv, VALUE self)
         }
     }
 
-    rb_thread_call_without_gvl(brotli_deflate_no_gvl, &args, NULL, NULL);
+    /* See brotli_inflate: an interrupt may raise out of the GVL release. */
+    rb_protect(brotli_deflate_run, (VALUE)&args, &state);
     RB_GC_GUARD(str);
     RB_GC_GUARD(dict);
+    if (state) {
+        brotli_deflate_cleanup(&args);
+        rb_jump_tag(state);
+    }
     if (args.oom) {
         brotli_deflate_cleanup(&args);
         rb_raise(rb_eNoMemError, "failed to allocate compression buffer");
     }
     if (args.finished == BROTLI_TRUE) {
-        int state = 0;
         value = rb_protect(brotli_deflate_take_result, (VALUE)&args, &state);
         if (state) {
             brotli_deflate_cleanup(&args);
@@ -971,6 +1006,10 @@ rb_decompressor_initialize(int argc, VALUE* argv, VALUE self)
     rb_scan_args(argc, argv, "01", &opts);
     TypedData_Get_Struct(self, brotli_decompressor_t, &brotli_decompressor_data_type, br);
     brotli_decompressor_reset(self, br);
+    if (RTEST(brotli_hash_lookup(opts, id_large_window)) &&
+        !BrotliDecoderSetParameter(br->state, BROTLI_DECODER_PARAM_LARGE_WINDOW, 1)) {
+        rb_raise(rb_eBrotli, "Failed to enable large-window decompression");
+    }
     brotli_decompressor_attach_dictionary(br, opts);
 
     return self;
@@ -1216,6 +1255,7 @@ Init_brotli(void)
     rb_define_singleton_method(rb_mBrotli, "version", brotli_version, 0);
     id_cmp = rb_intern("<=>");
     id_dictionary = rb_intern("dictionary");
+    id_large_window = rb_intern("large_window");
     id_font = rb_intern("font");
     id_generic = rb_intern("generic");
     id_lgblock = rb_intern("lgblock");

data/lib/brotli/version.rb

@@ -1,3 +1,3 @@
 module Brotli
-  VERSION = '0.9.2'
+  VERSION = '0.9.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: brotli
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors:
 - miyucy