# ankusht369/gossh architecture

> Architecture diagram of the GitHub repository ankusht369/gossh, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-06). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ankusht369/gossh
- Repository: https://github.com/ankusht369/gossh

## Overview

gossh provides SSH-over-WebSocket transport: an SSH client connects to a local TCP port, the gossh client carries that stream over WSS to the gossh server, and the server bridges it to the existing sshd. The CLI also exposes server status and optional daemon mode. The relay service is an optional deployment layer documented in the README; source excerpts do not show its implementation. The shared tunnel session and logging are useful internal layers. Evidence is limited to the README and sampled source files.

Main entry points: [`cmd/gossh/main.go`](https://github.com/ankusht369/gossh/blob/main/cmd/gossh/main.go) (CLI modes), [`internal/client/client.go`](https://github.com/ankusht369/gossh/blob/main/internal/client/client.go) (Client WebSocket), [`internal/server/server.go`](https://github.com/ankusht369/gossh/blob/main/internal/server/server.go) (WebSocket handler), [`internal/tunnel/session.go`](https://github.com/ankusht369/gossh/blob/main/internal/tunnel/session.go) (Tunnel session)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["CLI and process"]
  node_cli["CLI modes<br/>[main.go]"]
  node_daemon["Daemon process<br/>[daemon_unix.go]"]
end

subgraph group_client_side["Client transport"]
  node_local_tcp["Local TCP listener<br/>[client.go]"]
  node_client_ws["Client WebSocket<br/>[client.go]"]
end

subgraph group_server_side["Server transport"]
  node_server_http["HTTP endpoints<br/>[server.go]"]
  node_server_ws["WebSocket handler<br/>[server.go]"]
  node_status["Status response<br/>[server.go]"]
end

subgraph group_shared["Shared runtime"]
  node_session["Tunnel session<br/>[session.go]"]
  node_logger["Runtime logger<br/>[log.go]"]
end

node_ssh_user(("SSH user"))
node_ssh_client(("SSH client"))
node_relay["HTTPS relay"]
node_ssh_daemon(("SSH daemon"))

node_ssh_user -->|"starts"| node_ssh_client
node_ssh_client -->|"connects to"| node_local_tcp
node_cli -->|"starts client"| node_local_tcp
node_local_tcp -->|"opens per connection"| node_client_ws
node_client_ws -->|"creates session"| node_session
node_client_ws -.->|"carries WSS"| node_relay
node_relay -.->|"forwards WebSocket"| node_server_http
node_server_http -->|"routes /ws"| node_server_ws
node_server_ws -->|"dials SSH"| node_ssh_daemon
node_server_ws -->|"creates session"| node_session
node_session -->|"bridges TCP"| node_ssh_daemon
node_cli -->|"starts server"| node_server_http
node_cli -->|"requests status"| node_status
node_server_http -->|"serves /status"| node_status
node_cli -->|"daemonizes"| node_daemon
node_cli -->|"initializes"| node_logger
node_client_ws -->|"logs transport"| node_logger
node_server_ws -->|"logs transport"| node_logger

click node_cli "https://github.com/ankusht369/gossh/blob/main/cmd/gossh/main.go"
click node_daemon "https://github.com/ankusht369/gossh/blob/main/internal/daemon/daemon_unix.go"
click node_local_tcp "https://github.com/ankusht369/gossh/blob/main/internal/client/client.go"
click node_client_ws "https://github.com/ankusht369/gossh/blob/main/internal/client/client.go"
click node_server_http "https://github.com/ankusht369/gossh/blob/main/internal/server/server.go"
click node_server_ws "https://github.com/ankusht369/gossh/blob/main/internal/server/server.go"
click node_status "https://github.com/ankusht369/gossh/blob/main/internal/server/server.go"
click node_session "https://github.com/ankusht369/gossh/blob/main/internal/tunnel/session.go"
click node_logger "https://github.com/ankusht369/gossh/blob/main/internal/log/log.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli,node_daemon,node_ssh_user,node_ssh_client toneBlue
class node_local_tcp,node_client_ws toneAmber
class node_server_http,node_server_ws,node_status toneMint
class node_session,node_logger toneRose
class node_relay,node_ssh_daemon toneIndigo
```

## Components

### CLI and process

- [CLI modes](https://github.com/ankusht369/gossh/blob/main/cmd/gossh/main.go): `cmd/gossh/main.go`
- [Daemon process](https://github.com/ankusht369/gossh/blob/main/internal/daemon/daemon_unix.go): `internal/daemon/daemon_unix.go`

### Client transport

- [Local TCP listener](https://github.com/ankusht369/gossh/blob/main/internal/client/client.go): `internal/client/client.go`
- [Client WebSocket](https://github.com/ankusht369/gossh/blob/main/internal/client/client.go): `internal/client/client.go`

### Server transport

- [HTTP endpoints](https://github.com/ankusht369/gossh/blob/main/internal/server/server.go): `internal/server/server.go`
- [WebSocket handler](https://github.com/ankusht369/gossh/blob/main/internal/server/server.go): `internal/server/server.go`
- [Status response](https://github.com/ankusht369/gossh/blob/main/internal/server/server.go): `internal/server/server.go`

### Shared runtime

- [Tunnel session](https://github.com/ankusht369/gossh/blob/main/internal/tunnel/session.go): `internal/tunnel/session.go`
- [Runtime logger](https://github.com/ankusht369/gossh/blob/main/internal/log/log.go): `internal/log/log.go`

### Other components

- **SSH user**
- **SSH client**
- **HTTPS relay**
- **SSH daemon**

## Connections

- SSH user → SSH client: starts (evidence: `README.md`)
- SSH client → Local TCP listener: connects to (evidence: `README.md`)
- CLI modes → Local TCP listener: starts client (evidence: `cmd/gossh/main.go`)
- Local TCP listener → Client WebSocket: opens per connection (evidence: `internal/client/client.go`)
- Client WebSocket → Tunnel session: creates session (evidence: `internal/client/client.go`)
- Client WebSocket → HTTPS relay: carries WSS (evidence: `README.md`)
- HTTPS relay → HTTP endpoints: forwards WebSocket (evidence: `README.md`)
- HTTP endpoints → WebSocket handler: routes /ws (evidence: `internal/server/server.go`)
- WebSocket handler → SSH daemon: dials SSH (evidence: `internal/server/server.go`)
- WebSocket handler → Tunnel session: creates session (evidence: `internal/server/server.go`)
- Tunnel session → SSH daemon: bridges TCP
- CLI modes → HTTP endpoints: starts server (evidence: `cmd/gossh/main.go`)
- CLI modes → Status response: requests status (evidence: `cmd/gossh/main.go`)
- HTTP endpoints → Status response: serves /status (evidence: `internal/server/server.go`)
- CLI modes → Daemon process: daemonizes (evidence: `cmd/gossh/main.go`)
- CLI modes → Runtime logger: initializes (evidence: `cmd/gossh/main.go`)
- Client WebSocket → Runtime logger: logs transport (evidence: `internal/client/client.go`)
- WebSocket handler → Runtime logger: logs transport (evidence: `internal/server/server.go`)
