runner

Documentation

Index

• func GetUpdateCallback() func()
• type Options
  • func ParseOptions() *Options
• type OutputWriter
  • func NewOutputWriter() (*OutputWriter, error)
  • func (o *OutputWriter) AddWriters(writers ...io.Writer)
  • func (o *OutputWriter) Close()
  • func (o *OutputWriter) Write(data []byte)
  • func (o *OutputWriter) WriteJsonData(data sources.Result)
  • func (o *OutputWriter) WriteString(data string)
• type Runner
  • func NewRunner(options *Options) (*Runner, error)
  • func (r *Runner) Close()
  • func (r *Runner) Run(ctx context.Context) error

Functions

func GetUpdateCallback

func GetUpdateCallback() func()

GetUpdateCallback returns a callback function that updates uncover

Types

type Options

type Options struct {
	Query              goflags.StringSlice
	Engine             goflags.StringSlice
	ConfigFile         string
	ProviderFile       string
	OutputFile         string
	OutputFields       string
	JSON               bool
	Raw                bool
	Limit              int
	Silent             bool
	Verbose            bool
	NoColor            bool
	Timeout            int
	RateLimit          int
	RateLimitMinute    int
	Retries            int
	Shodan             goflags.StringSlice
	ShodanIdb          goflags.StringSlice
	Fofa               goflags.StringSlice
	Censys             goflags.StringSlice
	Quake              goflags.StringSlice
	Netlas             goflags.StringSlice
	Hunter             goflags.StringSlice
	ZoomEye            goflags.StringSlice
	CriminalIP         goflags.StringSlice
	Publicwww          goflags.StringSlice
	HunterHow          goflags.StringSlice
	Google             goflags.StringSlice
	DisableUpdateCheck bool
}

Options contains the configuration options for tuning the enumeration process.

func ParseOptions

func ParseOptions() *Options

ParseOptions parses the command line flags provided by a user

type OutputWriter

type OutputWriter struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

func NewOutputWriter

func NewOutputWriter() (*OutputWriter, error)

func (*OutputWriter) AddWriters

func (o *OutputWriter) AddWriters(writers ...io.Writer)

func (*OutputWriter) Close

func (o *OutputWriter) Close()

Close closes the output writers

func (*OutputWriter) Write

func (o *OutputWriter) Write(data []byte)

Write writes the data taken as input using only the writer(s) with that name.

func (*OutputWriter) WriteJsonData

func (o *OutputWriter) WriteJsonData(data sources.Result)

WriteJsonData writes the result taken as input in JSON format

func (*OutputWriter) WriteString

func (o *OutputWriter) WriteString(data string)

WriteString writes the string taken as input using only

type Runner

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

Runner is an instance of the uncover enumeration client used to orchestrate the whole process.

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) Close

func (r *Runner) Close()

Close closes its resources

func (*Runner) Run

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

RunEnumeration runs the subdomain enumeration flow on the targets specified