cache, goroutine and unbounded workers management #6420
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,148 @@ | ||
| package core | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "sync/atomic" | ||
| "testing" | ||
| "time" | ||
|
|
||
| inputtypes "github.com/projectdiscovery/nuclei/v3/pkg/input/types" | ||
| "github.com/projectdiscovery/nuclei/v3/pkg/output" | ||
| "github.com/projectdiscovery/nuclei/v3/pkg/protocols" | ||
| "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/contextargs" | ||
| "github.com/projectdiscovery/nuclei/v3/pkg/scan" | ||
| "github.com/projectdiscovery/nuclei/v3/pkg/templates" | ||
| tmpltypes "github.com/projectdiscovery/nuclei/v3/pkg/templates/types" | ||
| "github.com/projectdiscovery/nuclei/v3/pkg/types" | ||
| ) | ||
|
|
||
| // fakeExecuter is a simple stub for protocols.Executer used to test executeTemplateOnInput | ||
| type fakeExecuter struct { | ||
| withResults bool | ||
| } | ||
|
|
||
| func (f *fakeExecuter) Compile() error { return nil } | ||
| func (f *fakeExecuter) Requests() int { return 1 } | ||
| func (f *fakeExecuter) Execute(ctx *scan.ScanContext) (bool, error) { return !f.withResults, nil } | ||
| func (f *fakeExecuter) ExecuteWithResults(ctx *scan.ScanContext) ([]*output.ResultEvent, error) { | ||
| if !f.withResults { | ||
| return nil, nil | ||
| } | ||
| return []*output.ResultEvent{{Host: "h"}}, nil | ||
| } | ||
|
|
||
| // newTestEngine creates a minimal Engine for tests | ||
| func newTestEngine() *Engine { | ||
| return New(&types.Options{}) | ||
| } | ||
|
|
||
| func Test_executeTemplateOnInput_CallbackPath(t *testing.T) { | ||
| e := newTestEngine() | ||
| called := 0 | ||
| e.Callback = func(*output.ResultEvent) { called++ } | ||
|
|
||
| tpl := &templates.Template{} | ||
| tpl.Executer = &fakeExecuter{withResults: true} | ||
|
|
||
| ok, err := e.executeTemplateOnInput(context.Background(), tpl, &contextargs.MetaInput{Input: "x"}) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %v", err) | ||
| } | ||
| if !ok { | ||
| t.Fatalf("expected match true") | ||
| } | ||
| if called == 0 { | ||
| t.Fatalf("expected callback to be called") | ||
| } | ||
| } | ||
|
|
||
| func Test_executeTemplateOnInput_ExecutePath(t *testing.T) { | ||
| e := newTestEngine() | ||
| tpl := &templates.Template{} | ||
| tpl.Executer = &fakeExecuter{withResults: false} | ||
|
|
||
| ok, err := e.executeTemplateOnInput(context.Background(), tpl, &contextargs.MetaInput{Input: "x"}) | ||
| if err != nil { | ||
| t.Fatalf("unexpected error: %v", err) | ||
| } | ||
| if !ok { | ||
| t.Fatalf("expected match true from Execute path") | ||
| } | ||
| } | ||
|
|
||
| type fakeExecuterErr struct{} | ||
|
|
||
| func (f *fakeExecuterErr) Compile() error { return nil } | ||
| func (f *fakeExecuterErr) Requests() int { return 1 } | ||
| func (f *fakeExecuterErr) Execute(ctx *scan.ScanContext) (bool, error) { return false, nil } | ||
| func (f *fakeExecuterErr) ExecuteWithResults(ctx *scan.ScanContext) ([]*output.ResultEvent, error) { | ||
| return nil, fmt.Errorf("boom") | ||
| } | ||
|
|
||
| func Test_executeTemplateOnInput_CallbackErrorPropagates(t *testing.T) { | ||
| e := newTestEngine() | ||
| e.Callback = func(*output.ResultEvent) {} | ||
| tpl := &templates.Template{} | ||
| tpl.Executer = &fakeExecuterErr{} | ||
|
|
||
| ok, err := e.executeTemplateOnInput(context.Background(), tpl, &contextargs.MetaInput{Input: "x"}) | ||
| if err == nil { | ||
| t.Fatalf("expected error to propagate") | ||
| } | ||
| if ok { | ||
| t.Fatalf("expected match to be false on error") | ||
| } | ||
| } | ||
|
|
||
| type fakeTargetProvider struct { | ||
| values []*contextargs.MetaInput | ||
| } | ||
|
|
||
| func (f *fakeTargetProvider) Count() int64 { return int64(len(f.values)) } | ||
| func (f *fakeTargetProvider) Iterate(cb func(value *contextargs.MetaInput) bool) { | ||
| for _, v := range f.values { | ||
| if !cb(v) { | ||
| return | ||
| } | ||
| } | ||
| } | ||
| func (f *fakeTargetProvider) Set(string, string) {} | ||
| func (f *fakeTargetProvider) SetWithProbe(string, string, inputtypes.InputLivenessProbe) error { | ||
| return nil | ||
| } | ||
| func (f *fakeTargetProvider) SetWithExclusions(string, string) error { return nil } | ||
| func (f *fakeTargetProvider) InputType() string { return "test" } | ||
| func (f *fakeTargetProvider) Close() {} | ||
|
|
||
| type slowExecuter struct{} | ||
|
|
||
| func (s *slowExecuter) Compile() error { return nil } | ||
| func (s *slowExecuter) Requests() int { return 1 } | ||
| func (s *slowExecuter) Execute(ctx *scan.ScanContext) (bool, error) { | ||
| select { | ||
| case <-ctx.Context().Done(): | ||
| return false, ctx.Context().Err() | ||
| case <-time.After(200 * time.Millisecond): | ||
| return true, nil | ||
| } | ||
| } | ||
| func (s *slowExecuter) ExecuteWithResults(ctx *scan.ScanContext) ([]*output.ResultEvent, error) { | ||
| return nil, nil | ||
| } | ||
|
|
||
| func Test_executeTemplateWithTargets_RespectsCancellation(t *testing.T) { | ||
| e := newTestEngine() | ||
| e.SetExecuterOptions(&protocols.ExecutorOptions{Logger: e.Logger, ResumeCfg: types.NewResumeCfg(), ProtocolType: tmpltypes.HTTPProtocol}) | ||
|
|
||
| tpl := &templates.Template{} | ||
| tpl.Executer = &slowExecuter{} | ||
|
|
||
| targets := &fakeTargetProvider{values: []*contextargs.MetaInput{{Input: "a"}, {Input: "b"}, {Input: "c"}}} | ||
|
|
||
| ctx, cancel := context.WithCancel(context.Background()) | ||
| cancel() | ||
|
|
||
| var matched atomic.Bool | ||
| e.executeTemplateWithTargets(ctx, tpl, targets, &matched) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| package cache | ||
|
|
||
| import ( | ||
| "regexp" | ||
| "sync" | ||
|
|
||
| "github.com/Knetic/govaluate" | ||
| "github.com/projectdiscovery/gcache" | ||
| ) | ||
|
|
||
| var ( | ||
| initOnce sync.Once | ||
| mu sync.RWMutex | ||
|
|
||
| regexCap = 4096 | ||
| dslCap = 4096 | ||
|
|
||
| regexCache gcache.Cache[string, *regexp.Regexp] | ||
| dslCache gcache.Cache[string, *govaluate.EvaluableExpression] | ||
| ) | ||
|
|
||
| func initCaches() { | ||
| initOnce.Do(func() { | ||
| regexCache = gcache.New[string, *regexp.Regexp](regexCap).LRU().Build() | ||
| dslCache = gcache.New[string, *govaluate.EvaluableExpression](dslCap).LRU().Build() | ||
| }) | ||
| } | ||
|
|
||
| func SetCapacities(regexCapacity, dslCapacity int) { | ||
| // ensure caches are initialized under initOnce, so later Regex()/DSL() won't re-init | ||
| initCaches() | ||
dwisiswant0 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| mu.Lock() | ||
| defer mu.Unlock() | ||
|
|
||
| if regexCapacity > 0 { | ||
| regexCap = regexCapacity | ||
| } | ||
| if dslCapacity > 0 { | ||
| dslCap = dslCapacity | ||
| } | ||
| if regexCapacity <= 0 && dslCapacity <= 0 { | ||
| return | ||
| } | ||
| // rebuild caches with new capacities | ||
| regexCache = gcache.New[string, *regexp.Regexp](regexCap).LRU().Build() | ||
| dslCache = gcache.New[string, *govaluate.EvaluableExpression](dslCap).LRU().Build() | ||
| } | ||
|
|
||
| func Regex() gcache.Cache[string, *regexp.Regexp] { | ||
| initCaches() | ||
| mu.RLock() | ||
| defer mu.RUnlock() | ||
| return regexCache | ||
| } | ||
|
|
||
| func DSL() gcache.Cache[string, *govaluate.EvaluableExpression] { | ||
| initCaches() | ||
| mu.RLock() | ||
| defer mu.RUnlock() | ||
| return dslCache | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.