redact

type Class int

type CustomRule struct {
	ID      string
	Pattern string
	// Flags is any of "i", "m", "s".
	Flags string
	// Replacement, when set, replaces each match verbatim; otherwise the
	// configured placeholder is used.
	Replacement string
}

type CustomRuleError struct {
	Field string
	Msg   string
}

type Hit struct {
	RuleID string
	Count  int
}

type Options struct {
	// Key is the live API key value; it is always redacted (HARD).
	Key string
	// Secrets are further known secret values (env-var values) that must not
	// survive redaction (HARD).
	Secrets []string
	// Home is the home directory rewritten to "~" (SOFT).
	Home string
	// DisableSoft lists SOFT rule ids to turn off.
	DisableSoft []string
	// Allow maps a SOFT rule id to RE2 patterns; a match of the rule whose text
	// matches any pattern is left in place.
	Allow map[string][]string
	// Custom are extra regexp rules. They are HARD: they cannot be disabled or
	// allowlisted.
	Custom []CustomRule
	// Placeholder overrides the "[REDACTED]" replacement; nil keeps it.
	Placeholder Placeholder
	// EntropyThreshold (bits/char) and MinTokenLen tune the SOFT high-entropy
	// rule; zero keeps DefaultEntropyThreshold and DefaultMinTokenLen.
	EntropyThreshold float64
	MinTokenLen      int
	// Strict redacts every SOFT rule and lowers the entropy threshold and
	// minimum token length to StrictEntropyThreshold and StrictMinTokenLen
	// (never raising them). It cannot be combined with DisableSoft or Allow.
	Strict bool
}

type Placeholder func(ruleID, matched string) string

type Redactor struct {
	// contains filtered or unexported fields
}

type Result struct {
	Text string
	Hits []Hit
}

type Rule struct {
	ID    string
	Class Class
}

type RuleInfo struct {
	ID      string
	Class   Class
	Pattern string
	Summary string
}