Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/SECUREFOREST/WebMap
Nmap Web Interface including XML parsing, maps and reports
https://github.com/SECUREFOREST/WebMap
docker nmap nmap-analyzer nmap-parser nmap-results-analyse nmap-scripts nmap-xml webapp
Last synced: 21 days ago
JSON representation
Nmap Web Interface including XML parsing, maps and reports
- Host: GitHub
- URL: https://github.com/SECUREFOREST/WebMap
- Owner: SECUREFOREST
- License: gpl-3.0
- Created: 2019-10-20T07:41:09.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2021-05-31T08:59:16.000Z (over 3 years ago)
- Last Synced: 2024-08-05T17:44:14.500Z (4 months ago)
- Topics: docker, nmap, nmap-analyzer, nmap-parser, nmap-results-analyse, nmap-scripts, nmap-xml, webapp
- Language: Python
- Homepage: https://github.com/SECUREFOREST/WebMap
- Size: 965 KB
- Stars: 48
- Watchers: 5
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - SECUREFOREST/WebMap - Nmap Web Interface including XML parsing, maps and reports (Python)
README
A Web Dashboard for Nmap XML Report
Current version: 2.3b
## Table Of Contents
- [Usage](#usage)
- [Features](#features)
- [XML Filenames](#xml-filenames)
- [CVE and Exploits](#cve-and-exploits)
- [RESTful API](#restful-api)
- [Third Parts](#third-parts)
- [Security Issues](#security-issues)
- [Contributors](#contributors)
- [Contacts](#contacts)
## Usage
You should use this with docker, just by sending this command:
```bash
$ mkdir /tmp/webmap
$ docker run -d \
--name webmap \
-h webmap \
-p 8000:8000 \
-v /tmp/webmap:/opt/xml \
secureforest/webmap
$ # now you can run Nmap and save the XML Report on /tmp/webmap
$ nmap -sT -A -T4 -oX /tmp/webmap/myscan.xml 192.168.1.0/24
```
Now point your browser to http://localhost:8000
### Generate new token
In order to access to the WebMap dashboard, you need a token. You can create a new token with:
```bash
$ docker exec -ti webmap /root/token
```
### Quick and Dirty
```bash
$ curl -sL http://bit.ly/wmsetup | bash
```
### Upgrade from previous release
```bash
$ # stop running webmap container
$ docker stop webmap
$ # remove webmap container
$ docker rm webmap
$ # pull new image from dockerhub
$ docker pull secureforest/webmap
$ # run WebMap
$ curl -sL http://bit.ly/wmsetup | bash
```
### Run without Docker
This project is designed to run on a Docker container. IMHO it isn't a good idea to run this on a custom Django installation,
but if you need it you can find all building steps inside the [Dockerfile](https://raw.githubusercontent.com/SECUREFOREST/WebMap/master/docker/Dockerfile).
## Features
- Import and parse Nmap XML files
- Run and Schedule Nmap Scan from dashboard
- Statistics and Charts on discovered services, ports, OS, etc...
- Inspect a single host by clicking on its IP address
- Attach labels on a host
- Insert notes for a specific host
- Create a PDF Report with charts, details, labels and notes
- Copy to clipboard as Nikto, Curl or Telnet commands
- Search for CVE and Exploits based on CPE collected by Nmap
- RESTful API
## Roadmap for v2.4x
You love WebMap and you know python? We need your help! This is what we want deploy for the v2.4:
- [todo] Improve API: create a documentation/wiki about it
- [todo] Wiki: create WebMap User Guide on GitHub
- [todo] Zaproxy: Perform web scan using the OWASP ZAP API
## Changes on v2.3b
- Docker fixes
## Changes on v2.3a
- [In progress] Improve template: try to define better the html template and charts
- [In progress] Various bug fixes
## Changes on v2.3
- Scan diff: show difference between two scheduled nmap scan report
- Authentication or something that could blocks access to WebMap if != localhost
## Changes on v2.2
- fixed bug on missing services
- Run nmap from WebMap
- Schedule nmap run
- Add custom NSE scripts section
## Changes on v2.1
- Better usage of Django template
- Fixed some Nmap XML parse problems
- Fixed CVE and Exploit collecting problems
- Add new Network View
- Add RESTful API
## XML Filenames
When creating the PDF version of the Nmap XML Report, the XML filename is used as document title on the first page.
WebMap will replace some parts of the filename as following:
- `_` will replaced by a space (` `)
- `.xml` will be removed
Example: `ACME_Ltd..xml`
PDF title: `ACME Ltd.`
## CVE and Exploits
thanks to the amazing API services by circl.lu, WebMap is able to looking for CVE and Exploits for each CPE collected by Nmap.
Not all CPE are checked over the circl.lu API, but only when a specific version is specified
(for example: `cpe:/a:microsoft:iis:7.5` and not `cpe:/o:microsoft:windows`).
## RESTful API
From `v2.1` WebMap has a RESTful API frontend that makes users able to query their scan files with something like:
```bash
curl -s 'http://localhost:8000/api/v1/scan?token='
"webmap_version": "v2.3/master",
"scans": {
"scanme.nmap.org.xml": {
"filename": "scanme.nmap.org.xml",
"startstr": "Sun Nov 4 16:22:46 2018",
"nhost": "1",
"port_stats": {
"open": 42,
"closed": 0,
"filtered": 0
}
},
"hackthebox.xml": {
"filename": "hackthebox.xml",
"startstr": "Mon Oct 8 20:56:32 2018",
"nhost": "256",
"port_stats": {
"open": 67,
"closed": 0,
"filtered": 2
}
}
}
}
```
A user can get information about a single scan by append to the URL the XML filename:
```bash
curl -v 'http://localhost:8000/api/v1/scan/hackthebox.xml?token='
{
"file": "hackthebox.xml",
"hosts": {
"10.10.10.2": {
"hostname": {},
"label": "",
"notes": ""
},
"10.10.10.72": {
"hostname": {
"PTR": "streetfighterclub.htb"
},
"label": "",
"notes": ""
},
"10.10.10.76": {
"hostname": {},
"label": "",
"notes": ""
},
"10.10.10.77": {
"hostname": {},
"label": "Vulnerable",
"notes": "PHNwYW4gY2xhc3M9ImxhYmVsIGdyZWVuIj5SRU1FRElBVElPTjwvc3Bhbj4gVXBncmFkZSB0byB0aGUgbGF0ZXN0IHZlcnNpb24g"
},
...
```
and he can get all information about a single host by append the IP address to URL:
```bash
curl -v 'http://localhost:8000/api/v1/scan/hackthebox.xml/10.10.10.87?token='
"file": "hackthebox.xml",
"hosts": {
"10.10.10.87": {
"ports": [
{
"port": "22",
"name": "ssh",
"state": "open",
"protocol": "tcp",
"reason": "syn-ack",
"product": "OpenSSH",
"version": "7.5",
"extrainfo": "protocol 2.0"
},
{
"port": "80",
"name": "http",
"state": "open",
"protocol": "tcp",
"reason": "syn-ack",
"product": "nginx",
"version": "1.12.2",
"extrainfo": ""
},
{
"port": "8888",
"name": "sun-answerbook",
"state": "filtered",
"protocol": "tcp",
"reason": "no-response",
"product": "",
"version": "",
"extrainfo": ""
}
],
"hostname": {},
"label": "Checked",
"notes": "",
"CVE": [
{
"Modified": "2018-08-17T15:29:00.253000",
"Published": "2018-08-17T15:29:00.223000",
"cvss": "5.0",
"cwe": "CWE-200",
"exploit-db": [
{
"description": "OpenSSH 7.7 - Username Enumeration. CVE-2018-15473. Remote exploit for Linux platform",
"file": "exploits/linux/remote/45233.py",
"id": "EDB-ID:45233",
"last seen": "2018-08-21",
"modified": "2018-08-21",
"platform": "linux",
"port": "",
"published": "2018-08-21",
"reporter": "Exploit-DB",
"source": "https://www.exploit-db.com/download/45233/",
"title": "OpenSSH 7.7 - Username Enumeration",
"type": "remote"
},
{
"id": "EDB-ID:45210"
}
],
"id": "CVE-2018-15473",
"last-modified": "2018-11-02T06:29:06.993000",
"metasploit": [
...
```
## Third Parts
- [Django](https://www.djangoproject.com)
- [Materialize CSS](https://materializecss.com)
- [Clipboard.js](https://clipboardjs.com)
- [Chart.js](https://www.chartjs.org)
- [Wkhtmltopdf](https://wkhtmltopdf.org)
- [API cve.circl.lu](https://cve.circl.lu)
- [vis.js](http://visjs.org/)
## Security Issues
This app is not intended to be exposed to the internet, but to be used as localhost web application. Please, **DO NOT expose** this app to the internet, use your localhost or,
in case you can't do it, take care to filter who and what can access to WebMap with a firewall rule or something like that.
Exposing this app to the whole internet could lead not only to a stored XSS but also to a leakage of sensitive/critical/private
informations about your port scan. Please, be smart.
## Contributors
This project is currently a beta, and I'm not super skilled on Django so, every type of contribution is appreciated.
I'll mention all contributors on the [CONTRIBUTORS](CONTRIBUTORS.md) file.