Web Inventory tool that uses Pyppeteer (headless Chrome/Chromium) and provides some extra bells & whistles to make life easier.
Project description
WitnessMe
My take on a Web Inventory tool, heavily inspired by Eyewitness. Takes screenshots of webpages using Pyppeteer (headless Chrome/Chromium).
Supports Python 3.7+, fully asynchronous and has extra bells & whistles that make life easier.
Why & what problems does this solve
- Python 3.7+
- No dependency/installation hell, works on a variety of *nix flavors
- AsyncIO provides Mad Max level speeds
- Headless chrome/chromium is the best.
- Provides a RESTful API.
Sponsors
Table of Contents
Note, the documentation is still a WIP. I've released this early because of CVE-2020-5902.
Quick Starts
Finding F5 Load Balancers Vulnerable to CVE-2020-5902
Note: it is highly recommended to give the Docker container at least 4GB of RAM during large scans as Chromium can be a resource hog. If you keep running into "Page Crash" errors, it's because your container does not have enough memory. On Mac/Windows you can change this by clicking the Docker Task Bar Icon -> Preferences -> Resources. For Linux, refer to Docker's documentation
Install WitnessMe using Docker:
docker pull byt3bl33d3r/witnessme
Get the $IMAGE_ID
from the docker images
command output, then run the following command to drop into a shell inside the container. Additionally, specify the -v
flag to mount the current directory inside the container at the path /transfer
in order to copy the scan results back to your host machine (if so desired):
docker run -it --entrypoint=/bin/sh -v $(pwd):/transfer $IMAGE_ID
Scan your network using WitnessMe, it can accept multiple .Nessus files, Nmap XMLs, IP ranges/CIDRs. Example:
witnessme 10.0.1.0/24 192.168.0.1-20 ~/my_nessus_scan.nessus ~/my_nmap_scan.xml
After the scan is finished, a folder will have been created in the current directory with the results. Access the results using the wmdb
command line utility:
wmdb scan_2020_$TIME/
To quickly identify F5 load balancers, first perform a signature scan using the scan
command. Then search for "BIG-IP" or "F5" using the servers
command (this will search for the "BIG-IP" and "F5" string in the signature name, page title and server header):
Additionally, you can generate an HTML or CSV report using the following commands:
WMDB ≫ generate_report html
WMDB ≫ generate_report csv
You can then copy the entire scan folder which will contain all of the reports and results to your host machine by copying it to the /transfer
folder.
Installation
Docker
Running WitnessMe from a Docker container is fully supported and is the easiest/recommended way of using the tool.
Pull the image from Docker Hub:
docker pull byt3bl33d3r/witnessme
You can then spin up a docker container, run it like the main witnessme
script and pass it the same arguments:
docker run --rm -ti $IMAGE_ID https://google.com 192.168.0.1/24
Alternatively, you can drop into a shell within the container and run the tools that way. This also allows you to execute the wmdb
and wmapi
scripts.
docker run --rm -ti --entrypoint=/bin/sh $IMAGE_ID
Python Package
WitnessMe is also available as a Python package (Python 3.7 or above is required). If you do install it this way it is extremely recommended to use pipx as it takes care of installing everything in isolated environments for you in a seamless manner.
Run the following commands:
python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install witnessme
All of the WitnessMe scripts should now be in your PATH and ready to go.
Development Install
You really should only install WitnessMe this way if you intend to hack on the source code. You're going to Python 3.7+ and Poetry: please refer to the Poetry installation documentation in order to install it.
git clone https://github.com/byt3bl33d3r/WitnessMe && cd WitnessMe
poetry install
RESTful API
As of version 1.0, WitnessMe has a RESTful API which allows you to interact with the tool remotely.
Note: Currently, the API does not implement any authentication mechanisms. Make sure to allow/deny access at the transport level
To start the RESTful API for testing/development purposes run :
wmapi
The API documentation will then be available at http://127.0.0.1:8000/docs
Uvicorn should be used to enable SSL and run the API in production. See this dockerfile for an example.
Deploying to the Cloud (™)
Since WitnessMe has a RESTful API now, you can deploy it to the magical cloud and perform scanning from there. This would have a number of benefits, including giving you a fresh external IP on every scan (More OPSEC safe when assessing attack surface on Red Teams).
There are a number of ways of doing this, you can obviously do it the traditional way (e.g. spin up a machine, install docker etc..).
Recently cloud service providers started offering ways of running Docker containers directly in a fully managed environment. Think of it as serverless functions (e.g. AWS Lambdas) only with Docker containers.
This would technically allow you to really quickly deploy and run WitnessMe (or really anything in a Docker container) without having to worry about underlying infrastructure and removes a lot of the security concerns that come with that.
Below are some of the ones I've tried along with the steps necessary to get it going and any issues I encountered.
GCP Cloud Run
Cloud Run is by far the easiest of these services to work with.
This repository includes the cloudbuild.yaml
file necessary to get this setup and running.
Unfortunately, it seems like Cloud Run doesn't allow outbound internet access to containers, if anybody knows of a way to get around this please get in touch
From the repositories root folder (after you authenticated and setup a project), these two commands will automatically build the Docker image, publish it to the Gcloud Container Registry and deploy a working container to Cloud Run:
gcloud builds submit --config cloudbuild.yaml
gcloud run deploy --image gcr.io/$PROJECT_ID/witnessme --platform managed
The output will give you a HTTPS url to invoke the WitnessMe RESTful API from :)
When you're done:
gcloud run services delete witnessme
gcloud container images delete gcr.io/$PROJECT_ID/witnessme
AWS ECS/Fargate
TO DO
Usage and Examples
There are 3 main tools:
witnessme
: is the main CLI interface.wmdb
: allows you to browse the database (created on each scan) to view results and generate reports.wmapi
: provides a RESTful API to schedule, start, stop and monitor scans.
usage: witnessme [-h] [-p PORTS [PORTS ...]] [--threads THREADS] [--timeout TIMEOUT] target [target ...]
positional arguments:
target The target IP(s), range(s), CIDR(s) or hostname(s)
optional arguments:
-h, --help show this help message and exit
-p PORTS [PORTS ...], --ports PORTS [PORTS ...]
Ports to scan if IP Range/CIDR is provided (default: [80, 8080, 443, 8443])
--threads THREADS Number of concurrent threads (default: 25)
--timeout TIMEOUT Timeout for each connection attempt in seconds (default: 15)
Can accept a mix of .Nessus file(s), Nmap XML file(s), files containing URLs and/or IPs, IP addresses/ranges/CIDRs and URLs. Long story short, should be able to handle anything you throw at it:
witnessme 192.168.1.0/24 192.168.1.10-20 https://bing.com ~/my_nessus_scan.nessus ~/my_nmap_scan.xml ~/myfilewithURLSandIPs
Note: as of writing, WitnessMe detects .Nessus and NMap files by their extension so make sure Nessus files have a .nessus
extension and NMap scans have a .xml
extension
If an IP address/range/CIDR is specified as a target, WitnessMe will attempt to screenshot HTTP & HTTPS pages on ports 80, 8080, 443, 8443 by default. This is customizable with the --port
argument.
Once a scan is completed, a folder with all the screenshots and a database will be in the current directory, point wmdb.py
to the database in order to see the results.
wmdb scan_2019_11_05_021237/
Pressing tab will show you the available commands and a help menu:
Searching the Database
The servers
and hosts
commands in the wmdb
CLI accept 1 argument. WMCLI is smart enough to know what you're trying to do with that argument
Server Command
No arguments will show all discovered servers. Passing it an argument will search the title
and server
columns for that pattern (it's case insensitive).
For example if you wanted to search for all discovered Apache Tomcat servers:
servers tomcat
orservers 'apache tomcat'
Similarly if you wanted to find servers with a 'login' in the title:
servers login
Hosts Command
No arguments will show all discovered hosts. Passing it an argument will search the IP
and Hostname
columns for that pattern (it's case insensitive). If the value corresponds to a Host ID it will show you the host information and all of the servers discovered on that host which is extremely useful for reporting purposes and/or when targeting specific hosts.
Signature Scan
You can perform a signature scan on all discovered services using the scan
command.
Generating Reports
You can use the generate_report
command in the wmdb
cli to generate reports in HTML or CSV format. To generate a HTML report simply run generate_report
without any arguments. Here's an example of what it'll look like:
To generate a CSV report:
WMDB ≫ generate_report csv
The reports will then be available in the scan folder.
Preview Screenshots Directly in the Terminal
Note: this feature will only work if you're on MacOSX and using ITerm2
You can preview screenshots directly in the terminal using the show
command:
Call for Signatures!
If you run into a new webapp write a signature for it! It's beyond simple and they're all in YAML!
Don't believe me? Here's the AirOS signature (you can find them all in the signatures directory):
credentials:
- password: ubnt
username: ubnt
name: AirOS
signatures:
- airos_logo.png
- form enctype="multipart/form-data" id="loginform" method="post"
- align="center" class="loginsubtable"
- function onLangChange()
# AirOS ubnt/ubnt
Yup that's it. Just plop it in the signatures folder and POW! Done.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for WitnessMe-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0727c4dadb23ad2f99203bd9f046b1eab205877f32f87b80fec0bb5941304b36 |
|
MD5 | 6f02df87ef7969c0cfc0934ae5505815 |
|
BLAKE2b-256 | 61fca16f6b555c4c0fdd6f50c34294cdb98b55d81b6bf0475729786a0abad990 |