scanwitness 2.2.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- scanwitness-2.2.0/LICENSE +21 -0
- scanwitness-2.2.0/MANIFEST.in +1 -0
- scanwitness-2.2.0/PKG-INFO +165 -0
- scanwitness-2.2.0/README.md +138 -0
- scanwitness-2.2.0/pyproject.toml +41 -0
- scanwitness-2.2.0/scanwitness.egg-info/PKG-INFO +165 -0
- scanwitness-2.2.0/scanwitness.egg-info/SOURCES.txt +17 -0
- scanwitness-2.2.0/scanwitness.egg-info/dependency_links.txt +1 -0
- scanwitness-2.2.0/scanwitness.egg-info/entry_points.txt +2 -0
- scanwitness-2.2.0/scanwitness.egg-info/requires.txt +2 -0
- scanwitness-2.2.0/scanwitness.egg-info/top_level.txt +1 -0
- scanwitness-2.2.0/scanwitness.py +1414 -0
- scanwitness-2.2.0/setup.cfg +4 -0
- scanwitness-2.2.0/tests/fixtures/raw/legacy.example_443/shcheck.json +1 -0
- scanwitness-2.2.0/tests/fixtures/raw/legacy.example_443/sslscan.xml +31 -0
- scanwitness-2.2.0/tests/fixtures/raw/legacy.example_443/target.txt +1 -0
- scanwitness-2.2.0/tests/fixtures/raw/legacy.example_443/wafw00f.json +1 -0
- scanwitness-2.2.0/tests/fixtures/raw/legacy.example_443/whatweb.json +3 -0
- scanwitness-2.2.0/tests/test_parsers.py +382 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Isaac E. Louzeiro
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
recursive-include tests *.py *.json *.xml *.txt
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: scanwitness
|
|
3
|
+
Version: 2.2.0
|
|
4
|
+
Summary: Runs wafw00f, shcheck, sslscan and whatweb and consolidates the results into HTML, Markdown and CSV reports with severity, evidence and recommendations per target
|
|
5
|
+
Author: Isaac E. Louzeiro
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/IsaacLouzeiro/scanwitness
|
|
8
|
+
Project-URL: Issues, https://github.com/IsaacLouzeiro/scanwitness/issues
|
|
9
|
+
Keywords: security,pentest,recon,tls,security-headers,waf,report
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Information Technology
|
|
13
|
+
Classifier: Intended Audience :: System Administrators
|
|
14
|
+
Classifier: Natural Language :: English
|
|
15
|
+
Classifier: Natural Language :: Portuguese (Brazilian)
|
|
16
|
+
Classifier: Operating System :: MacOS
|
|
17
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
20
|
+
Classifier: Topic :: Security
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Requires-Dist: wafw00f
|
|
25
|
+
Requires-Dist: shcheck
|
|
26
|
+
Dynamic: license-file
|
|
27
|
+
|
|
28
|
+
# scanwitness
|
|
29
|
+
|
|
30
|
+
Runs the standard web recon scans of a pentest and consolidates them into **one report**: an HTML report, a Markdown report and CSV files. For each target, it tells you whether each issue is present (`YES`) or not (`NO`), with severity, evidence and a recommendation.
|
|
31
|
+
|
|
32
|
+
| Tool | What it checks |
|
|
33
|
+
|---|---|
|
|
34
|
+
| [wafw00f](https://github.com/EnableSecurity/wafw00f) | presence or absence of a WAF |
|
|
35
|
+
| [shcheck](https://github.com/santoru/shcheck) | missing or weak security headers (short HSTS max-age, CSP with `unsafe-inline`/`unsafe-eval`/`*`), headers that leak versions (`Server`, `X-Powered-By`, ...) |
|
|
36
|
+
| [sslscan](https://github.com/rbsec/sslscan) | SSLv2/v3, TLS 1.0/1.1, missing TLS 1.3, weak/medium cipher suites, Heartbleed, CRIME, insecure renegotiation, TLS_FALLBACK_SCSV, expired/self-signed/SHA1/short-key certificate |
|
|
37
|
+
| [whatweb](https://github.com/urbanadventurer/WhatWeb) | technology fingerprinting, with exposed versions |
|
|
38
|
+
|
|
39
|
+
A tool missing from `PATH` is skipped with a warning; the others still run.
|
|
40
|
+
|
|
41
|
+
## Installation
|
|
42
|
+
|
|
43
|
+
Requires Python 3.10+.
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
pipx install scanwitness # or: pip install scanwitness (also installs wafw00f and shcheck)
|
|
47
|
+
brew install sslscan # or: apt install sslscan
|
|
48
|
+
apt install whatweb # Kali/Debian; on macOS: git clone the official repository
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
`sslscan` and `whatweb` are not Python packages, so they are installed with your system's package manager.
|
|
52
|
+
|
|
53
|
+
From source:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
git clone https://github.com/IsaacLouzeiro/scanwitness.git
|
|
57
|
+
cd scanwitness
|
|
58
|
+
pip install -r requirements.txt # wafw00f + shcheck
|
|
59
|
+
python3 scanwitness.py --help
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
scanwitness itself only uses the Python standard library.
|
|
63
|
+
|
|
64
|
+
## Usage
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
scanwitness -t https://target.com
|
|
68
|
+
scanwitness -t target1.com -t https://target2.com:8443
|
|
69
|
+
scanwitness -f targets.txt -o results --threads 4 --timeout 300
|
|
70
|
+
scanwitness -f targets.txt --skip whatweb,wafw00f
|
|
71
|
+
scanwitness --reparse results # rebuild the reports from results/raw without scanning again
|
|
72
|
+
scanwitness -t target.com --lang pt # reports in Portuguese (Brazil)
|
|
73
|
+
scanwitness -t target.com --format html # only the HTML report
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
When running from source, use `python3 scanwitness.py` instead of `scanwitness`.
|
|
77
|
+
|
|
78
|
+
| Option | Description |
|
|
79
|
+
|---|---|
|
|
80
|
+
| `-t`, `--target` | target URL or host (can be repeated) |
|
|
81
|
+
| `-f`, `--file` | file with one target per line (`#` starts a comment) |
|
|
82
|
+
| `--reparse DIR` | only rebuild the reports from `DIR/raw` |
|
|
83
|
+
| `-o`, `--output` | output folder (default: `scanwitness_<date>`) |
|
|
84
|
+
| `--format` | `csv`, `html`, `md` (comma-separated) or `all`; **default: all** |
|
|
85
|
+
| `--lang` | language of the generated reports: `en` or `pt`; **default: `en`** |
|
|
86
|
+
| `-d`, `--delimiter` | CSV delimiter (default: `,` for `en`, `;` for `pt`, so it opens directly in Excel) |
|
|
87
|
+
| `--threads` | targets scanned in parallel (default: 3) |
|
|
88
|
+
| `--timeout` | timeout per tool, in seconds (default: 300) |
|
|
89
|
+
| `--skip` | comma-separated tools to skip |
|
|
90
|
+
| `--no-evidence` | do not create the `evidence/` folder |
|
|
91
|
+
| `--evidence-host` | include this machine's hostname in the evidence headers (off by default) |
|
|
92
|
+
| `-q`, `--quiet` | suppress progress messages |
|
|
93
|
+
|
|
94
|
+
The command line and its messages are always in English; `--lang` only changes the content of the generated reports.
|
|
95
|
+
|
|
96
|
+
## Outputs
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
results/
|
|
100
|
+
├── report.html full report, single self-contained file (print-friendly)
|
|
101
|
+
├── report.md the same report in Markdown (GitHub, Obsidian, wikis...)
|
|
102
|
+
├── findings.csv target,tool,category,check,vulnerable,severity,detail,recommendation
|
|
103
|
+
├── matrix.csv target,total_vulns,[sslscan] TLSv1.0 enabled,[shcheck] Missing ... header,...
|
|
104
|
+
├── technologies.csv target,url,technology,version,detail
|
|
105
|
+
├── evidence/ raw tool output to hand over to the client (see below)
|
|
106
|
+
│ ├── README.txt
|
|
107
|
+
│ ├── SHA256SUMS.txt
|
|
108
|
+
│ └── <host_port>/<tool>.txt
|
|
109
|
+
└── raw/<host_port>/ working files used to build the reports
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
The HTML and Markdown reports are organized like a pentest report:
|
|
113
|
+
|
|
114
|
+
1. **Executive summary** – issues by severity (High / Medium / Low / Info) and an overview per target with its overall risk.
|
|
115
|
+
2. **Findings** – one entry per issue, per target, sorted from most to least severe, with an ID (`F-01`, ...), severity, tool, evidence and recommendation.
|
|
116
|
+
3. **Passed and not applicable checks** – what was checked and found OK, with evidence.
|
|
117
|
+
4. **Check matrix** – every check (rows) against every target (columns).
|
|
118
|
+
5. **Technology inventory** – technologies and versions detected by whatweb.
|
|
119
|
+
6. **Scope and methodology** – targets, tools used and how to read `N/A`.
|
|
120
|
+
|
|
121
|
+
Values of `vulnerable` in the CSVs: `YES`, `NO`, `N/A` (the check does not apply or the tool did not run for that target). With `--lang pt`: `SIM`, `NÃO`, `N/A`, and the column names are in Portuguese.
|
|
122
|
+
|
|
123
|
+
All tool output is escaped before going into the HTML and Markdown reports, since it comes from the scanned target.
|
|
124
|
+
|
|
125
|
+
## Evidence for the client
|
|
126
|
+
|
|
127
|
+
`evidence/` proves that the scans were actually run. Each `<host_port>/<tool>.txt` starts with a header and then shows the tool's console output:
|
|
128
|
+
|
|
129
|
+
```
|
|
130
|
+
Tool: sslscan 2.1.4
|
|
131
|
+
Target: https://target.com (target.com:443)
|
|
132
|
+
Command: sslscan --no-colour --xml=raw/target.com_443/sslscan.xml target.com:443
|
|
133
|
+
Started: 2026-11-12 10:31:05 UTC
|
|
134
|
+
Finished: 2026-11-12 10:31:19 UTC (14s)
|
|
135
|
+
Exit code: 0
|
|
136
|
+
Collected by: scanwitness 2.2.0
|
|
137
|
+
|
|
138
|
+
========================================================================
|
|
139
|
+
STANDARD OUTPUT
|
|
140
|
+
========================================================================
|
|
141
|
+
...
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
- ANSI color codes are removed and the shcheck JSON is indented; nothing else is changed.
|
|
145
|
+
- Paths in the command line are relative to the results folder, so no local paths from your machine end up in the evidence.
|
|
146
|
+
- `SHA256SUMS.txt` lets the client check that the files were not modified (`cd evidence && sha256sum -c SHA256SUMS.txt`).
|
|
147
|
+
- The **Scope and methodology** section of the reports links to each evidence file, so send the whole results folder (or at least the reports together with `evidence/`).
|
|
148
|
+
- `--reparse` rebuilds `evidence/` from `raw/`. Scans made with versions older than 2.1.0 did not record timestamps and versions, so no evidence is generated for them.
|
|
149
|
+
- The raw output can include internal details of the target (IP addresses, banners). Review it before sending.
|
|
150
|
+
|
|
151
|
+
## Tests
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
python3 -m unittest discover tests -v
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## Upgrading from 1.x
|
|
158
|
+
|
|
159
|
+
Version 2.0 renamed the output files (`achados.csv` → `findings.csv`, `matriz.csv` → `matrix.csv`, `tecnologias.csv` → `technologies.csv`, `relatorio.*` → `report.*`) and generates reports in English by default. Use `--lang pt` for Portuguese reports (it also keeps `;` as the CSV delimiter, as in 1.x).
|
|
160
|
+
|
|
161
|
+
> Only scan targets you are authorized to test.
|
|
162
|
+
|
|
163
|
+
## License
|
|
164
|
+
|
|
165
|
+
[MIT](https://github.com/IsaacLouzeiro/scanwitness/blob/main/LICENSE)
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
# scanwitness
|
|
2
|
+
|
|
3
|
+
Runs the standard web recon scans of a pentest and consolidates them into **one report**: an HTML report, a Markdown report and CSV files. For each target, it tells you whether each issue is present (`YES`) or not (`NO`), with severity, evidence and a recommendation.
|
|
4
|
+
|
|
5
|
+
| Tool | What it checks |
|
|
6
|
+
|---|---|
|
|
7
|
+
| [wafw00f](https://github.com/EnableSecurity/wafw00f) | presence or absence of a WAF |
|
|
8
|
+
| [shcheck](https://github.com/santoru/shcheck) | missing or weak security headers (short HSTS max-age, CSP with `unsafe-inline`/`unsafe-eval`/`*`), headers that leak versions (`Server`, `X-Powered-By`, ...) |
|
|
9
|
+
| [sslscan](https://github.com/rbsec/sslscan) | SSLv2/v3, TLS 1.0/1.1, missing TLS 1.3, weak/medium cipher suites, Heartbleed, CRIME, insecure renegotiation, TLS_FALLBACK_SCSV, expired/self-signed/SHA1/short-key certificate |
|
|
10
|
+
| [whatweb](https://github.com/urbanadventurer/WhatWeb) | technology fingerprinting, with exposed versions |
|
|
11
|
+
|
|
12
|
+
A tool missing from `PATH` is skipped with a warning; the others still run.
|
|
13
|
+
|
|
14
|
+
## Installation
|
|
15
|
+
|
|
16
|
+
Requires Python 3.10+.
|
|
17
|
+
|
|
18
|
+
```bash
|
|
19
|
+
pipx install scanwitness # or: pip install scanwitness (also installs wafw00f and shcheck)
|
|
20
|
+
brew install sslscan # or: apt install sslscan
|
|
21
|
+
apt install whatweb # Kali/Debian; on macOS: git clone the official repository
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
`sslscan` and `whatweb` are not Python packages, so they are installed with your system's package manager.
|
|
25
|
+
|
|
26
|
+
From source:
|
|
27
|
+
|
|
28
|
+
```bash
|
|
29
|
+
git clone https://github.com/IsaacLouzeiro/scanwitness.git
|
|
30
|
+
cd scanwitness
|
|
31
|
+
pip install -r requirements.txt # wafw00f + shcheck
|
|
32
|
+
python3 scanwitness.py --help
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
scanwitness itself only uses the Python standard library.
|
|
36
|
+
|
|
37
|
+
## Usage
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
scanwitness -t https://target.com
|
|
41
|
+
scanwitness -t target1.com -t https://target2.com:8443
|
|
42
|
+
scanwitness -f targets.txt -o results --threads 4 --timeout 300
|
|
43
|
+
scanwitness -f targets.txt --skip whatweb,wafw00f
|
|
44
|
+
scanwitness --reparse results # rebuild the reports from results/raw without scanning again
|
|
45
|
+
scanwitness -t target.com --lang pt # reports in Portuguese (Brazil)
|
|
46
|
+
scanwitness -t target.com --format html # only the HTML report
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
When running from source, use `python3 scanwitness.py` instead of `scanwitness`.
|
|
50
|
+
|
|
51
|
+
| Option | Description |
|
|
52
|
+
|---|---|
|
|
53
|
+
| `-t`, `--target` | target URL or host (can be repeated) |
|
|
54
|
+
| `-f`, `--file` | file with one target per line (`#` starts a comment) |
|
|
55
|
+
| `--reparse DIR` | only rebuild the reports from `DIR/raw` |
|
|
56
|
+
| `-o`, `--output` | output folder (default: `scanwitness_<date>`) |
|
|
57
|
+
| `--format` | `csv`, `html`, `md` (comma-separated) or `all`; **default: all** |
|
|
58
|
+
| `--lang` | language of the generated reports: `en` or `pt`; **default: `en`** |
|
|
59
|
+
| `-d`, `--delimiter` | CSV delimiter (default: `,` for `en`, `;` for `pt`, so it opens directly in Excel) |
|
|
60
|
+
| `--threads` | targets scanned in parallel (default: 3) |
|
|
61
|
+
| `--timeout` | timeout per tool, in seconds (default: 300) |
|
|
62
|
+
| `--skip` | comma-separated tools to skip |
|
|
63
|
+
| `--no-evidence` | do not create the `evidence/` folder |
|
|
64
|
+
| `--evidence-host` | include this machine's hostname in the evidence headers (off by default) |
|
|
65
|
+
| `-q`, `--quiet` | suppress progress messages |
|
|
66
|
+
|
|
67
|
+
The command line and its messages are always in English; `--lang` only changes the content of the generated reports.
|
|
68
|
+
|
|
69
|
+
## Outputs
|
|
70
|
+
|
|
71
|
+
```
|
|
72
|
+
results/
|
|
73
|
+
├── report.html full report, single self-contained file (print-friendly)
|
|
74
|
+
├── report.md the same report in Markdown (GitHub, Obsidian, wikis...)
|
|
75
|
+
├── findings.csv target,tool,category,check,vulnerable,severity,detail,recommendation
|
|
76
|
+
├── matrix.csv target,total_vulns,[sslscan] TLSv1.0 enabled,[shcheck] Missing ... header,...
|
|
77
|
+
├── technologies.csv target,url,technology,version,detail
|
|
78
|
+
├── evidence/ raw tool output to hand over to the client (see below)
|
|
79
|
+
│ ├── README.txt
|
|
80
|
+
│ ├── SHA256SUMS.txt
|
|
81
|
+
│ └── <host_port>/<tool>.txt
|
|
82
|
+
└── raw/<host_port>/ working files used to build the reports
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
The HTML and Markdown reports are organized like a pentest report:
|
|
86
|
+
|
|
87
|
+
1. **Executive summary** – issues by severity (High / Medium / Low / Info) and an overview per target with its overall risk.
|
|
88
|
+
2. **Findings** – one entry per issue, per target, sorted from most to least severe, with an ID (`F-01`, ...), severity, tool, evidence and recommendation.
|
|
89
|
+
3. **Passed and not applicable checks** – what was checked and found OK, with evidence.
|
|
90
|
+
4. **Check matrix** – every check (rows) against every target (columns).
|
|
91
|
+
5. **Technology inventory** – technologies and versions detected by whatweb.
|
|
92
|
+
6. **Scope and methodology** – targets, tools used and how to read `N/A`.
|
|
93
|
+
|
|
94
|
+
Values of `vulnerable` in the CSVs: `YES`, `NO`, `N/A` (the check does not apply or the tool did not run for that target). With `--lang pt`: `SIM`, `NÃO`, `N/A`, and the column names are in Portuguese.
|
|
95
|
+
|
|
96
|
+
All tool output is escaped before going into the HTML and Markdown reports, since it comes from the scanned target.
|
|
97
|
+
|
|
98
|
+
## Evidence for the client
|
|
99
|
+
|
|
100
|
+
`evidence/` proves that the scans were actually run. Each `<host_port>/<tool>.txt` starts with a header and then shows the tool's console output:
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
Tool: sslscan 2.1.4
|
|
104
|
+
Target: https://target.com (target.com:443)
|
|
105
|
+
Command: sslscan --no-colour --xml=raw/target.com_443/sslscan.xml target.com:443
|
|
106
|
+
Started: 2026-11-12 10:31:05 UTC
|
|
107
|
+
Finished: 2026-11-12 10:31:19 UTC (14s)
|
|
108
|
+
Exit code: 0
|
|
109
|
+
Collected by: scanwitness 2.2.0
|
|
110
|
+
|
|
111
|
+
========================================================================
|
|
112
|
+
STANDARD OUTPUT
|
|
113
|
+
========================================================================
|
|
114
|
+
...
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
- ANSI color codes are removed and the shcheck JSON is indented; nothing else is changed.
|
|
118
|
+
- Paths in the command line are relative to the results folder, so no local paths from your machine end up in the evidence.
|
|
119
|
+
- `SHA256SUMS.txt` lets the client check that the files were not modified (`cd evidence && sha256sum -c SHA256SUMS.txt`).
|
|
120
|
+
- The **Scope and methodology** section of the reports links to each evidence file, so send the whole results folder (or at least the reports together with `evidence/`).
|
|
121
|
+
- `--reparse` rebuilds `evidence/` from `raw/`. Scans made with versions older than 2.1.0 did not record timestamps and versions, so no evidence is generated for them.
|
|
122
|
+
- The raw output can include internal details of the target (IP addresses, banners). Review it before sending.
|
|
123
|
+
|
|
124
|
+
## Tests
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
python3 -m unittest discover tests -v
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## Upgrading from 1.x
|
|
131
|
+
|
|
132
|
+
Version 2.0 renamed the output files (`achados.csv` → `findings.csv`, `matriz.csv` → `matrix.csv`, `tecnologias.csv` → `technologies.csv`, `relatorio.*` → `report.*`) and generates reports in English by default. Use `--lang pt` for Portuguese reports (it also keeps `;` as the CSV delimiter, as in 1.x).
|
|
133
|
+
|
|
134
|
+
> Only scan targets you are authorized to test.
|
|
135
|
+
|
|
136
|
+
## License
|
|
137
|
+
|
|
138
|
+
[MIT](https://github.com/IsaacLouzeiro/scanwitness/blob/main/LICENSE)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "scanwitness"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = "Runs wafw00f, shcheck, sslscan and whatweb and consolidates the results into HTML, Markdown and CSV reports with severity, evidence and recommendations per target"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = "MIT"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
13
|
+
authors = [{ name = "Isaac E. Louzeiro" }]
|
|
14
|
+
keywords = ["security", "pentest", "recon", "tls", "security-headers", "waf", "report"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 4 - Beta",
|
|
17
|
+
"Environment :: Console",
|
|
18
|
+
"Intended Audience :: Information Technology",
|
|
19
|
+
"Intended Audience :: System Administrators",
|
|
20
|
+
"Natural Language :: English",
|
|
21
|
+
"Natural Language :: Portuguese (Brazilian)",
|
|
22
|
+
"Operating System :: MacOS",
|
|
23
|
+
"Operating System :: POSIX :: Linux",
|
|
24
|
+
"Programming Language :: Python :: 3",
|
|
25
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
26
|
+
"Topic :: Security",
|
|
27
|
+
]
|
|
28
|
+
dependencies = ["wafw00f", "shcheck"]
|
|
29
|
+
|
|
30
|
+
[project.scripts]
|
|
31
|
+
scanwitness = "scanwitness:main"
|
|
32
|
+
|
|
33
|
+
[project.urls]
|
|
34
|
+
Homepage = "https://github.com/IsaacLouzeiro/scanwitness"
|
|
35
|
+
Issues = "https://github.com/IsaacLouzeiro/scanwitness/issues"
|
|
36
|
+
|
|
37
|
+
[tool.setuptools]
|
|
38
|
+
py-modules = ["scanwitness"]
|
|
39
|
+
|
|
40
|
+
[tool.setuptools.dynamic]
|
|
41
|
+
version = { attr = "scanwitness.__version__" }
|
|
@@ -0,0 +1,165 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: scanwitness
|
|
3
|
+
Version: 2.2.0
|
|
4
|
+
Summary: Runs wafw00f, shcheck, sslscan and whatweb and consolidates the results into HTML, Markdown and CSV reports with severity, evidence and recommendations per target
|
|
5
|
+
Author: Isaac E. Louzeiro
|
|
6
|
+
License-Expression: MIT
|
|
7
|
+
Project-URL: Homepage, https://github.com/IsaacLouzeiro/scanwitness
|
|
8
|
+
Project-URL: Issues, https://github.com/IsaacLouzeiro/scanwitness/issues
|
|
9
|
+
Keywords: security,pentest,recon,tls,security-headers,waf,report
|
|
10
|
+
Classifier: Development Status :: 4 - Beta
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Information Technology
|
|
13
|
+
Classifier: Intended Audience :: System Administrators
|
|
14
|
+
Classifier: Natural Language :: English
|
|
15
|
+
Classifier: Natural Language :: Portuguese (Brazilian)
|
|
16
|
+
Classifier: Operating System :: MacOS
|
|
17
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
18
|
+
Classifier: Programming Language :: Python :: 3
|
|
19
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
20
|
+
Classifier: Topic :: Security
|
|
21
|
+
Requires-Python: >=3.10
|
|
22
|
+
Description-Content-Type: text/markdown
|
|
23
|
+
License-File: LICENSE
|
|
24
|
+
Requires-Dist: wafw00f
|
|
25
|
+
Requires-Dist: shcheck
|
|
26
|
+
Dynamic: license-file
|
|
27
|
+
|
|
28
|
+
# scanwitness
|
|
29
|
+
|
|
30
|
+
Runs the standard web recon scans of a pentest and consolidates them into **one report**: an HTML report, a Markdown report and CSV files. For each target, it tells you whether each issue is present (`YES`) or not (`NO`), with severity, evidence and a recommendation.
|
|
31
|
+
|
|
32
|
+
| Tool | What it checks |
|
|
33
|
+
|---|---|
|
|
34
|
+
| [wafw00f](https://github.com/EnableSecurity/wafw00f) | presence or absence of a WAF |
|
|
35
|
+
| [shcheck](https://github.com/santoru/shcheck) | missing or weak security headers (short HSTS max-age, CSP with `unsafe-inline`/`unsafe-eval`/`*`), headers that leak versions (`Server`, `X-Powered-By`, ...) |
|
|
36
|
+
| [sslscan](https://github.com/rbsec/sslscan) | SSLv2/v3, TLS 1.0/1.1, missing TLS 1.3, weak/medium cipher suites, Heartbleed, CRIME, insecure renegotiation, TLS_FALLBACK_SCSV, expired/self-signed/SHA1/short-key certificate |
|
|
37
|
+
| [whatweb](https://github.com/urbanadventurer/WhatWeb) | technology fingerprinting, with exposed versions |
|
|
38
|
+
|
|
39
|
+
A tool missing from `PATH` is skipped with a warning; the others still run.
|
|
40
|
+
|
|
41
|
+
## Installation
|
|
42
|
+
|
|
43
|
+
Requires Python 3.10+.
|
|
44
|
+
|
|
45
|
+
```bash
|
|
46
|
+
pipx install scanwitness # or: pip install scanwitness (also installs wafw00f and shcheck)
|
|
47
|
+
brew install sslscan # or: apt install sslscan
|
|
48
|
+
apt install whatweb # Kali/Debian; on macOS: git clone the official repository
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
`sslscan` and `whatweb` are not Python packages, so they are installed with your system's package manager.
|
|
52
|
+
|
|
53
|
+
From source:
|
|
54
|
+
|
|
55
|
+
```bash
|
|
56
|
+
git clone https://github.com/IsaacLouzeiro/scanwitness.git
|
|
57
|
+
cd scanwitness
|
|
58
|
+
pip install -r requirements.txt # wafw00f + shcheck
|
|
59
|
+
python3 scanwitness.py --help
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
scanwitness itself only uses the Python standard library.
|
|
63
|
+
|
|
64
|
+
## Usage
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
scanwitness -t https://target.com
|
|
68
|
+
scanwitness -t target1.com -t https://target2.com:8443
|
|
69
|
+
scanwitness -f targets.txt -o results --threads 4 --timeout 300
|
|
70
|
+
scanwitness -f targets.txt --skip whatweb,wafw00f
|
|
71
|
+
scanwitness --reparse results # rebuild the reports from results/raw without scanning again
|
|
72
|
+
scanwitness -t target.com --lang pt # reports in Portuguese (Brazil)
|
|
73
|
+
scanwitness -t target.com --format html # only the HTML report
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
When running from source, use `python3 scanwitness.py` instead of `scanwitness`.
|
|
77
|
+
|
|
78
|
+
| Option | Description |
|
|
79
|
+
|---|---|
|
|
80
|
+
| `-t`, `--target` | target URL or host (can be repeated) |
|
|
81
|
+
| `-f`, `--file` | file with one target per line (`#` starts a comment) |
|
|
82
|
+
| `--reparse DIR` | only rebuild the reports from `DIR/raw` |
|
|
83
|
+
| `-o`, `--output` | output folder (default: `scanwitness_<date>`) |
|
|
84
|
+
| `--format` | `csv`, `html`, `md` (comma-separated) or `all`; **default: all** |
|
|
85
|
+
| `--lang` | language of the generated reports: `en` or `pt`; **default: `en`** |
|
|
86
|
+
| `-d`, `--delimiter` | CSV delimiter (default: `,` for `en`, `;` for `pt`, so it opens directly in Excel) |
|
|
87
|
+
| `--threads` | targets scanned in parallel (default: 3) |
|
|
88
|
+
| `--timeout` | timeout per tool, in seconds (default: 300) |
|
|
89
|
+
| `--skip` | comma-separated tools to skip |
|
|
90
|
+
| `--no-evidence` | do not create the `evidence/` folder |
|
|
91
|
+
| `--evidence-host` | include this machine's hostname in the evidence headers (off by default) |
|
|
92
|
+
| `-q`, `--quiet` | suppress progress messages |
|
|
93
|
+
|
|
94
|
+
The command line and its messages are always in English; `--lang` only changes the content of the generated reports.
|
|
95
|
+
|
|
96
|
+
## Outputs
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
results/
|
|
100
|
+
├── report.html full report, single self-contained file (print-friendly)
|
|
101
|
+
├── report.md the same report in Markdown (GitHub, Obsidian, wikis...)
|
|
102
|
+
├── findings.csv target,tool,category,check,vulnerable,severity,detail,recommendation
|
|
103
|
+
├── matrix.csv target,total_vulns,[sslscan] TLSv1.0 enabled,[shcheck] Missing ... header,...
|
|
104
|
+
├── technologies.csv target,url,technology,version,detail
|
|
105
|
+
├── evidence/ raw tool output to hand over to the client (see below)
|
|
106
|
+
│ ├── README.txt
|
|
107
|
+
│ ├── SHA256SUMS.txt
|
|
108
|
+
│ └── <host_port>/<tool>.txt
|
|
109
|
+
└── raw/<host_port>/ working files used to build the reports
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
The HTML and Markdown reports are organized like a pentest report:
|
|
113
|
+
|
|
114
|
+
1. **Executive summary** – issues by severity (High / Medium / Low / Info) and an overview per target with its overall risk.
|
|
115
|
+
2. **Findings** – one entry per issue, per target, sorted from most to least severe, with an ID (`F-01`, ...), severity, tool, evidence and recommendation.
|
|
116
|
+
3. **Passed and not applicable checks** – what was checked and found OK, with evidence.
|
|
117
|
+
4. **Check matrix** – every check (rows) against every target (columns).
|
|
118
|
+
5. **Technology inventory** – technologies and versions detected by whatweb.
|
|
119
|
+
6. **Scope and methodology** – targets, tools used and how to read `N/A`.
|
|
120
|
+
|
|
121
|
+
Values of `vulnerable` in the CSVs: `YES`, `NO`, `N/A` (the check does not apply or the tool did not run for that target). With `--lang pt`: `SIM`, `NÃO`, `N/A`, and the column names are in Portuguese.
|
|
122
|
+
|
|
123
|
+
All tool output is escaped before going into the HTML and Markdown reports, since it comes from the scanned target.
|
|
124
|
+
|
|
125
|
+
## Evidence for the client
|
|
126
|
+
|
|
127
|
+
`evidence/` proves that the scans were actually run. Each `<host_port>/<tool>.txt` starts with a header and then shows the tool's console output:
|
|
128
|
+
|
|
129
|
+
```
|
|
130
|
+
Tool: sslscan 2.1.4
|
|
131
|
+
Target: https://target.com (target.com:443)
|
|
132
|
+
Command: sslscan --no-colour --xml=raw/target.com_443/sslscan.xml target.com:443
|
|
133
|
+
Started: 2026-11-12 10:31:05 UTC
|
|
134
|
+
Finished: 2026-11-12 10:31:19 UTC (14s)
|
|
135
|
+
Exit code: 0
|
|
136
|
+
Collected by: scanwitness 2.2.0
|
|
137
|
+
|
|
138
|
+
========================================================================
|
|
139
|
+
STANDARD OUTPUT
|
|
140
|
+
========================================================================
|
|
141
|
+
...
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
- ANSI color codes are removed and the shcheck JSON is indented; nothing else is changed.
|
|
145
|
+
- Paths in the command line are relative to the results folder, so no local paths from your machine end up in the evidence.
|
|
146
|
+
- `SHA256SUMS.txt` lets the client check that the files were not modified (`cd evidence && sha256sum -c SHA256SUMS.txt`).
|
|
147
|
+
- The **Scope and methodology** section of the reports links to each evidence file, so send the whole results folder (or at least the reports together with `evidence/`).
|
|
148
|
+
- `--reparse` rebuilds `evidence/` from `raw/`. Scans made with versions older than 2.1.0 did not record timestamps and versions, so no evidence is generated for them.
|
|
149
|
+
- The raw output can include internal details of the target (IP addresses, banners). Review it before sending.
|
|
150
|
+
|
|
151
|
+
## Tests
|
|
152
|
+
|
|
153
|
+
```bash
|
|
154
|
+
python3 -m unittest discover tests -v
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
## Upgrading from 1.x
|
|
158
|
+
|
|
159
|
+
Version 2.0 renamed the output files (`achados.csv` → `findings.csv`, `matriz.csv` → `matrix.csv`, `tecnologias.csv` → `technologies.csv`, `relatorio.*` → `report.*`) and generates reports in English by default. Use `--lang pt` for Portuguese reports (it also keeps `;` as the CSV delimiter, as in 1.x).
|
|
160
|
+
|
|
161
|
+
> Only scan targets you are authorized to test.
|
|
162
|
+
|
|
163
|
+
## License
|
|
164
|
+
|
|
165
|
+
[MIT](https://github.com/IsaacLouzeiro/scanwitness/blob/main/LICENSE)
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
MANIFEST.in
|
|
3
|
+
README.md
|
|
4
|
+
pyproject.toml
|
|
5
|
+
scanwitness.py
|
|
6
|
+
scanwitness.egg-info/PKG-INFO
|
|
7
|
+
scanwitness.egg-info/SOURCES.txt
|
|
8
|
+
scanwitness.egg-info/dependency_links.txt
|
|
9
|
+
scanwitness.egg-info/entry_points.txt
|
|
10
|
+
scanwitness.egg-info/requires.txt
|
|
11
|
+
scanwitness.egg-info/top_level.txt
|
|
12
|
+
tests/test_parsers.py
|
|
13
|
+
tests/fixtures/raw/legacy.example_443/shcheck.json
|
|
14
|
+
tests/fixtures/raw/legacy.example_443/sslscan.xml
|
|
15
|
+
tests/fixtures/raw/legacy.example_443/target.txt
|
|
16
|
+
tests/fixtures/raw/legacy.example_443/wafw00f.json
|
|
17
|
+
tests/fixtures/raw/legacy.example_443/whatweb.json
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
scanwitness
|