Skip to content

fix(config): warn to stderr when secrets passed as CLI flags #535

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
margaretjgu merged 1 commit into from
Aug 12, 2026
+30 −0
Merged

fix(config): warn to stderr when secrets passed as CLI flags #535

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/config/commands.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,11 @@ function collectFieldUpdates (options: Record<string, string | number | boolean>
secrets.push({ field, value: raw })
}
}
if (secrets.length > 0) {
process.stderr.write(
`Warning: secret value(s) passed via flag(s) (${secrets.map(s => `--${s.field.flag}`).join(', ')}) are visible in process listings and shell history.\n`
)
}
for (const field of PLAIN_FIELDS) {
const raw = options[field.flag]
if (typeof raw === 'string' && raw.length > 0) {
Expand Down
25 changes: 25 additions & 0 deletions test/config/commands.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,4 +176,29 @@ describe('elastic config (integration)', () => {
assert.equal(res.exitCode, 1)
assert.equal((res.json as { error?: { code: string } }).error?.code, 'context_not_found')
})

it('context add emits a stderr warning when a secret flag is supplied', async () => {
await writeFile(cfg, 'current_context: only\ncontexts:\n only:\n elasticsearch:\n url: http://x:9200\n auth:\n api_key: k\n')
const res = run([
'config', 'context', 'add', 'withsecret',
'--config-file', cfg,
'--es-url', 'http://localhost:9200',
'--es-api-key', 'supersecret',
'--inline-secrets',
])
assert.ok(res.stderr.includes('Warning:'), 'expected a Warning on stderr')
assert.ok(res.stderr.includes('--es-api-key'), 'expected --es-api-key in the warning')
assert.ok(res.stderr.includes('process listings'), 'expected visibility warning text')
})

it('context add does not emit a stderr warning when no secret flag is supplied', async () => {
await writeFile(cfg, 'current_context: only\ncontexts:\n only:\n elasticsearch:\n url: http://x:9200\n auth:\n api_key: k\n')
const res = run([
'config', 'context', 'add', 'nosecret',
'--config-file', cfg,
'--es-url', 'http://localhost:9200',
])
const secretWarning = res.stderr.split('\n').filter(l => l.startsWith('Warning:') && l.includes('process listings'))
assert.equal(secretWarning.length, 0, 'expected no secret-flag warning on stderr')
})
})
Loading