From 787f2990ec034f3b77bdddbc8c92c687c663425c Mon Sep 17 00:00:00 2001 From: HAHWUL Date: Fri, 8 Dec 2023 00:51:12 +0900 Subject: [PATCH] Update README --- README.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index e8923924..5b8a9b8b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
- -

♠️ Noir is an attack surface detector that identifies endpoints by static analysis.

+ +

Noir is an attack surface detector that identifies endpoints by static analysis.

## Key Features @@ -83,7 +83,7 @@ cp ./bin/noir /usr/bin/ ### Docker (GHCR) ```bash -docker pull ghcr.io/noir-cr/noir:main +docker pull ghcr.io/noir-cr/noir:latest ``` ## Usage @@ -105,16 +105,19 @@ Usage: noir Deliver: --send-req Send the results to the web request --send-proxy http://proxy.. Send the results to the web request via http proxy - --send-es https://es.. Send the results to elasticsearch + --send-es http://es.. Send the results to elasticsearch --with-headers X-Header:Value Add Custom Headers to be Used in Deliver --use-matchers string Delivers URLs that match a specific condition --use-filters string Excludes URLs that match a specific condition Technologies: - -t TECHS, --techs rails,php Set technologies to use + -t TECHS, --techs rails,php Specify the technologies to use --exclude-techs rails,php Specify the technologies to be excluded --list-techs Show all technologies + Config: + --concurrency 100 Set concurrency + Others: -d, --debug Show debug messages -v, --version Show version @@ -126,7 +129,7 @@ Example noir -b . -u https://testapp.internal.domains ``` -![](https://github.com/hahwul/noir/assets/13212227/68fb1b3a-dc57-4480-b8cf-e42f452e6706) +![](https://github.com/noir-cr/noir/assets/13212227/40d09acf-e250-4ea9-a84b-d9251a2d5147) JSON Result ``` @@ -145,13 +148,13 @@ noir -b . -u https://testapp.internal.domains -f json "value": "" }, { - "name": "title", - "param_type": "json", - "value": "" + "name": "X-API-KEY", + "value":"", + "param_type":"header" }, { - "name": "id", - "param_type": "json", + "name": "auth", + "param_type": "cookie", "value": "" } ],