libgobuster

Documentation

Index

• Constants
• type Gobuster
  • func NewGobuster(c context.Context, opts *Options, plugin GobusterPlugin) (*Gobuster, error)
  • func (g *Gobuster) ClearProgress()
  • func (g *Gobuster) DNSLookup(domain string) ([]string, error)
  • func (g *Gobuster) DNSLookupCname(domain string) (string, error)
  • func (g *Gobuster) Errors() <-chan error
  • func (g *Gobuster) GetConfigString() (string, error)
  • func (g *Gobuster) GetRequest(url string) (*int, *int64, error)
  • func (g *Gobuster) PrintProgress()
  • func (g *Gobuster) Results() <-chan Result
  • func (g *Gobuster) Start() error
• type GobusterPlugin
• type Options
  • func NewOptions() *Options
• type ProcessFunc
• type Result
  • func (r *Result) ToString(g *Gobuster) (string, error)
• type ResultToStringFunc
• type SetupFunc

Constants

const (
	// ModeDir represents -m dir
	ModeDir = "dir"
	// ModeDNS represents -m dns
	ModeDNS = "dns"
)

const (
	// VERSION contains the current gobuster version
	VERSION = "2.0.1"
)

Types

type Gobuster

type Gobuster struct {
	Opts *Options

	WildcardIps stringSet

	IsWildcard bool
	// contains filtered or unexported fields
}

Gobuster is the main object when creating a new run

func NewGobuster

func NewGobuster(c context.Context, opts *Options, plugin GobusterPlugin) (*Gobuster, error)

NewGobuster returns a new Gobuster object

func (*Gobuster) ClearProgress

func (g *Gobuster) ClearProgress()

ClearProgress removes the last status line from stderr

func (*Gobuster) DNSLookup

func (g *Gobuster) DNSLookup(domain string) ([]string, error)

DNSLookup looks up a domain via system default DNS servers

func (*Gobuster) DNSLookupCname

func (g *Gobuster) DNSLookupCname(domain string) (string, error)

DNSLookupCname looks up a CNAME record via system default DNS servers

func (*Gobuster) Errors

func (g *Gobuster) Errors() <-chan error

Errors returns a channel of errors

func (*Gobuster) GetConfigString

func (g *Gobuster) GetConfigString() (string, error)

GetConfigString returns the current config as a printable string

func (*Gobuster) GetRequest

func (g *Gobuster) GetRequest(url string) (*int, *int64, error)

GetRequest issues a GET request to the target and returns the status code, length and an error

func (*Gobuster) PrintProgress

func (g *Gobuster) PrintProgress()

PrintProgress outputs the current wordlist progress to stderr

func (*Gobuster) Results

func (g *Gobuster) Results() <-chan Result

Results returns a channel of Results

func (*Gobuster) Start

func (g *Gobuster) Start() error

Start the busting of the website with the given set of settings from the command line.

type GobusterPlugin

type GobusterPlugin interface {
	Setup(*Gobuster) error
	Process(*Gobuster, string) ([]Result, error)
	ResultToString(*Gobuster, *Result) (*string, error)
}

GobusterPlugin is an interface which plugins must implement

type Options

type Options struct {
	Extensions        string
	ExtensionsParsed  stringSet
	Mode              string
	Password          string
	StatusCodes       string
	StatusCodesParsed intSet
	Threads           int
	URL               string
	UserAgent         string
	Username          string
	Wordlist          string
	Proxy             string
	Cookies           string
	Timeout           time.Duration
	FollowRedirect    bool
	IncludeLength     bool
	NoStatus          bool
	NoProgress        bool
	Expanded          bool
	Quiet             bool
	ShowIPs           bool
	ShowCNAME         bool
	InsecureSSL       bool
	WildcardForced    bool
	Verbose           bool
	UseSlash          bool
}

Options helds all options that can be passed to libgobuster

func NewOptions

func NewOptions() *Options

NewOptions returns a new initialized Options object

type ProcessFunc

type ProcessFunc func(*Gobuster, string) ([]Result, error)

ProcessFunc is the "process" function prototype for implementations

type Result

type Result struct {
	Entity string
	Status int
	Extra  string
	Size   *int64
}

Result represents a single gobuster result

func (*Result) ToString

func (r *Result) ToString(g *Gobuster) (string, error)

ToString converts the Result to it's textual representation

type ResultToStringFunc

type ResultToStringFunc func(*Gobuster, *Result) (*string, error)

ResultToStringFunc is the "to string" function prototype for implementations

type SetupFunc

type SetupFunc func(*Gobuster) error

SetupFunc is the "setup" function prototype for implementations