# besrabasant/ssh-tunnel-manager architecture

> Architecture diagram of the GitHub repository besrabasant/ssh-tunnel-manager, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/besrabasant/ssh-tunnel-manager
- Repository: https://github.com/besrabasant/ssh-tunnel-manager

## Overview

##### Main Components

a) Client-Side Components:
- CLI Interface (client/cmd/*.go files)
- Client Library (client/lib/)
- RPC Client Communication Layer

b) Server-Side (Daemon) Components:
- RPC Server (daemon/rpcserver.go)
- Task Handlers (daemon/tasks/)
- Tunnel Manager (pkg/tunnelmanager/)
- Configuration Manager (pkg/configmanager/)

c) External Components:
- SSH Servers (that the tool connects to)
- Local Applications (that use the tunnels)

**┌─ User Interface Layer ─────────────────────┐**
- CLI Commands (add, list, tunnel, etc.)     │
- ┬───────────────────────┘
- ↓
**┌─ Client Layer ────────────────────────────┐**
- RPC Client | Form Handler | Daemon Client  │
- ┬───────────────────────┘
- ↓
**┌─ Communication Layer ────────────────────────┐**
- gRPC Protocol (daemon.proto)                 │
- ┬───────────────────────┘
- ↓
**┌─ Server Layer (Daemon) ──────────────────────┐**
- RPC Server | Task Handlers                   │
- ┬───────────────────────┘
- ↓
**┌─ Core Services Layer ────────────────────────┐**
- Tunnel Manager | Config Manager              │
- ┬───────────────────────┘
- ↓
**┌─ External Systems Layer ──────────────────────┐**
- SSH Servers | Local Ports                     │
- ┘

##### Key Relationships to Highlight

a) Data Flow:
- Command flow from CLI → Client Library → RPC → Daemon
- Configuration management flow through ConfigManager
- SSH tunnel establishment flow through TunnelManager
- Active tunnel monitoring path

b) Component Interactions:
- How the daemon manages multiple tunnel configurations
- Relationship between active tunnels and their configurations
- How the CLI interfaces with the daemon through RPC

##### Important Details

- gRPC service definitions between client and daemon
- Configuration storage and management flow
- SSH tunnel establishment process
- Active tunnel monitoring and management
- Command execution flow for each main feature (add, list, tunnel, etc.)

##### Implementation Notes

- The separation between the CLI tool and the daemon service
- The role of the RPC layer in communication
- The centralized management of SSH tunnels
- Configuration persistence and retrieval
- The relationship with external SSH servers

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph UI["User Interface Layer"]
        CLI["CLI Commands"]:::cli
        AddCmd["Add Command"]:::cli
        ListCmd["List Command"]:::cli
        TunnelCmd["Tunnel Command"]:::cli
        ActiveCmd["Active Command"]:::cli
        DeleteCmd["Delete Command"]:::cli
        KillCmd["Kill Command"]:::cli
        EditCmd["Edit Command"]:::cli
    end

    subgraph CL["Client Layer"]
        RPCClient["RPC Client"]:::client
        FormHandler["Form Handler"]:::client
        DaemonClient["Daemon Client"]:::client
    end

    subgraph COM["Communication Layer"]
        gRPC["gRPC Protocol"]:::protocol
    end

    subgraph SL["Server Layer"]
        RPCServer["RPC Server"]:::server
        TaskHandlers["Task Handlers"]:::server
        ActiveTask["Active Tasks"]:::server
        AddTask["Add Tasks"]:::server
        DeleteTask["Delete Tasks"]:::server
        ListTask["List Tasks"]:::server
        TunnelTask["Tunnel Tasks"]:::server
        UpdateTask["Update Tasks"]:::server
    end

    subgraph CS["Core Services Layer"]
        TunnelMgr["Tunnel Manager"]:::core
        ConfigMgr["Config Manager"]:::core
        SSHConn["SSH Connections"]:::core
        ConnInfo["Connection Info"]:::core
        SSHHelpers["SSH Helpers"]:::core
        DataTransformer["Data Transformer"]:::core
    end

    subgraph EX["External Systems Layer"]
        SSHServers["SSH Servers"]:::external
        LocalPorts["Local Ports"]:::external
    end

    %% Relationships
    CLI --> AddCmd & ListCmd & TunnelCmd & ActiveCmd & DeleteCmd & KillCmd & EditCmd
    AddCmd & ListCmd & TunnelCmd & ActiveCmd & DeleteCmd & KillCmd & EditCmd --> RPCClient
    RPCClient --> FormHandler
    FormHandler --> DaemonClient
    DaemonClient --> gRPC
    gRPC --> RPCServer
    RPCServer --> TaskHandlers
    TaskHandlers --> ActiveTask & AddTask & DeleteTask & ListTask & TunnelTask & UpdateTask
    TaskHandlers --> TunnelMgr
    TunnelMgr --> ConfigMgr
    TunnelMgr --> SSHConn
    SSHConn --> ConnInfo
    SSHConn --> SSHHelpers
    ConfigMgr --> DataTransformer
    SSHConn --> SSHServers
    SSHServers --> LocalPorts

    %% Click Events
    click CLI "https://github.com/besrabasant/ssh-tunnel-manager/tree/master/client/cmd/"
    click AddCmd "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/client/cmd/add.go"
    click ListCmd "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/client/cmd/list.go"
    click TunnelCmd "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/client/cmd/tunnel.go"
    click ActiveCmd "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/client/cmd/active.go"
    click DeleteCmd "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/client/cmd/delete.go"
    click KillCmd "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/client/cmd/kill.go"
    click EditCmd "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/client/cmd/edit.go"
    click RPCClient "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/client/lib/daemon_client.go"
    click FormHandler "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/client/lib/form.go"
    click RPCServer "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/daemon/rpcserver.go"
    click ActiveTask "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/daemon/tasks/active.go"
    click AddTask "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/daemon/tasks/add.go"
    click DeleteTask "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/daemon/tasks/delete.go"
    click ListTask "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/daemon/tasks/list.go"
    click TunnelTask "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/daemon/tasks/tunnel.go"
    click UpdateTask "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/daemon/tasks/update.go"
    click TunnelMgr "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/pkg/tunnelmanager/tunnel_manager.go"
    click SSHConn "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/pkg/tunnelmanager/ssh_connections.go"
    click ConnInfo "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/pkg/tunnelmanager/connection_info.go"
    click SSHHelpers "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/pkg/tunnelmanager/ssh_helpers.go"
    click ConfigMgr "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/pkg/configmanager/config_manager.go"
    click DataTransformer "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/pkg/configmanager/transformer.go"
    click gRPC "https://github.com/besrabasant/ssh-tunnel-manager/blob/master/rpc/daemon.proto"

    %% Styles
    classDef cli fill:#2196F3,stroke:#1565C0,color:white
    classDef client fill:#42A5F5,stroke:#1E88E5,color:white
    classDef protocol fill:#9C27B0,stroke:#7B1FA2,color:white
    classDef server fill:#4CAF50,stroke:#388E3C,color:white
    classDef core fill:#66BB6A,stroke:#43A047,color:white
    classDef external fill:#FF9800,stroke:#F57C00,color:white
```
