feat(api): optional X-Service-Token auth for backend-only access#34
Merged
Conversation
When OST_LINKER_SERVICE_TOKEN is set, protected endpoints require X-Service-Token matching (constant-time compare). When unset, the API behaves as before — preserves backward compat for gradual rollout. /health stays open for uptime monitors. The token is read directly from os.environ in the dependency so tests stay simple and the check never touches the pydantic config path.
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
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.
Summary
Adds a shared-secret gate on the FastAPI REST API so that only the
ost-backendMCP gateway can reach it in production. Paired with ost-backend#51 which sends the header.What changes
Rollout safety
Open by default. When `OST_LINKER_SERVICE_TOKEN` is unset, endpoints behave exactly as today — anyone can hit them. Only when the env is set on prod do the endpoints require the header. Deploy sequence (your call, not this PR's job):
Verification
```
✓ ruff check src/services/api/ tests/api/ — All checks passed
✓ ruff format --check — clean
✓ mypy src/services/api/ — Success: no issues found in 13 source files
✓ pytest -m api tests/api/test_service_token.py — 12 passed
```
Test plan