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
Fix: redacted cart tokens and gift card codes in the webhook delivery log
Damian Legawiecd1cea8f6827c
diff --git a/spree/core/app/models/concerns/spree/webhook_payload_redaction.rb b/spree/core/app/models/concerns/spree/webhook_payload_redaction.rbindex 46025435df..8484a78e1f 100644--- a/spree/core/app/models/concerns/spree/webhook_payload_redaction.rb+++ b/spree/core/app/models/concerns/spree/webhook_payload_redaction.rb@@ -24,7 +24,11 @@ module Spree# Payment session secrets are gateway-agnostic: `external_client_secret` is# a core column and `external_data` is a free-form provider hash, so every# provider that stores a confirmation credential there is covered.+ #+ # `token` is the guest cart credential (`X-Spree-Token`), which a placed+ # order inherits; with it anyone can read and change the cart.SENSITIVE_PAYLOAD_KEYS = %w[+ tokenreset_tokenunsubscribe_tokenverification_token@@ -34,6 +38,13 @@ module Spreeephemeral_key_secret].freeze+ # A gift card's `code` is what a shopper redeems, so it is spendable by+ # whoever reads it. Only a gift card's own `code` is redacted — promotion,+ # country and channel codes elsewhere in a payload are not credentials.+ GIFT_CARD_CODE_KEY = 'code'+ GIFT_CARD_NODE = 'gift_card'+ GIFT_CARD_EVENT_PREFIX = 'gift_card.'+REDACTION_PLACEHOLDER = '[REDACTED]'# Separates the segments of a secret's path. Segments are escaped before@@ -59,9 +70,10 @@ module Spree# keyed by their dotted path under `data`def self.split(payload)secrets = {}+ gift_card_event = event_name_of(payload).start_with?(GIFT_CARD_EVENT_PREFIX)redacted = transform_data_hashes(payload) do |data|- redact(data, [ROOT_SEGMENT], secrets)+ redact(data, [ROOT_SEGMENT], secrets, gift_card_event)endsecrets.empty? ? [payload, {}] : [redacted, secrets]@@ -83,20 +95,20 @@ module Spree# Walks a hash replacing sensitive values, recording each one against its# path so two secrets sharing a key name (`client_secret` at the top level# and inside `external_data`) cannot overwrite one another.- def self.redact(node, path, secrets)+ def self.redact(node, path, secrets, gift_card_event = false)if node.is_a?(Array)- return node.each_with_index.map { |element, index| redact(element, path + [index.to_s], secrets) }+ return node.each_with_index.map { |element, index| redact(element, path + [index.to_s], secrets, gift_card_event) }endreturn node unless node.is_a?(Hash)node.to_h do |key, value|key_path = path + [key.to_s]- if sensitive?(key, value)+ if sensitive?(key, value) || gift_card_code?(key, value, path, gift_card_event)secrets[secret_key_for(key_path)] = value[key, REDACTION_PLACEHOLDER]else- [key, redact(value, key_path, secrets)]+ [key, redact(value, key_path, secrets, gift_card_event)]endendend@@ -128,11 +140,33 @@ module Spreeprivate_class_method :restoredef self.sensitive?(key, value)- SENSITIVE_PAYLOAD_KEYS.include?(key.to_s) && value.present? &&- !value.is_a?(Hash) && !value.is_a?(Array)+ SENSITIVE_PAYLOAD_KEYS.include?(key.to_s) && scalar?(value)endprivate_class_method :sensitive?+ # The `code` of a gift card: at the root of a gift card event's data, or+ # on a `gift_card` node nested in another record (an order or cart that+ # has one applied).+ def self.gift_card_code?(key, value, path, gift_card_event)+ return false unless key.to_s == GIFT_CARD_CODE_KEY && scalar?(value)+ return true if gift_card_event && path == [ROOT_SEGMENT]++ path.last == GIFT_CARD_NODE+ end+ private_class_method :gift_card_code?++ def self.scalar?(value)+ value.present? && !value.is_a?(Hash) && !value.is_a?(Array)+ end+ private_class_method :scalar?++ def self.event_name_of(payload)+ return '' unless payload.is_a?(Hash)++ (payload[:name] || payload['name']).to_s+ end+ private_class_method :event_name_of+# Applies +block+ to every `data` hash on the payload.## Both key forms are visited rather than only the first match: a payloaddiff --git a/spree/core/spec/models/concerns/spree/webhook_payload_redaction_spec.rb b/spree/core/spec/models/concerns/spree/webhook_payload_redaction_spec.rbindex c470da7e03..3e159e8f7f 100644--- a/spree/core/spec/models/concerns/spree/webhook_payload_redaction_spec.rb+++ b/spree/core/spec/models/concerns/spree/webhook_payload_redaction_spec.rb@@ -143,6 +143,42 @@ describe Spree::WebhookPayloadRedaction doexpect(secrets.keys).to eq(['data.client_secret'])end+ # The guest cart token lets whoever holds it read and change the cart,+ # so it must not sit in a log that `read_webhooks` can read.+ it 'redacts the guest cart token' do+ original = { name: 'cart.updated', data: { id: 'cart_1', token: 'guest-token' } }++ payload, secrets = described_class.split(original)++ expect(payload[:data][:token]).to eq(placeholder)+ expect(described_class.merge(payload, secrets)).to eq(original)+ end++ it "redacts a gift card event's code" do+ original = { name: 'gift_card.created', data: { id: 'gc_1', code: 'SPEND-ME' } }++ payload, secrets = described_class.split(original)++ expect(payload[:data][:code]).to eq(placeholder)+ expect(described_class.merge(payload, secrets)).to eq(original)+ end++ it 'redacts the code of a gift card applied to an order' do+ original = { name: 'order.completed', data: { id: 'or_1', gift_card: { id: 'gc_1', code: 'SPEND-ME' } } }++ payload, secrets = described_class.split(original)++ expect(payload[:data][:gift_card][:code]).to eq(placeholder)+ expect(described_class.merge(payload, secrets)).to eq(original)+ end++ # Promotion, country and channel codes are not credentials.+ it 'leaves other codes alone' do+ original = { name: 'order.completed', data: { id: 'or_1', code: 'R123', market: { code: 'eu' } } }++ expect(described_class.split(original)).to eq([original, {}])+ end+it 'returns the payload untouched when nothing is sensitive' dooriginal = { 'data' => { 'number' => 'R123' } }