mirror of https://github.com/daffainfo/nuclei.git
86 lines
4.0 KiB
Go
86 lines
4.0 KiB
Go
package protocols
|
|
|
|
import (
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/catalog"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/model"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/operators"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/operators/extractors"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/operators/matchers"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/output"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/progress"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/projectfile"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/hosterrorscache"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/interactsh"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/headless/engine"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/reporting"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/types"
|
|
"go.uber.org/ratelimit"
|
|
)
|
|
|
|
// Executer is an interface implemented any protocol based request executer.
|
|
type Executer interface {
|
|
// Compile compiles the execution generators preparing any requests possible.
|
|
Compile() error
|
|
// Requests returns the total number of requests the rule will perform
|
|
Requests() int
|
|
// Execute executes the protocol group and returns true or false if results were found.
|
|
Execute(input string) (bool, error)
|
|
// ExecuteWithResults executes the protocol requests and returns results instead of writing them.
|
|
ExecuteWithResults(input string, callback OutputEventCallback) error
|
|
}
|
|
|
|
// ExecuterOptions contains the configuration options for executer clients
|
|
type ExecuterOptions struct {
|
|
// TemplateID is the ID of the template for the request
|
|
TemplateID string
|
|
// TemplatePath is the path of the template for the request
|
|
TemplatePath string
|
|
// TemplateInfo contains information block of the template request
|
|
TemplateInfo model.Info
|
|
// Output is a writer interface for writing output events from executer.
|
|
Output output.Writer
|
|
// Options contains configuration options for the executer.
|
|
Options *types.Options
|
|
// IssuesClient is a client for nuclei issue tracker reporting
|
|
IssuesClient *reporting.Client
|
|
// Progress is a progress client for scan reporting
|
|
Progress progress.Progress
|
|
// RateLimiter is a rate-limiter for limiting sent number of requests.
|
|
RateLimiter ratelimit.Limiter
|
|
// Catalog is a template catalog implementation for nuclei
|
|
Catalog *catalog.Catalog
|
|
// ProjectFile is the project file for nuclei
|
|
ProjectFile *projectfile.ProjectFile
|
|
// Browser is a browser engine for running headless templates
|
|
Browser *engine.Browser
|
|
// Interactsh is a client for interactsh oob polling server
|
|
Interactsh *interactsh.Client
|
|
// HostErrorsCache is an optional cache for handling host errors
|
|
HostErrorsCache *hosterrorscache.Cache
|
|
|
|
Operators []*operators.Operators // only used by offlinehttp module
|
|
|
|
WorkflowLoader model.WorkflowLoader
|
|
}
|
|
|
|
// Request is an interface implemented any protocol based request generator.
|
|
type Request interface {
|
|
// Compile compiles the request generators preparing any requests possible.
|
|
Compile(options *ExecuterOptions) error
|
|
// Requests returns the total number of requests the rule will perform
|
|
Requests() int
|
|
// GetID returns the ID for the request if any. IDs are used for multi-request
|
|
// condition matching. So, two requests can be sent and their match can
|
|
// be evaluated from the third request by using the IDs for both requests.
|
|
GetID() string
|
|
// Match performs matching operation for a matcher on model and returns true or false.
|
|
Match(data map[string]interface{}, matcher *matchers.Matcher) bool
|
|
// Extract performs extracting operation for a extractor on model and returns true or false.
|
|
Extract(data map[string]interface{}, matcher *extractors.Extractor) map[string]struct{}
|
|
// ExecuteWithResults executes the protocol requests and returns results instead of writing them.
|
|
ExecuteWithResults(input string, dynamicValues, previous output.InternalEvent, callback OutputEventCallback) error
|
|
}
|
|
|
|
// OutputEventCallback is a callback event for any results found during scanning.
|
|
type OutputEventCallback func(result *output.InternalWrappedEvent)
|