
Elimina contenido similar a credenciales de cadenas de forma libre antes de que lleguen a registros o telemetría. Parte del kit de herramientas Go phpboyscout. · https://redact.go.phpboyscout.uk
Elimina contenido similar a credenciales de cadenas de formato libre antes de que lleguen a los logs, la telemetría o cualquier superficie de terceros
Parte del phpboyscout Go toolkit: módulos Go pequeños y sin framework extraídos de go-tool-base. Documentación: redact.go.phpboyscout.uk
gitlab.com/phpboyscout/go/redact redacta contenido similar a credenciales de cadenas
de formato libre en el límite entre superficies de observabilidad confiables y no confiables, como
proveedores de telemetría, agregadores de logs y almacenes de métricas. Los mensajes de error, los argumentos
de comandos y los valores de cabeceras HTTP suelen transportar secretos por accidente (una URL con
userinfo incrustado, un flag --api-key=sk-… en os.Args, una cabecera Authorization
citada en un error de exportación). Hazlos pasar por redact.String en el momento de la
salida y nunca abandonarán el proceso en claro.
regexp, strings), así que nada más que
el módulo entra en tu grafo. Un guardián depfootprint_test.go lo impone, y
limita las pruebas a testify y al go/errors del ecosistema.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 elimina la información de usuario de las URL para cualquier esquema (https://, postgres://,
redis://, …), las asignaciones de credenciales name=value, los campos de credenciales JSON como
"access_token" y "client_secret", los tokens de la cabecera Authorization, los JWT,
los prefijos de proveedores conocidos (sk-, ghp_, glpat-, AIza, AKIA, Slack, Hugging Face),
y los tokens opacos largos. SensitiveHeaderKeys / IsSensitiveHeaderKey identifican
las cabeceras cuyos valores deben redactarse.
Los catálogos de patrones nunca alcanzan el 100% de cobertura, y este es deliberadamente conservador:
String no enmascara valores de cabecera arbitrarios. Conoce Authorization:
y nada más; X-API-Key: … pasa sin modificar. Para eso están los símbolos de cabecera.What redact does not do expone el límite completo.
Guías completas, referencia y modelo de amenazas: redact.go.phpboyscout.uk. Documentación de API generada y ejemplos ejecutables: pkg.go.dev.
Consulta LICENSE.