
redact v0.2.2
Entferne credential-ähnliche Inhalte aus Freitext-Strings, bevor sie in Logs oder Telemetrie gelangen. Teil des phpboyscout Go-Toolkits. · https://redact.go.phpboyscout.uk
redact
Entfernt credential-ähnliche Inhalte aus Freitext-Strings, bevor sie Logs, Telemetrie oder andere Drittanbieter-Oberflächen erreichen
Teil des phpboyscout Go toolkit: kleine, framework-freie Go-Module, extrahiert aus go-tool-base. Docs: redact.go.phpboyscout.uk
gitlab.com/phpboyscout/go/redact entfernt credential-ähnliche Inhalte aus Freitext-Strings an der Grenze zwischen vertrauenswürdigen und nicht vertrauenswürdigen Observability-Oberflächen, wie etwa Telemetrie-Anbietern, Log-Aggregatoren und Metrik-Speichern. Fehlermeldungen, Kommandozeilenargumente und HTTP-Header-Werte enthalten routinemäßig versehentlich Secrets (eine URL mit eingebetteten Userinfo-Daten, ein --api-key=sk-…-Flag in os.Args, ein Authorization-Header, der in einem Export-Fehler zitiert wird). Leite diese auf dem Weg nach draußen durch redact.String, und sie verlassen den Prozess nie im Klartext.
Design
- Keine Abhängigkeiten. Reine Standardbibliothek (
regexp,strings), sodass nichts außer dem Modul in deinen Graphen gelangt. Eindepfootprint_test.go-Guard erzwingt dies und hält die Tests auftestifyund dasgo/errorsdes Estates. - Grenz-Redaktion. Bereinige dort, wo Daten den Host verlassen, nicht überall.
- Standardmäßig konservativ. Der Opaque-Token-Fallback erfordert ≥41 Zeichen, damit er niemals fälschlicherweise auf UUIDs, MD5 oder SHA-1 anschlägt.
Installation
go get gitlab.com/phpboyscout/go/redact
Verwendung
import "gitlab.com/phpboyscout/go/redact"
safe := redact.String("failed calling https://user:[email protected]?api_key=sk-abc123…")
// → credentials in the URL userinfo, the api_key query param, and the sk- token are masked
msg := redact.Error(err) // redact.String applied to err.Error() (nil-safe)
if redact.IsSensitiveHeaderKey("Authorization") { /* … redact this header's value … */ }
redact.String entfernt URL-Benutzerinformationen für jedes Schema (https://, postgres://,
redis://, …), Anmeldedaten-Zuweisungen name=value, JSON-Anmeldedatenfelder wie
"access_token" und "client_secret", Authorization-Header-Token, JWTs,
bekannte Anbieter-Präfixe (sk-, ghp_, glpat-, AIza, AKIA, Slack, Hugging Face)
und lange undurchsichtige Token. SensitiveHeaderKeys / IsSensitiveHeaderKey identifizieren
Header, deren Werte redigiert werden sollten.
Einschränkungen
Musterkataloge erreichen nie 100 % Trefferquote, und dieser ist bewusst konservativ:
- Keine Konfiguration. Sie können kein Muster hinzufügen, deaktivieren oder neu anordnen. Das Paket exportiert vier Symbole und nichts zum Anpassen. Komponieren Sie stattdessen darum herum.
Stringmaskiert keine beliebigen Header-Werte. Es kenntAuthorization:und sonst nichts;X-API-Key: …wird durchgelassen. Dafür sind die Header- Symbole da.- Maßgeschneiderte und kurze Geheimnisse rutschen durch. Der Catch-all-Fallback benötigt 41 Zeichen, und jedes Anbieter-Präfix hat eine harte Mindestlänge. Es verschont außerdem eine Folge, die als Wörter gelesen wird, sodass eine Passphrase aus Wörterbuchwörtern durchkommt.
- Muster sind nur ASCII, und die Redaktion ist einseitig: nichts umzukehren und keine Aufzeichnung darüber, was ersetzt wurde.
Was redact nicht tut beschreibt die vollständige Grenze.
Dokumentation
Vollständige Anleitungen, Referenz und Bedrohungsmodell: redact.go.phpboyscout.uk. Generierte API-Dokumentation und ausführbare Beispiele: pkg.go.dev.
Lizenz
Siehe LICENSE.