# amsou-ismail/penaut architecture

> Architecture diagram of the GitHub repository amsou-ismail/penaut, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-15). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/amsou-ismail/penaut
- Repository: https://github.com/amsou-ismail/penaut

## Overview

##### Project type and purpose
- From the file tree and README, PenAut Toolkit is a Python-based, command‐line penetration testing automation toolkit.
- It bundles multiple security modules (network scanning, port scanning, subdomain enumeration, hash cracking, CVE lookup, Shodan integration, Pwned DB checks) into one CLI wrapper.

##### File structure
- Top‐level files:
- README.md, requirement.txt, setup.sh (installation & metadata)
- PenAut_pack/ (all functional modules + main orchestrator)
- Under PenAut_pack/:
- main.py – entry point for the CLI tool (“sudo PenAut”)
- tool_style.py – shared styling/output formatting
- network_scanner.py, port_scanner.py, url_enum.py – discovery modules
- hashcracker.py – offline hash cracking
- cve_scan.py, cve_search.py – querying CVE databases
- shodan_scan.py – Shodan API integration
- passpwnd.py – “Have I Been Pwned” password breach check

##### README for additional insights
- Enumerates supported features and usage pattern (single CLI, root prerequisites for low‐level operations).

## Diagram (Mermaid)

```mermaid
graph TD
    subgraph "Installation & Metadata"
        READ["README.md"]:::doc
        REQ["requirement.txt"]:::doc
        SETUP["setup.sh"]:::doc
    end

    subgraph "Runtime Environment"
        Python["Python 3 Interpreter\nOS Privilege Boundary"]:::env
    end

    CLI["CLI Interface\n(main.py)"]:::core
    UTIL["Shared Utilities\n(tool_style.py)"]:::util

    subgraph "Discovery Modules"
        NS["Network Scanner\n(network_scanner.py)"]:::core
        PS["Port Scanner\n(port_scanner.py)"]:::core
        UE["URL Enumeration\n(url_enum.py)"]:::core
    end

    subgraph "Cracking & Breach Modules"
        HC["Hash Cracker\n(hashcracker.py)"]:::core
        PW["Have I Been Pwned Check\n(passpwnd.py)"]:::core
    end

    subgraph "CVE Modules"
        CS["CVE Scanner\n(cve_scan.py)"]:::core
        CE["CVE Search\n(cve_search.py)"]:::core
    end

    subgraph "External API Module"
        SH["Shodan Integration\n(shodan_scan.py)"]:::core
    end

    subgraph "External Services"
        NET["Network Targets\n(raw sockets)"]:::external
        CVEAPI["CVE API\n(HTTPS)"]:::external
        SHODAN["Shodan API\n(HTTPS)"]:::external
        PWNED["HaveIBeenPwned API\n(HTTPS)"]:::external
    end

    READ -->|metadata| CLI
    REQ -->|depends on| CLI
    SETUP -->|installs| CLI

    Python -->|runs| CLI

    CLI -->|invokes| NS
    CLI -->|invokes| PS
    CLI -->|invokes| UE
    CLI -->|invokes| HC
    CLI -->|invokes| PW
    CLI -->|invokes| CS
    CLI -->|invokes| CE
    CLI -->|invokes| SH

    NS -->|formats output| UTIL
    PS -->|formats output| UTIL
    UE -->|formats output| UTIL
    HC -->|formats output| UTIL
    PW -->|formats output| UTIL
    CS -->|formats output| UTIL
    CE -->|formats output| UTIL
    SH -->|formats output| UTIL

    NS -->|scans via raw sockets| NET
    PS -->|scans via raw sockets| NET
    UE -->|HTTP discovery| NET

    CS -->|queries| CVEAPI
    CE -->|queries| CVEAPI
    SH -->|queries| SHODAN
    PW -->|queries| PWNED

    click CLI "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/main.py"
    click UTIL "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/tool_style.py"
    click NS "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/network_scanner.py"
    click PS "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/port_scanner.py"
    click UE "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/url_enum.py"
    click HC "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/hashcracker.py"
    click PW "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/passpwnd.py"
    click CS "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/cve_scan.py"
    click CE "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/cve_search.py"
    click SH "https://github.com/amsou-ismail/penaut/blob/main/PenAut_pack/shodan_scan.py"
    click READ "https://github.com/amsou-ismail/penaut/blob/main/README.md"
    click REQ "https://github.com/amsou-ismail/penaut/blob/main/requirement.txt"
    click SETUP "https://github.com/amsou-ismail/penaut/blob/main/setup.sh"

    classDef core fill:#D6EAF8,stroke:#3498DB
    classDef util fill:#D5F5E3,stroke:#27AE60
    classDef external fill:#E5E7E9,stroke:#7F8C8D
    classDef doc fill:#FCF3CF,stroke:#F1C40F
    classDef env fill:#FADBD8,stroke:#E74C3C
```
