
Entferne credential-ähnliche Inhalte aus Freitext-Strings, bevor sie in Logs oder Telemetrie gelangen. Teil des phpboyscout Go-Toolkits. · https://redact.go.phpboyscout.uk
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.
regexp, strings), sodass nichts außer dem Modul in deinen Graphen gelangt. Ein depfootprint_test.go-Guard erzwingt dies und hält die Tests auf testify und das go/errors des Estates.go get gitlab.com/phpboyscout/go/redact
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.
Musterkataloge erreichen nie 100 % Trefferquote, und dieser ist bewusst konservativ:
String maskiert keine beliebigen Header-Werte. Es kennt Authorization:
und sonst nichts; X-API-Key: … wird durchgelassen. Dafür sind die Header-
Symbole da.Was redact nicht tut beschreibt die vollständige Grenze.
Vollständige Anleitungen, Referenz und Bedrohungsmodell: redact.go.phpboyscout.uk. Generierte API-Dokumentation und ausführbare Beispiele: pkg.go.dev.
Siehe LICENSE.