Allow addr_map_ values to be hostnames, not just IP literals (#2515)

addr_map_ only accepted IP literals as mapped values; a non-IP value was
passed as the `ip` argument and rejected by getaddrinfo's AI_NUMERICHOST
path. The lookup in ClientImpl::create_client_socket and
WebSocketClient::connect now checks the mapped value with
detail::is_ip_address: IP literals keep the existing AI_NUMERICHOST path,
while hostnames are passed as the connect host so they get resolved.

host_ is never touched, so it keeps supplying the Host header and SNI in
both cases.

is_ip_address() moved into the non-SSL detail block so that both client
code paths can use it without CPPHTTPLIB_SSL_ENABLED.

This also fixes the documented Unix domain socket client example, where
the mapped value is a socket path: it previously took the AI_NUMERICHOST
path and never reached the AF_UNIX branch in create_socket.
This commit is contained in:
Kim, Hyuk
2026-08-01 14:29:20 -04:00
committed by GitHub
parent 447b9c4a29
commit 49b921b52d
2 changed files with 135 additions and 17 deletions
+38 -17
View File
@@ -2452,7 +2452,8 @@ protected:
std::thread::id socket_requests_are_from_thread_ = std::thread::id();
bool socket_should_be_closed_when_request_is_done_ = false;
// Hostname-IP map
// Hostname to connection target map. The value is an IP literal or another
// hostname; only the connection target changes, never the identity.
std::map<std::string, std::string> addr_map_;
// Default headers
@@ -4021,7 +4022,8 @@ private:
time_t connection_timeout_usec_ = CPPHTTPLIB_CONNECTION_TIMEOUT_USECOND;
std::string interface_;
// Hostname-IP map
// Hostname to connection target map. The value is an IP literal or another
// hostname; only the connection target changes, never the identity.
std::map<std::string, std::string> addr_map_;
#ifdef CPPHTTPLIB_SSL_ENABLED
@@ -9096,6 +9098,13 @@ inline bool perform_websocket_handshake(Stream &strm, Request &req,
selected_subprotocol);
}
inline bool is_ip_address(const std::string &host) {
struct in_addr addr4;
struct in6_addr addr6;
return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
}
} // namespace detail
/*
@@ -9279,13 +9288,6 @@ inline std::string SHA_512(const std::string &s) {
}
#endif
inline bool is_ip_address(const std::string &host) {
struct in_addr addr4;
struct in6_addr addr6;
return inet_pton(AF_INET, host.c_str(), &addr4) == 1 ||
inet_pton(AF_INET6, host.c_str(), &addr6) == 1;
}
template <typename T>
inline bool process_server_socket_ssl(
const std::atomic<socket_t> &svr_sock, tls::session_t session,
@@ -12991,13 +12993,23 @@ inline socket_t ClientImpl::create_client_socket(Error &error) const {
write_timeout_sec_, write_timeout_usec_, interface_, error);
}
// Check is custom IP specified for host_
// Check is custom IP or hostname specified for host_.
// An IP literal goes to the ip argument, which keeps create_socket's
// AI_NUMERICHOST path; a hostname goes to the host argument so that it is
// resolved. Either way host_ still supplies the Host header and SNI.
auto connect_host = host_;
std::string ip;
auto it = addr_map_.find(host_);
if (it != addr_map_.end()) { ip = it->second; }
if (it != addr_map_.end() && !it->second.empty()) {
if (detail::is_ip_address(it->second)) {
ip = it->second;
} else {
connect_host = it->second;
}
}
return detail::create_client_socket(
host_, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
socket_options_, connection_timeout_sec_, connection_timeout_usec_,
read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
write_timeout_usec_, interface_, error);
@@ -20859,16 +20871,25 @@ inline bool WebSocketClient::connect() {
if (!is_valid_) { return false; }
shutdown_and_close();
// Check is custom IP specified for host_.
// host_ stays the identity used for the Host header and for SNI, while ip
// only redirects where the socket connects.
// Check is custom IP or hostname specified for host_.
// host_ stays the identity used for the Host header and for SNI, while the
// mapped value only redirects where the socket connects. An IP literal goes
// to the ip argument, which keeps create_socket's AI_NUMERICHOST path; a
// hostname goes to the host argument so that it is resolved.
auto connect_host = host_;
std::string ip;
auto it = addr_map_.find(host_);
if (it != addr_map_.end()) { ip = it->second; }
if (it != addr_map_.end() && !it->second.empty()) {
if (detail::is_ip_address(it->second)) {
ip = it->second;
} else {
connect_host = it->second;
}
}
Error error;
sock_ = detail::create_client_socket(
host_, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
connect_host, ip, port_, address_family_, tcp_nodelay_, ipv6_v6only_,
socket_options_, connection_timeout_sec_, connection_timeout_usec_,
read_timeout_sec_, read_timeout_usec_, write_timeout_sec_,
write_timeout_usec_, interface_, error);
+97
View File
@@ -15,7 +15,9 @@
#include <algorithm>
#include <atomic>
#include <cctype>
#include <chrono>
#include <clocale>
#include <cstdio>
#include <fstream>
#include <future>
@@ -2573,6 +2575,101 @@ TEST(SpecifyServerIPAddressTest, RealHostname_Online) {
EXPECT_EQ(Error::Connection, res.error());
}
TEST(SpecifyServerIPAddressTest, HostnameAsAddrMapValue) {
// A mapped value that is not an IP literal must be resolved. "localhost"
// resolves from the hosts file, so this test needs no external DNS.
// "target.invalid" (RFC 6761) is only a map key and the Host header value.
auto host = "target.invalid";
Server svr;
std::string received_host;
svr.Get("/hi", [&](const Request &req, Response &res) {
received_host = req.get_header_value("Host");
res.set_content("Hello World!", "text/plain");
});
auto port = svr.bind_to_any_port(HOST);
auto thread = std::thread([&]() { svr.listen_after_bind(); });
auto se = detail::scope_exit([&] {
svr.stop();
thread.join();
ASSERT_FALSE(svr.is_running());
});
svr.wait_until_ready();
Client cli(host, port);
cli.set_hostname_addr_map({{host, HOST}});
auto res = cli.Get("/hi");
ASSERT_TRUE(res) << "Error: " << to_string(res.error());
EXPECT_EQ(StatusCode::OK_200, res->status);
// The mapping only redirects the connection; the identity stays host_.
EXPECT_EQ(std::string(host) + ":" + std::to_string(port), received_host);
}
TEST(SpecifyServerIPAddressTest, IPAddressAsAddrMapValue) {
// A mapped value that is an IP literal keeps the AI_NUMERICHOST path.
auto host = "target.invalid";
Server svr;
svr.Get("/hi", [](const Request & /*req*/, Response &res) {
res.set_content("Hello World!", "text/plain");
});
auto port = svr.bind_to_any_port("127.0.0.1");
auto thread = std::thread([&]() { svr.listen_after_bind(); });
auto se = detail::scope_exit([&] {
svr.stop();
thread.join();
ASSERT_FALSE(svr.is_running());
});
svr.wait_until_ready();
Client cli(host, port);
cli.set_hostname_addr_map({{host, "127.0.0.1"}});
auto res = cli.Get("/hi");
ASSERT_TRUE(res) << "Error: " << to_string(res.error());
EXPECT_EQ(StatusCode::OK_200, res->status);
}
TEST(SpecifyServerIPAddressTest, EmptyAddrMapValueIsIgnored) {
// An empty mapped value must leave host_ as the connection target. Without
// that guard the empty value would become the host argument, getaddrinfo
// would be called with a null node, and (no AI_PASSIVE) it would resolve to
// loopback - silently connecting somewhere the caller never asked for.
// The server listens on loopback, so such a fallback would succeed and is
// therefore observable as a failure of this test.
auto blackhole = "192.0.2.1"; // TEST-NET-1, never routable
Server svr;
svr.Get("/hi", [](const Request & /*req*/, Response &res) {
res.set_content("Hello World!", "text/plain");
});
auto port = svr.bind_to_any_port(HOST);
auto thread = std::thread([&]() { svr.listen_after_bind(); });
auto se = detail::scope_exit([&] {
svr.stop();
thread.join();
ASSERT_FALSE(svr.is_running());
});
svr.wait_until_ready();
Client cli(blackhole, port);
cli.set_hostname_addr_map({{blackhole, ""}});
cli.set_connection_timeout(1);
auto res = cli.Get("/hi");
EXPECT_FALSE(res) << "empty mapping must not redirect to loopback";
}
TEST(AbsoluteRedirectTest, Redirect_Online) {
auto host = "httpbingo.org";
auto path = std::string{"/absolute-redirect/3"};