mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-26 11:13:23 -03:00
a15388c606
79d343a642
http: update libevent workaround to correct version (stickies-v) Pull request description: The libevent bug described in5ff8eb2637
was already patched in [release-2.1.9-beta](https://github.com/libevent/libevent/releases/tag/release-2.1.9-beta), with cherry-picked commits [5b40744d1581447f5b4496ee8d4807383e468e7a](5b40744d15
) and [b25813800f97179b2355a7b4b3557e6a7f568df2](b25813800f
). There should be no side-effects by re-applying the workaround on an already patched version of libevent (as is currently done in master for people running libevent between 2.1.9 and 2.1.12), but it is best to just set the correct version number to avoid confusion. This will prevent situations like e.g. in https://github.com/bitcoin/bitcoin/pull/27909#discussion_r1238858604, where a reverse workaround was incorrectly applied to the wrong version range. ACKs for top commit: fanquake: ACK79d343a642
Tree-SHA512: 56d2576411cf38e56d0976523fec951e032a48e35af293ed1ef3af820af940b26f779b9197baaed6d8b79bd1c7f7334646b9d73f80610d63cffbc955958ca8a0
716 lines
24 KiB
C++
716 lines
24 KiB
C++
// Copyright (c) 2015-2022 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#if defined(HAVE_CONFIG_H)
|
|
#include <config/bitcoin-config.h>
|
|
#endif
|
|
|
|
#include <httpserver.h>
|
|
|
|
#include <chainparamsbase.h>
|
|
#include <common/args.h>
|
|
#include <compat/compat.h>
|
|
#include <logging.h>
|
|
#include <netbase.h>
|
|
#include <node/interface_ui.h>
|
|
#include <rpc/protocol.h> // For HTTP status codes
|
|
#include <shutdown.h>
|
|
#include <sync.h>
|
|
#include <util/strencodings.h>
|
|
#include <util/threadnames.h>
|
|
#include <util/translation.h>
|
|
|
|
#include <condition_variable>
|
|
#include <cstdio>
|
|
#include <cstdlib>
|
|
#include <deque>
|
|
#include <memory>
|
|
#include <optional>
|
|
#include <string>
|
|
#include <unordered_set>
|
|
|
|
#include <sys/types.h>
|
|
#include <sys/stat.h>
|
|
|
|
#include <event2/buffer.h>
|
|
#include <event2/bufferevent.h>
|
|
#include <event2/http.h>
|
|
#include <event2/http_struct.h>
|
|
#include <event2/keyvalq_struct.h>
|
|
#include <event2/thread.h>
|
|
#include <event2/util.h>
|
|
|
|
#include <support/events.h>
|
|
|
|
/** Maximum size of http request (request line + headers) */
|
|
static const size_t MAX_HEADERS_SIZE = 8192;
|
|
|
|
/** HTTP request work item */
|
|
class HTTPWorkItem final : public HTTPClosure
|
|
{
|
|
public:
|
|
HTTPWorkItem(std::unique_ptr<HTTPRequest> _req, const std::string &_path, const HTTPRequestHandler& _func):
|
|
req(std::move(_req)), path(_path), func(_func)
|
|
{
|
|
}
|
|
void operator()() override
|
|
{
|
|
func(req.get(), path);
|
|
}
|
|
|
|
std::unique_ptr<HTTPRequest> req;
|
|
|
|
private:
|
|
std::string path;
|
|
HTTPRequestHandler func;
|
|
};
|
|
|
|
/** Simple work queue for distributing work over multiple threads.
|
|
* Work items are simply callable objects.
|
|
*/
|
|
template <typename WorkItem>
|
|
class WorkQueue
|
|
{
|
|
private:
|
|
Mutex cs;
|
|
std::condition_variable cond GUARDED_BY(cs);
|
|
std::deque<std::unique_ptr<WorkItem>> queue GUARDED_BY(cs);
|
|
bool running GUARDED_BY(cs){true};
|
|
const size_t maxDepth;
|
|
|
|
public:
|
|
explicit WorkQueue(size_t _maxDepth) : maxDepth(_maxDepth)
|
|
{
|
|
}
|
|
/** Precondition: worker threads have all stopped (they have been joined).
|
|
*/
|
|
~WorkQueue() = default;
|
|
/** Enqueue a work item */
|
|
bool Enqueue(WorkItem* item) EXCLUSIVE_LOCKS_REQUIRED(!cs)
|
|
{
|
|
LOCK(cs);
|
|
if (!running || queue.size() >= maxDepth) {
|
|
return false;
|
|
}
|
|
queue.emplace_back(std::unique_ptr<WorkItem>(item));
|
|
cond.notify_one();
|
|
return true;
|
|
}
|
|
/** Thread function */
|
|
void Run() EXCLUSIVE_LOCKS_REQUIRED(!cs)
|
|
{
|
|
while (true) {
|
|
std::unique_ptr<WorkItem> i;
|
|
{
|
|
WAIT_LOCK(cs, lock);
|
|
while (running && queue.empty())
|
|
cond.wait(lock);
|
|
if (!running && queue.empty())
|
|
break;
|
|
i = std::move(queue.front());
|
|
queue.pop_front();
|
|
}
|
|
(*i)();
|
|
}
|
|
}
|
|
/** Interrupt and exit loops */
|
|
void Interrupt() EXCLUSIVE_LOCKS_REQUIRED(!cs)
|
|
{
|
|
LOCK(cs);
|
|
running = false;
|
|
cond.notify_all();
|
|
}
|
|
};
|
|
|
|
struct HTTPPathHandler
|
|
{
|
|
HTTPPathHandler(std::string _prefix, bool _exactMatch, HTTPRequestHandler _handler):
|
|
prefix(_prefix), exactMatch(_exactMatch), handler(_handler)
|
|
{
|
|
}
|
|
std::string prefix;
|
|
bool exactMatch;
|
|
HTTPRequestHandler handler;
|
|
};
|
|
|
|
/** HTTP module state */
|
|
|
|
//! libevent event loop
|
|
static struct event_base* eventBase = nullptr;
|
|
//! HTTP server
|
|
static struct evhttp* eventHTTP = nullptr;
|
|
//! List of subnets to allow RPC connections from
|
|
static std::vector<CSubNet> rpc_allow_subnets;
|
|
//! Work queue for handling longer requests off the event loop thread
|
|
static std::unique_ptr<WorkQueue<HTTPClosure>> g_work_queue{nullptr};
|
|
//! Handlers for (sub)paths
|
|
static GlobalMutex g_httppathhandlers_mutex;
|
|
static std::vector<HTTPPathHandler> pathHandlers GUARDED_BY(g_httppathhandlers_mutex);
|
|
//! Bound listening sockets
|
|
static std::vector<evhttp_bound_socket *> boundSockets;
|
|
//! Track active requests
|
|
static GlobalMutex g_requests_mutex;
|
|
static std::condition_variable g_requests_cv;
|
|
static std::unordered_set<evhttp_request*> g_requests GUARDED_BY(g_requests_mutex);
|
|
|
|
/** Check if a network address is allowed to access the HTTP server */
|
|
static bool ClientAllowed(const CNetAddr& netaddr)
|
|
{
|
|
if (!netaddr.IsValid())
|
|
return false;
|
|
for(const CSubNet& subnet : rpc_allow_subnets)
|
|
if (subnet.Match(netaddr))
|
|
return true;
|
|
return false;
|
|
}
|
|
|
|
/** Initialize ACL list for HTTP server */
|
|
static bool InitHTTPAllowList()
|
|
{
|
|
rpc_allow_subnets.clear();
|
|
rpc_allow_subnets.push_back(CSubNet{LookupHost("127.0.0.1", false).value(), 8}); // always allow IPv4 local subnet
|
|
rpc_allow_subnets.push_back(CSubNet{LookupHost("::1", false).value()}); // always allow IPv6 localhost
|
|
for (const std::string& strAllow : gArgs.GetArgs("-rpcallowip")) {
|
|
CSubNet subnet;
|
|
LookupSubNet(strAllow, subnet);
|
|
if (!subnet.IsValid()) {
|
|
uiInterface.ThreadSafeMessageBox(
|
|
strprintf(Untranslated("Invalid -rpcallowip subnet specification: %s. Valid are a single IP (e.g. 1.2.3.4), a network/netmask (e.g. 1.2.3.4/255.255.255.0) or a network/CIDR (e.g. 1.2.3.4/24)."), strAllow),
|
|
"", CClientUIInterface::MSG_ERROR);
|
|
return false;
|
|
}
|
|
rpc_allow_subnets.push_back(subnet);
|
|
}
|
|
std::string strAllowed;
|
|
for (const CSubNet& subnet : rpc_allow_subnets)
|
|
strAllowed += subnet.ToString() + " ";
|
|
LogPrint(BCLog::HTTP, "Allowing HTTP connections from: %s\n", strAllowed);
|
|
return true;
|
|
}
|
|
|
|
/** HTTP request method as string - use for logging only */
|
|
std::string RequestMethodString(HTTPRequest::RequestMethod m)
|
|
{
|
|
switch (m) {
|
|
case HTTPRequest::GET:
|
|
return "GET";
|
|
case HTTPRequest::POST:
|
|
return "POST";
|
|
case HTTPRequest::HEAD:
|
|
return "HEAD";
|
|
case HTTPRequest::PUT:
|
|
return "PUT";
|
|
case HTTPRequest::UNKNOWN:
|
|
return "unknown";
|
|
} // no default case, so the compiler can warn about missing cases
|
|
assert(false);
|
|
}
|
|
|
|
/** HTTP request callback */
|
|
static void http_request_cb(struct evhttp_request* req, void* arg)
|
|
{
|
|
// Track requests and notify when a request is completed.
|
|
{
|
|
WITH_LOCK(g_requests_mutex, g_requests.insert(req));
|
|
g_requests_cv.notify_all();
|
|
evhttp_request_set_on_complete_cb(req, [](struct evhttp_request* req, void*) {
|
|
auto n{WITH_LOCK(g_requests_mutex, return g_requests.erase(req))};
|
|
assert(n == 1);
|
|
g_requests_cv.notify_all();
|
|
}, nullptr);
|
|
}
|
|
|
|
// Disable reading to work around a libevent bug, fixed in 2.1.9
|
|
// See https://github.com/libevent/libevent/commit/5ff8eb26371c4dc56f384b2de35bea2d87814779
|
|
// and https://github.com/bitcoin/bitcoin/pull/11593.
|
|
if (event_get_version_number() >= 0x02010600 && event_get_version_number() < 0x02010900) {
|
|
evhttp_connection* conn = evhttp_request_get_connection(req);
|
|
if (conn) {
|
|
bufferevent* bev = evhttp_connection_get_bufferevent(conn);
|
|
if (bev) {
|
|
bufferevent_disable(bev, EV_READ);
|
|
}
|
|
}
|
|
}
|
|
std::unique_ptr<HTTPRequest> hreq(new HTTPRequest(req));
|
|
|
|
// Early address-based allow check
|
|
if (!ClientAllowed(hreq->GetPeer())) {
|
|
LogPrint(BCLog::HTTP, "HTTP request from %s rejected: Client network is not allowed RPC access\n",
|
|
hreq->GetPeer().ToStringAddrPort());
|
|
hreq->WriteReply(HTTP_FORBIDDEN);
|
|
return;
|
|
}
|
|
|
|
// Early reject unknown HTTP methods
|
|
if (hreq->GetRequestMethod() == HTTPRequest::UNKNOWN) {
|
|
LogPrint(BCLog::HTTP, "HTTP request from %s rejected: Unknown HTTP request method\n",
|
|
hreq->GetPeer().ToStringAddrPort());
|
|
hreq->WriteReply(HTTP_BAD_METHOD);
|
|
return;
|
|
}
|
|
|
|
LogPrint(BCLog::HTTP, "Received a %s request for %s from %s\n",
|
|
RequestMethodString(hreq->GetRequestMethod()), SanitizeString(hreq->GetURI(), SAFE_CHARS_URI).substr(0, 100), hreq->GetPeer().ToStringAddrPort());
|
|
|
|
// Find registered handler for prefix
|
|
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.substr(0, i->prefix.size()) == i->prefix);
|
|
if (match) {
|
|
path = strURI.substr(i->prefix.size());
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Dispatch to worker thread
|
|
if (i != iend) {
|
|
std::unique_ptr<HTTPWorkItem> item(new HTTPWorkItem(std::move(hreq), path, i->handler));
|
|
assert(g_work_queue);
|
|
if (g_work_queue->Enqueue(item.get())) {
|
|
item.release(); /* if true, queue took ownership */
|
|
} else {
|
|
LogPrintf("WARNING: request rejected because http work queue depth exceeded, it can be increased with the -rpcworkqueue= setting\n");
|
|
item->req->WriteReply(HTTP_SERVICE_UNAVAILABLE, "Work queue depth exceeded");
|
|
}
|
|
} else {
|
|
hreq->WriteReply(HTTP_NOT_FOUND);
|
|
}
|
|
}
|
|
|
|
/** Callback to reject HTTP requests after shutdown. */
|
|
static void http_reject_request_cb(struct evhttp_request* req, void*)
|
|
{
|
|
LogPrint(BCLog::HTTP, "Rejecting request while shutting down\n");
|
|
evhttp_send_error(req, HTTP_SERVUNAVAIL, nullptr);
|
|
}
|
|
|
|
/** Event dispatcher thread */
|
|
static void ThreadHTTP(struct event_base* base)
|
|
{
|
|
util::ThreadRename("http");
|
|
LogPrint(BCLog::HTTP, "Entering http event loop\n");
|
|
event_base_dispatch(base);
|
|
// Event loop will be interrupted by InterruptHTTPServer()
|
|
LogPrint(BCLog::HTTP, "Exited http event loop\n");
|
|
}
|
|
|
|
/** Bind HTTP server to specified addresses */
|
|
static bool HTTPBindAddresses(struct evhttp* http)
|
|
{
|
|
uint16_t http_port{static_cast<uint16_t>(gArgs.GetIntArg("-rpcport", BaseParams().RPCPort()))};
|
|
std::vector<std::pair<std::string, uint16_t>> endpoints;
|
|
|
|
// Determine what addresses to bind to
|
|
if (!(gArgs.IsArgSet("-rpcallowip") && gArgs.IsArgSet("-rpcbind"))) { // Default to loopback if not allowing external IPs
|
|
endpoints.push_back(std::make_pair("::1", http_port));
|
|
endpoints.push_back(std::make_pair("127.0.0.1", http_port));
|
|
if (gArgs.IsArgSet("-rpcallowip")) {
|
|
LogPrintf("WARNING: option -rpcallowip was specified without -rpcbind; this doesn't usually make sense\n");
|
|
}
|
|
if (gArgs.IsArgSet("-rpcbind")) {
|
|
LogPrintf("WARNING: option -rpcbind was ignored because -rpcallowip was not specified, refusing to allow everyone to connect\n");
|
|
}
|
|
} else if (gArgs.IsArgSet("-rpcbind")) { // Specific bind address
|
|
for (const std::string& strRPCBind : gArgs.GetArgs("-rpcbind")) {
|
|
uint16_t port{http_port};
|
|
std::string host;
|
|
SplitHostPort(strRPCBind, port, host);
|
|
endpoints.push_back(std::make_pair(host, port));
|
|
}
|
|
}
|
|
|
|
// Bind addresses
|
|
for (std::vector<std::pair<std::string, uint16_t> >::iterator i = endpoints.begin(); i != endpoints.end(); ++i) {
|
|
LogPrintf("Binding RPC on address %s port %i\n", i->first, i->second);
|
|
evhttp_bound_socket *bind_handle = evhttp_bind_socket_with_handle(http, i->first.empty() ? nullptr : i->first.c_str(), i->second);
|
|
if (bind_handle) {
|
|
const std::optional<CNetAddr> addr{LookupHost(i->first, false)};
|
|
if (i->first.empty() || (addr.has_value() && addr->IsBindAny())) {
|
|
LogPrintf("WARNING: the RPC server is not safe to expose to untrusted networks such as the public internet\n");
|
|
}
|
|
boundSockets.push_back(bind_handle);
|
|
} else {
|
|
LogPrintf("Binding RPC on address %s port %i failed.\n", i->first, i->second);
|
|
}
|
|
}
|
|
return !boundSockets.empty();
|
|
}
|
|
|
|
/** Simple wrapper to set thread name and run work queue */
|
|
static void HTTPWorkQueueRun(WorkQueue<HTTPClosure>* queue, int worker_num)
|
|
{
|
|
util::ThreadRename(strprintf("httpworker.%i", worker_num));
|
|
queue->Run();
|
|
}
|
|
|
|
/** libevent event log callback */
|
|
static void libevent_log_cb(int severity, const char *msg)
|
|
{
|
|
BCLog::Level level;
|
|
switch (severity) {
|
|
case EVENT_LOG_DEBUG:
|
|
level = BCLog::Level::Debug;
|
|
break;
|
|
case EVENT_LOG_MSG:
|
|
level = BCLog::Level::Info;
|
|
break;
|
|
case EVENT_LOG_WARN:
|
|
level = BCLog::Level::Warning;
|
|
break;
|
|
default: // EVENT_LOG_ERR and others are mapped to error
|
|
level = BCLog::Level::Error;
|
|
break;
|
|
}
|
|
LogPrintLevel(BCLog::LIBEVENT, level, "%s\n", msg);
|
|
}
|
|
|
|
bool InitHTTPServer()
|
|
{
|
|
if (!InitHTTPAllowList())
|
|
return false;
|
|
|
|
// Redirect libevent's logging to our own log
|
|
event_set_log_callback(&libevent_log_cb);
|
|
// Update libevent's log handling.
|
|
UpdateHTTPServerLogging(LogInstance().WillLogCategory(BCLog::LIBEVENT));
|
|
|
|
#ifdef WIN32
|
|
evthread_use_windows_threads();
|
|
#else
|
|
evthread_use_pthreads();
|
|
#endif
|
|
|
|
raii_event_base base_ctr = obtain_event_base();
|
|
|
|
/* Create a new evhttp object to handle requests. */
|
|
raii_evhttp http_ctr = obtain_evhttp(base_ctr.get());
|
|
struct evhttp* http = http_ctr.get();
|
|
if (!http) {
|
|
LogPrintf("couldn't create evhttp. Exiting.\n");
|
|
return false;
|
|
}
|
|
|
|
evhttp_set_timeout(http, gArgs.GetIntArg("-rpcservertimeout", DEFAULT_HTTP_SERVER_TIMEOUT));
|
|
evhttp_set_max_headers_size(http, MAX_HEADERS_SIZE);
|
|
evhttp_set_max_body_size(http, MAX_SIZE);
|
|
evhttp_set_gencb(http, http_request_cb, nullptr);
|
|
|
|
if (!HTTPBindAddresses(http)) {
|
|
LogPrintf("Unable to bind any endpoint for RPC server\n");
|
|
return false;
|
|
}
|
|
|
|
LogPrint(BCLog::HTTP, "Initialized HTTP server\n");
|
|
int workQueueDepth = std::max((long)gArgs.GetIntArg("-rpcworkqueue", DEFAULT_HTTP_WORKQUEUE), 1L);
|
|
LogPrintfCategory(BCLog::HTTP, "creating work queue of depth %d\n", workQueueDepth);
|
|
|
|
g_work_queue = std::make_unique<WorkQueue<HTTPClosure>>(workQueueDepth);
|
|
// transfer ownership to eventBase/HTTP via .release()
|
|
eventBase = base_ctr.release();
|
|
eventHTTP = http_ctr.release();
|
|
return true;
|
|
}
|
|
|
|
void UpdateHTTPServerLogging(bool enable) {
|
|
if (enable) {
|
|
event_enable_debug_logging(EVENT_DBG_ALL);
|
|
} else {
|
|
event_enable_debug_logging(EVENT_DBG_NONE);
|
|
}
|
|
}
|
|
|
|
static std::thread g_thread_http;
|
|
static std::vector<std::thread> g_thread_http_workers;
|
|
|
|
void StartHTTPServer()
|
|
{
|
|
LogPrint(BCLog::HTTP, "Starting HTTP server\n");
|
|
int rpcThreads = std::max((long)gArgs.GetIntArg("-rpcthreads", DEFAULT_HTTP_THREADS), 1L);
|
|
LogPrintfCategory(BCLog::HTTP, "starting %d worker threads\n", rpcThreads);
|
|
g_thread_http = std::thread(ThreadHTTP, eventBase);
|
|
|
|
for (int i = 0; i < rpcThreads; i++) {
|
|
g_thread_http_workers.emplace_back(HTTPWorkQueueRun, g_work_queue.get(), i);
|
|
}
|
|
}
|
|
|
|
void InterruptHTTPServer()
|
|
{
|
|
LogPrint(BCLog::HTTP, "Interrupting HTTP server\n");
|
|
if (eventHTTP) {
|
|
// Reject requests on current connections
|
|
evhttp_set_gencb(eventHTTP, http_reject_request_cb, nullptr);
|
|
}
|
|
if (g_work_queue) {
|
|
g_work_queue->Interrupt();
|
|
}
|
|
}
|
|
|
|
void StopHTTPServer()
|
|
{
|
|
LogPrint(BCLog::HTTP, "Stopping HTTP server\n");
|
|
if (g_work_queue) {
|
|
LogPrint(BCLog::HTTP, "Waiting for HTTP worker threads to exit\n");
|
|
for (auto& thread : g_thread_http_workers) {
|
|
thread.join();
|
|
}
|
|
g_thread_http_workers.clear();
|
|
}
|
|
// Unlisten sockets, these are what make the event loop running, which means
|
|
// that after this and all connections are closed the event loop will quit.
|
|
for (evhttp_bound_socket *socket : boundSockets) {
|
|
evhttp_del_accept_socket(eventHTTP, socket);
|
|
}
|
|
boundSockets.clear();
|
|
{
|
|
WAIT_LOCK(g_requests_mutex, lock);
|
|
if (!g_requests.empty()) {
|
|
LogPrint(BCLog::HTTP, "Waiting for %d requests to stop HTTP server\n", g_requests.size());
|
|
}
|
|
g_requests_cv.wait(lock, []() EXCLUSIVE_LOCKS_REQUIRED(g_requests_mutex) {
|
|
return g_requests.empty();
|
|
});
|
|
}
|
|
if (eventHTTP) {
|
|
// Schedule a callback to call evhttp_free in the event base thread, so
|
|
// that evhttp_free does not need to be called again after the handling
|
|
// of unfinished request connections that follows.
|
|
event_base_once(eventBase, -1, EV_TIMEOUT, [](evutil_socket_t, short, void*) {
|
|
evhttp_free(eventHTTP);
|
|
eventHTTP = nullptr;
|
|
}, nullptr, nullptr);
|
|
}
|
|
if (eventBase) {
|
|
LogPrint(BCLog::HTTP, "Waiting for HTTP event thread to exit\n");
|
|
if (g_thread_http.joinable()) g_thread_http.join();
|
|
event_base_free(eventBase);
|
|
eventBase = nullptr;
|
|
}
|
|
g_work_queue.reset();
|
|
LogPrint(BCLog::HTTP, "Stopped HTTP server\n");
|
|
}
|
|
|
|
struct event_base* EventBase()
|
|
{
|
|
return eventBase;
|
|
}
|
|
|
|
static void httpevent_callback_fn(evutil_socket_t, short, void* data)
|
|
{
|
|
// Static handler: simply call inner handler
|
|
HTTPEvent *self = static_cast<HTTPEvent*>(data);
|
|
self->handler();
|
|
if (self->deleteWhenTriggered)
|
|
delete self;
|
|
}
|
|
|
|
HTTPEvent::HTTPEvent(struct event_base* base, bool _deleteWhenTriggered, const std::function<void()>& _handler):
|
|
deleteWhenTriggered(_deleteWhenTriggered), handler(_handler)
|
|
{
|
|
ev = event_new(base, -1, 0, httpevent_callback_fn, this);
|
|
assert(ev);
|
|
}
|
|
HTTPEvent::~HTTPEvent()
|
|
{
|
|
event_free(ev);
|
|
}
|
|
void HTTPEvent::trigger(struct timeval* tv)
|
|
{
|
|
if (tv == nullptr)
|
|
event_active(ev, 0, 0); // immediately trigger event in main thread
|
|
else
|
|
evtimer_add(ev, tv); // trigger after timeval passed
|
|
}
|
|
HTTPRequest::HTTPRequest(struct evhttp_request* _req, bool _replySent) : req(_req), replySent(_replySent)
|
|
{
|
|
}
|
|
|
|
HTTPRequest::~HTTPRequest()
|
|
{
|
|
if (!replySent) {
|
|
// Keep track of whether reply was sent to avoid request leaks
|
|
LogPrintf("%s: Unhandled request\n", __func__);
|
|
WriteReply(HTTP_INTERNAL_SERVER_ERROR, "Unhandled request");
|
|
}
|
|
// evhttpd cleans up the request, as long as a reply was sent.
|
|
}
|
|
|
|
std::pair<bool, std::string> HTTPRequest::GetHeader(const std::string& hdr) const
|
|
{
|
|
const struct evkeyvalq* headers = evhttp_request_get_input_headers(req);
|
|
assert(headers);
|
|
const char* val = evhttp_find_header(headers, hdr.c_str());
|
|
if (val)
|
|
return std::make_pair(true, val);
|
|
else
|
|
return std::make_pair(false, "");
|
|
}
|
|
|
|
std::string HTTPRequest::ReadBody()
|
|
{
|
|
struct evbuffer* buf = evhttp_request_get_input_buffer(req);
|
|
if (!buf)
|
|
return "";
|
|
size_t size = evbuffer_get_length(buf);
|
|
/** Trivial implementation: if this is ever a performance bottleneck,
|
|
* internal copying can be avoided in multi-segment buffers by using
|
|
* evbuffer_peek and an awkward loop. Though in that case, it'd be even
|
|
* better to not copy into an intermediate string but use a stream
|
|
* abstraction to consume the evbuffer on the fly in the parsing algorithm.
|
|
*/
|
|
const char* data = (const char*)evbuffer_pullup(buf, size);
|
|
if (!data) // returns nullptr in case of empty buffer
|
|
return "";
|
|
std::string rv(data, size);
|
|
evbuffer_drain(buf, size);
|
|
return rv;
|
|
}
|
|
|
|
void HTTPRequest::WriteHeader(const std::string& hdr, const std::string& value)
|
|
{
|
|
struct evkeyvalq* headers = evhttp_request_get_output_headers(req);
|
|
assert(headers);
|
|
evhttp_add_header(headers, hdr.c_str(), value.c_str());
|
|
}
|
|
|
|
/** Closure sent to main thread to request a reply to be sent to
|
|
* a HTTP request.
|
|
* Replies must be sent in the main loop in the main http thread,
|
|
* this cannot be done from worker threads.
|
|
*/
|
|
void HTTPRequest::WriteReply(int nStatus, const std::string& strReply)
|
|
{
|
|
assert(!replySent && req);
|
|
if (ShutdownRequested()) {
|
|
WriteHeader("Connection", "close");
|
|
}
|
|
// Send event to main http thread to send reply message
|
|
struct evbuffer* evb = evhttp_request_get_output_buffer(req);
|
|
assert(evb);
|
|
evbuffer_add(evb, strReply.data(), strReply.size());
|
|
auto req_copy = req;
|
|
HTTPEvent* ev = new HTTPEvent(eventBase, true, [req_copy, nStatus]{
|
|
evhttp_send_reply(req_copy, nStatus, nullptr, nullptr);
|
|
// Re-enable reading from the socket. This is the second part of the libevent
|
|
// workaround above.
|
|
if (event_get_version_number() >= 0x02010600 && event_get_version_number() < 0x02010900) {
|
|
evhttp_connection* conn = evhttp_request_get_connection(req_copy);
|
|
if (conn) {
|
|
bufferevent* bev = evhttp_connection_get_bufferevent(conn);
|
|
if (bev) {
|
|
bufferevent_enable(bev, EV_READ | EV_WRITE);
|
|
}
|
|
}
|
|
}
|
|
});
|
|
ev->trigger(nullptr);
|
|
replySent = true;
|
|
req = nullptr; // transferred back to main thread
|
|
}
|
|
|
|
CService HTTPRequest::GetPeer() const
|
|
{
|
|
evhttp_connection* con = evhttp_request_get_connection(req);
|
|
CService peer;
|
|
if (con) {
|
|
// evhttp retains ownership over returned address string
|
|
const char* address = "";
|
|
uint16_t port = 0;
|
|
|
|
#ifdef HAVE_EVHTTP_CONNECTION_GET_PEER_CONST_CHAR
|
|
evhttp_connection_get_peer(con, &address, &port);
|
|
#else
|
|
evhttp_connection_get_peer(con, (char**)&address, &port);
|
|
#endif // HAVE_EVHTTP_CONNECTION_GET_PEER_CONST_CHAR
|
|
|
|
peer = LookupNumeric(address, port);
|
|
}
|
|
return peer;
|
|
}
|
|
|
|
std::string HTTPRequest::GetURI() const
|
|
{
|
|
return evhttp_request_get_uri(req);
|
|
}
|
|
|
|
HTTPRequest::RequestMethod HTTPRequest::GetRequestMethod() const
|
|
{
|
|
switch (evhttp_request_get_command(req)) {
|
|
case EVHTTP_REQ_GET:
|
|
return GET;
|
|
case EVHTTP_REQ_POST:
|
|
return POST;
|
|
case EVHTTP_REQ_HEAD:
|
|
return HEAD;
|
|
case EVHTTP_REQ_PUT:
|
|
return PUT;
|
|
default:
|
|
return UNKNOWN;
|
|
}
|
|
}
|
|
|
|
std::optional<std::string> HTTPRequest::GetQueryParameter(const std::string& key) const
|
|
{
|
|
const char* uri{evhttp_request_get_uri(req)};
|
|
|
|
return GetQueryParameterFromUri(uri, key);
|
|
}
|
|
|
|
std::optional<std::string> GetQueryParameterFromUri(const char* uri, const std::string& key)
|
|
{
|
|
evhttp_uri* uri_parsed{evhttp_uri_parse(uri)};
|
|
if (!uri_parsed) {
|
|
throw std::runtime_error("URI parsing failed, it likely contained RFC 3986 invalid characters");
|
|
}
|
|
const char* query{evhttp_uri_get_query(uri_parsed)};
|
|
std::optional<std::string> result;
|
|
|
|
if (query) {
|
|
// Parse the query string into a key-value queue and iterate over it
|
|
struct evkeyvalq params_q;
|
|
evhttp_parse_query_str(query, ¶ms_q);
|
|
|
|
for (struct evkeyval* param{params_q.tqh_first}; param != nullptr; param = param->next.tqe_next) {
|
|
if (param->key == key) {
|
|
result = param->value;
|
|
break;
|
|
}
|
|
}
|
|
evhttp_clear_headers(¶ms_q);
|
|
}
|
|
evhttp_uri_free(uri_parsed);
|
|
|
|
return result;
|
|
}
|
|
|
|
void RegisterHTTPHandler(const std::string &prefix, bool exactMatch, const HTTPRequestHandler &handler)
|
|
{
|
|
LogPrint(BCLog::HTTP, "Registering HTTP handler for %s (exactmatch %d)\n", prefix, exactMatch);
|
|
LOCK(g_httppathhandlers_mutex);
|
|
pathHandlers.push_back(HTTPPathHandler(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)
|
|
{
|
|
LogPrint(BCLog::HTTP, "Unregistering HTTP handler for %s (exactmatch %d)\n", prefix, exactMatch);
|
|
pathHandlers.erase(i);
|
|
}
|
|
}
|