メインコンテンツへスキップ

Gateway アーキテクチャ

最終更新日: 2026-01-22

概要

  • 単一の長時間稼働 Gateway が、すべてのメッセージングサーフェス(Baileys 経由の WhatsApp、grammY 経由の Telegram、Slack、Discord、Signal、iMessage、WebChat)を管理します。
  • コントロールプレーンのクライアント(macOS アプリ、CLI、Web UI、自動化)は、設定されたバインドホスト(デフォルトは 127.0.0.1:18789)上の WebSocket 経由で Gateway に接続します。
  • ノード(macOS / iOS / Android / ヘッドレス)も WebSocket 経由で接続しますが、明示的な capabilities / コマンドを伴う role: node を宣言します。
  • ホストあたり 1 つの Gateway とし、WhatsApp セッションを開くのはここだけです。
  • canvas host は Gateway HTTP サーバーによって以下のパスで提供されます:
    • /__openclaw__/canvas/(エージェントが編集可能な HTML/CSS/JS)
    • /__openclaw__/a2ui/(A2UI ホスト) Gateway と同じポート(デフォルト 18789)を使用します。

コンポーネントとフロー

Gateway(デーモン)

  • プロバイダー接続を維持します。
  • 型付き WS API(リクエスト、レスポンス、サーバープッシュイベント)を公開します。
  • 受信フレームを JSON Schema に対して検証します。
  • agentchatpresencehealthheartbeatcron などのイベントを発行します。

クライアント(mac アプリ / CLI / Web 管理)

  • クライアントごとに 1 つの WS 接続。
  • リクエストを送信します(healthstatussendagentsystem-presence)。
  • イベントを購読します(tickagentpresenceshutdown)。

ノード(macOS / iOS / Android / ヘッドレス)

  • role: node を用いて 同一の WS サーバー に接続します。
  • connect にデバイスアイデンティティを提供します。ペアリングは デバイスベース(ロールは node)であり、承認はデバイスペアリングストアに保存されます。
  • canvas.*camera.*screen.recordlocation.get などのコマンドを公開します。
プロトコルの詳細:

WebChat

  • Gateway WS API を使用してチャット履歴を取得し、送信を行う静的 UI です。
  • リモート構成では、他のクライアントと同じ SSH / Tailscale トンネルを通じて接続します。

接続ライフサイクル(単一クライアント)

ワイヤープロトコル(概要)

  • トランスポート: WebSocket、JSON ペイロードを含むテキストフレーム。
  • 最初のフレームは 必ず connect でなければなりません。
  • ハンドシェイク後:
    • リクエスト: {type:"req", id, method, params}{type:"res", id, ok, payload|error}
    • イベント: {type:"event", event, payload, seq?, stateVersion?}
  • OPENCLAW_GATEWAY_TOKEN(または --token)が設定されている場合、connect.params.auth.token が一致しなければソケットはクローズされます。
  • 副作用を伴うメソッド(sendagent)では、安全に再試行できるよう冪等性キーが必須です。サーバーは短命の重複排除キャッシュを保持します。
  • ノードは role: "node" に加え、connect に capabilities / コマンド / 権限を含める必要があります。

ペアリングとローカルの信頼度

  • すべての WS クライアント(オペレーター + ノード)は、connectデバイスアイデンティティ を含めます。
  • 新しいデバイス ID にはペアリング承認が必要です。Gateway は、以降の接続用に デバイストークン を発行します。
  • ローカル 接続(ループバック、またはゲートウェイホスト自身の tailnet アドレス)は、同一ホストでの UX を円滑に保つため自動承認できます。
  • 非ローカル 接続は、connect.challenge の nonce に署名する必要があり、明示的な承認が必要です。
  • Gateway 認証(gateway.auth.*)は、ローカル/リモートを問わず すべて の接続に適用されます。
詳細: Gateway protocolPairingSecurity

プロトコルの型付けとコード生成

  • TypeBox スキーマがプロトコルを定義します。
  • それらのスキーマから JSON Schema が生成されます。
  • JSON Schema から Swift モデルが生成されます。

リモートアクセス

  • 推奨: Tailscale または VPN。
  • 代替: SSH トンネル
    ssh -N -L 18789:127.0.0.1:18789 user@host
    
  • トンネル越しでも同一のハンドシェイク + 認証トークンが適用されます。
  • リモート構成では、WS に対して TLS + 任意のピンニングを有効化できます。

運用スナップショット

  • 起動: openclaw gateway(フォアグラウンド、ログは stdout に出力)。
  • ヘルス: WS 経由の healthhello-ok にも含まれます)。
  • 監督: 自動再起動のために launchd / systemd を使用します。

不変条件

  • 各ホストにつき、単一の Baileys セッションを制御する Gateway は 正確に 1 つ です。
  • ハンドシェイクは必須です。JSON 以外、または connect 以外の最初のフレームは即時クローズされます。
  • イベントは再送されません。欠落がある場合、クライアントは再取得する必要があります。