https://github.com/arsho/cbpen
Cloud Blazers Penetration Testing Tool
https://github.com/arsho/cbpen
Last synced: 2 months ago
JSON representation
Cloud Blazers Penetration Testing Tool
- Host: GitHub
- URL: https://github.com/arsho/cbpen
- Owner: arsho
- Created: 2021-10-11T05:38:59.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-11-08T17:36:38.000Z (over 3 years ago)
- Last Synced: 2025-05-29T21:05:31.579Z (about 1 year ago)
- Language: HTML
- Size: 20.7 MB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# CBPen
Cloud Blazers Penetration Testing Tool
### Project checklist
✓ Must provide a web based or mobile app based interface.
✓ User enters a range of IP addresses to scan, and selects from many different scanning options.
✓ The cloud based server/monitor then splits the IP address ranges and distributes the task across multiple (at
least 3) virtual machines, SQS can be used to send the tasks to the scanner virtual machines.
✓ Each of the scanner virtual machines performs a scan for the range of IP addresses given and sends the scan
result back to the monitor.
✓ The monitor combines reports from multiple scanners and prepares a central report.
✓ Must support multiple concurrent users and require user authentication.
### Features
- Scan top ports
- Scan services
- Scan operating systems
- List subdomains
- Scan SSL certificates
- Expose vulnerabilities associated with the network (ports, OS, etc)
- Mitigation tool for developers to slow down the attacker
- Utilize multiple VMs in parallel reducing scan time and analysis
- Analytics report of all the scanning events
- Require authentication using cloud database technologies
### Demonstration video
[](https://docs.google.com/file/d/1MhJ2E8Q6y1K7hurqOsNAEy6C-UldAVgR/preview)
### Presentation
[Powerpoint presentation of CBPen](https://arshovon.com/presentations/CBPen.pdf)
### Execution time comparison
Comparison between parallel and nonparallel execution time. The time is measured in seconds.
| Scan type | Number of sites | Parallel execution time | Nonparallel execution time |
| --- | --- | --- | --- |
| Port | 6 | 3.29 | 11.93 |
| Services and operating systems | 6 | 39.88 | 161.02 |
| Subdomains and SSL certificates | 6 | 30.27 | 87.58 |
### System design:
- Scanning tool:
- Nmap - "Network Mapper" open source tool for network discovery & security auditing​
- Sublist3r - Subdomain listing tool
- SSLyze - SSL/TLS scanning tool
- TLS-Parser - Parse TLS information
- Requests - Gather metadata from the hosts
- Web application:
- Python & Flask - Provides REST APIs for concurrent scanning from multiple VMs
- SQLAlchemy - SQL Object Relational Mapper
- Cryptography - Used for cryptographic algorithms and encryptions/decryptions
- Dotenv - Sets environment variables based on the development or production environment
- Bootstrap & jQuery - Used for developing responsive frontend
- Docker with docker-compose - Creates docker containers for OS independent execution
- Cloud architecture:
## Local Setup
### Requirements
- Python 3
- Pip
- nmap:
Windows users should download and
install [latest stable release self-installer nmap-7.92-setup.exe](https://nmap.org/dist/nmap-7.92-setup.exe)
- Internet connection
### Install dependencies
- Clone the repository.
- Open a terminal / powershell in the cloned repository.
- Create a virtual environment and activate it. If you are using Linux / Mac.
- Based on your version of python you may have use the command py in place of python3 or python in the following
commands:
```commandline
python3 -m venv venv
source venv/bin/activate
```
Create and activate `venv` in Windows (Tested in Windows 10):
```commandline
python -m venv venv
Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser
.\venv\Scripts\Activate.ps1
```
After activate the terminal / powershell will have `(venv)` added to the prompt.
- Check `pip` version:
```commandline
pip --version
```
It should point to the `pip` in the activated `venv`.
- Install required packages:
```commandline
pip install -r requirements.txt
```
### Run the project
- Activate the `venv` if not activated:
Linux / Mac:
```commandline
source venv/bin/activate
```
Windows:
```commandline
.\venv\Scripts\Activate.ps1
```
- To run the project call `flask run` command. It will invoke the environment variables which are set
in [.flaskenv](./.flaskenv) file:
```commandline
flask run
```
- Look for localhost url and paste into any internet browser:
## Docker Setup
### Requirements
- Docker
- Docker compose
### Run the project
- Run the project using the following command:
```commandline
docker-compose build --no-cache
docker-compose up --force-recreate
```
- Access the web application from: [http://localhost:5000/](http://localhost:5000/)
- Down the project:
```commandline
docker-compose down
```
### Clean docker
- Check the running images:
```commandline
docker ps -a
```
- Remove any stopped containers and all unused images:
```commandline
docker system prune -a
```
### Clean package list
- List currently installed packages in a file:
```commandline
pip freeze > uninstall.txt
```
- Uninstall everything recursively:
```commandline
pip uninstall -r uninstall.txt -y
```
- Delete the uninstalled package list file:
```commandline
rm uninstall.txt
```
- Install everything recursively:
```commandline
pip install -r requirements.txt
```
### Sample of getting JSON API response:
- Get ports information of "example.com" or an IP:
```commandline
http://127.0.0.1:5000/portsjson?site=example.com
http://127.0.0.1:5000/portsjson?site=93.184.216.34
```
- Get service information of "example.com" or an IP:
```commandline
http://127.0.0.1:5000/servicesjson?site=example.com
http://127.0.0.1:5000/servicesjson?site=93.184.216.34
```
- Get subdomain and SSL information of "example.com" (No IP address is allowed):
```commandline
http://127.0.0.1:5000/subdomainsjson?site=example.com
```
### Developer notes
- After adding a new model, create an instance in db:
```commandline
from app import db
db.create_all()
```
- Update the VM's address in [configuration.py](controller.py) file.
## Cloud Blazers Team
- William Austin
- Andrew Balfour
- Jeremy Crown
- Trina Lin
- Ahmedur Rahman Shovon
### Reference
- [Docker compose tutorial](https://docs.docker.com/compose/gettingstarted/)
- [How To Remove Docker Images, Containers, and Volumes](https://www.digitalocean.com/community/tutorials/how-to-remove-docker-images-containers-and-volumes)
- [Writing a Basic Port Scanner in Python](https://westoahu.hawaii.edu/cyber/forensics-weekly-executive-summmaries/writing-a-basic-port-scanner-in-python/)
- [Icons class in template](https://icons.getbootstrap.com/)
- [Virtual environments for Flask app](https://flask.palletsprojects.com/en/2.0.x/installation/#virtual-environments)
- [Python3 nmap package](https://pypi.org/project/python3-nmap/)
- [Python nmap package](https://pypi.org/project/python-nmap/)
- [Latest stable release self-installer nmap-7.92-setup.exe](https://nmap.org/dist/nmap-7.92-setup.exe)
- [Sublist3r package](https://github.com/aboul3la/Sublist3r)
- [sslyze documentation](https://nabla-c0d3.github.io/sslyze/documentation/available-scan-commands.html#id15)
- [Requests future package](https://pypi.org/project/requests-futures/)
- [Jinja template documentation](https://jinja.palletsprojects.com/en/3.0.x/templates/#if-expression)
- [Flask SQLAlchemy documentation](https://flask-sqlalchemy.palletsprojects.com/en/2.x/quickstart/#a-minimal-application)