+
-
+
+
+
+
+
+ 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 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) - - -## Features - -
- 
+| -```sh -▶ nuclei -l urls.txt -t cves/ -t files/ -o results.txt -``` +### Download Templates -### Running with subfinder. +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. -```sh -▶ subfinder -d hackerone.com -silent | httpx -silent | nuclei -t cves/ -o results.txt -``` +`▶ nuclei -update-templates` -### Running in Docker container +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. -You can use the [nuclei dockerhub image](https://hub.docker.com/r/projectdiscovery/nuclei). Simply run - + | +
+| -- `-c` flag => Limits the number of templates processed in parallel. -- `-bulk-size` flag => Limits the number of hosts processed in parallel for each template. -- `-rate-limit` flag => Global rate limiter that ensures defined number of requests/second across all templates. +**For bugbounty hunters:** -If you wanted go fast or control the scans, feel free to play with these flags and numbers, `rate-limit` always ensure to control the outgoing requests regardless the other flag you are using. +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. -### Template Exclusion +- 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. -[Nuclei-templates](https://github.com/projectdiscovery/nuclei-templates) includes multiple checks including many that are useful for attack surface mapping and not necessarily a security issue, in cases where you only looking to scan few specific templates or directory, here are few options / flags to filter or exclude them from running. +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) -#### Running templates with exclusion + | +
| + +**For pentesters:** -```sh -nuclei -l urls.txt -t nuclei-templates -exclude panels/ -exclude technologies -exclude files/wp-xmlrpc.yaml -``` +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. -Note:- both directory and specific templates case be excluded from scan as shared in the above example. +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. -#### Running templates based on severity +- 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. -You can run the templates based on the specific severity of the template, single and multiple severity can be used for scan. + | +
+
+
+