package network import ( "strconv" "strings" "github.com/pkg/errors" "github.com/projectdiscovery/fastdialer/fastdialer" "github.com/projectdiscovery/nuclei/v3/pkg/operators" "github.com/projectdiscovery/nuclei/v3/pkg/protocols" "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/expressions" "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/generators" "github.com/projectdiscovery/nuclei/v3/pkg/protocols/network/networkclientpool" errorutil "github.com/projectdiscovery/utils/errors" fileutil "github.com/projectdiscovery/utils/file" ) // Request contains a Network protocol request to be made from a template type Request struct { // ID is the optional id of the request ID string `yaml:"id,omitempty" json:"id,omitempty" jsonschema:"title=id of the request,description=ID of the network request"` // description: | // Host to send network requests to. // // Usually it's set to `{{Hostname}}`. If you want to enable TLS for // TCP Connection, you can use `tls://{{Hostname}}`. // examples: // - value: | // []string{"{{Hostname}}"} Address []string `yaml:"host,omitempty" json:"host,omitempty" jsonschema:"title=host to send requests to,description=Host to send network requests to"` addresses []addressKV // description: | // Attack is the type of payload combinations to perform. // // Batteringram is inserts the same payload into all defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates // permutations and combinations for all payloads. AttackType generators.AttackTypeHolder `yaml:"attack,omitempty" json:"attack,omitempty" jsonschema:"title=attack is the payload combination,description=Attack is the type of payload combinations to perform,enum=batteringram,enum=pitchfork,enum=clusterbomb"` // description: | // Payloads contains any payloads for the current request. // // Payloads support both key-values combinations where a list // of payloads is provided, or optionally a single file can also // be provided as payload which will be read on run-time. Payloads map[string]interface{} `yaml:"payloads,omitempty" json:"payloads,omitempty" jsonschema:"title=payloads for the network request,description=Payloads contains any payloads for the current request"` // description: | // Inputs contains inputs for the network socket Inputs []*Input `yaml:"inputs,omitempty" json:"inputs,omitempty" jsonschema:"title=inputs for the network request,description=Inputs contains any input/output for the current request"` // description: | // Port is the port to send network requests to. this acts as default port but is overriden if target/input contains // non-http(s) ports like 80,8080,8081 etc Port string `yaml:"port,omitempty" json:"port,omitempty" jsonschema:"title=port to send requests to,description=Port to send network requests to"` // description: | // ExcludePorts is the list of ports to exclude from being scanned . It is intended to be used with `Port` field and contains a list of ports which are ignored/skipped ExcludePorts string `yaml:"exclude-ports,omitempty" json:"exclude-ports,omitempty" jsonschema:"title=exclude ports from being scanned,description=Exclude ports from being scanned"` // description: | // ReadSize is the size of response to read at the end // // Default value for read-size is 1024. // examples: // - value: "2048" ReadSize int `yaml:"read-size,omitempty" json:"read-size,omitempty" jsonschema:"title=size of network response to read,description=Size of response to read at the end. Default is 1024 bytes"` // description: | // ReadAll determines if the data stream should be read till the end regardless of the size // // Default value for read-all is false. // examples: // - value: false ReadAll bool `yaml:"read-all,omitempty" json:"read-all,omitempty" jsonschema:"title=read all response stream,description=Read all response stream till the server stops sending"` // description: | // SelfContained specifies if the request is self-contained. SelfContained bool `yaml:"-" json:"-"` // description: | // ports is post processed list of ports to scan (obtained from Port) ports []string `yaml:"-" json:"-"` // Operators for the current request go here. operators.Operators `yaml:",inline,omitempty"` CompiledOperators *operators.Operators `yaml:"-"` generator *generators.PayloadGenerator // cache any variables that may be needed for operation. dialer *fastdialer.Dialer options *protocols.ExecutorOptions } // RequestPartDefinitions contains a mapping of request part definitions and their // description. Multiple definitions are separated by commas. // Definitions not having a name (generated on runtime) are prefixed & suffixed by <>. var RequestPartDefinitions = map[string]string{ "template-id": "ID of the template executed", "template-info": "Info Block of the template executed", "template-path": "Path of the template executed", "host": "Host is the input to the template", "matched": "Matched is the input which was matched upon", "type": "Type is the type of request made", "request": "Network request made from the client", "body,all,data": "Network response received from server (default)", "raw": "Full Network protocol data", } type addressKV struct { address string tls bool } // Input is the input to send on the network type Input struct { // description: | // Data is the data to send as the input. // // It supports DSL Helper Functions as well as normal expressions. // examples: // - value: "\"TEST\"" // - value: "\"hex_decode('50494e47')\"" Data string `yaml:"data,omitempty" json:"data,omitempty" jsonschema:"title=data to send as input,description=Data is the data to send as the input"` // description: | // Type is the type of input specified in `data` field. // // Default value is text, but hex can be used for hex formatted data. // values: // - "hex" // - "text" Type NetworkInputTypeHolder `yaml:"type,omitempty" json:"type,omitempty" jsonschema:"title=type is the type of input data,description=Type of input specified in data field,enum=hex,enum=text"` // description: | // Read is the number of bytes to read from socket. // // This can be used for protocols which expect an immediate response. You can // read and write responses one after another and eventually perform matching // on every data captured with `name` attribute. // // The [network docs](https://nuclei.projectdiscovery.io/templating-guide/protocols/network/) highlight more on how to do this. // examples: // - value: "1024" Read int `yaml:"read,omitempty" json:"read,omitempty" jsonschema:"title=bytes to read from socket,description=Number of bytes to read from socket"` // description: | // Name is the optional name of the data read to provide matching on. // examples: // - value: "\"prefix\"" Name string `yaml:"name,omitempty" json:"name,omitempty" jsonschema:"title=optional name for data read,description=Optional name of the data read to provide matching on"` } // GetID returns the unique ID of the request if any. func (request *Request) GetID() string { return request.ID } // Compile compiles the protocol request for further execution. func (request *Request) Compile(options *protocols.ExecutorOptions) error { var shouldUseTLS bool var err error request.options = options for _, address := range request.Address { // check if the connection should be encrypted if strings.HasPrefix(address, "tls://") { shouldUseTLS = true address = strings.TrimPrefix(address, "tls://") } request.addresses = append(request.addresses, addressKV{address: address, tls: shouldUseTLS}) } // Pre-compile any input dsl functions before executing the request. for _, input := range request.Inputs { if input.Type.String() != "" { continue } if compiled, evalErr := expressions.Evaluate(input.Data, map[string]interface{}{}); evalErr == nil { input.Data = compiled } } // parse ports and validate if request.Port != "" { for _, port := range strings.Split(request.Port, ",") { if port == "" { continue } portInt, err := strconv.Atoi(port) if err != nil { return errorutil.NewWithErr(err).Msgf("could not parse port %v from '%s'", port, request.Port) } if portInt < 1 || portInt > 65535 { return errorutil.NewWithTag(request.TemplateID, "port %v is not in valid range", portInt) } request.ports = append(request.ports, port) } } // Resolve payload paths from vars if they exists for name, payload := range request.options.Options.Vars.AsMap() { payloadStr, ok := payload.(string) // check if inputs contains the payload var hasPayloadName bool for _, input := range request.Inputs { if input.Type.String() != "" { continue } if expressions.ContainsVariablesWithNames(map[string]interface{}{name: payload}, input.Data) == nil { hasPayloadName = true break } } if ok && hasPayloadName && fileutil.FileExists(payloadStr) { if request.Payloads == nil { request.Payloads = make(map[string]interface{}) } request.Payloads[name] = payloadStr } } if len(request.Payloads) > 0 { request.generator, err = generators.New(request.Payloads, request.AttackType.Value, request.options.TemplatePath, request.options.Catalog, request.options.Options.AttackType, request.options.Options) if err != nil { return errors.Wrap(err, "could not parse payloads") } } // Create a client for the class client, err := networkclientpool.Get(options.Options, &networkclientpool.Configuration{}) if err != nil { return errors.Wrap(err, "could not get network client") } request.dialer = client if len(request.Matchers) > 0 || len(request.Extractors) > 0 { compiled := &request.Operators compiled.ExcludeMatchers = options.ExcludeMatchers compiled.TemplateID = options.TemplateID if err := compiled.Compile(); err != nil { return errors.Wrap(err, "could not compile operators") } request.CompiledOperators = compiled } return nil } // Requests returns the total number of requests the YAML rule will perform func (request *Request) Requests() int { return len(request.Address) }