Update README.md

This commit is contained in:
bauthard 2020-09-01 00:47:45 +05:30
parent c261b31fdf
commit 9d59ee0a72

111
README.md
View File

@ -17,9 +17,11 @@ Nuclei is used to send requests across targets based on a template leading to ze
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. 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 ## Resources
<details>
<summary>Resources</summary>
- [Resources](#resources)
- [Features](#features) - [Features](#features)
- [Usage](#usage) - [Usage](#usage)
- [Installation Instructions](#installation-instructions) - [Installation Instructions](#installation-instructions)
@ -28,13 +30,15 @@ We have also [open-sourced a template repository](https://github.com/projectdisc
- [From Github](#from-github) - [From Github](#from-github)
- [Nuclei templates](#nuclei-templates) - [Nuclei templates](#nuclei-templates)
- [Running nuclei](#running-nuclei) - [Running nuclei](#running-nuclei)
- [1. Running nuclei with a single template.](#1-running-nuclei-with-a-single-template) - [Running with a single template.](#running-with-single-template)
- [2. Running nuclei with multiple templates.](#2-running-nuclei-with-multiple-templates) - [Running with multiple templates.](#running-with-multiple-templates)
- [3. Automating nuclei with subfinder and any other similar tool.](#3-automating-nuclei-with-subfinder-and-any-other-similar-tool) - [Running with subfinder](#running-with-subfinder)
- [4. Running nuclei in a Docker](#running-in-a-docker-container) - [Running in Docker](#running-in-docker-container)
- Thanks](#thanks) - [Thanks](#thanks)
# Features </details>
## Features
<h1 align="left"> <h1 align="left">
<img src="static/nuclei-run.png" alt="nuclei" width="700px"></a> <img src="static/nuclei-run.png" alt="nuclei" width="700px"></a>
@ -46,9 +50,9 @@ We have also [open-sourced a template repository](https://github.com/projectdisc
- Handles edge cases doing retries, backoffs etc for handling WAFs. - Handles edge cases doing retries, backoffs etc for handling WAFs.
- Smart matching functionality for zero false positive scanning. - Smart matching functionality for zero false positive scanning.
# Usage ## Usage
```bash ```sh
nuclei -h nuclei -h
``` ```
@ -79,115 +83,110 @@ This will display help for the tool. Here are all the switches it supports.
| -proxy-socks-url | Socks proxy URL | nuclei -proxy-socks-url socks5://127.0.0.1:8080 | | -proxy-socks-url | Socks proxy URL | nuclei -proxy-socks-url socks5://127.0.0.1:8080 |
| -H | Custom Header | nuclei -H "x-bug-bounty: hacker" | | -H | Custom Header | nuclei -H "x-bug-bounty: hacker" |
# Installation Instructions ## Installation Instructions
### From Binary ### From Binary
The installation is easy. You can download the pre-built binaries for your platform from the [Releases](https://github.com/projectdiscovery/nuclei/releases/) page. Extract them using tar, move it to your `$PATH`and you're ready to go. The installation is easy. You can download the pre-built binaries for your platform from the [Releases](https://github.com/projectdiscovery/nuclei/releases/) page. Extract them using tar, move it to your `$PATH`and you're ready to go.
```bash ```sh
https://github.com/projectdiscovery/nuclei/releases Download latest binary from https://github.com/projectdiscovery/nuclei/releases
tar -xzvf nuclei-linux-amd64.tar.gz
mv nuclei /usr/local/bin/ ▶ tar -xzvf nuclei-linux-amd64.tar.gz
nuclei -h ▶ mv nuclei /usr/local/bin/
▶ nuclei -h
``` ```
### From Source ### From Source
nuclei requires **go1.14+** to install successfully. Run the following command to get the repo - nuclei requires **go1.14+** to install successfully. Run the following command to get the repo -
```bash ```sh
> GO111MODULE=on go get -u -v github.com/projectdiscovery/nuclei/v2/cmd/nuclei ▶ GO111MODULE=auto go get -u -v github.com/projectdiscovery/nuclei/v2/cmd/nuclei
``` ```
In order to update the tool, you can use -u flag with `go get` command. In order to update the tool, you can use -u flag with `go get` command.
### From Github ### From Github
```bash ```sh
git clone https://github.com/projectdiscovery/nuclei.git ▶ git clone https://github.com/projectdiscovery/nuclei.git; cd nuclei/cmd/nuclei/; go build; mv nuclei /usr/local/bin/; nuclei -h
cd nuclei/cmd/nuclei/
go build .
mv nuclei /usr/local/bin/
nuclei -h
``` ```
# Nuclei templates ## Nuclei templates
You can download or update the nuclei templates using `update-templates` flag. You can download or update the nuclei templates using `update-templates` flag.
```bash ```sh
> nuclei -update-templates nuclei -update-templates
``` ```
or download it from [nuclei templates](https://github.com/projectdiscovery/nuclei-templates) Github project. or download it from [nuclei templates](https://github.com/projectdiscovery/nuclei-templates) Github project.
```bash ```sh
> git clone https://github.com/projectdiscovery/nuclei-templates.git git clone https://github.com/projectdiscovery/nuclei-templates.git
``` ```
**Please refer to [this guide](https://nuclei.projectdiscovery.io/templating-guide/) to writing your own custom templates.** **Please refer to nuclei [templating guide](https://nuclei.projectdiscovery.io/templating-guide/) to writing your own custom templates.**
# Running nuclei ## Running nuclei
### 1. Running nuclei with a single template. ### Running with single template.
This will run the tool against all the hosts in `urls.txt` and returns the matched results. This will run `git-core.yaml` template against all the hosts in `urls.txt` and returns the matched results.
```bash ```sh
> nuclei -l urls.txt -t files/git-core.yaml -o results.txt nuclei -l urls.txt -t files/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. You can also pass the list of urls 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. ```sh
▶ cat urls.txt | nuclei -t files/git-core.yaml -o results.txt
```bash
> cat urls.txt | nuclei -t files/git-core.yaml -o results.txt
``` ```
### 2. Running nuclei with multiple templates. ### Running 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. 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.
```bash ```sh
> nuclei -l urls.txt -t cves/ -o results.txt ▶ nuclei -l urls.txt -t cves/ -t files/ -o results.txt
``` ```
### 3. Automating nuclei with subfinder and any other similar tool. ### Running with subfinder.
```bash ```sh
> subfinder -d hackerone.com -silent | httpx -silent | nuclei -t cves/ -o results.txt subfinder -d hackerone.com -silent | httpx -silent | nuclei -t cves/ -o results.txt
``` ```
### Running in a Docker Container ### Running in Docker container
You can use the [nuclei dockerhub image](https://hub.docker.com/r/projectdiscovery/nuclei). Simply run - You can use the [nuclei dockerhub image](https://hub.docker.com/r/projectdiscovery/nuclei). Simply run -
```bash ```sh
> docker pull projectdiscovery/nuclei docker pull projectdiscovery/nuclei
``` ```
- After downloading or building the container, run the following: - After downloading or building the container, run the following:
```bash ```sh
> docker run -it projectdiscovery/nuclei 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: For example, this will run the tool against all the hosts in `urls.txt` and output the results to your host file system:
```bash ```sh
> cat urls.txt | docker run -v /path-to-nuclei-templates:/go/src/app/ -i projectdiscovery/nuclei -t ./files/git-config.yaml > results.txt cat urls.txt | docker run -v /path-to-nuclei-templates:/go/src/app/ -i projectdiscovery/nuclei -t ./files/git-config.yaml > results.txt
``` ```
Remember to change `/path-to-nuclei-templates` to the real path on your host file system. Remember to change `/path-to-nuclei-templates` to the real path on your host file system.
* * * * * *
# Thanks ## Thanks
nuclei is made with 🖤 by the [projectdiscovery](https://projectdiscovery.io) team. Community contributions have made the project what it is. See the **[Thanks.md](https://github.com/projectdiscovery/nuclei/blob/master/THANKS.md)** file for more details. nuclei is made with 🖤 by the [projectdiscovery](https://projectdiscovery.io) team. Community contributions have made the project what it is. See the **[Thanks.md](https://github.com/projectdiscovery/nuclei/blob/master/THANKS.md)** file for more details.
Do also check out these similar awesome projects that may fit in your workflow: Do also check out these similar awesome projects that may fit in your workflow:
- [Burp Suite](https://portswigger.net/burp), [FFuF](https://github.com/ffuf/ffuf), [Jaeles](https://github.com/jaeles-project/jaeles), [Qsfuzz](https://github.com/ameenmaali/qsfuzz), [Inception](https://github.com/proabiral/inception), [Snallygaster](https://github.com/hannob/snallygaster), [Gofingerprint](https://github.com/Static-Flow/gofingerprint), [Sn1per](https://github.com/1N3/Sn1per/tree/master/templates), [Google tsunami](https://github.com/google/tsunami-security-scanner), [ChopChop](https://github.com/michelin/ChopChop) [Burp Suite](https://portswigger.net/burp), [FFuF](https://github.com/ffuf/ffuf), [Jaeles](https://github.com/jaeles-project/jaeles), [Qsfuzz](https://github.com/ameenmaali/qsfuzz), [Inception](https://github.com/proabiral/inception), [Snallygaster](https://github.com/hannob/snallygaster), [Gofingerprint](https://github.com/Static-Flow/gofingerprint), [Sn1per](https://github.com/1N3/Sn1per/tree/master/templates), [Google tsunami](https://github.com/google/tsunami-security-scanner), [ChopChop](https://github.com/michelin/ChopChop)