#include <bitcoin-build-config.h>
#include <httpserver.h>
#include <chainparamsbase.h>
#include <common/args.h>
#include <common/messages.h>
#include <common/url.h>
#include <compat/compat.h>
#include <logging.h>
#include <netbase.h>
#include <node/interface_ui.h>
#include <rpc/protocol.h>
#include <span.h>
#include <sync.h>
#include <util/check.h>
#include <util/signalinterrupt.h>
#include <util/sock.h>
#include <util/strencodings.h>
#include <util/thread.h>
#include <util/threadnames.h>
#include <util/threadpool.h>
#include <util/time.h>
#include <util/translation.h>
#include <condition_variable>
#include <cstdio>
#include <cstdlib>
#include <memory>
#include <optional>
#include <span>
#include <string>
#include <string_view>
#include <thread>
#include <unordered_map>
#include <vector>
#include <sys/types.h>
#include <sys/stat.h>
static constexpr auto SELECT_TIMEOUT{50ms};
static constexpr int SOCKET_OPTION_TRUE{1};
using common::InvalidPortErrMsg;
using util::LineReader;
using namespace bitcoin_http;
struct HTTPPathHandler
{
HTTPPathHandler(std::string _prefix, bool _exactMatch, HTTPRequestHandler _handler):
prefix(_prefix), exactMatch(_exactMatch), handler(_handler)
{
}
std::string prefix;
bool exactMatch;
HTTPRequestHandler handler;
};
static std::unique_ptr<HTTPServer> g_http_server{nullptr};
static GlobalMutex g_httppathhandlers_mutex;
static std::vector<HTTPPathHandler> pathHandlers GUARDED_BY(g_httppathhandlers_mutex);
static ThreadPool g_threadpool_http("http");
static int g_max_queue_depth{100};
bool HTTPServer::ClientAllowed(const CNetAddr& netaddr) const
{
if (!netaddr.IsValid())
return false;
for(const CSubNet& subnet : m_allow_subnets)
if (subnet.Match(netaddr))
return true;
return false;
}
bool HTTPServer::InitHTTPAllowList()
{
Assume(!m_thread_socket_handler.joinable());
m_allow_subnets.clear();
m_allow_subnets.emplace_back(LookupHost("127.0.0.1", false).value(), 8);
m_allow_subnets.emplace_back(LookupHost("::1", false).value());
for (const std::string& strAllow : gArgs.GetArgs("-rpcallowip")) {
const CSubNet subnet{LookupSubNet(strAllow)};
if (!subnet.IsValid()) {
uiInterface.ThreadSafeMessageBox(
Untranslated(strprintf("Invalid -rpcallowip subnet specification: %s. Valid values are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. 1.2.3.4/255.255.255.0), a network/CIDR (e.g. 1.2.3.4/24), all ipv4 (0.0.0.0/0), or all ipv6 (::/0). RFC4193 is allowed only if -cjdnsreachable=0.", strAllow)),
CClientUIInterface::MSG_ERROR);
return false;
}
m_allow_subnets.push_back(subnet);
}
std::string strAllowed;
for (const CSubNet& subnet : m_allow_subnets)
strAllowed += subnet.ToString() + " ";
LogDebug(BCLog::HTTP, "Allowing HTTP connections from: %s\n", strAllowed);
return true;
}
std::string_view RequestMethodString(HTTPRequestMethod m)
{
switch (m) {
using enum HTTPRequestMethod;
case GET: return "GET";
case POST: return "POST";
case HEAD: return "HEAD";
case PUT: return "PUT";
case UNKNOWN: return "unknown";
}
assert(false);
}
static void WriteNoStoreErrorReply(HTTPRequest& req, HTTPStatusCode status, std::string_view reply = {})
{
req.WriteHeader("Cache-Control", "no-store");
req.WriteReply(status, reply);
}
static void MaybeDispatchRequestToWorker(std::shared_ptr<HTTPRequest> hreq)
{
if (hreq->GetRequestMethod() == HTTPRequestMethod::UNKNOWN) {
LogDebug(BCLog::HTTP, "HTTP request from %s rejected: Unknown HTTP request method\n",
hreq->GetPeer().ToStringAddrPort());
WriteNoStoreErrorReply(*hreq, HTTP_BAD_METHOD);
return;
}
std::string strURI = hreq->GetURI();
std::string path;
LOCK(g_httppathhandlers_mutex);
std::vector<HTTPPathHandler>::const_iterator i = pathHandlers.begin();
std::vector<HTTPPathHandler>::const_iterator iend = pathHandlers.end();
for (; i != iend; ++i) {
bool match = false;
if (i->exactMatch)
match = (strURI == i->prefix);
else
match = strURI.starts_with(i->prefix);
if (match) {
path = strURI.substr(i->prefix.size());
break;
}
}
if (i != iend) {
if (static_cast<int>(g_threadpool_http.WorkQueueSize()) >= g_max_queue_depth) {
LogWarning("Request rejected because http work queue depth exceeded, it can be increased with the -rpcworkqueue= setting");
WriteNoStoreErrorReply(*hreq, HTTP_SERVICE_UNAVAILABLE, "Work queue depth exceeded");
return;
}
auto item = [req = hreq, in_path = std::move(path), fn = i->handler]() {
std::string err_msg;
try {
fn(req.get(), in_path);
return;
} catch (const std::exception& e) {
LogWarning("Unexpected error while processing request for '%s'. Error msg: '%s'", req->GetURI(), e.what());
err_msg = e.what();
} catch (...) {
LogWarning("Unknown error while processing request for '%s'", req->GetURI());
err_msg = "unknown error";
}
req->WriteHeader("Connection", "close");
WriteNoStoreErrorReply(*req, HTTP_INTERNAL_SERVER_ERROR, err_msg);
};
if (auto res = g_threadpool_http.Submit(std::move(item)); !res.has_value()) {
Assume(hreq.use_count() == 1);
LogWarning("HTTP request rejected during server shutdown: '%s'", SubmitErrorString(res.error()));
WriteNoStoreErrorReply(*hreq, HTTP_SERVICE_UNAVAILABLE, "Request rejected during server shutdown");
return;
}
} else {
WriteNoStoreErrorReply(*hreq, HTTP_NOT_FOUND);
}
}
static void RejectRequest(std::unique_ptr<HTTPRequest> hreq)
{
LogDebug(BCLog::HTTP, "Rejecting request while shutting down");
WriteNoStoreErrorReply(*hreq, HTTP_SERVICE_UNAVAILABLE);
}
static std::vector<std::pair<std::string, uint16_t>> GetBindAddresses()
{
uint16_t http_port{static_cast<uint16_t>(gArgs.GetIntArg("-rpcport", BaseParams().RPCPort()))};
std::vector<std::pair<std::string, uint16_t>> endpoints;
if (gArgs.GetArgs("-rpcallowip").empty() || gArgs.GetArgs("-rpcbind").empty()) {
endpoints.emplace_back("::1", http_port);
endpoints.emplace_back("127.0.0.1", http_port);
if (!gArgs.GetArgs("-rpcallowip").empty()) {
LogWarning("Option -rpcallowip was specified without -rpcbind; this doesn't usually make sense");
}
if (!gArgs.GetArgs("-rpcbind").empty()) {
LogWarning("Option -rpcbind was ignored because -rpcallowip was not specified, refusing to allow everyone to connect");
}
} else {
for (const std::string& strRPCBind : gArgs.GetArgs("-rpcbind")) {
uint16_t port{http_port};
std::string host;
if (!SplitHostPort(strRPCBind, port, host)) {
LogError("%s\n", InvalidPortErrMsg("-rpcbind", strRPCBind).original);
return {};
}
endpoints.emplace_back(host, port);
}
}
return endpoints;
}
void RegisterHTTPHandler(const std::string &prefix, bool exactMatch, const HTTPRequestHandler &handler)
{
LogDebug(BCLog::HTTP, "Registering HTTP handler for %s (exactmatch %d)\n", prefix, exactMatch);
LOCK(g_httppathhandlers_mutex);
pathHandlers.emplace_back(prefix, exactMatch, handler);
}
void UnregisterHTTPHandler(const std::string &prefix, bool exactMatch)
{
LOCK(g_httppathhandlers_mutex);
std::vector<HTTPPathHandler>::iterator i = pathHandlers.begin();
std::vector<HTTPPathHandler>::iterator iend = pathHandlers.end();
for (; i != iend; ++i)
if (i->prefix == prefix && i->exactMatch == exactMatch)
break;
if (i != iend)
{
LogDebug(BCLog::HTTP, "Unregistering HTTP handler for %s (exactmatch %d)\n", prefix, exactMatch);
pathHandlers.erase(i);
}
}
using util::Split;
std::optional<std::string> HTTPHeaders::FindFirst(const std::string_view key) const
{
for (const auto& item : m_headers) {
if (CaseInsensitiveEqual(key, item.first)) {
return item.second;
}
}
return std::nullopt;
}
std::vector<std::string_view> HTTPHeaders::FindAll(const std::string_view key) const
{
std::vector<std::string_view> ret;
for (const auto& item : m_headers) {
if (CaseInsensitiveEqual(key, item.first)) {
ret.push_back(item.second);
}
}
return ret;
}
void HTTPHeaders::Write(std::string&& key, std::string&& value)
{
m_headers.emplace_back(std::move(key), std::move(value));
}
void HTTPHeaders::RemoveAll(std::string_view key)
{
auto moved = std::ranges::remove_if(m_headers, [key] (auto& pair) {
return CaseInsensitiveEqual(key, pair.first);
});
m_headers.erase(moved.begin(), moved.end());
}
bool HTTPHeaders::Read(util::LineReader& reader, bool write)
{
size_t start{reader.Consumed()};
while (auto maybe_line = reader.ReadLine()) {
if (reader.Consumed() - start + m_consumed > MAX_HEADERS_SIZE) throw std::runtime_error("HTTP headers exceed size limit");
const std::string_view& line = *maybe_line;
if (line.empty()) {
m_consumed += reader.Consumed() - start;
return true;
}
if (line.find_first_of("\r\n\0", 0, 3) != std::string_view::npos) throw std::runtime_error("Header contains invalid character");
const size_t pos{line.find(':')};
if (pos == std::string_view::npos) throw std::runtime_error("HTTP header missing colon (:)");
std::string_view key = line.substr(0, pos);
if (key.find_first_of(" \t\n\r\f\v") != std::string_view::npos) throw std::runtime_error("Invalid header field-name contains whitespace");
std::string value = util::TrimString(std::string_view(line).substr(pos + 1));
if (key.empty()) throw std::runtime_error("Empty HTTP header name");
if (write) {
Write(std::string(key), std::move(value));
}
}
m_consumed += reader.Consumed() - start;
return false;
}
std::string HTTPHeaders::Stringify() const
{
std::string out;
for (const auto& [key, value] : m_headers) {
out += key + ": " + value + "\r\n";
}
out += "\r\n";
return out;
}
std::string HTTPResponse::StringifyHeaders() const
{
return strprintf("HTTP/%d.%d %d %s\r\n%s",
version.major,
version.minor,
status,
HTTPStatusReasonString(status),
headers.Stringify());
}
bool HTTPRequest::LoadControlData(LineReader& reader)
{
auto maybe_line = reader.ReadLine();
if (!maybe_line) return false;
const std::string_view& request_line = *maybe_line;
if (request_line.length() < MIN_REQUEST_LINE_LENGTH) throw std::runtime_error("HTTP request line too short");
if (request_line.find('\0') != std::string_view::npos) throw std::runtime_error("Invalid request line contains NUL");
const std::vector<std::string_view> parts{Split<std::string_view>(request_line, " ")};
if (parts.size() != 3) throw std::runtime_error("HTTP request line malformed");
if (parts[0] == "GET") {
m_method = HTTPRequestMethod::GET;
} else if (parts[0] == "POST") {
m_method = HTTPRequestMethod::POST;
} else if (parts[0] == "HEAD") {
m_method = HTTPRequestMethod::HEAD;
} else if (parts[0] == "PUT") {
m_method = HTTPRequestMethod::PUT;
} else {
m_method = HTTPRequestMethod::UNKNOWN;
}
m_target = parts[1];
if (parts[2].rfind("HTTP/") != 0) throw std::runtime_error("HTTP request line malformed");
const std::vector<std::string_view> version_parts{Split<std::string_view>(parts[2].substr(5), ".")};
if (version_parts.size() != 2) throw std::runtime_error("HTTP request line malformed");
if (version_parts[0].size() != 1 || version_parts[1].size() != 1) throw std::runtime_error("HTTP bad version");
auto major = ToIntegral<uint8_t>(version_parts[0]);
auto minor = ToIntegral<uint8_t>(version_parts[1]);
if (!major || !minor || major != 1 || minor > 9) throw std::runtime_error("HTTP bad version");
m_version.major = major.value();
m_version.minor = minor.value();
return true;
}
bool HTTPRequest::LoadHeaders(LineReader& reader)
{
return m_headers.Read(reader);
}
bool HTTPRequest::LoadBody(LineReader& reader)
{
auto transfer_encoding_header = m_headers.FindFirst("Transfer-Encoding");
if (transfer_encoding_header && ToLower(transfer_encoding_header.value()) == "chunked") {
while (reader.Remaining() > 0) {
if (!m_chunk_size) {
auto maybe_chunk_size = reader.ReadLine();
if (!maybe_chunk_size) return false;
std::string_view chunk_size_noext{maybe_chunk_size.value()};
const auto semicolon_pos = chunk_size_noext.find(';');
if (semicolon_pos != chunk_size_noext.npos) {
chunk_size_noext.remove_suffix(chunk_size_noext.size() - semicolon_pos);
}
m_chunk_size = ToIntegral<uint64_t>(util::TrimStringView(chunk_size_noext), 16);
if (!m_chunk_size) throw std::runtime_error("Cannot parse chunk length value");
if ((m_body.size() > MAX_BODY_SIZE) ||
(*m_chunk_size > MAX_BODY_SIZE - m_body.size()))
throw ContentTooLargeError("Chunk will exceed max body size");
}
Assume(m_chunk_size);
if (*m_chunk_size == 0) {
return m_headers.Read(reader, false);
}
if (m_chunk_read < *m_chunk_size) {
const uint64_t chunk_need{*m_chunk_size - m_chunk_read};
const uint64_t buffer_has{std::min(chunk_need, static_cast<uint64_t>(reader.Remaining()))};
m_body += reader.ReadLength(buffer_has);
m_chunk_read += buffer_has;
}
if (m_chunk_read == *m_chunk_size) {
auto crlf = reader.ReadLine();
if (!crlf) {
return false;
}
if (!crlf.value().empty()) throw std::runtime_error("Improperly terminated chunk");
m_chunk_size.reset();
m_chunk_read = 0;
}
}
return false;
} else {
auto content_length_values{m_headers.FindAll("Content-Length")};
if (content_length_values.empty()) return true;
const auto& first_content_length_value{content_length_values[0]};
for (size_t i = 1; i < content_length_values.size(); ++i) {
if (content_length_values[i] != first_content_length_value) throw std::runtime_error("Differing Content-Length values");
}
const auto content_length{ToIntegral<uint64_t>(first_content_length_value)};
if (!content_length) throw std::runtime_error("Cannot parse Content-Length value");
if (*content_length > MAX_BODY_SIZE) throw ContentTooLargeError("Max body size exceeded");
const uint64_t body_need{*content_length - m_body.size()};
const uint64_t buffer_has{std::min(body_need, static_cast<uint64_t>(reader.Remaining()))};
m_body += reader.ReadLength(buffer_has);
return m_body.size() == *content_length;
}
}
void HTTPRequest::WriteReply(HTTPStatusCode status, std::span<const std::byte> reply_body)
{
HTTPResponse res;
res.headers = std::move(m_response_headers);
res.version = m_version;
res.status = status;
bool needs_body{status != HTTP_NO_CONTENT && (status < 100 || status >= 200)};
bool needs_content_length{false};
bool keep_alive{false};
if (m_version.major == 1) {
if (m_version.minor == 0) {
auto connection_header{m_headers.FindFirst("Connection")};
if (connection_header && ToLower(connection_header.value()) == "keep-alive") {
res.headers.Write("Connection", "keep-alive");
keep_alive = true;
if (needs_body) needs_content_length = true;
}
}
if (m_version.minor >= 1) {
const int64_t now_seconds{TicksSinceEpoch<std::chrono::seconds>(NodeClock::now())};
res.headers.Write("Date", FormatRFC1123DateTime(now_seconds));
if (needs_body) needs_content_length = true;
keep_alive = true;
}
}
if (needs_content_length) {
res.headers.Write("Content-Length", util::ToString(reply_body.size()));
}
if (needs_body && !res.headers.FindFirst("Content-Type")) {
res.headers.Write("Content-Type", "text/html; charset=ISO-8859-1");
}
auto connection_header{m_headers.FindFirst("Connection")};
if (connection_header && ToLower(connection_header.value()) == "close") {
res.headers.RemoveAll("Connection");
res.headers.Write("Connection", "close");
keep_alive = false;
}
if (std::shared_ptr client{m_client.lock()}) {
client->Send(res, reply_body, keep_alive);
}
}
void HTTPRemoteClient::Send(const HTTPResponse& res, std::span<const std::byte> reply_body, bool keep_alive)
{
m_keep_alive = keep_alive;
const std::string headers{res.StringifyHeaders()};
const auto headers_bytes{std::as_bytes(std::span{headers})};
bool send_buffer_was_empty{false};
{
LOCK(m_send_mutex);
send_buffer_was_empty = m_send_buffer.empty();
m_send_buffer.insert(m_send_buffer.end(), headers_bytes.begin(), headers_bytes.end());
m_send_buffer.insert(m_send_buffer.end(), reply_body.begin(), reply_body.end());
if (!send_buffer_was_empty) m_send_ready = true;
}
LogDebug(
BCLog::HTTP,
"HTTPResponse (status code: %d size: %lld) added to send buffer for client %s (id=%llu)",
res.status,
headers_bytes.size() + reply_body.size(),
m_origin,
m_id);
if (send_buffer_was_empty) {
MaybeSendBytesFromBuffer();
}
m_req_busy = false;
}
CService HTTPRequest::GetPeer() const
{
if (std::shared_ptr c{m_client.lock()}) {
return c->GetPeer();
} else {
return {};
}
}
std::optional<std::string> HTTPRequest::GetQueryParameter(const std::string_view key) const
{
return GetQueryParameterFromUri(m_target, key);
}
std::optional<std::string> GetQueryParameterFromUri(const std::string_view uri, const std::string_view key)
{
size_t start = uri.find('?');
if (start == std::string::npos) return std::nullopt;
size_t end = uri.find('#', start);
if (end == std::string::npos) {
end = uri.length();
}
const std::string_view query{uri.data() + start + 1, end - start - 1};
const std::vector<std::string_view> params{Split<std::string_view>(query, "&")};
for (const std::string_view& param : params) {
size_t delim = param.find('=');
if (key == UrlDecode(param.substr(0, delim))) {
if (delim == std::string::npos) {
return "";
} else {
return std::string(UrlDecode(param.substr(delim + 1)));
}
}
}
return std::nullopt;
}
std::optional<std::string> HTTPRequest::GetHeader(const std::string_view hdr) const
{
return m_headers.FindFirst(hdr);
}
void HTTPRequest::WriteHeader(std::string&& hdr, std::string&& value)
{
m_response_headers.Write(std::move(hdr), std::move(value));
}
util::Expected<void, std::string> HTTPServer::BindAndStartListening(const CService& to)
{
sockaddr_storage storage;
auto sa = reinterpret_cast<sockaddr*>(&storage);
socklen_t len{sizeof(storage)};
if (!to.GetSockAddr(sa, &len)) {
return util::Unexpected{strprintf("Bind address family for %s not supported", to.ToStringAddrPort())};
}
std::unique_ptr<Sock> sock{CreateSock(to.GetSAFamily(), SOCK_STREAM, IPPROTO_TCP)};
if (!sock) {
return util::Unexpected{strprintf("Cannot create %s listen socket: %s",
to.ToStringAddrPort(),
NetworkErrorString(WSAGetLastError()))};
}
if (sock->SetSockOpt(SOL_SOCKET, SO_REUSEADDR, &SOCKET_OPTION_TRUE, sizeof(SOCKET_OPTION_TRUE)) == SOCKET_ERROR) {
LogDebug(BCLog::HTTP,
"Cannot set SO_REUSEADDR on %s listen socket: %s, continuing anyway",
to.ToStringAddrPort(),
NetworkErrorString(WSAGetLastError()));
}
if (to.IsIPv6()) {
#ifdef IPV6_V6ONLY
if (sock->SetSockOpt(IPPROTO_IPV6, IPV6_V6ONLY, &SOCKET_OPTION_TRUE, sizeof(SOCKET_OPTION_TRUE)) == SOCKET_ERROR) {
LogDebug(BCLog::HTTP,
"Cannot set IPV6_V6ONLY on %s listen socket: %s, continuing anyway",
to.ToStringAddrPort(),
NetworkErrorString(WSAGetLastError()));
}
#endif
#ifdef WIN32
int prot_level{PROTECTION_LEVEL_UNRESTRICTED};
if (sock->SetSockOpt(IPPROTO_IPV6,
IPV6_PROTECTION_LEVEL,
&prot_level,
sizeof(prot_level)) == SOCKET_ERROR) {
LogDebug(BCLog::HTTP,
"Cannot set IPV6_PROTECTION_LEVEL on %s listen socket: %s, continuing anyway",
to.ToStringAddrPort(),
NetworkErrorString(WSAGetLastError()));
}
#endif
}
if (sock->Bind(sa, len) == SOCKET_ERROR) {
const int err{WSAGetLastError()};
if (err == WSAEADDRINUSE) {
return util::Unexpected{strprintf("Unable to bind to %s on this computer. %s is probably already running.",
to.ToStringAddrPort(),
CLIENT_NAME)};
} else {
return util::Unexpected{strprintf("Unable to bind to %s on this computer (bind returned error %s)",
to.ToStringAddrPort(),
NetworkErrorString(err))};
}
}
if (sock->Listen(SOMAXCONN) == SOCKET_ERROR) {
return util::Unexpected{strprintf("Cannot listen on %s: %s",
to.ToStringAddrPort(),
NetworkErrorString(WSAGetLastError()))};
}
m_listen.emplace_back(std::move(sock));
return {};
}
void HTTPServer::StopListening()
{
m_listen.clear();
}
void HTTPServer::StartSocketsThreads()
{
Assume(!m_allow_subnets.empty());
m_thread_socket_handler = std::thread(&util::TraceThread,
"http",
[this] { ThreadSocketHandler(); });
}
void HTTPServer::JoinSocketsThreads()
{
if (m_thread_socket_handler.joinable()) {
m_thread_socket_handler.join();
}
}
std::unique_ptr<Sock> HTTPServer::AcceptConnection(const Sock& listen_sock, CService& addr)
{
Assume(std::ranges::any_of(m_listen, [&](const auto& sock) { return sock.get() == &listen_sock; }));
sockaddr_storage storage;
socklen_t len{sizeof(storage)};
auto sa = reinterpret_cast<sockaddr*>(&storage);
auto sock{listen_sock.Accept(sa, &len)};
if (!sock) {
const int err{WSAGetLastError()};
if (err != WSAEWOULDBLOCK) {
LogDebug(BCLog::HTTP,
"Cannot accept new connection: %s",
NetworkErrorString(err));
}
return {};
}
if (!addr.SetSockAddr(sa, len)) {
LogDebug(BCLog::HTTP,
"Unknown socket family");
}
if (!ClientAllowed(addr)) {
LogDebug(BCLog::HTTP, "Connection from %s rejected: Client network is not allowed HTTP access\n",
addr.ToStringAddrPort());
return {};
}
return sock;
}
HTTPServer::Id HTTPServer::GetNewId()
{
return m_next_id.fetch_add(1, std::memory_order_relaxed);
}
void HTTPServer::NewSockAccepted(std::unique_ptr<Sock>&& sock, const CService& addr)
{
if (!sock->IsSelectable()) {
LogDebug(BCLog::HTTP,
"connection from %s dropped: non-selectable socket",
addr.ToStringAddrPort());
return;
}
if (sock->SetSockOpt(IPPROTO_TCP, TCP_NODELAY, &SOCKET_OPTION_TRUE, sizeof(SOCKET_OPTION_TRUE)) == SOCKET_ERROR) {
LogDebug(BCLog::HTTP, "connection from %s: unable to set TCP_NODELAY, continuing anyway",
addr.ToStringAddrPort());
}
const Id id{GetNewId()};
m_connected.push_back(std::make_shared<HTTPRemoteClient>(id, addr, std::move(sock)));
m_connected_size.fetch_add(1, std::memory_order_relaxed);
LogDebug(BCLog::HTTP,
"HTTP Connection accepted from %s (id=%llu)",
addr.ToStringAddrPort(), id);
}
void HTTPServer::SocketHandlerConnected(const IOReadiness& io_readiness) const
{
for (const auto& [sock, events] : io_readiness.events_per_sock) {
if (m_interrupt_net) {
return;
}
auto it{io_readiness.httpclients_per_sock.find(sock)};
if (it == io_readiness.httpclients_per_sock.end()) {
continue;
}
const std::shared_ptr<HTTPRemoteClient>& client{it->second};
bool send_ready = events.occurred & Sock::SendEvent;
bool recv_ready = events.occurred & Sock::RecvEvent;
bool err_ready = events.occurred & Sock::ErrorEvent;
if (send_ready) {
if (!client->MaybeSendBytesFromBuffer()) {
recv_ready = false;
}
}
if (recv_ready || err_ready) {
client->Receive();
}
if (std::unique_ptr<HTTPRequest> request{HTTPRemoteClient::TryReadRequest(client)})
{
LOCK(m_request_dispatcher_mutex);
m_request_dispatcher(std::move(request));
}
}
}
void HTTPRemoteClient::Receive()
{
char buf[0x10000];
const ssize_t nrecv{WITH_LOCK(
m_sock_mutex,
return m_sock->Recv(buf, sizeof(buf), MSG_DONTWAIT);)};
if (nrecv < 0) {
const int err = WSAGetLastError();
if (IOErrorIsPermanent(err)) {
LogDebug(
BCLog::HTTP,
"Permanent read error from %s (id=%llu): %s",
m_origin,
m_id,
NetworkErrorString(err));
m_disconnect = true;
}
} else if (nrecv == 0) {
LogDebug(
BCLog::HTTP,
"Received EOF from %s (id=%llu)",
m_origin,
m_id);
m_disconnect = true;
} else {
m_idle_since = Now<SteadySeconds>();
m_connection_busy = true;
m_recv_buffer.insert(
m_recv_buffer.end(),
buf,
buf + nrecv);
}
}
void HTTPServer::SocketHandlerListening(const Sock::EventsPerSock& events_per_sock)
{
if (m_stop_accepting) return;
for (const auto& sock : m_listen) {
if (m_interrupt_net) {
return;
}
const auto it = events_per_sock.find(sock);
if (it != events_per_sock.end() && it->second.occurred & Sock::RecvEvent) {
while (GetConnectionsCount() < static_cast<size_t>(m_rpcmaxconnections)) {
CService addr_accepted;
auto sock_accepted{AcceptConnection(*sock, addr_accepted)};
if (!sock_accepted) break;
NewSockAccepted(std::move(sock_accepted), addr_accepted);
}
}
}
}
HTTPServer::IOReadiness HTTPServer::GenerateWaitSockets() const
{
IOReadiness io_readiness;
if (GetConnectionsCount() < static_cast<size_t>(m_rpcmaxconnections)) {
for (const auto& sock : m_listen) {
io_readiness.events_per_sock.emplace(sock, Sock::Events{Sock::RecvEvent});
}
}
for (const auto& http_client : m_connected) {
std::shared_ptr<Sock> sock{http_client->GetSock()};
Sock::Event event = (http_client->ReadyToSend() ? Sock::SendEvent : Sock::RecvEvent);
io_readiness.events_per_sock.emplace(sock, Sock::Events{event});
io_readiness.httpclients_per_sock.emplace(sock, http_client);
}
return io_readiness;
}
void HTTPServer::ThreadSocketHandler()
{
while (!m_interrupt_net) {
auto io_readiness{GenerateWaitSockets()};
if (io_readiness.events_per_sock.empty() ||
!io_readiness.events_per_sock.begin()->first->WaitMany(SELECT_TIMEOUT,
io_readiness.events_per_sock)) {
m_interrupt_net.sleep_for(SELECT_TIMEOUT);
}
SocketHandlerConnected(io_readiness);
SocketHandlerListening(io_readiness.events_per_sock);
DisconnectClients();
}
}
std::unique_ptr<HTTPRequest> HTTPRemoteClient::TryReadRequest(const std::shared_ptr<HTTPRemoteClient>& client)
{
if (client->m_req_busy) return nullptr;
if (!client->m_req) {
client->m_req = std::make_unique<HTTPRequest>(client);
}
try {
client->ReadRequest(*client->m_req);
} catch (const ContentTooLargeError& e) {
LogDebug(
BCLog::HTTP,
"HTTP request body too large from client %s (id=%llu): %s",
client->m_origin,
client->m_id,
e.what());
WriteNoStoreErrorReply(*client->m_req, HTTP_CONTENT_TOO_LARGE);
client->m_disconnect = true;
return nullptr;
} catch (const std::runtime_error& e) {
LogDebug(
BCLog::HTTP,
"Error reading HTTP request from client %s (id=%llu): %s",
client->m_origin,
client->m_id,
e.what());
WriteNoStoreErrorReply(*client->m_req, HTTP_BAD_REQUEST);
client->m_disconnect = true;
return nullptr;
}
if (client->m_req->GetState() == HTTPRequest::State::Complete) {
LogDebug(
BCLog::HTTP,
"Received a %s request for %s from %s (id=%llu)",
RequestMethodString(client->m_req->GetRequestMethod()),
client->m_req->GetURI(),
client->m_origin,
client->m_id);
client->m_req_busy = true;
return std::move(client->m_req);
}
return nullptr;
}
void HTTPServer::DisconnectClients()
{
const auto now{Now<SteadySeconds>()};
size_t erased = std::erase_if(m_connected,
[&](auto& client) {
return client->MaybeDisconnect(now,
m_rpcservertimeout,
m_disconnect_all_clients);
});
if (erased > 0) {
m_connected_size.fetch_sub(erased, std::memory_order_relaxed);
}
}
bool HTTPRemoteClient::MaybeDisconnect(std::chrono::time_point<SteadyClock> now, std::chrono::seconds rpcservertimeout, bool disconnect_all)
{
const bool is_idle{rpcservertimeout.count() > 0 &&
now - m_idle_since.load() > rpcservertimeout &&
!m_req_busy};
if (m_disconnect || is_idle) {
if (is_idle) {
LogDebug(BCLog::HTTP,
"HTTP client idle timeout %s (id=%llu)",
m_origin,
m_id);
}
} else {
if (disconnect_all) {
if (m_connection_busy) {
return false;
} else {
;
}
} else {
return false;
}
}
LogDebug(BCLog::HTTP,
"Disconnecting HTTP client %s (id=%llu)",
m_origin,
m_id);
return true;
}
void HTTPServer::ClearConnectedClients()
{
Assume(!m_thread_socket_handler.joinable());
if (m_connected.empty()) return;
LogWarning("Force-disconnecting %d HTTP client(s) that did not disconnect gracefully", m_connected.size());
m_connected_size.fetch_sub(m_connected.size(), std::memory_order_relaxed);
m_connected.clear();
}
void HTTPRemoteClient::ReadRequest(HTTPRequest& req)
{
if (m_recv_buffer.empty()) return;
LineReader reader(m_recv_buffer, MAX_HEADERS_SIZE);
try {
switch (req.GetState()) {
case HTTPRequest::State::Init:
if (!req.LoadControlData(reader)) break;
req.SetState(HTTPRequest::State::NeedsHeaders);
[[fallthrough]];
case HTTPRequest::State::NeedsHeaders:
if (!req.LoadHeaders(reader)) break;
req.SetState(HTTPRequest::State::NeedsBody);
[[fallthrough]];
case HTTPRequest::State::NeedsBody:
if (!req.LoadBody(reader)) break;
req.SetState(HTTPRequest::State::Complete);
[[fallthrough]];
case HTTPRequest::State::Complete:
break;
case HTTPRequest::State::Error:
break;
}
} catch (...) {
req.SetState(HTTPRequest::State::Error);
m_recv_buffer.clear();
throw;
}
m_recv_buffer.erase(
m_recv_buffer.begin(),
m_recv_buffer.begin() + reader.Consumed());
}
bool HTTPRemoteClient::MaybeSendBytesFromBuffer()
{
LOCK(m_send_mutex);
if (!m_send_buffer.empty()) {
int flags{MSG_NOSIGNAL | MSG_DONTWAIT};
ssize_t bytes_sent;
{
LOCK(m_sock_mutex);
bytes_sent = m_sock->Send(m_send_buffer.data(),
m_send_buffer.size(),
flags);
}
if (bytes_sent < 0) {
const int err{WSAGetLastError()};
if (!IOErrorIsPermanent(err)) {
m_send_ready = true;
m_connection_busy = true;
return true;
} else {
LogDebug(
BCLog::HTTP,
"Error sending HTTP response data to client %s (id=%llu): %s",
m_origin,
m_id,
NetworkErrorString(err));
m_send_ready = false;
m_disconnect = true;
return false;
}
}
Assume(static_cast<size_t>(bytes_sent) <= m_send_buffer.size());
m_send_buffer.erase(m_send_buffer.begin(),
m_send_buffer.begin() + bytes_sent);
LogDebug(
BCLog::HTTP,
"Sent %d bytes to client %s (id=%llu)",
bytes_sent,
m_origin,
m_id);
if (m_send_buffer.empty()) {
m_send_ready = false;
m_connection_busy = false;
if (!m_keep_alive) {
m_disconnect = true;
return false;
}
} else {
m_send_ready = true;
m_connection_busy = true;
}
m_idle_since = Now<SteadySeconds>();
}
return true;
}
bool InitHTTPServer()
{
g_http_server = std::make_unique<HTTPServer>(MaybeDispatchRequestToWorker);
if (!g_http_server->InitHTTPAllowList()) {
return false;
}
g_http_server->SetServerTimeout(std::chrono::seconds(gArgs.GetIntArg("-rpcservertimeout", DEFAULT_HTTP_SERVER_TIMEOUT)));
g_http_server->SetMaxConnections(std::max(gArgs.GetArg<int>("-rpcmaxconnections", DEFAULT_MAX_HTTP_CONNECTIONS), 1));
std::vector<std::pair<std::string, uint16_t>> endpoints{GetBindAddresses()};
bool bind_success{false};
for (const auto& [address_string, port] : endpoints) {
LogInfo("Binding RPC on address %s port %i", address_string, port);
const std::optional<CService> addr{Lookup(address_string, port, false)};
if (addr) {
if (addr->IsBindAny()) {
LogWarning("The RPC server is not safe to expose to untrusted networks such as the public internet");
}
auto result{g_http_server->BindAndStartListening(addr.value())};
if (!result) {
LogWarning("Binding RPC on address %s failed: %s", addr->ToStringAddrPort(), result.error());
} else {
bind_success = true;
}
} else {
LogWarning("Could not bind RPC on address %s port %i: Address lookup failed.", address_string, port);
}
}
if (!bind_success) {
LogError("Unable to bind any endpoint for RPC server");
return false;
}
LogDebug(BCLog::HTTP, "Initialized HTTP server");
g_max_queue_depth = std::max(gArgs.GetArg<int>("-rpcworkqueue", DEFAULT_HTTP_WORKQUEUE), 1);
LogDebug(BCLog::HTTP, "set work queue of depth %d\n", g_max_queue_depth);
return true;
}
void StartHTTPServer()
{
auto rpcThreads{std::max(gArgs.GetArg<int>("-rpcthreads", DEFAULT_HTTP_THREADS), 1)};
LogInfo("Starting HTTP server with %d worker threads", rpcThreads);
g_threadpool_http.Start(rpcThreads);
g_http_server->StartSocketsThreads();
}
void InterruptHTTPServer()
{
LogDebug(BCLog::HTTP, "Interrupting HTTP server");
if (g_http_server) {
g_http_server->SetRequestHandler(RejectRequest);
}
g_threadpool_http.Interrupt();
}
void StopHTTPServer()
{
LogDebug(BCLog::HTTP, "Stopping HTTP server");
LogDebug(BCLog::HTTP, "Waiting for HTTP worker threads to exit\n");
g_threadpool_http.Stop();
if (g_http_server) {
g_http_server->StopAccepting();
g_http_server->DisconnectAllClients();
LogDebug(BCLog::HTTP, "Waiting for HTTP clients to disconnect gracefully");
const auto deadline{NodeClock::now() + 30s};
while (g_http_server->GetConnectionsCount() != 0) {
if (NodeClock::now() > deadline) {
LogWarning("Timeout waiting for HTTP clients to disconnect gracefully, continuing shutdown");
break;
}
std::this_thread::sleep_for(50ms);
}
g_http_server->InterruptNet();
g_http_server->JoinSocketsThreads();
g_http_server->ClearConnectedClients();
g_http_server->StopListening();
}
LogDebug(BCLog::HTTP, "Stopped HTTP server");
}