Security and privacy

ContribSutra reads other people's text. The security model assumes that text is hostile.

Principles

  1. Repository files, issue text and tool output are data, never instructions.
  2. Read-only by default. There is no code path that writes to GitHub or runs a repository script.
  3. Fail closed on ambiguity: unknown statuses become not_run, unknown ranges become cannot_determine.
  4. Least privilege: fixed probe binaries with constant arguments; a localhost server with a token.

Threats and controls

ThreatControlEvidence
Prompt injection in issues or docsDetected, flagged, declined or labelled; never echoed into reportsaudit A04, G02
Malicious README commandsQuoted as documented_not_run; never executedscan tests
Path traversal and absolute pathsRejected before any readaudit B01, B02
Symlink escapelstat + realpath containment; symlinked roots and destinations refusedcore tests (run on Linux/macOS CI)
Oversized inputHard caps on document, snapshot and report sizesaudit B05
Report tamperingSHA-256 seal; verify and render refuse mismatchesaudit C01
Stale evidenceverify --root re-hashes sourcesaudit C02
Secret leakageHeuristic redaction of tokens, keys, emails, URL credentialsaudit E02
XSS in HTML reportsEscaping everywhere, no script elements, CSP on the serveraudit E01
Local server abuse127.0.0.1, token ≥ 16 chars, constant-time compare, Host check, GET only, connection capaudit F01
Invented test successClaims never upgraded to verifiedaudit D01–D03
PR floodingNo write path; lifecycle stops at planningaudit D03, D04

Privacy

No telemetry, accounts, cookies or network calls. Reports contain relative paths, hashes and redacted short excerpts. Issue bodies are scanned and discarded. The doctor report contains tool versions and the Node/OS facts shown in the report, not environment variables or home paths. Review any report before sharing it: redaction is heuristic.

What the seal is not

A SHA-256 seal detects accidental change. It is not a digital signature, does not identify the author and does not prove a maintainer approved anything. Signing is on the roadmap.

Residual risks

Heuristic secret detection can miss secrets. PATH determines which git or node runs. A snapshot can be stale or malicious. Skills cannot enforce rules inside a host IDE. Windows without symlink rights cannot run the symlink tests locally (they skip and are reported as skipped).

Reporting vulnerabilities

Use GitHub private vulnerability reporting for the repository. Do not open public issues for vulnerabilities and never post live tokens.

Hardening backlog

Signed reports and releases, SBOM, nested-secret redaction improvements, structured consent logs, OS-specific path tests, optional sandbox for future test execution.