网关协议

网关协议（WebSocket）

网关 WS 协议是 OpenClaw 的单一控制平面 + 节点传输。所有客户端（CLI、Web UI、macOS 应用、iOS/Android 节点、无头节点）都通过 WebSocket 连接，并在握手时声明其角色 + 范围。

传输

WebSocket，带有 JSON 负载的文本帧。
第一帧必须是 connect 请求。

握手（connect）

网关 → 客户端（预连接挑战）：

{
  "type": "event",
  "event": "connect.challenge",
  "payload": { "nonce": "…", "ts": 1737264000000 }
}

客户端 → 网关：

{
  "type": "req",
  "id": "…",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 3,
    "client": {
      "id": "cli",
      "version": "1.2.3",
      "platform": "macos",
      "mode": "operator"
    },
    "role": "operator",
    "scopes": ["operator.read", "operator.write"],
    "caps": [],
    "commands": [],
    "permissions": {},
    "auth": { "token": "…" },
    "locale": "en-US",
    "userAgent": "openclaw-cli/1.2.3",
    "device": {
      "id": "device_fingerprint",
      "publicKey": "…",
      "signature": "…",
      "signedAt": 1737264000000,
      "nonce": "…"
    }
  }
}

网关 → 客户端：

{
  "type": "res",
  "id": "…",
  "ok": true,
  "payload": { "type": "hello-ok", "protocol": 3, "policy": { "tickIntervalMs": 15000 } }
}

当颁发设备 token 时，hello-ok 还包括：

{
  "auth": {
    "deviceToken": "…",
    "role": "operator",
    "scopes": ["operator.read", "operator.write"]
  }
}

节点示例

{
  "type": "req",
  "id": "…",
  "method": "connect",
  "params": {
    "minProtocol": 3,
    "maxProtocol": 3,
    "client": {
      "id": "ios-node",
      "version": "1.2.3",
      "platform": "ios",
      "mode": "node"
    },
    "role": "node",
    "scopes": [],
    "caps": ["camera", "canvas", "screen", "location", "voice"],
    "commands": ["camera.snap", "canvas.navigate", "screen.record", "location.get"],
    "permissions": { "camera.capture": true, "screen.record": false },
    "auth": { "token": "…" },
    "locale": "en-US",
    "userAgent": "openclaw-ios/1.2.3",
    "device": {
      "id": "device_fingerprint",
      "publicKey": "…",
      "signature": "…",
      "signedAt": 1737264000000,
      "nonce": "…"
    }
  }
}

帧结构

请求：{type:"req", id, method, params}
响应：{type:"res", id, ok, payload|error}
事件：{type:"event", event, payload, seq?, stateVersion?}

副作用方法需要幂等性 key（参见 schema）。

角色 + 范围

角色

operator = 控制平面客户端（CLI/UI/自动化）。
node = 能力主机（camera/screen/canvas/system.run）。

范围（operator）

常见范围：

operator.read
operator.write
operator.admin
operator.approvals
operator.pairing

Caps/commands/permissions（node）

节点在连接时声明能力主张：

caps：高级别能力类别。
commands：用于 invoke 的命令允许列表。
permissions：细粒度开关（例如 screen.record、camera.capture）。

网关将这些视为主张并执行服务器端允许列表。

存在状态

system-presence 返回以设备身份为 key 的条目。
存在状态条目包括 deviceId、roles 和 scopes，因此 UI 可以为每个设备显示单行，即使它同时作为operator和node连接。

节点辅助方法

节点可以调用 skills.bins 来获取当前技能可执行文件列表，用于自动允许检查。

Operator 辅助方法

Operator 可以调用 tools.catalog（operator.read）来获取代理的运行时工具目录。响应包括分组的工具和来源元数据：
- source：core 或 plugin
- pluginId：当 source="plugin" 时的插件所有者
- optional：插件工具是否为可选

Exec 审批

当 exec 请求需要审批时，网关广播 exec.approval.requested。
Operator 客户端通过调用 exec.approval.resolve 来解决（需要 operator.approvals 范围）。
对于 host=node，exec.approval.request 必须包含 systemRunPlan（规范的 argv/cwd/rawCommand/会话元数据）。缺少 systemRunPlan 的请求将被拒绝。

版本控制

PROTOCOL_VERSION 位于 src/gateway/protocol/schema.ts。
客户端发送 minProtocol + maxProtocol；服务器拒绝不匹配。
Schemas + 模型从 TypeBox 定义生成：
- pnpm protocol:gen
- pnpm protocol:gen:swift
- pnpm protocol:check

认证

如果设置了 OPENCLAW_GATEWAY_TOKEN（或 --token），connect.params.auth.token 必须匹配，否则 socket 将关闭。
配对后，网关颁发一个设备 token，范围限定为连接角色 + 范围。它在 hello-ok.auth.deviceToken 中返回，客户端应将其持久化以供未来连接使用。
设备 token 可以通过 device.token.rotate 和 device.token.revoke 轮换/撤销（需要 operator.pairing 范围）。

设备身份 + 配对

节点应包含一个稳定的设备身份（device.id），源自密钥对指纹。
网关为每个设备 + 角色颁发 token。
除非启用了本地自动审批，否则新设备 ID 需要配对审批。
本地连接包括环回和网关机器的自有 tailnet 地址（因此同主机 tailnet 绑定仍然可以自动审批）。
所有 WS 客户端在 connect 期间必须包含 device 身份（operator + node）。控制 UI 仅在启用 gateway.controlUi.dangerouslyDisableDeviceAuth 用于紧急情况下时可以省略它。
所有连接必须签署服务器提供的 connect.challenge nonce。

设备认证迁移诊断

对于仍使用预挑战签名行为的传统客户端，connect 现在在 error.details.code 下返回 DEVICE_AUTH_* 详细代码，并带有稳定的 error.details.reason。

常见迁移失败：

消息	details.code	details.reason	含义
`device nonce required`	`DEVICE_AUTH_NONCE_REQUIRED`	`device-nonce-missing`	客户端省略 `device.nonce`（或发送空白）。
`device nonce mismatch`	`DEVICE_AUTH_NONCE_MISMATCH`	`device-nonce-mismatch`	客户端使用过时/错误的 nonce 签名。
`device signature invalid`	`DEVICE_AUTH_SIGNATURE_INVALID`	`device-signature`	签名负载与 v2 负载不匹配。
`device signature expired`	`DEVICE_AUTH_SIGNATURE_EXPIRED`	`device-signature-stale`	签名时间戳超出允许的偏差范围。
`device identity mismatch`	`DEVICE_AUTH_DEVICE_ID_MISMATCH`	`device-id-mismatch`	`device.id` 与公钥指纹不匹配。
`device public key invalid`	`DEVICE_AUTH_PUBLIC_KEY_INVALID`	`device-public-key`	公钥格式/规范化失败。

迁移目标：

始终等待 connect.challenge。
签署包含服务器 nonce 的 v2 负载。
在 connect.params.device.nonce 中发送相同的 nonce。
首选签名负载是 v3，除了设备/客户端/角色/范围/token/nonce 字段外，还绑定了 platform 和 deviceFamily。
为了兼容性，传统 v2 签名仍然被接受，但配对设备元数据 pinning 仍然在重新连接时控制命令策略。

TLS + pinning

WS 连接支持 TLS。
客户端可以选择 pin 网关证书指纹（参见 gateway.tls 配置加上 gateway.remote.tlsFingerprint 或 CLI --tls-fingerprint）。

范围

此协议公开完整的网关 API（status、channels、models、chat、agent、sessions、nodes、approvals 等）。确切表面由 src/gateway/protocol/schema.ts 中的 TypeBox schemas 定义。