Remote Gateway

The Remote Gateway

Remote Access

The local application opens a SSH Tunnel to the cloud gateway which tunnels the http frontend.

sequenceDiagram
	participant Local
	participant Cloud
	Local ->> Cloud: Register with public key
	Cloud -->> Local: SSH Configuration
	Local ->> Cloud: Open SSH Tunnel

Loading

Registration

To register with the cloud gateway the local application has to POST to the cloud gateway

POST /api/gateway
Content-Type: application/json
---
{
	"public_key": "<public_key>",
	"preferred_prefix": "<optional prefix>"
}

The gateway responds with a remote url and the ssh user and url

{
    "id": "<uuid>",
    "access_url": "https://<prefix>.<cloud-url>",
    "tunnel_url": "ssh://<tbd>@tunnel.<cloud-url>"
}

The local application has to ping the cloud gateway in regular intervals.

POST /api/gateway/tunnel/<tunnel_id>/ping

On Startup the local application should ask whether the tunnel is still active

GET /api/gateway/tunnel/<tunnel_id>

It returns with 204 when the tunnel exists and 404 when it doesn't.

Tunnel

The local application opens a ssh tunnel to the configured <tunnel_url>. All requests to the <access_url> are forwarded via port forwarding to the http frontend of the local application.

OAuth Login

sequenceDiagram
  Local ->> Cloud: Redirect to cloud redirect_uri=<local_url>
  Cloud ->> Auth Provider: Redirect to login redirect_uri=<cloud_url>
  Auth Provider -->> Cloud: Redirect to <cloud_url>
  Cloud -->> Local: Redirect to <local_url>

Loading