runner

Documentation

Index

• Constants
• type Options
  • func ParseOptions() *Options
• type OutputWriter
  • func NewOutputWriter() (*OutputWriter, error)
  • func (o *OutputWriter) AddWriters(writers ...io.Writer)
  • func (o *OutputWriter) Write(data []byte)
  • func (o *OutputWriter) WriteString(data string)
• type Provider
  • func (provider *Provider) GetKeys() uncover.Keys
  • func (provider *Provider) HasKeys() bool
• type Runner
  • func NewRunner(options *Options) (*Runner, error)
  • func (r *Runner) Run(ctx context.Context, query ...string) error

Constants

const Version = `v0.0.4`

Version is the current version of uncover

Types

type Options

type Options struct {
	Query        goflags.FileCommaSeparatedStringSlice
	Engine       goflags.FileNormalizedStringSlice
	ConfigFile   string
	ProviderFile string
	OutputFile   string
	OutputFields string
	JSON         bool
	Raw          bool
	Limit        int
	Silent       bool
	Version      bool
	Verbose      bool
	NoColor      bool
	Timeout      int
	Delay        int

	Provider *Provider
	// contains filtered or unexported fields
}

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

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

func (*OutputWriter) WriteString

func (o *OutputWriter) WriteString(data string)

type Provider

type Provider struct {
	Shodan []string `yaml:"shodan"`
	Censys []string `yaml:"censys"`
	Fofa   []string `yaml:"fofa"`
}

func (*Provider) GetKeys

func (provider *Provider) GetKeys() uncover.Keys

func (*Provider) HasKeys

func (provider *Provider) HasKeys() bool

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

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

RunEnumeration runs the subdomain enumeration flow on the targets specified