How obheda12/gitdorker works
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.