2026-02-01 22:47:44 +01:00
|
|
|
|
---
|
|
|
|
|
|
read_when:
|
|
|
|
|
|
- 构建或调试节点客户端(iOS/Android/macOS 节点模式)
|
2026-02-03 13:23:00 -08:00
|
|
|
|
- 调查配对或 bridge 认证失败
|
|
|
|
|
|
- 审计 Gateway 网关暴露的节点接口
|
|
|
|
|
|
summary: Bridge 协议(旧版节点):TCP JSONL、配对、作用域 RPC
|
|
|
|
|
|
title: Bridge 协议
|
2026-02-01 22:47:44 +01:00
|
|
|
|
x-i18n:
|
2026-02-03 13:23:00 -08:00
|
|
|
|
generated_at: "2026-02-03T07:47:42Z"
|
2026-02-01 22:47:44 +01:00
|
|
|
|
model: claude-opus-4-5
|
|
|
|
|
|
provider: pi
|
|
|
|
|
|
source_hash: 789bcf3cbc6841fc293e054b919e63d661b3cc4cd205b2094289f00800127fe2
|
|
|
|
|
|
source_path: gateway/bridge-protocol.md
|
2026-02-03 13:23:00 -08:00
|
|
|
|
workflow: 15
|
2026-02-01 22:47:44 +01:00
|
|
|
|
---
|
|
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
# Bridge 协议(旧版节点传输)
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
Bridge 协议是一个**旧版**节点传输(TCP JSONL)。新的节点客户端应该使用统一的 Gateway 网关 WebSocket 协议。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
如果你正在构建操作者或节点客户端,请使用 [Gateway 网关协议](/gateway/protocol)。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
**注意:** 当前的 OpenClaw 构建不再包含 TCP bridge 监听器;本文档仅作历史参考保留。
|
|
|
|
|
|
旧版 `bridge.*` 配置键不再是配置模式的一部分。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
## 为什么我们有两种协议
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
- **安全边界**:bridge 暴露一个小的允许列表,而不是完整的 Gateway 网关 API 接口。
|
|
|
|
|
|
- **配对 + 节点身份**:节点准入由 Gateway 网关管理,并与每节点令牌绑定。
|
|
|
|
|
|
- **设备发现用户体验**:节点可以通过局域网上的 Bonjour 发现 Gateway 网关,或通过 tailnet 直接连接。
|
|
|
|
|
|
- **Loopback WS**:完整的 WS 控制平面保持本地,除非通过 SSH 隧道。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
## 传输
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
|
|
|
|
|
- TCP,每行一个 JSON 对象(JSONL)。
|
|
|
|
|
|
- 可选 TLS(当 `bridge.tls.enabled` 为 true 时)。
|
2026-02-03 13:23:00 -08:00
|
|
|
|
- 旧版默认监听端口为 `18790`(当前构建不启动 TCP bridge)。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
当 TLS 启用时,设备发现 TXT 记录包含 `bridgeTls=1` 加上 `bridgeTlsSha256`,以便节点可以固定证书。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
## 握手 + 配对
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
1. 客户端发送带有节点元数据 + 令牌(如果已配对)的 `hello`。
|
|
|
|
|
|
2. 如果未配对,Gateway 网关回复 `error`(`NOT_PAIRED`/`UNAUTHORIZED`)。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
3. 客户端发送 `pair-request`。
|
2026-02-03 13:23:00 -08:00
|
|
|
|
4. Gateway 网关等待批准,然后发送 `pair-ok` 和 `hello-ok`。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
|
|
|
|
|
`hello-ok` 返回 `serverName`,可能包含 `canvasHostUrl`。
|
|
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
## 帧
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
客户端 → Gateway 网关:
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
- `req` / `res`:作用域 Gateway 网关 RPC(chat、sessions、config、health、voicewake、skills.bins)
|
|
|
|
|
|
- `event`:节点信号(语音转录、智能体请求、聊天订阅、exec 生命周期)
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
Gateway 网关 → 客户端:
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
|
|
|
|
|
- `invoke` / `invoke-res`:节点命令(`canvas.*`、`camera.*`、`screen.record`、`location.get`、`sms.send`)
|
|
|
|
|
|
- `event`:已订阅会话的聊天更新
|
|
|
|
|
|
- `ping` / `pong`:保活
|
|
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
旧版允许列表强制执行位于 `src/gateway/server-bridge.ts`(已移除)。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
## Exec 生命周期事件
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
节点可以发出 `exec.finished` 或 `exec.denied` 事件来表面化 system.run 活动。
|
|
|
|
|
|
这些被映射到 Gateway 网关中的系统事件。(旧版节点可能仍会发出 `exec.started`。)
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
Payload 字段(除非注明,否则都是可选的):
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
- `sessionKey`(必需):接收系统事件的智能体会话。
|
|
|
|
|
|
- `runId`:用于分组的唯一 exec id。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
- `command`:原始或格式化的命令字符串。
|
|
|
|
|
|
- `exitCode`、`timedOut`、`success`、`output`:完成详情(仅限 finished)。
|
|
|
|
|
|
- `reason`:拒绝原因(仅限 denied)。
|
|
|
|
|
|
|
|
|
|
|
|
## Tailnet 使用
|
|
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
- 将 bridge 绑定到 tailnet IP:在 `~/.openclaw/openclaw.json` 中设置 `bridge.bind: "tailnet"`。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
- 客户端通过 MagicDNS 名称或 tailnet IP 连接。
|
2026-02-03 13:23:00 -08:00
|
|
|
|
- Bonjour **不**跨网络;需要时使用手动主机/端口或广域 DNS‑SD。
|
2026-02-01 22:47:44 +01:00
|
|
|
|
|
|
|
|
|
|
## 版本控制
|
|
|
|
|
|
|
2026-02-03 13:23:00 -08:00
|
|
|
|
Bridge 目前是**隐式 v1**(无最小/最大协商)。预期向后兼容;在任何破坏性变更之前添加 bridge 协议版本字段。
|