Skip to content

armgit / spree

Public Imported from GitHub
0

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.

Enforce API-key scopes on non-resource admin endpoints (F2)

Damian Legawiec7efe91b424f1
diff --git a/spree/api/app/controllers/spree/api/v3/admin/base_controller.rb b/spree/api/app/controllers/spree/api/v3/admin/base_controller.rb
index 1e81e59cd9..63ec8e4b5b 100644
--- a/spree/api/app/controllers/spree/api/v3/admin/base_controller.rb
+++ b/spree/api/app/controllers/spree/api/v3/admin/base_controller.rb
@@ -4,9 +4,13 @@ module Spree
module Admin
class BaseController < Spree::Api::V3::BaseController
include Spree::Api::V3::AdminAuthentication
- include Spree::Api::V3::ScopedAuthorization
+ # Must be registered before ScopedAuthorization so authenticate_admin!
+ # resolves @current_api_key before authorize_api_key_scope! reads it —
+ # otherwise the scope guard short-circuits on a nil key and never runs.
before_action :authenticate_admin!
+
+ include Spree::Api::V3::ScopedAuthorization
end
end
end
diff --git a/spree/api/spec/controllers/spree/api/v3/admin/store_controller_spec.rb b/spree/api/spec/controllers/spree/api/v3/admin/store_controller_spec.rb
index 5a43297c11..c4e11b5826 100644
--- a/spree/api/spec/controllers/spree/api/v3/admin/store_controller_spec.rb
+++ b/spree/api/spec/controllers/spree/api/v3/admin/store_controller_spec.rb
@@ -198,5 +198,38 @@ RSpec.describe Spree::Api::V3::Admin::StoreController, type: :controller do
expect(response).to have_http_status(:unauthorized)
end
end
+
+ # Regression: StoreController inherits from Admin::BaseController (the
+ # non-resource branch). Its scope guard once ran before authenticate_admin!
+ # resolved the API key, so it short-circuited on a nil key and every
+ # API-key caller could rewrite store settings without write_settings.
+ context 'authenticated with a secret API key' do
+ include_context 'API v3 Admin'
+
+ let(:secret_api_key) { create(:api_key, :secret, store: store, scopes: scopes) }
+ let(:headers) { api_key_headers }
+ let(:params) { { name: 'Renamed Store' } }
+
+ context 'lacking the write_settings scope' do
+ let(:scopes) { ['read_orders'] }
+
+ it 'denies the write with the required scope' do
+ subject
+ expect(response).to have_http_status(:forbidden)
+ expect(json_response['error']['details']['required_scope']).to eq('write_settings')
+ expect(store.reload.name).not_to eq('Renamed Store')
+ end
+ end
+
+ context 'carrying the write_settings scope' do
+ let(:scopes) { ['write_settings'] }
+
+ it 'allows the write' do
+ subject
+ expect(response).to have_http_status(:ok)
+ expect(store.reload.name).to eq('Renamed Store')
+ end
+ end
+ end
end
end