+
-
+
+
+
+
+
+ How • + Install • + For Security Engineers • + For Developers • + Wiki • + Credits • + License • + Join Discord
+--- -Nuclei is a fast tool for configurable targeted scanning based on templates offering massive extensibility and ease of use. +Nuclei is used to send requests across targets based on a template leading to zero false positives and providing fast scanning on large number of hosts. Nuclei offers scanning for a variety of protocols including TCP, DNS, HTTP, File, etc. With powerful and flexible templating, all kinds of security checks can be modelled with Nuclei. -Nuclei is used to send requests across targets based on a template leading to zero false positives and providing effective scanning for known paths. Main use cases for nuclei are during initial reconnaissance phase to quickly check for low hanging fruits or CVEs across targets that are known and easily detectable. It uses [retryablehttp-go library](https://github.com/projectdiscovery/retryablehttp-go) designed to handle various errors and retries in case of blocking by WAFs, this is also one of our core modules from custom-queries. - -We have also [open-sourced a template repository](https://github.com/projectdiscovery/nuclei-templates) to maintain various type of templates, we hope that you will contribute there too. Templates are provided in hopes that these will be useful and will allow everyone to build their own templates for the scanner. Checkout the templating guide at [**nuclei.projectdiscovery.io**](https://nuclei.projectdiscovery.io/templating-guide/) for a primer on nuclei templates. - -## Resources - -- [Features](#features) -- [Installation Instructions](#installation-instructions) -- [Nuclei templates](#nuclei-templates) -- [Usage](#usage) -- [Running nuclei](#running-nuclei) -- [Rate Limits](#rate-limits) -- [Template exclusion](#template-exclusion) -- [Acknowledgments](#acknowledgments) +We have a [dedicated repository](https://github.com/projectdiscovery/nuclei-templates) that houses various type of vulnerability templates contributed by **more than 100** security researchers and engineers. It is preloaded with ready to use templates using `-update-templates` flag. -## Features -
- 
+| + +### Download Templates + +You can download and update the nuclei templates using *update-templates* flag of nuclei that downloads all the available **nuclei-templates** from [Github project](https://github.com/projectdiscovery/nuclei-templates), a community curated list of templates that are ready to use. + +`▶ nuclei -update-templates` + +Nuclei is designed to used with custom templates according to the target and workflow, you can write your own checks for your specific workflow and needs, please refer to nuclei **[templating guide](https://nuclei.projectdiscovery.io/templating-guide/)** to write your own custom templates. + + | +
+| -This will display help for the tool. Here are all the switches it supports. +**For bugbounty hunters:** -| Flag | Description | Example | -| ---------------------- | --------------------------------------------------------- | ----------------------------------------------- | -| bulk-size | Max hosts analyzed in parallel per template ( default 25) | nuclei -bulk-size 25 | -| burp-collaborator-biid | Burp Collaborator BIID | nuclei -burp-collaborator-biid XXXX | -| c | Max templates processed in parallel (default 10) | nuclei -c 10 | -| l | List of urls to run templates | nuclei -l urls.txt | -| target | Target to scan using Templates | nuclei -target hxxps://example.com | -| t | Templates input file/files to check across hosts | nuclei -t git-core.yaml -t cves/ | -| no-color | Don't Use colors in output | nuclei -no-color | -| no-meta | Don't display metadata for the matches | nuclei -no-meta | -| json | Prints and write output in json format | nuclei -json | -| include-rr | Inlcude req/resp of matched output in JSON output | nuclei -json -include-rr | -| o | File to save output result (optional) | nuclei -o output.txt | -| project | Project flag to avoid sending same requests | nuclei -project | -| project-path | Use a user defined project folder | nuclei -project -project-path test | -| stats | Enable the progress bar (optional) | nuclei -stats | -| silent | Show only found results in output | nuclei -silent | -| retries | Number of times to retry a failed request | nuclei -retries 1 | -| timeout | Seconds to wait before timeout (default 5) | nuclei -timeout 5 | -| trace-log | File to write sent requests trace log | nuclei -trace-log logs | -| rate-limit | Maximum requests/second (default 150) | nuclei -rate-limit 150 | -| severity | Run templates based on severity | nuclei -severity critical,high | -| stop-at-first-match | Stop processing http requests at first match | nuclei -stop-at-first-match | -| exclude | Template input dir/file/files to exclude | nuclei -exclude panels -exclude tokens | -| debug | Allow debugging of request/responses. | nuclei -debug | -| update-templates | Download and updates nuclei templates | nuclei -update-templates | -| update-directory | Directory for storing nuclei-templates(optional) | nuclei -update-directory templates | -| tl | List available templates | nuclei -tl | -| templates-version | Shows the installed nuclei-templates version | nuclei -templates-version | -| v | Shows verbose output of all sent requests | nuclei -v | -| version | Show version of nuclei | nuclei -version | -| proxy-url | Proxy URL | nuclei -proxy-url hxxp://127.0.0.1:8080 | -| proxy-socks-url | Socks proxyURL | nuclei -proxy-socks-url socks5://127.0.0.1:8080 | -| random-agent | Use random User-Agents | nuclei -random-agent | -| H | Custom Header | nuclei -H "x-bug-bounty: hacker" | +Nuclei allows you to customise your testing approach with your own suite of checks and easily run across your bug bounty programs. Moroever, Nuclei can be easily integrated into any continuous scanning workflow. -## Running Nuclei +- Designed to be easily integrated into other tool workflow. +- Can process thousands of hosts in few minutes. +- Easily automate your custom testing approach with our simple YAML DSL. -### Running with single template. +Please check our other open-source projects that might fit into your bug bounty workflow: [github.com/projectdiscovery](http://github.com/projectdiscovery), we also host daily refresh of the DNS data at: [chaos.projectdiscovery.io](http://chaos.projectdiscovery.io) -This will run `git-core.yaml` template against all the hosts in `urls.txt` and returns the matched results. + | +
| + +**For pentesters:** -You can also pass the list of urls at standard input (STDIN). This allows for easy integration in automation pipelines. +Nuclei immensely improve how you approach security assessment by augmenting the manual repetitve processes. Consultancies are already converting their manual assessment steps with Nuclei, it allows them to run set of their custom assessment approach across thousands of hosts in an automated manner. -```sh -▶ cat urls.txt | nuclei -t files/git-core.yaml -o results.txt -``` +Pen-testers get the full power of our public templates and customization capabilities to speed-up their assessment process, and specifically with the regression cycle where you can easily verify the fix. -💡 Nuclei accepts list of URLs as input, for example here is how `urls.txt` looks like:- +- Easily create your compliance, standards suite (e.g. OWASP Top 10) checklist. +- With capabilities like [fuzz](https://nuclei.projectdiscovery.io/templating-guide/#advance-fuzzing) and [workflows](https://nuclei.projectdiscovery.io/templating-guide/#workflows), complex manual steps and repetitive assessment can be easily automated with Nuclei. +- Easy to re-test vulnerability-fix by just re-running the template. -``` -https://test.some-site.com -http://vuls-testing.com -https://test.com -``` -### Running with multiple templates. - -This will run the tool against all the urls in `urls.txt` with all the templates in the `cves` and `files` directory and returns the matched results. - -```sh -▶ nuclei -l urls.txt -t cves/ -t files/ -o results.txt -``` - -### Running with subfinder. - -```sh -▶ subfinder -d hackerone.com -silent | httpx -silent | nuclei -t cves/ -o results.txt -``` - -### Running in Docker container - -You can use the [nuclei dockerhub image](https://hub.docker.com/r/projectdiscovery/nuclei). Simply run - - -```sh -▶ docker pull projectdiscovery/nuclei -``` - -After downloading or building the container, run the following: - -```sh -▶ docker run -it projectdiscovery/nuclei -``` - -For example, this will run the tool against all the hosts in `urls.txt` and output the results to your host file system: - -```sh -▶ cat urls.txt | docker run -v /path/to/nuclei-templates:/app/nuclei-templates -v /path/to/nuclei/config:/app/.nuclei-config.json -i projectdiscovery/nuclei -t /app/nuclei-templates/files/git-config.yaml > results.txt -``` - -Remember to change `/path-to-nuclei-templates` to the real path on your host file system. - -### Rate Limits - -Nuclei have multiple rate limit controls for multiple factors including a number of templates to execute in parallel, a number of hosts to be scanned in parallel for each template, and the global number of request / per second you wanted to make/limit using nuclei, as an example here is how all this can be controlled using flags. + | +
+
+
+