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.

Fixed `api-keys` cli command with secret keys

Damian Legawiec9ce6af13a4ef
diff --git a/docs/api-reference/admin-api/authentication.mdx b/docs/api-reference/admin-api/authentication.mdx
index 73f63fce9b..3d7db2c62d 100644
--- a/docs/api-reference/admin-api/authentication.mdx
+++ b/docs/api-reference/admin-api/authentication.mdx
@@ -38,11 +38,13 @@ curl -X GET 'https://store.example.com/api/v3/admin/orders' \
Secret API keys are prefixed with `sk_`. Create them in the Spree admin under **Settings → API Keys** or via the Spree CLI:
```bash
-spree api-key create --type secret # Create a new secret key
-spree api-key list # List existing keys
-spree api-key revoke <key_id> # Revoke a key
+spree api-key create --type secret --scopes read_orders,write_products # Create a scoped secret key
+spree api-key list # List existing keys
+spree api-key revoke <key_id> # Revoke a key
```
+Secret keys require at least one scope (see [Permissions](#permissions) below); pass `--scopes read_all` for a read-only key that can access everything.
+
<Warning>
If you omit the API key, the API returns `401 Unauthorized`:
diff --git a/packages/cli/.changeset/api-key-create-scopes.md b/packages/cli/.changeset/api-key-create-scopes.md
new file mode 100644
index 0000000000..8d7bee901c
--- /dev/null
+++ b/packages/cli/.changeset/api-key-create-scopes.md
@@ -0,0 +1,5 @@
+---
+"@spree/cli": minor
+---
+
+`spree api-key create` now supports scopes for secret keys via `--scopes` (comma-separated, e.g. `--scopes read_orders,write_products`) or an interactive prompt defaulting to `read_all`. Required against Spree 5.5+ servers, where secret keys must carry at least one scope.
diff --git a/packages/cli/src/commands/api-key.ts b/packages/cli/src/commands/api-key.ts
index 67d7092f44..fab00f0611 100644
--- a/packages/cli/src/commands/api-key.ts
+++ b/packages/cli/src/commands/api-key.ts
@@ -13,11 +13,16 @@ export function registerApiKeyCommand(program: Command): void {
.description('Create an API key')
.option('--name <name>', 'key name')
.option('--type <type>', 'key type: publishable or secret')
- .action(async (flags: { name?: string; type?: string }) => {
+ .option(
+ '--scopes <scopes>',
+ 'comma-separated scopes for secret keys (e.g. read_all or read_orders,write_products)',
+ )
+ .action(async (flags: { name?: string; type?: string; scopes?: string }) => {
const ctx = detectProject()
let name = flags.name
let keyType = flags.type
+ let scopes = flags.scopes
if (!name) {
const result = await p.text({
@@ -54,12 +59,31 @@ export function registerApiKeyCommand(program: Command): void {
throw new Error('Key type must be "publishable" or "secret".')
}
+ // Secret keys require at least one scope (server-side validation).
+ if (keyType === 'secret' && !scopes) {
+ const result = await p.text({
+ message: 'Scopes (comma-separated):',
+ placeholder: 'read_all',
+ initialValue: 'read_all',
+ validate(value) {
+ if (!value) return 'Secret keys require at least one scope'
+ return undefined
+ },
+ })
+ if (p.isCancel(result)) {
+ p.cancel('Cancelled.')
+ process.exit(0)
+ }
+ scopes = result
+ }
+
const s = p.spinner()
s.start('Creating API key...')
const stdout = await rakeTask('spree:cli:create_api_key', ctx.projectDir, {
NAME: name,
KEY_TYPE: keyType,
+ ...(keyType === 'secret' && scopes ? { SCOPES: scopes } : {}),
})
const tokenPrefix = keyType === 'publishable' ? 'pk_' : 'sk_'
@@ -75,6 +99,7 @@ export function registerApiKeyCommand(program: Command): void {
]
if (keyType === 'secret') {
+ lines.push(`${pc.bold('Scopes:')} ${scopes}`)
lines.push('')
lines.push(pc.yellow('Save this token now — secret keys cannot be retrieved later.'))
}
diff --git a/spree/core/lib/tasks/cli.rake b/spree/core/lib/tasks/cli.rake
index e42094a379..b2f48fabbb 100644
--- a/spree/core/lib/tasks/cli.rake
+++ b/spree/core/lib/tasks/cli.rake
@@ -12,8 +12,9 @@ namespace :spree do
task create_api_key: :environment do
name = ENV.fetch('NAME')
key_type = ENV.fetch('KEY_TYPE')
+ scopes = ENV.fetch('SCOPES', '').split(',').map(&:strip).reject(&:empty?)
store = Spree::Store.default
- key = store.api_keys.create!(name: name, key_type: key_type)
+ key = store.api_keys.create!(name: name, key_type: key_type, scopes: scopes)
print key.plaintext_token
end
diff --git a/spree/core/spec/lib/tasks/cli_spec.rb b/spree/core/spec/lib/tasks/cli_spec.rb
new file mode 100644
index 0000000000..19f31520de
--- /dev/null
+++ b/spree/core/spec/lib/tasks/cli_spec.rb
@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'rake'
+
+describe 'spree:cli:create_api_key' do
+ subject { Rake::Task[task_name] }
+
+ let(:task_name) { 'spree:cli:create_api_key' }
+
+ before(:all) do
+ Rake::Task.define_task(:environment)
+ load Spree::Core::Engine.root.join('lib', 'tasks', 'cli.rake')
+ end
+
+ before { subject.reenable }
+
+ let!(:store) { Spree::Store.default || create(:store, default: true) }
+
+ around do |example|
+ env.each { |key, value| ENV[key] = value }
+ example.run
+ ensure
+ env.each_key { |key| ENV.delete(key) }
+ end
+
+ context 'with KEY_TYPE=secret' do
+ let(:env) { { 'NAME' => 'CI key', 'KEY_TYPE' => 'secret', 'SCOPES' => 'read_orders, write_promotions' } }
+
+ it 'mints a secret key with the scopes from SCOPES and prints its plaintext token' do
+ expect do
+ expect { subject.invoke }.to output(/\Ask_/).to_stdout
+ end.to change { store.api_keys.secret.count }.by(1)
+
+ key = store.api_keys.secret.order(:created_at).last
+ expect(key.name).to eq('CI key')
+ expect(key.scopes).to eq(%w[read_orders write_promotions])
+ end
+
+ context 'without SCOPES' do
+ let(:env) { { 'NAME' => 'CI key', 'KEY_TYPE' => 'secret' } }
+
+ it 'fails the scope presence validation' do
+ expect { subject.invoke }.to raise_error(ActiveRecord::RecordInvalid, /Scopes/)
+ end
+ end
+ end
+
+ context 'with KEY_TYPE=publishable' do
+ let(:env) { { 'NAME' => 'Storefront', 'KEY_TYPE' => 'publishable' } }
+
+ it 'mints a publishable key without requiring SCOPES' do
+ expect do
+ expect { subject.invoke }.to output(/\Apk_/).to_stdout
+ end.to change { store.api_keys.publishable.count }.by(1)
+
+ expect(store.api_keys.publishable.order(:created_at).last.scopes).to eq([])
+ end
+ end
+end