
redact v0.2.2
# Remova conteúdo semelhante a credenciais de strings de formato livre antes que elas cheguem a logs ou telemetria. Parte do kit de ferramentas Go phpboyscout. · https://redact.go.phpboyscout.uk
redact
Remove conteúdo semelhante a credenciais de strings de formato livre antes que cheguem a logs, telemetria ou qualquer superfície de terceiros
Parte do phpboyscout Go toolkit: módulos Go pequenos e sem framework extraídos do go-tool-base. Documentação: redact.go.phpboyscout.uk
gitlab.com/phpboyscout/go/redact remove conteúdo semelhante a credenciais de strings
de formato livre na fronteira entre superfícies de observabilidade confiáveis e não confiáveis, como
fornecedores de telemetria, agregadores de logs e armazenamentos de métricas. Mensagens de erro, argumentos
de comando e valores de cabeçalhos HTTP carregam rotineiramente segredos por acidente (uma URL com
userinfo incorporado, uma flag --api-key=sk-… em os.Args, um cabeçalho Authorization
citado num erro de exportação). Encaminhe esses dados por redact.String no momento da
saída e eles nunca deixam o processo em texto claro.
Design
- Zero dependências. Apenas biblioteca padrão (
regexp,strings), para que nada além do módulo entre no seu grafo. Uma proteção emdepfootprint_test.gogarante isso, e restringe os testes atestifye aogo/errorsdo ecossistema. - Redação na fronteira. Sanitize onde os dados saem do host, não em todo lugar.
- Conservador por padrão. O fallback de token opaco exige ≥41 caracteres para que nunca produza falsos positivos em UUIDs, MD5 ou SHA-1.
Instalação
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 remove o userinfo de URL para qualquer esquema (https://, postgres://,
redis://, …), atribuições de credenciais name=value, campos de credenciais em JSON como
"access_token" e "client_secret", tokens de cabeçalho Authorization, JWTs,
prefixos de provedores conhecidos (sk-, ghp_, glpat-, AIza, AKIA, Slack, Hugging Face),
e tokens opacos longos. SensitiveHeaderKeys / IsSensitiveHeaderKey identificam
cabeçalhos cujos valores devem ser redigidos.
Limitações
Catálogos de padrões nunca alcançam 100% de recall, e este é deliberadamente conservador:
- Sem configuração. Não é possível adicionar, desativar ou reordenar um padrão. O pacote exporta quatro símbolos e nada para ajustar. Componha em torno dele.
Stringnão mascara valores arbitrários de cabeçalhos. Ele conheceAuthorization:e nada mais;X-API-Key: …passa adiante. É para isso que servem os símbolos de cabeçalho.- Segredos personalizados e curtos passam despercebidos. O fallback genérico exige 41 caracteres, e cada prefixo de provedor tem um comprimento mínimo rígido. Ele também poupa uma sequência que se lê como palavras, então uma passphrase de palavras de dicionário passa.
- Os padrões são apenas ASCII, e a redação é unidirecional: nada para reverter e nenhum registro do que foi substituído.
O que o redact não faz declara o limite completo.
Documentação
Guias completos, referência e modelo de ameaças: redact.go.phpboyscout.uk. Documentação de API gerada e exemplos executáveis: pkg.go.dev.
Licença
Consulte LICENSE.