# abdalsattar-sys/penetration-testing-tools architecture

> Architecture diagram of the GitHub repository abdalsattar-sys/penetration-testing-tools, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-11). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/abdalsattar-sys/penetration-testing-tools
- Repository: https://github.com/abdalsattar-sys/penetration-testing-tools

## Overview

##### Project type and purpose
- This is a Python-based CLI penetration-testing toolkit comprising three standalone tools:
- Simple Port Scanner (port_scanner.py)
- Advanced Port Scanner (advanced_port_scanner.py)
- Basic Vulnerability Scanner (vulnerability_scanner.py)
- Purpose: educational and security auditing—scan target hosts for open ports and common web vulnerabilities, optionally persisting results.

##### File structure
- Top-level files only: three scripts plus a requirements.txt and README.md.
- No shared “src” or “lib” directory—each tool is self-contained.
- Requirements.txt lists third-party dependencies (requests).
- No build/deployment artifacts—CLI invocation only.

##### README for additional insights
- Confirms feature set of each tool and command-line options.
- Mentions core libraries used (socket, threading, argparse, json, ssl, requests).
- Points out extension points: common_services dictionary, add-vulnerability functions.

##### Key to capturing essential details
- Separate flows for simple vs. advanced scanning (single-thread vs. multi-thread + JSON)
- Vulnerability scanner’s HTTP sequence and checks (headers, file enumeration, SSL tests)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External User
    UserCLI["User CLI"]:::external

    %% Simple Port Scanner Module
    subgraph "Simple Port Scanner"
        direction TB
        SPScript["Simple Port Scanner (port_scanner.py)"]:::script
        SP_Arg["ArgumentParser"]:::core
        SP_Engine["Port Scanner Core"]:::core
        SP_Output["Output Handler"]:::core
        SPScript -->|parses args| SP_Arg
        SP_Arg -->|invokes| SP_Engine
        SP_Engine -->|scans| Network
        SP_Engine -->|sends results| SP_Output
        SP_Output -->|writes to| Console
    end

    %% Advanced Port Scanner Module
    subgraph "Advanced Port Scanner"
        direction TB
        APScript["Advanced Port Scanner (advanced_port_scanner.py)"]:::script
        AP_Arg["ArgumentParser"]:::core
        AP_Engine["Thread-pooled ScanEngine"]:::core
        Services["common_services (plugin)"]:::core
        JSONWriter["JSON Writer"]:::core
        APScript -->|parses args| AP_Arg
        AP_Arg -->|invokes| AP_Engine
        Services -->|lookup| AP_Engine
        AP_Engine -->|scans| Network
        AP_Engine -->|outputs JSON| JSONWriter
        JSONWriter -->|writes to| JSONFile
        AP_Engine -->|sends results| Console
    end

    %% Vulnerability Scanner Module
    subgraph "Vulnerability Scanner"
        direction TB
        VScript["Basic Vulnerability Scanner (vulnerability_scanner.py)"]:::script
        V_Arg["ArgumentParser"]:::core
        V_Engine["HTTP(S) Vulnerability Engine"]:::core
        V_Output["Output Handler"]:::core
        VScript -->|parses args| V_Arg
        V_Arg -->|invokes| V_Engine
        V_Engine -->|sends HTTP/S requests| Network
        V_Engine -->|processes responses| V_Output
        V_Output -->|writes to| Console
        V_Output -->|writes to| JSONFile
    end

    %% Shared External and Storage
    Network["Network Targets"]:::external
    Console["Console Output"]:::external
    JSONFile["JSON File"]:::storage

    %% Documentation and Dependencies
    Requirements["requirements.txt"]:::storage
    README["README.md"]:::storage

    %% User CLI triggers each script
    UserCLI --> SPScript
    UserCLI --> APScript
    UserCLI --> VScript

    %% Click Events
    click SPScript "https://github.com/abdalsattar-sys/penetration-testing-tools/blob/main/port_scanner.py"
    click APScript "https://github.com/abdalsattar-sys/penetration-testing-tools/blob/main/advanced_port_scanner.py"
    click VScript "https://github.com/abdalsattar-sys/penetration-testing-tools/blob/main/vulnerability_scanner.py"
    click Requirements "https://github.com/abdalsattar-sys/penetration-testing-tools/blob/main/requirements.txt"
    click README "https://github.com/abdalsattar-sys/penetration-testing-tools/blob/main/README.md"

    %% Class Definitions
    classDef script fill:#AED6F1,stroke:#1F618D,color:#1B2631;
    classDef core fill:#ABEBC6,stroke:#196F3D,color:#145A32;
    classDef external fill:#D5D8DC,stroke:#566573,color:#1B2631;
    classDef storage fill:#F9E79F,stroke:#B7950B,color:#1B2631;
```
