2020-12-21 09:01:32 +00:00
|
|
|
package types
|
2020-12-23 15:16:42 +00:00
|
|
|
|
2021-07-16 14:28:13 +00:00
|
|
|
import (
|
2023-07-12 19:21:06 +00:00
|
|
|
"io"
|
2023-08-31 12:33:01 +00:00
|
|
|
"os"
|
|
|
|
"path/filepath"
|
2023-07-28 15:50:57 +00:00
|
|
|
"strings"
|
2022-06-30 12:21:54 +00:00
|
|
|
"time"
|
|
|
|
|
2021-07-16 14:28:13 +00:00
|
|
|
"github.com/projectdiscovery/goflags"
|
2023-10-17 12:14:13 +00:00
|
|
|
"github.com/projectdiscovery/nuclei/v3/pkg/catalog"
|
|
|
|
"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"
|
2023-08-31 12:33:01 +00:00
|
|
|
errorutil "github.com/projectdiscovery/utils/errors"
|
2022-11-06 20:24:23 +00:00
|
|
|
fileutil "github.com/projectdiscovery/utils/file"
|
2023-10-13 07:47:27 +00:00
|
|
|
folderutil "github.com/projectdiscovery/utils/folder"
|
2021-07-16 14:28:13 +00:00
|
|
|
)
|
2021-01-27 06:16:41 +00:00
|
|
|
|
2023-07-12 19:21:06 +00:00
|
|
|
var (
|
|
|
|
// ErrNoMoreRequests is internal error to indicate that generator has no more requests to generate
|
|
|
|
ErrNoMoreRequests = io.EOF
|
|
|
|
)
|
|
|
|
|
2020-12-23 15:16:42 +00:00
|
|
|
// Options contains the configuration options for nuclei scanner.
|
|
|
|
type Options struct {
|
2021-02-26 07:43:11 +00:00
|
|
|
// Tags contains a list of tags to execute templates for. Multiple paths
|
|
|
|
// can be specified with -l flag and -tags can be used in combination with
|
|
|
|
// the -l flag.
|
2022-08-27 14:05:17 +00:00
|
|
|
Tags goflags.StringSlice
|
2021-03-13 19:45:33 +00:00
|
|
|
// ExcludeTags is the list of tags to exclude
|
2022-08-27 14:05:17 +00:00
|
|
|
ExcludeTags goflags.StringSlice
|
2021-03-05 06:38:31 +00:00
|
|
|
// Workflows specifies any workflows to run by nuclei
|
2022-08-27 14:05:17 +00:00
|
|
|
Workflows goflags.StringSlice
|
2021-10-14 21:30:37 +00:00
|
|
|
// WorkflowURLs specifies URLs to a list of workflows to use
|
2022-08-27 14:05:17 +00:00
|
|
|
WorkflowURLs goflags.StringSlice
|
2021-02-26 07:43:11 +00:00
|
|
|
// Templates specifies the template/templates to use
|
2022-08-27 14:05:17 +00:00
|
|
|
Templates goflags.StringSlice
|
2021-10-14 21:30:37 +00:00
|
|
|
// TemplateURLs specifies URLs to a list of templates to use
|
2022-08-27 14:05:17 +00:00
|
|
|
TemplateURLs goflags.StringSlice
|
2022-01-12 13:03:17 +00:00
|
|
|
// RemoteTemplates specifies list of allowed URLs to load remote templates from
|
|
|
|
RemoteTemplateDomainList goflags.StringSlice
|
2021-02-26 07:43:11 +00:00
|
|
|
// ExcludedTemplates specifies the template/templates to exclude
|
2022-08-27 14:05:17 +00:00
|
|
|
ExcludedTemplates goflags.StringSlice
|
2022-06-24 17:39:27 +00:00
|
|
|
// ExcludeMatchers is a list of matchers to exclude processing
|
2022-08-27 14:05:17 +00:00
|
|
|
ExcludeMatchers goflags.StringSlice
|
2021-02-26 07:43:11 +00:00
|
|
|
// CustomHeaders is the list of custom global headers to send with each request.
|
2022-08-27 14:05:17 +00:00
|
|
|
CustomHeaders goflags.StringSlice
|
2021-08-08 21:42:10 +00:00
|
|
|
// Vars is the list of custom global vars
|
2021-08-09 08:51:52 +00:00
|
|
|
Vars goflags.RuntimeMap
|
2021-07-16 14:28:13 +00:00
|
|
|
// Severities filters templates based on their severity and only run the matching ones.
|
|
|
|
Severities severity.Severities
|
2021-10-08 19:24:29 +00:00
|
|
|
// ExcludeSeverities specifies severities to exclude
|
|
|
|
ExcludeSeverities severity.Severities
|
2021-11-02 20:53:48 +00:00
|
|
|
// Authors filters templates based on their author and only run the matching ones.
|
2022-08-27 14:05:17 +00:00
|
|
|
Authors goflags.StringSlice
|
2021-10-25 17:54:42 +00:00
|
|
|
// Protocols contains the protocols to be allowed executed
|
2021-11-03 11:48:35 +00:00
|
|
|
Protocols types.ProtocolTypes
|
2021-10-25 17:54:42 +00:00
|
|
|
// ExcludeProtocols contains protocols to not be executed
|
2021-11-03 11:48:35 +00:00
|
|
|
ExcludeProtocols types.ProtocolTypes
|
2021-06-30 13:09:01 +00:00
|
|
|
// IncludeTags includes specified tags to be run even while being in denylist
|
2022-08-27 14:05:17 +00:00
|
|
|
IncludeTags goflags.StringSlice
|
2021-06-30 13:09:01 +00:00
|
|
|
// IncludeTemplates includes specified templates to be run even while being in denylist
|
2022-08-27 14:05:17 +00:00
|
|
|
IncludeTemplates goflags.StringSlice
|
2022-01-07 12:00:20 +00:00
|
|
|
// IncludeIds includes specified ids to be run even while being in denylist
|
2022-08-27 14:05:17 +00:00
|
|
|
IncludeIds goflags.StringSlice
|
2022-01-07 12:00:20 +00:00
|
|
|
// ExcludeIds contains templates ids to not be executed
|
2022-08-27 14:05:17 +00:00
|
|
|
ExcludeIds goflags.StringSlice
|
2021-06-30 13:09:01 +00:00
|
|
|
|
2021-02-26 07:43:11 +00:00
|
|
|
InternalResolversList []string // normalized from resolvers flag as well as file provided.
|
|
|
|
// ProjectPath allows nuclei to use a user defined project folder
|
|
|
|
ProjectPath string
|
2021-04-16 11:26:41 +00:00
|
|
|
// InteractshURL is the URL for the interactsh server.
|
2022-01-13 07:52:43 +00:00
|
|
|
InteractshURL string
|
2021-09-01 16:42:15 +00:00
|
|
|
// Interactsh Authorization header value for self-hosted servers
|
2021-09-06 13:40:32 +00:00
|
|
|
InteractshToken string
|
2021-08-04 05:47:09 +00:00
|
|
|
// Target URLs/Domains to scan using a template
|
|
|
|
Targets goflags.StringSlice
|
2023-11-23 18:35:20 +00:00
|
|
|
// ExcludeTargets URLs/Domains to exclude from scanning
|
|
|
|
ExcludeTargets goflags.StringSlice
|
2021-08-04 17:28:56 +00:00
|
|
|
// TargetsFilePath specifies the targets from a file to scan using templates.
|
2021-08-04 05:47:09 +00:00
|
|
|
TargetsFilePath string
|
2021-11-29 13:38:45 +00:00
|
|
|
// Resume the scan from the state stored in the resume config file
|
2022-02-24 09:02:41 +00:00
|
|
|
Resume string
|
2021-02-26 07:43:11 +00:00
|
|
|
// Output is the file to write found results to.
|
|
|
|
Output string
|
2022-03-09 11:31:12 +00:00
|
|
|
// ProxyInternal requests
|
|
|
|
ProxyInternal bool
|
2022-08-28 11:07:21 +00:00
|
|
|
// Show all supported DSL signatures
|
|
|
|
ListDslSignatures bool
|
2021-11-10 16:00:03 +00:00
|
|
|
// List of HTTP(s)/SOCKS5 proxy to use (comma separated or file input)
|
2022-08-27 14:05:17 +00:00
|
|
|
Proxy goflags.StringSlice
|
2021-02-26 07:43:11 +00:00
|
|
|
// TemplatesDirectory is the directory to use for storing templates
|
2023-04-19 16:28:48 +00:00
|
|
|
NewTemplatesDirectory string
|
2021-02-26 07:43:11 +00:00
|
|
|
// TraceLogFile specifies a file to write with the trace of all requests
|
|
|
|
TraceLogFile string
|
2021-10-30 09:39:38 +00:00
|
|
|
// ErrorLogFile specifies a file to write with the errors of all requests
|
|
|
|
ErrorLogFile string
|
2021-02-26 07:43:11 +00:00
|
|
|
// ReportingDB is the db for report storage as well as deduplication
|
|
|
|
ReportingDB string
|
|
|
|
// ReportingConfig is the config file for nuclei reporting module
|
|
|
|
ReportingConfig string
|
2021-11-25 16:54:16 +00:00
|
|
|
// MarkdownExportDirectory is the directory to export reports in Markdown format
|
2021-09-19 10:56:47 +00:00
|
|
|
MarkdownExportDirectory string
|
2023-07-21 20:54:06 +00:00
|
|
|
// MarkdownExportSortMode is the method to sort the markdown reports (options: severity, template, host, none)
|
|
|
|
MarkdownExportSortMode string
|
2021-06-05 21:26:36 +00:00
|
|
|
// SarifExport is the file to export sarif output format to
|
|
|
|
SarifExport string
|
2021-02-26 07:43:11 +00:00
|
|
|
// ResolversFile is a file containing resolvers for nuclei.
|
|
|
|
ResolversFile string
|
|
|
|
// StatsInterval is the number of seconds to display stats after
|
|
|
|
StatsInterval int
|
|
|
|
// MetricsPort is the port to show metrics on
|
|
|
|
MetricsPort int
|
2021-08-31 19:39:16 +00:00
|
|
|
// MaxHostError is the maximum number of errors allowed for a host
|
|
|
|
MaxHostError int
|
2023-03-14 08:29:42 +00:00
|
|
|
// TrackError contains additional error messages that count towards the maximum number of errors allowed for a host
|
|
|
|
TrackError goflags.StringSlice
|
2023-01-22 09:38:50 +00:00
|
|
|
// NoHostErrors disables host skipping after maximum number of errors
|
|
|
|
NoHostErrors bool
|
2021-02-26 07:43:11 +00:00
|
|
|
// BulkSize is the of targets analyzed in parallel for each template
|
|
|
|
BulkSize int
|
|
|
|
// TemplateThreads is the number of templates executed in parallel
|
|
|
|
TemplateThreads int
|
2021-10-27 10:23:04 +00:00
|
|
|
// HeadlessBulkSize is the of targets analyzed in parallel for each headless template
|
|
|
|
HeadlessBulkSize int
|
|
|
|
// HeadlessTemplateThreads is the number of headless templates executed in parallel
|
|
|
|
HeadlessTemplateThreads int
|
2021-02-26 07:43:11 +00:00
|
|
|
// Timeout is the seconds to wait for a response from the server.
|
|
|
|
Timeout int
|
|
|
|
// Retries is the number of times to retry the request
|
|
|
|
Retries int
|
|
|
|
// Rate-Limit is the maximum number of requests per specified target
|
|
|
|
RateLimit int
|
2021-07-31 10:16:21 +00:00
|
|
|
// Rate-Limit is the maximum number of requests per minute for specified target
|
|
|
|
RateLimitMinute int
|
2021-03-02 09:24:57 +00:00
|
|
|
// PageTimeout is the maximum time to wait for a page in seconds
|
2021-03-01 08:50:56 +00:00
|
|
|
PageTimeout int
|
2021-04-16 11:26:41 +00:00
|
|
|
// InteractionsCacheSize is the number of interaction-url->req to keep in cache at a time.
|
|
|
|
InteractionsCacheSize int
|
|
|
|
// InteractionsPollDuration is the number of seconds to wait before each interaction poll
|
|
|
|
InteractionsPollDuration int
|
|
|
|
// Eviction is the number of seconds after which to automatically discard
|
|
|
|
// interaction requests.
|
|
|
|
InteractionsEviction int
|
2021-11-25 16:54:16 +00:00
|
|
|
// InteractionsCoolDownPeriod is additional seconds to wait for interactions after closing
|
2021-04-16 11:26:41 +00:00
|
|
|
// of the poller.
|
2021-11-25 16:54:16 +00:00
|
|
|
InteractionsCoolDownPeriod int
|
2022-03-15 12:40:05 +00:00
|
|
|
// MaxRedirects is the maximum numbers of redirects to be followed.
|
|
|
|
MaxRedirects int
|
|
|
|
// FollowRedirects enables following redirects for http request module
|
|
|
|
FollowRedirects bool
|
2022-09-28 22:41:28 +00:00
|
|
|
// FollowRedirects enables following redirects for http request module only on the same host
|
|
|
|
FollowHostRedirects bool
|
2021-02-26 07:43:11 +00:00
|
|
|
// OfflineHTTP is a flag that specific offline processing of http response
|
|
|
|
// using same matchers/extractors from http protocol without the need
|
|
|
|
// to send a new request, reading responses from a file.
|
|
|
|
OfflineHTTP bool
|
2022-12-04 17:02:01 +00:00
|
|
|
// Force HTTP2 requests
|
|
|
|
ForceAttemptHTTP2 bool
|
2021-07-08 09:54:04 +00:00
|
|
|
// StatsJSON writes stats output in JSON format
|
|
|
|
StatsJSON bool
|
2021-02-26 07:43:11 +00:00
|
|
|
// Headless specifies whether to allow headless mode templates
|
|
|
|
Headless bool
|
|
|
|
// ShowBrowser specifies whether the show the browser in headless mode
|
|
|
|
ShowBrowser bool
|
2023-07-28 15:50:57 +00:00
|
|
|
// HeadlessOptionalArguments specifies optional arguments to pass to Chrome
|
|
|
|
HeadlessOptionalArguments goflags.StringSlice
|
2022-12-11 12:36:21 +00:00
|
|
|
// DisableClustering disables clustering of templates
|
|
|
|
DisableClustering bool
|
2021-09-26 05:56:35 +00:00
|
|
|
// UseInstalledChrome skips chrome install and use local instance
|
|
|
|
UseInstalledChrome bool
|
2021-09-30 16:07:59 +00:00
|
|
|
// SystemResolvers enables override of nuclei's DNS client opting to use system resolver stack.
|
2021-02-26 07:43:11 +00:00
|
|
|
SystemResolvers bool
|
2022-08-25 05:13:32 +00:00
|
|
|
// ShowActions displays a list of all headless actions
|
|
|
|
ShowActions bool
|
2023-09-02 09:04:05 +00:00
|
|
|
// Deprecated: Enabled by default through clistats . Metrics enables display of metrics via an http endpoint
|
2020-12-23 15:16:42 +00:00
|
|
|
Metrics bool
|
|
|
|
// Debug mode allows debugging request/responses for the engine
|
|
|
|
Debug bool
|
2021-01-12 11:48:08 +00:00
|
|
|
// DebugRequests mode allows debugging request for the engine
|
|
|
|
DebugRequests bool
|
|
|
|
// DebugResponse mode allows debugging response for the engine
|
|
|
|
DebugResponse bool
|
2022-10-20 11:53:00 +00:00
|
|
|
// DisableHTTPProbe disables http probing feature of input normalization
|
|
|
|
DisableHTTPProbe bool
|
2022-01-17 22:43:59 +00:00
|
|
|
// LeaveDefaultPorts skips normalization of default ports
|
|
|
|
LeaveDefaultPorts bool
|
2022-03-14 07:02:05 +00:00
|
|
|
// AutomaticScan enables automatic tech based template execution
|
|
|
|
AutomaticScan bool
|
2020-12-23 15:16:42 +00:00
|
|
|
// Silent suppresses any extra text and only writes found URLs on screen.
|
|
|
|
Silent bool
|
2021-07-07 13:33:14 +00:00
|
|
|
// Validate validates the templates passed to nuclei.
|
|
|
|
Validate bool
|
2022-07-13 11:30:11 +00:00
|
|
|
// NoStrictSyntax disables strict syntax check on nuclei templates (allows custom key-value pairs).
|
|
|
|
NoStrictSyntax bool
|
2020-12-23 15:16:42 +00:00
|
|
|
// Verbose flag indicates whether to show verbose output or not
|
2021-07-01 12:52:08 +00:00
|
|
|
Verbose bool
|
|
|
|
VerboseVerbose bool
|
2022-11-01 14:58:50 +00:00
|
|
|
// ShowVarDump displays variable dump
|
|
|
|
ShowVarDump bool
|
2020-12-23 15:16:42 +00:00
|
|
|
// No-Color disables the colored output.
|
|
|
|
NoColor bool
|
2023-04-19 16:28:48 +00:00
|
|
|
// UpdateTemplates updates the templates installed at startup (also used by cloud to update datasources)
|
2020-12-23 15:16:42 +00:00
|
|
|
UpdateTemplates bool
|
2023-03-31 09:59:29 +00:00
|
|
|
// JSON writes json line output to files
|
|
|
|
JSONL bool
|
2020-12-23 15:16:42 +00:00
|
|
|
// JSONRequests writes requests/responses for matches in JSON output
|
2023-07-04 20:37:56 +00:00
|
|
|
// Deprecated: use OmitRawRequests instead as of now JSONRequests(include raw requests) is always true
|
2020-12-23 15:16:42 +00:00
|
|
|
JSONRequests bool
|
2023-07-04 20:37:56 +00:00
|
|
|
// OmitRawRequests omits requests/responses for matches in JSON output
|
|
|
|
OmitRawRequests bool
|
2023-11-10 23:12:27 +00:00
|
|
|
// OmitTemplate omits encoded template from JSON output
|
|
|
|
OmitTemplate bool
|
2023-03-31 09:59:29 +00:00
|
|
|
// JSONExport is the file to export JSON output format to
|
|
|
|
JSONExport string
|
2023-04-08 12:14:41 +00:00
|
|
|
// JSONLExport is the file to export JSONL output format to
|
|
|
|
JSONLExport string
|
2020-12-23 15:16:42 +00:00
|
|
|
// EnableProgressBar enables progress bar
|
|
|
|
EnableProgressBar bool
|
2022-11-29 12:18:44 +00:00
|
|
|
// TemplateDisplay displays the template contents
|
|
|
|
TemplateDisplay bool
|
2020-12-23 15:16:42 +00:00
|
|
|
// TemplateList lists available templates
|
|
|
|
TemplateList bool
|
2022-05-30 09:11:24 +00:00
|
|
|
// HangMonitor enables nuclei hang monitoring
|
|
|
|
HangMonitor bool
|
2020-12-23 15:16:42 +00:00
|
|
|
// Stdin specifies whether stdin input was given to the process
|
|
|
|
Stdin bool
|
|
|
|
// StopAtFirstMatch stops processing template at first full match (this may break chained requests)
|
|
|
|
StopAtFirstMatch bool
|
2021-09-26 20:33:12 +00:00
|
|
|
// Stream the input without sorting
|
|
|
|
Stream bool
|
2020-12-23 15:16:42 +00:00
|
|
|
// NoMeta disables display of metadata for the matches
|
|
|
|
NoMeta bool
|
2022-12-04 16:46:55 +00:00
|
|
|
// Timestamp enables display of timestamp for the matcher
|
|
|
|
Timestamp bool
|
2020-12-23 15:16:42 +00:00
|
|
|
// Project is used to avoid sending same HTTP request multiple times
|
|
|
|
Project bool
|
2021-03-05 06:38:31 +00:00
|
|
|
// NewTemplates only runs newly added templates from the repository
|
|
|
|
NewTemplates bool
|
2022-07-13 11:19:06 +00:00
|
|
|
// NewTemplatesWithVersion runs new templates added in specific version
|
2022-08-27 14:05:17 +00:00
|
|
|
NewTemplatesWithVersion goflags.StringSlice
|
2021-04-18 11:57:45 +00:00
|
|
|
// NoInteractsh disables use of interactsh server for interaction polling
|
|
|
|
NoInteractsh bool
|
2021-08-08 22:22:09 +00:00
|
|
|
// EnvironmentVariables enables support for environment variables
|
|
|
|
EnvironmentVariables bool
|
2021-11-22 12:23:25 +00:00
|
|
|
// MatcherStatus displays optional status for the failed matches as well
|
|
|
|
MatcherStatus bool
|
2021-10-20 03:06:02 +00:00
|
|
|
// ClientCertFile client certificate file (PEM-encoded) used for authenticating against scanned hosts
|
|
|
|
ClientCertFile string
|
|
|
|
// ClientKeyFile client key file (PEM-encoded) used for authenticating against scanned hosts
|
|
|
|
ClientKeyFile string
|
|
|
|
// ClientCAFile client certificate authority file (PEM-encoded) used for authenticating against scanned hosts
|
|
|
|
ClientCAFile string
|
2023-07-07 00:09:14 +00:00
|
|
|
// Deprecated: Use ZTLS library
|
2022-01-25 19:48:21 +00:00
|
|
|
ZTLS bool
|
2023-07-14 14:09:32 +00:00
|
|
|
// AllowLocalFileAccess allows local file access from templates payloads
|
|
|
|
AllowLocalFileAccess bool
|
|
|
|
// RestrictLocalNetworkAccess restricts local network access from templates requests
|
|
|
|
RestrictLocalNetworkAccess bool
|
2022-06-02 11:36:50 +00:00
|
|
|
// ShowMatchLine enables display of match line number
|
|
|
|
ShowMatchLine bool
|
2022-03-03 14:14:29 +00:00
|
|
|
// EnablePprof enables exposing pprof runtime information with a webserver.
|
2022-04-27 16:19:44 +00:00
|
|
|
EnablePprof bool
|
2022-04-01 19:29:02 +00:00
|
|
|
// StoreResponse stores received response to output directory
|
2022-04-27 16:19:44 +00:00
|
|
|
StoreResponse bool
|
2022-04-01 19:29:02 +00:00
|
|
|
// StoreResponseDir stores received response to custom directory
|
|
|
|
StoreResponseDir string
|
2022-04-27 16:19:44 +00:00
|
|
|
// DisableRedirects disables following redirects for http request module
|
|
|
|
DisableRedirects bool
|
2022-05-11 10:30:39 +00:00
|
|
|
// SNI custom hostname
|
|
|
|
SNI string
|
2022-08-25 12:12:35 +00:00
|
|
|
// Interface to use for network scan
|
|
|
|
Interface string
|
|
|
|
// SourceIP sets custom source IP address for network requests
|
|
|
|
SourceIP string
|
2022-10-18 22:21:45 +00:00
|
|
|
// AttackType overrides template level attack-type configuration
|
|
|
|
AttackType string
|
2022-10-07 14:40:00 +00:00
|
|
|
// ResponseReadSize is the maximum size of response to read
|
|
|
|
ResponseReadSize int
|
|
|
|
// ResponseSaveSize is the maximum size of response to save
|
|
|
|
ResponseSaveSize int
|
2022-06-21 19:10:10 +00:00
|
|
|
// Health Check
|
|
|
|
HealthCheck bool
|
2022-06-30 12:21:54 +00:00
|
|
|
// Time to wait between each input read operation before closing the stream
|
|
|
|
InputReadTimeout time.Duration
|
|
|
|
// Disable stdin for input processing
|
|
|
|
DisableStdin bool
|
2022-08-25 11:22:08 +00:00
|
|
|
// IncludeConditions is the list of conditions templates should match
|
2022-08-27 14:05:17 +00:00
|
|
|
IncludeConditions goflags.StringSlice
|
2023-08-01 18:33:43 +00:00
|
|
|
// Enable uncover engine
|
2022-11-16 05:42:39 +00:00
|
|
|
Uncover bool
|
|
|
|
// Uncover search query
|
|
|
|
UncoverQuery goflags.StringSlice
|
|
|
|
// Uncover search engine
|
|
|
|
UncoverEngine goflags.StringSlice
|
|
|
|
// Uncover search field
|
|
|
|
UncoverField string
|
|
|
|
// Uncover search limit
|
|
|
|
UncoverLimit int
|
|
|
|
// Uncover search delay
|
2023-05-08 22:27:56 +00:00
|
|
|
UncoverRateLimit int
|
2022-11-09 13:18:56 +00:00
|
|
|
// ScanAllIPs associated to a dns record
|
|
|
|
ScanAllIPs bool
|
|
|
|
// IPVersion to scan (4,6)
|
|
|
|
IPVersion goflags.StringSlice
|
2023-07-17 19:23:10 +00:00
|
|
|
// PublicTemplateDisableDownload disables downloading templates from the nuclei-templates public repository
|
|
|
|
PublicTemplateDisableDownload bool
|
2023-04-19 21:42:52 +00:00
|
|
|
// GitHub token used to clone/pull from private repos for custom templates
|
2023-08-01 18:33:43 +00:00
|
|
|
GitHubToken string
|
|
|
|
// GitHubTemplateRepo is the list of custom public/private templates GitHub repos
|
|
|
|
GitHubTemplateRepo []string
|
2023-07-17 19:23:10 +00:00
|
|
|
// GitHubTemplateDisableDownload disables downloading templates from custom GitHub repositories
|
|
|
|
GitHubTemplateDisableDownload bool
|
2023-04-19 21:42:52 +00:00
|
|
|
// GitLabServerURL is the gitlab server to use for custom templates
|
|
|
|
GitLabServerURL string
|
|
|
|
// GitLabToken used to clone/pull from private repos for custom templates
|
|
|
|
GitLabToken string
|
|
|
|
// GitLabTemplateRepositoryIDs is the comma-separated list of custom gitlab repositories IDs
|
|
|
|
GitLabTemplateRepositoryIDs []int
|
2023-07-17 19:23:10 +00:00
|
|
|
// GitLabTemplateDisableDownload disables downloading templates from custom GitLab repositories
|
|
|
|
GitLabTemplateDisableDownload bool
|
2023-04-19 21:42:52 +00:00
|
|
|
// AWS access key for downloading templates from S3 bucket
|
2022-12-01 22:27:00 +00:00
|
|
|
AwsAccessKey string
|
2023-04-19 21:42:52 +00:00
|
|
|
// AWS secret key for downloading templates from S3 bucket
|
2022-12-01 22:27:00 +00:00
|
|
|
AwsSecretKey string
|
2023-04-19 21:42:52 +00:00
|
|
|
// AWS bucket name for downloading templates from S3 bucket
|
2022-12-01 22:27:00 +00:00
|
|
|
AwsBucketName string
|
2023-04-19 21:42:52 +00:00
|
|
|
// AWS Region name where AWS S3 bucket is located
|
2022-12-01 22:27:00 +00:00
|
|
|
AwsRegion string
|
2023-07-17 19:23:10 +00:00
|
|
|
// AwsTemplateDisableDownload disables downloading templates from AWS S3 buckets
|
|
|
|
AwsTemplateDisableDownload bool
|
2023-04-17 08:18:06 +00:00
|
|
|
// AzureContainerName for downloading templates from Azure Blob Storage. Example: templates
|
|
|
|
AzureContainerName string
|
|
|
|
// AzureTenantID for downloading templates from Azure Blob Storage. Example: 00000000-0000-0000-0000-000000000000
|
|
|
|
AzureTenantID string
|
|
|
|
// AzureClientID for downloading templates from Azure Blob Storage. Example: 00000000-0000-0000-0000-000000000000
|
|
|
|
AzureClientID string
|
|
|
|
// AzureClientSecret for downloading templates from Azure Blob Storage. Example: 00000000-0000-0000-0000-000000000000
|
|
|
|
AzureClientSecret string
|
|
|
|
// AzureServiceURL for downloading templates from Azure Blob Storage. Example: https://XXXXXXXXXX.blob.core.windows.net/
|
|
|
|
AzureServiceURL string
|
2023-07-17 19:23:10 +00:00
|
|
|
// AzureTemplateDisableDownload disables downloading templates from Azure Blob Storage
|
|
|
|
AzureTemplateDisableDownload bool
|
2022-12-27 20:48:00 +00:00
|
|
|
// Scan Strategy (auto,hosts-spray,templates-spray)
|
|
|
|
ScanStrategy string
|
2023-03-06 11:26:38 +00:00
|
|
|
// Fuzzing Type overrides template level fuzzing-type configuration
|
|
|
|
FuzzingType string
|
|
|
|
// Fuzzing Mode overrides template level fuzzing-mode configuration
|
|
|
|
FuzzingMode string
|
2023-06-21 11:47:18 +00:00
|
|
|
// TlsImpersonate enables TLS impersonation
|
|
|
|
TlsImpersonate bool
|
2023-06-09 15:24:24 +00:00
|
|
|
// CodeTemplateSignaturePublicKey is the custom public key used to verify the template signature (algorithm is automatically inferred from the length)
|
|
|
|
CodeTemplateSignaturePublicKey string
|
|
|
|
// CodeTemplateSignatureAlgorithm specifies the sign algorithm (rsa, ecdsa)
|
|
|
|
CodeTemplateSignatureAlgorithm string
|
|
|
|
// SignTemplates enables signing of templates
|
|
|
|
SignTemplates bool
|
2023-11-16 12:26:07 +00:00
|
|
|
// EnableCodeTemplates enables code templates
|
|
|
|
EnableCodeTemplates bool
|
2023-11-18 10:55:37 +00:00
|
|
|
// Disables cloud upload
|
2023-11-20 15:49:19 +00:00
|
|
|
EnableCloudUpload bool
|
2020-12-23 15:16:42 +00:00
|
|
|
}
|
2021-10-07 10:36:27 +00:00
|
|
|
|
2021-11-29 13:38:45 +00:00
|
|
|
// ShouldLoadResume resume file
|
|
|
|
func (options *Options) ShouldLoadResume() bool {
|
2022-02-24 09:02:41 +00:00
|
|
|
return options.Resume != "" && fileutil.FileExists(options.Resume)
|
2021-11-29 13:38:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
// ShouldSaveResume file
|
|
|
|
func (options *Options) ShouldSaveResume() bool {
|
|
|
|
return true
|
|
|
|
}
|
|
|
|
|
2022-09-28 22:41:28 +00:00
|
|
|
// ShouldFollowHTTPRedirects determines if http redirects should be followed
|
|
|
|
func (options *Options) ShouldFollowHTTPRedirects() bool {
|
|
|
|
return options.FollowRedirects || options.FollowHostRedirects
|
|
|
|
}
|
|
|
|
|
2023-06-26 12:15:12 +00:00
|
|
|
// HasClientCertificates determines if any client certificate was specified
|
|
|
|
func (options *Options) HasClientCertificates() bool {
|
|
|
|
return options.ClientCertFile != "" || options.ClientCAFile != "" || options.ClientKeyFile != ""
|
|
|
|
}
|
|
|
|
|
2021-10-28 21:49:43 +00:00
|
|
|
// DefaultOptions returns default options for nuclei
|
|
|
|
func DefaultOptions() *Options {
|
|
|
|
return &Options{
|
|
|
|
RateLimit: 150,
|
|
|
|
BulkSize: 25,
|
|
|
|
TemplateThreads: 25,
|
|
|
|
HeadlessBulkSize: 10,
|
|
|
|
HeadlessTemplateThreads: 10,
|
|
|
|
Timeout: 5,
|
|
|
|
Retries: 1,
|
|
|
|
MaxHostError: 30,
|
2023-08-14 15:09:02 +00:00
|
|
|
ResponseReadSize: 10 * 1024 * 1024,
|
|
|
|
ResponseSaveSize: 1024 * 1024,
|
2021-10-28 21:49:43 +00:00
|
|
|
}
|
|
|
|
}
|
2022-12-21 17:18:43 +00:00
|
|
|
|
2023-01-22 09:38:50 +00:00
|
|
|
func (options *Options) ShouldUseHostError() bool {
|
|
|
|
return options.MaxHostError > 0 && !options.NoHostErrors
|
2022-12-21 17:18:43 +00:00
|
|
|
}
|
2023-07-28 15:50:57 +00:00
|
|
|
|
|
|
|
func (options *Options) ParseHeadlessOptionalArguments() map[string]string {
|
|
|
|
optionalArguments := make(map[string]string)
|
|
|
|
for _, v := range options.HeadlessOptionalArguments {
|
|
|
|
if argParts := strings.SplitN(v, "=", 2); len(argParts) >= 2 {
|
|
|
|
key := strings.TrimSpace(argParts[0])
|
|
|
|
value := strings.TrimSpace(argParts[1])
|
|
|
|
if key != "" && value != "" {
|
|
|
|
optionalArguments[key] = value
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return optionalArguments
|
|
|
|
}
|
2023-08-31 12:33:01 +00:00
|
|
|
|
|
|
|
// LoadHelperFile loads a helper file needed for the template
|
|
|
|
// this respects the sandbox rules and only loads files from
|
|
|
|
// allowed directories
|
2023-10-13 07:47:27 +00:00
|
|
|
func (options *Options) LoadHelperFile(helperFile, templatePath string, catalog catalog.Catalog) (io.ReadCloser, error) {
|
2023-08-31 12:33:01 +00:00
|
|
|
if !options.AllowLocalFileAccess {
|
2023-10-13 07:47:27 +00:00
|
|
|
// if global file access is disabled try loading with restrictions
|
|
|
|
absPath, err := options.GetValidAbsPath(helperFile, templatePath)
|
2023-08-31 12:33:01 +00:00
|
|
|
if err != nil {
|
2023-10-13 07:47:27 +00:00
|
|
|
return nil, err
|
2023-08-31 12:33:01 +00:00
|
|
|
}
|
2023-10-13 07:47:27 +00:00
|
|
|
helperFile = absPath
|
|
|
|
}
|
|
|
|
f, err := os.Open(helperFile)
|
|
|
|
if err != nil {
|
|
|
|
return nil, errorutil.NewWithErr(err).Msgf("could not open file %v", helperFile)
|
|
|
|
}
|
|
|
|
return f, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// GetValidAbsPath returns absolute path of helper file if it is allowed to be loaded
|
|
|
|
// this respects the sandbox rules and only loads files from allowed directories
|
|
|
|
func (o *Options) GetValidAbsPath(helperFilePath, templatePath string) (string, error) {
|
|
|
|
// Conditions to allow helper file
|
|
|
|
// 1. If helper file is present in nuclei-templates directory
|
|
|
|
// 2. If helper file and template file are in same directory given that its not root directory
|
|
|
|
|
|
|
|
// resolve and clean helper file path
|
|
|
|
// ResolveNClean uses a custom base path instead of CWD
|
|
|
|
resolvedPath, err := fileutil.ResolveNClean(helperFilePath, config.DefaultConfig.GetTemplateDir())
|
|
|
|
if err == nil {
|
|
|
|
// As per rule 1, if helper file is present in nuclei-templates directory, allow it
|
|
|
|
if strings.HasPrefix(resolvedPath, config.DefaultConfig.GetTemplateDir()) {
|
|
|
|
return resolvedPath, nil
|
2023-08-31 12:33:01 +00:00
|
|
|
}
|
|
|
|
}
|
2023-10-13 07:47:27 +00:00
|
|
|
|
|
|
|
// 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)
|
2023-08-31 12:33:01 +00:00
|
|
|
}
|
2023-10-13 07:47:27 +00:00
|
|
|
|
|
|
|
templatePath, err = fileutil.CleanPath(templatePath)
|
2023-08-31 12:33:01 +00:00
|
|
|
if err != nil {
|
2023-10-13 07:47:27 +00:00
|
|
|
return "", errorutil.NewWithErr(err).Msgf("could not clean template path %v", templatePath)
|
2023-08-31 12:33:01 +00:00
|
|
|
}
|
2023-10-13 07:47:27 +00:00
|
|
|
|
|
|
|
// As per rule 2, if template and helper file exist in same directory or helper file existed in any child dir of template dir
|
|
|
|
// and both of them are present in user home directory, allow it
|
|
|
|
// Review: should we keep this rule ? add extra option to disable this ?
|
|
|
|
if isHomeDir(helperFilePath) && isHomeDir(templatePath) && strings.HasPrefix(filepath.Dir(helperFilePath), filepath.Dir(templatePath)) {
|
|
|
|
return helperFilePath, nil
|
|
|
|
}
|
|
|
|
|
|
|
|
// all other cases are denied
|
|
|
|
return "", errorutil.New("access to helper file %v denied", helperFilePath)
|
|
|
|
}
|
|
|
|
|
|
|
|
// isRootDir checks if given is root directory
|
|
|
|
func isHomeDir(path string) bool {
|
|
|
|
homeDir := folderutil.HomeDirOrDefault("")
|
|
|
|
return strings.HasPrefix(path, homeDir)
|
2023-08-31 12:33:01 +00:00
|
|
|
}
|