# prdngr/red-sky architecture

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

- Interactive diagram: https://gitdiagram.com/prdngr/red-sky
- Repository: https://github.com/prdngr/red-sky

## Overview

##### Project Type and Purpose
- RedSky is a command-line utility (full CLI app), written in Go, for just-in-time offensive infrastructure provisioning on AWS.
- It embeds Terraform templates and invokes AWS APIs to create and destroy resources (EC2, networking, keys, etc.).

##### File Structure
- Top-level “cmd” directory: entry points for subcommands (create, destroy, list, version).
- “internal” directory: core services–AWS session management, Terraform orchestration, file handling, user-interface spinner/output, versioning, IP lookup (ifconfig).
- “static/terraform”: embedded Terraform code and modules (cdn, common), scripts (user-data).
- main.go ties everything together.

##### README Insights
- Describes supported deployment types (Nessus, Kali, Kali+Mythic C2).
- Installation via “go install”, usage via “red-sky create --type …”.
- Outputs AWS session details, deployment summary, SSH instructions.

##### Main Components
A. User (CLI)
B. RedSky Binary
1. CLI Parser & Command Dispatcher (cmd package)
2. Internal Services Layer:
– AWS Client (internal/aws.go)
– Terraform Orchestrator (internal/terraform.go)
– File Manager & Embedding (internal/files.go + static/embed.go)
– Network Info (internal/ifconfig.go)
– Spinner/UI & Output Formatter (internal/spinner.go + output.go)
– Versioning (internal/version.go)
3. Temporary Workspace (local filesystem) for Terraform files
C. Embedded Terraform Code (static/terraform & modules)
D. Terraform CLI (external binary invoked by orchestrator)
E. AWS API Endpoints (EC2, IAM, Networking, S3 for state)
F. (Optional) SSH Client for end-user connectivity

##### Relationships and Data Flows
- User issues “red-sky create” → CLI Parser dispatches to Create handler.
- Create handler:
– Initializes AWS session (calls AWS SDK).
– Extracts embedded Terraform assets into temp folder.
– Invokes Terraform init/plan/apply via Terraform orchestrator.
– Polls AWS APIs (e.g., describe-instances, elastic IP) until resource is live.
– Gathers output (instance IP, key material).
– Renders UI spinner and final summary.
- User then SSHs to the provisioned host.
- Similar flow for “destroy” and “list” commands.

##### Architectural Patterns & Principles
- Layered design: CLI layer → service layer → external dependencies (Terraform, AWS).
- Single binary embedding static assets for portability.
- Separation of concerns:
– cmd/* focuses on CLI/flags
– internal/* on business logic
– static/* on infrastructure-as-code templates
- Dependency injection via passing AWS session and paths into orchestrator.

##### Relevant Technologies / Libraries
- Go modules (go.mod)
- AWS SDK for Go
- Terraform CLI (external process)
- Go “embed” package (static/embed.go)
- Spinner library (internal/spinner.go)
- Standard libraries (os/exec, io/ioutil, net/http for ifconfig)

##### It Out
1. Leftmost lane: User & SSH Client.
2. Middle lane (Local Host):
– RedSky CLI binary
– Components: Parser → AWS Client → Terraform Orchestrator → Spinner/Output → Filesystem
– Embedded Terraform modules (static).
– Terraform CLI (external tool)
3. Rightmost lane (AWS Cloud):
– AWS API (EC2, IAM, Networking)
– Provisioned resources (EC2 instance, security groups, EIP)
– State backend (if S3 used in future)
– CLI→AWS SDK calls
– Orchestrator→Terraform CLI→AWS
– AWS→CLI (DescribeOutputs)
– CLI→User (SSH instructions)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Swimlanes
    subgraph "User & SSH Client" 
        direction TB
        User["User (CLI)"]:::user
        SSH["SSH Client"]:::user
    end

    subgraph "Local Host"
        direction TB
        %% RedSky CLI Binary and its components
        subgraph "RedSky CLI Binary"
            direction TB
            Parser["CLI Parser & Command Dispatcher"]:::internal
            AWSClient["AWS Client"]:::internal
            TerraformOrch["Terraform Orchestrator"]:::internal
            FileManager["File Manager & Embedding"]:::internal
            NetworkInfo["Network Info (ifconfig)"]:::internal
            SpinnerOutput["Spinner/UI & Output Formatter"]:::internal
            VersionService["Versioning Service"]:::internal
        end

        FS["Temporary Workspace (Local FS)"]:::fs
        TerraBinary["Terraform CLI (external)"]:::externalTool

        subgraph "Embedded Terraform Code & Modules"
            direction TB
            StaticTF["Static Terraform Code"]:::fs
            CDNModule["Module: cdn"]:::fs
            CommonModule["Module: common"]:::fs
            C2Script["Script: c2-user-data.sh"]:::fs
        end

        GoMod["Go Modules (go.mod, go.sum)"]:::internal
    end

    subgraph "AWS Cloud"
        direction TB
        AWSAPI["AWS API Endpoints (EC2, IAM, Networking, S3)"]:::aws
        Resources["Provisioned Resources"]:::aws
    end

    %% Connections
    User -->|"red-sky create"| Parser
    Parser -->|"Init AWS session"| AWSClient
    AWSClient -->|"pass session"| TerraformOrch
    FileManager -->|"Extract assets"| FS
    FS -->|"workspace files"| TerraformOrch
    TerraformOrch -->|"terraform init/plan/apply"| TerraBinary
    TerraBinary -->|"API calls"| AWSAPI
    AWSAPI -->|"DescribeInstances, EIP"| AWSClient
    AWSClient -->|"resource info"| SpinnerOutput
    TerraformOrch -->|"plan outputs"| SpinnerOutput
    SpinnerOutput -->|"summary & SSH info"| User
    User -->|"ssh to host"| SSH

    %% Click Events
    click Parser "https://github.com/prdngr/red-sky/blob/main/cmd/root.go"
    click AWSClient "https://github.com/prdngr/red-sky/blob/main/internal/aws.go"
    click TerraformOrch "https://github.com/prdngr/red-sky/blob/main/internal/terraform.go"
    click FileManager "https://github.com/prdngr/red-sky/blob/main/internal/files.go"
    click NetworkInfo "https://github.com/prdngr/red-sky/blob/main/internal/ifconfig.go"
    click SpinnerOutput "https://github.com/prdngr/red-sky/blob/main/internal/spinner.go"
    click VersionService "https://github.com/prdngr/red-sky/blob/main/internal/version.go"
    click StaticTF "https://github.com/prdngr/red-sky/tree/main/static/terraform"
    click CDNModule "https://github.com/prdngr/red-sky/tree/main/static/terraform/modules/cdn"
    click CommonModule "https://github.com/prdngr/red-sky/tree/main/static/terraform/modules/common"
    click C2Script "https://github.com/prdngr/red-sky/blob/main/static/terraform/scripts/c2-user-data.sh"
    click GoMod "https://github.com/prdngr/red-sky/blob/main/go.mod"

    %% Styles
    classDef internal fill:#D0E8FF,stroke:#036,stroke-width:1px
    classDef externalTool fill:#D5F5E3,stroke:#027,stroke-width:1px
    classDef aws fill:#FDEBD0,stroke:#E67,stroke-width:1px
    classDef fs fill:#ECECEC,stroke:#888,stroke-width:1px
    classDef user fill:#FFF2CC,stroke:#E1A10A,stroke-width:1px
```
