redact

Documentation

Overview

Package redact detecta y enmascara secretos (API keys, tokens, claves privadas) antes de que el contenido salga de la máquina vía `nem sync`. Es secure-by-default: el scrubbing corre siempre en la exportación a git.

Index

• type Option
  • func WithPattern(kind, pattern string) Option
  • func WithoutBuiltins() Option
• type Redactor
  • func New(options ...Option) (Redactor, error)
• type Result
  • func (r Result) Summary() string
  • func (r Result) Total() int

Types

type Option

type Option func(*config) error

Option configura el Redactor.

func WithPattern

func WithPattern(kind, pattern string) Option

WithPattern agrega un detector propio (kind + regex). Útil para secretos específicos de un usuario/empresa.

func WithoutBuiltins

func WithoutBuiltins() Option

WithoutBuiltins desactiva los detectores por defecto (solo se usan los propios).

type Redactor

type Redactor interface {
	// Redact devuelve el texto saneado y el conteo de secretos encontrados.
	Redact(s string) Result
}

Redactor enmascara secretos en texto.

func New

func New(options ...Option) (Redactor, error)

New crea un Redactor con los detectores por defecto más los configurados.

type Result

type Result struct {
	Text   string
	Counts map[string]int
}

Result es el texto saneado más el conteo de secretos por tipo.

func (Result) Summary

func (r Result) Summary() string

Summary devuelve un resumen ordenado tipo "2 openai-key, 1 aws-key".

func (Result) Total

func (r Result) Total() int

Total devuelve la cantidad total de secretos redactados.