scan

Documentation

Index

• func Run(ctx context.Context, cfg Config, events chan<- Event)
• type Config
• type Event
• type EventKind

Functions

func Run

func Run(ctx context.Context, cfg Config, events chan<- Event)

Run executes the subdomain scan, sending events to the provided channel. The caller must close or cancel ctx to abort early. Run closes events when the scan completes.

Types

type Config

type Config struct {
	Domain      string
	Entries     []string
	Concurrency int
	Timeout     time.Duration
	DNSServer   string
	Simulate    bool
	HitRate     int
	Attempts    int
	Force       bool
	Verbose     bool
}

Config holds all parameters needed to run a subdomain scan.

type Event

type Event struct {
	Kind      EventKind
	Domain    string // EventResult: the resolved subdomain
	Processed int64  // EventProgress
	Total     int64  // EventProgress
	Found     int64  // EventProgress / EventDone
	Message   string // EventError / EventWildcard
}

Event is emitted on the events channel during a scan.

type EventKind

type EventKind int

EventKind categorises a scan event.

const (
	EventResult   EventKind = iota // a subdomain resolved
	EventProgress                  // progress update
	EventWildcard                  // wildcard DNS detected
	EventError                     // non-fatal error message
	EventDone                      // scan finished
)