Gateway 协议（WebSocket）

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

传输

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

握手（connect）

Gateway → 客户端（连接前挑战）：

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

客户端 → Gateway：

{
  "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": "…"
    }
  }
}

Gateway → 客户端：

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

当颁发设备令牌时，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?}

有副作用的方法需要幂等性密钥（请参阅架构）。

角色 + 作用域

角色

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

作用域（operator）

常见作用域：

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

能力/命令/权限（node）

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

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

Gateway 将这些视为声明并强制执行服务器端允许列表。

存在

system-presence 返回按设备标识符键入的条目。
存在条目包括 deviceId、roles 和 scopes，以便 UI 可以为每个设备显示单行，即使它同时作为 operator 和 node 连接。

节点辅助方法

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

Operator 辅助方法

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

执行批准

当执行请求需要批准时，Gateway 广播 exec.approval.requested。
Operator 客户端通过调用 exec.approval.resolve（需要 operator.approvals 作用域）来解决。

版本控制

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

认证

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

设备身份 + 配对

节点应包含从密钥对指纹派生的稳定设备身份（device.id）。
Gateway 按设备 + 角色颁发令牌。
新设备 ID 需要配对批准，除非启用本地自动批准。
本地连接包括回环和 Gateway 主机的自己的 tailnet 地址（因此同一主机 tailnet 绑定仍可以自动批准）。
所有 WS 客户端必须在 connect 期间包含 device 身份（operator + node）。只有在为 break-glass 使用启用 gateway.controlUi.dangerouslyDisableDeviceAuth 时，控制 UI 才能省略它。
所有连接必须签署服务器提供的 connect.challenge nonce。
首选签名负载是 v3，它除了 device/client/role/scopes/token/nonce 字段外还绑定 platform 和 deviceFamily。
旧版 v2 签名仍然被接受以保持兼容性，但配对设备元数据固定仍控制在重新连接时控制命令策略。

TLS + 固定

WS 连接支持 TLS。
客户端可以选择固定 Gateway 证书指纹（请参阅 gateway.tls 配置加 gateway.remote.tlsFingerprint 或 CLI --tls-fingerprint）。

范围

此协议暴露完整的 Gateway API（状态、渠道、模型、聊天、代理、会话、节点、批准等）。确切的表面由 src/gateway/protocol/schema.ts 中的 TypeBox 架构定义。