# komodoooo/some-things architecture

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

- Interactive diagram: https://gitdiagram.com/komodoooo/some-things
- Repository: https://github.com/komodoooo/some-things

## Overview

##### Project Type and Purpose
- The project is essentially a “toolkit” repository that aggregates various security scripts (written in languages such as Python, Ruby, Go, Bash, etc.) along with write-ups and payload collections.
- Its purpose is to provide a single resource that documents, demonstrates, and serves as a playground for various pen-testing utilities and proof-of-concept exploits. The README also points to an external blog (Terrons) that discusses parts of the repository.

##### Analyzing the File Structure
- Top-level Files: LICENSE, README.md, papers.md, and payloads.md are documentation and resource files.
- The “things” Directory: Contains a series of scripts (e.g., adb.sh, broski.rb, btw.py, etc.) for various testing tasks—from network sniffing to directory fuzzing and beyond.
- The diversity of file types (Python, Ruby, Go, Bash) indicates there isn’t a single runtime or framework but rather a collection of independent tools, each likely to be executed in its own context.

a. Central Repository Node:

b. Documentation and Resources:
- README.md (Main entry point for project overview and links)
- papers.md (Research papers and write-ups on vulnerabilities)
- payloads.md (Exploitation payload data)

c. Tools & Utilities (The “things” folder):
- Enclose the “things” folder as a major subcomponent.
- Within this, create nodes for each tool/script (e.g., Autoclicker, Basic SQL injection scanner, Directory fuzzer, etc.). You may group them by language or functionality if desired (e.g., “Web-related tools”, “Network tools”, “Exploit Tools”).
- For each tool, annotate key aspects such as the script’s language and its primary security function (e.g., “sexer-ssh.rb” for SSH brute-forcing, “ssl-scanner.rb” for SSL scanning).

d. External Resources:
- Similarly, include nodes for any external proof-of-concepts (linked CVEs) that show how the repository connects with real-world vulnerabilities.

##### Architectural Patterns and Design Principles
- Modularity of the repository: each tool/script functions as an independent module rather than a tightly coupled system.
- A “microservice” approach (conceptually) can be applied by treating each script as an independent component with its own inputs (arguments, external data) and outputs (reports, logs).
- Separation between “Documentation” components and “Tool” components to reflect their distinct roles.

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Repository"
        RD["Repository"]:::container

        subgraph "Documentation and Resources"
            READMEMD["README.md"]:::doc
            PAPERSMD["papers.md"]:::doc
            PAYLOADSMD["payloads.md"]:::doc
            LICENSEFILE["LICENSE"]:::doc
        end

        subgraph "Tools & Utilities"
            THINGS["things"]:::container
            ADB["adb.sh"]:::tool
            BROS["broski.rb"]:::tool
            BTW["btw.py"]:::tool
            CADE["cade.py"]:::tool
            CHICK["chick.py"]:::tool
            CHOLO["cholo.go"]:::tool
            DEA["deauth.py"]:::tool
            DIRFUZZ["dirfuzz.rb"]:::tool
            GUGOL["gugol.rb"]:::tool
            PYSNIFFER["pysniffer.py"]:::tool
            SEXER["sexer-ssh.rb"]:::tool
            SPINA["spina.py"]:::tool
            SSLSCAN["ssl-scanner.rb"]:::tool
            TENKAI["tenkai.rb"]:::tool
        end

        subgraph "External Resources"
            TERRONS["Terrons Blog"]:::external
        end
    end

    %% Connections from Repository to Documentation
    RD -->|"contains"| READMEMD
    RD -->|"contains"| PAPERSMD
    RD -->|"contains"| PAYLOADSMD
    RD -->|"contains"| LICENSEFILE

    %% Connections from Repository to Tools
    RD -->|"includes"| THINGS

    %% Connections for Tools inside things folder
    THINGS -->|"has"| ADB
    THINGS -->|"has"| BROS
    THINGS -->|"has"| BTW
    THINGS -->|"has"| CADE
    THINGS -->|"has"| CHICK
    THINGS -->|"has"| CHOLO
    THINGS -->|"has"| DEA
    THINGS -->|"has"| DIRFUZZ
    THINGS -->|"has"| GUGOL
    THINGS -->|"has"| PYSNIFFER
    THINGS -->|"has"| SEXER
    THINGS -->|"has"| SPINA
    THINGS -->|"has"| SSLSCAN
    THINGS -->|"has"| TENKAI

    %% Repository referencing external resources
    RD -->|"references"| TERRONS

    %% Click Events
    click RD "https://github.com/komodoooo/some-things/blob/main/."
    click READMEMD "https://github.com/komodoooo/some-things/blob/main/README.md"
    click PAPERSMD "https://github.com/komodoooo/some-things/blob/main/papers.md"
    click PAYLOADSMD "https://github.com/komodoooo/some-things/blob/main/payloads.md"
    click LICENSEFILE "https://github.com/komodoooo/some-things/tree/main/LICENSE"
    click THINGS "https://github.com/komodoooo/some-things/tree/main/things"
    click ADB "https://github.com/komodoooo/some-things/blob/main/things/adb.sh"
    click BROS "https://github.com/komodoooo/some-things/blob/main/things/broski.rb"
    click BTW "https://github.com/komodoooo/some-things/blob/main/things/btw.py"
    click CADE "https://github.com/komodoooo/some-things/blob/main/things/cade.py"
    click CHICK "https://github.com/komodoooo/some-things/blob/main/things/chick.py"
    click CHOLO "https://github.com/komodoooo/some-things/blob/main/things/cholo.go"
    click DEA "https://github.com/komodoooo/some-things/blob/main/things/deauth.py"
    click DIRFUZZ "https://github.com/komodoooo/some-things/blob/main/things/dirfuzz.rb"
    click GUGOL "https://github.com/komodoooo/some-things/blob/main/things/gugol.rb"
    click PYSNIFFER "https://github.com/komodoooo/some-things/blob/main/things/pysniffer.py"
    click SEXER "https://github.com/komodoooo/some-things/blob/main/things/sexer-ssh.rb"
    click SPINA "https://github.com/komodoooo/some-things/blob/main/things/spina.py"
    click SSLSCAN "https://github.com/komodoooo/some-things/blob/main/things/ssl-scanner.rb"
    click TENKAI "https://github.com/komodoooo/some-things/blob/main/things/tenkai.rb"

    %% Styles
    classDef doc fill:#fceabb,stroke:#e58c00,stroke-width:2px;
    classDef tool fill:#bbdef0,stroke:#0d47a1,stroke-width:2px,stroke-dasharray: 5, 5;
    classDef container fill:#c8e6c9,stroke:#388e3c,stroke-width:2px;
    classDef external fill:#ffe082,stroke:#f57f17,stroke-width:2px;
```
