# obheda12/gitdorker architecture

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

- Interactive diagram: https://gitdiagram.com/obheda12/gitdorker
- Repository: https://github.com/obheda12/gitdorker

## Overview

##### Project Type & Purpose
- GitDorker is a Python3 command-line tool for “dorking” GitHub via the GitHub Search API.
- It reads lists of search patterns (dorks) and GitHub tokens, rotates tokens to avoid rate limits, queries GitHub, and writes results.

##### File Structure
- Top Level:
- GitDorker.py – main CLI script
- Dorks/ – directory of dork‐pattern files (alldorksv3, medium_dorks.txt, etc.)
- tf/ – contains TOKENSFILE (GitHub personal access tokens)
- requirements.txt, Dockerfile, dummycreds
- No frontend or DB; all I/O is file-based or API-driven.
- Dockerfile encapsulates runtime environment.

##### Key Insights from README
- Core dependencies: Python3 libraries (via requirements.txt).
- Workflow: rotate between 1+ tokens → run 30 searches → sleep → continue.
- Output: scanned results dumped to user-specified files/folders.
- Optionally integrate with tools like GitRob or TruffleHog on discovered repos.

a. User/Operator (CLI invocation)
- GitDorker CLI Module (GitDorker.py)
- Token Manager
- Dork Manager (reads Dorks/)
- Rate Limiter (sleep logic)
- GitHub API Client (search endpoint)
- Output Generator (writes results)
- File System Mount (tf/TOKENSFILE, Dorks/, output directory)
c. External Service
- GitHub Search API

##### Relationships & Data Flow
1. User invokes `docker run` or `python3 GitDorker.py` with parameters.
2. CLI Module → Token Manager loads tokens from tf/TOKENSFILE.
3. CLI Module → Dork Manager loads list of dorks from Dorks/*.
4. For each dork:
– GitHub API Client sends search request using current token.
– Rate Limiter ensures 30 calls/minute (sleep logic).
– Response forwarded to Output Generator.
5. Output Generator writes result sets to output folder.
6. (Optional) Discovered repos handed off to GitRob/TruffleHog.

##### Architectural Patterns & Principles
- Layered/Modular: separate concerns (token handling, dork loading, API calls, I/O).
- Resilience: rate-limit control via sleep.
- Extensibility: drop-in additional dork files or tokens; hook external tools.

## Diagram (Mermaid)

```mermaid
flowchart TB
    User["User/Operator"] 

    subgraph "Docker Container"
        direction TB
        CLIModule["GitDorker CLI Module"]:::internal
        TokenManager["Token Manager"]:::internal
        DorkManager["Dork Manager"]:::internal
        APICient["GitHub API Client"]:::internal
        RateLimiter["Rate Limiter"]:::internal
        OutputGen["Output Generator"]:::internal
        FileSystem["File System Mount"]:::io
    end

    subgraph "Project Files"
        direction TB
        DockerfileNode["Dockerfile"]:::io
        Requirements["requirements.txt"]:::io
        DummyCreds["dummycreds"]:::io
        README["README.md"]:::external
    end

    GitHubAPI["GitHub Search API"]:::external
    GitRob["GitRob"]:::optional
    TruffleHog["TruffleHog"]:::optional

    User --> CLIModule
    CLIModule --> TokenManager
    CLIModule --> DorkManager
    FileSystem --> TokenManager
    FileSystem --> DorkManager
    TokenManager --> APICient
    DorkManager --> APICient
    APICient --> RateLimiter
    RateLimiter --> APICient
    APICient --> GitHubAPI
    APICient --> OutputGen
    OutputGen --> FileSystem
    OutputGen -.->|hand off results| GitRob
    OutputGen -.->|hand off results| TruffleHog

    click CLIModule "https://github.com/obheda12/gitdorker/blob/master/GitDorker.py"
    click DorkManager "https://github.com/obheda12/gitdorker/tree/master/Dorks/"
    click TokenManager "https://github.com/obheda12/gitdorker/tree/master/tf/TOKENSFILE"
    click DockerfileNode "https://github.com/obheda12/gitdorker/tree/master/Dockerfile"
    click Requirements "https://github.com/obheda12/gitdorker/blob/master/requirements.txt"
    click DummyCreds "https://github.com/obheda12/gitdorker/tree/master/dummycreds"
    click README "https://github.com/obheda12/gitdorker/blob/master/README.md"

    classDef internal fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef io fill:#90EE90,stroke:#333,stroke-width:1px
    classDef external fill:#FFA500,stroke:#333,stroke-width:1px
    classDef optional fill:#D3D3D3,stroke-dasharray:5 5,stroke:#333,stroke-width:1px
```
