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.
87 lines
3.0 KiB
Markdown
87 lines
3.0 KiB
Markdown
---
|
|
title: "T04. Configure mTLS"
|
|
order: 46
|
|
status: "draft"
|
|
---
|
|
|
|
Regular TLS verifies the server certificate only. **mTLS** (mutual TLS) adds the other direction: the client presents a certificate too, and the server verifies it. It's common for zero-trust API-to-API traffic and internal system authentication.
|
|
|
|
## Server side
|
|
|
|
Pass the CA used to verify client certificates as the third (and fourth) argument to `SSLServer`.
|
|
|
|
```cpp
|
|
httplib::SSLServer svr(
|
|
"server-cert.pem", // server certificate
|
|
"server-key.pem", // server private key
|
|
"client-ca.pem", // CA that signs valid client certs
|
|
nullptr // CA directory (none)
|
|
);
|
|
|
|
svr.Get("/", [](const httplib::Request &req, httplib::Response &res) {
|
|
res.set_content("authenticated", "text/plain");
|
|
});
|
|
|
|
svr.listen("0.0.0.0", 443);
|
|
```
|
|
|
|
With this, any connection whose client certificate isn't signed by `client-ca.pem` is rejected at the handshake. By the time a handler runs, the client is already authenticated.
|
|
|
|
## Configure with in-memory PEM
|
|
|
|
```cpp
|
|
httplib::SSLServer::PemMemory pem{};
|
|
pem.cert_pem = server_cert.data();
|
|
pem.cert_pem_len = server_cert.size();
|
|
pem.key_pem = server_key.data();
|
|
pem.key_pem_len = server_key.size();
|
|
pem.client_ca_pem = client_ca.data();
|
|
pem.client_ca_pem_len = client_ca.size();
|
|
|
|
httplib::SSLServer svr(pem);
|
|
```
|
|
|
|
This is the clean way when you load certificates from environment variables or a secrets manager.
|
|
|
|
## Client side
|
|
|
|
On the client side, pass the client certificate and key to `SSLClient`.
|
|
|
|
```cpp
|
|
httplib::SSLClient cli("api.example.com", 443,
|
|
"client-cert.pem",
|
|
"client-key.pem");
|
|
|
|
auto res = cli.Get("/");
|
|
```
|
|
|
|
Note you're using `SSLClient` directly, not `Client`. If the private key has a password, pass it as the fifth argument.
|
|
|
|
The client side has the same `PemMemory` struct too, letting you set the client certificate from PEM in memory.
|
|
|
|
```cpp
|
|
httplib::SSLClient::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::SSLClient cli("api.example.com", 443, pem);
|
|
|
|
auto res = cli.Get("/");
|
|
```
|
|
|
|
> For mTLS with a WebSocket client (`wss://`), see [W05. Configure TLS for wss:// Connections](../w05-websocket-tls).
|
|
|
|
## Read client info from a handler
|
|
|
|
To see which client connected from inside a handler, use `req.peer_cert()`. Details in [T05. Access the peer certificate on the server](../t05-peer-cert).
|
|
|
|
## Use cases
|
|
|
|
- **Microservice-to-microservice calls**: Issue a cert per service, use the cert as identity
|
|
- **IoT device management**: Burn a cert into each device and use it to gate API access
|
|
- **An alternative to internal VPN**: Put cert-based auth in front of public endpoints so internal resources can be reached safely
|
|
|
|
> **Note:** Issuing and revoking client certificates is more operational work than password-based auth. You'll need either an internal PKI setup or an automated flow using ACME-family tools.
|