mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-18 15:25:26 +00:00
1fbbca66f9
* Adding support to scan all v4/v6 IPs * adding tests * metainput prototype * using new signature * fixing nil pointer * adding request context with metadata * removing log instruction * fixing merge conflicts * adding clone helpers * attempting to fix ipv6 square parenthesis wrap * fixing dialed ip info * fixing syntax * fixing output ip selection * adding integration tests * disabling test due to gh ipv6 issue * using ipv4 only due to GH limited networking * extending metainput marshaling * fixing hmap key * adding test for httpx integration * fixing lint error * reworking marshaling/id-calculation * adding ip version validation * improving handling non url targets * fixing condition check
66 lines
2.0 KiB
Go
66 lines
2.0 KiB
Go
package core
|
|
|
|
import (
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/contextargs"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/types"
|
|
)
|
|
|
|
// Engine is an executer for running Nuclei Templates/Workflows.
|
|
//
|
|
// The engine contains multiple thread pools which allow using different
|
|
// concurrency values per protocol executed.
|
|
//
|
|
// The engine does most of the heavy lifting of execution, from clustering
|
|
// templates to leading to the final execution by the work pool, it is
|
|
// handled by the engine.
|
|
type Engine struct {
|
|
workPool *WorkPool
|
|
options *types.Options
|
|
executerOpts protocols.ExecuterOptions
|
|
}
|
|
|
|
// InputProvider is an input providing interface for the nuclei execution
|
|
// engine.
|
|
//
|
|
// An example InputProvider implementation is provided in form of hybrid
|
|
// input provider in pkg/core/inputs/hybrid/hmap.go
|
|
type InputProvider interface {
|
|
// Count returns the number of items for input provider
|
|
Count() int64
|
|
// Scan iterates the input and each found item is passed to the
|
|
// callback consumer.
|
|
Scan(callback func(value *contextargs.MetaInput) bool)
|
|
}
|
|
|
|
// New returns a new Engine instance
|
|
func New(options *types.Options) *Engine {
|
|
workPool := NewWorkPool(WorkPoolConfig{
|
|
InputConcurrency: options.BulkSize,
|
|
TypeConcurrency: options.TemplateThreads,
|
|
HeadlessInputConcurrency: options.HeadlessBulkSize,
|
|
HeadlessTypeConcurrency: options.HeadlessTemplateThreads,
|
|
})
|
|
engine := &Engine{
|
|
options: options,
|
|
workPool: workPool,
|
|
}
|
|
return engine
|
|
}
|
|
|
|
// SetExecuterOptions sets the executer options for the engine. This is required
|
|
// before using the engine to perform any execution.
|
|
func (e *Engine) SetExecuterOptions(options protocols.ExecuterOptions) {
|
|
e.executerOpts = options
|
|
}
|
|
|
|
// ExecuterOptions returns protocols.ExecuterOptions for nuclei engine.
|
|
func (e *Engine) ExecuterOptions() protocols.ExecuterOptions {
|
|
return e.executerOpts
|
|
}
|
|
|
|
// WorkPool returns the worker pool for the engine
|
|
func (e *Engine) WorkPool() *WorkPool {
|
|
return e.workPool
|
|
}
|