Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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
- API
  
  Reference documentation for the pkg.go.dev API
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

leak

package

Go to main page

Versions in this module

v0

v0.13.0

Nov 13, 2026

v0.12.1

Nov 13, 2026

v0.12.0

Nov 10, 2026

Changes in this version

+ const DefaultSampleRows

+ var ErrAllowValue = errors.New("a value of --allow-email is neither an address nor a domain with a dot")

+ var ErrFileFormat = errors.New(...)

+ var ErrFileUnreadable = errors.New("can't read the file given to --hashes")

+ var ErrFileVersion = errors.New(...)

+ var ErrKeyFormat = errors.New(...)

+ var ErrKeyUTF16 = errors.New(...)

+ var ErrNothingSampled = errors.New(...)

+ var ErrNothingToHash = errors.New(...)

+ var ErrWrongKey = errors.New("this key isn't the one the hash file was made with")

+ func CatchChance(n, N, real float64) float64

+ func Compare(ctx context.Context, sess *dbconn.Session, f *File, key Key, ...) (*model.LeakResult, error)

+ func Gate(res *model.LeakResult, threshold model.Severity) (hits, unchecked int)

+ func ShownAt95(n, N float64) float64

+ func WriteNewKey(path string) error

+ type Allowlist struct

+ Domains []string

+ func NewAllowlist(values []string) (*Allowlist, error)

+ func (a *Allowlist) Addresses() int

+ type CompareOptions struct

+ Allow *Allowlist

+ FailExcept []string

+ MaxTime time.Duration

+ Progress func(done, total int, table string, rows int64)

+ Starting func(tables int, rowsEstimate int64)

+ Version string

+ type File struct

+ AllowDomains []string

+ AllowedAddresses int

+ Columns []FileColumn

+ CreatedAt time.Time

+ Database string

+ Format string

+ KeyCheck []byte

+ LeftOut []model.LeakLeftOut

+ Notice string

+ Salt []byte

+ SampleRows int

+ ToolVersion string

+ ValuesSkipped int64

+ Version int

+ Warnings []string

+ func Hash(ctx context.Context, sess *dbconn.Session, key Key, opts HashOptions) (*File, []string, error)

+ func ReadFile(path string) (*File, error)

+ func (f *File) CheckKey(k Key) error

+ func (f *File) String() string

+ func (f *File) Write(w io.Writer) error

+ type FileColumn struct

+ Column string

+ EstimatedValues int64

+ Exact bool

+ Hashes []byte

+ KeyColumn string

+ Kind model.LeakKind

+ MaxChars int

+ MetaKey string

+ RowsEstimate int64

+ RowsRead int64

+ Sample string

+ Table string

+ Values int

+ Whole bool

+ type HashOptions struct

+ Allow *Allowlist

+ Pick func(n uint64) uint64

+ Preset string

+ Progress func(done, total int, table string)

+ SampleRows int

+ ScanProgress func(done, total int, table string)

+ Version string

+ type Key struct

+ func ParseKey(text []byte) (Key, error)

+ func ReadKeyFile(path string) (k Key, worldReadable bool, err error)

+ func (Key) Format(f fmt.State, _ rune)