Skip to content

Commit cd6378b

Browse files
hahwulhahwul
authoredSep 27, 2024
Merge pull request #414 from owasp-noir/update-document
Refactor documentation: Update URLs and remove redundant information
·
v0.20.0v0.18.0
2 parents 12be898 + 9cb519d commit cd6378b

File tree

7 files changed

+24
-108
lines changed

7 files changed

+24
-108
lines changed
 

‎README.md

+7-106
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
</p>
2020

2121
<p align="center">
22-
<a href="#installation">Installation</a> •
2322
<a href="https://owasp-noir.github.io/noir/">Documentation</a> •
24-
<a href="#available-support-scope">Available Support Scope</a> •
23+
<a href="https://owasp-noir.github.io/noir/get_started/installation/">Installation</a> •
24+
<a href="https://owasp-noir.github.io/noir/supported">Available Support Scope</a> •
2525
<a href="#usage">Usage</a> •
2626
<a href="#contributing">Contributing</a>
2727
</p>
@@ -35,108 +35,6 @@
3535
- Friendly Offensive Security Tools integration, allowing usage with tools such as ZAP and Caido, Burpsuite.
3636
- Generate elegant and clear output results.
3737

38-
## Available Support Scope
39-
40-
<details>
41-
<summary>Endpoint's Entities</summary>
42-
43-
- Path
44-
- Method
45-
- Param
46-
- Header
47-
- Cookie
48-
- Protocol (e.g ws)
49-
- Details (e.g The origin of the endpoint)
50-
51-
</details>
52-
53-
<details>
54-
<summary>Languages and Frameworks</summary>
55-
56-
| Language | Framework | URL | Method | Param | Header | Cookie | WS |
57-
|----------|-------------|-----|--------|-------|--------|--------|----|
58-
| Crystal | Kemal | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
59-
| Crystal | Lucky | ✅ | ✅ | ✅ | ✅ | ✅ | X |
60-
| Go | Beego | ✅ | ✅ | X | X | X | X |
61-
| Go | Echo | ✅ | ✅ | ✅ | ✅ | ✅ | X |
62-
| Go | Gin | ✅ | ✅ | ✅ | ✅ | ✅ | X |
63-
| Go | Fiber | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
64-
| Python | Django | ✅ | ✅ | ✅ | ✅ | ✅ | X |
65-
| Python | Flask | ✅ | ✅ | ✅ | ✅ | ✅ | X |
66-
| Python | FastAPI | ✅ | ✅ | ✅ | ✅ | ✅ | ✅ |
67-
| Ruby | Rails | ✅ | ✅ | ✅ | ✅ | ✅ | X |
68-
| Ruby | Sinatra | ✅ | ✅ | ✅ | ✅ | ✅ | X |
69-
| Ruby | Hanami | ✅ | ✅ | X | X | X | X |
70-
| Php | | ✅ | ✅ | ✅ | ✅ | X | X |
71-
| Java | Jsp | ✅ | ✅ | ✅ | X | X | X |
72-
| Java | Armeria | ✅ | ✅ | X | X | X | X |
73-
| Java | Spring | ✅ | ✅ | ✅ | ✅ | X | X |
74-
| Kotlin | Spring | ✅ | ✅ | ✅ | ✅ | ✅ | X |
75-
| JS | Express | ✅ | ✅ | ✅ | ✅ | ✅ | X |
76-
| JS | Restify | ✅ | ✅ | ✅ | ✅ | ✅ | X |
77-
| Rust | Axum | ✅ | ✅ | X | X | X | X |
78-
| Rust | Rocket | ✅ | ✅ | X | X | X | X |
79-
| Elixir | Phoenix | ✅ | ✅ | X | X | X | ✅ |
80-
| C# | ASP.NET MVC | ✅ | X | X | X | X | X |
81-
| JS | Next | X | X | X | X | X | X |
82-
83-
</details>
84-
85-
<details>
86-
<summary>Specification</summary>
87-
88-
| Specification | Format | URL | Method | Param | Header | WS |
89-
|------------------------|---------|-----|--------|-------|--------|----|
90-
| OAS 2.0 (Swagger 2.0) | JSON | ✅ | ✅ | ✅ | ✅ | X |
91-
| OAS 2.0 (Swagger 2.0) | YAML | ✅ | ✅ | ✅ | ✅ | X |
92-
| OAS 3.0 | JSON | ✅ | ✅ | ✅ | ✅ | X |
93-
| OAS 3.0 | YAML | ✅ | ✅ | ✅ | ✅ | X |
94-
| RAML | YAML | ✅ | ✅ | ✅ | ✅ | X |
95-
| HAR | JSON | ✅ | ✅ | ✅ | ✅ | X |
96-
97-
</details>
98-
99-
## Installation
100-
### Homebrew
101-
102-
```bash
103-
brew install noir
104-
105-
# https://formulae.brew.sh/formula/noir
106-
```
107-
108-
### Snapcraft
109-
110-
```bash
111-
sudo snap install noir
112-
113-
# https://snapcraft.io/noir
114-
```
115-
116-
### From Sources
117-
```bash
118-
# Install Crystal-lang
119-
# https://crystal-lang.org/install/
120-
121-
# Clone this repo
122-
git clone https://github.com/owasp-noir/noir
123-
cd noir
124-
125-
# Install Dependencies
126-
shards install
127-
128-
# Build
129-
shards build --release --no-debug
130-
131-
# Copy binary
132-
cp ./bin/noir /usr/bin/
133-
```
134-
135-
### Docker (GHCR)
136-
```bash
137-
docker pull ghcr.io/owasp-noir/noir:main
138-
```
139-
14038
## Usage
14139

14240
```bash
@@ -156,7 +54,8 @@ noir -b . -u https://testapp.internal.domains -f json -T
15654
```
15755

15856
```json
159-
{
57+
[
58+
{
16059
"url": "https://testapp.internal.domains/query",
16160
"method": "POST",
16261
"params": [
@@ -182,14 +81,16 @@ noir -b . -u https://testapp.internal.domains -f json -T
18281
"details": {
18382
"code_paths": [
18483
{
185-
"path": "spec/functional_test/fixtures/crystal_kemal/src/testapp.cr",
84+
"path": "testapp/src/testapp.cr",
18685
"line": 8
18786
}
18887
]
18988
},
19089
"protocol": "http",
19190
"tags": []
19291
}
92+
...
93+
]
19394
```
19495

19596
For more details, please visit our [documentation](https://owasp-noir.github.io/noir/) page.

‎docs/_get_started/basic.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ noir -b <BASE_PATH>
2424

2525
## Outputs
2626

27-
The output will display endpoints (such as paths, methods, parameters, headers, etc.), and you can specify the output format using flags like `-f`.
27+
The output will display endpoints (such as paths, methods, parameters, headers, etc.), and you can specify the output format using flags `-f` or `--format`. If you're curious about the supported formats, please refer to [this](/get_started/output/) document.
2828

2929
![](../../images/get_started/basic.png)
3030

‎docs/_get_started/output.md

+15
Original file line numberDiff line numberDiff line change
@@ -17,3 +17,18 @@ noir -b <BASE_PATH> -f <FORMAT>
1717

1818
```
1919

20+
| Format | Description |
21+
|-----------------|-----------------------------------------------------------------------------|
22+
| plain | Outputs the results in plain text format. |
23+
| yaml | Outputs the results in YAML format. |
24+
| json | Outputs the results in JSON format. |
25+
| jsonl | Outputs the results in JSON Lines format, where each line is a JSON object. |
26+
| markdown-table | Outputs the results in a Markdown table format. |
27+
| curl | Outputs the results as curl commands. |
28+
| httpie | Outputs the results as httpie commands. |
29+
| oas2 | Outputs the results in OpenAPI Specification v2 format. |
30+
| oas3 | Outputs the results in OpenAPI Specification v3 format. |
31+
| only-url | Outputs only the URLs found in the analysis. |
32+
| only-param | Outputs only the parameters found in the analysis. |
33+
| only-header | Outputs only the headers found in the analysis. |
34+
| only-cookie | Outputs only the cookies found in the analysis. |

‎docs/images/get_started/basic.png

-14.3 KB
Loading

‎docs/images/illust.jpg

-350 KB
Binary file not shown.

‎docs/images/noir-usage.jpg

24 KB
Loading

‎docs/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ OWASP Noir is an open-source project, specializing in identifying attack surface
2020

2121
Noir is an open-source project dedicated to identifying attack surfaces, enhancing whitebox security testing, and optimizing security pipelines. It excels at discovering API endpoints, web endpoints, and other potential entry points within source code for comprehensive security analysis.
2222

23-
![](../images/noir-usage.jpg)
23+
![](images/noir-usage.jpg)
2424

2525
This tool was developed using [Crystal](https://crystal-lang.org). Initially started as hahwul's personal project[^1] in August 2023, it became an OWASP project[^2] in June 2024, co-led by [hahwul](https://github.com/hahwul) and [ksg](https://github.com/ksg97031).
2626

0 commit comments

Comments
 (0)
Please sign in to comment.