Skip to content

Security: manijose1919/flakeradar

Security

SECURITY.md

Security Policy

Reporting a vulnerability

Please report suspected vulnerabilities privately via GitHub Security Advisories (the "Report a vulnerability" button on the Security tab) rather than a public issue. We aim to acknowledge reports within a few days.

Trust model

FlakeRadar's security posture is deliberate and documented:

  • Write path is token-gated. POST /api/ingest and GET /api/quarantine require the X-API-Key header, compared in constant time. These are the endpoints external CI calls.
  • Read/dashboard APIs are open by design. They are expected to sit on a private network or behind an authenticating reverse proxy. Do not expose the dashboard directly to the public internet.
  • The quarantine toggle (POST /api/tests/{id}/quarantine) is an intentionally open write. It is a dashboard action (internal origin), so it shares the dashboard's trust boundary rather than the token-gated CI path. Anyone who can reach the dashboard can quarantine/un-quarantine a test — the same trust level under which they can already read every result. Gate it at the reverse proxy if your dashboard is not on a trusted network.
  • Secrets (FLAKERADAR_API_TOKEN, FLAKERADAR_GITHUB_TOKEN) live only in .env, which is git-ignored. Never commit them. Rotate the API token if it is ever exposed. The process refuses to start on the shipped default token (changeme) unless FLAKERADAR_ALLOW_INSECURE=1 is set.

There aren't any published security advisories