modules

Documentation

Index

• type Artifact
• type Module
• type NucleiOptions
• type Registry
  • func NewRegistry() *Registry
  • func (r *Registry) Get(name string) (Module, bool)
  • func (r *Registry) Register(m Module)
  • func (r *Registry) Resolve(names []string) ([]Module, error)
• type Result
• type RunContext
  • func NewRunContext(target, profile string, dryRun bool, run *storage.Run, ...) *RunContext
  • func (c *RunContext) AddArtifact(name string, artifact Artifact) error
  • func (c *RunContext) GetArtifact(name string) (Artifact, bool)
  • func (c *RunContext) HeaderArgs(flag string) []string
  • func (c *RunContext) MustArtifact(name string) (Artifact, error)
  • func (c *RunContext) ProxyArgs(flag string) []string
  • func (c *RunContext) ProxyHost() string

Types

type Artifact

type Artifact struct {
	Name string
	Type string
	Path string
}

type Module

type Module interface {
	Name() string
	Description() string
	Requires() []string
	Produces() []string
	Run(ctx context.Context, runCtx *RunContext, executor runner.Executor) (*Result, error)
}

type NucleiOptions

type NucleiOptions struct {
	Severity        string
	ExcludeSeverity string
	Tags            string
	ExcludeTags     string
	RateLimit       int
	TemplatesDir    string
	UpdateTemplates bool
}

NucleiOptions configures the nuclei module's template selection and pacing.

type Registry

type Registry struct {
	// contains filtered or unexported fields
}

func NewRegistry

func NewRegistry() *Registry

func (*Registry) Get

func (r *Registry) Get(name string) (Module, bool)

func (*Registry) Register

func (r *Registry) Register(m Module)

func (*Registry) Resolve

func (r *Registry) Resolve(names []string) ([]Module, error)

type Result

type Result struct {
	Name        string
	Status      string
	OutputFiles map[string]string
}

type RunContext

type RunContext struct {
	Target    string
	Profile   string
	DryRun    bool
	Run       *storage.Run
	Scope     *scanScope.Scope
	Artifacts map[string]Artifact

	// Proxy is an optional HTTP/SOCKS proxy (e.g. a Caido or Burp listener
	// such as http://127.0.0.1:8080) that HTTP-capable modules route their
	// traffic through, so findings can be intercepted and triaged manually.
	Proxy string
	// Headers are raw "Name: Value" entries applied to every outgoing HTTP
	// request by modules that support it (e.g. session cookies or auth
	// tokens for authenticated scanning).
	Headers []string
	// Nuclei carries nuclei-specific tuning that has no equivalent in other
	// modules (severity/tag filtering, rate limiting, custom templates).
	Nuclei NucleiOptions
	// NmapConcurrency bounds how many nmap processes run at once. <= 0 means
	// the module picks its own default.
	NmapConcurrency int
	// contains filtered or unexported fields
}

func NewRunContext

func NewRunContext(target, profile string, dryRun bool, run *storage.Run, scopes ...*scanScope.Scope) *RunContext

func (*RunContext) AddArtifact

func (c *RunContext) AddArtifact(name string, artifact Artifact) error

AddArtifact publishes a module output for downstream consumers. Text artifacts are filtered in place first, making this the central scope boundary for all line-oriented host, URL, IP, and host:port lists.

func (*RunContext) GetArtifact

func (c *RunContext) GetArtifact(name string) (Artifact, bool)

func (*RunContext) HeaderArgs

func (c *RunContext) HeaderArgs(flag string) []string

HeaderArgs returns repeated flag/value pairs, one per configured header, suitable for tools that accept custom headers as repeatable CLI flags (e.g. "-H" "Authorization: Bearer ...").

func (*RunContext) MustArtifact

func (c *RunContext) MustArtifact(name string) (Artifact, error)

func (*RunContext) ProxyArgs

func (c *RunContext) ProxyArgs(flag string) []string

ProxyArgs returns the flag/value pair to append to a command's args when a proxy is configured, or nil otherwise. flag is the tool-specific proxy option (e.g. "-proxy", "-x", "--proxy").

func (*RunContext) ProxyHost

func (c *RunContext) ProxyHost() string

ProxyHost returns the configured proxy without its scheme, for tools that expect a bare host[:port] rather than a URL (e.g. whatweb's --proxy).