runner

Documentation

Index

• Variables
• func ListSources()
• func UnmarshalFrom(file string) error
• func WriteJSONResult(writer io.Writer, result *sources.Result, target string) error
• func WritePlainResult(writer io.Writer, verbose bool, result *sources.Result) error
• type Options
  • func (options *Options) ConfigureOutput()
• type Runner
  • func NewRunner(options *Options) (*Runner, error)
  • func (r *Runner) EnumerateMultipleTargets(ctx context.Context, reader io.Reader, writers []io.Writer) error
  • func (r *Runner) EnumerateSingleTarget(ctx context.Context, target string, scanType sources.ScanType, ...) error
  • func (r *Runner) RunEnumeration(ctx context.Context) error
• type Verifier
  • func NewVerifier(enabled bool) *Verifier
  • func (v *Verifier) EnrichResult(result *sources.Result)

Variables

var AllSources = [...]sources.Source{
	&sources.BreachDirectory{},
	&sources.DeHashed{},
	&sources.HudsonRock{},
	&sources.IntelX{},
	&sources.LeakCheck{},
	&sources.LeakLookup{},
	&sources.LeakSight{},
	&sources.OSINTLeak{},
	&sources.ProxyNova{},
	&sources.Snusbase{},
	&sources.WeLeakInfo{},
	&sources.WhiteIntel{},
}

AllSources are used to store all available sources

Functions

func ListSources

func ListSources()

ListSources prints all available sources to stdout.

func UnmarshalFrom

func UnmarshalFrom(file string) error

UnmarshalFrom writes the marshaled yaml config to disk

func WriteJSONResult

func WriteJSONResult(writer io.Writer, result *sources.Result, target string) error

func WritePlainResult

func WritePlainResult(writer io.Writer, verbose bool, result *sources.Result) error

Types

type Options

type Options struct {
	Debug           bool
	Insecure        bool // Insecure disables TLS certificate verification when true
	JSON            bool // JSON outputs results as JSONL (one JSON object per line)
	ListSources     bool
	NoDeduplication bool // NoDeduplication disables deduplication of results across sources
	NoFilter        bool
	NoRateLimit     bool
	Output          io.Writer
	OutputFile      string
	Overwrite       bool
	ProviderConfig  string // ProviderConfig contains the location of the provider config file
	Proxy           string
	Quiet           bool
	Sources         []string
	Stdin           bool
	Targets         string
	Timeout         time.Duration
	Type            sources.ScanType
	UserAgent       string
	Verbose         bool
	Verify          bool // Verify enriches results with HIBP password checks and hash identification
	Version         string
}

Options struct is used to store leaker options. Sort alphabetically

func (*Options) ConfigureOutput

func (options *Options) ConfigureOutput()

ConfigureOutput configures the output on the screen

type Runner

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

func NewRunner

func NewRunner(options *Options) (*Runner, error)

NewRunner creates a new runner struct instance by parsing the configuration options, configuring sources, reading lists and setting up loggers, etc.

func (*Runner) EnumerateMultipleTargets

func (r *Runner) EnumerateMultipleTargets(ctx context.Context, reader io.Reader, writers []io.Writer) error

func (*Runner) EnumerateSingleTarget

func (r *Runner) EnumerateSingleTarget(ctx context.Context, target string, scanType sources.ScanType, timeout time.Duration, writers []io.Writer) error

func (*Runner) RunEnumeration

func (r *Runner) RunEnumeration(ctx context.Context) error

type Verifier

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

Verifier enriches results with HIBP password breach counts and hash type identification.

func NewVerifier

func NewVerifier(enabled bool) *Verifier

NewVerifier creates a new Verifier. When enabled is false, EnrichResult is a no-op.

func (*Verifier) EnrichResult

func (v *Verifier) EnrichResult(result *sources.Result)

EnrichResult enriches a Result in-place with verification signals.