
redact v0.2.2
# ログやテレメトリに到達する前に、自由形式の文字列から資格情報のようなコンテンツを除去します。phpboyscout Goツールキットの一部。 · https://redact.go.phpboyscout.uk
redact
ログ、テレメトリ、その他の第三者向けサーフェスに到達する前に、自由形式の文字列から認証情報らしき内容を除去する
phpboyscout Go toolkit の一部: go-tool-base から抽出された、フレームワークに依存しない小さな Go モジュール群。ドキュメント: redact.go.phpboyscout.uk
gitlab.com/phpboyscout/go/redact は、信頼できる観測サーフェスと信頼できない観測サーフェス(テレメトリベンダー、ログアグリゲータ、メトリクスストアなど)の境界において、自由形式の文字列から認証情報らしき内容を除去します。エラーメッセージ、コマンド引数、HTTP ヘッダー値は、しばしば偶発的にシークレットを含んでしまいます(ユーザー情報が埋め込まれた URL、os.Args 内の --api-key=sk-… フラグ、エクスポートエラーに引用された Authorization ヘッダーなど)。これらを出力時に redact.String 経由で通せば、平文のままプロセス外へ出ることはありません。
設計
- 依存関係ゼロ。 純粋な標準ライブラリ(
regexp、strings)のみを使用するため、モジュール以外は依存グラフに入りません。depfootprint_test.goのガードがこれを強制し、テストはtestifyとエステートのgo/errorsに限定しています。 - 境界でのリダクション。 データがホストを離れる箇所でサニタイズし、あらゆる場所では行いません。
- デフォルトで保守的。 不透明トークンのフォールバックは 41 文字以上を要求するため、UUID、MD5、SHA-1 に対して誤検知しません。
インストール
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 は、あらゆるスキーム(https://、postgres://、
redis:// など)の URL ユーザー情報、資格情報の name=value 代入、"access_token" や
"client_secret" といった JSON 資格情報フィールド、Authorization ヘッダーのトークン、JWT、
よく知られたプロバイダープレフィックス(sk-、ghp_、glpat-、AIza、AKIA、Slack、Hugging Face)、
および長い不透明トークンを除去します。SensitiveHeaderKeys / IsSensitiveHeaderKey は、
値を伏せ字にすべきヘッダーを識別します。
制限事項
パターンカタログが 100% の再現率に達することは決してなく、このカタログは意図的に 保守的に作られています:
- 設定はありません。 パターンを追加、無効化、並べ替えることはできません。この パッケージは 4 つのシンボルをエクスポートするだけで、調整できるものは何もありません。代わりに その周囲で組み合わせてください。
Stringは任意のヘッダー値をマスクしません。 認識するのはAuthorization:のみで、 それ以外はありません。X-API-Key: …はそのまま通過します。そのためにヘッダー用の シンボルが存在します。- 独自形式や短いシークレットはすり抜けます。 汎用のフォールバックには 41 文字が必要で、各プロバイダープレフィックスには厳格な最小長があります。また、単語として 読める連続文字列は除外されるため、辞書の単語からなるパスフレーズは通過します。
- パターンは ASCII のみであり、伏せ字化は一方向です:元に戻すものはなく、 何が置き換えられたかの記録もありません。
What redact does not do に完全な境界が記載されています。
ドキュメント
完全なガイド、リファレンス、脅威モデル: redact.go.phpboyscout.uk。 生成された API ドキュメントと実行可能な例: pkg.go.dev。
ライセンス
LICENSE を参照してください。