mirror of
https://github.com/projectdiscovery/nuclei.git
synced 2025-12-17 19:25:26 +00:00
283 lines
14 KiB
Go
283 lines
14 KiB
Go
package http
|
|
|
|
import (
|
|
"fmt"
|
|
"strings"
|
|
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/projectdiscovery/fileutil"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/operators"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/expressions"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/common/generators"
|
|
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/http/httpclientpool"
|
|
"github.com/projectdiscovery/rawhttp"
|
|
"github.com/projectdiscovery/retryablehttp-go"
|
|
)
|
|
|
|
// Request contains a http request to be made from a template
|
|
type Request struct {
|
|
// Operators for the current request go here.
|
|
operators.Operators `yaml:",inline"`
|
|
// description: |
|
|
// Path contains the path/s for the HTTP requests. It supports variables
|
|
// as placeholders.
|
|
// examples:
|
|
// - name: Some example path values
|
|
// value: >
|
|
// []string{"{{BaseURL}}", "{{BaseURL}}/+CSCOU+/../+CSCOE+/files/file_list.json?path=/sessions"}
|
|
Path []string `yaml:"path,omitempty" jsonschema:"title=path(s) for the http request,description=Path(s) to send http requests to"`
|
|
// description: |
|
|
// Raw contains HTTP Requests in Raw format.
|
|
// examples:
|
|
// - name: Some example raw requests
|
|
// value: |
|
|
// []string{"GET /etc/passwd HTTP/1.1\nHost:\nContent-Length: 4", "POST /.%0d./.%0d./.%0d./.%0d./bin/sh HTTP/1.1\nHost: {{Hostname}}\nUser-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:71.0) Gecko/20100101 Firefox/71.0\nContent-Length: 1\nConnection: close\n\necho\necho\ncat /etc/passwd 2>&1"}
|
|
Raw []string `yaml:"raw,omitempty" jsonschema:"http requests in raw format,description=HTTP Requests in Raw Format"`
|
|
// ID is the optional id of the request
|
|
ID string `yaml:"id,omitempty" jsonschema:"title=id for the http request,description=ID for the HTTP Request"`
|
|
// description: |
|
|
// Name is the optional name of the request.
|
|
//
|
|
// If a name is specified, all the named request in a template can be matched upon
|
|
// in a combined manner allowing multirequest based matchers.
|
|
Name string `yaml:"name,omitempty" jsonschema:"title=name for the http request,description=Optional name for the HTTP Request"`
|
|
// description: |
|
|
// Attack is the type of payload combinations to perform.
|
|
//
|
|
// batteringram is same payload into all of the defined payload positions at once, pitchfork combines multiple payload sets and clusterbomb generates
|
|
// permutations and combinations for all payloads.
|
|
// values:
|
|
// - "batteringram"
|
|
// - "pitchfork"
|
|
// - "clusterbomb"
|
|
AttackType generators.AttackTypeHolder `yaml:"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: |
|
|
// Method is the HTTP Request Method.
|
|
Method HTTPMethodTypeHolder `yaml:"method,omitempty" jsonschema:"title=method is the http request method,description=Method is the HTTP Request Method,enum=GET,enum=HEAD,enum=POST,enum=PUT,enum=DELETE,enum=CONNECT,enum=OPTIONS,enum=TRACE,enum=PATCH,enum=PURGE"`
|
|
// description: |
|
|
// Body is an optional parameter which contains HTTP Request body.
|
|
// examples:
|
|
// - name: Same Body for a Login POST request
|
|
// value: "\"username=test&password=test\""
|
|
Body string `yaml:"body,omitempty" jsonschema:"title=body is the http request body,description=Body is an optional parameter which contains HTTP Request body"`
|
|
// 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" jsonschema:"title=payloads for the http request,description=Payloads contains any payloads for the current request"`
|
|
// description: |
|
|
// Headers contains HTTP Headers to send with the request.
|
|
// examples:
|
|
// - value: |
|
|
// map[string]string{"Content-Type": "application/x-www-form-urlencoded", "Content-Length": "1", "Any-Header": "Any-Value"}
|
|
Headers map[string]string `yaml:"headers,omitempty" jsonschema:"title=headers to send with the http request,description=Headers contains HTTP Headers to send with the request"`
|
|
// description: |
|
|
// RaceCount is the number of times to send a request in Race Condition Attack.
|
|
// examples:
|
|
// - name: Send a request 5 times
|
|
// value: "5"
|
|
RaceNumberRequests int `yaml:"race_count,omitempty" jsonschema:"title=number of times to repeat request in race condition,description=Number of times to send a request in Race Condition Attack"`
|
|
// description: |
|
|
// MaxRedirects is the maximum number of redirects that should be followed.
|
|
// examples:
|
|
// - name: Follow up to 5 redirects
|
|
// value: "5"
|
|
MaxRedirects int `yaml:"max-redirects,omitempty" jsonschema:"title=maximum number of redirects to follow,description=Maximum number of redirects that should be followed"`
|
|
// description: |
|
|
// PipelineConcurrentConnections is number of connections to create during pipelining.
|
|
// examples:
|
|
// - name: Create 40 concurrent connections
|
|
// value: 40
|
|
PipelineConcurrentConnections int `yaml:"pipeline-concurrent-connections,omitempty" jsonschema:"title=number of pipelining connections,description=Number of connections to create during pipelining"`
|
|
// description: |
|
|
// PipelineRequestsPerConnection is number of requests to send per connection when pipelining.
|
|
// examples:
|
|
// - name: Send 100 requests per pipeline connection
|
|
// value: 100
|
|
PipelineRequestsPerConnection int `yaml:"pipeline-requests-per-connection,omitempty" jsonschema:"title=number of requests to send per pipelining connections,description=Number of requests to send per connection when pipelining"`
|
|
// description: |
|
|
// Threads specifies number of threads to use sending requests. This enables Connection Pooling.
|
|
//
|
|
// Connection: Close attribute must not be used in request while using threads flag, otherwise
|
|
// pooling will fail and engine will continue to close connections after requests.
|
|
// examples:
|
|
// - name: Send requests using 10 concurrent threads
|
|
// value: 10
|
|
Threads int `yaml:"threads,omitempty" jsonschema:"title=threads for sending requests,description=Threads specifies number of threads to use sending requests. This enables Connection Pooling"`
|
|
// description: |
|
|
// MaxSize is the maximum size of http response body to read in bytes.
|
|
// examples:
|
|
// - name: Read max 2048 bytes of the response
|
|
// value: 2048
|
|
MaxSize int `yaml:"max-size,omitempty" jsonschema:"title=maximum http response body size,description=Maximum size of http response body to read in bytes"`
|
|
|
|
CompiledOperators *operators.Operators `yaml:"-"`
|
|
|
|
options *protocols.ExecuterOptions
|
|
totalRequests int
|
|
customHeaders map[string]string
|
|
generator *generators.PayloadGenerator // optional, only enabled when using payloads
|
|
httpClient *retryablehttp.Client
|
|
rawhttpClient *rawhttp.Client
|
|
dynamicValues map[string]interface{}
|
|
|
|
// description: |
|
|
// SelfContained specifies if the request is self contained.
|
|
SelfContained bool `yaml:"-" json:"-"`
|
|
|
|
// description: |
|
|
// CookieReuse is an optional setting that enables cookie reuse for
|
|
// all requests defined in raw section.
|
|
CookieReuse bool `yaml:"cookie-reuse,omitempty" jsonschema:"title=optional cookie reuse enable,description=Optional setting that enables cookie reuse"`
|
|
// description: |
|
|
// Redirects specifies whether redirects should be followed by the HTTP Client.
|
|
//
|
|
// This can be used in conjunction with `max-redirects` to control the HTTP request redirects.
|
|
Redirects bool `yaml:"redirects,omitempty" jsonschema:"title=follow http redirects,description=Specifies whether redirects should be followed by the HTTP Client"`
|
|
// description: |
|
|
// Pipeline defines if the attack should be performed with HTTP 1.1 Pipelining
|
|
//
|
|
// All requests must be idempotent (GET/POST). This can be used for race conditions/billions requests.
|
|
Pipeline bool `yaml:"pipeline,omitempty" jsonschema:"title=perform HTTP 1.1 pipelining,description=Pipeline defines if the attack should be performed with HTTP 1.1 Pipelining"`
|
|
// description: |
|
|
// Unsafe specifies whether to use rawhttp engine for sending Non RFC-Compliant requests.
|
|
//
|
|
// This uses the [rawhttp](https://github.com/projectdiscovery/rawhttp) engine to achieve complete
|
|
// control over the request, with no normalization performed by the client.
|
|
Unsafe bool `yaml:"unsafe,omitempty" jsonschema:"title=use rawhttp non-strict-rfc client,description=Unsafe specifies whether to use rawhttp engine for sending Non RFC-Compliant requests"`
|
|
// description: |
|
|
// Race determines if all the request have to be attempted at the same time (Race Condition)
|
|
//
|
|
// The actual number of requests that will be sent is determined by the `race_count` field.
|
|
Race bool `yaml:"race,omitempty" jsonschema:"title=perform race-http request coordination attack,description=Race determines if all the request have to be attempted at the same time (Race Condition)"`
|
|
// description: |
|
|
// ReqCondition automatically assigns numbers to requests and preserves their history.
|
|
//
|
|
// This allows matching on them later for multi-request conditions.
|
|
ReqCondition bool `yaml:"req-condition,omitempty" jsonschema:"title=preserve request history,description=Automatically assigns numbers to requests and preserves their history"`
|
|
// description: |
|
|
// StopAtFirstMatch stops the execution of the requests and template as soon as a match is found.
|
|
StopAtFirstMatch bool `yaml:"stop-at-first-match,omitempty" jsonschema:"title=stop at first match,description=Stop the execution after a match is found"`
|
|
// description: |
|
|
// SkipVariablesCheck skips the check for unresolved variables in request
|
|
SkipVariablesCheck bool `yaml:"skip-variables-check,omitempty" jsonschema:"title=skip variable checks,description=Skips the check for unresolved variables in request"`
|
|
}
|
|
|
|
// GetID returns the unique ID of the request if any.
|
|
func (request *Request) GetID() string {
|
|
return request.ID
|
|
}
|
|
|
|
func (request *Request) isRaw() bool {
|
|
return len(request.Raw) > 0
|
|
}
|
|
|
|
// Compile compiles the protocol request for further execution.
|
|
func (request *Request) Compile(options *protocols.ExecuterOptions) error {
|
|
connectionConfiguration := &httpclientpool.Configuration{
|
|
Threads: request.Threads,
|
|
MaxRedirects: request.MaxRedirects,
|
|
FollowRedirects: request.Redirects,
|
|
CookieReuse: request.CookieReuse,
|
|
}
|
|
|
|
// if the headers contain "Connection" we need to disable the automatic keep alive of the standard library
|
|
if _, hasConnectionHeader := request.Headers["Connection"]; hasConnectionHeader {
|
|
connectionConfiguration.Connection = &httpclientpool.ConnectionConfiguration{DisableKeepAlive: false}
|
|
}
|
|
|
|
client, err := httpclientpool.Get(options.Options, connectionConfiguration)
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not get dns client")
|
|
}
|
|
request.customHeaders = make(map[string]string)
|
|
request.httpClient = client
|
|
request.options = options
|
|
for _, option := range request.options.Options.CustomHeaders {
|
|
parts := strings.SplitN(option, ":", 2)
|
|
if len(parts) != 2 {
|
|
continue
|
|
}
|
|
request.customHeaders[parts[0]] = strings.TrimSpace(parts[1])
|
|
}
|
|
|
|
if request.Body != "" && !strings.Contains(request.Body, "\r\n") {
|
|
request.Body = strings.ReplaceAll(request.Body, "\n", "\r\n")
|
|
}
|
|
if len(request.Raw) > 0 {
|
|
for i, raw := range request.Raw {
|
|
if !strings.Contains(raw, "\r\n") {
|
|
request.Raw[i] = strings.ReplaceAll(raw, "\n", "\r\n")
|
|
}
|
|
}
|
|
request.rawhttpClient = httpclientpool.GetRawHTTP(options.Options)
|
|
}
|
|
if len(request.Matchers) > 0 || len(request.Extractors) > 0 {
|
|
compiled := &request.Operators
|
|
if compileErr := compiled.Compile(); compileErr != nil {
|
|
return errors.Wrap(compileErr, "could not compile operators")
|
|
}
|
|
request.CompiledOperators = compiled
|
|
}
|
|
|
|
// Resolve payload paths from vars if they exists
|
|
for name, payload := range request.options.Options.VarsPayload() {
|
|
payloadStr, ok := payload.(string)
|
|
// check if inputs contains the payload
|
|
var hasPayloadName bool
|
|
// search for markers in all request parts
|
|
var inputs []string
|
|
inputs = append(inputs, request.Method.String(), request.Body)
|
|
inputs = append(inputs, request.Raw...)
|
|
for k, v := range request.customHeaders {
|
|
inputs = append(inputs, fmt.Sprintf("%s: %s", k, v))
|
|
}
|
|
for k, v := range request.Headers {
|
|
inputs = append(inputs, fmt.Sprintf("%s: %s", k, v))
|
|
}
|
|
|
|
for _, input := range inputs {
|
|
if expressions.ContainsVariablesWithNames(map[string]interface{}{name: payload}, input) == 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)
|
|
if err != nil {
|
|
return errors.Wrap(err, "could not parse payloads")
|
|
}
|
|
}
|
|
request.options = options
|
|
request.totalRequests = request.Requests()
|
|
return nil
|
|
}
|
|
|
|
// Requests returns the total number of requests the YAML rule will perform
|
|
func (request *Request) Requests() int {
|
|
if request.generator != nil {
|
|
payloadRequests := request.generator.NewIterator().Total() * len(request.Raw)
|
|
return payloadRequests
|
|
}
|
|
if len(request.Raw) > 0 {
|
|
requests := len(request.Raw)
|
|
if requests == 1 && request.RaceNumberRequests != 0 {
|
|
requests *= request.RaceNumberRequests
|
|
}
|
|
return requests
|
|
}
|
|
return len(request.Path)
|
|
}
|