runner

Documentation

Overview

Package runner executes the enumeration process.

Index

• Constants
• type Options
  • func ParseOptions() *Options
  • func (options *Options) ShouldLoadResume() bool
  • func (options *Options) ShouldSaveResume() bool
• type Result
  • func (r Result) CSVHeader() string
  • func (r Result) CSVRow(scanopts *scanOptions) string
  • func (r Result) JSON(scanopts *scanOptions) string
• type ResumeCfg
• type Runner
  • func New(options *Options) (*Runner, error)
  • func (r *Runner) Close()
  • func (r *Runner) RunEnumeration()
  • func (r *Runner) SaveResumeConfig() error

Constants

const (
	DefaultResumeFile = "resume.cfg"
)

const Version = `v1.1.3`

Version is the current version of httpx

Types

type Options

type Options struct {
	CustomHeaders customheader.CustomHeaders
	CustomPorts   customport.CustomPorts

	Output           string
	StoreResponseDir string
	HTTPProxy        string
	SocksProxy       string
	InputFile        string
	Methods          string
	RequestURI       string
	RequestURIs      string

	OutputMatchStatusCode     string
	OutputMatchContentLength  string
	OutputFilterStatusCode    string
	OutputFilterContentLength string
	InputRawRequest           string

	RequestBody        string
	OutputFilterString string
	OutputMatchString  string
	OutputFilterRegex  string
	OutputMatchRegex   string
	Retries            int
	Threads            int
	Timeout            int

	VHost              bool
	VHostInput         bool
	Smuggling          bool
	ExtractTitle       bool
	StatusCode         bool
	Location           bool
	ContentLength      bool
	FollowRedirects    bool
	StoreResponse      bool
	JSONOutput         bool
	CSVOutput          bool
	Silent             bool
	Version            bool
	Verbose            bool
	NoColor            bool
	CeyeApi            string
	CeyeDomain         string
	OutputServerHeader bool
	OutputWebSocket    bool

	FollowHostRedirects bool
	MaxRedirects        int
	OutputMethod        bool
	TLSProbe            bool
	CSPProbe            bool
	OutputContentType   bool
	OutputIP            bool
	OutputCName         bool
	Unsafe              bool
	Debug               bool
	Pipeline            bool
	HTTP2Probe          bool
	OutputCDN           bool
	OutputResponseTime  bool
	NoFallback          bool
	NoFallbackScheme    bool
	TechDetect          bool
	TLSGrab             bool

	ShowStatistics            bool
	RandomAgent               bool
	StoreChain                bool
	Deny                      customlist.CustomList
	Allow                     customlist.CustomList
	MaxResponseBodySizeToSave int
	MaxResponseBodySizeToRead int
	OutputExtractRegex        string
	RateLimit                 int
	Probe                     bool
	Resume                    bool

	ExcludeCDN    bool
	HostMaxErrors int
	Stream        bool
	SkipDedupe    bool
	Naabuinput    map[string]map[int]struct{}
	// contains filtered or unexported fields
}

Options contains configuration options for httpx.

func ParseOptions

func ParseOptions() *Options

ParseOptions parses the command line options for application

func (*Options) ShouldLoadResume

func (options *Options) ShouldLoadResume() bool

ShouldLoadResume resume file

func (*Options) ShouldSaveResume

func (options *Options) ShouldSaveResume() bool

ShouldSaveResume file

type Result

type Result struct {
	Timestamp      time.Time `json:"timestamp,omitempty" csv:"timestamp"`
	Request        string    `json:"request,omitempty" csv:"request"`
	ResponseHeader string    `json:"response-header,omitempty" csv:"response-header"`
	Scheme         string    `json:"scheme,omitempty" csv:"scheme"`
	Port           string    `json:"port,omitempty" csv:"port"`
	Path           string    `json:"path,omitempty" csv:"path"`
	BodySHA256     string    `json:"body-sha256,omitempty" csv:"body-sha256"`
	HeaderSHA256   string    `json:"header-sha256,omitempty" csv:"header-sha256"`
	A              []string  `json:"a,omitempty" csv:"a"`
	CNAMEs         []string  `json:"cnames,omitempty" csv:"cnames"`

	URL      string `json:"url,omitempty" csv:"url"`
	Input    string `json:"input,omitempty" csv:"input"`
	Location string `json:"location,omitempty" csv:"location"`
	Title    string `json:"title,omitempty" csv:"title"`

	Error            string              `json:"error,omitempty" csv:"error"`
	WebServer        string              `json:"webserver,omitempty" csv:"webserver"`
	ResponseBody     string              `json:"response-body,omitempty" csv:"response-body"`
	ContentType      string              `json:"content-type,omitempty" csv:"content-type"`
	Method           string              `json:"method,omitempty" csv:"method"`
	Host             string              `json:"host,omitempty" csv:"host"`
	ContentLength    int                 `json:"content-length,omitempty" csv:"content-length"`
	ChainStatusCodes []int               `json:"chain-status-codes,omitempty" csv:"chain-status-codes"`
	StatusCode       int                 `json:"status-code,omitempty" csv:"status-code"`
	TLSData          *cryptoutil.TLSData `json:"tls-grab,omitempty" csv:"tls-grab"`
	CSPData          *httpx.CSPData      `json:"csp,omitempty" csv:"csp"`
	VHost            bool                `json:"vhost,omitempty" csv:"vhost"`
	WebSocket        bool                `json:"websocket,omitempty" csv:"websocket"`
	Pipeline         bool                `json:"pipeline,omitempty" csv:"pipeline"`
	HTTP2            bool                `json:"http2,omitempty" csv:"http2"`
	CDN              bool                `json:"cdn,omitempty" csv:"cdn"`
	ResponseTime     string              `json:"response-time,omitempty" csv:"response-time"`
	Technologies     []string            `json:"technologies,omitempty" csv:"technologies"`
	Chain            []httpx.ChainItem   `json:"chain,omitempty" csv:"chain"`
	FinalURL         string              `json:"final-url,omitempty" csv:"final-url"`
	Failed           bool                `json:"failed" csv:"failed"`
	// contains filtered or unexported fields
}

Result of a scan

func (Result) CSVHeader

func (r Result) CSVHeader() string

CSVHeader the CSV headers

func (Result) CSVRow

func (r Result) CSVRow(scanopts *scanOptions) string

CSVRow the CSV Row

func (Result) JSON

func (r Result) JSON(scanopts *scanOptions) string

JSON the result

type ResumeCfg

type ResumeCfg struct {
	ResumeFrom string
	Index      int
	// contains filtered or unexported fields
}

type Runner

type Runner struct {
	HostErrorsCache gcache.Cache
	// 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 closes the httpx scan instance

func (*Runner) RunEnumeration

func (r *Runner) RunEnumeration()

RunEnumeration on targets for httpx client

func (*Runner) SaveResumeConfig

func (r *Runner) SaveResumeConfig() error

SaveResumeConfig to file