Skip to content

imharshitaa/toolkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

27 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

ToolKit

Cloud-based Cybersecurity Products Implementation Solutions

Python 3.8+ License: MIT

A comprehensive CLI framework for deploying, configuring, and managing enterprise cybersecurity tools across multiple domains including SOC/SIEM, EDR/XDR, Network Security, Application Security, Cloud Security, and more.

Features

  • Multi-Domain Support: SOC, EDR, Network, Application, Cloud, VM, AI Security
  • Cloud-Native: Deploy to AWS, Azure, GCP, Kubernetes, or Docker
  • Attack Simulation: Built-in MITRE ATT&CK scenarios for detection testing
  • Professional Reports: Generate executive and technical security reports
  • Extensible Architecture: Easy to add new tools and modules
  • Open Source First: Prioritizes open-source alternatives alongside enterprise tools

πŸ“‹ Table of Contents

🎯 Quick Start

# Clone repository
git clone https://github.com/imharshitaa/toolkit.git
cd toolkit

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

# Install dependencies
pip install -r requirements.txt

# Install ToolKit CLI
pip install -e .

# Verify installation
toolkit --version

# Deploy your first tool (Splunk via Docker)
toolkit deploy soc splunk --environment docker

# Access Splunk Web UI at http://localhost:8000
# Default credentials: admin / changeme

πŸ“¦ Installation

Prerequisites

  • Python 3.8 or higher
  • Docker (for containerized deployments)
  • AWS CLI (for AWS deployments)
  • kubectl (for Kubernetes deployments)
  • Terraform (for infrastructure as code)

Install from Source

git clone https://github.com/imharshitaa/toolkit.git
cd toolkit
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt
pip install -e .

Install via pip (coming soon)

pip install toolkit-cybersec

πŸ› οΈ Supported Tools

SOC / SIEM

Tool Type Description
Splunk Enterprise Leading SIEM platform
Microsoft Sentinel Cloud Cloud-native SIEM
IBM QRadar Enterprise Security analytics platform
Elastic Open Source Elasticsearch-based SIEM
Wazuh Open Source Open source security monitoring

EDR / XDR

Tool Type Description
CrowdStrike Falcon Enterprise Cloud-native endpoint protection
SentinelOne Enterprise AI-powered endpoint security
Microsoft Defender Enterprise Endpoint detection and response
Wazuh Open Source Open source EDR solution

Network Security

Tool Type Description
Palo Alto Enterprise Next-generation firewall
Fortinet Enterprise FortiGate security appliance
Cisco Secure Enterprise Network security solutions
OPNsense Open Source Open source firewall
pfSense Open Source FreeBSD-based firewall

Application Security

Tool Type Description
Burp Suite Enterprise Web application security testing
OWASP ZAP Open Source Penetration testing tool
Nuclei Open Source Vulnerability scanner
Postman Tool API security testing

Cloud Security

Tool Type Description
AWS GuardDuty Cloud AWS threat detection
Security Hub Cloud AWS security posture management
Prisma Cloud Enterprise Palo Alto cloud security
Mandiant Enterprise Google Cloud security

Vulnerability Management

Tool Type Description
Tenable Nessus Enterprise Vulnerability scanner
Qualys Enterprise Cloud-based VM platform
Rapid7 Enterprise Nexpose vulnerability management
OpenVAS Open Source Open source scanner

πŸ’» Usage

Basic Commands

# Check system status and dependencies
toolkit status

# List available tools for a module
toolkit list-tools soc
toolkit list-tools edr
toolkit list-tools appsec

# Get help for any command
toolkit --help
toolkit deploy --help
toolkit scan --help

Deployment Examples

Deploy Splunk (Docker)

toolkit deploy soc splunk --environment docker

Deploy to AWS

toolkit deploy soc splunk \
  --environment aws \
  --region us-east-1 \
  --instance-type t3.xlarge

Deploy to Kubernetes

toolkit deploy edr wazuh --environment kubernetes

Deploy with Custom Configuration

toolkit deploy soc splunk \
  --config-file ./configs/splunk-prod.yaml \
  --environment aws \
  --auto-approve

Scanning and Testing

Run Application Security Scan

toolkit scan appsec zap \
  --target https://example.com \
  --scan-type full \
  --output results.json

Run Vulnerability Scan

toolkit scan vm tenable \
  --target 192.168.1.0/24 \
  --scan-type compliance \
  --format html

Run Attack Simulation

# Simulate MITRE ATT&CK techniques
toolkit scan soc splunk \
  --target localhost:8088 \
  --simulate \
  --scenario brute_force

Report Generation

# Generate PDF security report
toolkit report soc splunk \
  --format pdf \
  --template executive

# Generate technical report with screenshots
toolkit report appsec zap \
  --format html \
  --template technical \
  --include-screenshots

# Generate compliance report
toolkit report vm tenable \
  --format docx \
  --compliance-framework nist \
  --severity-filter critical

Dashboard Access

# Open tool dashboard in browser
toolkit open soc splunk
toolkit open appsec zap
toolkit open cloudsec guardduty

# Print URL instead of opening browser
toolkit open soc splunk --print-url

# Connect to custom host
toolkit open soc splunk --host 192.168.1.10 --port 8000

πŸ—οΈ Architecture

toolkit/
β”‚
β”œβ”€β”€ toolkit/              # Core CLI engine
β”‚   β”œβ”€β”€ cli.py           # Main CLI entry point
β”‚   β”œβ”€β”€ core.py          # Execution engine
β”‚   β”œβ”€β”€ deploy.py        # Deployment logic
β”‚   β”œβ”€β”€ scan.py          # Scanning logic
β”‚   β”œβ”€β”€ report.py        # Report generation
β”‚   β”œβ”€β”€ open_dashboard.py # Dashboard opener
β”‚   └── utils.py         # Helper functions
β”‚
β”œβ”€β”€ modules/             # Security domain modules
β”‚   β”œβ”€β”€ SOC/            # SIEM tools
β”‚   β”‚   β”œβ”€β”€ splunk/
β”‚   β”‚   β”‚   β”œβ”€β”€ config.py      # Configuration
β”‚   β”‚   β”‚   β”œβ”€β”€ deploy.py      # Deployment logic
β”‚   β”‚   β”‚   β”œβ”€β”€ simulate.py    # Attack simulation
β”‚   β”‚   β”‚   β”œβ”€β”€ detections.md  # Detection rules
β”‚   β”‚   β”‚   └── README.md      # Documentation
β”‚   β”‚   β”œβ”€β”€ qradar/
β”‚   β”‚   └── elastic/
β”‚   β”‚
β”‚   β”œβ”€β”€ APPSEC/         # Application security
β”‚   β”œβ”€β”€ CLOUDSEC/       # Cloud security
β”‚   β”œβ”€β”€ NETSEC/         # Network security
β”‚   β”œβ”€β”€ EDR/            # Endpoint detection
β”‚   β”œβ”€β”€ VM/             # Vulnerability management
β”‚   └── AISEC/          # AI-powered security
β”‚
└── labs/               # Lab environments
    β”œβ”€β”€ docker/         # Docker Compose setups
    β”œβ”€β”€ terraform/      # IaC templates
    └── k8s/           # Kubernetes manifests

Module Structure

Each security tool follows a consistent structure:

tool_name/
β”œβ”€β”€ config.py         # Tool configuration
β”œβ”€β”€ deploy.py         # Deployment implementation
β”œβ”€β”€ simulate.py       # Attack/test simulation (optional)
β”œβ”€β”€ detections.md     # Detection rules (SIEM/EDR)
└── README.md         # Tool-specific documentation

πŸ”¬ Labs and Testing

Docker Lab Environment

cd labs/docker
docker-compose up -d

# Access services:
# Splunk: http://localhost:8000
# ZAP: http://localhost:8080
# Wazuh: http://localhost:5601
# Kibana: http://localhost:5602

AWS Infrastructure

cd labs/terraform
terraform init
terraform plan
terraform apply

# Outputs will show:
# - Splunk public IP
# - GuardDuty detector ID
# - CloudTrail ARN

Attack Simulation

The toolkit includes built-in attack simulations based on MITRE ATT&CK:

# Brute force attack (T1110)
toolkit scan soc splunk --simulate --scenario brute_force

# Lateral movement (T1021)
toolkit scan soc splunk --simulate --scenario lateral_movement

# Data exfiltration (T1048)
toolkit scan soc splunk --simulate --scenario data_exfiltration

πŸ”§ Development

Setting Up Development Environment

# Clone repository
git clone https://github.com/imharshitaa/toolkit.git
cd toolkit

# Create virtual environment
python3 -m venv venv
source venv/bin/activate

# Install in development mode
pip install -e ".[dev]"

# Install pre-commit hooks
pre-commit install

Running Tests

# Run all tests
pytest

# Run with coverage
pytest --cov=toolkit --cov-report=html

# Run specific test file
pytest tests/test_cli.py -v

# Run tests for a specific module
pytest tests/test_cli.py::TestCLI::test_version_command

Code Quality

# Format code
black toolkit/ modules/ tests/

# Lint code
flake8 toolkit/ modules/ tests/

# Type checking
mypy toolkit/

# Security scan
bandit -r toolkit/

Adding a New Tool

  1. Create module directory:
mkdir -p modules/MODULE_NAME/tool_name
  1. Create required files:
touch modules/MODULE_NAME/tool_name/config.py
touch modules/MODULE_NAME/tool_name/deploy.py
touch modules/MODULE_NAME/tool_name/README.md
  1. Implement config.py:
def get_config(environment: str = 'docker') -> dict:
    return {
        'tool_config': {...},
        'deployment': {...}
    }

def validate() -> bool:
    # Validation logic
    return True
  1. Implement deploy.py:
def execute(**kwargs) -> bool:
    # Deployment logic
    return True
  1. Add tool to core.py in get_available_tools() function

  2. Test your implementation:

toolkit deploy module_name tool_name --dry-run

πŸ“š Documentation

Ways to Contribute

  • πŸ› Report bugs and issues
  • πŸ’‘ Suggest new features
  • πŸ“ Improve documentation
  • πŸ”§ Add new tool modules
  • βœ… Write tests

Development Workflow

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Run tests (pytest)
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Open a Pull Request

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

Acknowledgments

  • MITRE ATT&CK Framework
  • OWASP Foundation
  • Splunk Community
  • All open-source security tool maintainers

Support

πŸ—ΊοΈ Roadmap

  • Add support for more SIEM platforms (Sumo Logic, LogRhythm)
  • Implement SOAR integration (Tines, Shuffle, Phantom)
  • Add compliance frameworks (SOC 2, PCI-DSS, HIPAA)
  • Create web UI dashboard
  • Add API for programmatic access
  • Implement machine learning-based threat detection
  • Support for hybrid cloud deployments
  • Integration with threat intelligence feeds

Made by imharshitaa

⭐ Star on GitHub if you find this project useful!

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors