runner

Documentation

Overview

Package runner executes the enumeration process.

Index

• Constants
• Variables
• func AuthWithPDCP()
• func ConfigureOptions() error
• func DoHealthCheck(options *types.Options) string
• func GetAuthTmplStore(opts types.Options, catalog catalog.Catalog, ...) (*loader.Store, error)
• func GetLazyAuthFetchCallback(opts *AuthLazyFetchOptions) authx.LazyFetchSecret
• func NucleiToolUpdateCallback()
• func ParseOptions(options *types.Options)
• func UploadResultsToCloud(options *types.Options) error
• func ValidateOptions(options *types.Options) error
• func Walk(s interface{}, callback WalkFunc)
• type AuthLazyFetchOptions
• type Runner
  • func New(options *types.Options) (*Runner, error)
  • func (r *Runner) Close()
  • func (r *Runner) RunEnumeration() error
  • func (r *Runner) SaveResumeConfig(path string) error
• type WalkFunc

Constants

const (
	// Default directory used to save protocols traffic
	DefaultDumpTrafficOutputFolder = "output"
)

Variables

var (
	// HideAutoSaveMsg is a global variable to hide the auto-save message
	HideAutoSaveMsg = false
	// EnableCloudUpload is global variable to enable cloud upload
	EnableCloudUpload = false
)

Functions

func AuthWithPDCP

func AuthWithPDCP()

AuthWithPDCP is used to authenticate with PDCP

func ConfigureOptions

func ConfigureOptions() error

func DoHealthCheck

func DoHealthCheck(options *types.Options) string

DoHealthCheck performs self-diagnostic checks

func GetAuthTmplStore

func GetAuthTmplStore(opts types.Options, catalog catalog.Catalog, execOpts protocols.ExecutorOptions) (*loader.Store, error)

GetAuthTmplStore create new loader for loading auth templates

func GetLazyAuthFetchCallback

func GetLazyAuthFetchCallback(opts *AuthLazyFetchOptions) authx.LazyFetchSecret

GetLazyAuthFetchCallback returns a lazy fetch callback for auth secrets

func NucleiToolUpdateCallback

func NucleiToolUpdateCallback()

NucleiToolUpdateCallback updates nuclei binary/tool to latest version

func ParseOptions

func ParseOptions(options *types.Options)

ParseOptions parses the command line flags provided by a user

func UploadResultsToCloud

func UploadResultsToCloud(options *types.Options) error

upload existing scan results to cloud with progress

func ValidateOptions

func ValidateOptions(options *types.Options) error

validateOptions validates the configuration options passed

func Walk

func Walk(s interface{}, callback WalkFunc)

Walk traverses a struct and executes a callback function on each value in the struct. The interface{} passed to the function should be a pointer to a struct or a struct. WalkFunc is the callback function used for each value in the struct. It is passed the reflect.Value and reflect.Type properties of the value in the struct.

Types

type AuthLazyFetchOptions

type AuthLazyFetchOptions struct {
	TemplateStore *loader.Store
	ExecOpts      protocols.ExecutorOptions
	OnError       func(error)
}

type Runner

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

Runner is a client for running the enumeration process.

func New

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

New creates a new client for running the enumeration process.

func (*Runner) Close

func (r *Runner) Close()

Close releases all the resources and cleans up

func (*Runner) RunEnumeration

func (r *Runner) RunEnumeration() error

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

func (*Runner) SaveResumeConfig

func (r *Runner) SaveResumeConfig(path string) error

SaveResumeConfig to file

type WalkFunc

type WalkFunc func(reflect.Value, reflect.StructField)