Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

secrets

package

Go to main page

Versions in this module

v1

v1.3.0

Feb 25, 2024

Changes in this version

+ var DefaultDynamicRules = []DynamicRule

+ var DefaultStaticRules = []StaticRule

+ type DynamicDetector interface

+ SearchFile func(path string, body io.Reader) ([]FileMatch, error)

+ type DynamicRule struct

+ FilePattern *regexp.Regexp

+ MinEntropy float64

+ Name string

+ Pattern *regexp.Regexp

+ func ParseDynamicRules(userRules []config.UserDynamicRule) (rules []DynamicRule, errors []config.UserDynamicRule)

+ func (r DynamicRule) String() string

+ type FileMatch struct

+ Path string

+ Rule DynamicRule

+ Secret Secret

type Opts

+ UseDefaultDynamicRules bool

+ UseDefaultStaticRules bool

+ type StaticDetector interface

+ SearchText func(text string) ([]TextMatch, error)

+ type StaticRule struct

+ MinEntropy float64

+ Name string

+ Pattern *regexp.Regexp

+ func ParseStaticRules(userRules []config.UserStaticRule) (rules []StaticRule, errors []config.UserStaticRule)

+ func (r StaticRule) String() string

+ type TextMatch struct

+ EndPos int

+ FullText string

+ Rule StaticRule

+ Secret Secret

+ StartPos int

v1.2.2

Feb 19, 2024

v1.2.1

Feb 19, 2024

v1.2.0

Feb 19, 2024

Changes in this version

+ var DefaultRules = []Rule

+ func CalculateShannonEntropy(s string) (entropy float64)

+ type Detector interface

+ SearchText func(text string) ([]Match, error)

+ func NewDetector(opts Opts, rules ...Rule) Detector

+ type Match struct

+ EndPos int

+ FullText string

+ Rule Rule

+ Secret Secret

+ StartPos int

+ type Opts struct

+ UseDefaultRules bool

+ type Rule struct

+ MinEntropy float64

+ Name string

+ Pattern *regexp.Regexp

+ func ParseRules(userRules []config.UserRule) (rules []Rule, errors []config.UserRule)

+ func (r Rule) String() string

+ type Secret struct

+ Entropy float64

+ Value string

+ func (s Secret) String() string