在自由格式字符串进入日志、遥测或任何第三方界面之前,剥离其中类似凭据的内容
属于 phpboyscout Go 工具集的一部分:从 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。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 会剥离任意 scheme(https://、postgres://、redis:// 等)的 URL userinfo、凭据 name=value 赋值、JSON 凭据字段(如 "access_token" 和 "client_secret")、Authorization 头令牌、JWT、知名提供商前缀(sk-、ghp_、glpat-、AIza、AKIA、Slack、Hugging Face)以及长的不透明令牌。SensitiveHeaderKeys / IsSensitiveHeaderKey 用于识别其值应被脱敏的请求头。
模式目录永远无法达到 100% 的召回率,而本目录刻意保持保守:
String 不会遮蔽任意请求头的值。 它只识别 Authorization:,除此之外一概不知;X-API-Key: … 会原样通过。这正是请求头符号的用途所在。What redact does not do 说明了完整边界。
完整指南、参考和威胁模型: redact.go.phpboyscout.uk。 生成的 API 文档和可运行示例: pkg.go.dev。
参见 LICENSE。