spidex

spidex copied to clipboard

Current release: v4.0.0 developed by @alechilczenko

Note: Docker images will be released in the coming weeks.

Table of contents

• Guide
  • English
  • Spanish
• Introduction
• Engine
  • Threads
  • Options
  • Examples
  • Visual
• API
  • Routes
• Deployment
  • Basic
  • Advanced
• Contributing
• Legal Disclaimer
• Contact
• License

Introduction

Spidex is a continuous reconnaissance scanner, which gives priority to proving network exposure. It performs large-scale port-oriented scanning and collects information from every device connected to the Internet.

Engine

The engine is responsible for massively analyzing IP addresses received as arguments. It collects public information about each target, such as: open ports, geographic location, web technologies and banners.

Also stores a report for every scan cycle, containing: Execution time, devices found and start/end date.

Threads

The implementation of threads and queues increases performance during scanning. In this way, requests are sent in parallel and the execution time for each cycle is significantly reduced. It currently has a limit of 450/500 threads.

Options

options:
  -h, --help            show this help message and exit
  -r RANGE, --range RANGE
                        Start IPv4 address
  -t THREADS, --threads THREADS
                        Number of threads [Default: 50]
  -f, FILE, --file      File path with IPv4 ranges
  -ti TIMEOUT, --timeout TIMEOUT
                        Socket timeout [Default: 0.5]
  -p, --top-ports       Scan only 20 most used ports
  -a, --all-ports       Scan 1000 most used ports
  -c CUSTOM [CUSTOM ...], --custom-ports CUSTOM [CUSTOM ...]
                        Scan custom ports directly from terminal
  -l, --logs            Add a log file, useful in debugging

Examples

Scan only a single IPv4 address range with most used ports by default:

python3 engine.py -r 192.168.0.0,192.168.0.255 -t 150 --top-ports

Scan from a text file with multiple IPv4 address ranges and socket timeout of seconds:

python3 engine.py -m ranges.csv -t 200 -ti 5 --all-ports

Scan with CIDR, custom ports and logs option:

python3 engine.py -r 192.168.0.0/255 -t 350 -C 80 21 22 --logs

Visual

API

It consists of a Flask application, which allows to store and perform any operation on the results sent by the search engine. It uses MongoDB as a database, it is ideal because the data is not structured.

Routes

Deployment

The deployment of both components is performed with Docker, for easier installation and to avoid contaminating the environment with dependencies. You can download the images from DockerHub.

Basic

For a basic deployment, set the environment variables for each image, in the Docker Compose files

MongoDB

MONGO_INITDB_ROOT_USERNAME: USERNAME
MONGO_INITDB_ROOT_PASSWORD: PASSWORD

API

DB_SERVER_NAME: MONGODB_SERVER 
DB_USERNAME: MONGODB_USER
DB_PASSWORD: MONGODB_PASSWORD

Engine

SERVER_ADDRESS: API_SERVER

Advanced

The integration of Elasticsearch and Kibana allows to have a graphical interface to visualize and manipulate data in an efficient way.

Currently the project does not have a way to insert data automatically. But you can use tools such as: Mongo-to-elastic-dump, and generate some interesting graphs in your local machine after complete scan cycle.

Contributing

If you have ideas or future features, feel free to participate to continue making this project great.

Legal Disclaimer

This project is made for educational and ethical testing purposes only. Usage of this software for attacking targets without prior mutual consent is illegal. It is the end user's responsibility to obey all applicable local, state and federal laws. Developers assume no liability and are not responsible for any misuse or damage caused by this program.

Contact

[email protected]

License

Apache 2.0