runner

Documentation

Overview

Package runner executes the enumeration process.

Index

• Constants
• type Options
  • func ParseOptions() *Options
• type Runner
  • func New(options *Options) (*Runner, error)
  • func (r *Runner) Close()
  • func (r *Runner) RunEnumeration()

Constants

const Version = `1.1.7`

Version is the current version of nuclei

Types

type Options

type Options struct {
	Debug         bool                   // Debug mode allows debugging request/responses for the engine
	Templates     string                 // Signature specifies the template/templates to use
	Targets       string                 // Targets specifies the targets to scan using templates.
	Threads       int                    // Thread controls the number of concurrent requests to make.
	Timeout       int                    // Timeout is the seconds to wait for a response from the server.
	Retries       int                    // Retries is the number of times to retry the request
	Output        string                 // Output is the file to write found subdomains to.
	ProxyURL      string                 // ProxyURL is the URL for the proxy server
	ProxySocksURL string                 // ProxySocksURL is the URL for the proxy socks server
	Silent        bool                   // Silent suppresses any extra text and only writes found URLs on screen.
	Version       bool                   // Version specifies if we should just show version and exit
	Verbose       bool                   // Verbose flag indicates whether to show verbose output or not
	NoColor       bool                   // No-Color disables the colored output.
	CustomHeaders requests.CustomHeaders // Custom global headers

	Stdin bool // Stdin specifies whether stdin input was given to the process
}

Options contains the configuration options for tuning the template requesting process.

func ParseOptions

func ParseOptions() *Options

ParseOptions parses the command line flags provided by a user

type Runner

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

Runner is a client for running the enumeration process.

func New

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

New creates a new client for running enumeration process.

func (*Runner) Close

func (r *Runner) Close()

Close releases all the resources and cleans up

func (*Runner) RunEnumeration

func (r *Runner) RunEnumeration()

RunEnumeration sets up the input layer for giving input nuclei. binary and runs the actual enumeration