mirror of
https://github.com/yhirose/cpp-httplib.git
synced 2026-09-02 14:53:46 +00:00
254e576b50
* Add Server::CustomRoute() for HTTP methods outside the built-in set parse_request_line validates the request method against a fixed whitelist and rejects anything else with 400 before routing runs. That blocks WebDAV, where PROPFIND, PROPPATCH, MKCOL, COPY, MOVE, LOCK and UNLOCK are ordinary methods defined by RFC 4918, and it blocks extension methods such as UPnP's SUBSCRIBE. The need has been open since #847. Registering a handler is now what makes the server accept a method: svr.CustomRoute("PROPFIND", "/dav/:id", handler); Because custom methods go through the normal dispatch path, patterns work the way they do for Get() and friends, and the request body is available in req.body. Serving these methods through set_pre_routing_handler was never enough: the body has not been read at that point, so PROPPATCH and LOCK, which require one, could not be implemented at all. A HandlerWithContentReader overload is available too. The content reader gate in routing() also fires when a custom method carries no body, matching what expect_content() does unconditionally for POST/PUT/PATCH/DELETE, so a body-less PROPFIND (RFC 4918 treats one as allprop) reaches its handler instead of falling through to 404. Method names are validated as RFC 9110 tokens, and the ten built-in methods are refused. Seven of them are dispatched by the if/else chain in routing() before the custom tables are consulted, so a route registered for one could never fire; CONNECT, TRACE and PRI carry protocol-level meaning this library does not route. A refused registration makes is_valid() return false, so listen() fails rather than starting a server holding a handler that would never run. This is also why SSLServer::is_valid() now chains to Server::is_valid() instead of only checking ctx_. Servers that never call CustomRoute() keep the previous per-request cost: the built-in method set is checked first and short-circuits, and the custom lookup returns early on an empty map. * Add cookbook recipe for custom HTTP methods The CustomRoute() docs were a section inside S01, which pushed that page to 90 lines, the longest in the cookbook, and mixed a separate feature into a page about registering GET/POST/PUT/DELETE handlers. Move the section into its own recipe and give it room for the part that was missing: the OPTIONS handler returning DAV: and Allow, which WebDAV clients probe for before anything else. S01 goes back to 68 lines and keeps a pointer to the new page. The recipe is titled after the API rather than after WebDAV, and says outright that generating the 207 Multi-Status XML, interpreting Depth and managing locks are the reader's job. Routing the method is all the library does. S23 takes order 42, so the TLS, SSE and WebSocket recipes shift to 43-57. That only moves the sort key. Filenames, the T01/E01/W01 labels, the published URLs and every cross-reference are untouched.
2.6 KiB
2.6 KiB
title, order, status
| title | order | status |
|---|---|---|
| T01. OpenSSL・mbedTLS・wolfSSLの選択指針 | 43 | draft |
cpp-httplibはTLSの実装を自前では持たず、3つのバックエンドの中から1つを選んで使います。ビルド時に有効にするマクロで切り替えます。
| バックエンド | マクロ | 特徴 |
|---|---|---|
| OpenSSL | CPPHTTPLIB_OPENSSL_SUPPORT |
最も広く使われている、機能が豊富 |
| mbedTLS | CPPHTTPLIB_MBEDTLS_SUPPORT |
軽量、組み込み向け |
| wolfSSL | CPPHTTPLIB_WOLFSSL_SUPPORT |
組み込み向け、商用サポートあり |
ビルド時の指定
httplib.hをインクルードする前に、使いたいバックエンドのマクロを定義します。
#define CPPHTTPLIB_OPENSSL_SUPPORT
#include <httplib.h>
リンク時にそのバックエンドのライブラリ（libssl、libcrypto、libmbedtls、libwolfsslなど）も必要です。
どれを選ぶか
迷ったらOpenSSL
機能が一番豊富で、情報も多いです。通常のサーバー用途やLinuxデスクトップ向けなら、まずこれで始めて問題ありません。
バイナリサイズを抑えたい、組み込みで使う
mbedTLSかwolfSSLが向いています。OpenSSLよりずっとコンパクトで、メモリ制約のあるデバイスでも動きます。
商用サポートが必要
wolfSSLには商用ライセンスとサポートがあります。製品に組み込むなら選択肢に入ります。
複数バックエンドを切り替えたい場合
ビルドバリアントとして切り分けて、同じソースをマクロ切替でコンパイルし直すのが一般的です。APIの違いは、cpp-httplib側でかなり吸収してくれますが、完全に同じ挙動ではないのでテストは必須です。
どのバックエンドでも使えるAPI
証明書の検証制御、SSLServerの立ち上げ、ピア証明書の取得などは、どのバックエンドでも同じAPIで呼べます。
Note: macOSでは、OpenSSL系のバックエンドを使う場合、システムのキーチェーンからルート証明書を自動で読む設定（
CPPHTTPLIB_USE_CERTS_FROM_MACOSX_KEYCHAIN）がデフォルトで有効です。無効にしたい場合はCPPHTTPLIB_DISABLE_MACOSX_AUTOMATIC_ROOT_CERTIFICATESを定義してください。