redact

Documentation

Overview

Package redact provides functions for determining values to redact.

Index

• Constants
• func Redact([]byte) []byte
• func Values(logger shell.Logger, patterns []string, environment map[string]string) []string
• func Vars(logger shell.Logger, patterns []string, environment map[string]string) map[string]string

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 Redact

func Redact([]byte) []byte

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

func Values

func Values(logger shell.Logger, patterns []string, environment map[string]string) []string

Values returns the variable Values to be redacted, given a redaction config string and an environment map.

func Vars

func Vars(logger shell.Logger, patterns []string, environment map[string]string) map[string]string

Vars returns the variable names and values to be redacted, given a redaction config string and an environment map.