Bridge protocol (legacy nodes): TCP JSONL, pairing, scoped RPC

Read when…
  • Building or debugging node clients (iOS/Android/macOS node mode)
  • Investigating pairing or bridge auth failures
  • Auditing the node surface exposed by the gateway

桥接协议(旧版节点传输)

桥接协议是一个旧版节点传输(TCP JSONL)。新的节点客户端应使用统一的网关WebSocket协议。

如果您正在构建一个操作员或节点客户端,请使用网关协议

注意: 当前的OpenClaw构建不再包含TCP桥接监听器;此文档仅用于历史参考。旧版bridge.*配置键不再是配置模式的一部分。

为什么同时存在两种协议

  • 安全边界:桥接暴露一个小的允许列表而不是完整的网关API表面。
  • 配对 + 节点身份:节点准入由网关管理,并与每个节点的令牌相关联。
  • 发现用户体验:节点可以通过LAN上的Bonjour发现网关,或者直接通过tailnet连接。
  • 本地回环WS:完整的WS控制平面保持本地,除非通过SSH隧道传输。

传输

  • TCP,每行一个JSON对象(JSONL)。
  • 可选TLS(当bridge.tls.enabled为true时)。
  • 旧版默认监听端口是18790(当前构建不启动TCP桥接)。

启用TLS时,发现TXT记录包括bridgeTls=1加上bridgeTlsSha256,以便节点可以固定证书。

握手 + 配对

  1. 客户端发送hello,包含节点元数据+令牌(如果已配对)。
  2. 如果未配对,网关回复error (NOT_PAIRED/UNAUTHORIZED)。
  3. 客户端发送pair-request
  4. 网关等待批准,然后发送pair-okhello-ok

hello-ok返回serverName,可能包括canvasHostUrl

客户端 → 网关:

  • req / res:范围化的网关RPC(聊天、会话、配置、健康检查、语音唤醒、skills.bins)
  • event:节点信号(语音转录、代理请求、聊天订阅、exec生命周期)

网关 → 客户端:

  • invoke / invoke-res:节点命令 (canvas.*, camera.*, screen.record, location.get, sms.send)
  • event:已订阅会话的聊天更新
  • ping / pong:心跳

旧版允许列表强制执行位于src/gateway/server-bridge.ts(已移除)。

Exec生命周期事件

节点可以发出exec.finishedexec.denied事件以显示system.run活动。 这些被映射到网关中的系统事件。(旧版节点可能仍然发出exec.started。)

负载字段(除非注明,否则全部可选):

  • sessionKey(必需):接收系统事件的代理会话。
  • runId:用于分组的唯一exec id。
  • command:原始或格式化的命令字符串。
  • exitCode, timedOut, success, output:完成详情(仅完成时)。
  • reason:拒绝原因(仅拒绝时)。

使用tailnet

  • 将桥接绑定到tailnet IP:在~/.openclaw/openclaw.json中设置bridge.bind: "tailnet"
  • 客户端通过MagicDNS名称或tailnet IP连接。
  • Bonjour跨网络;需要时使用手动主机/端口或广域DNS‑SD。

版本控制

桥接当前是隐式v1(没有最小/最大协商)。预期向后兼容;在任何重大更改之前添加桥接协议版本字段。