# ant3r0s/email-osint-tool architecture

> Architecture diagram of the GitHub repository ant3r0s/email-osint-tool, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-22). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ant3r0s/email-osint-tool
- Repository: https://github.com/ant3r0s/email-osint-tool

## Overview

##### Project type and purpose
- This is a Python‑based CLI (command‑line interface) OSINT tool focused on extracting and analyzing intelligence from email domains.
- Its main use cases include domain extraction, DNS resolution, WHOIS lookups, SSL certificate checks, HTTP header analysis, geolocation, CMS detection, crawling/link extraction, Google dorks, and related reconnaissance functions.

##### File structure
- Top level:
- osint.py – single entry‑point script housing the CLI, menu logic, and all functional routines
- requirements.txt – lists dependencies (`requests`, `beautifulsoup4`, `whois`, `dnspython`, etc.)
- README.md, LICENSE – documentation and license
- There are no separate subdirectories; instead, logical modules and functions are grouped inside osint.py.

##### README for additional insights
- Reveals the tool’s feature set and external integrations:
- socket.gethostbyname, dnspython for DNS
- python‑whois library for WHOIS
- requests for HTTP/SSL/header analysis
- BeautifulSoup for HTML parsing
- ipinfo.io API for geolocation
- Comments hint at using additional external services (ViewDNS, HaveIBeenPwned)

a. Main components
1. User (CLI)
2. CLI/Menu Dispatcher
3. Functional Modules
– Domain Extractor
– DNS Resolver
– WHOIS Client
– SSL/Certificate Checker
– HTTP Header Analyzer
– Link Extractor & Crawler
– Google Dork Executor
– GeoIP Lookup
– CMS Detector
– Similar‑Domain Finder
4. External Services & Libraries
– socket, dnspython, whois library
– requests (HTTP/SSL calls)
– BeautifulSoup (HTML parsing)
– ipinfo.io API
– (Optional) ViewDNS, HaveIBeenPwned, WHOIS APIs
b. Relationships and interactions
- The User invokes commands in the CLI
- The CLI/Menu Dispatcher parses input and routes to the corresponding Functional Module
- Each module may:
– Call a Python library (e.g., socket.gethostbyname, whois)
– Send HTTP requests via `requests` to target domains or external APIs
– Parse HTML with BeautifulSoup
– Return structured results to the CLI
- The CLI formats and prints results back to the user
c. Architectural patterns and principles
- Single‑process, modular design (all logic in one script but logically separated)
- Separation of concerns: input parsing, core OSINT functions, output formatting
- Dependency on well‑established libraries for network, parsing, and API calls
d. Key technologies and libraries
– Python 3.x
– requests, beautifulsoup4
– python‑whois, dnspython
– socket (built‑in)
– External REST APIs (ipinfo.io, optional OSINT services)

##### Final recommendations
- Modules with the primary library or protocol they use (e.g., “WHOIS Client (python‑whois)”).
- Keep the data flow clear: show how user input travels through the system and how responses propagate back.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% User Interaction
    User["User"]:::external
    User -->|"commands"| CLI["CLI Dispatcher"]:::internal

    %% Functional Modules
    subgraph "Functional Modules"
        DE["Domain Extractor\n(socket.gethostbyname)"]:::internal
        DR["DNS Resolver\n(dnspython)"]:::internal
        WC["WHOIS Client\n(python-whois)"]:::internal
        SC["SSL/Certificate Checker\n(requests)"]:::internal
        HA["HTTP Header Analyzer\n(requests)"]:::internal
        LC["Link Extractor & Crawler\n(BeautifulSoup)"]:::internal
        GD["Google Dork Executor\n(requests)"]:::internal
        GL["GeoIP Lookup\n(ipinfo.io API)"]:::internal
        CM["CMS Detector\n(requests)"]:::internal
        SD["Similar-Domain Finder\n(dnspython)"]:::internal
    end

    %% Dispatcher to Modules
    CLI -->|"invoke"| DE
    CLI -->|"invoke"| DR
    CLI -->|"invoke"| WC
    CLI -->|"invoke"| SC
    CLI -->|"invoke"| HA
    CLI -->|"invoke"| LC
    CLI -->|"invoke"| GD
    CLI -->|"invoke"| GL
    CLI -->|"invoke"| CM
    CLI -->|"invoke"| SD

    %% Modules to Libraries / External Services
    DE -->|"DNS query"| socket["socket"]:::library
    DR -->|"DNS resolution"| dnspython["dnspython"]:::library
    WC -->|"WHOIS lookup"| whois["python-whois"]:::library
    SC -->|"HTTP/SSL GET"| requests["requests"]:::library
    HA -->|"HTTP GET"| requests
    LC -->|"HTML parse"| bs4["BeautifulSoup"]:::library
    GD -->|"HTTP GET"| requests
    GL -->|"API request"| ipinfo["ipinfo.io API"]:::external
    CM -->|"HTTP GET"| requests
    SD -->|"DNS resolution"| dnspython

    %% Modules returning results
    DE -->|"results"| CLI
    DR -->|"results"| CLI
    WC -->|"results"| CLI
    SC -->|"results"| CLI
    HA -->|"results"| CLI
    LC -->|"results"| CLI
    GD -->|"results"| CLI
    GL -->|"results"| CLI
    CM -->|"results"| CLI
    SD -->|"results"| CLI

    %% CLI Output
    CLI -->|"display"| User

    %% Documentation and Config
    requirements["requirements.txt"]:::library
    README["README.md"]:::external
    LICENSE["LICENSE"]:::external

    classDef internal fill:#AED6F1,stroke:#21618C,color:#1B4F72
    classDef external fill:#ABEBC6,stroke:#239B56,color:#1D8348
    classDef library fill:#D5D8DC,stroke:#566573,color:#2C3E50

    %% Click Events
    click CLI "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click DE "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click DR "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click WC "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click SC "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click HA "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click LC "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click GD "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click GL "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click CM "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click SD "https://github.com/ant3r0s/email-osint-tool/blob/main/osint.py"
    click requirements "https://github.com/ant3r0s/email-osint-tool/blob/main/requirements.txt"
    click README "https://github.com/ant3r0s/email-osint-tool/blob/main/README.md"
    click LICENSE "https://github.com/ant3r0s/email-osint-tool/tree/main/LICENSE"
```
