# gorkaaaa/sublisting architecture

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

- Interactive diagram: https://gitdiagram.com/gorkaaaa/sublisting
- Repository: https://github.com/gorkaaaa/sublisting

## Overview

##### Project Type & Purpose
- The project is a specialized security/reconnaissance tool aimed at subdomain enumeration and validation.
- Its main task is to orchestrate a set of external subdomain scanning tools via scripts and then validate the results.
- Because of its script-based nature (Bash and Python integration) and reliance on external utilities, the project can be seen as a lightweight automation pipeline tool.

##### File Structure
- The repository consists of a README.md (project description), an installation script (install.sh) to set up dependencies, a main Bash script (Sublisting.sh) which coordinates the subdomain collection, and a Python script (finder.py) responsible for verifying subdomain accessibility.
- The structure indicates that the architecture is centered around a sequential pipeline or orchestration, where each script plays a specific role in gathering and processing data.

##### Insights from the README
- The README clearly lays out the steps to install the environment using install.sh and then to run the pipeline (Sublisting.sh and finder.py).
- It describes the collection process for subdomains and emphasizes the aesthetic clean output following filtering and verification.

##### Main Components and Their Roles
a. User Input:
- The domain provided by the user when running the Sublisting.sh script.
b. Installation Environment:
c. Subdomain Enumeration Module (Sublisting.sh):
- Acts as the coordinator that triggers external tools to gather subdomains.
- It pipes data from various tools into a common list, performing filtering and formatting.
d. Subdomain Verification Module (finder.py):
- Takes the collected subdomains and checks their accessibility/validity.
- Runs as a validation stage, refining results to offer clean output.
e. External Tools:
f. Output:
- The final result – a validated, formatted list of subdomains.

##### Relationships and Interactions
- User provides the domain → Sublisting.sh script is executed.
- Sublisting.sh sequentially calls multiple external tools (via system calls) to perform subdomain collection.
- The output from Sublisting.sh is then passed (directly or indirectly) to finder.py for verification.
- The final, cleaned output is produced for the user.
- The install.sh script (executed initially) ensures that all required external tools are installed.

##### Architectural Patterns & Design Principles
- A pipeline/chain-of-command pattern: each script forms a stage (collection followed by validation).
- Separation of Concerns: distinct scripts handle installation (environment setup), collection (orchestration of enumeration), and verification (accessibility testing).
- Integration with external utilities: the project minimally wraps around third-party tools, reflecting a modular design.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Installation Phase
    subgraph "Installation Phase"
        A("User Input"):::user
        B("install.sh (Setup Script)"):::script
        click B "https://github.com/gorkaaaa/sublisting/blob/main/install.sh"
        C("README.md (Documentation)"):::doc
        click C "https://github.com/gorkaaaa/sublisting/blob/main/README.md"
    end

    %% Enumeration Phase
    subgraph "Enumeration Phase"
        D("Sublisting.sh (Orchestration)"):::script
        click D "https://github.com/gorkaaaa/sublisting/blob/main/Sublisting.sh"
        E("External Tools (subfinder,amass,sublist3r,httpx,socialhunter)"):::external
    end

    %% Verification Phase
    subgraph "Verification Phase"
        F("finder.py (Verification)"):::script
        click F "https://github.com/gorkaaaa/sublisting/blob/main/finder.py"
        G("Final Validated Output"):::output
    end

    %% Data Flow
    A -->|"providesDomain"| B
    B -->|"environmentSetup"| C
    B -->|"triggersEnumeration"| D
    D -->|"callsTools"| E
    E -->|"aggregatesResults"| F
    F -->|"producesOutput"| G

    %% Styles
    classDef user fill:#FFCC00,stroke:#333,stroke-width:2px;
    classDef script fill:#66CCFF,stroke:#333,stroke-width:2px;
    classDef doc fill:#FF9966,stroke:#333,stroke-width:2px;
    classDef external fill:#99CC66,stroke:#333,stroke-width:2px;
    classDef output fill:#CCFFCC,stroke:#333,stroke-width:2px;
```
