桥接协议（遗留节点传输）

桥接协议是一个遗留的节点传输（TCP JSONL）。新的节点客户端应该使用统一的 Gateway WebSocket 协议。

如果你正在构建操作员或节点客户端，请使用 Gateway 协议。

注意： 当前的 OpenClaw 构建不再附带 TCP 桥接监听器；此文档保留用于历史参考。 遗留的 bridge.* 配置键不再是配置模式的一部分。

为什么我们同时拥有两者

  • 安全边界：桥接暴露一个小的白名单，而不是完整的 gateway API 表面。
  • 配对 + 节点身份：节点准入由 gateway 拥有，并绑定到每个节点的令牌。
  • 发现 UX：节点可以通过 LAN 上的 Bonjour 发现 gateway，或通过 tailnet 直接连接。
  • 回环 WS：完整的 WS 控制平面保持本地，除非通过 SSH 隧道。

传输

  • TCP，每行一个 JSON 对象（JSONL）。
  • 可选 TLS（当 bridge.tls.enabled 为 true 时）。
  • 遗留默认监听器端口为 18790（当前构建不启动 TCP 桥接）。

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

握手 + 配对

  1. 客户端使用节点元数据 + 令牌（如果已配对）发送 hello。
  2. 如果未配对，gateway 回复 error（NOT_PAIRED/UNAUTHORIZED）。
  3. 客户端发送 pair-request。
  4. Gateway 等待批准，然后发送 pair-ok 和 hello-ok。

hello-ok 返回 serverName，可能包含 canvasHostUrl。

帧

客户端 → Gateway：

  • req / res：作用域 gateway RPC（聊天、会话、配置、健康、voicewake、skills.bins）
  • event：节点信号（语音转录、agent 请求、聊天订阅、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。）

载荷字段（除非另有说明，均为可选）：

  • sessionKey（必需）：接收系统事件的 agent 会话。
  • runId：用于分组的唯一 exec id。
  • command：原始或格式化的命令字符串。
  • exitCode、timedOut、success、output：完成详情（仅 finished）。
  • reason：拒绝原因（仅 denied）。

Tailnet 使用

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

版本控制

桥接当前是隐式 v1（无最小/最大协商）。预期向后兼容；在任何破坏性更改之前添加桥接协议版本字段。

← 返回文档首页