# ivanglinkin/fast-google-dorks-scan architecture

> Architecture diagram of the GitHub repository ivanglinkin/fast-google-dorks-scan, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-05). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ivanglinkin/fast-google-dorks-scan
- Repository: https://github.com/ivanglinkin/fast-google-dorks-scan

## Overview

##### Project Type and Purpose
- The project is a lightweight OSINT utility written as a shell script (FGDS.sh) designed to automatically scan a given website by executing Google dorks search queries.
- Its goal is to automate the discovery of common admin panels, vulnerable file types, and misconfigured paths on a target site.
- It offers two modes of use: a direct execution mode (typical for environments like Kali Linux) and a containerized mode using Docker for broader compatibility.

##### File Structure
- Key Files:
- FGDS.sh: Main scanning script that orchestrates the OSINT process.
- settings.conf: Contains configurable parameters such as dork search combinations or other settings the script might use.
- Dockerfile: Enables containerization to package the script with all its dependencies.
- outputs/: Folder that holds the scan results (e.g., outputs/20230404_211631_aha.ru.txt).
- Support Files:
- .github directory: Contains funding configuration and other repository management files.
- README.md: Provides the project description, usage instructions, and examples.

##### Core Components
- Input Component:
- The user (or an automated process) provides target URL arguments (and optionally proxy settings) to the FGDS.sh script.
- Processing Component (Scanner Engine):
- The FGDS.sh script acts as the central module. It reads any necessary configuration from settings.conf.
- It assembles and executes multiple Google dorks search queries according to its internal logic.
- External Interactions:
- Google Search: The script constructs queries that use Google dorks to find information about the target website.
- Optional Proxy: If a proxy IP and port are provided, the script routes traffic accordingly.
- Output Component:
- The results of the scans are stored in the outputs directory.
- Containerization:
- Docker: The Dockerfile encapsulates the entire application, packaging the script and its environment so that it can be reliably deployed and run in any environment.

##### Architectural Patterns and Relationships
- Although the architecture is script-centric, the use of Docker highlights a containerization pattern, promoting portability and consistency between environments.

## Diagram (Mermaid)

```mermaid
flowchart TD
    User("User/CLI"):::userStyle
    User -->|"executesDirectMode"| FGDS_direct("FGDS.sh (Direct Execution)"):::scanner
    User -->|"executesContainerizedMode"| Docker("Dockerfile (Containerization Setup)"):::container

    FGDS_direct -->|"reads"| Config("settings.conf (Configuration)"):::config
    FGDS_direct -->|"queries"| Google("Google Search (External)"):::external
    FGDS_direct -->|"writesTo"| Outputs("outputs/ (Output Storage)"):::output

    Docker -->|"builds"| FGDS_container("FGDS.sh (Containerized Execution)"):::scanner
    FGDS_container -->|"reads"| Config
    FGDS_container -->|"optionallyUses"| Proxy("Optional Proxy"):::proxy
    Proxy -->|"forwardsTo"| Google
    FGDS_container -->|"writesTo"| Outputs

    Docs("Repository & Project Documentation (.github/ & README.md)"):::doc
    User -->|"references"| Docs

    click FGDS_direct "https://github.com/ivanglinkin/fast-google-dorks-scan/blob/master/FGDS.sh"
    click FGDS_container "https://github.com/ivanglinkin/fast-google-dorks-scan/blob/master/FGDS.sh"
    click Config "https://github.com/ivanglinkin/fast-google-dorks-scan/blob/master/settings.conf"
    click Outputs "https://github.com/ivanglinkin/fast-google-dorks-scan/tree/master/outputs/"
    click Docker "https://github.com/ivanglinkin/fast-google-dorks-scan/tree/master/Dockerfile"
    click Docs "https://github.com/ivanglinkin/fast-google-dorks-scan/tree/master/.github/"
    click Docs "https://github.com/ivanglinkin/fast-google-dorks-scan/blob/master/README.md"

    classDef userStyle fill:#f9f,stroke:#333,stroke-width:2px;
    classDef scanner fill:#bbf,stroke:#333,stroke-width:2px;
    classDef config fill:#fbf,stroke:#333,stroke-width:2px;
    classDef external fill:#ff9,stroke:#333,stroke-width:2px;
    classDef output fill:#9f9,stroke:#333,stroke-width:2px;
    classDef container fill:#cfc,stroke:#333,stroke-width:2px;
    classDef proxy fill:#fc9,stroke:#333,stroke-width:2px;
    classDef doc fill:#cff,stroke:#333,stroke-width:2px;
```
