Fast and customizable vulnerability scanner based on simple YAML based DSL.

Go to file

Rishiraj Sharma a13f4d0651 include logo		2020-04-04 23:45:28 +05:30
cmd/nuclei	Misc + cmd + final	2020-04-04 17:24:31 +05:30
internal/runner	Misc	2020-04-04 19:06:30 +05:30
pkg	Added retryablehttp	2020-04-04 17:12:29 +05:30
static	include logo	2020-04-04 23:45:28 +05:30
.gitignore	Misc + cmd + final	2020-04-04 17:24:31 +05:30
README.md	Update README.md	2020-04-04 23:30:09 +05:30
go.mod	Misc fixes	2020-04-04 18:10:26 +05:30
go.sum	Misc fixes	2020-04-04 18:10:26 +05:30

README.md

nuclei

Nuceli 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.

Resources

Resources
Features
Usage
Installation Instructions
- Prerequisite
- Direct Installation
  - From Binary
  - From Source
Running nuclei
License

Features

Simple and modular code base making it easy to contribute.
Fast And Fully configurable using a template based engine.
Handles edge cases doing retries, backoffs etc for handling WAFs.
Optimized for ease of use
Smart matching functionality for zero false positive scanning.

Usage

nuclei -h

This will display help for the tool. Here are all the switches it supports.

Flag	Description	Example
-c	Number of concurrent requests (default 10)	nuclei -c 100
-l	List of urls to run templates	nuclei -l urls.txt
-t	Templates input file/files to check across hosts	nuclei -t git-core.yaml
-t	Templates input file/files to check across hosts	nuclei -t "path/*.yaml"
-nC	Don't Use colors in output	nuclei -nC
-o	File to save output result (optional)	nuclei -o output.txt
-silent	Show only found results in output	nuclei -silent
-retries	Number of times to retry a failed request (default 1)	nuclei -retries 1
-timeout	Seconds to wait before timeout (default 5)	nuclei -timeout 5
-v	Show Verbose output	nuclei -v
-version	Show version of nuclei	nuclei -version

Installation Instructions

Direct Installation

From Binary

The installation is easy. You can download the pre-built binaries for your platform from the Releases page. Extract them using tar, move it to your $PATHand you're ready to go.

> tar -xzvf nuclei-linux-amd64.tar
> mv nuclei-linux-amd64 /usr/bin/nuclei
> nuclei -h

From Source

nuclei requires go1.13+ to install successfully. Run the following command to get the repo -

> GO111MODULE=on go get -u -v github.com/projectdiscovery/nuclei/cmd/nuclei

In order to update the tool, you can use -u flag with go get command.

Running nuclei

1. Running nuclei with a single template.

This will run the tool against all the hosts in urls.txt and returns the matched results.

> nuclei -l urls.txt -t git-core.yaml -o results.txt

You can also pass the list of hosts at standard input (STDIN). This allows for easy integration in automation pipelines.

This will run the tool against all the hosts in urls.txt and returns the matched results.

> cat urls.txt | nuclei -t git-core.yaml -o results.txt

2. Running nuclei with multiple templates.

This will run the tool against all the hosts in urls.txt with all the templates in the path-to-templates directory and returns the matched results.

> nuclei -l urls.txt -t "path-to-templates/*.yaml" -o results.txt

Nuclei supports glob expression ending in .yaml meaning multiple templates can be easily passed to be executed one after the other.

License

nuclei is made with 🖤 by the projectdiscovery team. Community contributions have made the project what it is. See the Thanks.md file for more details.