Documentation
¶
Overview ¶
Package output defines output formatter interfaces and shared helpers used across the concrete formatters (json, sarif, csv, table, github).
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SanitizeForDisplay ¶ added in v1.7.0
SanitizeForDisplay strips Unicode control characters — including the ESC (0x1B) byte that begins ANSI/OSC/DCS escape sequences, and the C0/C1 control ranges more generally — from s.
Apply this to any attacker-influenced field (file path, detector ID, redacted match value, ...) before it is written somewhere an operator views directly: a real terminal (table formatter) or a stream consumed by another tool that itself renders to a terminal (e.g. GitHub Actions' workflow-command log). Without it, a maliciously named file (Git/most filesystems permit any byte except '/' and NUL) or a permissive custom-rule match can inject cursor moves, color changes, title-bar writes, or other terminal escape sequences into the operator's session.
Bytes are removed rather than substituted: the safe behavior for a terminal-facing display field is to drop the disallowed byte entirely rather than risk re-introducing structure (e.g. a substitute delimiter) that could itself be misinterpreted downstream.
Do NOT apply this to the unredacted secret value (Raw) shown under --show-raw: that field's entire purpose is exact fidelity to the actual secret, and silently dropping bytes from it would misrepresent the secret being reported.
Types ¶
type Formatter ¶
type Formatter interface {
// Format writes findings to the given writer.
Format(w io.Writer, findings []finding.Finding) error
// FileExtension returns the file extension for this format (including the
// leading dot, e.g. ".sarif").
//
// The cmd/ output layer uses it to auto-suffix a bare --output path that
// has no extension, so `--format sarif --output results` writes
// results.sarif. A path that already carries an extension is left
// untouched.
FileExtension() string
}
Formatter outputs findings in a specific format.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package csv provides a CSV output formatter for Leakwatch findings.
|
Package csv provides a CSV output formatter for Leakwatch findings. |
|
Package github provides an output formatter that emits GitHub Actions workflow commands (::error / ::warning / ::notice) so Leakwatch findings show up as inline annotations on pull requests and in the workflow run log.
|
Package github provides an output formatter that emits GitHub Actions workflow commands (::error / ::warning / ::notice) so Leakwatch findings show up as inline annotations on pull requests and in the workflow run log. |
|
Package json provides a JSON output formatter.
|
Package json provides a JSON output formatter. |
|
Package sarif provides a SARIF v2.1.0 output formatter for Leakwatch findings.
|
Package sarif provides a SARIF v2.1.0 output formatter for Leakwatch findings. |
|
Package table provides a human-readable table output formatter for terminal display.
|
Package table provides a human-readable table output formatter for terminal display. |