secrets

Documentation

Index

• func IsTextFile(path string) bool
• func MaskAll(content string) string
• func MaskSecretKeyBlocks(content string) string
• type RuleSet
  • func DefaultRuleSet() *RuleSet
  • func (r *RuleSet) AddAllowed(pattern string) error
  • func (r *RuleSet) AddPattern(pattern string) error
  • func (r *RuleSet) AddValueMaskKey(keywordList []string)
  • func (r *RuleSet) ScanDir(root string, recursive bool) ([]SecretMatch, error)
  • func (r *RuleSet) ScanFile(path string) ([]SecretMatch, error)
  • func (r *RuleSet) ScanReader(rd io.Reader, filename string) ([]SecretMatch, error)
• type SecretMatch
• type ValueMaskRule
  • func (r *ValueMaskRule) MaskLine(line string) string

Functions

func IsTextFile

func IsTextFile(path string) bool

func MaskAll

func MaskAll(content string) string

func MaskSecretKeyBlocks

func MaskSecretKeyBlocks(content string) string

Types

type RuleSet

type RuleSet struct {
	FullMaskPatterns []*regexp.Regexp // Default+Added patterns (order matters!)
	Allowed          []*regexp.Regexp
	ValueMaskRules   []*ValueMaskRule
}

func DefaultRuleSet

func DefaultRuleSet() *RuleSet

func (*RuleSet) AddAllowed

func (r *RuleSet) AddAllowed(pattern string) error

func (*RuleSet) AddPattern

func (r *RuleSet) AddPattern(pattern string) error

func (*RuleSet) AddValueMaskKey

func (r *RuleSet) AddValueMaskKey(keywordList []string)

func (*RuleSet) ScanDir

func (r *RuleSet) ScanDir(root string, recursive bool) ([]SecretMatch, error)

func (*RuleSet) ScanFile

func (r *RuleSet) ScanFile(path string) ([]SecretMatch, error)

func (*RuleSet) ScanReader

func (r *RuleSet) ScanReader(rd io.Reader, filename string) ([]SecretMatch, error)

type SecretMatch

type SecretMatch struct {
	File    string
	Line    int
	Text    string
	Pattern string
}

type ValueMaskRule

type ValueMaskRule struct {
	KeyPattern *regexp.Regexp
}

func (*ValueMaskRule) MaskLine

func (r *ValueMaskRule) MaskLine(line string) string