Merge pull request #111 from Syslifters/88-documentation-improvement

88 documentation improvement
Syslifters · Sep 13, 2023 · 47811e2 · 47811e2
2 parents 8f9183c + 9aa7d98
commit 47811e2
Show file tree

Hide file tree

Showing 8 changed files with 60 additions and 14 deletions.
diff --git a/docs/assets/uploaded-files.png b/docs/assets/uploaded-files.png
diff --git a/docs/getting-started.md b/docs/getting-started.md
@@ -1,14 +1,14 @@
 # reptor (alpha version)
-reptor allows you to automating pentest reporting with SysReptor.
+reptor allows you to automate pentest reporting with SysReptor.
 
  * Create findings and notes from tool outputs
  * Upload evidences (also bulk upload)
  * Import data from other reporting tools
 
-**GitHub:** https://github.com/Syslifters/reptor/  
-**Docs:** https://docs.sysreptor.com/cli/getting-started  
-**Setup:** https://docs.sysreptor.com/cli/setup  
-**PyPi:** https://pypi.org/project/reptor/  
+**GitHub:** [https://github.com/Syslifters/reptor/](https://github.com/Syslifters/reptor/){ target=_blank }  
+**Docs:** [https://docs.sysreptor.com/cli/getting-started](https://docs.sysreptor.com/cli/getting-started){ target=_blank }   
+**Setup:** [https://docs.sysreptor.com/cli/setup](https://docs.sysreptor.com/cli/setup){ target=_blank }   
+**PyPi:** [https://pypi.org/project/reptor/](https://pypi.org/project/reptor/){ target=_blank }   
 
 
 ## Usage

diff --git a/docs/projects-and-templates/translate.md b/docs/projects-and-templates/translate.md
@@ -9,8 +9,6 @@ reptor translate -to DE --skip-fields recommendation,summary
 Make sure you installed the correct dependency by using `pip install reptor[translate]` or `pip install reptor[all]`.
 
 ## Configuration
-Run `reptor conf` to setup your initial configuration.
-
 The translate module needs additional configurations, which you can add to `~/.sysreptor/config.yaml`:
 
 ```
@@ -27,8 +25,3 @@ translate:
 ```
 --8<-- "docs/cli/help-messages/translate"
 ```
-
-
-
-
-
diff --git a/docs/tools/nmap.md b/docs/tools/nmap.md
@@ -1,3 +1,24 @@
+## Examples
+
+```bash title="Nmap scan"
+sudo -n nmap -Pn -n -sV -oX - -p 0-65535 $target | tee nmap-output.xml
+```
+
+```bash title="Format nmap output"
+cat nmap-output.xml | reptor nmap -oX
+| Hostname | IP | Port | Service | Version |
+| ------- | ------- | ------- | ------- | ------- |
+| www.google.com | 142.250.180.228 | 80/tcp | http | gws |
+| www.google.com | 142.250.180.228 | 443/tcp | https | gws |
+| www.syslifters.com | 34.249.200.254 | 80/tcp | http | n/a |
+| www.syslifters.com | 34.249.200.254 | 443/tcp | https | n/a |
+```
+
+```bash title="Upload table to notes"
+cat nmap-output.xml | reptor nmap -oX --upload
+cat nmap-output.xml | reptor nmap -oX --upload --multi-notes  # One table per host
+```
+
 ## Usage
 ```
 --8<-- "docs/cli/help-messages/nmap"

diff --git a/docs/tools/sslyze.md b/docs/tools/sslyze.md
@@ -1,3 +1,15 @@
+## Examples
+
+```bash title="SSLyze scan"
+sslyze --sslv2 --sslv3 --tlsv1 --tlsv1_1 --tlsv1_2 --tlsv1_3 --certinfo --reneg --http_get --hide_rejected_ciphers --compression --heartbleed --openssl_ccs --fallback --robot "$target" --json_out=- | tee sslyze.json
+```
+
+```bash title="SSLyze"
+cat sslyze.json | reptor sslyze  # Format
+cat sslyze.json | reptor sslyze --upload  # Format and upload as note
+cat sslyze.json | reptor sslyze --push-findings  # Create findings from scan results
+```
+
 ## Usage
 ```
 --8<-- "docs/cli/help-messages/sslyze"

diff --git a/docs/uploads/file.md b/docs/uploads/file.md
@@ -1,3 +1,14 @@
+`file` uploads files from your system into a SysReptor note.
+
+## Examples
+
+```bash title="Upload files from folder"
+reptor file archive.zip
+reptor file *  # Upload all files
+```
+
+![Uploaded files](/cli/assets/uploaded-files.png)
+
 ## Usage
 ```
 --8<-- "docs/cli/help-messages/file"

diff --git a/docs/uploads/note.md b/docs/uploads/note.md
@@ -1,3 +1,12 @@
+`note` creates a new note in SysReptor.
+
+## Examples
+```bash title="Upload notes"
+echo "*Upload me*" | reptor note  # Appends to "Uploads" note
+echo "*Upload me*" | reptor note --force  # Force unlock note
+echo "*Upload me*" | reptor note --notename "My Note"  # Custom notename
+```
+
 ## Usage
 ```
 --8<-- "docs/cli/help-messages/note"

diff --git a/reptor/plugins/tools/Sslyze/Sslyze.py b/reptor/plugins/tools/Sslyze/Sslyze.py
@@ -6,10 +6,10 @@
 class Sslyze(ToolBase):
     """
     target="app1.example.com:443{127.0.0.1} app2.example.com:443{127.0.0.2}"
-    sslyze --sslv2 --sslv3 --tlsv1 --tlsv1_1 --tlsv1_2 --tlsv1_3 --certinfo --reneg --http_get --hide_rejected_ciphers --compression --heartbleed --openssl_ccs --fallback --robot "$target" --json_out=- | tee sslyze.txt | reptor sslyze
+    sslyze --sslv2 --sslv3 --tlsv1 --tlsv1_1 --tlsv1_2 --tlsv1_3 --certinfo --reneg --http_get --hide_rejected_ciphers --compression --heartbleed --openssl_ccs --fallback --robot "$target" --json_out=- | tee sslyze.json | reptor sslyze
 
     # Format and upload
-    cat sslyze_result.txt | reptor ssylyze -c upload
+    cat sslyze.json | reptor sslyze --upload
     """
 
     meta = {