Bridge 协议(旧版节点传输)
Bridge 协议是旧版节点传输方式(TCP JSONL)。新的节点客户端应使用统一的 Gateway WebSocket 协议。
如果你在开发 operator 或节点客户端,请使用 Gateway 协议。
说明: 当前版本的 OpenClaw 已不再包含 TCP bridge 监听器;本文档仅作历史参考。
旧版 bridge.* 配置键已不属于配置 schema。
为什么同时存在两种协议
- 安全边界:bridge 只暴露一个小的白名单,而非完整的 Gateway API 接口。
- 配对 + 节点身份:节点准入由 Gateway 管理,绑定到每节点的 token。
- 发现体验:节点可以通过局域网 Bonjour 发现 Gateway,或通过 tailnet 直连。
- 回环 WS:完整的 WS 控制面保持在本地,除非通过 SSH 隧道。
传输方式
- TCP,每行一个 JSON 对象(JSONL)。
- 可选 TLS(当
bridge.tls.enabled为 true 时)。 - 旧版默认监听端口为
18790(当前版本不启动 TCP bridge)。
启用 TLS 时,发现 TXT 记录中会包含 bridgeTls=1 和 bridgeTlsSha256 作为非机密提示。注意 Bonjour/mDNS TXT 记录未经认证;客户端不应将广播的指纹视为权威钉扎,除非有用户的显式确认或其他带外验证。
握手 + 配对
- 客户端发送
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 订阅、exec 生命周期)
Gateway → 客户端:
invoke/invoke-res:节点命令(canvas.*、camera.*、screen.record、location.get、sms.send)event:已订阅会话的聊天更新ping/pong:保活
旧版白名单执行逻辑位于 src/gateway/server-bridge.ts(已移除)。
Exec 生命周期事件
节点可以发送 exec.finished 或 exec.denied 事件来呈现 system.run 活动。
这些会被映射为 Gateway 中的系统事件。(旧版节点可能仍会发送 exec.started。)
Payload 字段(除注明外均可选):
sessionKey(必填):接收系统事件的 agent 会话。runId:唯一 exec ID,用于分组。command:原始或格式化的命令字符串。exitCode、timedOut、success、output:完成详情(仅 finished)。reason:拒绝原因(仅 denied)。
Tailnet 用法
- 将 bridge 绑定到 tailnet IP:在
~/.openclaw/openclaw.json中设置bridge.bind: "tailnet"。 - 客户端通过 MagicDNS 名称或 tailnet IP 连接。
- Bonjour 不能跨网络;需要时请使用手动主机/端口或广域 DNS-SD。
版本控制
Bridge 目前是隐式 v1(没有最小/最大版本协商)。预期保持向后兼容;在做任何破坏性变更前应添加 bridge 协议版本字段。