Bridge 协议(旧版节点传输)
Bridge 协议是一个旧版节点传输协议(TCP JSONL)。新的节点客户端应该使用统一的 Gateway WebSocket 协议。
如果你正在构建 operator 或节点客户端,请使用 Gateway 协议。
注意: 当前的 OpenClaw 构建版本已不再包含 TCP Bridge 监听器;本文档仅作历史参考。旧版的 bridge.* 配置项已不再是配置架构的一部分。
为什么有两种协议
- 安全边界:Bridge 只暴露一个小的白名单,而不是完整的 Gateway API 接口。
- Pairing + 节点身份:节点准入由 Gateway 管理,并绑定到每个节点的 token。
- 发现体验:节点可以通过局域网的 Bonjour 发现 Gateway,或直接通过 tailnet 连接。
- 本地回环 WS:完整的 WS 控制平面保持在本地,除非通过 SSH 隧道。
传输方式
- TCP,每行一个 JSON 对象(JSONL)。
- 可选 TLS(当
bridge.tls.enabled为 true 时)。 - 旧版默认监听端口是
18790(当前构建版本不会启动 TCP Bridge)。
当启用 TLS 时,发现的 TXT 记录会包含 bridgeTls=1 以及 bridgeTlsSha256,这样节点就可以固定证书。
握手 + 配对
- 客户端发送
hello,包含节点元数据 + token(如果已配对)。 - 如果未配对,Gateway 回复
error(NOT_PAIRED/UNAUTHORIZED)。 - 客户端发送
pair-request。 - Gateway 等待批准,然后发送
pair-ok和hello-ok。
hello-ok 返回 serverName,可能还包含 canvasHostUrl。
帧格式
客户端 → Gateway:
req/res:作用域内的 Gateway RPC(chat、sessions、config、health、voicewake、skills.bins)event:节点信号(语音转录、Agent 请求、chat 订阅、执行生命周期)
Gateway → 客户端:
invoke/invoke-res:节点命令(canvas.*、camera.*、screen.record、location.get、sms.send)event:已订阅 Session 的 chat 更新ping/pong:保活
旧版的白名单强制执行逻辑位于 src/gateway/server-bridge.ts(已移除)。
执行生命周期事件
节点可以发出 exec.finished 或 exec.denied 事件来展示 system.run 活动。这些事件会被映射为 Gateway 中的系统事件。(旧版节点可能仍会发出 exec.started。)
载荷字段(除非标注,否则都是可选的):
sessionKey(必需):接收系统事件的 Agent Session。runId:用于分组的唯一执行 ID。command:原始或格式化的命令字符串。exitCode、timedOut、success、output:完成详情(仅 finished)。reason:拒绝原因(仅 denied)。
Tailnet 使用
- 将 Bridge 绑定到 tailnet IP:在
~/.openclaw/openclaw.json中设置bridge.bind: "tailnet"。 - 客户端通过 MagicDNS 名称或 tailnet IP 连接。
- Bonjour 不会跨网络;需要时使用手动 host/port 或广域 DNS-SD。
版本控制
Bridge 目前是隐式 v1(没有最小/最大版本协商)。预期保持向后兼容;在任何破坏性更改之前,需要添加 Bridge 协议版本字段。