Documentation
¶
Overview ¶
Package redact provides functions for determining values to redact.
Index ¶
- Constants
- func MatchAny(patterns []string, name string) (matched bool, err error)
- func NeedlesFromEnv(patterns []string) (values, short []string, err error)
- func New(dst io.Writer, needles []string) *replacer.Replacer
- func Redacted([]byte) []byte
- func String(input string, needles []string) string
- func Vars(patterns []string, environment []env.Pair) (matched []env.Pair, short []string, err error)
Constants ¶
const LengthMin = 6
LengthMin is the shortest string length that will be considered a potential secret by the environment redactor. e.g. if the redactor is configured to filter out environment variables matching *_TOKEN, and API_TOKEN is set to "none", this minimum length will prevent the word "none" from being redacted from useful log output.
Variables ¶
This section is empty.
Functions ¶
func NeedlesFromEnv ¶
NeedlesFromEnv matches the patterns against os.Environ. It returns values to redact and the names of env vars with "short" values.
func String ¶
String is a convenience wrapper for redacting small strings. This is fine to call repeatedly with many separate strings, but avoid using this to redact large streams - it requires buffering the whole input and output.
func Vars ¶
func Vars(patterns []string, environment []env.Pair) (matched []env.Pair, short []string, err error)
Vars returns the variable names and values to be redacted, given a redaction config string and an environment map. It also returned variables whose names match the redacted-vars config, but whose values were too short.
Types ¶
This section is empty.
Source Files