# intruder-sec/reconswift architecture

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

- Interactive diagram: https://gitdiagram.com/intruder-sec/reconswift
- Repository: https://github.com/intruder-sec/reconswift

## Overview

##### Project Type and Purpose
- Project Type: Backend service for an automated security reconnaissance framework.
- Purpose: Receive scan requests, enqueue them in AWS SQS, execute Bash‐based scans (quick/advanced/full), store results in MongoDB, and expose REST endpoints to a NextJS frontend.

##### File Structure
- Top-Level Files:
– Dockerfile, Jenkinsfile, .gitignore, LEARN.md – deployment & CI/CD
– index.js – application entrypoint
– routes.js – route definitions
– package.json / package-lock.json – Node dependencies & scripts
- Controllers (controllers/*.js): API logic for startScan, addScan, completeScan, deleteQueue
- Models (model/*.js): Mongoose schemas (UserSchema, UserScans)
- Utils:
– modules/*.sh – scan scripts (quick_scan, full_scan, advanced_scan)
– tools/Sublist3r – external subdomain enumeration binary
– wordlists/dir/common.txt – directory brute-forcing wordlist
– script.sh – orchestrator wrapper
- Public: static resources (TXT proofs)

##### README Insights
– API Layer (Node/Express)
– Message Queue (AWS SQS)
– Worker processes (Bash scripts)
– Database (MongoDB Atlas)
– Cloud services (Cloudinary / Azure)
- Env requirements: SQS URL, AWS keys, Mongo URL, Cloudinary creds

##### Main Components & Relationships
a. Components:
1. Client (NextJS Frontend)
2. API Server (Node.js + Express: index.js, routes.js, controllers/)
3. Message Queue (AWS SQS)
4. Worker Node(s) (Bash scripts under utils/modules/)
5. External Scanning Tools (Sublist3r, wordlists)
6. Database (MongoDB Atlas)
7. Cloudinary / Cloud Storage (for screenshots or assets)
8. CI/CD (Jenkins, Docker)
b. Interactions:
- Frontend → HTTP POST “/startScan” → API Server
- API Server: validates, writes UserScans record, enqueues message to SQS
- Worker (polls SQS): receives job → executes appropriate .sh script → calls Sublist3r/tools → outputs results
- Worker: updates scan status & results in MongoDB, uploads assets to Cloudinary (if needed)
- Frontend polls or WebSocket for status via API Server → reads from MongoDB
c. Architectural Patterns:
- Queue-based decoupling (producer/consumer) for long-running scans
- MVC-style separation in API (routes → controllers → models)
- Microservices-like workers (Bash scripts) invoked outside Node runtime
d. Key Technologies:
- Node.js, Express
- Mongoose (MongoDB)
- AWS SQS
- Bash scripting & external tools (Sublist3r)
- Docker, Jenkins for CI/CD
- Cloudinary / Azure for media

## Diagram (Mermaid)

```mermaid
flowchart TD
    subgraph "Frontend (NextJS)" 
        FE["NextJS Frontend"] 
    end

    subgraph "API Server (Node.js + Express)" 
        Index["index.js"]
        Routes["routes.js"]
        subgraph "Controllers"
            CS1["startScan.js"]
            CS2["addScan.js"]
            CS3["completeScan.js"]
            CS4["deleteQueue.js"]
        end
        subgraph "Models"
            M1["UserSchema.js"]
            M2["UserScans.js"]
        end
    end

    Queue["AWS SQS Queue"]

    subgraph "Scan Worker(s)"
        Script["script.sh"]
        subgraph "Modules"
            QS["quick_scan.sh"]
            AS["advanced_scan.sh"]
            FS["full_scan.sh"]
        end
        Tools["Sublist3r"]
        WL["common.txt"]
    end

    DB["MongoDB Atlas"]
    Cloudinary["Cloudinary / Azure"]
    Public["Public Proofs"]

    subgraph "CI/CD & Deployment"
        Docker["Dockerfile"]
        Jenkins["Jenkinsfile"]
        Learn["LEARN.md"]
        Gitignore[".gitignore"]
        Package["package.json"]
        Lock["package-lock.json"]
    end

    FE -->|POST /startScan| Index
    Index --> Routes
    Routes --> CS1
    CS1 -->|enqueue| Queue
    CS2 -->|enqueue| Queue
    Queue --> Script
    Script --> QS
    Script --> AS
    Script --> FS
    QS --> Tools
    QS --> WL
    Script -->|update results| DB
    Script -->|upload assets| Cloudinary
    Index -->|read/write| DB
    FE -->|poll status| Index
    FE -->|access| Public

    click Index "https://github.com/intruder-sec/reconswift/blob/main/index.js"
    click Routes "https://github.com/intruder-sec/reconswift/blob/main/routes.js"
    click CS1 "https://github.com/intruder-sec/reconswift/blob/main/controllers/startScan.js"
    click CS2 "https://github.com/intruder-sec/reconswift/blob/main/controllers/addScan.js"
    click CS3 "https://github.com/intruder-sec/reconswift/blob/main/controllers/completeScan.js"
    click CS4 "https://github.com/intruder-sec/reconswift/blob/main/controllers/deleteQueue.js"
    click M1 "https://github.com/intruder-sec/reconswift/blob/main/model/UserSchema.js"
    click M2 "https://github.com/intruder-sec/reconswift/blob/main/model/UserScans.js"
    click Script "https://github.com/intruder-sec/reconswift/blob/main/utils/script.sh"
    click QS "https://github.com/intruder-sec/reconswift/blob/main/utils/modules/quick_scan.sh"
    click AS "https://github.com/intruder-sec/reconswift/blob/main/utils/modules/advanced_scan.sh"
    click FS "https://github.com/intruder-sec/reconswift/blob/main/utils/modules/full_scan.sh"
    click Tools "https://github.com/intruder-sec/reconswift/tree/main/utils/tools/Sublist3r"
    click WL "https://github.com/intruder-sec/reconswift/blob/main/utils/wordlists/dir/common.txt"
    click Public "https://github.com/intruder-sec/reconswift/blob/main/public/8942e3a2fde6cdb02c6beb9fb312bfe2.txt"
    click Docker "https://github.com/intruder-sec/reconswift/tree/main/Dockerfile"
    click Jenkins "https://github.com/intruder-sec/reconswift/tree/main/Jenkinsfile"
    click Learn "https://github.com/intruder-sec/reconswift/blob/main/LEARN.md"
    click Gitignore "https://github.com/intruder-sec/reconswift/blob/main/.gitignore"
    click Package "https://github.com/intruder-sec/reconswift/blob/main/package.json"
    click Lock "https://github.com/intruder-sec/reconswift/blob/main/package-lock.json"

    class Index,Routes,CS1,CS2,CS3,CS4,M1,M2 api
    class Queue queue
    class Script,QS,AS,FS,Tools,WL worker
    class DB db
    class Cloudinary cloud
    class FE external
    class Public doc
    class Docker,Jenkins,Learn,Gitignore,Package,Lock ci

    classDef api fill:#cce5ff,stroke:#004085
    classDef queue fill:#fff3cd,stroke:#856404
    classDef worker fill:#e2e3e5,stroke:#383d41
    classDef db fill:#d4edda,stroke:#155724
    classDef cloud fill:#f5c6cb,stroke:#721c24
    classDef external fill:#d1ecf1,stroke:#0c5460
    classDef doc fill:#f8d7da,stroke:#721c24
    classDef ci fill:#d6d8d9,stroke:#1b1e21
```
