网关协议（WebSocket）

适用范围

在以下情况使用此页面：

• 实现或更新网关 WS 客户端
• 调试协议不匹配或连接失败
• 重新生成协议架构/模型

网关 WS 协议是 Moltbot 的 单一控制平面 + 节点传输。 所有客户端（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": "moltbot-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 } }
}

当发出设备令牌时，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": "moltbot-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.read
• operator.write
• operator.admin
• operator.approvals
• operator.pairing

能力/命令/权限（节点）

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

• caps：高级能力类别。
• commands：invoke 的命令允许列表。
• permissions：精细切换（例如 screen.record、camera.capture）。

网关将这些视为 索赔 并强制执行服务器端允许列表。

在场

• system-presence 返回按设备身份键控的条目。
• 在场条目包括 deviceId、roles 和 scopes，因此 UI 可以每个设备显示一行，即使它同时连接为 操作员 和 节点。

节点辅助方法

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

Exec 批准

• 当 exec 请求需要批准时，网关广播 exec.approval.requested。
• 操作员客户端通过调用 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

身份验证

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

设备身份 + 配对

• 节点应该包括从密钥对指纹派生的稳定设备身份（device.id）。
• 网关为每个设备 + 角色发出令牌。
• 除非启用本地自动批准，否则新设备 ID 需要配对批准。
• 本地连接包括回环和网关主机自己的 tailnet 地址（因此同主机 tailnet 绑定仍然可以自动批准）。
• 所有 WS 客户端在 connect 期间必须包括 device 身份（操作员 + 节点）。 控制 UI 仅在启用 gateway.controlUi.allowInsecureAuth 时才能省略它。
• 非本地连接必须签署服务器提供的 connect.challenge nonce。

TLS + 固定

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

作用域

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