Skip to content

webixly/Cyber-Tool

Repository files navigation

🛡️ Webixly Cyber Tool

Python License Stars Forks Issues Last Commit Release Build Coverage


⚠️ Legal & Ethical Notice This project is intended strictly for educational purposes and controlled lab environments. Do NOT use it against any system you do not own or lack explicit permission to test. The author assumes no responsibility for misuse.


📌 Quick Summary

Webixly Cyber Tool is an educational Python-based tool designed to provide safe utilities for cybersecurity learning and lab-based training. This repository contains non-destructive utilities for learning, CTF practice, and red-team exercises — all designed to be safe by default.


🚀 Overview

Webixly Cyber Tool offers educational cybersecurity utilities for:

  • Controlled red-team practice in isolated labs
  • CTF (Capture The Flag) challenges and training
  • Classroom exercises and workshops on network concepts and defensive detection
  • Safe simulations of common reconnaissance techniques (configured to run in --test-mode only)

Important: Offensive capabilities such as DDoS or unauthorized exploitation are not included in public releases. Any scanning or probing features are intentionally limited to safe, permissioned, and auditable modes.


✨ Features (Safe-by-default)

  • 🔎 IP & DNS lookup – passive lookups using public, non-intrusive sources
  • 📡 Server information retrieval – collection of public metadata for lab servers (e.g., service banners)
  • 🔍 Safe port discovery — low-rate, permissioned scans with explicit --test-mode and allowlist checks
  • 📜 Allowlist & logging — require explicit target allowlists and generate detailed logs for auditing
  • 🔒 Configuration-driven — all potentially intrusive behavior must be enabled in config and is off by default
  • 🧪 Simulation modules — simulated vulnerability checks for training without performing real exploitation

⚙️ Installation

# Clone the repository
git clone https://github.com/webixly/Cyber-Tool.git
cd Cyber-Tool

# Create virtual environment (recommended)
python3 -m venv .venv
source .venv/bin/activate   # On Windows: .venv\Scripts\activate

# Install requirements
pip install -r requirements.txt

▶️ Quickstart (Safe mode)

All commands below run the tool in test / lab mode. Do not use against external systems.

# Display help and global options
python CyberTool.py --help
python CyberTool.py

# Run a safe information-gathering job (requires allowlist config)
python Cyber-tool.py gather --config config/example-allowlist.yml --test-mode
  • --test-mode must be present for any reconnaissance or scan command.
  • Ensure config/example-allowlist.yml lists only IPs/hosts you control or have explicit permission to test.

🛠️ Configuration

  • config/default.yml — global defaults (test mode = true)
  • config/example-allowlist.yml — permitted targets for lab runs

Always review configuration files before running the tool. Sensitive options are disabled by default.


🧪 Testing

Run the included unit & integration tests locally:

pytest tests/ --maxfail=1 -q

Tests exercise simulation code and safe parsing logic. They do not perform destructive network actions.


📚 Contributing

Contributions are welcome under the following rules:

  1. Keep changes educational and non-destructive by default.
  2. New features must include tests and documentation.
  3. Any code that could be used offensively must include a clear safety rationale and be gated behind explicit config options.
  4. Follow the repository's CODE_OF_CONDUCT.md and CONTRIBUTING.md.

🧾 License

This project is released under the MIT License. See LICENSE for details.


📬 Contact / Support

  • Maintainer: Webixly
  • Issues & feature requests: use GitHub Issues

About

Safe and educational cybersecurity tool built with Python for labs and learning.

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages