fuzz

Documentation

Overview

Package fuzz holds the data structures and logic necessary to perform web application fuzzing for the `networkscan fuzz` command

Index

• Constants
• func PrepareJob(conf *ffuf.Config) (*ffuf.Job, error)
• func SetupFilters(parseOpts *ffuf.ConfigOptions, conf *ffuf.Config) error
• type CustomOutput
  • func NewCustomOutput(conf *ffuf.Config) *CustomOutput
  • func (s *CustomOutput) Banner()
  • func (s *CustomOutput) Cycle()
  • func (s *CustomOutput) Error(errstring string)
  • func (s *CustomOutput) Finalize() error
  • func (s *CustomOutput) GetCurrentResults() []ffuf.Result
  • func (s *CustomOutput) Info(infostring string)
  • func (s *CustomOutput) PrintResult(res ffuf.Result)
  • func (s *CustomOutput) Progress(status ffuf.Progress)
  • func (s *CustomOutput) Raw(output string)
  • func (s *CustomOutput) Reset()
  • func (s *CustomOutput) Result(resp ffuf.Response)
  • func (s *CustomOutput) SaveFile(filename, format string) error
  • func (s *CustomOutput) SetCurrentResults(results []ffuf.Result)
  • func (s *CustomOutput) Warning(warnstring string)
• type PathReport
  • func PerformPathFuzz(ctx context.Context, target string, pathlist string, responsecodes string, ...) (PathReport, error)
• type URLDetails

Constants

const (
	TerminalClearLine = "\r\x1b[2K"
	AnsiClear         = "\x1b[0m"
	AnsiRed           = "\x1b[31m"
)

Functions

func PrepareJob

func PrepareJob(conf *ffuf.Config) (*ffuf.Job, error)

PrepareJob creates a new ffuf job with the provided configuration, leveraging the CustomOutput ffuf type to provide control over the output.

func SetupFilters

func SetupFilters(parseOpts *ffuf.ConfigOptions, conf *ffuf.Config) error

SetupFilters sets up the filters for the ffuf job based on the provided configuration options.

Types

type CustomOutput

type CustomOutput struct {
	Results        []ffuf.Result
	CurrentResults []ffuf.Result
	// contains filtered or unexported fields
}

CustomOutput is a custom output implementation for ffuf. This implementation is used to customize the output of the ffuf tool to provide easier data integration and automation capabilies within the webscan tool.

func NewCustomOutput

func NewCustomOutput(conf *ffuf.Config) *CustomOutput

NewCustomOutput creates a new CustomOutput instance with the provided ffuf configuration.

func (*CustomOutput) Banner

func (s *CustomOutput) Banner()

Banner prints the banner for the ffuf tool, displaying the version, method, URL, wordlist, and other metadata during the tool's execution.

func (*CustomOutput) Cycle

func (s *CustomOutput) Cycle()

Cycle appends the current results to the results list and performs a reset of the current results.

func (*CustomOutput) Error

func (s *CustomOutput) Error(errstring string)

func (*CustomOutput) Finalize

func (s *CustomOutput) Finalize() error

func (*CustomOutput) GetCurrentResults

func (s *CustomOutput) GetCurrentResults() []ffuf.Result

GetCurrentResults returns the current results for the CustomOutput instance.

func (*CustomOutput) Info

func (s *CustomOutput) Info(infostring string)

func (*CustomOutput) PrintResult

func (s *CustomOutput) PrintResult(res ffuf.Result)

func (*CustomOutput) Progress

func (s *CustomOutput) Progress(status ffuf.Progress)

Progress prints the current progress of the ffuf tool, including the request count, request rate, duration, and error count.

func (*CustomOutput) Raw

func (s *CustomOutput) Raw(output string)

func (*CustomOutput) Reset

func (s *CustomOutput) Reset()

Reset resets the current results for the CustomOutput instance.

func (*CustomOutput) Result

func (s *CustomOutput) Result(resp ffuf.Response)

func (*CustomOutput) SaveFile

func (s *CustomOutput) SaveFile(filename, format string) error

func (*CustomOutput) SetCurrentResults

func (s *CustomOutput) SetCurrentResults(results []ffuf.Result)

SetCurrentResults sets the current results for the CustomOutput instance.

func (*CustomOutput) Warning

func (s *CustomOutput) Warning(warnstring string)

type PathReport

type PathReport struct {
	Target string       `json:"target" yaml:"target"`
	URLs   []URLDetails `json:"urls" yaml:"urls"`
	Errors []string     `json:"errors" yaml:"errors"`
}

A PathReport represents a holistic report of all the URLs that were fuzzed during a path fuzzing operation, including non-fatal errors that occurred during the operation.

func PerformPathFuzz

func PerformPathFuzz(ctx context.Context, target string, pathlist string, responsecodes string, maxtime int) (PathReport, error)

PerformPathFuzz performs a path fuzzing operation against a target URL, using the provided pathlist and responsecodes

type URLDetails

type URLDetails struct {
	URL    string `json:"url" yaml:"url"`
	Status string `json:"status" yaml:"status"`
	Size   int64  `json:"size" yaml:"size"`
}

URLDetails provides the details of a single URL that was fuzzed.