Files
cpp-httplib/docs-src/pages/ja/cookbook/w05-websocket-tls.md
T
yhirose 9bfd2ddf1c Fix README and docs pages that no longer match the code
Bring the READMEs and the docs pages (en and ja) in line with the
current header:

- Fix the client sample that does not compile, the Transfer-Encoding
  statement for default headers, the verifier callback comment, the
  thread pool spawn rule, the sanitize_filename description, and the
  inverted Accept-Encoding sentence.
- Describe recent behaviour: TLS errors behind Read/Write failures,
  Host validation, Connection: close for a body without length,
  content_reader rules, refused CONNECT, WebSocketClient proxies,
  CPPHTTPLIB_INTERIM_RESPONSE_MAX_COUNT, the SSE event size limit, and
  the payload limit of the Stream API.
- Complete the API references of WebSocket, WebSocketClient and the
  stream:: helpers, and the SSE reconnect rules.
- Fix cookbook pages: keychain loading on every backend, received Close
  status, a multipart sample that trusted the client's file name, an
  echo sample that sent binary as text, SNI, pre-request handler scope,
  stop() with WebSocket handlers, and the thread pool notes.
- Restore the mutex in the LLM app's Chapter 5 code.
2026-10-18 10:13:57 -04:00

2.5 KiB
Raw Blame History

title, order, status
title order status
W05. wss接続でTLSを設定する 56 draft

wss://(WebSocket over TLS)接続のクライアント側TLS設定は、SSLClientとほぼ同じAPIです。ws::WebSocketClientはws://とwss://を同じクラスで扱うので、SSLClientのような別クラスへの切り替えは不要です。

httplib::ws::WebSocketClient ws1("ws://localhost:8080/ws");   // 平文
httplib::ws::WebSocketClient ws2("wss://localhost:8443/ws");  // TLS

サーバー証明書の検証

set_ca_cert_path()で独自のCA証明書を指定できます。シグネチャはSSLClientと同じで、第1引数がCA証明書ファイル、第2引数がCA証明書ディレクトリ(省略可)です。

httplib::ws::WebSocketClient ws("wss://internal.example.com/ws");
ws.set_ca_cert_path("/etc/ssl/certs/internal-ca.pem");

if (ws.connect()) {
  ws.send("hello");
}

証明書検証そのものを無効にしたい場合はenable_server_certificate_verification(false)が使えます。挙動の詳細はT02. SSL証明書の検証を制御するを参照してください。

WebSocketClientには、独自の検証に使うset_server_certificate_verifier()とset_session_verifier()や、プロキシ用のセッター(set_proxy()、set_proxy_basic_auth()、set_proxy_bearer_token_auth()、set_proxy_digest_auth()、set_no_proxy())もあります。CA証明書は最初のconnect()で読み込まれるので、それより前に設定してください。

クライアント証明書を使う(mTLS)

ws::WebSocketClientにはPemMemory構造体を受け取るコンストラクタがあり、wss://接続でクライアント証明書を提示できます。

httplib::ws::WebSocketClient::PemMemory pem{};
pem.cert_pem = client_cert.data();
pem.cert_pem_len = client_cert.size();
pem.key_pem = client_key.data();
pem.key_pem_len = client_key.size();

httplib::ws::WebSocketClient ws("wss://api.example.com/ws", pem);

if (ws.connect()) {
  ws.send("hello");
}

ws://(非TLS)のURLにPemMemoryを渡した場合は黙って無視されます。SSLClientと違い、ファイルパスから直接読み込むコンストラクタは用意されていないので、PEMをメモリ上に読み込んでから渡す必要があります。

mTLSの全体像(サーバー側の設定や用途の解説を含む)はT04. mTLSを設定するを参照してください。