
redact v0.2.2
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
redact
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.
Diseño
- Cero dependencias. Solo biblioteca estándar (
regexp,strings), así que nada más que el módulo entra en tu grafo. Un guardiándepfootprint_test.golo impone, y limita las pruebas atestifyy algo/errorsdel ecosistema. - Redacción en el límite. Sanitiza donde los datos abandonan el host, no en todas partes.
- Conservador por defecto. El respaldo de tokens opacos requiere ≥41 caracteres para que nunca dé falsos positivos con UUIDs, MD5 o SHA-1.
Instalación
go get gitlab.com/phpboyscout/go/redact
Uso
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.
Limitaciones
Los catálogos de patrones nunca alcanzan el 100% de cobertura, y este es deliberadamente conservador:
- Sin configuración. No puedes añadir, desactivar ni reordenar un patrón. El paquete exporta cuatro símbolos y nada que ajustar. Compón alrededor de él en su lugar.
Stringno enmascara valores de cabecera arbitrarios. ConoceAuthorization:y nada más;X-API-Key: …pasa sin modificar. Para eso están los símbolos de cabecera.- Los secretos personalizados y cortos se escapan. El respaldo genérico necesita 41 caracteres, y cada prefijo de proveedor tiene una longitud mínima estricta. También perdona una secuencia que se lee como palabras, por lo que una frase de contraseña compuesta por palabras de diccionario pasa.
- Los patrones son solo ASCII, y la redacción es unidireccional: nada que revertir y ningún registro de lo que se reemplazó.
What redact does not do expone el límite completo.
Documentación
Guías completas, referencia y modelo de amenazas: redact.go.phpboyscout.uk. Documentación de API generada y ejemplos ejecutables: pkg.go.dev.
Licencia
Consulta LICENSE.