Adds OpenChamber Relay — an opt-in way to reach an instance from a phone, browser, or another desktop from anywhere, with no open inbound ports, no tunnel, and no shared LAN. The instance dials outbound to a relay; all app traffic (HTTP, the event stream, terminal, dictation) is multiplexed and encrypted through a single connection per client, so the relay only ever forwards opaque ciphertext. Transport - End-to-end-encrypted channel over WebCrypto (ECDH P-256 -> HKDF -> AES-256-GCM) with a capability-negotiated handshake and a small HTTP/SSE/WebSocket multiplexing protocol. A byte-compatible JS host mirror is cross-checked by tests. - Host: outbound connection manager, per-client tunnel dispatcher to the local server over loopback, reuse of the existing instance identity key, and management routes. Disabled by default; explicit opt-in. - Client: plugs into the existing runtime layer (runtime-fetch/-url/-switch/ -auth, event pipeline, terminal, dictation) so features work over the relay unchanged; direct-URL and Electron realtime-proxy paths are untouched. Pairing & UX - Relay section in Settings -> Remote Instances (live status, QR/link pairing, revocation via the existing client-token list) and the mobile connect flow. - Frame batching and idle-gated keepalive keep tunnel message volume low without affecting streaming smoothness. Security - The tunnel is transport only; the server authenticates every tunneled request exactly as for a direct remote client. fragments only. The relay stores no keys, tokens, or payloads. Operability - The endpoint can be pinned to a self-hosted rel paired clients inherit it from the offer automatically. - Relay module DOCUMENTATION.md and a relay-trans invariants that future WebSocket/streaming changes must follow. The relay transport is complete and tested; the UI for enabling and pairing is gated behind openchamber_relay_gate and stays
21 lines
1.1 KiB
TypeScript
21 lines
1.1 KiB
TypeScript
// Opens a runtime WebSocket the right way for the active runtime: through the
|
|
// relay tunnel when relay mode is active, or a native browser WebSocket
|
|
// otherwise (wrapped to the same shape). Every runtime WS consumer — the event
|
|
// pipeline, dictation, terminal — must go through here so relay mode carries
|
|
// ALL socket traffic, not just the main event stream. A raw `new WebSocket(url)`
|
|
// against a relay-mode runtime fails: the resolver yields a tunnel-virtual URL
|
|
// (or a capacitor:// origin) that the platform WebSocket rejects with
|
|
// "The string did not match the expected pattern".
|
|
|
|
import { getActiveRelayTunnel } from './runtime-tunnel';
|
|
import { wsUrlToTunnelPath } from './tunnel-payloads';
|
|
import { wrapBrowserWebSocket, type RelayTunnelWebSocket } from './tunnel-client';
|
|
|
|
export const openRuntimeWebSocket = (url: string, protocols?: string[]): RelayTunnelWebSocket => {
|
|
const relay = getActiveRelayTunnel();
|
|
if (relay) {
|
|
return relay.openWebSocket(wsUrlToTunnelPath(url), protocols);
|
|
}
|
|
return wrapBrowserWebSocket(protocols ? new WebSocket(url, protocols) : new WebSocket(url));
|
|
};
|