WebSocket

どのようなものか

WebSocketは、接続の両側がいつでもデータを送れる通信プロトコルです。
HTTPのハンドシェイクで接続を確立し、どちらかが閉じるか、接続に障害が
起きるまで開いたままにします。IETFは2011年12月にRFC
6455として公開しました。ブラウザーがスクリプトに公開する`WebSocket`
オブジェクトは、WHATWGのWebSockets
Standardで定義されています。コードや文書ではwebsocketやweb
socketともよく書かれ、複数形のWebSocketsは通常、この技術全体を指しま
す。

従来のHTTP/1.1のハンドシェイクは、通常の`GET`から始まります。クライ
アントは`Upgrade:
websocket`と`Connection:
Upgrade`、値が13の`Sec-WebSocket-Version`、ランダムな16バイトを
base64で符号化した`Sec-WebSocket-Key`を加えます。受け入れるサーバー
は、101
Switching
Protocolsと`Sec-WebSocket-Accept`ヘッダーを返します。この値は、古い
応答の再送ではなく、今回のハンドシェイクをサーバーが読んだことを示し
ます。クライアントのキーに固定のGUIDを足し、SHA-1でハッシュ化して
base64で符号化したものです。この時点で、その接続上のHTTPは終わり、双
方はフレームを交換します。一方、HTTP/2とHTTP/3は、RFC
8441とRFC 9220が定める拡張CONNECTを使い、1本のストリーム上で
WebSocketを扱います。

フレームは小さな単位です。ヘッダーは2バイトから始まり、ペイロードが
125バイトを超えると、さらに2バイトまたは8バイト増えます。クライアン
トからのフレームにはマスキングキーがあるため、さらに4バイト加わりま
す。各フレームはオペコードを持ち、テキスト、バイナリ、複数フレームに
分割したメッセージの継続を区別します。このほか、終了、ping、pongの3
種類の制御フレームがあります。テキストメッセージ全体は正しいUTF-8で
なければなりませんが、個々の断片ではUTF-8の並びの途中で分割できま
す。クライアントが送るすべてのフレームは、新しいランダムな32ビット
キーでマスクし、サーバーは一切マスクしません。マスキングは暗号化では
ありません。悪意のあるスクリプトがネットワークを流れるバイト列を正確
に選び、途中のキャッシュプロキシを汚染するために使うことを防ぐ仕組み
です。

アドレスのスキームは`ws://`と`wss://`で、指定しなければ、それぞれ
ポート80と443を使います。`wss`では、やり取り全体をTLSの内側で行いま
す。HTTPと同じポートを使うのは意図的です。途中のファイアウォールやプ
ロキシには、ハンドシェイクがほかのウェブリクエストと同じように見える
ためです。

なぜ重要なのか

短いHTTP応答では、サーバーは問い合わせられたときにしか話せません。多
くの製品は、その逆を必要とします。チャットのメッセージ、変わったばか
りの価格、共有文書のカーソル、終了したバックグラウンド処理などです。
サーバーから送れる経路がなければ、クライアントはポーリングするしかあ
りません。数秒ごとに問い合わせ、たいていは変化がないという応答を受け
取ります。どの応答もヘッダー一式を含み、知らせが届くまで最大で問い合
わせ1回分の間隔だけ待ちます。開いたWebSocket接続は、両方の負担を取り
除きます。サーバーは次の問い合わせを待たず、何かが起きたときに送れま
す。各メッセージに必要なのは、HTTPヘッダー一式ではなく、フレーム用の
数バイトだけです。

その代償は、状態を持つことです。HTTPリクエストはロードバランサーの背
後のどのサーバーに届いても構いませんが、WebSocket接続は、存在する間
ずっと1つのプロセスに属します。そのプロセスは、開いている接続ごとに
メモリーを確保し、デプロイや再起動で全接続が一度に切れます。途中のす
べてのプロキシとロードバランサーも、ハンドシェイクに対応し、何分も無
通信になることがある接続を維持しなければなりません。サーバーを複数動
かすと、通常のHTTPでは問われない問題も生まれます。サーバーAで起きた
ことを、サーバーBに接続しているクライアントへ、どう届けるのでしょう
か。一般的な答えは、全サーバーが購読する共通のパブリッシュ・サブスク
ライブ経路です。運用するシステムが、さらに1つ増えます。

したがって、WebSocketは既定の選択肢ではなく、用途に応じて選ぶ方式で
す。知らせを送るのがサーバーだけなら、HTML標準が定めるServer-Sent
Eventsで、通常のHTTP応答を`text/event-stream`として使ってイベントを
送れます。応答が途切れると、ブラウザーが自動的に再接続します。
WebSocketの追加の仕組みが見合うのは、チャット、ゲーム、共同編集のよ
うに、クライアントもサーバーと同程度に送るものがある場合です。

実際の活用例

次のやり取りは、チャット接続を開きます。キーはRFC
6455に載っている例で、受け入れを示す値も、正しいサーバーならこのキー
に対して必ず返す、標準に掲載された値です。

```http
GET /chat HTTP/1.1
Host: example.com
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
Sec-WebSocket-Version: 13
Origin: https://example.com

HTTP/1.1 101 Switching Protocols
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Accept: s3pPLMBiTxaQ9kYGzzhZRbK+xOo=
```

サーバーの応答を終える空行の後は、この接続上にHTTPは流れません。ブラ
ウザーは、コンストラクターを1回呼ぶだけでハンドシェイク全体を処理
し、その後はイベントリスナーに引き継ぎます。

```js
const socket = new WebSocket("wss://example.com/chat");
socket.addEventListener("open", () => socket.send("hello"));
socket.addEventListener("message", (event) => console.log(event.data));
socket.addEventListener("close", (event) => {
  console.log(event.code, event.reason, event.wasClean);
});
```

closeイベントは、接続がどのように終わったかを示します。コード1000は
正常終了で、1001は、サーバーの停止やブラウザーでページを離れる場合な
ど、相手が接続から離れることを意味します。1006は、closeフレームを受
け取らずに接続が切れたことを示します。どのエンドポイントも、このコー
ドを送ってはいけません。上位のプログラムが異常終了と正常終了を区別す
るためだけの値です。

リクエストと応答の仕組みと、ソケットそのものを扱う仕組みの違いは、こ
のサイトの実績にある1つのプロジェクトにはっきり表れています。APIを
Huma
v2へ移した際、ちょうど2つを除く全ルートをHumaのリクエスト・レスポン
スモデルに移しました。WebSocketエンドポイントは、ソケット自体を必要
とし、Humaのモデルには合わないため、Fiberを直接使う形で残しました。
HTTPの形を基に作られたフレームワークは、リクエストと応答を記述し、検
証するのには適しています。長く維持する双方向接続は、それとは別のもの
です。

問題が起きるところ

別のサイトのページが、訪問者のCookieで接続を開く。
ブラウザーはサーバーのホストにハンドシェイクのリクエストを送り、ブラ
ウザーのCookie方針が認める場合、そのCookieを含めることがあります。認
証付きのクロスサイトリクエストが認められる場合、Cookieで認証するサー
バーが`Origin`ヘッダーを無視すると、別サイトのページが開いた接続を、
訪問者本人のものとして受け入れるおそれがあります。RFC
6455は、特定のサイトだけを想定するサーバーに対し、`Origin`が想定する
ものか検査し、それ以外は403
Forbiddenで拒否するよう勧めています。接続を受け入れる前のハンドシェ
イクで行います。

アクセストークンがログに残る。
ブラウザーの`WebSocket`コンストラクターが受け取るのは、URLと、任意指
定のサブプロトコル一覧だけです。そのため、スクリプトから
`Authorization`ヘッダーを追加できません。手早い回避策はURLにトークン
を入れることですが、リバースプロキシやアクセスログにも記録されます。
RFCは認証方式を限定せず、Cookie、HTTP認証、TLS認証を選択肢として挙げ
ています。上記の`Origin`検査を組み合わせたCookieが使えます。また、認
証済みのHTTP呼び出しでページが取得し、ハンドシェイクで1回だけ使う、
有効期間の短いチケットも使えます。

再起動で全クライアントが集中する。
突然のデプロイや再起動で、全接続が一度に閉じることがあります。close
フレームを受け取らなかったクライアントは、1006を報告します。全員が直
ちに再接続し、試行を続けると、復帰したサーバーは、RFCがサービス拒否
攻撃に例える集中を受けます。RFC
6455は、最初の試行前にランダムな時間を待つよう求め、0秒から5秒の間を
例に挙げています。さらに失敗するたびに、上限付きの二進指数バックオフ
などで、待ち時間を長くするよう求めています。停止前に1001で接続を閉じ
るサーバーなら、少なくとも計画的な切断であることを伝えられます。

```js
function reconnectDelay(attempt) {
  if (attempt === 0) return Math.random() * 5000;
  const ceiling = Math.min(60_000, 1000 * 2 ** attempt);
  return Math.random() * ceiling;
}
```

接続が切れても誰も気付かない。
通信のない接続では、経路がまだ存在するという手掛かりを双方とも得られ
ません。closeフレームなしに消えた相手は、次の書き込みが失敗するま
で、静かな相手と区別が付きません。そのためにpingとpongがあります。エ
ンドポイントは、closeフレームをすでに受け取っていない限り、pingに
pongで答えなければなりません。未応答のpingが複数あれば、最後のものだ
けに答えても構いません。RFCは、pingを接続の維持にも、相手が応答する
かの確認にも使えるとしています。ブラウザーAPIからpingを送る手段はな
いため、タイマーはサーバー側に置きます。接続ごとに一定間隔でpingを送
り、pongが返らないものを閉じます。

1つのメッセージがサーバーのメモリーを使い尽くす。
フレームヘッダーの長さフィールドは、どんなサーバーのメモリーにも収ま
らないほど大きなペイロードを表現できます。RFCは、悪意のある相手が、
巨大な1フレームや、途切れない小さな断片の列を送るおそれを指摘してい
ます。実装側で守らなければならないため、サーバーのライブラリーにメッ
セージサイズの上限を設定し、超えた相手には、メッセージが大きすぎるこ
とを表す1009で接続を閉じます。逆方向にも同じ滞留が起きます。ブラウ
ザーでは、`bufferedAmount`が、`send()`でキューに入り、まだネットワー
クへ送られていないバイト数を示します。WHATWGの例は、この値がゼロのと
きだけ、次の更新を送ります。サーバー側も、読むのが遅いクライアントに
よって送信バッファーが同じように埋まるため、接続ごとに上限と、それに
達したときの規則が必要です。

参考資料

  * RFC 6455: WebSocketプロトコル —
ハンドシェイク、フレーム、マスキング、終了コードと、それぞれのセキュ
リティ上の理由。

  * WebSockets Standard —
ブラウザーAPI。コンストラクター、`send()`、`close()`、
`bufferedAmount`、closeイベント。

  * RFC 9110: HTTPの意味論 — ハンドシェイクが使う`Upgrade`ヘッダー
フィールドと、101 Switching
Protocolsステータス。

  * Server-Sent Events — 再接続を組み込んだ、HTML標準による単方向の
代替手段。

  * RFC 8441: HTTP/2でのWebSocketの起動 —
拡張CONNECTで、HTTP/2の多重化された1ストリーム上にWebSocketを載せま
す。

  * RFC 9220: HTTP/3でのWebSocketの起動 — HTTP/3に対応する拡張
CONNECTの仕組み。

hこのページのウェブ版	URL:https://engineer.company/ja/glossary/websocket/	engineer.company	70
