diff --git a/Makefile b/Makefile index 1b089e76f5..6aaa55de11 100644 --- a/Makefile +++ b/Makefile @@ -15,8 +15,8 @@ ifneq ($(shell go env GOOS),darwin) endif .PHONY: all build build-stats clean devtools-all devtools-bindgen devtools-scrapefuncs -.PHONY: devtools-tsgen docs docgen dsl-docs functional fuzzplayground go-build syntax-docs -.PHONY: integration jsupdate-all jsupdate-bindgen jsupdate-tsgen memogen scan-charts test +.PHONY: devtools-tsgen docs docgen dsl-docs functional fuzzplayground go-build lint lint-strict syntax-docs +.PHONY: integration jsupdate-all jsupdate-bindgen jsupdate-tsgen memogen scan-charts test test-with-lint .PHONY: tidy ts verify download vet template-validate all: build diff --git a/cmd/integration-test/http.go b/cmd/integration-test/http.go index 2d273d5138..69fb35187c 100644 --- a/cmd/integration-test/http.go +++ b/cmd/integration-test/http.go @@ -19,7 +19,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/testutils" "github.com/projectdiscovery/nuclei/v3/pkg/utils/json" "github.com/projectdiscovery/retryablehttp-go" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" logutil "github.com/projectdiscovery/utils/log" sliceutil "github.com/projectdiscovery/utils/slice" stringsutil "github.com/projectdiscovery/utils/strings" @@ -196,7 +196,7 @@ func (d *httpDefaultMatcherCondition) Execute(filePath string) error { return err } if routerErr != nil { - return errorutil.NewWithErr(routerErr).Msgf("failed to send http request to interactsh server") + return errkit.Append(errkit.New("failed to send http request to interactsh server"), routerErr) } if err := expectResultsCount(results, 1); err != nil { return err @@ -628,10 +628,10 @@ func (h *httpRawWithParams) Execute(filePath string) error { // we intentionally use params["test"] instead of params.Get("test") to test the case where // there are multiple parameters with the same name if !reflect.DeepEqual(params["key1"], []string{"value1"}) { - errx = errorutil.WrapfWithNil(errx, "expected %v, got %v", []string{"value1"}, params["key1"]) + errx = errkit.Append(errkit.New(fmt.Sprintf("expected %v, got %v", []string{"value1"}, params["key1"])), errx) } if !reflect.DeepEqual(params["key2"], []string{"value2"}) { - errx = errorutil.WrapfWithNil(errx, "expected %v, got %v", []string{"value2"}, params["key2"]) + errx = errkit.Append(errkit.New(fmt.Sprintf("expected %v, got %v", []string{"value2"}, params["key2"])), errx) } _, _ = fmt.Fprintf(w, "Test is test raw-params-matcher text") }) @@ -971,10 +971,10 @@ func (h *httpRequestSelfContainedWithParams) Execute(filePath string) error { // we intentionally use params["test"] instead of params.Get("test") to test the case where // there are multiple parameters with the same name if !reflect.DeepEqual(params["something"], []string{"here"}) { - errx = errorutil.WrapfWithNil(errx, "expected %v, got %v", []string{"here"}, params["something"]) + errx = errkit.Append(errkit.New(fmt.Sprintf("expected %v, got %v", []string{"here"}, params["something"])), errx) } if !reflect.DeepEqual(params["key"], []string{"value"}) { - errx = errorutil.WrapfWithNil(errx, "expected %v, got %v", []string{"value"}, params["key"]) + errx = errkit.Append(errkit.New(fmt.Sprintf("expected %v, got %v", []string{"value"}, params["key"])), errx) } _, _ = w.Write([]byte("This is self-contained response")) }) @@ -1027,10 +1027,10 @@ func (h *httpRequestSelfContainedFileInput) Execute(filePath string) error { // create temp file FileLoc, err := os.CreateTemp("", "self-contained-payload-*.txt") if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to create temp file") + return errkit.Append(errkit.New("failed to create temp file"), err) } if _, err := FileLoc.Write([]byte("one\ntwo\n")); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to write payload to temp file") + return errkit.Append(errkit.New("failed to write payload to temp file"), err) } defer func() { _ = FileLoc.Close() @@ -1046,7 +1046,7 @@ func (h *httpRequestSelfContainedFileInput) Execute(filePath string) error { } if !sliceutil.ElementsMatch(gotReqToEndpoints, []string{"/one", "/two", "/one", "/two"}) { - return errorutil.NewWithTag(filePath, "expected requests to be sent to `/one` and `/two` endpoints but were sent to `%v`", gotReqToEndpoints) + return errkit.New(fmt.Sprintf("%s: expected requests to be sent to `/one` and `/two` endpoints but were sent to `%v`", filePath, gotReqToEndpoints)).Build() } return nil } diff --git a/cmd/integration-test/loader.go b/cmd/integration-test/loader.go index d1114ef333..2967e9afb5 100644 --- a/cmd/integration-test/loader.go +++ b/cmd/integration-test/loader.go @@ -10,7 +10,7 @@ import ( "github.com/julienschmidt/httprouter" "github.com/projectdiscovery/nuclei/v3/pkg/testutils" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" permissionutil "github.com/projectdiscovery/utils/permission" ) @@ -223,7 +223,7 @@ type loadTemplateWithID struct{} func (h *loadTemplateWithID) Execute(nooop string) error { results, err := testutils.RunNucleiBareArgsAndGetResults(debug, nil, "-target", "scanme.sh", "-id", "self-signed-ssl") if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to load template with id") + return errkit.Append(errkit.New("failed to load template with id"), err) } return expectResultsCount(results, 1) } diff --git a/cmd/integration-test/profile-loader.go b/cmd/integration-test/profile-loader.go index 80ae4cfd47..19e57ba484 100644 --- a/cmd/integration-test/profile-loader.go +++ b/cmd/integration-test/profile-loader.go @@ -4,7 +4,7 @@ import ( "fmt" "github.com/projectdiscovery/nuclei/v3/pkg/testutils" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) var profileLoaderTestcases = []TestCaseInfo{ @@ -18,7 +18,7 @@ type profileLoaderByRelFile struct{} func (h *profileLoaderByRelFile) Execute(testName string) error { results, err := testutils.RunNucleiWithArgsAndGetResults(debug, "-tl", "-tp", "cloud.yml") if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to load template with id") + return errkit.Append(errkit.New("failed to load template with id"), err) } if len(results) <= 10 { return fmt.Errorf("incorrect result: expected more results than %d, got %v", 10, len(results)) @@ -31,7 +31,7 @@ type profileLoaderById struct{} func (h *profileLoaderById) Execute(testName string) error { results, err := testutils.RunNucleiWithArgsAndGetResults(debug, "-tl", "-tp", "cloud") if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to load template with id") + return errkit.Append(errkit.New("failed to load template with id"), err) } if len(results) <= 10 { return fmt.Errorf("incorrect result: expected more results than %d, got %v", 10, len(results)) @@ -45,7 +45,7 @@ type customProfileLoader struct{} func (h *customProfileLoader) Execute(filepath string) error { results, err := testutils.RunNucleiWithArgsAndGetResults(debug, "-tl", "-tp", filepath) if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to load template with id") + return errkit.Append(errkit.New("failed to load template with id"), err) } if len(results) < 1 { return fmt.Errorf("incorrect result: expected more results than %d, got %v", 1, len(results)) diff --git a/cmd/integration-test/template-dir.go b/cmd/integration-test/template-dir.go index 20691da042..96da87424d 100644 --- a/cmd/integration-test/template-dir.go +++ b/cmd/integration-test/template-dir.go @@ -4,7 +4,7 @@ import ( "os" "github.com/projectdiscovery/nuclei/v3/pkg/testutils" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) var templatesDirTestCases = []TestCaseInfo{ @@ -17,7 +17,7 @@ type templateDirWithTargetTest struct{} func (h *templateDirWithTargetTest) Execute(filePath string) error { tempdir, err := os.MkdirTemp("", "nuclei-update-dir-*") if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to create temp dir") + return errkit.Append(errkit.New("failed to create temp dir"), err) } defer func() { _ = os.RemoveAll(tempdir) diff --git a/cmd/nuclei/main.go b/cmd/nuclei/main.go index dd554a8a9c..ba71a1e0f7 100644 --- a/cmd/nuclei/main.go +++ b/cmd/nuclei/main.go @@ -39,7 +39,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/projectdiscovery/nuclei/v3/pkg/types/scanstrategy" "github.com/projectdiscovery/nuclei/v3/pkg/utils/monitor" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" unitutils "github.com/projectdiscovery/utils/unit" updateutils "github.com/projectdiscovery/utils/update" @@ -187,7 +187,7 @@ func main() { options.Logger.Info().Msgf("Creating resume file: %s\n", resumeFileName) err := nucleiRunner.SaveResumeConfig(resumeFileName) if err != nil { - return errorutil.NewWithErr(err).Msgf("couldn't create crash resume file") + return errkit.Append(errkit.New("couldn't create crash resume file"), err) } return nil }) diff --git a/cmd/tmc/main.go b/cmd/tmc/main.go index 8e4eb1ed28..69065436d6 100644 --- a/cmd/tmc/main.go +++ b/cmd/tmc/main.go @@ -23,7 +23,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/projectdiscovery/nuclei/v3/pkg/utils/json" "github.com/projectdiscovery/retryablehttp-go" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" "gopkg.in/yaml.v3" ) @@ -243,7 +243,7 @@ func enhanceTemplate(data string) (string, bool, error) { return data, false, err } if resp.StatusCode != 200 { - return data, false, errorutil.New("unexpected status code: %v", resp.Status) + return data, false, errkit.New(fmt.Sprintf("unexpected status code: %v", resp.Status)).Build() } var templateResp TemplateResp if err := json.NewDecoder(resp.Body).Decode(&templateResp); err != nil { @@ -254,20 +254,20 @@ func enhanceTemplate(data string) (string, bool, error) { } if templateResp.ValidateErrorCount > 0 { if len(templateResp.ValidateError) > 0 { - return data, false, errorutil.NewWithTag("validate", templateResp.ValidateError[0].Message+": at line %v", templateResp.ValidateError[0].Mark.Line) + return data, false, errkit.New(fmt.Sprintf("validate: %s: at line %v", templateResp.ValidateError[0].Message, templateResp.ValidateError[0].Mark.Line)).Build() } - return data, false, errorutil.New("validation failed").WithTag("validate") + return data, false, errkit.New("validate: validation failed").Build() } if templateResp.Error.Name != "" { - return data, false, errorutil.New("%s", templateResp.Error.Name) + return data, false, errkit.New(templateResp.Error.Name).Build() } if strings.TrimSpace(templateResp.Enhanced) == "" && !templateResp.Lint { if templateResp.LintError.Reason != "" { - return data, false, errorutil.NewWithTag("lint", templateResp.LintError.Reason+" : at line %v", templateResp.LintError.Mark.Line) + return data, false, errkit.New(fmt.Sprintf("lint: %s : at line %v", templateResp.LintError.Reason, templateResp.LintError.Mark.Line)).Build() } - return data, false, errorutil.NewWithTag("lint", "at line: %v", templateResp.LintError.Mark.Line) + return data, false, errkit.New(fmt.Sprintf("lint: at line: %v", templateResp.LintError.Mark.Line)).Build() } - return data, false, errorutil.New("template enhance failed") + return data, false, errkit.New("template enhance failed").Build() } // formatTemplate formats template data using templateman format api @@ -277,7 +277,7 @@ func formatTemplate(data string) (string, bool, error) { return data, false, err } if resp.StatusCode != 200 { - return data, false, errorutil.New("unexpected status code: %v", resp.Status) + return data, false, errkit.New(fmt.Sprintf("unexpected status code: %v", resp.Status)).Build() } var templateResp TemplateResp if err := json.NewDecoder(resp.Body).Decode(&templateResp); err != nil { @@ -288,20 +288,20 @@ func formatTemplate(data string) (string, bool, error) { } if templateResp.ValidateErrorCount > 0 { if len(templateResp.ValidateError) > 0 { - return data, false, errorutil.NewWithTag("validate", templateResp.ValidateError[0].Message+": at line %v", templateResp.ValidateError[0].Mark.Line) + return data, false, errkit.New(fmt.Sprintf("validate: %s: at line %v", templateResp.ValidateError[0].Message, templateResp.ValidateError[0].Mark.Line)).Build() } - return data, false, errorutil.New("validation failed").WithTag("validate") + return data, false, errkit.New("validate: validation failed").Build() } if templateResp.Error.Name != "" { - return data, false, errorutil.New("%s", templateResp.Error.Name) + return data, false, errkit.New(templateResp.Error.Name).Build() } if strings.TrimSpace(templateResp.Updated) == "" && !templateResp.Lint { if templateResp.LintError.Reason != "" { - return data, false, errorutil.NewWithTag("lint", templateResp.LintError.Reason+" : at line %v", templateResp.LintError.Mark.Line) + return data, false, errkit.New(fmt.Sprintf("lint: %s : at line %v", templateResp.LintError.Reason, templateResp.LintError.Mark.Line)).Build() } - return data, false, errorutil.NewWithTag("lint", "at line: %v", templateResp.LintError.Mark.Line) + return data, false, errkit.New(fmt.Sprintf("lint: at line: %v", templateResp.LintError.Mark.Line)).Build() } - return data, false, errorutil.New("template format failed") + return data, false, errkit.New("template format failed").Build() } // lintTemplate lints template data using templateman lint api @@ -311,7 +311,7 @@ func lintTemplate(data string) (bool, error) { return false, err } if resp.StatusCode != 200 { - return false, errorutil.New("unexpected status code: %v", resp.Status) + return false, errkit.New(fmt.Sprintf("unexpected status code: %v", resp.Status)).Build() } var lintResp TemplateLintResp if err := json.NewDecoder(resp.Body).Decode(&lintResp); err != nil { @@ -321,9 +321,9 @@ func lintTemplate(data string) (bool, error) { return true, nil } if lintResp.LintError.Reason != "" { - return false, errorutil.NewWithTag("lint", lintResp.LintError.Reason+" : at line %v", lintResp.LintError.Mark.Line) + return false, errkit.New(fmt.Sprintf("lint: %s : at line %v", lintResp.LintError.Reason, lintResp.LintError.Mark.Line)).Build() } - return false, errorutil.NewWithTag("lint", "at line: %v", lintResp.LintError.Mark.Line) + return false, errkit.New(fmt.Sprintf("lint: at line: %v", lintResp.LintError.Mark.Line)).Build() } // validateTemplate validates template data using templateman validate api @@ -333,7 +333,7 @@ func validateTemplate(data string) (bool, error) { return false, err } if resp.StatusCode != 200 { - return false, errorutil.New("unexpected status code: %v", resp.Status) + return false, errkit.New(fmt.Sprintf("unexpected status code: %v", resp.Status)).Build() } var validateResp TemplateResp if err := json.NewDecoder(resp.Body).Decode(&validateResp); err != nil { @@ -344,14 +344,14 @@ func validateTemplate(data string) (bool, error) { } if validateResp.ValidateErrorCount > 0 { if len(validateResp.ValidateError) > 0 { - return false, errorutil.NewWithTag("validate", validateResp.ValidateError[0].Message+": at line %v", validateResp.ValidateError[0].Mark.Line) + return false, errkit.New(fmt.Sprintf("validate: %s: at line %v", validateResp.ValidateError[0].Message, validateResp.ValidateError[0].Mark.Line)).Build() } - return false, errorutil.New("validation failed").WithTag("validate") + return false, errkit.New("validate: validation failed").Build() } if validateResp.Error.Name != "" { - return false, errorutil.New("%s", validateResp.Error.Name) + return false, errkit.New(validateResp.Error.Name).Build() } - return false, errorutil.New("template validation failed") + return false, errkit.New("template validation failed").Build() } // parseAndAddMaxRequests parses and adds max requests to templates diff --git a/internal/pdcp/writer.go b/internal/pdcp/writer.go index 19e2c7e84b..ed98d556e8 100644 --- a/internal/pdcp/writer.go +++ b/internal/pdcp/writer.go @@ -19,7 +19,7 @@ import ( "github.com/projectdiscovery/retryablehttp-go" pdcpauth "github.com/projectdiscovery/utils/auth/pdcp" "github.com/projectdiscovery/utils/env" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" unitutils "github.com/projectdiscovery/utils/unit" updateutils "github.com/projectdiscovery/utils/update" urlutil "github.com/projectdiscovery/utils/url" @@ -77,11 +77,11 @@ func NewUploadWriter(ctx context.Context, logger *gologger.Logger, creds *pdcpau output.WithJson(true, true), ) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not create output writer") + return nil, errkit.Append(errkit.New("could not create output writer"), err) } tmp, err := urlutil.Parse(creds.Server) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not parse server url") + return nil, errkit.Append(errkit.New("could not parse server url"), err) } tmp.Path = uploadEndpoint tmp.Update() @@ -199,7 +199,7 @@ func (u *UploadWriter) autoCommit(ctx context.Context, r *io.PipeReader) { // uploadChunk uploads a chunk of data to the server func (u *UploadWriter) uploadChunk(buff *bytes.Buffer) error { if err := u.upload(buff.Bytes()); err != nil { - return errorutil.NewWithErr(err).Msgf("could not upload chunk") + return errkit.Append(errkit.New("could not upload chunk"), err) } // if successful, reset the buffer buff.Reset() @@ -211,25 +211,25 @@ func (u *UploadWriter) uploadChunk(buff *bytes.Buffer) error { func (u *UploadWriter) upload(data []byte) error { req, err := u.getRequest(data) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not create upload request") + return errkit.Append(errkit.New("could not create upload request"), err) } resp, err := u.client.Do(req) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not upload results") + return errkit.Append(errkit.New("could not upload results"), err) } defer func() { _ = resp.Body.Close() }() bin, err := io.ReadAll(resp.Body) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not get id from response") + return errkit.Append(errkit.New("could not get id from response"), err) } if resp.StatusCode != http.StatusOK { return fmt.Errorf("could not upload results got status code %v on %v", resp.StatusCode, resp.Request.URL.String()) } var uploadResp uploadResponse if err := json.Unmarshal(bin, &uploadResp); err != nil { - return errorutil.NewWithErr(err).Msgf("could not unmarshal response got %v", string(bin)) + return errkit.Append(errkit.New(fmt.Sprintf("could not unmarshal response got %v", string(bin))), err) } if uploadResp.ID != "" && u.scanID == "" { u.scanID = uploadResp.ID @@ -254,7 +254,7 @@ func (u *UploadWriter) getRequest(bin []byte) (*retryablehttp.Request, error) { } req, err := retryablehttp.NewRequest(method, url, bytes.NewReader(bin)) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not create cloud upload request") + return nil, errkit.Append(errkit.New("could not create cloud upload request"), err) } // add pdtm meta params req.Params.Merge(updateutils.GetpdtmParams(config.Version)) diff --git a/internal/runner/lazy.go b/internal/runner/lazy.go index 30664bfd55..27f223e6da 100644 --- a/internal/runner/lazy.go +++ b/internal/runner/lazy.go @@ -17,7 +17,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/scan" "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/projectdiscovery/utils/env" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) type AuthLazyFetchOptions struct { @@ -32,7 +32,7 @@ func GetAuthTmplStore(opts *types.Options, catalog catalog.Catalog, execOpts *pr for _, file := range opts.SecretsFile { data, err := authx.GetTemplatePathsFromSecretFile(file) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("failed to get template paths from secrets file") + return nil, errkit.Append(errkit.New("failed to get template paths from secrets file"), err) } tmpls = append(tmpls, data...) } @@ -58,7 +58,7 @@ func GetAuthTmplStore(opts *types.Options, catalog catalog.Catalog, execOpts *pr cfg.StoreId = loader.AuthStoreId store, err := loader.New(cfg) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("failed to initialize dynamic auth templates store") + return nil, errkit.Append(errkit.New("failed to initialize dynamic auth templates store"), err) } return store, nil } diff --git a/internal/runner/proxy.go b/internal/runner/proxy.go index ec14302eb6..4584eedcca 100644 --- a/internal/runner/proxy.go +++ b/internal/runner/proxy.go @@ -8,7 +8,7 @@ import ( "strings" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" proxyutils "github.com/projectdiscovery/utils/proxy" ) @@ -50,7 +50,7 @@ func loadProxyServers(options *types.Options) error { } proxyURL, err := url.Parse(aliveProxy) if err != nil { - return errorutil.WrapfWithNil(err, "failed to parse proxy got %v", err) + return errkit.Append(errkit.New(fmt.Sprintf("failed to parse proxy got %v", err)), err) } if options.ProxyInternal { _ = os.Setenv(HTTP_PROXY_ENV, proxyURL.String()) diff --git a/lib/config.go b/lib/config.go index 125442898d..24af8fdbf9 100644 --- a/lib/config.go +++ b/lib/config.go @@ -102,7 +102,7 @@ type InteractshOpts interactsh.Options func WithInteractshOptions(opts InteractshOpts) NucleiSDKOptions { return func(e *NucleiEngine) error { if e.mode == threadSafe { - return ErrOptionsNotSupported.Msgf("WithInteractshOptions") + return ErrOptionsNotSupported("WithInteractshOptions") } optsPtr := &opts e.interactshOpts = (*interactsh.Options)(optsPtr) @@ -229,7 +229,7 @@ type StatsOptions struct { func EnableStatsWithOpts(opts StatsOptions) NucleiSDKOptions { return func(e *NucleiEngine) error { if e.mode == threadSafe { - return ErrOptionsNotSupported.Msgf("EnableStatsWithOpts") + return ErrOptionsNotSupported("EnableStatsWithOpts") } if opts.Interval == 0 { opts.Interval = 5 //sec @@ -257,7 +257,7 @@ type VerbosityOptions struct { func WithVerbosity(opts VerbosityOptions) NucleiSDKOptions { return func(e *NucleiEngine) error { if e.mode == threadSafe { - return ErrOptionsNotSupported.Msgf("WithVerbosity") + return ErrOptionsNotSupported("WithVerbosity") } e.opts.Verbose = opts.Verbose e.opts.Silent = opts.Silent @@ -290,7 +290,7 @@ type NetworkConfig struct { func WithNetworkConfig(opts NetworkConfig) NucleiSDKOptions { return func(e *NucleiEngine) error { if e.mode == threadSafe { - return ErrOptionsNotSupported.Msgf("WithNetworkConfig") + return ErrOptionsNotSupported("WithNetworkConfig") } e.opts.NoHostErrors = opts.DisableMaxHostErr e.opts.MaxHostError = opts.MaxHostError @@ -321,7 +321,7 @@ func WithNetworkConfig(opts NetworkConfig) NucleiSDKOptions { func WithProxy(proxy []string, proxyInternalRequests bool) NucleiSDKOptions { return func(e *NucleiEngine) error { if e.mode == threadSafe { - return ErrOptionsNotSupported.Msgf("WithProxy") + return ErrOptionsNotSupported("WithProxy") } e.opts.Proxy = proxy e.opts.ProxyInternal = proxyInternalRequests @@ -346,7 +346,7 @@ type OutputWriter output.Writer func UseOutputWriter(writer OutputWriter) NucleiSDKOptions { return func(e *NucleiEngine) error { if e.mode == threadSafe { - return ErrOptionsNotSupported.Msgf("UseOutputWriter") + return ErrOptionsNotSupported("UseOutputWriter") } e.customWriter = writer return nil @@ -361,7 +361,7 @@ type StatsWriter progress.Progress func UseStatsWriter(writer StatsWriter) NucleiSDKOptions { return func(e *NucleiEngine) error { if e.mode == threadSafe { - return ErrOptionsNotSupported.Msgf("UseStatsWriter") + return ErrOptionsNotSupported("UseStatsWriter") } e.customProgress = writer return nil @@ -375,7 +375,7 @@ func UseStatsWriter(writer StatsWriter) NucleiSDKOptions { func WithTemplateUpdateCallback(disableTemplatesAutoUpgrade bool, callback func(newVersion string)) NucleiSDKOptions { return func(e *NucleiEngine) error { if e.mode == threadSafe { - return ErrOptionsNotSupported.Msgf("WithTemplateUpdateCallback") + return ErrOptionsNotSupported("WithTemplateUpdateCallback") } e.disableTemplatesAutoUpgrade = disableTemplatesAutoUpgrade e.onUpdateAvailableCallback = callback @@ -387,7 +387,7 @@ func WithTemplateUpdateCallback(disableTemplatesAutoUpgrade bool, callback func( func WithSandboxOptions(allowLocalFileAccess bool, restrictLocalNetworkAccess bool) NucleiSDKOptions { return func(e *NucleiEngine) error { if e.mode == threadSafe { - return ErrOptionsNotSupported.Msgf("WithSandboxOptions") + return ErrOptionsNotSupported("WithSandboxOptions") } e.opts.AllowLocalFileAccess = allowLocalFileAccess e.opts.RestrictLocalNetworkAccess = restrictLocalNetworkAccess diff --git a/lib/multi.go b/lib/multi.go index 3c414116d6..d224d09f6b 100644 --- a/lib/multi.go +++ b/lib/multi.go @@ -13,7 +13,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/protocols" "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/projectdiscovery/ratelimit" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" "github.com/rs/xid" ) @@ -147,13 +147,13 @@ func (e *ThreadSafeNucleiEngine) ExecuteNucleiWithOptsCtx(ctx context.Context, t // load templates workflowLoader, err := workflow.NewLoader(unsafeOpts.executerOpts) if err != nil { - return errorutil.New("Could not create workflow loader: %s\n", err) + return errkit.Append(errkit.New("Could not create workflow loader"), err) } unsafeOpts.executerOpts.WorkflowLoader = workflowLoader store, err := loader.New(loader.NewConfig(tmpEngine.opts, e.eng.catalog, unsafeOpts.executerOpts)) if err != nil { - return errorutil.New("Could not create loader client: %s\n", err) + return errkit.Append(errkit.New("Could not create loader client"), err) } store.Load() diff --git a/lib/sdk.go b/lib/sdk.go index d1d8314db6..76fc8870b3 100644 --- a/lib/sdk.go +++ b/lib/sdk.go @@ -4,6 +4,7 @@ import ( "bufio" "bytes" "context" + "fmt" "io" "sync" @@ -28,7 +29,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/projectdiscovery/ratelimit" "github.com/projectdiscovery/retryablehttp-go" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" "github.com/rs/xid" ) @@ -37,15 +38,18 @@ type NucleiSDKOptions func(e *NucleiEngine) error var ( // ErrNotImplemented is returned when a feature is not implemented - ErrNotImplemented = errorutil.New("Not implemented") + ErrNotImplemented = errkit.New("Not implemented").Build() // ErrNoTemplatesAvailable is returned when no templates are available to execute - ErrNoTemplatesAvailable = errorutil.New("No templates available") + ErrNoTemplatesAvailable = errkit.New("No templates available").Build() // ErrNoTargetsAvailable is returned when no targets are available to scan - ErrNoTargetsAvailable = errorutil.New("No targets available") - // ErrOptionsNotSupported is returned when an option is not supported in thread safe mode - ErrOptionsNotSupported = errorutil.NewWithFmt("Option %v not supported in thread safe mode") + ErrNoTargetsAvailable = errkit.New("No targets available").Build() ) +// ErrOptionsNotSupported returns an error when an option is not supported in thread safe mode +func ErrOptionsNotSupported(option string) error { + return errkit.New(fmt.Sprintf("Option %v not supported in thread safe mode", option)).Build() +} + type engineMode uint const ( @@ -98,13 +102,13 @@ type NucleiEngine struct { func (e *NucleiEngine) LoadAllTemplates() error { workflowLoader, err := workflow.NewLoader(e.executerOpts) if err != nil { - return errorutil.New("Could not create workflow loader: %s\n", err) + return errkit.Append(errkit.New("Could not create workflow loader"), err) } e.executerOpts.WorkflowLoader = workflowLoader e.store, err = loader.New(loader.NewConfig(e.opts, e.catalog, e.executerOpts)) if err != nil { - return errorutil.New("Could not create loader client: %s\n", err) + return errkit.Append(errkit.New("Could not create loader client"), err) } e.store.Load() e.templatesLoaded = true diff --git a/pkg/authprovider/authx/dynamic.go b/pkg/authprovider/authx/dynamic.go index a3abc22046..9a2427555f 100644 --- a/pkg/authprovider/authx/dynamic.go +++ b/pkg/authprovider/authx/dynamic.go @@ -8,7 +8,7 @@ import ( "github.com/projectdiscovery/gologger" "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/replacer" "github.com/projectdiscovery/nuclei/v3/pkg/utils/json" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" sliceutil "github.com/projectdiscovery/utils/slice" ) @@ -53,7 +53,7 @@ func (d *Dynamic) GetDomainAndDomainRegex() ([]string, []string) { func (d *Dynamic) UnmarshalJSON(data []byte) error { if d == nil { - return errorutil.New("cannot unmarshal into nil Dynamic struct") + return errkit.New("cannot unmarshal into nil Dynamic struct").Build() } // Use an alias type (auxiliary) to avoid a recursive call in this method. @@ -72,10 +72,10 @@ func (d *Dynamic) UnmarshalJSON(data []byte) error { func (d *Dynamic) Validate() error { d.m = &sync.Mutex{} if d.TemplatePath == "" { - return errorutil.New(" template-path is required for dynamic secret") + return errkit.New(" template-path is required for dynamic secret").Build() } if len(d.Variables) == 0 { - return errorutil.New("variables are required for dynamic secret") + return errkit.New("variables are required for dynamic secret").Build() } if d.Secret != nil { diff --git a/pkg/authprovider/authx/file.go b/pkg/authprovider/authx/file.go index e2f473727c..fc749fda35 100644 --- a/pkg/authprovider/authx/file.go +++ b/pkg/authprovider/authx/file.go @@ -8,7 +8,7 @@ import ( "strings" "github.com/projectdiscovery/nuclei/v3/pkg/utils/json" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" "github.com/projectdiscovery/utils/generic" stringsutil "github.com/projectdiscovery/utils/strings" "gopkg.in/yaml.v3" @@ -237,7 +237,7 @@ func GetAuthDataFromYAML(data []byte) (*Authx, error) { var auth Authx err := yaml.Unmarshal(data, &auth) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not unmarshal yaml") + return nil, errkit.Append(errkit.New("could not unmarshal yaml"), err) } return &auth, nil } @@ -247,7 +247,7 @@ func GetAuthDataFromJSON(data []byte) (*Authx, error) { var auth Authx err := json.Unmarshal(data, &auth) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not unmarshal json") + return nil, errkit.Append(errkit.New("could not unmarshal json"), err) } return &auth, nil } diff --git a/pkg/authprovider/file.go b/pkg/authprovider/file.go index 1c2ef51bf5..02df46b6ff 100644 --- a/pkg/authprovider/file.go +++ b/pkg/authprovider/file.go @@ -1,13 +1,14 @@ package authprovider import ( + "fmt" "net" "net/url" "regexp" "strings" "github.com/projectdiscovery/nuclei/v3/pkg/authprovider/authx" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" urlutil "github.com/projectdiscovery/utils/url" ) @@ -30,16 +31,16 @@ func NewFileAuthProvider(path string, callback authx.LazyFetchSecret) (AuthProvi return nil, ErrNoSecrets } if len(store.Dynamic) > 0 && callback == nil { - return nil, errorutil.New("lazy fetch callback is required for dynamic secrets") + return nil, errkit.New("lazy fetch callback is required for dynamic secrets").Build() } for _, secret := range store.Secrets { if err := secret.Validate(); err != nil { - return nil, errorutil.NewWithErr(err).Msgf("invalid secret in file: %s", path) + return nil, errkit.Append(errkit.New(fmt.Sprintf("invalid secret in file: %s", path)), err) } } for i, dynamic := range store.Dynamic { if err := dynamic.Validate(); err != nil { - return nil, errorutil.NewWithErr(err).Msgf("invalid dynamic in file: %s", path) + return nil, errkit.Append(errkit.New(fmt.Sprintf("invalid dynamic in file: %s", path)), err) } dynamic.SetLazyFetchCallback(callback) store.Dynamic[i] = dynamic diff --git a/pkg/catalog/config/nucleiconfig.go b/pkg/catalog/config/nucleiconfig.go index 1f43d0c16b..8496b69b3d 100644 --- a/pkg/catalog/config/nucleiconfig.go +++ b/pkg/catalog/config/nucleiconfig.go @@ -13,7 +13,7 @@ import ( "github.com/projectdiscovery/gologger" "github.com/projectdiscovery/nuclei/v3/pkg/utils/json" "github.com/projectdiscovery/utils/env" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" folderutil "github.com/projectdiscovery/utils/folder" ) @@ -140,13 +140,13 @@ func (c *Config) UpdateNucleiIgnoreHash() error { if fileutil.FileExists(ignoreFilePath) { bin, err := os.ReadFile(ignoreFilePath) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not read nuclei ignore file") + return errkit.Append(errkit.New("could not read nuclei ignore file"), err) } c.NucleiIgnoreHash = fmt.Sprintf("%x", md5.Sum(bin)) // write config to disk return c.WriteTemplatesConfig() } - return errorutil.NewWithTag("config", "ignore file not found: could not update nuclei ignore hash") + return errkit.New("config: ignore file not found: could not update nuclei ignore hash").Build() } // GetConfigDir returns the nuclei configuration directory @@ -257,7 +257,7 @@ func (c *Config) SetTemplatesVersion(version string) error { c.TemplateVersion = version // write config to disk if err := c.WriteTemplatesConfig(); err != nil { - return errorutil.NewWithErr(err).Msgf("could not write nuclei config file at %s", c.getTemplatesConfigFilePath()) + return errkit.Append(errkit.New(fmt.Sprintf("could not write nuclei config file at %s", c.getTemplatesConfigFilePath())), err) } return nil } @@ -265,15 +265,15 @@ func (c *Config) SetTemplatesVersion(version string) error { // ReadTemplatesConfig reads the nuclei templates config file func (c *Config) ReadTemplatesConfig() error { if !fileutil.FileExists(c.getTemplatesConfigFilePath()) { - return errorutil.NewWithTag("config", "nuclei config file at %s does not exist", c.getTemplatesConfigFilePath()) + return errkit.New(fmt.Sprintf("config: nuclei config file at %s does not exist", c.getTemplatesConfigFilePath())).Build() } var cfg *Config bin, err := os.ReadFile(c.getTemplatesConfigFilePath()) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not read nuclei config file at %s", c.getTemplatesConfigFilePath()) + return errkit.Append(errkit.New(fmt.Sprintf("could not read nuclei config file at %s", c.getTemplatesConfigFilePath())), err) } if err := json.Unmarshal(bin, &cfg); err != nil { - return errorutil.NewWithErr(err).Msgf("could not unmarshal nuclei config file at %s", c.getTemplatesConfigFilePath()) + return errkit.Append(errkit.New(fmt.Sprintf("could not unmarshal nuclei config file at %s", c.getTemplatesConfigFilePath())), err) } // apply config c.TemplatesDirectory = cfg.TemplatesDirectory @@ -292,10 +292,10 @@ func (c *Config) WriteTemplatesConfig() error { } bin, err := json.Marshal(c) if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to marshal nuclei config") + return errkit.Append(errkit.New("failed to marshal nuclei config"), err) } if err = os.WriteFile(c.getTemplatesConfigFilePath(), bin, 0600); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to write nuclei config file at %s", c.getTemplatesConfigFilePath()) + return errkit.Append(errkit.New(fmt.Sprintf("failed to write nuclei config file at %s", c.getTemplatesConfigFilePath())), err) } return nil } @@ -319,7 +319,7 @@ func (c *Config) getTemplatesConfigFilePath() string { func (c *Config) createConfigDirIfNotExists() error { if !fileutil.FolderExists(c.configDir) { if err := fileutil.CreateFolder(c.configDir); err != nil { - return errorutil.NewWithErr(err).Msgf("could not create nuclei config directory at %s", c.configDir) + return errkit.Append(errkit.New(fmt.Sprintf("could not create nuclei config directory at %s", c.configDir)), err) } } return nil diff --git a/pkg/catalog/loader/ai_loader.go b/pkg/catalog/loader/ai_loader.go index 998d2b0b9f..5b30c49732 100644 --- a/pkg/catalog/loader/ai_loader.go +++ b/pkg/catalog/loader/ai_loader.go @@ -3,6 +3,7 @@ package loader import ( "bytes" "encoding/json" + "fmt" "io" "net/http" "os" @@ -14,7 +15,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/projectdiscovery/retryablehttp-go" pdcpauth "github.com/projectdiscovery/utils/auth/pdcp" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) const ( @@ -33,27 +34,27 @@ type AITemplateResponse struct { func getAIGeneratedTemplates(prompt string, options *types.Options) ([]string, error) { prompt = strings.TrimSpace(prompt) if len(prompt) < 5 { - return nil, errorutil.New("Prompt is too short. Please provide a more descriptive prompt") + return nil, errkit.New("Prompt is too short. Please provide a more descriptive prompt").Build() } if len(prompt) > 3000 { - return nil, errorutil.New("Prompt is too long. Please limit to 3000 characters") + return nil, errkit.New("Prompt is too long. Please limit to 3000 characters").Build() } template, templateID, err := generateAITemplate(prompt) if err != nil { - return nil, errorutil.New("Failed to generate template: %v", err) + return nil, errkit.New(fmt.Sprintf("Failed to generate template: %v", err)).Build() } pdcpTemplateDir := filepath.Join(config.DefaultConfig.GetTemplateDir(), "pdcp") if err := os.MkdirAll(pdcpTemplateDir, 0755); err != nil { - return nil, errorutil.New("Failed to create pdcp template directory: %v", err) + return nil, errkit.New(fmt.Sprintf("Failed to create pdcp template directory: %v", err)).Build() } templateFile := filepath.Join(pdcpTemplateDir, templateID+".yaml") err = os.WriteFile(templateFile, []byte(template), 0644) if err != nil { - return nil, errorutil.New("Failed to generate template: %v", err) + return nil, errkit.New(fmt.Sprintf("Failed to generate template: %v", err)).Build() } options.Logger.Info().Msgf("Generated template available at: https://cloud.projectdiscovery.io/templates/%s", templateID) @@ -91,22 +92,22 @@ func generateAITemplate(prompt string) (string, string, error) { } jsonBody, err := json.Marshal(reqBody) if err != nil { - return "", "", errorutil.New("Failed to marshal request body: %v", err) + return "", "", errkit.New(fmt.Sprintf("Failed to marshal request body: %v", err)).Build() } req, err := http.NewRequest(http.MethodPost, aiTemplateGeneratorAPIEndpoint, bytes.NewBuffer(jsonBody)) if err != nil { - return "", "", errorutil.New("Failed to create HTTP request: %v", err) + return "", "", errkit.New(fmt.Sprintf("Failed to create HTTP request: %v", err)).Build() } ph := pdcpauth.PDCPCredHandler{} creds, err := ph.GetCreds() if err != nil { - return "", "", errorutil.New("Failed to get PDCP credentials: %v", err) + return "", "", errkit.New(fmt.Sprintf("Failed to get PDCP credentials: %v", err)).Build() } if creds == nil { - return "", "", errorutil.New("PDCP API Key not configured, Create one for free at https://cloud.projectdiscovery.io/") + return "", "", errkit.New("PDCP API Key not configured, Create one for free at https://cloud.projectdiscovery.io/").Build() } req.Header.Set("Content-Type", "application/json") @@ -114,28 +115,28 @@ func generateAITemplate(prompt string) (string, string, error) { resp, err := retryablehttp.DefaultClient().Do(req) if err != nil { - return "", "", errorutil.New("Failed to send HTTP request: %v", err) + return "", "", errkit.New(fmt.Sprintf("Failed to send HTTP request: %v", err)).Build() } defer func() { _ = resp.Body.Close() }() if resp.StatusCode == http.StatusUnauthorized { - return "", "", errorutil.New("Invalid API Key or API Key not configured, Create one for free at https://cloud.projectdiscovery.io/") + return "", "", errkit.New("Invalid API Key or API Key not configured, Create one for free at https://cloud.projectdiscovery.io/").Build() } if resp.StatusCode != http.StatusOK { body, _ := io.ReadAll(resp.Body) - return "", "", errorutil.New("API returned status code %d: %s", resp.StatusCode, string(body)) + return "", "", errkit.New(fmt.Sprintf("API returned status code %d: %s", resp.StatusCode, string(body))).Build() } var result AITemplateResponse if err := json.NewDecoder(resp.Body).Decode(&result); err != nil { - return "", "", errorutil.New("Failed to decode API response: %v", err) + return "", "", errkit.New(fmt.Sprintf("Failed to decode API response: %v", err)).Build() } if result.TemplateID == "" || result.Completion == "" { - return "", "", errorutil.New("Failed to generate template") + return "", "", errkit.New("Failed to generate template").Build() } return result.Completion, result.TemplateID, nil diff --git a/pkg/catalog/loader/loader.go b/pkg/catalog/loader/loader.go index 2c34032406..069e99b50e 100644 --- a/pkg/catalog/loader/loader.go +++ b/pkg/catalog/loader/loader.go @@ -24,7 +24,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/utils/stats" "github.com/projectdiscovery/nuclei/v3/pkg/workflows" "github.com/projectdiscovery/retryablehttp-go" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" sliceutil "github.com/projectdiscovery/utils/slice" stringsutil "github.com/projectdiscovery/utils/strings" syncutil "github.com/projectdiscovery/utils/sync" @@ -238,7 +238,7 @@ func (store *Store) ReadTemplateFromURI(uri string, remote bool) ([]byte, error) uri = handleTemplatesEditorURLs(uri) remoteTemplates, _, err := getRemoteTemplatesAndWorkflows([]string{uri}, nil, store.config.RemoteTemplateDomainList) if err != nil || len(remoteTemplates) == 0 { - return nil, errorutil.NewWithErr(err).Msgf("Could not load template %s: got %v", uri, remoteTemplates) + return nil, errkit.Append(errkit.New(fmt.Sprintf("Could not load template %s: got %v", uri, remoteTemplates)), err) } resp, err := retryablehttp.Get(remoteTemplates[0]) if err != nil { diff --git a/pkg/external/customtemplates/azure_blob.go b/pkg/external/customtemplates/azure_blob.go index 2610e2de9c..180c45d8ef 100644 --- a/pkg/external/customtemplates/azure_blob.go +++ b/pkg/external/customtemplates/azure_blob.go @@ -3,6 +3,7 @@ package customtemplates import ( "bytes" "context" + "fmt" "os" "path/filepath" "strings" @@ -12,7 +13,7 @@ import ( "github.com/projectdiscovery/gologger" "github.com/projectdiscovery/nuclei/v3/pkg/catalog/config" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) var _ Provider = &customTemplateAzureBlob{} @@ -29,7 +30,7 @@ func NewAzureProviders(options *types.Options) ([]*customTemplateAzureBlob, erro // Establish a connection to Azure and build a client object with which to download templates from Azure Blob Storage azClient, err := getAzureBlobClient(options.AzureTenantID, options.AzureClientID, options.AzureClientSecret, options.AzureServiceURL) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("Error establishing Azure Blob client for %s", options.AzureContainerName) + return nil, errkit.Append(errkit.New(fmt.Sprintf("Error establishing Azure Blob client for %s", options.AzureContainerName)), err) } // Create a new Azure Blob Storage container object diff --git a/pkg/external/customtemplates/gitlab.go b/pkg/external/customtemplates/gitlab.go index 169928befc..fce4caa2dd 100644 --- a/pkg/external/customtemplates/gitlab.go +++ b/pkg/external/customtemplates/gitlab.go @@ -3,13 +3,14 @@ package customtemplates import ( "context" "encoding/base64" + "fmt" "os" "path/filepath" "github.com/projectdiscovery/gologger" "github.com/projectdiscovery/nuclei/v3/pkg/catalog/config" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" gitlab "gitlab.com/gitlab-org/api/client-go" ) @@ -28,7 +29,7 @@ func NewGitLabProviders(options *types.Options) ([]*customTemplateGitLabRepo, er // Establish a connection to GitLab and build a client object with which to download templates from GitLab gitLabClient, err := getGitLabClient(options.GitLabServerURL, options.GitLabToken) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("Error establishing GitLab client for %s %s", options.GitLabServerURL, err) + return nil, errkit.Append(errkit.New(fmt.Sprintf("Error establishing GitLab client for %s %s", options.GitLabServerURL, err)), err) } // Create a new GitLab service client diff --git a/pkg/external/customtemplates/s3.go b/pkg/external/customtemplates/s3.go index 29bb465fd3..8b4eabff95 100644 --- a/pkg/external/customtemplates/s3.go +++ b/pkg/external/customtemplates/s3.go @@ -2,6 +2,7 @@ package customtemplates import ( "context" + "fmt" "os" "path/filepath" "strings" @@ -14,7 +15,7 @@ import ( "github.com/projectdiscovery/gologger" nucleiConfig "github.com/projectdiscovery/nuclei/v3/pkg/catalog/config" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" stringsutil "github.com/projectdiscovery/utils/strings" ) @@ -64,7 +65,7 @@ func NewS3Providers(options *types.Options) ([]*customTemplateS3Bucket, error) { if options.AwsBucketName != "" && !options.AwsTemplateDisableDownload { s3c, err := getS3Client(context.TODO(), options.AwsAccessKey, options.AwsSecretKey, options.AwsRegion, options.AwsProfile) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("error downloading s3 bucket %s", options.AwsBucketName) + return nil, errkit.Append(errkit.New(fmt.Sprintf("error downloading s3 bucket %s", options.AwsBucketName)), err) } ctBucket := &customTemplateS3Bucket{ bucketName: options.AwsBucketName, diff --git a/pkg/external/customtemplates/templates_provider.go b/pkg/external/customtemplates/templates_provider.go index 471d16482b..a4691d5bfa 100644 --- a/pkg/external/customtemplates/templates_provider.go +++ b/pkg/external/customtemplates/templates_provider.go @@ -4,7 +4,7 @@ import ( "context" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) type Provider interface { @@ -38,7 +38,7 @@ func NewCustomTemplatesManager(options *types.Options) (*CustomTemplatesManager, // Add GitHub providers githubProviders, err := NewGitHubProviders(options) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not create github providers for custom templates") + return nil, errkit.Append(errkit.New("could not create github providers for custom templates"), err) } for _, v := range githubProviders { ctm.providers = append(ctm.providers, v) @@ -47,7 +47,7 @@ func NewCustomTemplatesManager(options *types.Options) (*CustomTemplatesManager, // Add AWS S3 providers s3Providers, err := NewS3Providers(options) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not create s3 providers for custom templates") + return nil, errkit.Append(errkit.New("could not create s3 providers for custom templates"), err) } for _, v := range s3Providers { ctm.providers = append(ctm.providers, v) @@ -56,7 +56,7 @@ func NewCustomTemplatesManager(options *types.Options) (*CustomTemplatesManager, // Add Azure providers azureProviders, err := NewAzureProviders(options) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not create azure providers for custom templates") + return nil, errkit.Append(errkit.New("could not create azure providers for custom templates"), err) } for _, v := range azureProviders { ctm.providers = append(ctm.providers, v) @@ -65,7 +65,7 @@ func NewCustomTemplatesManager(options *types.Options) (*CustomTemplatesManager, // Add GitLab providers gitlabProviders, err := NewGitLabProviders(options) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not create gitlab providers for custom templates") + return nil, errkit.Append(errkit.New("could not create gitlab providers for custom templates"), err) } for _, v := range gitlabProviders { ctm.providers = append(ctm.providers, v) diff --git a/pkg/fuzz/execute.go b/pkg/fuzz/execute.go index eda78f4d0f..ddec765052 100644 --- a/pkg/fuzz/execute.go +++ b/pkg/fuzz/execute.go @@ -17,15 +17,16 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/marker" "github.com/projectdiscovery/nuclei/v3/pkg/utils/json" "github.com/projectdiscovery/retryablehttp-go" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" mapsutil "github.com/projectdiscovery/utils/maps" sliceutil "github.com/projectdiscovery/utils/slice" urlutil "github.com/projectdiscovery/utils/url" ) -var ( - ErrRuleNotApplicable = errorutil.NewWithFmt("rule not applicable: %v") -) +// ErrRuleNotApplicable returns a rule not applicable error +func ErrRuleNotApplicable(reason interface{}) error { + return errkit.New(fmt.Sprintf("rule not applicable: %v", reason)).Build() +} // IsErrRuleNotApplicable checks if an error is due to rule not applicable func IsErrRuleNotApplicable(err error) bool { @@ -89,10 +90,10 @@ type GeneratedRequest struct { // goroutines. func (rule *Rule) Execute(input *ExecuteRuleInput) (err error) { if !rule.isInputURLValid(input.Input) { - return ErrRuleNotApplicable.Msgf("invalid input url: %v", input.Input.MetaInput.Input) + return ErrRuleNotApplicable(fmt.Sprintf("invalid input url: %v", input.Input.MetaInput.Input)) } if input.BaseRequest == nil && input.Input.MetaInput.ReqResp == nil { - return ErrRuleNotApplicable.Msgf("both base request and reqresp are nil for %v", input.Input.MetaInput.Input) + return ErrRuleNotApplicable(fmt.Sprintf("both base request and reqresp are nil for %v", input.Input.MetaInput.Input)) } var finalComponentList []component.Component @@ -144,7 +145,7 @@ func (rule *Rule) Execute(input *ExecuteRuleInput) (err error) { } if len(finalComponentList) == 0 { - return ErrRuleNotApplicable.Msgf("no component matched on this rule") + return ErrRuleNotApplicable("no component matched on this rule") } baseValues := input.Values diff --git a/pkg/input/formats/openapi/generator.go b/pkg/input/formats/openapi/generator.go index 30778d8dc2..3d758cbc9a 100644 --- a/pkg/input/formats/openapi/generator.go +++ b/pkg/input/formats/openapi/generator.go @@ -20,7 +20,7 @@ import ( httpTypes "github.com/projectdiscovery/nuclei/v3/pkg/input/types" "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/projectdiscovery/nuclei/v3/pkg/utils/json" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" "github.com/projectdiscovery/utils/generic" mapsutil "github.com/projectdiscovery/utils/maps" "github.com/valyala/fasttemplate" @@ -395,7 +395,7 @@ func generateRequestsFromOp(opts *generateReqOptions) error { func GetGlobalParamsForSecurityRequirement(schema *openapi3.T, requirement *openapi3.SecurityRequirements) ([]*openapi3.ParameterRef, error) { globalParams := openapi3.NewParameters() if len(schema.Components.SecuritySchemes) == 0 { - return nil, errorutil.NewWithTag("openapi", "security requirements (%+v) without any security schemes found in openapi file", schema.Security) + return nil, errkit.New(fmt.Sprintf("openapi: security requirements (%+v) without any security schemes found in openapi file", schema.Security)).Build() } found := false // this api is protected for each security scheme pull its corresponding scheme @@ -415,11 +415,11 @@ schemaLabel: } if !found && len(security) > 1 { // if this is case then both security schemes are required - return nil, errorutil.NewWithTag("openapi", "security requirement (%+v) not found in openapi file", security) + return nil, errkit.New(fmt.Sprintf("openapi: security requirement (%+v) not found in openapi file", security)).Build() } } if !found { - return nil, errorutil.NewWithTag("openapi", "security requirement (%+v) not found in openapi file", requirement) + return nil, errkit.New(fmt.Sprintf("openapi: security requirement (%+v) not found in openapi file", requirement)).Build() } return globalParams, nil @@ -428,12 +428,12 @@ schemaLabel: // GenerateParameterFromSecurityScheme generates an example from a schema object func GenerateParameterFromSecurityScheme(scheme *openapi3.SecuritySchemeRef) (*openapi3.Parameter, error) { if !generic.EqualsAny(scheme.Value.Type, "http", "apiKey") { - return nil, errorutil.NewWithTag("openapi", "unsupported security scheme type (%s) found in openapi file", scheme.Value.Type) + return nil, errkit.New(fmt.Sprintf("openapi: unsupported security scheme type (%s) found in openapi file", scheme.Value.Type)).Build() } if scheme.Value.Type == "http" { // check scheme if !generic.EqualsAny(scheme.Value.Scheme, "basic", "bearer") { - return nil, errorutil.NewWithTag("openapi", "unsupported security scheme (%s) found in openapi file", scheme.Value.Scheme) + return nil, errkit.New(fmt.Sprintf("openapi: unsupported security scheme (%s) found in openapi file", scheme.Value.Scheme)).Build() } // HTTP authentication schemes basic or bearer use the Authorization header headerName := scheme.Value.Name @@ -458,10 +458,10 @@ func GenerateParameterFromSecurityScheme(scheme *openapi3.SecuritySchemeRef) (*o if scheme.Value.Type == "apiKey" { // validate name and in if scheme.Value.Name == "" { - return nil, errorutil.NewWithTag("openapi", "security scheme (%s) name is empty", scheme.Value.Type) + return nil, errkit.New(fmt.Sprintf("openapi: security scheme (%s) name is empty", scheme.Value.Type)).Build() } if !generic.EqualsAny(scheme.Value.In, "query", "header", "cookie") { - return nil, errorutil.NewWithTag("openapi", "unsupported security scheme (%s) in (%s) found in openapi file", scheme.Value.Type, scheme.Value.In) + return nil, errkit.New(fmt.Sprintf("openapi: unsupported security scheme (%s) in (%s) found in openapi file", scheme.Value.Type, scheme.Value.In)).Build() } // create parameters using the scheme switch scheme.Value.In { @@ -482,5 +482,5 @@ func GenerateParameterFromSecurityScheme(scheme *openapi3.SecuritySchemeRef) (*o return c, nil } } - return nil, errorutil.NewWithTag("openapi", "unsupported security scheme type (%s) found in openapi file", scheme.Value.Type) + return nil, errkit.New(fmt.Sprintf("openapi: unsupported security scheme type (%s) found in openapi file", scheme.Value.Type)).Build() } diff --git a/pkg/input/provider/interface.go b/pkg/input/provider/interface.go index 1ac0685143..c93a329de5 100644 --- a/pkg/input/provider/interface.go +++ b/pkg/input/provider/interface.go @@ -13,15 +13,19 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/contextargs" "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/generators" configTypes "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" stringsutil "github.com/projectdiscovery/utils/strings" ) var ( - ErrNotImplemented = errorutil.NewWithFmt("provider %s does not implement %s") - ErrInactiveInput = fmt.Errorf("input is inactive") + ErrInactiveInput = fmt.Errorf("input is inactive") ) +// ErrNotImplemented returns an error when a provider does not implement a method +func ErrNotImplemented(provider, method string) error { + return errkit.New(fmt.Sprintf("provider %s does not implement %s", provider, method)).Build() +} + const ( MultiFormatInputProvider = "MultiFormatInputProvider" ListInputProvider = "ListInputProvider" diff --git a/pkg/installer/template.go b/pkg/installer/template.go index d9f3d5ae19..62fefb0a60 100644 --- a/pkg/installer/template.go +++ b/pkg/installer/template.go @@ -17,7 +17,7 @@ import ( "github.com/projectdiscovery/gologger" "github.com/projectdiscovery/nuclei/v3/pkg/catalog/config" "github.com/projectdiscovery/nuclei/v3/pkg/external/customtemplates" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" stringsutil "github.com/projectdiscovery/utils/strings" updateutils "github.com/projectdiscovery/utils/update" @@ -80,7 +80,7 @@ func (t *TemplateManager) FreshInstallIfNotExists() error { } gologger.Info().Msgf("nuclei-templates are not installed, installing...") if err := t.installTemplatesAt(config.DefaultConfig.TemplatesDirectory); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to install templates at %s", config.DefaultConfig.TemplatesDirectory) + return errkit.Append(errkit.New(fmt.Sprintf("failed to install templates at %s", config.DefaultConfig.TemplatesDirectory)), err) } if t.CustomTemplates != nil { t.CustomTemplates.Download(context.TODO()) @@ -121,7 +121,7 @@ func (t *TemplateManager) UpdateIfOutdated() error { func (t *TemplateManager) installTemplatesAt(dir string) error { if !fileutil.FolderExists(dir) { if err := fileutil.CreateFolder(dir); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to create directory at %s", dir) + return errkit.Append(errkit.New(fmt.Sprintf("failed to create directory at %s", dir)), err) } } if t.DisablePublicTemplates { @@ -130,12 +130,12 @@ func (t *TemplateManager) installTemplatesAt(dir string) error { } ghrd, err := updateutils.NewghReleaseDownloader(config.OfficialNucleiTemplatesRepoName) if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to install templates at %s", dir) + return errkit.Append(errkit.New(fmt.Sprintf("failed to install templates at %s", dir)), err) } // write templates to disk if err := t.writeTemplatesToDisk(ghrd, dir); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to write templates to disk at %s", dir) + return errkit.Append(errkit.New(fmt.Sprintf("failed to write templates to disk at %s", dir)), err) } gologger.Info().Msgf("Successfully installed nuclei-templates at %s", dir) return nil @@ -156,7 +156,7 @@ func (t *TemplateManager) updateTemplatesAt(dir string) error { ghrd, err := updateutils.NewghReleaseDownloader(config.OfficialNucleiTemplatesRepoName) if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to install templates at %s", dir) + return errkit.Append(errkit.New(fmt.Sprintf("failed to install templates at %s", dir)), err) } latestVersion := ghrd.Latest.GetTagName() @@ -177,7 +177,7 @@ func (t *TemplateManager) updateTemplatesAt(dir string) error { newchecksums, err := t.getChecksumFromDir(dir) if err != nil { // unlikely this case will happen - return errorutil.NewWithErr(err).Msgf("failed to get checksums from %s after update", dir) + return errkit.Append(errkit.New(fmt.Sprintf("failed to get checksums from %s after update", dir)), err) } // summarize all changes @@ -299,7 +299,7 @@ func (t *TemplateManager) writeTemplatesToDisk(ghrd *updateutils.GHReleaseDownlo bin, err := io.ReadAll(r) if err != nil { // if error occurs, iteration also stops - return errorutil.NewWithErr(err).Msgf("failed to read file %s", uri) + return errkit.Append(errkit.New(fmt.Sprintf("failed to read file %s", uri)), err) } // TODO: It might be better to just download index file from nuclei templates repo // instead of creating it from scratch @@ -310,7 +310,7 @@ func (t *TemplateManager) writeTemplatesToDisk(ghrd *updateutils.GHReleaseDownlo if oldPath != writePath { // write new template at a new path and delete old template if err := os.WriteFile(writePath, bin, f.Mode()); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to write file %s", uri) + return errkit.Append(errkit.New(fmt.Sprintf("failed to write file %s", uri)), err) } // after successful write, remove old template if err := os.Remove(oldPath); err != nil { @@ -325,20 +325,20 @@ func (t *TemplateManager) writeTemplatesToDisk(ghrd *updateutils.GHReleaseDownlo } err = ghrd.DownloadSourceWithCallback(!HideProgressBar, callbackFunc) if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to download templates") + return errkit.Append(errkit.New("failed to download templates"), err) } if err := config.DefaultConfig.WriteTemplatesConfig(); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to write templates config") + return errkit.Append(errkit.New("failed to write templates config"), err) } // update ignore hash after writing new templates if err := config.DefaultConfig.UpdateNucleiIgnoreHash(); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to update nuclei ignore hash") + return errkit.Append(errkit.New("failed to update nuclei ignore hash"), err) } // update templates version in config file if err := config.DefaultConfig.SetTemplatesVersion(ghrd.Latest.GetTagName()); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to update templates version") + return errkit.Append(errkit.New("failed to update templates version"), err) } PurgeEmptyDirectories(dir) @@ -348,11 +348,11 @@ func (t *TemplateManager) writeTemplatesToDisk(ghrd *updateutils.GHReleaseDownlo index, err := config.GetNucleiTemplatesIndex() if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to get nuclei templates index") + return errkit.Append(errkit.New("failed to get nuclei templates index"), err) } if err = config.DefaultConfig.WriteTemplatesIndex(index); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to write nuclei templates index") + return errkit.Append(errkit.New("failed to write nuclei templates index"), err) } if !HideReleaseNotes { @@ -448,5 +448,8 @@ func (t *TemplateManager) calculateChecksumMap(dir string) (map[string]string, e } return nil }) - return checksumMap, errorutil.WrapfWithNil(err, "failed to calculate checksums of templates") + if err != nil { + return nil, errkit.Append(errkit.New("failed to calculate checksums of templates"), err) + } + return checksumMap, nil } diff --git a/pkg/installer/util.go b/pkg/installer/util.go index af74826216..a0bc99751e 100644 --- a/pkg/installer/util.go +++ b/pkg/installer/util.go @@ -14,7 +14,7 @@ import ( "github.com/Masterminds/semver/v3" "github.com/projectdiscovery/gologger" "github.com/projectdiscovery/nuclei/v3/pkg/catalog/config" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) // GetNewTemplatesInVersions returns templates path of all newly added templates @@ -52,7 +52,7 @@ func getNewAdditionsFileFromGitHub(version string) ([]string, error) { return nil, err } if resp.StatusCode != http.StatusOK { - return nil, errorutil.New("version not found") + return nil, errkit.New("version not found").Build() } data, err := io.ReadAll(resp.Body) if err != nil { diff --git a/pkg/js/devtools/tsgen/scrape.go b/pkg/js/devtools/tsgen/scrape.go index 960700f579..3c846ad7d1 100644 --- a/pkg/js/devtools/tsgen/scrape.go +++ b/pkg/js/devtools/tsgen/scrape.go @@ -6,7 +6,7 @@ import ( "regexp" "strings" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) // scrape.go scrapes all information of exported type from different package @@ -21,17 +21,17 @@ func (p *EntityParser) scrapeAndCreate(typeName string) error { // get package pkg, ok := p.imports[pkgName] if !ok { - return errorutil.New("package %v for type %v not found", pkgName, typeName) + return errkit.New(fmt.Sprintf("package %v for type %v not found", pkgName, typeName)).Build() } // get type obj := pkg.Types.Scope().Lookup(baseTypeName) if obj == nil { - return errorutil.New("type %v not found in package %+v", typeName, pkg) + return errkit.New(fmt.Sprintf("type %v not found in package %+v", typeName, pkg)).Build() } // Ensure the object is a type name typeNameObj, ok := obj.(*types.TypeName) if !ok { - return errorutil.New("%v is not a type name", typeName) + return errkit.New(fmt.Sprintf("%v is not a type name", typeName)).Build() } // Ensure the type is a named struct type namedStruct, ok := typeNameObj.Type().Underlying().(*types.Struct) diff --git a/pkg/js/global/scripts.go b/pkg/js/global/scripts.go index 6101eaf425..5bd625cbc2 100644 --- a/pkg/js/global/scripts.go +++ b/pkg/js/global/scripts.go @@ -4,6 +4,7 @@ import ( "bytes" "context" "embed" + "fmt" "math/rand" "net" "reflect" @@ -17,7 +18,6 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/utils/vardump" "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/projectdiscovery/utils/errkit" - errorutil "github.com/projectdiscovery/utils/errors" stringsutil "github.com/projectdiscovery/utils/strings" ) @@ -257,7 +257,7 @@ func RegisterNativeScripts(runtime *goja.Runtime) error { // import default modules _, err = runtime.RunString(defaultImports) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not import default modules %v", defaultImports) + return errkit.Append(errkit.New(fmt.Sprintf("could not import default modules %v", defaultImports)), err) } return nil diff --git a/pkg/js/gojs/set.go b/pkg/js/gojs/set.go index 6aff9f1c73..72aece402a 100644 --- a/pkg/js/gojs/set.go +++ b/pkg/js/gojs/set.go @@ -2,15 +2,16 @@ package gojs import ( "context" + "fmt" "reflect" "github.com/Mzack9999/goja" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) var ( - ErrInvalidFuncOpts = errorutil.NewWithFmt("invalid function options: %v") - ErrNilRuntime = errorutil.New("runtime is nil") + ErrInvalidFuncOpts = errkit.New("invalid function options: %v").Build() + ErrNilRuntime = errkit.New("runtime is nil").Build() ) type FuncOpts struct { @@ -83,7 +84,7 @@ func RegisterFuncWithSignature(runtime *goja.Runtime, opts FuncOpts) error { return ErrNilRuntime } if !opts.valid() { - return ErrInvalidFuncOpts.Msgf("name: %s, signatures: %v, description: %s", opts.Name, opts.Signatures, opts.Description) + return errkit.New(fmt.Sprintf("invalid function options: name: %s, signatures: %v, description: %s", opts.Name, opts.Signatures, opts.Description)).Build() } // Wrap the function with context injection diff --git a/pkg/js/libs/mssql/mssql.go b/pkg/js/libs/mssql/mssql.go index 4f9caf2751..f1a538db22 100644 --- a/pkg/js/libs/mssql/mssql.go +++ b/pkg/js/libs/mssql/mssql.go @@ -63,7 +63,7 @@ func connect(executionId string, host string, port int, username string, passwor } if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return false, protocolstate.ErrHostDenied.Msgf(host) + return false, protocolstate.ErrHostDenied(host) } target := net.JoinHostPort(host, fmt.Sprintf("%d", port)) @@ -118,7 +118,7 @@ func (c *MSSQLClient) IsMssql(ctx context.Context, host string, port int) (bool, func isMssql(executionId string, host string, port int) (bool, error) { if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return false, protocolstate.ErrHostDenied.Msgf(host) + return false, protocolstate.ErrHostDenied(host) } dialer := protocolstate.GetDialersWithId(executionId) @@ -162,7 +162,7 @@ func (c *MSSQLClient) ExecuteQuery(ctx context.Context, host string, port int, u } if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return nil, protocolstate.ErrHostDenied.Msgf(host) + return nil, protocolstate.ErrHostDenied(host) } target := net.JoinHostPort(host, fmt.Sprintf("%d", port)) diff --git a/pkg/js/libs/mysql/mysql.go b/pkg/js/libs/mysql/mysql.go index c48c73a83d..a059766d38 100644 --- a/pkg/js/libs/mysql/mysql.go +++ b/pkg/js/libs/mysql/mysql.go @@ -45,7 +45,7 @@ func (c *MySQLClient) IsMySQL(ctx context.Context, host string, port int) (bool, func isMySQL(executionId string, host string, port int) (bool, error) { if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return false, protocolstate.ErrHostDenied.Msgf(host) + return false, protocolstate.ErrHostDenied(host) } dialer := protocolstate.GetDialersWithId(executionId) if dialer == nil { @@ -85,7 +85,7 @@ func (c *MySQLClient) Connect(ctx context.Context, host string, port int, userna executionId := ctx.Value("executionId").(string) if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return false, protocolstate.ErrHostDenied.Msgf(host) + return false, protocolstate.ErrHostDenied(host) } // executing queries implies the remote mysql service @@ -144,7 +144,7 @@ func fingerprintMySQL(executionId string, host string, port int) (MySQLInfo, err info := MySQLInfo{} if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return info, protocolstate.ErrHostDenied.Msgf(host) + return info, protocolstate.ErrHostDenied(host) } dialer := protocolstate.GetDialersWithId(executionId) if dialer == nil { @@ -209,7 +209,7 @@ func (c *MySQLClient) ExecuteQueryWithOpts(ctx context.Context, opts MySQLOption executionId := ctx.Value("executionId").(string) if !protocolstate.IsHostAllowed(executionId, opts.Host) { // host is not valid according to network policy - return nil, protocolstate.ErrHostDenied.Msgf(opts.Host) + return nil, protocolstate.ErrHostDenied(opts.Host) } // executing queries implies the remote mysql service diff --git a/pkg/js/libs/net/net.go b/pkg/js/libs/net/net.go index 1db091636f..2f486bfa5c 100644 --- a/pkg/js/libs/net/net.go +++ b/pkg/js/libs/net/net.go @@ -10,7 +10,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/protocolstate" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" "github.com/projectdiscovery/utils/reader" ) @@ -201,7 +201,7 @@ func (c *NetConn) RecvFull(N int) ([]byte, error) { } bin, err := reader.ConnReadNWithTimeout(c.conn, int64(N), c.timeout) if err != nil { - return []byte{}, errorutil.NewWithErr(err).Msgf("failed to read %d bytes", N) + return []byte{}, errkit.Append(errkit.New(fmt.Sprintf("failed to read %d bytes", N)), err) } return bin, nil } @@ -226,7 +226,7 @@ func (c *NetConn) Recv(N int) ([]byte, error) { b := make([]byte, N) n, err := c.conn.Read(b) if err != nil { - return []byte{}, errorutil.NewWithErr(err).Msgf("failed to read %d bytes", N) + return []byte{}, errkit.Append(errkit.New(fmt.Sprintf("failed to read %d bytes", N)), err) } return b[:n], nil } diff --git a/pkg/js/libs/postgres/postgres.go b/pkg/js/libs/postgres/postgres.go index 322048a8b1..4dd1cd542c 100644 --- a/pkg/js/libs/postgres/postgres.go +++ b/pkg/js/libs/postgres/postgres.go @@ -122,7 +122,7 @@ func (c *PGClient) ExecuteQuery(ctx context.Context, host string, port int, user func executeQuery(executionId string, host string, port int, username string, password string, dbName string, query string) (*utils.SQLResult, error) { if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return nil, protocolstate.ErrHostDenied.Msgf(host) + return nil, protocolstate.ErrHostDenied(host) } target := net.JoinHostPort(host, fmt.Sprintf("%d", port)) @@ -179,7 +179,7 @@ func connect(executionId string, host string, port int, username string, passwor if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return false, protocolstate.ErrHostDenied.Msgf(host) + return false, protocolstate.ErrHostDenied(host) } target := net.JoinHostPort(host, fmt.Sprintf("%d", port)) diff --git a/pkg/js/libs/redis/redis.go b/pkg/js/libs/redis/redis.go index 84b96d86b3..5017882435 100644 --- a/pkg/js/libs/redis/redis.go +++ b/pkg/js/libs/redis/redis.go @@ -27,7 +27,7 @@ func GetServerInfo(ctx context.Context, host string, port int) (string, error) { func getServerInfo(executionId string, host string, port int) (string, error) { if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return "", protocolstate.ErrHostDenied.Msgf(host) + return "", protocolstate.ErrHostDenied(host) } // create a new client client := redis.NewClient(&redis.Options{ @@ -69,7 +69,7 @@ func Connect(ctx context.Context, host string, port int, password string) (bool, func connect(executionId string, host string, port int, password string) (bool, error) { if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return false, protocolstate.ErrHostDenied.Msgf(host) + return false, protocolstate.ErrHostDenied(host) } // create a new client client := redis.NewClient(&redis.Options{ @@ -109,7 +109,7 @@ func GetServerInfoAuth(ctx context.Context, host string, port int, password stri func getServerInfoAuth(executionId string, host string, port int, password string) (string, error) { if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return "", protocolstate.ErrHostDenied.Msgf(host) + return "", protocolstate.ErrHostDenied(host) } // create a new client client := redis.NewClient(&redis.Options{ @@ -181,7 +181,7 @@ func RunLuaScript(ctx context.Context, host string, port int, password string, s executionId := ctx.Value("executionId").(string) if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return false, protocolstate.ErrHostDenied.Msgf(host) + return false, protocolstate.ErrHostDenied(host) } // create a new client client := redis.NewClient(&redis.Options{ diff --git a/pkg/js/libs/smb/smb.go b/pkg/js/libs/smb/smb.go index 7dc2dc83b5..62a8046096 100644 --- a/pkg/js/libs/smb/smb.go +++ b/pkg/js/libs/smb/smb.go @@ -43,7 +43,7 @@ func (c *SMBClient) ConnectSMBInfoMode(ctx context.Context, host string, port in func connectSMBInfoMode(executionId string, host string, port int) (*smb.SMBLog, error) { if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return nil, protocolstate.ErrHostDenied.Msgf(host) + return nil, protocolstate.ErrHostDenied(host) } dialer := protocolstate.GetDialersWithId(executionId) if dialer == nil { @@ -90,7 +90,7 @@ func (c *SMBClient) ListSMBv2Metadata(ctx context.Context, host string, port int executionId := ctx.Value("executionId").(string) if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return nil, protocolstate.ErrHostDenied.Msgf(host) + return nil, protocolstate.ErrHostDenied(host) } return memoizedcollectSMBv2Metadata(executionId, host, port, 5*time.Second) } @@ -119,7 +119,7 @@ func (c *SMBClient) ListShares(ctx context.Context, host string, port int, user, func listShares(executionId string, host string, port int, user string, password string) ([]string, error) { if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return nil, protocolstate.ErrHostDenied.Msgf(host) + return nil, protocolstate.ErrHostDenied(host) } dialer := protocolstate.GetDialersWithId(executionId) if dialer == nil { diff --git a/pkg/js/libs/smb/smbghost.go b/pkg/js/libs/smb/smbghost.go index 69ddcca1e5..bf498f3bab 100644 --- a/pkg/js/libs/smb/smbghost.go +++ b/pkg/js/libs/smb/smbghost.go @@ -35,7 +35,7 @@ func (c *SMBClient) DetectSMBGhost(ctx context.Context, host string, port int) ( func detectSMBGhost(executionId string, host string, port int) (bool, error) { if !protocolstate.IsHostAllowed(executionId, host) { // host is not valid according to network policy - return false, protocolstate.ErrHostDenied.Msgf(host) + return false, protocolstate.ErrHostDenied(host) } addr := net.JoinHostPort(host, strconv.Itoa(port)) dialer := protocolstate.GetDialersWithId(executionId) diff --git a/pkg/js/libs/smtp/smtp.go b/pkg/js/libs/smtp/smtp.go index d4a7e02270..f0f4b90b1f 100644 --- a/pkg/js/libs/smtp/smtp.go +++ b/pkg/js/libs/smtp/smtp.go @@ -68,7 +68,7 @@ func NewSMTPClient(call goja.ConstructorCall, runtime *goja.Runtime) *goja.Objec executionId := c.nj.ExecutionId() // check if this is allowed address - c.nj.Require(protocolstate.IsHostAllowed(executionId, host+":"+port), protocolstate.ErrHostDenied.Msgf(host+":"+port).Error()) + c.nj.Require(protocolstate.IsHostAllowed(executionId, host+":"+port), protocolstate.ErrHostDenied(host+":"+port).Error()) // Link Constructor to Client and return return utils.LinkConstructor(call, runtime, c) diff --git a/pkg/js/libs/ssh/ssh.go b/pkg/js/libs/ssh/ssh.go index 17b35afe57..ebb041e208 100644 --- a/pkg/js/libs/ssh/ssh.go +++ b/pkg/js/libs/ssh/ssh.go @@ -7,7 +7,7 @@ import ( "time" "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/protocolstate" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" "github.com/zmap/zgrab2/lib/ssh" ) @@ -129,7 +129,7 @@ func (c *SSHClient) ConnectSSHInfoMode(ctx context.Context, host string, port in // ``` func (c *SSHClient) Run(cmd string) (string, error) { if c.connection == nil { - return "", errorutil.New("no connection") + return "", errkit.New("no connection").Build() } session, err := c.connection.NewSession() if err != nil { @@ -177,14 +177,14 @@ type connectOptions struct { func (c *connectOptions) validate() error { if c.Host == "" { - return errorutil.New("host is required") + return errkit.New("host is required").Build() } if c.Port <= 0 { - return errorutil.New("port is required") + return errkit.New("port is required").Build() } if !protocolstate.IsHostAllowed(c.ExecutionId, c.Host) { // host is not valid according to network policy - return protocolstate.ErrHostDenied.Msgf(c.Host) + return protocolstate.ErrHostDenied(c.Host) } if c.Timeout == 0 { c.Timeout = 10 * time.Second diff --git a/pkg/operators/common/dsl/dsl.go b/pkg/operators/common/dsl/dsl.go index 56ac06509e..a424790d55 100644 --- a/pkg/operators/common/dsl/dsl.go +++ b/pkg/operators/common/dsl/dsl.go @@ -61,11 +61,12 @@ func init() { return nil, fmt.Errorf("invalid dns type") } - err := dnsclientpool.Init(&types.Options{}) + options := &types.Options{} + err := dnsclientpool.Init(options) if err != nil { return nil, err } - dnsClient, err := dnsclientpool.Get(nil, &dnsclientpool.Configuration{}) + dnsClient, err := dnsclientpool.Get(options, &dnsclientpool.Configuration{}) if err != nil { return nil, err } diff --git a/pkg/operators/common/dsl/dsl_test.go b/pkg/operators/common/dsl/dsl_test.go index f83fb2073a..40564ca187 100644 --- a/pkg/operators/common/dsl/dsl_test.go +++ b/pkg/operators/common/dsl/dsl_test.go @@ -5,10 +5,15 @@ import ( "testing" "github.com/Knetic/govaluate" + "github.com/projectdiscovery/nuclei/v3/pkg/protocols/dns/dnsclientpool" + "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/stretchr/testify/require" ) func TestDslExpressions(t *testing.T) { + // Use Google DNS for more reliable testing + googleDNS := []string{"8.8.8.8:53", "8.8.4.4:53"} + dslExpressions := map[string]interface{}{ `resolve("scanme.sh")`: "128.199.158.128", `resolve("scanme.sh","a")`: "128.199.158.128", @@ -17,7 +22,7 @@ func TestDslExpressions(t *testing.T) { `resolve("scanme.sh","soa")`: "ns69.domaincontrol.com", } - testDslExpressionScenarios(t, dslExpressions) + testDslExpressionScenariosWithDNS(t, dslExpressions, googleDNS) } func evaluateExpression(t *testing.T, dslExpression string) interface{} { @@ -34,7 +39,13 @@ func evaluateExpression(t *testing.T, dslExpression string) interface{} { return actualResult } -func testDslExpressionScenarios(t *testing.T, dslExpressions map[string]interface{}) { +func testDslExpressionScenariosWithDNS(t *testing.T, dslExpressions map[string]interface{}, resolvers []string) { + // Initialize DNS client pool with custom resolvers for testing + err := dnsclientpool.Init(&types.Options{ + InternalResolversList: resolvers, + }) + require.NoError(t, err, "Failed to initialize DNS client pool with custom resolvers") + for dslExpression, expectedResult := range dslExpressions { t.Run(dslExpression, func(t *testing.T) { actualResult := evaluateExpression(t, dslExpression) diff --git a/pkg/protocols/code/code.go b/pkg/protocols/code/code.go index 4af590c77b..0a17c9f3f4 100644 --- a/pkg/protocols/code/code.go +++ b/pkg/protocols/code/code.go @@ -33,7 +33,6 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/types" contextutil "github.com/projectdiscovery/utils/context" "github.com/projectdiscovery/utils/errkit" - errorutil "github.com/projectdiscovery/utils/errors" ) const ( @@ -114,7 +113,7 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { if options.Options.Validate { options.Logger.Error().Msgf("%s <- %s", errMsg, err) } else { - return errorutil.NewWithErr(err).Msgf(errMsg) + return errkit.Append(errkit.New(errMsg), err) } } else { request.gozero = engine @@ -154,7 +153,7 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { if request.PreCondition != "" { preConditionCompiled, err := compiler.SourceAutoMode(request.PreCondition, false) if err != nil { - return errorutil.NewWithTag(request.TemplateID, "could not compile pre-condition: %s", err) + return errkit.New(fmt.Sprintf("%s: could not compile pre-condition: %s", request.TemplateID, err)).Build() } request.preConditionCompiled = preConditionCompiled } @@ -231,7 +230,7 @@ func (request *Request) ExecuteWithResults(input *contextargs.Context, dynamicVa Context: input.Context(), }) if err != nil { - return errorutil.NewWithTag(request.TemplateID, "could not execute pre-condition: %s", err) + return errkit.New(fmt.Sprintf("%s: could not execute pre-condition: %s", request.TemplateID, err)).Build() } if !result.GetSuccess() || types.ToString(result["error"]) != "" { gologger.Warning().Msgf("[%s] Precondition for request %s was not satisfied\n", request.TemplateID, request.PreCondition) diff --git a/pkg/protocols/common/interactsh/interactsh.go b/pkg/protocols/common/interactsh/interactsh.go index 6bb70709f1..6cf7b12289 100644 --- a/pkg/protocols/common/interactsh/interactsh.go +++ b/pkg/protocols/common/interactsh/interactsh.go @@ -22,7 +22,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/helpers/responsehighlighter" "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/helpers/writer" "github.com/projectdiscovery/retryablehttp-go" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" stringsutil "github.com/projectdiscovery/utils/strings" ) @@ -88,7 +88,7 @@ func (c *Client) poll() error { KeepAliveInterval: time.Minute, }) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not create client") + return errkit.Append(errkit.New("could not create client"), err) } c.interactsh = interactsh @@ -109,7 +109,7 @@ func (c *Client) poll() error { // If we don't have any request for this ID, add it to temporary // lru cache, so we can correlate when we get an add request. items, err := c.interactions.Get(interaction.UniqueID) - if errorutil.IsAny(err, gcache.KeyNotFoundError) || items == nil { + if errors.Is(err, gcache.KeyNotFoundError) || items == nil { _ = c.interactions.SetWithExpire(interaction.UniqueID, []*server.Interaction{interaction}, defaultInteractionDuration) } else { items = append(items, interaction) @@ -128,7 +128,7 @@ func (c *Client) poll() error { }) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not perform interactsh polling") + return errkit.Append(errkit.New("could not perform interactsh polling"), err) } return nil } @@ -239,7 +239,7 @@ func (c *Client) URL() (string, error) { err = c.poll() }) if err != nil { - return "", errorutil.NewWithErr(err).Wrap(ErrInteractshClientNotInitialized) + return "", errkit.Append(ErrInteractshClientNotInitialized, err) } if c.interactsh == nil { diff --git a/pkg/protocols/common/protocolstate/file.go b/pkg/protocols/common/protocolstate/file.go index 180d5a0b5e..0ca4dd3b7f 100644 --- a/pkg/protocols/common/protocolstate/file.go +++ b/pkg/protocols/common/protocolstate/file.go @@ -1,11 +1,12 @@ package protocolstate import ( + "fmt" "strings" "github.com/projectdiscovery/nuclei/v3/pkg/catalog/config" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" mapsutil "github.com/projectdiscovery/utils/maps" ) @@ -67,12 +68,12 @@ func NormalizePath(options *types.Options, filePath string) (string, error) { } cleaned, err := fileutil.ResolveNClean(filePath, config.DefaultConfig.GetTemplateDir()) if err != nil { - return "", errorutil.NewWithErr(err).Msgf("could not resolve and clean path %v", filePath) + return "", errkit.Append(errkit.New(fmt.Sprintf("could not resolve and clean path %v", filePath)), err) } // only allow files inside nuclei-templates directory // even current working directory is not allowed if strings.HasPrefix(cleaned, config.DefaultConfig.GetTemplateDir()) { return cleaned, nil } - return "", errorutil.New("path %v is outside nuclei-template directory and -lfa is not enabled", filePath) + return "", errkit.New(fmt.Sprintf("path %v is outside nuclei-template directory and -lfa is not enabled", filePath)).Build() } diff --git a/pkg/protocols/common/protocolstate/headless.go b/pkg/protocols/common/protocolstate/headless.go index 1d9970119c..ee75c3b31b 100644 --- a/pkg/protocols/common/protocolstate/headless.go +++ b/pkg/protocols/common/protocolstate/headless.go @@ -2,6 +2,7 @@ package protocolstate import ( "context" + "fmt" "net" "strings" @@ -9,7 +10,7 @@ import ( "github.com/go-rod/rod/lib/proto" "github.com/projectdiscovery/networkpolicy" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" stringsutil "github.com/projectdiscovery/utils/strings" urlutil "github.com/projectdiscovery/utils/url" "go.uber.org/multierr" @@ -17,10 +18,15 @@ import ( // initialize state of headless protocol -var ( - ErrURLDenied = errorutil.NewWithFmt("headless: url %v dropped by rule: %v") - ErrHostDenied = errorutil.NewWithFmt("host %v dropped by network policy") -) +// ErrURLDenied returns an error when a URL is denied by network policy +func ErrURLDenied(url, rule string) error { + return errkit.New(fmt.Sprintf("headless: url %v dropped by rule: %v", url, rule)).Build() +} + +// ErrHostDenied returns an error when a host is denied by network policy +func ErrHostDenied(host string) error { + return errkit.New(fmt.Sprintf("host %v dropped by network policy", host)).Build() +} func GetNetworkPolicy(ctx context.Context) *networkpolicy.NetworkPolicy { execCtx := GetExecutionContext(ctx) @@ -41,15 +47,15 @@ func ValidateNFailRequest(options *types.Options, page *rod.Page, e *proto.Fetch normalized := strings.ToLower(reqURL) // normalize url to lowercase normalized = strings.TrimSpace(normalized) // trim leading & trailing whitespaces if !IsLfaAllowed(options) && stringsutil.HasPrefixI(normalized, "file:") { - return multierr.Combine(FailWithReason(page, e), ErrURLDenied.Msgf(reqURL, "use of file:// protocol disabled use '-lfa' to enable")) + return multierr.Combine(FailWithReason(page, e), ErrURLDenied(reqURL, "use of file:// protocol disabled use '-lfa' to enable")) } // validate potential invalid schemes // javascript protocol is allowed for xss fuzzing if stringsutil.HasPrefixAnyI(normalized, "ftp:", "externalfile:", "chrome:", "chrome-extension:") { - return multierr.Combine(FailWithReason(page, e), ErrURLDenied.Msgf(reqURL, "protocol blocked by network policy")) + return multierr.Combine(FailWithReason(page, e), ErrURLDenied(reqURL, "protocol blocked by network policy")) } if !isValidHost(options, reqURL) { - return multierr.Combine(FailWithReason(page, e), ErrURLDenied.Msgf(reqURL, "address blocked by network policy")) + return multierr.Combine(FailWithReason(page, e), ErrURLDenied(reqURL, "address blocked by network policy")) } return nil } diff --git a/pkg/protocols/headless/engine/page.go b/pkg/protocols/headless/engine/page.go index 244d740c86..86f95a0e8c 100644 --- a/pkg/protocols/headless/engine/page.go +++ b/pkg/protocols/headless/engine/page.go @@ -18,7 +18,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/protocols/utils" httputil "github.com/projectdiscovery/nuclei/v3/pkg/protocols/utils/http" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" urlutil "github.com/projectdiscovery/utils/url" ) @@ -78,7 +78,7 @@ func (i *Instance) Run(ctx *contextargs.Context, actions []*Action, payloads map target := ctx.MetaInput.Input input, err := urlutil.Parse(target) if err != nil { - return nil, nil, errorutil.NewWithErr(err).Msgf("could not parse URL %s", target) + return nil, nil, errkit.Append(errkit.New(fmt.Sprintf("could not parse URL %s", target)), err) } hasTrailingSlash := httputil.HasTrailingSlash(target) diff --git a/pkg/protocols/headless/engine/page_actions.go b/pkg/protocols/headless/engine/page_actions.go index c051357d95..1a11bdc7f9 100644 --- a/pkg/protocols/headless/engine/page_actions.go +++ b/pkg/protocols/headless/engine/page_actions.go @@ -23,7 +23,6 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/protocolstate" contextutil "github.com/projectdiscovery/utils/context" "github.com/projectdiscovery/utils/errkit" - errorutil "github.com/projectdiscovery/utils/errors" fileutil "github.com/projectdiscovery/utils/file" folderutil "github.com/projectdiscovery/utils/folder" stringsutil "github.com/projectdiscovery/utils/strings" @@ -32,8 +31,8 @@ import ( ) var ( - errinvalidArguments = errorutil.New("invalid arguments provided") - ErrLFAccessDenied = errorutil.New("Use -allow-local-file-access flag to enable local file access") + errinvalidArguments = errkit.New("invalid arguments provided").Build() + ErrLFAccessDenied = errkit.New("Use -allow-local-file-access flag to enable local file access").Build() // ErrActionExecDealine is the error returned when alloted time for action execution exceeds ErrActionExecDealine = errkit.New("headless action execution deadline exceeded").SetKind(errkit.ErrKindDeadline).Build() ) @@ -60,7 +59,7 @@ func (p *Page) ExecuteActions(input *contextargs.Context, actions []*Action) (ou } if r := recover(); r != nil { - err = errorutil.New("panic on headless action: %v", r) + err = errkit.New(fmt.Sprintf("panic on headless action: %v", r)).Build() } }() @@ -73,7 +72,7 @@ func (p *Page) ExecuteActions(input *contextargs.Context, actions []*Action) (ou for _, waitFunc := range waitFuncs { if waitFunc != nil { if err := waitFunc(); err != nil { - return nil, errorutil.NewWithErr(err).Msgf("error occurred while executing waitFunc") + return nil, errkit.Append(errkit.New("error occurred while executing waitFunc"), err) } } } @@ -401,7 +400,7 @@ func (p *Page) NavigateURL(action *Action, out ActionData) error { parsedURL, err := urlutil.ParseURL(url, true) if err != nil { - return errorutil.NewWithTag("headless", "failed to parse url %v while creating http request", url) + return errkit.New(fmt.Sprintf("headless: failed to parse url %v while creating http request", url)).Build() } // ===== parameter automerge ===== @@ -411,7 +410,7 @@ func (p *Page) NavigateURL(action *Action, out ActionData) error { parsedURL.Params = finalparams if err := p.page.Navigate(parsedURL.String()); err != nil { - return errorutil.NewWithErr(err).Msgf("could not navigate to url %s", parsedURL.String()) + return errkit.Append(errkit.New(fmt.Sprintf("could not navigate to url %s", parsedURL.String())), err) } p.updateLastNavigatedURL() @@ -525,14 +524,14 @@ func (p *Page) Screenshot(act *Action, out ActionData) error { to, err = fileutil.CleanPath(to) if err != nil { - return errorutil.New("could not clean output screenshot path %s", to) + return errkit.New(fmt.Sprintf("could not clean output screenshot path %s", to)).Build() } // allow if targetPath is child of current working directory if !protocolstate.IsLfaAllowed(p.options.Options) { cwd, err := os.Getwd() if err != nil { - return errorutil.NewWithErr(err).Msgf("could not get current working directory") + return errkit.Append(errkit.New("could not get current working directory"), err) } if !strings.HasPrefix(to, cwd) { @@ -551,7 +550,7 @@ func (p *Page) Screenshot(act *Action, out ActionData) error { // creates new directory if needed based on path `to` // TODO: replace all permission bits with fileutil constants (https://github.com/projectdiscovery/utils/issues/113) if err := os.MkdirAll(filepath.Dir(to), 0700); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to create directory while writing screenshot") + return errkit.Append(errkit.New("failed to create directory while writing screenshot"), err) } } @@ -563,7 +562,7 @@ func (p *Page) Screenshot(act *Action, out ActionData) error { if fileutil.FileExists(filePath) { // return custom error as overwriting files is not supported - return errorutil.NewWithTag("screenshot", "failed to write screenshot, file %v already exists", filePath) + return errkit.New(fmt.Sprintf("screenshot: failed to write screenshot, file %v already exists", filePath)).Build() } err = os.WriteFile(filePath, data, 0540) if err != nil { @@ -806,12 +805,12 @@ func (p *Page) WaitEvent(act *Action, out ActionData) (func() error, error) { gotType := proto.GetType(event) if gotType == nil { - return nil, errorutil.New("event %q does not exist", event) + return nil, errkit.New(fmt.Sprintf("event %q does not exist", event)).Build() } tmp, ok := reflect.New(gotType).Interface().(proto.Event) if !ok { - return nil, errorutil.New("event %q is not a page event", event) + return nil, errkit.New(fmt.Sprintf("event %q is not a page event", event)).Build() } waitEvent = tmp @@ -948,7 +947,7 @@ func (p *Page) getActionArg(action *Action, arg string) (string, error) { err = expressions.ContainsUnresolvedVariables(exprs...) if err != nil { - return "", errorutil.NewWithErr(err).Msgf("argument %q, value: %q", arg, argValue) + return "", errkit.Append(errkit.New(fmt.Sprintf("argument %q, value: %q", arg, argValue)), err) } argValue, err = expressions.Evaluate(argValue, p.variables) diff --git a/pkg/protocols/http/build_request.go b/pkg/protocols/http/build_request.go index 2911682652..7dac41568e 100644 --- a/pkg/protocols/http/build_request.go +++ b/pkg/protocols/http/build_request.go @@ -27,7 +27,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/types/scanstrategy" "github.com/projectdiscovery/rawhttp" "github.com/projectdiscovery/retryablehttp-go" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" readerutil "github.com/projectdiscovery/utils/reader" stringsutil "github.com/projectdiscovery/utils/strings" urlutil "github.com/projectdiscovery/utils/url" @@ -37,11 +37,17 @@ const ( ReqURLPatternKey = "req_url_pattern" ) -// ErrEvalExpression -var ( - ErrEvalExpression = errorutil.NewWithTag("expr", "could not evaluate helper expressions") - ErrUnresolvedVars = errorutil.NewWithFmt("unresolved variables `%v` found in request") -) +// ErrEvalExpression returns an error when helper expressions cannot be evaluated +func ErrEvalExpression(tag string) func(error) error { + return func(err error) error { + return errkit.Append(errkit.New(fmt.Sprintf("%s: could not evaluate helper expressions", tag)), err) + } +} + +// ErrUnresolvedVars returns an error when unresolved variables are found in request +func ErrUnresolvedVars(vars string) error { + return errkit.New(fmt.Sprintf("unresolved variables `%v` found in request", vars)).Build() +} // generatedRequest is a single generated request wrapped for a template request type generatedRequest struct { @@ -193,7 +199,7 @@ func (r *requestGenerator) Make(ctx context.Context, input *contextargs.Context, for payloadName, payloadValue := range payloads { payloads[payloadName], err = expressions.Evaluate(types.ToString(payloadValue), allVars) if err != nil { - return nil, ErrEvalExpression.Wrap(err).WithTag("http") + return nil, ErrEvalExpression("http")(err) } } // finalVars contains allVars and any generator/fuzzing specific payloads @@ -210,7 +216,7 @@ func (r *requestGenerator) Make(ctx context.Context, input *contextargs.Context, // Evaluate (replace) variable with final values reqData, err = expressions.Evaluate(reqData, finalVars) if err != nil { - return nil, ErrEvalExpression.Wrap(err).WithTag("http") + return nil, ErrEvalExpression("http")(err) } if isRawRequest { @@ -219,7 +225,7 @@ func (r *requestGenerator) Make(ctx context.Context, input *contextargs.Context, reqURL, err := urlutil.ParseAbsoluteURL(reqData, true) if err != nil { - return nil, errorutil.NewWithTag("http", "failed to parse url %v while creating http request", reqData) + return nil, errkit.New(fmt.Sprintf("http: failed to parse url %v while creating http request", reqData)).Build() } // while merging parameters first preference is given to target params finalparams := parsed.Params @@ -252,7 +258,7 @@ func (r *requestGenerator) makeSelfContainedRequest(ctx context.Context, data st // evaluate request data, err := expressions.Evaluate(data, values) if err != nil { - return nil, ErrEvalExpression.Wrap(err).WithTag("self-contained") + return nil, ErrEvalExpression("self-contained")(err) } // If the request is a raw request, get the URL from the request // header and use it to make the request. @@ -275,7 +281,7 @@ func (r *requestGenerator) makeSelfContainedRequest(ctx context.Context, data st } if err := expressions.ContainsUnresolvedVariables(parts[1]); err != nil && !r.request.SkipVariablesCheck { - return nil, ErrUnresolvedVars.Msgf(parts[1]) + return nil, ErrUnresolvedVars(parts[1]) } parsed, err := urlutil.ParseURL(parts[1], true) @@ -289,19 +295,19 @@ func (r *requestGenerator) makeSelfContainedRequest(ctx context.Context, data st // Evaluate (replace) variable with final values data, err = expressions.Evaluate(data, values) if err != nil { - return nil, ErrEvalExpression.Wrap(err).WithTag("self-contained", "raw") + return nil, ErrEvalExpression("self-contained")(err) } return r.generateRawRequest(ctx, data, parsed, values, payloads) } if err := expressions.ContainsUnresolvedVariables(data); err != nil && !r.request.SkipVariablesCheck { // early exit: if there are any unresolved variables in `path` after evaluation // then return early since this will definitely fail - return nil, ErrUnresolvedVars.Msgf(data) + return nil, ErrUnresolvedVars(data) } urlx, err := urlutil.ParseURL(data, true) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("failed to parse %v in self contained request", data).WithTag("self-contained") + return nil, errkit.New(fmt.Sprintf("self-contained: failed to parse %v in self contained request: %s", data, err)).Build() } return r.generateHttpRequest(ctx, urlx, values, payloads) } @@ -312,7 +318,7 @@ func (r *requestGenerator) makeSelfContainedRequest(ctx context.Context, data st func (r *requestGenerator) generateHttpRequest(ctx context.Context, urlx *urlutil.URL, finalVars, generatorValues map[string]interface{}) (*generatedRequest, error) { method, err := expressions.Evaluate(r.request.Method.String(), finalVars) if err != nil { - return nil, ErrEvalExpression.Wrap(err).Msgf("failed to evaluate while generating http request") + return nil, ErrEvalExpression("http")(err) } // Build a request on the specified URL req, err := retryablehttp.NewRequestFromURLWithContext(ctx, method, urlx, nil) @@ -341,7 +347,7 @@ func (r *requestGenerator) generateRawRequest(ctx context.Context, rawRequest st rawRequestData, err = raw.Parse(rawRequest, baseURL, r.request.Unsafe, r.request.DisablePathAutomerge) } if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("failed to parse raw request") + return nil, errkit.Append(errkit.New("failed to parse raw request"), err) } // Unsafe option uses rawhttp library @@ -357,7 +363,7 @@ func (r *requestGenerator) generateRawRequest(ctx context.Context, rawRequest st } urlx, err := urlutil.ParseAbsoluteURL(rawRequestData.FullURL, true) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("failed to create request with url %v got %v", rawRequestData.FullURL, err).WithTag("raw") + return nil, errkit.New(fmt.Sprintf("raw: failed to create request with url %v got %v", rawRequestData.FullURL, err)).Build() } req, err := retryablehttp.NewRequestFromURLWithContext(ctx, rawRequestData.Method, urlx, rawRequestData.Data) if err != nil { @@ -414,7 +420,7 @@ func (r *requestGenerator) fillRequest(req *retryablehttp.Request, values map[st } value, err := expressions.Evaluate(value, values) if err != nil { - return nil, ErrEvalExpression.Wrap(err).Msgf("failed to evaluate while adding headers to request") + return nil, ErrEvalExpression("http")(err) } req.Header[header] = []string{value} if header == "Host" { @@ -435,7 +441,7 @@ func (r *requestGenerator) fillRequest(req *retryablehttp.Request, values map[st } body, err := expressions.Evaluate(body, values) if err != nil { - return nil, ErrEvalExpression.Wrap(err) + return nil, ErrEvalExpression("http")(err) } bodyReader, err := readerutil.NewReusableReadCloser([]byte(body)) if err != nil { diff --git a/pkg/protocols/http/raw/raw.go b/pkg/protocols/http/raw/raw.go index f6c427ad96..11454bb777 100644 --- a/pkg/protocols/http/raw/raw.go +++ b/pkg/protocols/http/raw/raw.go @@ -12,7 +12,7 @@ import ( "github.com/projectdiscovery/gologger" "github.com/projectdiscovery/nuclei/v3/pkg/authprovider/authx" "github.com/projectdiscovery/rawhttp/client" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" stringsutil "github.com/projectdiscovery/utils/strings" urlutil "github.com/projectdiscovery/utils/url" ) @@ -48,7 +48,7 @@ func Parse(request string, inputURL *urlutil.URL, unsafe, disablePathAutomerge b case strings.HasPrefix(rawrequest.Path, "http") && !unsafe: urlx, err := urlutil.ParseURL(rawrequest.Path, true) if err != nil { - return nil, errorutil.NewWithErr(err).WithTag("raw").Msgf("failed to parse url %v from template", rawrequest.Path) + return nil, errkit.New(fmt.Sprintf("raw: failed to parse url %v from template: %s", rawrequest.Path, err)).Build() } cloned := inputURL.Clone() cloned.Params.IncludeEquals = true @@ -57,7 +57,7 @@ func Parse(request string, inputURL *urlutil.URL, unsafe, disablePathAutomerge b } parseErr := cloned.MergePath(urlx.GetRelativePath(), true) if parseErr != nil { - return nil, errorutil.NewWithTag("raw", "could not automergepath for template path %v", urlx.GetRelativePath()).Wrap(parseErr) + return nil, errkit.Append(errkit.New(fmt.Sprintf("raw: could not automergepath for template path %v", urlx.GetRelativePath())), parseErr) } rawrequest.Path = cloned.GetRelativePath() // If unsafe changes must be made in raw request string itself @@ -94,7 +94,7 @@ func Parse(request string, inputURL *urlutil.URL, unsafe, disablePathAutomerge b } err = cloned.MergePath(rawrequest.Path, true) if err != nil { - return nil, errorutil.NewWithErr(err).WithTag("raw").Msgf("failed to automerge %v from unsafe template", rawrequest.Path) + return nil, errkit.New(fmt.Sprintf("raw: failed to automerge %v from unsafe template: %s", rawrequest.Path, err)).Build() } unsafeRelativePath = cloned.GetRelativePath() } @@ -116,7 +116,7 @@ func Parse(request string, inputURL *urlutil.URL, unsafe, disablePathAutomerge b } parseErr := cloned.MergePath(rawrequest.Path, true) if parseErr != nil { - return nil, errorutil.NewWithTag("raw", "could not automergepath for template path %v", rawrequest.Path).Wrap(parseErr) + return nil, errkit.Append(errkit.New(fmt.Sprintf("raw: could not automergepath for template path %v", rawrequest.Path)), parseErr) } rawrequest.Path = cloned.GetRelativePath() } @@ -145,18 +145,18 @@ func ParseRawRequest(request string, unsafe bool) (*Request, error) { if strings.HasPrefix(req.Path, "http") { urlx, err := urlutil.Parse(req.Path) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("failed to parse url %v", req.Path) + return nil, errkit.Append(errkit.New(fmt.Sprintf("failed to parse url %v", req.Path)), err) } req.Path = urlx.GetRelativePath() req.FullURL = urlx.String() } else { if req.Path == "" { - return nil, errorutil.NewWithTag("self-contained-raw", "path cannot be empty in self contained request") + return nil, errkit.New("self-contained-raw: path cannot be empty in self contained request").Build() } // given url is relative construct one using Host Header if _, ok := req.Headers["Host"]; !ok { - return nil, errorutil.NewWithTag("self-contained-raw", "host header is required for relative path") + return nil, errkit.New("self-contained-raw: host header is required for relative path").Build() } // Review: Current default scheme in self contained templates if relative path is provided is http req.FullURL = fmt.Sprintf("%s://%s%s", urlutil.HTTP, strings.TrimSpace(req.Headers["Host"]), req.Path) diff --git a/pkg/protocols/http/signer/aws-sign.go b/pkg/protocols/http/signer/aws-sign.go index 0da4902c38..bf6e15d3ee 100644 --- a/pkg/protocols/http/signer/aws-sign.go +++ b/pkg/protocols/http/signer/aws-sign.go @@ -14,7 +14,7 @@ import ( awsconfig "github.com/aws/aws-sdk-go-v2/config" "github.com/aws/aws-sdk-go-v2/credentials" "github.com/projectdiscovery/gologger" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) const defaultEmptyPayloadHash = "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" @@ -60,7 +60,7 @@ func (a *AWSSigner) SignHTTP(ctx context.Context, request *http.Request) error { // contentHash is sha256 hash of response body contentHash := a.getPayloadHash(request) if err := a.signer.SignHTTP(ctx, *a.creds, request, contentHash, a.options.Service, a.options.Region, time.Now()); err != nil { - return errorutil.NewWithErr(err).Msgf("failed to sign http request using aws v4 signer") + return errkit.Append(errkit.New("failed to sign http request using aws v4 signer"), err) } // add x-amz-content-sha256 header to request request.Header.Set("x-amz-content-sha256", contentHash) diff --git a/pkg/protocols/http/utils.go b/pkg/protocols/http/utils.go index 90b2e8446d..547b32dab0 100644 --- a/pkg/protocols/http/utils.go +++ b/pkg/protocols/http/utils.go @@ -1,12 +1,13 @@ package http import ( + "fmt" "io" "strings" "github.com/projectdiscovery/nuclei/v3/pkg/protocols/common/generators" "github.com/projectdiscovery/rawhttp" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) // dump creates a dump of the http request in form of a byte slice @@ -15,14 +16,14 @@ func dump(req *generatedRequest, reqURL string) ([]byte, error) { // Use a clone to avoid a race condition with the http transport bin, err := req.request.Clone(req.request.Context()).Dump() if err != nil { - return nil, errorutil.NewWithErr(err).WithTag("http").Msgf("could not dump request: %v", req.request.String()) + return nil, errkit.New(fmt.Sprintf("http: could not dump request: %v: %s", req.request.String(), err)).Build() } return bin, nil } rawHttpOptions := &rawhttp.Options{CustomHeaders: req.rawRequest.UnsafeHeaders, CustomRawBytes: req.rawRequest.UnsafeRawBytes} bin, err := rawhttp.DumpRequestRaw(req.rawRequest.Method, reqURL, req.rawRequest.Path, generators.ExpandMapValues(req.rawRequest.Headers), io.NopCloser(strings.NewReader(req.rawRequest.Data)), rawHttpOptions) if err != nil { - return nil, errorutil.NewWithErr(err).WithTag("http").Msgf("could not dump request: %v", reqURL) + return nil, errkit.New(fmt.Sprintf("http: could not dump request: %v: %s", reqURL, err)).Build() } return bin, nil } diff --git a/pkg/protocols/javascript/js.go b/pkg/protocols/javascript/js.go index fc5b30b989..573855ab5f 100644 --- a/pkg/protocols/javascript/js.go +++ b/pkg/protocols/javascript/js.go @@ -34,7 +34,6 @@ import ( templateTypes "github.com/projectdiscovery/nuclei/v3/pkg/templates/types" "github.com/projectdiscovery/nuclei/v3/pkg/types" "github.com/projectdiscovery/utils/errkit" - errorutil "github.com/projectdiscovery/utils/errors" iputil "github.com/projectdiscovery/utils/ip" mapsutil "github.com/projectdiscovery/utils/maps" syncutil "github.com/projectdiscovery/utils/sync" @@ -128,14 +127,14 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { } } if err := compiled.Compile(); err != nil { - return errorutil.NewWithTag(request.TemplateID, "could not compile operators got %v", err) + return errkit.New(fmt.Sprintf("%s: could not compile operators got %v", request.TemplateID, err)).Build() } request.CompiledOperators = compiled } // "Port" is a special variable and it should not contains any dsl expressions if strings.Contains(request.getPort(), "{{") { - return errorutil.NewWithTag(request.TemplateID, "'Port' variable cannot contain any dsl expressions") + return errkit.New(fmt.Sprintf("%s: 'Port' variable cannot contain any dsl expressions", request.TemplateID)).Build() } if request.Init != "" { @@ -219,11 +218,11 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { initCompiled, err := compiler.SourceAutoMode(request.Init, false) if err != nil { - return errorutil.NewWithTag(request.TemplateID, "could not compile init code: %s", err) + return errkit.New(fmt.Sprintf("%s: could not compile init code: %s", request.TemplateID, err)).Build() } result, err := request.options.JsCompiler.ExecuteWithOptions(initCompiled, args, opts) if err != nil { - return errorutil.NewWithTag(request.TemplateID, "could not execute pre-condition: %s", err) + return errkit.New(fmt.Sprintf("%s: could not execute pre-condition: %s", request.TemplateID, err)).Build() } if types.ToString(result["error"]) != "" { gologger.Warning().Msgf("[%s] Init failed with error %v\n", request.TemplateID, result["error"]) @@ -240,7 +239,7 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { if request.PreCondition != "" { preConditionCompiled, err := compiler.SourceAutoMode(request.PreCondition, false) if err != nil { - return errorutil.NewWithTag(request.TemplateID, "could not compile pre-condition: %s", err) + return errkit.New(fmt.Sprintf("%s: could not compile pre-condition: %s", request.TemplateID, err)).Build() } request.preConditionCompiled = preConditionCompiled } @@ -249,7 +248,7 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { if request.Code != "" { scriptCompiled, err := compiler.SourceAutoMode(request.Code, false) if err != nil { - return errorutil.NewWithTag(request.TemplateID, "could not compile javascript code: %s", err) + return errkit.New(fmt.Sprintf("%s: could not compile javascript code: %s", request.TemplateID, err)).Build() } request.scriptCompiled = scriptCompiled } diff --git a/pkg/protocols/network/network.go b/pkg/protocols/network/network.go index be3c85cd62..f1adc90c2f 100644 --- a/pkg/protocols/network/network.go +++ b/pkg/protocols/network/network.go @@ -1,6 +1,7 @@ package network import ( + "fmt" "strconv" "strings" @@ -12,7 +13,7 @@ import ( "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" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" ) @@ -196,10 +197,10 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { } portInt, err := strconv.Atoi(port) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not parse port %v from '%s'", port, request.Port) + return errkit.Append(errkit.New(fmt.Sprintf("could not parse port %v from '%s'", port, request.Port)), err) } if portInt < 1 || portInt > 65535 { - return errorutil.NewWithTag(request.TemplateID, "port %v is not in valid range", portInt) + return errkit.New(fmt.Sprintf("%s: port %v is not in valid range", request.TemplateID, portInt)).Build() } request.ports = append(request.ports, port) } diff --git a/pkg/protocols/network/request.go b/pkg/protocols/network/request.go index 24071763ec..63e1bfb590 100644 --- a/pkg/protocols/network/request.go +++ b/pkg/protocols/network/request.go @@ -31,7 +31,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/protocols/network/networkclientpool" protocolutils "github.com/projectdiscovery/nuclei/v3/pkg/protocols/utils" templateTypes "github.com/projectdiscovery/nuclei/v3/pkg/templates/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" mapsutil "github.com/projectdiscovery/utils/maps" "github.com/projectdiscovery/utils/reader" syncutil "github.com/projectdiscovery/utils/sync" @@ -362,7 +362,7 @@ func (request *Request) executeRequestWithPayloads(variables map[string]interfac if input.Read > 0 { buffer, err := ConnReadNWithTimeout(conn, int64(input.Read), request.options.Options.GetTimeouts().TcpReadTimeout) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not read response from connection") + return errkit.Append(errkit.New("could not read response from connection"), err) } responseBuilder.Write(buffer) diff --git a/pkg/protocols/ssl/ssl.go b/pkg/protocols/ssl/ssl.go index 72d6664228..aa4a02616d 100644 --- a/pkg/protocols/ssl/ssl.go +++ b/pkg/protocols/ssl/ssl.go @@ -33,7 +33,7 @@ import ( "github.com/projectdiscovery/tlsx/pkg/tlsx" "github.com/projectdiscovery/tlsx/pkg/tlsx/clients" "github.com/projectdiscovery/tlsx/pkg/tlsx/openssl" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" stringsutil "github.com/projectdiscovery/utils/strings" ) @@ -121,7 +121,7 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { CustomDialer: options.CustomFastdialer, }) if err != nil { - return errorutil.NewWithTag("ssl", "could not get network client").Wrap(err) + return errkit.Append(errkit.New("ssl: could not get network client"), err) } request.dialer = client switch { @@ -130,7 +130,7 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { request.ScanMode = "auto" case !stringsutil.EqualFoldAny(request.ScanMode, "auto", "openssl", "ztls", "ctls"): - return errorutil.NewWithTag(request.TemplateID, "template %v does not contain valid scan-mode", request.TemplateID) + return errkit.New(fmt.Sprintf("%s: template %v does not contain valid scan-mode", request.TemplateID, request.TemplateID)).Build() case request.ScanMode == "openssl" && !openssl.IsAvailable(): // if openssl is not installed instead of failing "auto" scanmode is used @@ -169,7 +169,7 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { tlsxService, err := tlsx.New(tlsxOptions) if err != nil { - return errorutil.NewWithTag(request.TemplateID, "could not create tlsx service") + return errkit.New(fmt.Sprintf("%s: could not create tlsx service", request.TemplateID)).Build() } request.tlsx = tlsxService @@ -178,7 +178,7 @@ func (request *Request) Compile(options *protocols.ExecutorOptions) error { compiled.ExcludeMatchers = options.ExcludeMatchers compiled.TemplateID = options.TemplateID if err := compiled.Compile(); err != nil { - return errorutil.NewWithTag(request.TemplateID, "could not compile operators got %v", err) + return errkit.New(fmt.Sprintf("%s: could not compile operators got %v", request.TemplateID, err)).Build() } request.CompiledOperators = compiled } @@ -236,7 +236,7 @@ func (request *Request) ExecuteWithResults(input *contextargs.Context, dynamicVa addressToDial := string(finalAddress) host, port, err := net.SplitHostPort(addressToDial) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not split input host port") + return errkit.Append(errkit.New("could not split input host port"), err) } var hostIp string @@ -250,7 +250,7 @@ func (request *Request) ExecuteWithResults(input *contextargs.Context, dynamicVa if err != nil { requestOptions.Output.Request(requestOptions.TemplateID, input.MetaInput.Input, request.Type().String(), err) requestOptions.Progress.IncrementFailedRequestsBy(1) - return errorutil.NewWithTag(request.TemplateID, "could not connect to server").Wrap(err) + return errkit.Append(errkit.New(fmt.Sprintf("%s: could not connect to server", request.TemplateID)), err) } requestOptions.Output.Request(requestOptions.TemplateID, hostPort, request.Type().String(), err) @@ -287,7 +287,7 @@ func (request *Request) ExecuteWithResults(input *contextargs.Context, dynamicVa // if response is not struct compatible, error out if !structs.IsStruct(response) { - return errorutil.NewWithTag("ssl", "response cannot be parsed into a struct: %v", response) + return errkit.New(fmt.Sprintf("ssl: response cannot be parsed into a struct: %v", response)).Build() } // Convert response to key value pairs and first cert chain item as well @@ -307,7 +307,7 @@ func (request *Request) ExecuteWithResults(input *contextargs.Context, dynamicVa // if certificate response is not struct compatible, error out if !structs.IsStruct(response.CertificateResponse) { - return errorutil.NewWithTag("ssl", "certificate response cannot be parsed into a struct: %v", response.CertificateResponse) + return errkit.New(fmt.Sprintf("ssl: certificate response cannot be parsed into a struct: %v", response.CertificateResponse)).Build() } responseParsed = structs.New(response.CertificateResponse) diff --git a/pkg/reporting/exporters/markdown/util/markdown_utils.go b/pkg/reporting/exporters/markdown/util/markdown_utils.go index b9a6744059..2ec5d8f9fb 100644 --- a/pkg/reporting/exporters/markdown/util/markdown_utils.go +++ b/pkg/reporting/exporters/markdown/util/markdown_utils.go @@ -5,7 +5,7 @@ import ( "fmt" "strings" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) func CreateLink(title string, url string) string { @@ -20,7 +20,7 @@ func CreateTable(headers []string, rows [][]string) (string, error) { builder := &bytes.Buffer{} headerSize := len(headers) if headers == nil || headerSize == 0 { - return "", errorutil.New("No headers provided") + return "", errkit.New("No headers provided").Build() } builder.WriteString(CreateTableHeader(headers...)) @@ -34,7 +34,7 @@ func CreateTable(headers []string, rows [][]string) (string, error) { copy(extendedRows, row) builder.WriteString(CreateTableRow(extendedRows...)) } else { - return "", errorutil.New("Too many columns for the given headers") + return "", errkit.New("Too many columns for the given headers").Build() } } diff --git a/pkg/reporting/reporting.go b/pkg/reporting/reporting.go index 100f35743f..30de6ad87d 100644 --- a/pkg/reporting/reporting.go +++ b/pkg/reporting/reporting.go @@ -31,7 +31,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/reporting/trackers/gitlab" "github.com/projectdiscovery/nuclei/v3/pkg/reporting/trackers/jira" "github.com/projectdiscovery/nuclei/v3/pkg/reporting/trackers/linear" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" ) @@ -84,7 +84,7 @@ func New(options *Options, db string, doNotDedupe bool) (Client, error) { options.GitHub.OmitRaw = options.OmitRaw tracker, err := github.New(options.GitHub) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrReportingClientCreation) + return nil, errkit.Append(ErrReportingClientCreation, err) } client.trackers = append(client.trackers, tracker) } @@ -93,7 +93,7 @@ func New(options *Options, db string, doNotDedupe bool) (Client, error) { options.GitLab.OmitRaw = options.OmitRaw tracker, err := gitlab.New(options.GitLab) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrReportingClientCreation) + return nil, errkit.Append(ErrReportingClientCreation, err) } client.trackers = append(client.trackers, tracker) } @@ -102,7 +102,7 @@ func New(options *Options, db string, doNotDedupe bool) (Client, error) { options.Gitea.OmitRaw = options.OmitRaw tracker, err := gitea.New(options.Gitea) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrReportingClientCreation) + return nil, errkit.Append(ErrReportingClientCreation, err) } client.trackers = append(client.trackers, tracker) } @@ -111,7 +111,7 @@ func New(options *Options, db string, doNotDedupe bool) (Client, error) { options.Jira.OmitRaw = options.OmitRaw tracker, err := jira.New(options.Jira) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrReportingClientCreation) + return nil, errkit.Append(ErrReportingClientCreation, err) } client.trackers = append(client.trackers, tracker) } @@ -120,35 +120,35 @@ func New(options *Options, db string, doNotDedupe bool) (Client, error) { options.Linear.OmitRaw = options.OmitRaw tracker, err := linear.New(options.Linear) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrReportingClientCreation) + return nil, errkit.Append(ErrReportingClientCreation, err) } client.trackers = append(client.trackers, tracker) } if options.MarkdownExporter != nil { exporter, err := markdown.New(options.MarkdownExporter) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrExportClientCreation) + return nil, errkit.Append(ErrExportClientCreation, err) } client.exporters = append(client.exporters, exporter) } if options.SarifExporter != nil { exporter, err := sarif.New(options.SarifExporter) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrExportClientCreation) + return nil, errkit.Append(ErrExportClientCreation, err) } client.exporters = append(client.exporters, exporter) } if options.JSONExporter != nil { exporter, err := json_exporter.New(options.JSONExporter) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrExportClientCreation) + return nil, errkit.Append(ErrExportClientCreation, err) } client.exporters = append(client.exporters, exporter) } if options.JSONLExporter != nil { exporter, err := jsonl.New(options.JSONLExporter) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrExportClientCreation) + return nil, errkit.Append(ErrExportClientCreation, err) } client.exporters = append(client.exporters, exporter) } @@ -157,7 +157,7 @@ func New(options *Options, db string, doNotDedupe bool) (Client, error) { options.ElasticsearchExporter.ExecutionId = options.ExecutionId exporter, err := es.New(options.ElasticsearchExporter) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrExportClientCreation) + return nil, errkit.Append(ErrExportClientCreation, err) } client.exporters = append(client.exporters, exporter) } @@ -166,14 +166,14 @@ func New(options *Options, db string, doNotDedupe bool) (Client, error) { options.SplunkExporter.ExecutionId = options.ExecutionId exporter, err := splunk.New(options.SplunkExporter) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrExportClientCreation) + return nil, errkit.Append(ErrExportClientCreation, err) } client.exporters = append(client.exporters, exporter) } if options.MongoDBExporter != nil { exporter, err := mongo.New(options.MongoDBExporter) if err != nil { - return nil, errorutil.NewWithErr(err).Wrap(ErrExportClientCreation) + return nil, errkit.Append(ErrExportClientCreation, err) } client.exporters = append(client.exporters, exporter) } @@ -227,7 +227,7 @@ func CreateConfigIfNotExists() error { } reportingFile, err := os.Create(reportingConfig) if err != nil { - return errorutil.NewWithErr(err).Msgf("could not create config file") + return errkit.Append(errkit.New("could not create config file"), err) } defer func() { _ = reportingFile.Close() diff --git a/pkg/templates/compile.go b/pkg/templates/compile.go index fdb612a96c..6554e8cde5 100644 --- a/pkg/templates/compile.go +++ b/pkg/templates/compile.go @@ -25,7 +25,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/tmplexec" "github.com/projectdiscovery/nuclei/v3/pkg/utils" "github.com/projectdiscovery/nuclei/v3/pkg/utils/json" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" stringsutil "github.com/projectdiscovery/utils/strings" ) @@ -480,7 +480,7 @@ func parseTemplate(data []byte, srcOptions *protocols.ExecutorOptions) (*Templat } } if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("failed to parse %s", template.Path) + return nil, errkit.Append(errkit.New(fmt.Sprintf("failed to parse %s", template.Path)), err) } if utils.IsBlank(template.Info.Name) { @@ -540,7 +540,7 @@ func parseTemplate(data []byte, srcOptions *protocols.ExecutorOptions) (*Templat // load `flow` and `source` in code protocol from file // if file is referenced instead of actual source code if err := template.ImportFileRefs(template.Options); err != nil { - return nil, errorutil.NewWithErr(err).Msgf("failed to load file refs for %s", template.ID) + return nil, errkit.Append(errkit.New(fmt.Sprintf("failed to load file refs for %s", template.ID)), err) } if err := template.compileProtocolRequests(template.Options); err != nil { diff --git a/pkg/templates/parser.go b/pkg/templates/parser.go index 3a2cabc2ae..bf24308e7c 100644 --- a/pkg/templates/parser.go +++ b/pkg/templates/parser.go @@ -82,7 +82,7 @@ func (p *Parser) LoadTemplate(templatePath string, t any, extraTags []string, ca t, templateParseError := p.ParseTemplate(templatePath, catalog) if templateParseError != nil { checkOpenFileError(templateParseError) - return false, ErrCouldNotLoadTemplate.Msgf(templatePath, templateParseError) + return false, ErrCouldNotLoadTemplate(templatePath, templateParseError.Error()) } template, ok := t.(*Template) if !ok { @@ -96,13 +96,13 @@ func (p *Parser) LoadTemplate(templatePath string, t any, extraTags []string, ca validationError := validateTemplateMandatoryFields(template) if validationError != nil { stats.Increment(SyntaxErrorStats) - return false, ErrCouldNotLoadTemplate.Msgf(templatePath, validationError) + return false, ErrCouldNotLoadTemplate(templatePath, validationError.Error()) } ret, err := isTemplateInfoMetadataMatch(tagFilter, template, extraTags) if err != nil { checkOpenFileError(err) - return ret, ErrCouldNotLoadTemplate.Msgf(templatePath, err) + return ret, ErrCouldNotLoadTemplate(templatePath, err.Error()) } // if template loaded then check the template for optional fields to add warnings if ret { @@ -110,7 +110,7 @@ func (p *Parser) LoadTemplate(templatePath string, t any, extraTags []string, ca if validationWarning != nil { stats.Increment(SyntaxWarningStats) checkOpenFileError(validationWarning) - return ret, ErrCouldNotLoadTemplate.Msgf(templatePath, validationWarning) + return ret, ErrCouldNotLoadTemplate(templatePath, validationWarning.Error()) } } return ret, nil diff --git a/pkg/templates/parser_error.go b/pkg/templates/parser_error.go index 98c9e25d70..eaf174cbc6 100644 --- a/pkg/templates/parser_error.go +++ b/pkg/templates/parser_error.go @@ -1,13 +1,28 @@ package templates import ( - errorutil "github.com/projectdiscovery/utils/errors" -) + "fmt" -var ( - ErrMandatoryFieldMissingFmt = errorutil.NewWithFmt("mandatory '%s' field is missing") - ErrInvalidField = errorutil.NewWithFmt("invalid field format for '%s' (allowed format is %s)") - ErrWarningFieldMissing = errorutil.NewWithFmt("field '%s' is missing") - ErrCouldNotLoadTemplate = errorutil.NewWithFmt("Could not load template %s: %s") - ErrLoadedWithWarnings = errorutil.NewWithFmt("Loaded template %s: with syntax warning : %s") + "github.com/projectdiscovery/utils/errkit" ) + +// Helper functions for template errors with formatting +func ErrMandatoryFieldMissingFmt(field string) error { + return errkit.New(fmt.Sprintf("mandatory '%s' field is missing", field)).Build() +} + +func ErrInvalidField(field, format string) error { + return errkit.New(fmt.Sprintf("invalid field format for '%s' (allowed format is %s)", field, format)).Build() +} + +func ErrWarningFieldMissing(field string) error { + return errkit.New(fmt.Sprintf("field '%s' is missing", field)).Build() +} + +func ErrCouldNotLoadTemplate(path, reason string) error { + return errkit.New(fmt.Sprintf("Could not load template %s: %s", path, reason)).Build() +} + +func ErrLoadedWithWarnings(path, warning string) error { + return errkit.New(fmt.Sprintf("Loaded template %s: with syntax warning : %s", path, warning)).Build() +} diff --git a/pkg/templates/parser_test.go b/pkg/templates/parser_test.go index 4ec35b973d..9b405d025c 100644 --- a/pkg/templates/parser_test.go +++ b/pkg/templates/parser_test.go @@ -41,7 +41,7 @@ func TestLoadTemplate(t *testing.T) { name: "emptyTemplate", template: &Template{}, isValid: false, - expectedErr: errors.New("mandatory 'name' field is missing\nmandatory 'author' field is missing\nmandatory 'id' field is missing"), + expectedErr: errors.New("cause=\"Could not load template emptyTemplate: cause=\\\"mandatory 'name' field is missing\\\"\\ncause=\\\"mandatory 'author' field is missing\\\"\\ncause=\\\"mandatory 'id' field is missing\\\"\""), }, { name: "emptyNameWithInvalidID", @@ -52,7 +52,7 @@ func TestLoadTemplate(t *testing.T) { SeverityHolder: severity.Holder{Severity: severity.Medium}, }, }, - expectedErr: errors.New("mandatory 'name' field is missing\ninvalid field format for 'id' (allowed format is ^([a-zA-Z0-9]+[-_])*[a-zA-Z0-9]+$)"), + expectedErr: errors.New("cause=\"Could not load template emptyNameWithInvalidID: cause=\\\"mandatory 'name' field is missing\\\"\\ncause=\\\"invalid field format for 'id' (allowed format is ^([a-zA-Z0-9]+[-_])*[a-zA-Z0-9]+$)\\\"\""), }, { name: "emptySeverity", diff --git a/pkg/templates/parser_validate.go b/pkg/templates/parser_validate.go index 3466835504..3911bbb225 100644 --- a/pkg/templates/parser_validate.go +++ b/pkg/templates/parser_validate.go @@ -15,17 +15,17 @@ func validateTemplateMandatoryFields(template *Template) error { var validateErrors []error if utils.IsBlank(info.Name) { - validateErrors = append(validateErrors, ErrMandatoryFieldMissingFmt.Msgf("name")) + validateErrors = append(validateErrors, ErrMandatoryFieldMissingFmt("name")) } if info.Authors.IsEmpty() { - validateErrors = append(validateErrors, ErrMandatoryFieldMissingFmt.Msgf("author")) + validateErrors = append(validateErrors, ErrMandatoryFieldMissingFmt("author")) } if template.ID == "" { - validateErrors = append(validateErrors, ErrMandatoryFieldMissingFmt.Msgf("id")) + validateErrors = append(validateErrors, ErrMandatoryFieldMissingFmt("id")) } else if !ReTemplateID.MatchString(template.ID) { - validateErrors = append(validateErrors, ErrInvalidField.Msgf("id", ReTemplateID.String())) + validateErrors = append(validateErrors, ErrInvalidField("id", ReTemplateID.String())) } if len(validateErrors) > 0 { @@ -53,7 +53,7 @@ func validateTemplateOptionalFields(template *Template) error { var warnings []error if template.Type() != types.WorkflowProtocol && utils.IsBlank(info.SeverityHolder.Severity.String()) { - warnings = append(warnings, ErrWarningFieldMissing.Msgf("severity")) + warnings = append(warnings, ErrWarningFieldMissing("severity")) } if len(warnings) > 0 { diff --git a/pkg/templates/signer/default.go b/pkg/templates/signer/default.go index 16900bd08a..174bda18ce 100644 --- a/pkg/templates/signer/default.go +++ b/pkg/templates/signer/default.go @@ -4,7 +4,7 @@ import ( "github.com/projectdiscovery/gologger" "github.com/projectdiscovery/nuclei/v3/pkg/catalog/config" "github.com/projectdiscovery/nuclei/v3/pkg/keys" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) // DefaultTemplateVerifiers contains the default template verifiers @@ -34,7 +34,7 @@ func init() { // AddSignerToDefault adds a signer to the default list of signers func AddSignerToDefault(s *TemplateSigner) error { if s == nil { - return errorutil.New("signer is nil") + return errkit.New("signer is nil").Build() } DefaultTemplateVerifiers = append(DefaultTemplateVerifiers, s) return nil diff --git a/pkg/templates/signer/tmpl_signer.go b/pkg/templates/signer/tmpl_signer.go index 35536ab6ec..bb3d26c485 100644 --- a/pkg/templates/signer/tmpl_signer.go +++ b/pkg/templates/signer/tmpl_signer.go @@ -16,7 +16,7 @@ import ( "github.com/projectdiscovery/gologger" "github.com/projectdiscovery/nuclei/v3/pkg/catalog/config" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) var ( @@ -82,13 +82,13 @@ func (t *TemplateSigner) Sign(data []byte, tmpl SignableTemplate) (string, error arr := strings.SplitN(string(existingSignature), ":", 3) if len(arr) == 2 { // signature has no fragment - return "", errorutil.NewWithTag("signer", "re-signing code templates are not allowed for security reasons.") + return "", errkit.New("signer: re-signing code templates are not allowed for security reasons.").Build() } if len(arr) == 3 { // signature has fragment verify if it is equal to current fragment fragment := t.GetUserFragment() if fragment != arr[2] { - return "", errorutil.NewWithTag("signer", "re-signing code templates are not allowed for security reasons.") + return "", errkit.New("signer: re-signing code templates are not allowed for security reasons.").Build() } } } diff --git a/pkg/templates/template_sign.go b/pkg/templates/template_sign.go index d9a1417ebf..e6647a335d 100644 --- a/pkg/templates/template_sign.go +++ b/pkg/templates/template_sign.go @@ -14,7 +14,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/templates/extensions" "github.com/projectdiscovery/nuclei/v3/pkg/templates/signer" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" ) // Due to file references in sensitive fields of template @@ -28,7 +28,7 @@ var ( _ = protocolstate.Init(defaultOpts) _ = protocolinit.Init(defaultOpts) }) - ErrNotATemplate = errorutil.NewWithTag("signer", "given filePath is not a template") + ErrNotATemplate = errkit.New("signer: given filePath is not a template").Build() ) // UseOptionsForSigner sets the options to use for signing templates @@ -68,7 +68,7 @@ func SignTemplate(templateSigner *signer.TemplateSigner, templatePath string) er template, bin, err := getTemplate(templatePath) if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to get template from disk") + return errkit.Append(errkit.New("failed to get template from disk"), err) } if len(template.Workflows) > 0 { // signing workflows is not supported at least yet @@ -100,7 +100,7 @@ func getTemplate(templatePath string) (*Template, []byte, error) { } template, err := ParseTemplateFromReader(bytes.NewReader(bin), nil, executerOpts) if err != nil { - return nil, bin, errorutil.NewWithErr(err).Msgf("failed to parse template") + return nil, bin, errkit.Append(errkit.New("failed to parse template"), err) } return template, bin, nil } diff --git a/pkg/templates/templates.go b/pkg/templates/templates.go index fbbfd44e93..418234751e 100644 --- a/pkg/templates/templates.go +++ b/pkg/templates/templates.go @@ -2,6 +2,7 @@ package templates import ( + "fmt" "io" "path/filepath" "strconv" @@ -24,7 +25,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/utils" "github.com/projectdiscovery/nuclei/v3/pkg/utils/json" "github.com/projectdiscovery/nuclei/v3/pkg/workflows" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" "go.uber.org/multierr" "gopkg.in/yaml.v2" @@ -325,14 +326,14 @@ func (template *Template) UnmarshalYAML(unmarshal func(interface{}) error) error *template = Template(*alias) if !ReTemplateID.MatchString(template.ID) { - return errorutil.New("template id must match expression %v", ReTemplateID).WithTag("invalid template") + return errkit.New(fmt.Sprintf("invalid template: template id must match expression %v", ReTemplateID)).Build() } info := template.Info if utils.IsBlank(info.Name) { - return errorutil.New("no template name field provided").WithTag("invalid template") + return errkit.New("invalid template: no template name field provided").Build() } if info.Authors.IsEmpty() { - return errorutil.New("no template author field provided").WithTag("invalid template") + return errkit.New("invalid template: no template author field provided").Build() } if len(template.RequestsHTTP) > 0 || len(template.RequestsNetwork) > 0 { @@ -340,10 +341,10 @@ func (template *Template) UnmarshalYAML(unmarshal func(interface{}) error) error } if len(alias.RequestsHTTP) > 0 && len(alias.RequestsWithHTTP) > 0 { - return errorutil.New("use http or requests, both are not supported").WithTag("invalid template") + return errkit.New("invalid template: use http or requests, both are not supported").Build() } if len(alias.RequestsNetwork) > 0 && len(alias.RequestsWithTCP) > 0 { - return errorutil.New("use tcp or network, both are not supported").WithTag("invalid template") + return errkit.New("invalid template: use tcp or network, both are not supported").Build() } if len(alias.RequestsWithHTTP) > 0 { template.RequestsHTTP = alias.RequestsWithHTTP @@ -361,7 +362,7 @@ func (template *Template) UnmarshalYAML(unmarshal func(interface{}) error) error var tempmap yaml.MapSlice err = unmarshal(&tempmap) if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to unmarshal multi protocol template %s", template.ID) + return errkit.Append(errkit.New(fmt.Sprintf("failed to unmarshal multi protocol template %s", template.ID)), err) } arr := []string{} for _, v := range tempmap { @@ -545,7 +546,7 @@ func (template *Template) UnmarshalJSON(data []byte) error { var tempMap map[string]interface{} err = json.Unmarshal(data, &tempMap) if err != nil { - return errorutil.NewWithErr(err).Msgf("failed to unmarshal multi protocol template %s", template.ID) + return errkit.Append(errkit.New(fmt.Sprintf("failed to unmarshal multi protocol template %s", template.ID)), err) } arr := []string{} for k := range tempMap { diff --git a/pkg/tmplexec/flow/flow_executor.go b/pkg/tmplexec/flow/flow_executor.go index 226a0c432a..860e96292c 100644 --- a/pkg/tmplexec/flow/flow_executor.go +++ b/pkg/tmplexec/flow/flow_executor.go @@ -16,16 +16,16 @@ import ( "github.com/kitabisa/go-ci" "github.com/projectdiscovery/nuclei/v3/pkg/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" mapsutil "github.com/projectdiscovery/utils/maps" "go.uber.org/multierr" ) -var ( - // ErrInvalidRequestID is a request id error - ErrInvalidRequestID = errorutil.NewWithFmt("[%s] invalid request id '%s' provided") -) +// ErrInvalidRequestID returns an error for invalid request IDs +func ErrInvalidRequestID(templateID, requestID string) error { + return errkit.New(fmt.Sprintf("[%s] invalid request id '%s' provided", templateID, requestID)).Build() +} // ProtoOptions are options that can be passed to flow protocol callback // ex: dns(protoOptions) <- protoOptions are optional and can be anything @@ -256,12 +256,12 @@ func (f *FlowExecutor) ExecuteWithResults(ctx *scan.ScanContext) error { f.reconcileProgress() if err != nil { ctx.LogError(err) - return errorutil.NewWithErr(err).Msgf("failed to execute flow\n%v\n", f.options.Flow) + return errkit.Append(errkit.New(fmt.Sprintf("failed to execute flow\n%v\n", f.options.Flow)), err) } runtimeErr := f.GetRuntimeErrors() if runtimeErr != nil { ctx.LogError(runtimeErr) - return errorutil.NewWithErr(runtimeErr).Msgf("got following errors while executing flow") + return errkit.Append(errkit.New("got following errors while executing flow"), runtimeErr) } return nil @@ -283,7 +283,7 @@ func (f *FlowExecutor) reconcileProgress() { func (f *FlowExecutor) GetRuntimeErrors() error { errs := []error{} for proto, err := range f.allErrs.GetAll() { - errs = append(errs, errorutil.NewWithErr(err).Msgf("failed to execute %v protocol", proto)) + errs = append(errs, errkit.Append(errkit.New(fmt.Sprintf("failed to execute %v protocol", proto)), err)) } return multierr.Combine(errs...) } diff --git a/pkg/tmplexec/flow/flow_internal.go b/pkg/tmplexec/flow/flow_internal.go index 9a8d807cce..249f324c6e 100644 --- a/pkg/tmplexec/flow/flow_internal.go +++ b/pkg/tmplexec/flow/flow_internal.go @@ -61,7 +61,7 @@ func (f *FlowExecutor) requestExecutor(runtime *goja.Runtime, reqMap mapsutil.Ma if !ok { f.ctx.LogError(fmt.Errorf("[%v] invalid request id '%s' provided", f.options.TemplateID, id)) // compile error - if err := f.allErrs.Set(opts.protoName+":"+id, ErrInvalidRequestID.Msgf(f.options.TemplateID, id)); err != nil { + if err := f.allErrs.Set(opts.protoName+":"+id, ErrInvalidRequestID(f.options.TemplateID, id)); err != nil { f.ctx.LogError(fmt.Errorf("failed to store flow runtime errors got %v", err)) } return matcherStatus.Load() diff --git a/pkg/types/types.go b/pkg/types/types.go index 656ff8447c..4d009db514 100644 --- a/pkg/types/types.go +++ b/pkg/types/types.go @@ -1,6 +1,7 @@ package types import ( + "fmt" "io" "os" "path/filepath" @@ -14,7 +15,7 @@ import ( "github.com/projectdiscovery/nuclei/v3/pkg/catalog/config" "github.com/projectdiscovery/nuclei/v3/pkg/model/types/severity" "github.com/projectdiscovery/nuclei/v3/pkg/templates/types" - errorutil "github.com/projectdiscovery/utils/errors" + "github.com/projectdiscovery/utils/errkit" fileutil "github.com/projectdiscovery/utils/file" folderutil "github.com/projectdiscovery/utils/folder" unitutils "github.com/projectdiscovery/utils/unit" @@ -830,7 +831,7 @@ func (options *Options) defaultLoadHelperFile(helperFile, templatePath string, c } f, err := os.Open(helperFile) if err != nil { - return nil, errorutil.NewWithErr(err).Msgf("could not open file %v", helperFile) + return nil, errkit.Append(errkit.New(fmt.Sprintf("could not open file %v", helperFile)), err) } return f, nil } @@ -855,12 +856,12 @@ func (o *Options) GetValidAbsPath(helperFilePath, templatePath string) (string, // CleanPath resolves using CWD and cleans the path helperFilePath, err = fileutil.CleanPath(helperFilePath) if err != nil { - return "", errorutil.NewWithErr(err).Msgf("could not clean helper file path %v", helperFilePath) + return "", errkit.Append(errkit.New(fmt.Sprintf("could not clean helper file path %v", helperFilePath)), err) } templatePath, err = fileutil.CleanPath(templatePath) if err != nil { - return "", errorutil.NewWithErr(err).Msgf("could not clean template path %v", templatePath) + return "", errkit.Append(errkit.New(fmt.Sprintf("could not clean template path %v", templatePath)), err) } // As per rule 2, if template and helper file exist in same directory or helper file existed in any child dir of template dir @@ -871,7 +872,7 @@ func (o *Options) GetValidAbsPath(helperFilePath, templatePath string) (string, } // all other cases are denied - return "", errorutil.New("access to helper file %v denied", helperFilePath) + return "", errkit.New(fmt.Sprintf("access to helper file %v denied", helperFilePath)).Build() } // SetExecutionID sets the execution ID for the options