Security guidelines
July 8, 2026 · View on GitHub
The essentials are in AGENTS.md: this is the depth.
The CLI reads local and remote files, resolves $refs across documents, authenticates against Redocly cloud, and runs real HTTP requests in respect-core — treat all of that as untrusted input.
- Never hardcode credentials, tokens, or API keys. Read them from the environment or the existing auth flow, and never log their values.
- Validate and type-check external input —
redocly.yaml, CLI arguments, and fetched documents — before using it. - Never use
evalor build shell commands from unsanitised input. The runtime-expression evaluator in respect-core stays expression-only, not arbitrary code execution. - Treat resolved
$refs and remote URLs as untrusted: guard file writes (bundle, split, eject) against path traversal, and don't fetch outside the intended scope. - Log sensitive operations without their sensitive values — tokens, secrets, and auth headers never reach the logger.