redact

Documentation

Index

• Constants
• Variables
• func Redact(input io.Reader, path string, ...) (io.Reader, error)
• func ResetRedactionList()
• type LineRedactor
• type MultiLineRedactor
  • func NewMultiLineRedactor(re1 LineRedactor, re2 string, maskText, path, name string, isDefault bool) (*MultiLineRedactor, error)
  • func (r *MultiLineRedactor) Redact(input io.Reader, path string) io.Reader
• type Redaction
• type RedactionList
  • func GetRedactionList() RedactionList
• type Redactor
• type SingleLineRedactor
  • func NewSingleLineRedactor(re LineRedactor, maskText, path, name string, isDefault bool) (*SingleLineRedactor, error)
  • func (r *SingleLineRedactor) Redact(input io.Reader, path string) io.Reader
• type YamlRedactor
  • func NewYamlRedactor(yamlPath, filePath, name string) *YamlRedactor
  • func (r *YamlRedactor) Redact(input io.Reader, path string) io.Reader

Constants

const (
	MASK_TEXT = "***HIDDEN***"
)

Variables

var NEW_LINE = []byte{'\n'}

Functions

func Redact

func Redact(input io.Reader, path string, additionalRedactors []*troubleshootv1beta2.Redact) (io.Reader, error)

func ResetRedactionList

func ResetRedactionList()

Types

type LineRedactor

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

type MultiLineRedactor

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

func NewMultiLineRedactor

func NewMultiLineRedactor(re1 LineRedactor, re2 string, maskText, path, name string, isDefault bool) (*MultiLineRedactor, error)

func (*MultiLineRedactor) Redact

func (r *MultiLineRedactor) Redact(input io.Reader, path string) io.Reader

type Redaction

type Redaction struct {
	RedactorName      string `json:"redactorName" yaml:"redactorName"`
	CharactersRemoved int    `json:"charactersRemoved" yaml:"charactersRemoved"`
	Line              int    `json:"line" yaml:"line"`
	File              string `json:"file" yaml:"file"`
	IsDefaultRedactor bool   `json:"isDefaultRedactor" yaml:"isDefaultRedactor"`
}

type RedactionList

type RedactionList struct {
	ByRedactor map[string][]Redaction `json:"byRedactor" yaml:"byRedactor"`
	ByFile     map[string][]Redaction `json:"byFile" yaml:"byFile"`
}

Redactions are indexed both by the file affected and by the name of the redactor

func GetRedactionList

func GetRedactionList() RedactionList

type Redactor

type Redactor interface {
	Redact(input io.Reader, path string) io.Reader
}

type SingleLineRedactor

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

func NewSingleLineRedactor

func NewSingleLineRedactor(re LineRedactor, maskText, path, name string, isDefault bool) (*SingleLineRedactor, error)

func (*SingleLineRedactor) Redact

func (r *SingleLineRedactor) Redact(input io.Reader, path string) io.Reader

type YamlRedactor

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

func NewYamlRedactor

func NewYamlRedactor(yamlPath, filePath, name string) *YamlRedactor

func (*YamlRedactor) Redact

func (r *YamlRedactor) Redact(input io.Reader, path string) io.Reader