redact

Documentation

Overview

Package redact provides functions for determining values to redact.

Index

• Constants
• func MatchAny(patterns []string, name string) (matched bool, err error)
• func Redact([]byte) []byte
• 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.

Functions

func MatchAny

func MatchAny(patterns []string, name string) (matched bool, err error)

MatchAny reports if the name matches any of the patterns.

func Redact

func Redact([]byte) []byte

Redact ignores its input and returns "[REDACTED]".

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.