# sebastian93921/oott architecture

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

- Interactive diagram: https://gitdiagram.com/sebastian93921/oott
- Repository: https://github.com/sebastian93921/oott

## Overview

##### Project Type and Purpose
- Type: Open-source security CLI toolkit in Go
- Purpose: Provide various pentesting scans (subdomains, web, secrets, emails, local files) via a unified command‐line interface.

##### File Structure
- Top-level “main.go” invokes the CLI (cli/).
- “cli/” holds subcommands (emailscan, secretscan, subdomainscan, webscan, localscan).
- Each feature has its own package: localscan/, subdomains/, webscans/, secrets/, emails/.
- Shared logic in common/, helper/, lib/ (config, filtering).
- defaults/ houses pattern definitions (secretpatterns.json, wappalyzer fingerprints).
- External integrations: GitHub API, DuckDuckGo API, PGP scanning, massdns, etc.

##### README for Insights
- Usage examples show how CLI flags map to modules.
- Supported plugins list reveals external services and requirements (API keys, installed tools).

##### Main Components & Their Interactions
A. CLI Layer
– Component: Root command (cobra) in cli/root.go → subcommands in cli/*.go
– Responsibility: parse flags, dispatch to scan modules

B. Scan Modules
1. Localscan
- Reads files from local filesystem → uses secretpatterns.json → reports secrets
2. SubdomainScan
- Orchestrates multiple subdomain providers (subdomains/*.go)
- Fast scan, HTTP-status check options
3. WebScan
- Crawler + Wappalyzer fingerprinting (webscans/*.go)
4. SecretScan
- Uses GitHub API (common/github.go) for code‐search of secrets
5. EmailScan
- Uses DuckDuckGo, GitHub, PGP modules (emails/*.go)

C. Shared Utilities
- lib/: config loading, filtering logic
- helper/: formatting, pretty printing, general helpers
- common/: API wrappers for DuckDuckGo, GitHub

D. Defaults and Data Files
- default secret patterns (defaults/secretpatterns.json)
- wappalyzer signatures (defaults/wappalyzer/*.json)

E. External Services & Tools
- GitHub API, DuckDuckGo API, Archive.org, AlienVault, CertSpotter, LeakIX, RapidDNS, URLScan.io, massdns, PGP tool

##### Architectural Patterns & Design Principles
- Plugin-style modularity: each scan type is isolated in its own package
- Dependency injection via config (lib/config.go)
- Shared utilities to avoid duplication (common/, helper/)
- Data-driven patterns: default JSON files drive fingerprinting and secret patterns

4. Module to:

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "CLI Orchestrator"
        CLI["CLI Orchestrator (cobra root)"]:::cli
        LocalCmd["localscan"]:::cli
        SubCmd["subdomainscan"]:::cli
        WebCmd["webscan"]:::cli
        SecCmd["secretscan"]:::cli
        EmailCmd["emailscan"]:::cli
        CLI -->|"localscan"| LocalCmd
        CLI -->|"subdomainscan"| SubCmd
        CLI -->|"webscan"| WebCmd
        CLI -->|"secretscan"| SecCmd
        CLI -->|"emailscan"| EmailCmd
    end

    LocalCmd -->|"dispatch"| LocalMod
    SubCmd -->|"dispatch"| SubMod
    WebCmd -->|"dispatch"| WebMod
    SecCmd -->|"dispatch"| SecMod
    EmailCmd -->|"dispatch"| EmailMod

    LocalMod["LocalScan Module"]:::module
    SubMod["SubdomainScan Module"]:::module
    WebMod["WebScan Module"]:::module
    SecMod["SecretScan Module"]:::module
    EmailMod["EmailScan Module"]:::module

    LocalMod -->|"reads patterns"| Data
    SubMod -->|"reads patterns"| Data
    WebMod -->|"reads signatures"| Data
    SecMod -->|"reads patterns"| Data
    EmailMod -->|"reads patterns"| Data

    LocalMod -->|"uses config"| Config
    SubMod -->|"uses config"| Config
    WebMod -->|"uses config"| Config
    SecMod -->|"uses config"| Config
    EmailMod -->|"uses config"| Config

    LocalMod -->|"uses filtering"| Filtering
    SubMod -->|"uses filtering"| Filtering
    WebMod -->|"uses filtering"| Filtering
    SecMod -->|"uses filtering"| Filtering
    EmailMod -->|"uses filtering"| Filtering

    LocalMod -->|"uses helpers"| Helper
    SubMod -->|"uses helpers"| Helper
    WebMod -->|"uses helpers"| Helper
    SecMod -->|"uses helpers"| Helper
    EmailMod -->|"uses helpers"| Helper

    SecMod -->|"calls API"| GitHub
    EmailMod -->|"calls API"| Duck
    EmailMod -->|"calls API"| GitHub
    SubMod -->|"calls APIs"| Services
    SubMod -.->|"optionally uses massdns"| Tools

    subgraph "Subdomain Providers"
        AV["AlienVault"]:::module
        AO["ArchiveOrg"]:::module
        CS["CertSpotter"]:::module
        DG["DuckDuckGo"]:::module
        HT["HackerTarget"]:::module
        LX["LeakIX"]:::module
        MD["MassDNS"]:::module
        RD["RapidDNS"]:::module
        SS["SimpleScan"]:::module
        TM["ThreatMiner"]:::module
        US["URLScan"]:::module
        SubMod -->|"invokes"| AV
        SubMod -->|"invokes"| AO
        SubMod -->|"invokes"| CS
        SubMod -->|"invokes"| DG
        SubMod -->|"invokes"| HT
        SubMod -->|"invokes"| LX
        SubMod -->|"invokes"| MD
        SubMod -->|"invokes"| RD
        SubMod -->|"invokes"| SS
        SubMod -->|"invokes"| TM
        SubMod -->|"invokes"| US
    end

    subgraph "WebScan Components"
        WSCore["webscans.go"]:::module
        Craw["crawler.go"]:::module
        Wapp["wappalyzer.go"]:::module
        WebMod -->|"calls"| WSCore
        WebMod -->|"calls"| Craw
        WebMod -->|"calls"| Wapp
    end

    subgraph "SecretScan Components"
        SecCore["secrets.go"]:::module
        SecGit["github.go"]:::module
        SecMod -->|"calls"| SecCore
        SecMod -->|"calls"| SecGit
    end

    subgraph "EmailScan Components"
        EmailCore["emails.go"]:::module
        EmailDG["duckduckgo.go"]:::module
        EmailGH["github.go"]:::module
        EmailPGP["pgpscan.go"]:::module
        EmailFmt["emailformat.go"]:::module
        EmailMod -->|"calls"| EmailCore
        EmailMod -->|"calls"| EmailDG
        EmailMod -->|"calls"| EmailGH
        EmailMod -->|"calls"| EmailPGP
        EmailMod -->|"calls"| EmailFmt
    end

    Config["config loader"]:::shared
    Filtering["filtering logic"]:::shared
    Helper["helper utilities"]:::shared
    Common["common API wrappers"]:::shared
    Data[(Defaults Data)]:::data

    GitHub["GitHub API"]:::external
    Duck["DuckDuckGo API"]:::external
    Services["Various Subdomain Services"]:::external
    Tools["External Tools (massdns, PGP)"]:::external

    class CLI,LocalCmd,SubCmd,WebCmd,SecCmd,EmailCmd cli
    class LocalMod,SubMod,WebMod,SecMod,EmailMod,AV,AO,CS,DG,HT,LX,MD,RD,SS,TM,US,WSCore,Craw,Wapp,SecCore,SecGit,EmailCore,EmailDG,EmailGH,EmailPGP,EmailFmt module
    class Config,Filtering,Helper,Common shared
    class Data data
    class GitHub,Duck,Services,Tools external

    click CLI "https://github.com/sebastian93921/oott/blob/main/cli/root.go"
    click EmailCmd "https://github.com/sebastian93921/oott/blob/main/cli/emailscan.go"
    click SecCmd "https://github.com/sebastian93921/oott/blob/main/cli/secretscan.go"
    click SubCmd "https://github.com/sebastian93921/oott/blob/main/cli/subdomainscan.go"
    click WebCmd "https://github.com/sebastian93921/oott/blob/main/cli/webscan.go"
    click LocalMod "https://github.com/sebastian93921/oott/blob/main/localscan/localsecrets.go"
    click SubMod "https://github.com/sebastian93921/oott/blob/main/subdomains/subdomains.go"
    click AV "https://github.com/sebastian93921/oott/blob/main/subdomains/alienvault.go"
    click AO "https://github.com/sebastian93921/oott/blob/main/subdomains/archiveorg.go"
    click CS "https://github.com/sebastian93921/oott/blob/main/subdomains/certspotter.go"
    click DG "https://github.com/sebastian93921/oott/blob/main/subdomains/duckduckgo.go"
    click HT "https://github.com/sebastian93921/oott/blob/main/subdomains/hackertarget.go"
    click LX "https://github.com/sebastian93921/oott/blob/main/subdomains/leakix.go"
    click MD "https://github.com/sebastian93921/oott/blob/main/subdomains/massdns.go"
    click RD "https://github.com/sebastian93921/oott/blob/main/subdomains/rapiddns.go"
    click SS "https://github.com/sebastian93921/oott/blob/main/subdomains/simplescan.go"
    click TM "https://github.com/sebastian93921/oott/blob/main/subdomains/threatminer.go"
    click US "https://github.com/sebastian93921/oott/blob/main/subdomains/urlscan.go"
    click WSCore "https://github.com/sebastian93921/oott/blob/main/webscans/webscans.go"
    click Craw "https://github.com/sebastian93921/oott/blob/main/webscans/crawler.go"
    click Wapp "https://github.com/sebastian93921/oott/blob/main/webscans/wappalyzer.go"
    click SecCore "https://github.com/sebastian93921/oott/blob/main/secrets/secrets.go"
    click SecGit "https://github.com/sebastian93921/oott/blob/main/secrets/github.go"
    click EmailCore "https://github.com/sebastian93921/oott/blob/main/emails/emails.go"
    click EmailDG "https://github.com/sebastian93921/oott/blob/main/emails/duckduckgo.go"
    click EmailGH "https://github.com/sebastian93921/oott/blob/main/emails/github.go"
    click EmailPGP "https://github.com/sebastian93921/oott/blob/main/emails/pgpscan.go"
    click EmailFmt "https://github.com/sebastian93921/oott/blob/main/emails/emailformat.go"
    click Config "https://github.com/sebastian93921/oott/blob/main/lib/config.go"
    click Filtering "https://github.com/sebastian93921/oott/blob/main/lib/filtering.go"
    click Helper "https://github.com/sebastian93921/oott/blob/main/helper/helper.go"
    click Common "https://github.com/sebastian93921/oott/blob/main/common/github.go"
    click Common "https://github.com/sebastian93921/oott/blob/main/common/duckduckgo.go"
    click Data "https://github.com/sebastian93921/oott/blob/main/defaults/defaults.go"
    classDef cli fill:#ADD8E6,stroke:#333,stroke-width:1px
    classDef module fill:#90EE90,stroke:#333,stroke-width:1px
    classDef shared fill:#FFA500,stroke:#333,stroke-width:1px
    classDef data fill:#FFFF99,stroke:#333,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:1px
```
