From 08803f05ec574236cbf2aea251e64fcdfa64eb5e Mon Sep 17 00:00:00 2001 From: Yun Wang Date: Fri, 13 Nov 2026 12:26:45 +0100 Subject: [PATCH] fix: limit decompressed webhook payloads to 10 MiB --- lib/getstream_ruby/client.rb | 1 + .../extensions/chat_extensions.rb | 22 ++++++++++++++++++ lib/getstream_ruby/generated/webhook.rb | 18 ++++++++++++-- spec/chat_extensions_spec.rb | 14 +++++++++++ spec/webhook_spec.rb | 10 ++++++++ .../_invalid/oversized_compression/body.gz | Bin 0 -> 20551 bytes .../_invalid/oversized_compression/body.json | 1 + .../oversized_compression/expected.json | 1 + .../oversized_compression/signature.txt | 1 + .../sns_notification.txt | 1 + .../oversized_compression/sqs_body.txt | 1 + .../sqs_body_uncompressed.txt | 1 + 12 files changed, 69 insertions(+), 2 deletions(-) create mode 100644 lib/getstream_ruby/extensions/chat_extensions.rb create mode 100644 spec/chat_extensions_spec.rb create mode 100644 test/fixtures/webhooks/_invalid/oversized_compression/body.gz create mode 100644 test/fixtures/webhooks/_invalid/oversized_compression/body.json create mode 100644 test/fixtures/webhooks/_invalid/oversized_compression/expected.json create mode 100644 test/fixtures/webhooks/_invalid/oversized_compression/signature.txt create mode 100644 test/fixtures/webhooks/_invalid/oversized_compression/sns_notification.txt create mode 100644 test/fixtures/webhooks/_invalid/oversized_compression/sqs_body.txt create mode 100644 test/fixtures/webhooks/_invalid/oversized_compression/sqs_body_uncompressed.txt diff --git a/lib/getstream_ruby/client.rb b/lib/getstream_ruby/client.rb index 028a822..a1c3595 100644 --- a/lib/getstream_ruby/client.rb +++ b/lib/getstream_ruby/client.rb @@ -15,6 +15,7 @@ require_relative 'generated/chat_client' require_relative 'generated/video_client' require_relative 'extensions/moderation_extensions' +require_relative 'extensions/chat_extensions' require_relative 'generated/feed' require_relative 'generated/webhook' require_relative 'generated/models/api_error' diff --git a/lib/getstream_ruby/extensions/chat_extensions.rb b/lib/getstream_ruby/extensions/chat_extensions.rb new file mode 100644 index 0000000..a2af4c5 --- /dev/null +++ b/lib/getstream_ruby/extensions/chat_extensions.rb @@ -0,0 +1,22 @@ +# frozen_string_literal: true + +module GetStream + + module Generated + + class ChatClient + + # The generated name of the fork message map method changes from fork_message_i_ds to + # fork_message_ids in a later regeneration. Keep both names working on either side of it. + if method_defined?(:fork_message_i_ds) && !method_defined?(:fork_message_ids) + alias fork_message_ids fork_message_i_ds + elsif method_defined?(:fork_message_ids) && !method_defined?(:fork_message_i_ds) + # @deprecated Use {#fork_message_ids} instead. + alias fork_message_i_ds fork_message_ids + end + + end + + end + +end diff --git a/lib/getstream_ruby/generated/webhook.rb b/lib/getstream_ruby/generated/webhook.rb index b404e21..0a5522e 100644 --- a/lib/getstream_ruby/generated/webhook.rb +++ b/lib/getstream_ruby/generated/webhook.rb @@ -3,6 +3,7 @@ require 'base64' require 'json' require 'openssl' +require 'stringio' require 'time' require 'zlib' require_relative 'models/activity_added_event' @@ -234,6 +235,14 @@ def initialize(type:, created_at: nil, raw: {}) GZIP_MAGIC = "\x1F\x8B".b.freeze private_constant :GZIP_MAGIC + class << self + # Caps the decompressed size of a gzip webhook body. gunzip_payload runs + # before the signature check, so without a cap an unsigned gzip bomb could + # exhaust memory. Raise it if your events are larger. + attr_accessor :max_payload_bytes + end + self.max_payload_bytes = 10 * 1024 * 1024 + # Webhook event type constants EVENT_TYPE_WILDCARD = '*' EVENT_TYPE_APPEAL_ACCEPTED = 'appeal.accepted' @@ -887,14 +896,19 @@ def self.verify_signature(body, signature, secret) # @param body [String] raw body (binary-safe) # @return [String] decompressed body, or the original body if not gzip-prefixed # @raise [InvalidWebhookError] if body has the gzip magic prefix but - # isn't a valid gzip stream + # isn't a valid gzip stream, or decompresses to more than + # {max_payload_bytes} def self.gunzip_payload(body) raise InvalidWebhookError, "#{InvalidWebhookError::INVALID_JSON}: body must be a String" unless body.is_a?(String) bytes = body.b return bytes if bytes.bytesize < 2 || bytes.byteslice(0, 2) != GZIP_MAGIC - Zlib.gunzip(bytes) + limit = max_payload_bytes + out = Zlib::GzipReader.wrap(StringIO.new(bytes)) { |gz| gz.read(limit + 1) } || ''.b + raise InvalidWebhookError, "#{InvalidWebhookError::GZIP_FAILED}: payload exceeds #{limit} bytes" if out.bytesize > limit + + out rescue Zlib::Error => e raise InvalidWebhookError, "#{InvalidWebhookError::GZIP_FAILED}: #{e.message}" end diff --git a/spec/chat_extensions_spec.rb b/spec/chat_extensions_spec.rb new file mode 100644 index 0000000..0d0f67d --- /dev/null +++ b/spec/chat_extensions_spec.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe GetStream::Generated::ChatClient do + + it 'answers to fork_message_ids and fork_message_i_ds with the same method' do + + names = %i[fork_message_ids fork_message_i_ds].map { |name| described_class.instance_method(name).original_name } + expect(names.uniq.size).to eq(1) + + end + +end diff --git a/spec/webhook_spec.rb b/spec/webhook_spec.rb index c5cf7f4..c68343b 100644 --- a/spec/webhook_spec.rb +++ b/spec/webhook_spec.rb @@ -1774,6 +1774,16 @@ def neg_dir(name) end + it 'raises on gzip body over the size cap' do + + skip 'fixtures not present' unless File.directory?(WEBHOOK_FIXTURE_ROOT) + + body = File.binread(File.join(neg_dir('oversized_compression'), 'body.gz')) + err_class = StreamChat::Webhook::InvalidWebhookError + expect { StreamChat::Webhook.gunzip_payload(body) }.to raise_error(err_class, /payload exceeds/) + + end + it 'raises on bad base64 (downstream parse failure)' do # Per CHA-3071 wire format: decode_sqs_payload falls back to raw bytes diff --git a/test/fixtures/webhooks/_invalid/oversized_compression/body.gz b/test/fixtures/webhooks/_invalid/oversized_compression/body.gz new file mode 100644 index 0000000000000000000000000000000000000000..78386cbfeae45c22abd71d8c66f55f610a1d0c22 GIT binary patch literal 20551 zcmeIzp-O`R7zNOOS_B7TT~V7h?WIH@BxO153s7qqG7>cFo-(z4K5c9 zo`o?6_rk{g{-hcoVsXDSTE=g$KQA}$-XD+u z^tF4n9{-d|@M&79iA%OmSL19Y=nt@f%8=p`C*T?2AsC-eB}f4ZRE89nP=Epyh|i}I zqyPmfLyAi%KmiKG=Tiw%fC7~v#U&J=00rXnsRSuNfy$8L5(-d&0`d7&f)t=YWk_)e z1t>s)_*Cm1Svp)%8=p` X3Q*wRD{we@8_$N<$-&KNI3K