Fixed request annotation based timeout bugs + tests + misc (#2476)

This commit is contained in:
Ice3man 2022-08-23 12:45:55 +05:30 committed by GitHub
parent 275425589a
commit e7cffad312
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 93 additions and 4 deletions

View File

@ -0,0 +1,18 @@
id: annotation-timeout
info:
name: Basic Annotation Timeout
author: pdteam
severity: info
requests:
- raw:
- |
@timeout: 5s
GET / HTTP/1.1
Host: {{Hostname}}
matchers:
- type: word
words:
- "This is test matcher text"

View File

@ -11,6 +11,7 @@ import (
"regexp"
"strconv"
"strings"
"time"
"github.com/julienschmidt/httprouter"
@ -52,6 +53,7 @@ var httpTestcases = map[string]testutils.TestCase{
"http/get-sni.yaml": &customCLISNI{},
"http/redirect-match-url.yaml": &httpRedirectMatchURL{},
"http/get-sni-unsafe.yaml": &customCLISNIUnsafe{},
"http/annotation-timeout.yaml": &annotationTimeout{},
}
type httpInteractshRequest struct{}
@ -909,3 +911,22 @@ func (h *customCLISNIUnsafe) Execute(filePath string) error {
}
return expectResultsCount(results, 1)
}
type annotationTimeout struct{}
// Execute executes a test case and returns an error if occurred
func (h *annotationTimeout) Execute(filePath string) error {
router := httprouter.New()
router.GET("/", func(w http.ResponseWriter, r *http.Request, _ httprouter.Params) {
time.Sleep(4 * time.Second)
fmt.Fprintf(w, "This is test matcher text")
})
ts := httptest.NewTLSServer(router)
defer ts.Close()
results, err := testutils.RunNucleiTemplateAndGetResults(filePath, ts.URL, debug, "-timeout", "1")
if err != nil {
return err
}
return expectResultsCount(results, 1)
}

View File

@ -26,6 +26,7 @@ import (
"github.com/projectdiscovery/nuclei/v2/pkg/types"
"github.com/projectdiscovery/rawhttp"
"github.com/projectdiscovery/retryablehttp-go"
"github.com/projectdiscovery/stringsutil"
)
var (
@ -112,10 +113,15 @@ func (r *requestGenerator) makeSelfContainedRequest(ctx context.Context, data st
if isRawRequest {
// Get the hostname from the URL section to build the request.
reader := bufio.NewReader(strings.NewReader(data))
read_line:
s, err := reader.ReadString('\n')
if err != nil {
return nil, fmt.Errorf("could not read request: %w", err)
}
// ignore all annotations
if stringsutil.HasPrefixAny(s, "@") {
goto read_line
}
parts := strings.Split(s, " ")
if len(parts) < 3 {
@ -288,8 +294,7 @@ func (r *requestGenerator) handleRawWithPayloads(ctx context.Context, rawRequest
}
if reqWithAnnotations, hasAnnotations := r.request.parseAnnotations(rawRequest, req); hasAnnotations {
req = reqWithAnnotations
request = request.WithContext(req.Context())
request.Request = reqWithAnnotations
}
return &generatedRequest{request: request, meta: generatorValues, original: r.request, dynamicValues: finalValues, interactshURLs: r.interactshURLs}, nil

View File

@ -102,12 +102,12 @@ func (r *Request) parseAnnotations(rawRequest string, request *http.Request) (*h
value := strings.TrimSpace(duration[1])
if parsed, err := time.ParseDuration(value); err == nil {
//nolint:govet // cancelled automatically by withTimeout
ctx, _ := context.WithTimeout(request.Context(), parsed)
ctx, _ := context.WithTimeout(context.Background(), parsed)
request = request.Clone(ctx)
}
} else {
//nolint:govet // cancelled automatically by withTimeout
ctx, _ := context.WithTimeout(request.Context(), time.Duration(r.options.Options.Timeout)*time.Second)
ctx, _ := context.WithTimeout(context.Background(), time.Duration(r.options.Options.Timeout)*time.Second)
request = request.Clone(ctx)
}
}

View File

@ -0,0 +1,45 @@
package http
import (
"context"
"net/http"
"testing"
"github.com/projectdiscovery/nuclei/v2/pkg/protocols/http/httpclientpool"
"github.com/stretchr/testify/require"
)
func TestRequestParseAnnotationsTimeout(t *testing.T) {
t.Run("positive", func(t *testing.T) {
request := &Request{
connConfiguration: &httpclientpool.Configuration{NoTimeout: true},
}
rawRequest := `@timeout: 2s
GET / HTTP/1.1
Host: {{Hostname}}`
httpReq, err := http.NewRequest(http.MethodGet, "https://example.com", nil)
require.Nil(t, err, "could not create http request")
newRequest, modified := request.parseAnnotations(rawRequest, httpReq)
require.True(t, modified, "could not get correct modified value")
_, deadlined := newRequest.Context().Deadline()
require.True(t, deadlined, "could not get set request deadline")
})
t.Run("negative", func(t *testing.T) {
request := &Request{
connConfiguration: &httpclientpool.Configuration{},
}
rawRequest := `GET / HTTP/1.1
Host: {{Hostname}}`
httpReq, err := http.NewRequestWithContext(context.Background(), http.MethodGet, "https://example.com", nil)
require.Nil(t, err, "could not create http request")
newRequest, modified := request.parseAnnotations(rawRequest, httpReq)
require.False(t, modified, "could not get correct modified value")
_, deadlined := newRequest.Context().Deadline()
require.False(t, deadlined, "could not get set request deadline")
})
}