docs: security scope notes and config-api troubleshooting - #198
Merged
Conversation
SECURITY.md's scope notes predated api_keys.yaml roles, Vault resolution and the configuration API — the threat-model change 0.20.0 shipped (an admin key can rewrite every config file over HTTP) was documented everywhere except the file an auditor reads first. The notes now cover the key model, the public routes, the config-API authority and its two reload guardrails, git projects as trusted input, and the deliberate absence of rate limiting. docs/troubleshooting.md gains the missing configuration-API section: every refusal (403/400/412/409/413), the wrote-but-never-reloaded state, and why restart_required persists.
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Two docs that lagged the code by several releases:
SECURITY.mdscope notes still described only the legacyUNIFIED_API_KEYshared secret. Rewritten to cover: theapi_keys.yamlkey model (admin vs restricted, secrets from env vars, constant-time compare, loud open-mode), the always-public routes andmetrics_require_auth, the configuration API's authority (admin key ≈ root on the instance when enabled) with its two pre-commit guardrails, git project checkouts as trusted input, Vault in the credential-resolution story, and the deliberate absence of auth rate limiting on a trusted network.docs/troubleshooting.mdhad no configuration-API coverage two releases after the feature shipped. New symptom-first section mapping every refusal (403disabled,400rejected-whole,412If-Match,409key guardrails,413body limit) plus the wrote-but-never-reloaded state (reload_pending) and the persistingrestart_required, ending with the audit-log pointer.Docs only — no code, no CHANGELOG entry per the changelog policy.
Note: the
413row referencesserver.max_body_bytesfrom #196, so this merges after it.