spider

Documentation

Overview

Package spider implements the logic for the `webscan spider` command. This command is used to crawl a list of URLs and report back the links found on each page, as well as any errors encountered during the crawl.

Index

• type LinkDetails
• type WebSpiderReport
  • func PerformWebSpider(ctx context.Context, targets string) (WebSpiderReport, error)

Types

type LinkDetails

type LinkDetails struct {
	Link   string `json:"link" yaml:"link"`
	Status int    `json:"status" yaml:"status"`
}

LinkDetails provides the details of a single link found during a web spider operation.

type WebSpiderReport

type WebSpiderReport struct {
	Targets []string      `json:"targets" yaml:"targets"`
	Links   []LinkDetails `json:"links" yaml:"links"`
	Errors  []string      `json:"errors" yaml:"errors"`
}

A WebSpiderReport represents a holistic report of all the links that were found during a web spider operation, including non-fatal errors that occurred during the operation.

func PerformWebSpider

func PerformWebSpider(ctx context.Context, targets string) (WebSpiderReport, error)

PerformWebSpider performs a web spider operation against the provided targets, returning a WebSpiderReport with the results of the spider.