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
Security hardening: Add 8 API v3 improvements (#13738)
Damian Legawiecdd48dcb1e768
diff --git a/spree/api/app/controllers/concerns/spree/api/v3/api_key_authentication.rb b/spree/api/app/controllers/concerns/spree/api/v3/api_key_authentication.rbindex 2ae1e54480..bd1c5a36a5 100644--- a/spree/api/app/controllers/concerns/spree/api/v3/api_key_authentication.rb+++ b/spree/api/app/controllers/concerns/spree/api/v3/api_key_authentication.rb@@ -68,7 +68,7 @@ module Spree## @return [String, nil] the API key tokendef extract_api_key- request.headers['X-Spree-Api-Key'].presence || params[:api_key]+ request.headers['X-Spree-Api-Key'].presenceendendenddiff --git a/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb b/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rbindex 16043fe85e..0935e915fb 100644--- a/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb+++ b/spree/api/app/controllers/concerns/spree/api/v3/error_handler.rb@@ -12,6 +12,7 @@ module Spreeaccess_denied: 'access_denied',invalid_token: 'invalid_token',invalid_provider: 'invalid_provider',+ current_password_invalid: 'current_password_invalid',# Resource errorsrecord_not_found: 'record_not_found',diff --git a/spree/api/app/controllers/concerns/spree/api/v3/jwt_authentication.rb b/spree/api/app/controllers/concerns/spree/api/v3/jwt_authentication.rbindex c81ca0b4a4..e6e2f22f2c 100644--- a/spree/api/app/controllers/concerns/spree/api/v3/jwt_authentication.rb+++ b/spree/api/app/controllers/concerns/spree/api/v3/jwt_authentication.rb@@ -82,7 +82,10 @@ module Spreeenddef jwt_secret- Rails.application.credentials.jwt_secret_key || ENV['JWT_SECRET_KEY'] || Rails.application.secret_key_base+ Spree::Api::Config[:jwt_secret_key].presence ||+ Rails.application.credentials.jwt_secret_key ||+ ENV['JWT_SECRET_KEY'] ||+ Rails.application.secret_key_baseenddef jwt_expirationdiff --git a/spree/api/app/controllers/concerns/spree/api/v3/security_headers.rb b/spree/api/app/controllers/concerns/spree/api/v3/security_headers.rbindex 3f882cc4f8..2aadb32312 100644--- a/spree/api/app/controllers/concerns/spree/api/v3/security_headers.rb+++ b/spree/api/app/controllers/concerns/spree/api/v3/security_headers.rb@@ -14,6 +14,9 @@ module Spreeresponse.headers['X-Content-Type-Options'] = 'nosniff'response.headers['X-Frame-Options'] = 'DENY'response.headers['X-Request-Id'] = request.request_id+ response.headers['Referrer-Policy'] = 'strict-origin-when-cross-origin'+ response.headers['Permissions-Policy'] = 'camera=(), microphone=(), geolocation=()'+ response.headers['Strict-Transport-Security'] = 'max-age=31536000; includeSubDomains' if request.ssl?response.headers.delete('X-Powered-By')response.headers.delete('Server')enddiff --git a/spree/api/app/controllers/spree/api/v3/admin/base_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/base_controller.rbnew file mode 100644index 0000000000..8a7ccd93b8--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/admin/base_controller.rb@@ -0,0 +1,19 @@+module Spree+ module Api+ module V3+ module Admin+ class BaseController < Spree::Api::V3::BaseController+ # Require secret API key for all Admin API requests+ before_action :authenticate_secret_key!++ protected++ # Override JWT audience to require admin tokens+ def expected_audience+ JWT_AUDIENCE_ADMIN+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/admin/resource_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/resource_controller.rbnew file mode 100644index 0000000000..d014b4912d--- /dev/null+++ b/spree/api/app/controllers/spree/api/v3/admin/resource_controller.rb@@ -0,0 +1,19 @@+module Spree+ module Api+ module V3+ module Admin+ class ResourceController < Spree::Api::V3::ResourceController+ # Require secret API key for all Admin API requests+ before_action :authenticate_secret_key!++ protected++ # Override JWT audience to require admin tokens+ def expected_audience+ JWT_AUDIENCE_ADMIN+ end+ end+ end+ end+ end+enddiff --git a/spree/api/app/controllers/spree/api/v3/base_controller.rb b/spree/api/app/controllers/spree/api/v3/base_controller.rbindex 8d3a13ea76..3afed4e33b 100644--- a/spree/api/app/controllers/spree/api/v3/base_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/base_controller.rb@@ -13,9 +13,28 @@ module Spreeinclude Spree::Api::V3::HttpCachinginclude Spree::Api::V3::SecurityHeadersinclude Spree::Api::V3::ResourceSerializer+ include Spree::Api::V3::RateLimitHeadersinclude Spree::Api::V3::Idempotentinclude Pagy::Method+ RATE_LIMIT_RESPONSE = -> {+ limit = Spree::Api::Config[:rate_limit_per_key]+ window = Spree::Api::Config[:rate_limit_window]+ body = { error: { code: 'rate_limit_exceeded', message: 'Too many requests. Please retry later.' } }+ headers = {+ 'Content-Type' => 'application/json',+ 'Retry-After' => window.to_s,+ 'X-RateLimit-Limit' => limit.to_s,+ 'X-RateLimit-Remaining' => '0'+ }+ [429, headers, [body.to_json]]+ }++ rate_limit to: Spree::Api::Config[:rate_limit_per_key], within: Spree::Api::Config[:rate_limit_window].seconds,+ store: Rails.cache,+ by: -> { request.headers['X-Spree-Api-Key'] || request.remote_ip },+ with: RATE_LIMIT_RESPONSE+# Optional JWT authentication by defaultbefore_action :authenticate_userdiff --git a/spree/api/app/controllers/spree/api/v3/store/base_controller.rb b/spree/api/app/controllers/spree/api/v3/store/base_controller.rbindex e160e640d7..fd330eef7f 100644--- a/spree/api/app/controllers/spree/api/v3/store/base_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/base_controller.rb@@ -3,27 +3,6 @@ module Spreemodule V3module Storeclass BaseController < Spree::Api::V3::BaseController- include Spree::Api::V3::RateLimitHeaders-- RATE_LIMIT_RESPONSE = -> {- limit = Spree::Api::Config[:rate_limit_per_key]- window = Spree::Api::Config[:rate_limit_window]- body = { error: { code: 'rate_limit_exceeded', message: 'Too many requests. Please retry later.' } }- headers = {- 'Content-Type' => 'application/json',- 'Retry-After' => window.to_s,- 'X-RateLimit-Limit' => limit.to_s,- 'X-RateLimit-Remaining' => '0'- }- [429, headers, [body.to_json]]- }-- # Global rate limit per publishable API key- rate_limit to: Spree::Api::Config[:rate_limit_per_key], within: Spree::Api::Config[:rate_limit_window].seconds,- store: Rails.cache,- by: -> { request.headers['X-Spree-Api-Key'] || request.remote_ip },- with: RATE_LIMIT_RESPONSE-# Require publishable API key for all Store API requestsbefore_action :authenticate_api_key!enddiff --git a/spree/api/app/controllers/spree/api/v3/store/customer/account_controller.rb b/spree/api/app/controllers/spree/api/v3/store/customer/account_controller.rbindex dcc6cc92af..84a2535820 100644--- a/spree/api/app/controllers/spree/api/v3/store/customer/account_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/customer/account_controller.rb@@ -13,7 +13,17 @@ module Spree# PATCH /api/v3/store/customerdef update- if current_user.update(permitted_params)+ if sensitive_update? && !valid_current_password?+ return render_error(+ code: ErrorHandler::ERROR_CODES[:current_password_invalid],+ message: Spree.t(:current_password_invalid, scope: :api),+ status: :unprocessable_content+ )+ end++ update_params = permitted_params.except(:current_password)++ if current_user.update(update_params)render json: serialize_resource(current_user)elserender_errors(current_user.errors)@@ -28,7 +38,26 @@ module Spreedef permitted_paramsparams.permit(:email, :password, :password_confirmation, :first_name, :last_name,- :accepts_email_marketing, :phone)+ :accepts_email_marketing, :phone, :current_password)+ end++ private++ def sensitive_update?+ (params[:email].present? && params[:email] != current_user.email) ||+ params[:password].present?+ end++ def valid_current_password?+ return false if params[:current_password].blank?++ if current_user.respond_to?(:valid_password?)+ current_user.valid_password?(params[:current_password])+ elsif current_user.respond_to?(:authenticate)+ current_user.authenticate(params[:current_password]).present?+ else+ false+ endendendenddiff --git a/spree/api/app/controllers/spree/api/v3/store/resource_controller.rb b/spree/api/app/controllers/spree/api/v3/store/resource_controller.rbindex 55fc84e6b1..188238daf9 100644--- a/spree/api/app/controllers/spree/api/v3/store/resource_controller.rb+++ b/spree/api/app/controllers/spree/api/v3/store/resource_controller.rb@@ -3,16 +3,6 @@ module Spreemodule V3module Storeclass ResourceController < Spree::Api::V3::ResourceController- include Spree::Api::V3::RateLimitHeaders-- RATE_LIMIT_RESPONSE = Store::BaseController::RATE_LIMIT_RESPONSE-- # Global rate limit per publishable API key- rate_limit to: Spree::Api::Config[:rate_limit_per_key], within: Spree::Api::Config[:rate_limit_window].seconds,- store: Rails.cache,- by: -> { request.headers['X-Spree-Api-Key'] || request.remote_ip },- with: RATE_LIMIT_RESPONSE-# Require publishable API key for all Store API requestsbefore_action :authenticate_api_key!enddiff --git a/spree/api/app/services/spree/webhooks/deliver_webhook.rb b/spree/api/app/services/spree/webhooks/deliver_webhook.rbindex 87d2315bb6..c5cbbe3b08 100644--- a/spree/api/app/services/spree/webhooks/deliver_webhook.rb+++ b/spree/api/app/services/spree/webhooks/deliver_webhook.rb@@ -55,6 +55,7 @@ module Spree'Content-Type' => 'application/json','User-Agent' => 'Spree-Webhooks/1.0','X-Spree-Webhook-Signature' => generate_signature,+ 'X-Spree-Webhook-Timestamp' => webhook_timestamp.to_s,'X-Spree-Webhook-Event' => @delivery.event_name},body: @delivery.payload.to_json,@@ -68,13 +69,18 @@ module Spreedef generate_signaturepayload_json = @delivery.payload.to_json- OpenSSL::HMAC.hexdigest('SHA256', @secret_key, payload_json)+ OpenSSL::HMAC.hexdigest('SHA256', @secret_key, "#{webhook_timestamp}.#{payload_json}")+ end++ def webhook_timestamp+ @webhook_timestamp ||= Time.current.to_ienddef ssl_verify_modeif Spree::Api::Config.webhooks_verify_sslOpenSSL::SSL::VERIFY_PEERelse+ Rails.logger.warn('[Spree] Webhook SSL verification is disabled. This is not recommended for production environments.')OpenSSL::SSL::VERIFY_NONEendenddiff --git a/spree/api/config/locales/en.yml b/spree/api/config/locales/en.ymlindex 44ee4a534d..407b18c51d 100644--- a/spree/api/config/locales/en.yml+++ b/spree/api/config/locales/en.yml@@ -6,6 +6,7 @@ en:invalid_api_key: Invalid API key (%{key}) specified.invalid_resource: Invalid resource. Please fix errors and try again.invalid_taxonomy_id: Invalid taxonomy id.+ current_password_invalid: Current password is invalid or missingmust_specify_api_key: You must specify an API key.negative_quantity: quantity is negativeorder:diff --git a/spree/api/lib/spree/api/configuration.rb b/spree/api/lib/spree/api/configuration.rbindex a4701c4af5..ae5e68c505 100644--- a/spree/api/lib/spree/api/configuration.rb+++ b/spree/api/lib/spree/api/configuration.rb@@ -10,6 +10,7 @@ module Spreepreference :api_v2_per_page_limit, :integer, default: 500preference :jwt_expiration, :integer, default: 3600 # 1 hour in seconds+ preference :jwt_secret_key, :string, default: nil# Rate limitingpreference :rate_limit_per_key, :integer, default: 300 # per publishable API keydiff --git a/spree/api/lib/spree/api/engine.rb b/spree/api/lib/spree/api/engine.rbindex 9e454178af..ef5d6c6b3b 100644--- a/spree/api/lib/spree/api/engine.rb+++ b/spree/api/lib/spree/api/engine.rb@@ -24,6 +24,21 @@ module SpreeSpree.subscribers << Spree::WebhookEventSubscriberend+ # Warn in production if no dedicated JWT secret key is configured+ config.after_initialize do+ next unless Rails.env.production?++ if Spree::Api::Config[:jwt_secret_key].blank? &&+ Rails.application.credentials.jwt_secret_key.blank? &&+ ENV['JWT_SECRET_KEY'].blank?+ Rails.logger.warn(+ '[Spree] No dedicated JWT secret key configured. Falling back to Rails.application.secret_key_base. ' \+ 'Set Spree::Api::Config[:jwt_secret_key], Rails credentials jwt_secret_key, or ENV["JWT_SECRET_KEY"] ' \+ 'for improved security.'+ )+ end+ end+def self.root@root ||= Pathname.new(File.expand_path('../../..', __dir__))enddiff --git a/spree/api/lib/spree/api/testing_support/v3/base.rb b/spree/api/lib/spree/api/testing_support/v3/base.rbindex 2a325c8124..a7557a123e 100644--- a/spree/api/lib/spree/api/testing_support/v3/base.rb+++ b/spree/api/lib/spree/api/testing_support/v3/base.rb@@ -13,7 +13,10 @@ module Spreeaud: audience,exp: Time.current.to_i + expiration}- secret = Rails.application.credentials.jwt_secret_key || ENV['JWT_SECRET_KEY'] || Rails.application.secret_key_base+ secret = Spree::Api::Config[:jwt_secret_key].presence ||+ Rails.application.credentials.jwt_secret_key ||+ ENV['JWT_SECRET_KEY'] ||+ Rails.application.secret_key_baseJWT.encode(payload, secret, 'HS256')endend@@ -47,6 +50,26 @@ shared_context 'API v3 Store guest' dolet(:headers) { api_key_headers }end+shared_context 'API v3 Admin' do+ let(:store) { @default_store || create(:store, default: true) }+ let(:secret_api_key) { create(:api_key, :secret, store: store) }+ let(:api_key_headers) { { 'x-spree-api-key' => secret_api_key.plaintext_token } }++ let(:admin_user) { create(:admin_user) }+ let(:admin_jwt_token) { Spree::Api::V3::TestingSupport.generate_jwt(admin_user, audience: Spree::Api::V3::JwtAuthentication::JWT_AUDIENCE_ADMIN) }+ let(:bearer_headers) { api_key_headers.merge('Authorization' => "Bearer #{admin_jwt_token}") }++ before do+ allow_any_instance_of(Spree::Api::V3::BaseController).to receive(:current_store).and_return(store)+ end+end++shared_context 'API v3 Admin authenticated' do+ include_context 'API v3 Admin'++ let(:headers) { bearer_headers }+end+# Shared examples for common response patternsshared_examples 'returns 200 OK' doit 'returns 200 status' dodiff --git a/spree/api/spec/controllers/concerns/spree/api/v3/rate_limiting_spec.rb b/spree/api/spec/controllers/concerns/spree/api/v3/rate_limiting_spec.rbindex e88293d395..2554469b59 100644--- a/spree/api/spec/controllers/concerns/spree/api/v3/rate_limiting_spec.rb+++ b/spree/api/spec/controllers/concerns/spree/api/v3/rate_limiting_spec.rb@@ -14,7 +14,7 @@ RSpec.describe 'Rate Limiting', type: :controller dodescribe 'rate limit response format' doit 'returns JSON error with rate_limit_exceeded code' do- response_proc = Spree::Api::V3::Store::BaseController::RATE_LIMIT_RESPONSE+ response_proc = Spree::Api::V3::BaseController::RATE_LIMIT_RESPONSEstatus, headers, body = response_proc.callexpect(status).to eq(429)diff --git a/spree/api/spec/controllers/spree/api/v3/admin/base_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/base_controller_spec.rbnew file mode 100644index 0000000000..f70d1a43ae--- /dev/null+++ b/spree/api/spec/controllers/spree/api/v3/admin/base_controller_spec.rb@@ -0,0 +1,145 @@+require 'spec_helper'++# Anonymous controller to test Admin::BaseController authentication and audience enforcement+class Spree::Api::V3::Admin::TestController < Spree::Api::V3::Admin::BaseController+ def index+ render json: { ok: true }+ end+end++RSpec.describe Spree::Api::V3::Admin::BaseController, type: :controller do+ controller(Spree::Api::V3::Admin::TestController) do+ def index+ if current_user+ render json: { ok: true, user_id: current_user.id }+ else+ render json: { ok: true }+ end+ end+ end++ render_views++ include_context 'API v3 Admin'++ before do+ routes.draw { get 'index' => 'spree/api/v3/admin/test#index' }+ end++ describe 'secret API key authentication' do+ context 'with valid secret API key' do+ before { request.headers['X-Spree-Api-Key'] = secret_api_key.plaintext_token }++ it 'returns 200' do+ get :index++ expect(response).to have_http_status(:ok)+ end+ end++ context 'without API key' do+ it 'returns 401 unauthorized' do+ get :index++ expect(response).to have_http_status(:unauthorized)+ expect(json_response['error']['code']).to eq('invalid_token')+ expect(json_response['error']['message']).to include('secret API key')+ end+ end++ context 'with invalid API key' do+ before { request.headers['X-Spree-Api-Key'] = 'sk_invalid' }++ it 'returns 401 unauthorized' do+ get :index++ expect(response).to have_http_status(:unauthorized)+ expect(json_response['error']['code']).to eq('invalid_token')+ end+ end++ context 'with publishable API key instead of secret' do+ let(:publishable_key) { create(:api_key, :publishable, store: store) }++ before { request.headers['X-Spree-Api-Key'] = publishable_key.token }++ it 'returns 401 unauthorized' do+ get :index++ expect(response).to have_http_status(:unauthorized)+ end+ end++ context 'with revoked secret API key' do+ before do+ secret_api_key.revoke!+ request.headers['X-Spree-Api-Key'] = secret_api_key.plaintext_token+ end++ it 'returns 401 unauthorized' do+ get :index++ expect(response).to have_http_status(:unauthorized)+ end+ end++ context 'with secret API key from another store' do+ let(:other_store) { create(:store) }+ let(:other_secret_key) { create(:api_key, :secret, store: other_store) }++ before { request.headers['X-Spree-Api-Key'] = other_secret_key.plaintext_token }++ it 'returns 401 unauthorized' do+ get :index++ expect(response).to have_http_status(:unauthorized)+ end+ end+ end++ describe 'JWT audience enforcement' do+ before { request.headers['X-Spree-Api-Key'] = secret_api_key.plaintext_token }++ context 'with admin JWT token (audience: admin_api)' do+ before { request.headers['Authorization'] = "Bearer #{admin_jwt_token}" }++ it 'authenticates successfully' do+ get :index++ expect(response).to have_http_status(:ok)+ expect(json_response['user_id']).to eq(admin_user.id)+ end+ end++ context 'with store JWT token (audience: store_api)' do+ let(:customer) { create(:user) }+ let(:store_jwt_token) { Spree::Api::V3::TestingSupport.generate_jwt(customer, audience: Spree::Api::V3::JwtAuthentication::JWT_AUDIENCE_STORE) }++ before { request.headers['Authorization'] = "Bearer #{store_jwt_token}" }++ it 'rejects the token silently (optional auth)' do+ get :index++ expect(response).to have_http_status(:ok)+ expect(json_response['user_id']).to be_nil+ end+ end++ context 'without JWT token' do+ it 'proceeds without user (optional auth)' do+ get :index++ expect(response).to have_http_status(:ok)+ expect(json_response['user_id']).to be_nil+ end+ end+ end++ describe 'API key query parameter rejection' do+ it 'does not accept API key via query parameter' do+ get :index, params: { api_key: secret_api_key.plaintext_token }++ expect(response).to have_http_status(:unauthorized)+ end+ end+enddiff --git a/spree/api/spec/controllers/spree/api/v3/store/customer/account_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/store/customer/account_controller_spec.rbindex d19395a670..482db6a834 100644--- a/spree/api/spec/controllers/spree/api/v3/store/customer/account_controller_spec.rb+++ b/spree/api/spec/controllers/spree/api/v3/store/customer/account_controller_spec.rb@@ -94,18 +94,63 @@ RSpec.describe Spree::Api::V3::Store::Customer::AccountController, type: :controexpect(user.internal_note).to be_nilend+ context 'when changing email' do+ it 'requires current_password' do+ patch :update, params: { email: '[email protected]' }++ expect(response).to have_http_status(:unprocessable_content)+ expect(json_response['error']['code']).to eq('current_password_invalid')+ end++ it 'rejects wrong current_password' do+ patch :update, params: { email: '[email protected]', current_password: 'wrongpassword' }++ expect(response).to have_http_status(:unprocessable_content)+ expect(json_response['error']['code']).to eq('current_password_invalid')+ end++ it 'accepts correct current_password' do+ patch :update, params: { email: '[email protected]', current_password: 'secret' }++ expect(response).to have_http_status(:ok)+ expect(user.reload.email).to eq('[email protected]')+ end++ it 'does not require current_password when email is unchanged' do+ patch :update, params: { email: user.email, first_name: 'Updated' }++ expect(response).to have_http_status(:ok)+ expect(user.reload.first_name).to eq('Updated')+ end+ end++ context 'when changing password' do+ it 'requires current_password' do+ patch :update, params: { password: 'newpassword123', password_confirmation: 'newpassword123' }++ expect(response).to have_http_status(:unprocessable_content)+ expect(json_response['error']['code']).to eq('current_password_invalid')+ end++ it 'accepts correct current_password' do+ patch :update, params: { password: 'newpassword123', password_confirmation: 'newpassword123', current_password: 'secret' }++ expect(response).to have_http_status(:ok)+ end+ end+context 'validation errors' do- it 'returns errors for blank email' do- patch :update, params: { email: '' }+ it 'returns errors for blank email with current password' do+ patch :update, params: { email: '', current_password: 'secret' }expect(response).to have_http_status(:unprocessable_content)expect(json_response['error']['code']).to eq('validation_error')expect(json_response['error']['details']['email']).to be_presentend- it 'returns errors for duplicate email' do+ it 'returns errors for duplicate email with current password' doother_user = create(:user)- patch :update, params: { email: other_user.email }+ patch :update, params: { email: other_user.email, current_password: 'secret' }expect(response).to have_http_status(:unprocessable_content)expect(json_response['error']['code']).to eq('validation_error')diff --git a/spree/api/spec/services/spree/webhooks/deliver_webhook_spec.rb b/spree/api/spec/services/spree/webhooks/deliver_webhook_spec.rbindex fc4caaec45..4c51997c67 100644--- a/spree/api/spec/services/spree/webhooks/deliver_webhook_spec.rb+++ b/spree/api/spec/services/spree/webhooks/deliver_webhook_spec.rb@@ -39,13 +39,20 @@ module Spree})end- it 'includes HMAC signature in headers' do- expected_signature = OpenSSL::HMAC.hexdigest('SHA256', secret_key, delivery.payload.to_json)-- described_class.call(delivery: delivery, secret_key: secret_key)-- expect(WebMock).to have_requested(:post, delivery.url)- .with(headers: { 'X-Spree-Webhook-Signature' => expected_signature })+ it 'includes HMAC signature with timestamp in headers' do+ Timecop.freeze do+ timestamp = Time.current.to_i+ payload_json = delivery.payload.to_json+ expected_signature = OpenSSL::HMAC.hexdigest('SHA256', secret_key, "#{timestamp}.#{payload_json}")++ described_class.call(delivery: delivery, secret_key: secret_key)++ expect(WebMock).to have_requested(:post, delivery.url)+ .with(headers: {+ 'X-Spree-Webhook-Signature' => expected_signature,+ 'X-Spree-Webhook-Timestamp' => timestamp.to_s+ })+ endendit 'sends payload as JSON body' dodiff --git a/spree/core/app/models/spree/payment/gateway_options.rb b/spree/core/app/models/spree/payment/gateway_options.rbindex 1a3a61f5cf..55d0f8b368 100644--- a/spree/core/app/models/spree/payment/gateway_options.rb+++ b/spree/core/app/models/spree/payment/gateway_options.rb@@ -34,6 +34,10 @@ module Spreepayment.numberend+ def idempotency_key+ "spree-#{payment.number}"+ end+def shippingorder.ship_total * exchange_multiplierend@@ -66,6 +70,7 @@ module Spree:ip,:order_id,:payment_id,+ :idempotency_key,:shipping,:tax,:subtotal,diff --git a/spree/core/spec/models/spree/payment/gateway_options_spec.rb b/spree/core/spec/models/spree/payment/gateway_options_spec.rbindex d1c99d7fe3..4cfa5a309e 100644--- a/spree/core/spec/models/spree/payment/gateway_options_spec.rb+++ b/spree/core/spec/models/spree/payment/gateway_options_spec.rb@@ -92,6 +92,12 @@ RSpec.describe Spree::Payment::GatewayOptions, type: :model doit { is_expected.to eq 'R1444-P1566' }end+ describe '#idempotency_key' do+ subject { options.idempotency_key }++ it { is_expected.to eq 'spree-P1566' }+ end+describe '#shipping' dosubject { options.shipping }@@ -145,6 +151,7 @@ RSpec.describe Spree::Payment::GatewayOptions, type: :model doip: '0.0.0.0',order_id: 'R1444-P1566',payment_id: 'P1566',+ idempotency_key: 'spree-P1566',shipping: '1244'.to_d,tax: '153'.to_d,subtotal: '1511'.to_d,