Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.
Ruby b2b-commercee-commerceecommerceecommerce-apiecommerce-frameworkecommerce-platformheadlessheadless-commerceheadless-ecommercemarketplacemulti-tenantmulti-vendormulti-vendor-ecommerceopen-sourcespree-commerce
Replace custom SSRF protection with ssrf_filter gem (#13742)
Damian Legawiecdf1254d722ac
diff --git a/spree/api/app/jobs/spree/webhook_delivery_job.rb b/spree/api/app/jobs/spree/webhook_delivery_job.rbindex 4fca11fd81..da423cebfa 100644--- a/spree/api/app/jobs/spree/webhook_delivery_job.rb+++ b/spree/api/app/jobs/spree/webhook_delivery_job.rb@@ -6,10 +6,13 @@ module Spreeretry_on StandardError, wait: :polynomially_longer, attempts: 5- def perform(delivery_id, secret_key)+ # Accept optional second argument for backward compatibility with jobs+ # enqueued before this change was deployed.+ def perform(delivery_id, _deprecated_secret_key = nil)delivery = Spree::WebhookDelivery.find_by(id: delivery_id)return if delivery.nil?+ secret_key = delivery.webhook_endpoint.secret_keySpree::Webhooks::DeliverWebhook.call(delivery: delivery, secret_key: secret_key)endenddiff --git a/spree/api/app/services/spree/webhooks/deliver_webhook.rb b/spree/api/app/services/spree/webhooks/deliver_webhook.rbindex a7d19fb984..87d2315bb6 100644--- a/spree/api/app/services/spree/webhooks/deliver_webhook.rb+++ b/spree/api/app/services/spree/webhooks/deliver_webhook.rb@@ -1,6 +1,6 @@# frozen_string_literal: true-require 'net/http'+require 'ssrf_filter'require 'openssl'module Spree@@ -49,21 +49,21 @@ module Spreeprivatedef make_request- uri = URI.parse(@delivery.url)- http = Net::HTTP.new(uri.host, uri.port)- http.use_ssl = uri.scheme == 'https'- http.verify_mode = ssl_verify_mode- http.open_timeout = TIMEOUT- http.read_timeout = TIMEOUT-- request = Net::HTTP::Post.new(uri.request_uri)- request['Content-Type'] = 'application/json'- request['User-Agent'] = 'Spree-Webhooks/1.0'- request['X-Spree-Webhook-Signature'] = generate_signature- request['X-Spree-Webhook-Event'] = @delivery.event_name- request.body = @delivery.payload.to_json-- http.request(request)+ SsrfFilter.post(+ @delivery.url,+ headers: {+ 'Content-Type' => 'application/json',+ 'User-Agent' => 'Spree-Webhooks/1.0',+ 'X-Spree-Webhook-Signature' => generate_signature,+ 'X-Spree-Webhook-Event' => @delivery.event_name+ },+ body: @delivery.payload.to_json,+ http_options: {+ open_timeout: TIMEOUT,+ read_timeout: TIMEOUT,+ verify_mode: ssl_verify_mode+ }+ )enddef generate_signaturediff --git a/spree/api/app/subscribers/spree/webhook_event_subscriber.rb b/spree/api/app/subscribers/spree/webhook_event_subscriber.rbindex 321b8d6e97..9a6466fc70 100644--- a/spree/api/app/subscribers/spree/webhook_event_subscriber.rb+++ b/spree/api/app/subscribers/spree/webhook_event_subscriber.rb@@ -48,7 +48,7 @@ module Spree)# Queue the delivery job- Spree::WebhookDeliveryJob.perform_later(delivery.id, endpoint.secret_key)+ Spree::WebhookDeliveryJob.perform_later(delivery.id)rescue StandardError => eRails.logger.error "[Spree Webhooks] Error queuing delivery for endpoint #{endpoint.id}: #{e.message}"Rails.error.report(e)diff --git a/spree/api/spec/jobs/spree/webhook_delivery_job_spec.rb b/spree/api/spec/jobs/spree/webhook_delivery_job_spec.rbindex dd129c5fd8..1027adf572 100644--- a/spree/api/spec/jobs/spree/webhook_delivery_job_spec.rb+++ b/spree/api/spec/jobs/spree/webhook_delivery_job_spec.rb@@ -14,20 +14,20 @@ module Spreestub_request(:post, delivery.url).to_return(status: 200, body: '{}')end- it 'calls DeliverWebhook service' do+ it 'calls DeliverWebhook service with secret_key from endpoint' doexpect(Spree::Webhooks::DeliverWebhook).to receive(:call).with(delivery: delivery,secret_key: secret_key)- described_class.new.perform(delivery.id, secret_key)+ described_class.new.perform(delivery.id)endcontext 'when delivery does not exist' doit 'returns early without calling service' doexpect(Spree::Webhooks::DeliverWebhook).not_to receive(:call)- described_class.new.perform(-1, secret_key)+ described_class.new.perform(-1)endend@@ -37,7 +37,7 @@ module Spreeit 'returns early without calling service' doexpect(Spree::Webhooks::DeliverWebhook).not_to receive(:call)- described_class.new.perform(delivery.id, secret_key)+ described_class.new.perform(delivery.id)endendenddiff --git a/spree/api/spec/services/spree/webhooks/deliver_webhook_spec.rb b/spree/api/spec/services/spree/webhooks/deliver_webhook_spec.rbindex ba3cac8c79..fc4caaec45 100644--- a/spree/api/spec/services/spree/webhooks/deliver_webhook_spec.rb+++ b/spree/api/spec/services/spree/webhooks/deliver_webhook_spec.rb@@ -169,6 +169,23 @@ module Spreeexpect(delivery.response_body.length).to be <= 10_003 # 10_000 + '...'endend++ context 'when URL resolves to private IP (SSRF)' do+ before do+ delivery+ allow(SsrfFilter).to receive(:post).and_raise(SsrfFilter::PrivateIPAddress, 'URL resolves to a blocked internal address')+ allow(Rails.error).to receive(:report)+ end++ it 'marks delivery as failed with connection error' do+ described_class.call(delivery: delivery, secret_key: secret_key)++ delivery.reload+ expect(delivery.success).to be false+ expect(delivery.error_type).to eq('connection_error')+ expect(delivery.request_errors).to include('blocked internal address')+ end+ endendendenddiff --git a/spree/core/app/jobs/spree/images/save_from_url_job.rb b/spree/core/app/jobs/spree/images/save_from_url_job.rbindex 537eed0b1b..04f2014bac 100644--- a/spree/core/app/jobs/spree/images/save_from_url_job.rb+++ b/spree/core/app/jobs/spree/images/save_from_url_job.rb@@ -1,12 +1,15 @@require 'open-uri'require 'openssl'+require 'ssrf_filter'+require 'tempfile'module Spreemodule Imagesclass SaveFromUrlJob < ::Spree::BaseJobqueue_as Spree.queues.images- retry_on ActiveRecord::RecordInvalid, OpenURI::HTTPError, wait: :polynomially_longer, attempts: Spree::Config.images_save_from_url_job_attempts.to_i+ retry_on ActiveRecord::RecordInvalid, wait: :polynomially_longer, attempts: Spree::Config.images_save_from_url_job_attempts.to_idiscard_on URI::InvalidURIError+ discard_on SsrfFilter::Errordef perform(viewable_id, viewable_type, external_url, external_id = nil, position = nil)viewable = viewable_type.safe_constantize.find(viewable_id)@@ -29,34 +32,55 @@ module Spree# still trigger save! if position has changedimage.save! and return if image_already_saved?(image, external_url)- uri = URI.parse(external_url)- unless %w[http https].include?(uri.scheme)- raise URI::InvalidURIError, "Invalid URL scheme: #{uri.scheme}. Only http and https are allowed."- end-- file = uri.open(- 'User-Agent' => 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',- 'Accept' => 'image/avif,image/webp,image/apng,image/svg+xml,image/*,*/*;q=0.8',- 'Accept-Language' => 'en-US,en;q=0.9',- 'Accept-Encoding' => 'gzip, deflate, br',- 'Cache-Control' => 'no-cache',- 'Pragma' => 'no-cache',- read_timeout: 60,- ssl_verify_mode: OpenSSL::SSL::VERIFY_PEER,- redirect: true- )- filename = File.basename(uri.path)-- image.attachment.attach(io: file, filename: filename)- image.external_url = external_url- image.external_id = external_id if external_id.present? && image.respond_to?(:external_id)- image.save!+ download_and_attach_image(external_url, image, external_id)rescue ActiveStorage::IntegrityError => eraise e unless Rails.env.test?endprivate+ def download_and_attach_image(external_url, image, external_id)+ max_size = Spree::Config.max_image_download_size++ response = SsrfFilter.get(+ external_url,+ headers: {+ 'User-Agent' => 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36',+ 'Accept' => 'image/avif,image/webp,image/apng,image/svg+xml,image/*,*/*;q=0.8',+ 'Accept-Language' => 'en-US,en;q=0.9',+ 'Accept-Encoding' => 'gzip, deflate, br',+ 'Cache-Control' => 'no-cache',+ 'Pragma' => 'no-cache'+ },+ http_options: {+ read_timeout: 60,+ open_timeout: 30+ }+ )++ body = response.body+ if body.bytesize > max_size+ raise StandardError, "Image file size exceeds the maximum allowed size of #{max_size} bytes"+ end++ uri = URI.parse(external_url)+ filename = File.basename(uri.path)+ tempfile = Tempfile.new(['spree_image', File.extname(uri.path)], binmode: true)++ begin+ tempfile.write(body)+ tempfile.rewind++ image.attachment.attach(io: tempfile, filename: filename)+ image.external_url = external_url+ image.external_id = external_id if external_id.present? && image.respond_to?(:external_id)+ image.save!+ ensure+ tempfile.close+ tempfile.unlink+ end+ end+def image_already_saved?(image, external_url)image.persisted? && image.attachment.attached? && image.external_url.present? && external_url == image.external_urlenddiff --git a/spree/core/app/models/spree/webhook_endpoint.rb b/spree/core/app/models/spree/webhook_endpoint.rbindex c00e0d4ee7..3760b11001 100644--- a/spree/core/app/models/spree/webhook_endpoint.rb+++ b/spree/core/app/models/spree/webhook_endpoint.rb@@ -1,5 +1,8 @@# frozen_string_literal: true+require 'ssrf_filter'+require 'resolv'+module Spreeclass WebhookEndpoint < Spree.base_classhas_prefix_id :whe # Stripe: we_@@ -8,12 +11,15 @@ module Spreeinclude Spree::SingleStoreResource+ encrypts :secret_key, deterministic: true if Rails.configuration.active_record.encryption.include?(:primary_key)+belongs_to :store, class_name: 'Spree::Store'has_many :webhook_deliveries, class_name: 'Spree::WebhookDelivery', dependent: :destroy_asyncvalidates :store, :url, presence: truevalidates :url, format: { with: URI::DEFAULT_PARSER.make_regexp(%w[http https]), message: :invalid_url }validates :active, inclusion: { in: [true, false] }+ validate :url_must_not_resolve_to_private_ip, if: -> { url.present? && url_changed? }before_create :generate_secret_key@@ -51,5 +57,16 @@ module Spreedef generate_secret_keyself.secret_key ||= SecureRandom.hex(32)end++ def url_must_not_resolve_to_private_ip+ uri = URI.parse(url)+ blacklist = SsrfFilter::IPV4_BLACKLIST + SsrfFilter::IPV6_BLACKLIST+ addresses = Resolv.getaddresses(uri.host)+ if addresses.any? { |addr| blacklist.any? { |range| range.include?(IPAddr.new(addr)) } }+ errors.add(:url, :internal_address_not_allowed)+ end+ rescue URI::InvalidURIError, Resolv::ResolvError, IPAddr::InvalidAddressError, ArgumentError+ # URI format validation handles invalid URLs; DNS failures are not SSRF+ endendenddiff --git a/spree/core/config/locales/en.yml b/spree/core/config/locales/en.ymlindex 2a1c51afed..f21cae57cd 100644--- a/spree/core/config/locales/en.yml+++ b/spree/core/config/locales/en.yml@@ -363,6 +363,10 @@ en:cannot_destroy_if_attached_to_line_items: Cannot delete Variants that are added to placed Orders. In such cases, please discontinue them.must_supply_price_for_variant_or_master: Must supply price for variant or master price for product.no_master_variant_found_to_infer_price: No master variant found to infer price+ spree/webhook_endpoint:+ attributes:+ url:+ internal_address_not_allowed: must not point to an internal or private network addressspree/wished_item:attributes:variant:diff --git a/spree/core/lib/spree/core/configuration.rb b/spree/core/lib/spree/core/configuration.rbindex 81a641e2c1..c0eeb2e853 100644--- a/spree/core/lib/spree/core/configuration.rb+++ b/spree/core/lib/spree/core/configuration.rb@@ -47,6 +47,7 @@ module Spreepreference :expedited_exchanges_days_window, :integer, default: 14 # the amount of days the customer has to return their item after the expedited exchange is shipped in order to avoid being chargedpreference :geocode_addresses, :boolean, default: truepreference :images_save_from_url_job_attempts, :integer, default: 5+ preference :max_image_download_size, :integer, default: 20_971_520 # 20 MB in bytes# Preprocessed product image variant sizes at 2x retina resolution.# These variants are generated on upload to reduce runtime processing.diff --git a/spree/core/spec/jobs/spree/images/save_from_url_job_spec.rb b/spree/core/spec/jobs/spree/images/save_from_url_job_spec.rbindex b95bacef54..12567dde8d 100644--- a/spree/core/spec/jobs/spree/images/save_from_url_job_spec.rb+++ b/spree/core/spec/jobs/spree/images/save_from_url_job_spec.rb@@ -24,17 +24,12 @@ RSpec.describe Spree::Images::SaveFromUrlJob, type: :job doendcontext "when performing the job" do- let(:image_scope) { double('image_scope') }let(:image) { variant.images.last }- let(:file_double) { StringIO.new("imagecontent") }- let(:filename) { "bar_image.png" }- let(:uri_double) {- instance_double(URI::HTTPS, path: "/foo/bar_image.png", open: file_double)- }+ let(:response_body) { "imagecontent" }+ let(:response) { instance_double(Net::HTTPResponse, code: '200', body: response_body) }before do- allow(URI).to receive(:parse).with(external_url.strip).and_return(uri_double)- allow(uri_double).to receive(:scheme).and_return('https')+ allow(SsrfFilter).to receive(:get).and_return(response)endit "downloads and attaches image from the URL" do@@ -62,8 +57,7 @@ RSpec.describe Spree::Images::SaveFromUrlJob, type: :job doendit "does not re-download but triggers save!" do- expect(URI).not_to receive(:parse)- expect(URI).not_to receive(:open)+ expect(SsrfFilter).not_to receive(:get)expect { subject }.not_to change(image, :attachment)endend@@ -78,10 +72,32 @@ RSpec.describe Spree::Images::SaveFromUrlJob, type: :job dolet!(:image) { create(:image, viewable: variant) }it "does not download the image" do- expect(URI).not_to receive(:parse)- expect(URI).not_to receive(:open)+ expect(SsrfFilter).not_to receive(:get)expect { subject }.not_to change(image, :attachment)endend++ context 'when URL resolves to private IP (SSRF)' do+ before do+ allow(SsrfFilter).to receive(:get).and_raise(SsrfFilter::PrivateIPAddress, 'URL resolves to a blocked internal address')+ end++ it 'discards the job without downloading' do+ expect { subject }.not_to change(Spree::Image, :count)+ end+ end++ context 'when downloaded file exceeds max size' do+ let(:max_size) { 1024 }+ let(:response_body) { 'x' * (max_size + 1) }++ before do+ allow(Spree::Config).to receive(:max_image_download_size).and_return(max_size)+ end++ it 'raises an error about file size' do+ expect { subject }.to raise_error(StandardError, /exceeds the maximum allowed size/)+ end+ endendenddiff --git a/spree/core/spec/models/spree/webhook_endpoint_spec.rb b/spree/core/spec/models/spree/webhook_endpoint_spec.rbindex 8cbc892912..356f1fdfd5 100644--- a/spree/core/spec/models/spree/webhook_endpoint_spec.rb+++ b/spree/core/spec/models/spree/webhook_endpoint_spec.rb@@ -28,6 +28,13 @@ describe Spree::WebhookEndpoint, type: :model dowebhook_endpoint.url = 'ftp://example.com/webhooks'expect(webhook_endpoint).not_to be_validend++ it 'rejects urls resolving to private IPs' do+ allow(Resolv).to receive(:getaddresses).with('internal.example.com').and_return(['127.0.0.1'])+ webhook_endpoint.url = 'https://internal.example.com/webhooks'+ expect(webhook_endpoint).not_to be_valid+ expect(webhook_endpoint.errors[:url]).to include('must not point to an internal or private network address')+ endenddescribe 'active inclusion' dodiff --git a/spree/core/spree_core.gemspec b/spree/core/spree_core.gemspecindex 8b5a1a6d55..375f98743f 100644--- a/spree/core/spree_core.gemspec+++ b/spree/core/spree_core.gemspec@@ -67,4 +67,5 @@ Gem::Specification.new do |s|s.add_dependency 'ar_lazy_preload', '~> 2.0's.add_dependency 'bcrypt', '~> 3.1's.add_dependency 'sqids', '~> 0.2'+ s.add_dependency 'ssrf_filter', '~> 1.0'end