Branch data Line data Source code
1 : : // Copyright (c) 2015-2022 The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <config/bitcoin-config.h> // IWYU pragma: keep
6 : :
7 : : #include <httpserver.h>
8 : :
9 : : #include <chainparamsbase.h>
10 : : #include <common/args.h>
11 : : #include <compat/compat.h>
12 : : #include <logging.h>
13 : : #include <netbase.h>
14 : : #include <node/interface_ui.h>
15 : : #include <rpc/protocol.h> // For HTTP status codes
16 : : #include <sync.h>
17 : : #include <util/check.h>
18 : : #include <util/signalinterrupt.h>
19 : : #include <util/strencodings.h>
20 : : #include <util/threadnames.h>
21 : : #include <util/translation.h>
22 : :
23 : : #include <condition_variable>
24 : : #include <cstdio>
25 : : #include <cstdlib>
26 : : #include <deque>
27 : : #include <memory>
28 : : #include <optional>
29 : : #include <span>
30 : : #include <string>
31 : : #include <unordered_map>
32 : :
33 : : #include <sys/types.h>
34 : : #include <sys/stat.h>
35 : :
36 : : #include <event2/buffer.h>
37 : : #include <event2/bufferevent.h>
38 : : #include <event2/http.h>
39 : : #include <event2/http_struct.h>
40 : : #include <event2/keyvalq_struct.h>
41 : : #include <event2/thread.h>
42 : : #include <event2/util.h>
43 : :
44 : : #include <support/events.h>
45 : :
46 : : /** Maximum size of http request (request line + headers) */
47 : : static const size_t MAX_HEADERS_SIZE = 8192;
48 : :
49 : : /** HTTP request work item */
50 : : class HTTPWorkItem final : public HTTPClosure
51 : : {
52 : : public:
53 : 0 : HTTPWorkItem(std::unique_ptr<HTTPRequest> _req, const std::string &_path, const HTTPRequestHandler& _func):
54 [ # # # # ]: 0 : req(std::move(_req)), path(_path), func(_func)
55 : : {
56 : 0 : }
57 : 0 : void operator()() override
58 : : {
59 : 0 : func(req.get(), path);
60 : 0 : }
61 : :
62 : : std::unique_ptr<HTTPRequest> req;
63 : :
64 : : private:
65 : : std::string path;
66 : : HTTPRequestHandler func;
67 : : };
68 : :
69 : : /** Simple work queue for distributing work over multiple threads.
70 : : * Work items are simply callable objects.
71 : : */
72 : : template <typename WorkItem>
73 : : class WorkQueue
74 : : {
75 : : private:
76 : : Mutex cs;
77 : : std::condition_variable cond GUARDED_BY(cs);
78 : : std::deque<std::unique_ptr<WorkItem>> queue GUARDED_BY(cs);
79 : : bool running GUARDED_BY(cs){true};
80 : : const size_t maxDepth;
81 : :
82 : : public:
83 [ # # ]: 0 : explicit WorkQueue(size_t _maxDepth) : maxDepth(_maxDepth)
84 : : {
85 : 0 : }
86 : : /** Precondition: worker threads have all stopped (they have been joined).
87 : : */
88 : 0 : ~WorkQueue() = default;
89 : : /** Enqueue a work item */
90 : 0 : bool Enqueue(WorkItem* item) EXCLUSIVE_LOCKS_REQUIRED(!cs)
91 : : {
92 : 0 : LOCK(cs);
93 [ # # # # ]: 0 : if (!running || queue.size() >= maxDepth) {
94 : : return false;
95 : : }
96 [ # # ]: 0 : queue.emplace_back(std::unique_ptr<WorkItem>(item));
97 : 0 : cond.notify_one();
98 : 0 : return true;
99 : 0 : }
100 : : /** Thread function */
101 : 0 : void Run() EXCLUSIVE_LOCKS_REQUIRED(!cs)
102 : : {
103 : 0 : while (true) {
104 : 0 : std::unique_ptr<WorkItem> i;
105 : : {
106 [ # # ]: 0 : WAIT_LOCK(cs, lock);
107 [ # # # # ]: 0 : while (running && queue.empty())
108 [ # # ]: 0 : cond.wait(lock);
109 [ # # # # ]: 0 : if (!running && queue.empty())
110 : : break;
111 : 0 : i = std::move(queue.front());
112 [ # # ]: 0 : queue.pop_front();
113 [ # # ]: 0 : }
114 [ # # ]: 0 : (*i)();
115 : : }
116 : 0 : }
117 : : /** Interrupt and exit loops */
118 : 0 : void Interrupt() EXCLUSIVE_LOCKS_REQUIRED(!cs)
119 : : {
120 : 0 : LOCK(cs);
121 : 0 : running = false;
122 [ # # ]: 0 : cond.notify_all();
123 : 0 : }
124 : : };
125 : :
126 : 0 : struct HTTPPathHandler
127 : : {
128 : 0 : HTTPPathHandler(std::string _prefix, bool _exactMatch, HTTPRequestHandler _handler):
129 [ # # ]: 0 : prefix(_prefix), exactMatch(_exactMatch), handler(_handler)
130 : : {
131 : 0 : }
132 : : std::string prefix;
133 : : bool exactMatch;
134 : : HTTPRequestHandler handler;
135 : : };
136 : :
137 : : /** HTTP module state */
138 : :
139 : : //! libevent event loop
140 : : static struct event_base* eventBase = nullptr;
141 : : //! HTTP server
142 : : static struct evhttp* eventHTTP = nullptr;
143 : : //! List of subnets to allow RPC connections from
144 : : static std::vector<CSubNet> rpc_allow_subnets;
145 : : //! Work queue for handling longer requests off the event loop thread
146 : : static std::unique_ptr<WorkQueue<HTTPClosure>> g_work_queue{nullptr};
147 : : //! Handlers for (sub)paths
148 : : static GlobalMutex g_httppathhandlers_mutex;
149 : : static std::vector<HTTPPathHandler> pathHandlers GUARDED_BY(g_httppathhandlers_mutex);
150 : : //! Bound listening sockets
151 : : static std::vector<evhttp_bound_socket *> boundSockets;
152 : :
153 : : /**
154 : : * @brief Helps keep track of open `evhttp_connection`s with active `evhttp_requests`
155 : : *
156 : : */
157 : : class HTTPRequestTracker
158 : : {
159 : : private:
160 : : mutable Mutex m_mutex;
161 : : mutable std::condition_variable m_cv;
162 : : //! For each connection, keep a counter of how many requests are open
163 : : std::unordered_map<const evhttp_connection*, size_t> m_tracker GUARDED_BY(m_mutex);
164 : :
165 : 0 : void RemoveConnectionInternal(const decltype(m_tracker)::iterator it) EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
166 : : {
167 : 0 : m_tracker.erase(it);
168 [ # # ]: 0 : if (m_tracker.empty()) m_cv.notify_all();
169 : 0 : }
170 : : public:
171 : : //! Increase request counter for the associated connection by 1
172 : 0 : void AddRequest(evhttp_request* req) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
173 : : {
174 : 0 : const evhttp_connection* conn{Assert(evhttp_request_get_connection(Assert(req)))};
175 [ # # # # ]: 0 : WITH_LOCK(m_mutex, ++m_tracker[conn]);
176 : 0 : }
177 : : //! Decrease request counter for the associated connection by 1, remove connection if counter is 0
178 : 0 : void RemoveRequest(evhttp_request* req) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
179 : : {
180 : 0 : const evhttp_connection* conn{Assert(evhttp_request_get_connection(Assert(req)))};
181 : 0 : LOCK(m_mutex);
182 : 0 : auto it{m_tracker.find(conn)};
183 [ # # # # ]: 0 : if (it != m_tracker.end() && it->second > 0) {
184 [ # # ]: 0 : if (--(it->second) == 0) RemoveConnectionInternal(it);
185 : : }
186 : 0 : }
187 : : //! Remove a connection entirely
188 : 0 : void RemoveConnection(const evhttp_connection* conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
189 : : {
190 : 0 : LOCK(m_mutex);
191 [ # # ]: 0 : auto it{m_tracker.find(Assert(conn))};
192 [ # # ]: 0 : if (it != m_tracker.end()) RemoveConnectionInternal(it);
193 : 0 : }
194 : 0 : size_t CountActiveConnections() const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
195 : : {
196 [ # # ]: 0 : return WITH_LOCK(m_mutex, return m_tracker.size());
197 : : }
198 : : //! Wait until there are no more connections with active requests in the tracker
199 : 0 : void WaitUntilEmpty() const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
200 : : {
201 : 0 : WAIT_LOCK(m_mutex, lock);
202 [ # # # # ]: 0 : m_cv.wait(lock, [this]() EXCLUSIVE_LOCKS_REQUIRED(m_mutex) { return m_tracker.empty(); });
203 : 0 : }
204 : : };
205 : : //! Track active requests
206 : : static HTTPRequestTracker g_requests;
207 : :
208 : : /** Check if a network address is allowed to access the HTTP server */
209 : 0 : static bool ClientAllowed(const CNetAddr& netaddr)
210 : : {
211 [ # # ]: 0 : if (!netaddr.IsValid())
212 : : return false;
213 [ # # ]: 0 : for(const CSubNet& subnet : rpc_allow_subnets)
214 [ # # ]: 0 : if (subnet.Match(netaddr))
215 : : return true;
216 : : return false;
217 : : }
218 : :
219 : : /** Initialize ACL list for HTTP server */
220 : 0 : static bool InitHTTPAllowList()
221 : : {
222 : 0 : rpc_allow_subnets.clear();
223 [ # # # # : 0 : rpc_allow_subnets.emplace_back(LookupHost("127.0.0.1", false).value(), 8); // always allow IPv4 local subnet
# # ]
224 [ # # # # : 0 : rpc_allow_subnets.emplace_back(LookupHost("::1", false).value()); // always allow IPv6 localhost
# # ]
225 [ # # # # ]: 0 : for (const std::string& strAllow : gArgs.GetArgs("-rpcallowip")) {
226 [ # # ]: 0 : const CSubNet subnet{LookupSubNet(strAllow)};
227 [ # # # # ]: 0 : if (!subnet.IsValid()) {
228 [ # # # # ]: 0 : uiInterface.ThreadSafeMessageBox(
229 [ # # # # : 0 : 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),
# # ]
230 : : "", CClientUIInterface::MSG_ERROR);
231 : 0 : return false;
232 : : }
233 [ # # ]: 0 : rpc_allow_subnets.push_back(subnet);
234 : 0 : }
235 : 0 : std::string strAllowed;
236 [ # # ]: 0 : for (const CSubNet& subnet : rpc_allow_subnets)
237 [ # # # # ]: 0 : strAllowed += subnet.ToString() + " ";
238 [ # # # # : 0 : LogDebug(BCLog::HTTP, "Allowing HTTP connections from: %s\n", strAllowed);
# # ]
239 : 0 : return true;
240 : 0 : }
241 : :
242 : : /** HTTP request method as string - use for logging only */
243 : 0 : std::string RequestMethodString(HTTPRequest::RequestMethod m)
244 : : {
245 [ # # # # : 0 : switch (m) {
# # ]
246 : 0 : case HTTPRequest::GET:
247 : 0 : return "GET";
248 : 0 : case HTTPRequest::POST:
249 : 0 : return "POST";
250 : 0 : case HTTPRequest::HEAD:
251 : 0 : return "HEAD";
252 : 0 : case HTTPRequest::PUT:
253 : 0 : return "PUT";
254 : 0 : case HTTPRequest::UNKNOWN:
255 : 0 : return "unknown";
256 : : } // no default case, so the compiler can warn about missing cases
257 : 0 : assert(false);
258 : : }
259 : :
260 : : /** HTTP request callback */
261 : 0 : static void http_request_cb(struct evhttp_request* req, void* arg)
262 : : {
263 : 0 : evhttp_connection* conn{evhttp_request_get_connection(req)};
264 : : // Track active requests
265 : 0 : {
266 : 0 : g_requests.AddRequest(req);
267 : 0 : evhttp_request_set_on_complete_cb(req, [](struct evhttp_request* req, void*) {
268 : : g_requests.RemoveRequest(req);
269 : : }, nullptr);
270 : 0 : evhttp_connection_set_closecb(conn, [](evhttp_connection* conn, void* arg) {
271 : : g_requests.RemoveConnection(conn);
272 : : }, nullptr);
273 : : }
274 : :
275 : : // Disable reading to work around a libevent bug, fixed in 2.1.9
276 : : // See https://github.com/libevent/libevent/commit/5ff8eb26371c4dc56f384b2de35bea2d87814779
277 : : // and https://github.com/bitcoin/bitcoin/pull/11593.
278 [ # # # # ]: 0 : if (event_get_version_number() >= 0x02010600 && event_get_version_number() < 0x02010900) {
279 [ # # ]: 0 : if (conn) {
280 : 0 : bufferevent* bev = evhttp_connection_get_bufferevent(conn);
281 [ # # ]: 0 : if (bev) {
282 : 0 : bufferevent_disable(bev, EV_READ);
283 : : }
284 : : }
285 : : }
286 : 0 : auto hreq{std::make_unique<HTTPRequest>(req, *static_cast<const util::SignalInterrupt*>(arg))};
287 : :
288 : : // Early address-based allow check
289 [ # # # # : 0 : if (!ClientAllowed(hreq->GetPeer())) {
# # ]
290 [ # # # # : 0 : LogDebug(BCLog::HTTP, "HTTP request from %s rejected: Client network is not allowed RPC access\n",
# # # # #
# ]
291 : : hreq->GetPeer().ToStringAddrPort());
292 [ # # ]: 0 : hreq->WriteReply(HTTP_FORBIDDEN);
293 : : return;
294 : : }
295 : :
296 : : // Early reject unknown HTTP methods
297 [ # # # # ]: 0 : if (hreq->GetRequestMethod() == HTTPRequest::UNKNOWN) {
298 [ # # # # : 0 : LogDebug(BCLog::HTTP, "HTTP request from %s rejected: Unknown HTTP request method\n",
# # # # #
# ]
299 : : hreq->GetPeer().ToStringAddrPort());
300 [ # # ]: 0 : hreq->WriteReply(HTTP_BAD_METHOD);
301 : : return;
302 : : }
303 : :
304 [ # # # # : 0 : LogDebug(BCLog::HTTP, "Received a %s request for %s from %s\n",
# # # # #
# # # # #
# # # # #
# ]
305 : : RequestMethodString(hreq->GetRequestMethod()), SanitizeString(hreq->GetURI(), SAFE_CHARS_URI).substr(0, 100), hreq->GetPeer().ToStringAddrPort());
306 : :
307 : : // Find registered handler for prefix
308 [ # # ]: 0 : std::string strURI = hreq->GetURI();
309 [ # # ]: 0 : std::string path;
310 [ # # ]: 0 : LOCK(g_httppathhandlers_mutex);
311 : 0 : std::vector<HTTPPathHandler>::const_iterator i = pathHandlers.begin();
312 : 0 : std::vector<HTTPPathHandler>::const_iterator iend = pathHandlers.end();
313 [ # # ]: 0 : for (; i != iend; ++i) {
314 : 0 : bool match = false;
315 [ # # ]: 0 : if (i->exactMatch)
316 : 0 : match = (strURI == i->prefix);
317 : : else
318 [ # # ]: 0 : match = (strURI.substr(0, i->prefix.size()) == i->prefix);
319 [ # # ]: 0 : if (match) {
320 [ # # ]: 0 : path = strURI.substr(i->prefix.size());
321 : 0 : break;
322 : : }
323 : : }
324 : :
325 : : // Dispatch to worker thread
326 [ # # ]: 0 : if (i != iend) {
327 [ # # # # ]: 0 : std::unique_ptr<HTTPWorkItem> item(new HTTPWorkItem(std::move(hreq), path, i->handler));
328 [ # # ]: 0 : assert(g_work_queue);
329 [ # # # # ]: 0 : if (g_work_queue->Enqueue(item.get())) {
330 : 0 : item.release(); /* if true, queue took ownership */
331 : : } else {
332 [ # # ]: 0 : LogPrintf("WARNING: request rejected because http work queue depth exceeded, it can be increased with the -rpcworkqueue= setting\n");
333 [ # # ]: 0 : item->req->WriteReply(HTTP_SERVICE_UNAVAILABLE, "Work queue depth exceeded");
334 : : }
335 : 0 : } else {
336 [ # # ]: 0 : hreq->WriteReply(HTTP_NOT_FOUND);
337 : : }
338 : 0 : }
339 : :
340 : : /** Callback to reject HTTP requests after shutdown. */
341 : 0 : static void http_reject_request_cb(struct evhttp_request* req, void*)
342 : : {
343 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Rejecting request while shutting down\n");
344 : 0 : evhttp_send_error(req, HTTP_SERVUNAVAIL, nullptr);
345 : 0 : }
346 : :
347 : : /** Event dispatcher thread */
348 : 0 : static void ThreadHTTP(struct event_base* base)
349 : : {
350 [ # # ]: 0 : util::ThreadRename("http");
351 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Entering http event loop\n");
352 : 0 : event_base_dispatch(base);
353 : : // Event loop will be interrupted by InterruptHTTPServer()
354 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Exited http event loop\n");
355 : 0 : }
356 : :
357 : : /** Bind HTTP server to specified addresses */
358 : 0 : static bool HTTPBindAddresses(struct evhttp* http)
359 : : {
360 [ # # ]: 0 : uint16_t http_port{static_cast<uint16_t>(gArgs.GetIntArg("-rpcport", BaseParams().RPCPort()))};
361 : 0 : std::vector<std::pair<std::string, uint16_t>> endpoints;
362 : :
363 : : // Determine what addresses to bind to
364 [ # # # # : 0 : if (!(gArgs.IsArgSet("-rpcallowip") && gArgs.IsArgSet("-rpcbind"))) { // Default to loopback if not allowing external IPs
# # # # #
# # # # #
# # ]
365 [ # # ]: 0 : endpoints.emplace_back("::1", http_port);
366 [ # # ]: 0 : endpoints.emplace_back("127.0.0.1", http_port);
367 [ # # # # : 0 : if (gArgs.IsArgSet("-rpcallowip")) {
# # ]
368 [ # # ]: 0 : LogPrintf("WARNING: option -rpcallowip was specified without -rpcbind; this doesn't usually make sense\n");
369 : : }
370 [ # # # # : 0 : if (gArgs.IsArgSet("-rpcbind")) {
# # ]
371 [ # # ]: 0 : LogPrintf("WARNING: option -rpcbind was ignored because -rpcallowip was not specified, refusing to allow everyone to connect\n");
372 : : }
373 [ # # # # : 0 : } else if (gArgs.IsArgSet("-rpcbind")) { // Specific bind address
# # ]
374 [ # # # # : 0 : for (const std::string& strRPCBind : gArgs.GetArgs("-rpcbind")) {
# # ]
375 : 0 : uint16_t port{http_port};
376 [ # # ]: 0 : std::string host;
377 [ # # ]: 0 : SplitHostPort(strRPCBind, port, host);
378 [ # # ]: 0 : endpoints.emplace_back(host, port);
379 : 0 : }
380 : : }
381 : :
382 : : // Bind addresses
383 [ # # ]: 0 : for (std::vector<std::pair<std::string, uint16_t> >::iterator i = endpoints.begin(); i != endpoints.end(); ++i) {
384 [ # # ]: 0 : LogPrintf("Binding RPC on address %s port %i\n", i->first, i->second);
385 [ # # # # ]: 0 : evhttp_bound_socket *bind_handle = evhttp_bind_socket_with_handle(http, i->first.empty() ? nullptr : i->first.c_str(), i->second);
386 [ # # ]: 0 : if (bind_handle) {
387 [ # # # # ]: 0 : const std::optional<CNetAddr> addr{LookupHost(i->first, false)};
388 [ # # # # : 0 : if (i->first.empty() || (addr.has_value() && addr->IsBindAny())) {
# # # # ]
389 [ # # ]: 0 : LogPrintf("WARNING: the RPC server is not safe to expose to untrusted networks such as the public internet\n");
390 : : }
391 : : // Set the no-delay option (disable Nagle's algorithm) on the TCP socket.
392 [ # # ]: 0 : evutil_socket_t fd = evhttp_bound_socket_get_fd(bind_handle);
393 : 0 : int one = 1;
394 [ # # ]: 0 : if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, (sockopt_arg_type)&one, sizeof(one)) == SOCKET_ERROR) {
395 [ # # ]: 0 : LogInfo("WARNING: Unable to set TCP_NODELAY on RPC server socket, continuing anyway\n");
396 : : }
397 [ # # ]: 0 : boundSockets.push_back(bind_handle);
398 : 0 : } else {
399 [ # # ]: 0 : LogPrintf("Binding RPC on address %s port %i failed.\n", i->first, i->second);
400 : : }
401 : : }
402 : 0 : return !boundSockets.empty();
403 : 0 : }
404 : :
405 : : /** Simple wrapper to set thread name and run work queue */
406 : 0 : static void HTTPWorkQueueRun(WorkQueue<HTTPClosure>* queue, int worker_num)
407 : : {
408 [ # # ]: 0 : util::ThreadRename(strprintf("httpworker.%i", worker_num));
409 : 0 : queue->Run();
410 : 0 : }
411 : :
412 : : /** libevent event log callback */
413 : 0 : static void libevent_log_cb(int severity, const char *msg)
414 : : {
415 : 0 : BCLog::Level level;
416 [ # # # # ]: 0 : switch (severity) {
417 : : case EVENT_LOG_DEBUG:
418 : : level = BCLog::Level::Debug;
419 : : break;
420 : 0 : case EVENT_LOG_MSG:
421 : 0 : level = BCLog::Level::Info;
422 : 0 : break;
423 : 0 : case EVENT_LOG_WARN:
424 : 0 : level = BCLog::Level::Warning;
425 : 0 : break;
426 : 0 : default: // EVENT_LOG_ERR and others are mapped to error
427 : 0 : level = BCLog::Level::Error;
428 : 0 : break;
429 : : }
430 [ # # ]: 0 : LogPrintLevel(BCLog::LIBEVENT, level, "%s\n", msg);
431 : 0 : }
432 : :
433 : 0 : bool InitHTTPServer(const util::SignalInterrupt& interrupt)
434 : : {
435 [ # # ]: 0 : if (!InitHTTPAllowList())
436 : : return false;
437 : :
438 : : // Redirect libevent's logging to our own log
439 : 0 : event_set_log_callback(&libevent_log_cb);
440 : : // Update libevent's log handling.
441 : 0 : UpdateHTTPServerLogging(LogInstance().WillLogCategory(BCLog::LIBEVENT));
442 : :
443 : : #ifdef WIN32
444 : : evthread_use_windows_threads();
445 : : #else
446 : 0 : evthread_use_pthreads();
447 : : #endif
448 : :
449 : 0 : raii_event_base base_ctr = obtain_event_base();
450 : :
451 : : /* Create a new evhttp object to handle requests. */
452 [ # # ]: 0 : raii_evhttp http_ctr = obtain_evhttp(base_ctr.get());
453 [ # # ]: 0 : struct evhttp* http = http_ctr.get();
454 [ # # ]: 0 : if (!http) {
455 [ # # ]: 0 : LogPrintf("couldn't create evhttp. Exiting.\n");
456 : : return false;
457 : : }
458 : :
459 [ # # # # : 0 : evhttp_set_timeout(http, gArgs.GetIntArg("-rpcservertimeout", DEFAULT_HTTP_SERVER_TIMEOUT));
# # ]
460 [ # # ]: 0 : evhttp_set_max_headers_size(http, MAX_HEADERS_SIZE);
461 [ # # ]: 0 : evhttp_set_max_body_size(http, MAX_SIZE);
462 [ # # ]: 0 : evhttp_set_gencb(http, http_request_cb, (void*)&interrupt);
463 : :
464 [ # # # # ]: 0 : if (!HTTPBindAddresses(http)) {
465 [ # # ]: 0 : LogPrintf("Unable to bind any endpoint for RPC server\n");
466 : : return false;
467 : : }
468 : :
469 [ # # # # : 0 : LogDebug(BCLog::HTTP, "Initialized HTTP server\n");
# # ]
470 [ # # # # : 0 : int workQueueDepth = std::max((long)gArgs.GetIntArg("-rpcworkqueue", DEFAULT_HTTP_WORKQUEUE), 1L);
# # ]
471 [ # # # # : 0 : LogDebug(BCLog::HTTP, "creating work queue of depth %d\n", workQueueDepth);
# # ]
472 : :
473 [ # # ]: 0 : g_work_queue = std::make_unique<WorkQueue<HTTPClosure>>(workQueueDepth);
474 : : // transfer ownership to eventBase/HTTP via .release()
475 : 0 : eventBase = base_ctr.release();
476 : 0 : eventHTTP = http_ctr.release();
477 : 0 : return true;
478 [ # # ]: 0 : }
479 : :
480 : 0 : void UpdateHTTPServerLogging(bool enable) {
481 [ # # ]: 0 : if (enable) {
482 : 0 : event_enable_debug_logging(EVENT_DBG_ALL);
483 : : } else {
484 : 0 : event_enable_debug_logging(EVENT_DBG_NONE);
485 : : }
486 : 0 : }
487 : :
488 : : static std::thread g_thread_http;
489 : : static std::vector<std::thread> g_thread_http_workers;
490 : :
491 : 0 : void StartHTTPServer()
492 : : {
493 [ # # # # ]: 0 : int rpcThreads = std::max((long)gArgs.GetIntArg("-rpcthreads", DEFAULT_HTTP_THREADS), 1L);
494 : 0 : LogInfo("Starting HTTP server with %d worker threads\n", rpcThreads);
495 : 0 : g_thread_http = std::thread(ThreadHTTP, eventBase);
496 : :
497 [ # # ]: 0 : for (int i = 0; i < rpcThreads; i++) {
498 : 0 : g_thread_http_workers.emplace_back(HTTPWorkQueueRun, g_work_queue.get(), i);
499 : : }
500 : 0 : }
501 : :
502 : 0 : void InterruptHTTPServer()
503 : : {
504 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Interrupting HTTP server\n");
505 [ # # ]: 0 : if (eventHTTP) {
506 : : // Reject requests on current connections
507 : 0 : evhttp_set_gencb(eventHTTP, http_reject_request_cb, nullptr);
508 : : }
509 [ # # ]: 0 : if (g_work_queue) {
510 : 0 : g_work_queue->Interrupt();
511 : : }
512 : 0 : }
513 : :
514 : 0 : void StopHTTPServer()
515 : : {
516 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Stopping HTTP server\n");
517 [ # # ]: 0 : if (g_work_queue) {
518 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Waiting for HTTP worker threads to exit\n");
519 [ # # ]: 0 : for (auto& thread : g_thread_http_workers) {
520 : 0 : thread.join();
521 : : }
522 : 0 : g_thread_http_workers.clear();
523 : : }
524 : : // Unlisten sockets, these are what make the event loop running, which means
525 : : // that after this and all connections are closed the event loop will quit.
526 [ # # ]: 0 : for (evhttp_bound_socket *socket : boundSockets) {
527 : 0 : evhttp_del_accept_socket(eventHTTP, socket);
528 : : }
529 [ # # ]: 0 : boundSockets.clear();
530 : 0 : {
531 [ # # ]: 0 : if (const auto n_connections{g_requests.CountActiveConnections()}; n_connections != 0) {
532 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Waiting for %d connections to stop HTTP server\n", n_connections);
533 : : }
534 : 0 : g_requests.WaitUntilEmpty();
535 : : }
536 [ # # ]: 0 : if (eventHTTP) {
537 : : // Schedule a callback to call evhttp_free in the event base thread, so
538 : : // that evhttp_free does not need to be called again after the handling
539 : : // of unfinished request connections that follows.
540 : 0 : event_base_once(eventBase, -1, EV_TIMEOUT, [](evutil_socket_t, short, void*) {
541 : : evhttp_free(eventHTTP);
542 : : eventHTTP = nullptr;
543 : : }, nullptr, nullptr);
544 : : }
545 [ # # ]: 0 : if (eventBase) {
546 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Waiting for HTTP event thread to exit\n");
547 [ # # ]: 0 : if (g_thread_http.joinable()) g_thread_http.join();
548 : 0 : event_base_free(eventBase);
549 : 0 : eventBase = nullptr;
550 : : }
551 [ # # ]: 0 : g_work_queue.reset();
552 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Stopped HTTP server\n");
553 : 0 : }
554 : :
555 : 0 : struct event_base* EventBase()
556 : : {
557 : 0 : return eventBase;
558 : : }
559 : :
560 : 0 : static void httpevent_callback_fn(evutil_socket_t, short, void* data)
561 : : {
562 : : // Static handler: simply call inner handler
563 : 0 : HTTPEvent *self = static_cast<HTTPEvent*>(data);
564 : 0 : self->handler();
565 [ # # ]: 0 : if (self->deleteWhenTriggered)
566 : 0 : delete self;
567 : 0 : }
568 : :
569 : 0 : HTTPEvent::HTTPEvent(struct event_base* base, bool _deleteWhenTriggered, const std::function<void()>& _handler):
570 : 0 : deleteWhenTriggered(_deleteWhenTriggered), handler(_handler)
571 : : {
572 [ # # ]: 0 : ev = event_new(base, -1, 0, httpevent_callback_fn, this);
573 [ # # ]: 0 : assert(ev);
574 : 0 : }
575 : 0 : HTTPEvent::~HTTPEvent()
576 : : {
577 : 0 : event_free(ev);
578 : 0 : }
579 : 0 : void HTTPEvent::trigger(struct timeval* tv)
580 : : {
581 [ # # ]: 0 : if (tv == nullptr)
582 : 0 : event_active(ev, 0, 0); // immediately trigger event in main thread
583 : : else
584 : 0 : evtimer_add(ev, tv); // trigger after timeval passed
585 : 0 : }
586 : 0 : HTTPRequest::HTTPRequest(struct evhttp_request* _req, const util::SignalInterrupt& interrupt, bool _replySent)
587 : 0 : : req(_req), m_interrupt(interrupt), replySent(_replySent)
588 : : {
589 : 0 : }
590 : :
591 : 0 : HTTPRequest::~HTTPRequest()
592 : : {
593 [ # # ]: 0 : if (!replySent) {
594 : : // Keep track of whether reply was sent to avoid request leaks
595 : 0 : LogPrintf("%s: Unhandled request\n", __func__);
596 : 0 : WriteReply(HTTP_INTERNAL_SERVER_ERROR, "Unhandled request");
597 : : }
598 : : // evhttpd cleans up the request, as long as a reply was sent.
599 : 0 : }
600 : :
601 : 0 : std::pair<bool, std::string> HTTPRequest::GetHeader(const std::string& hdr) const
602 : : {
603 : 0 : const struct evkeyvalq* headers = evhttp_request_get_input_headers(req);
604 [ # # ]: 0 : assert(headers);
605 : 0 : const char* val = evhttp_find_header(headers, hdr.c_str());
606 [ # # ]: 0 : if (val)
607 : 0 : return std::make_pair(true, val);
608 : : else
609 : 0 : return std::make_pair(false, "");
610 : : }
611 : :
612 : 0 : std::string HTTPRequest::ReadBody()
613 : : {
614 : 0 : struct evbuffer* buf = evhttp_request_get_input_buffer(req);
615 [ # # ]: 0 : if (!buf)
616 : 0 : return "";
617 : 0 : size_t size = evbuffer_get_length(buf);
618 : : /** Trivial implementation: if this is ever a performance bottleneck,
619 : : * internal copying can be avoided in multi-segment buffers by using
620 : : * evbuffer_peek and an awkward loop. Though in that case, it'd be even
621 : : * better to not copy into an intermediate string but use a stream
622 : : * abstraction to consume the evbuffer on the fly in the parsing algorithm.
623 : : */
624 : 0 : const char* data = (const char*)evbuffer_pullup(buf, size);
625 [ # # ]: 0 : if (!data) // returns nullptr in case of empty buffer
626 : 0 : return "";
627 : 0 : std::string rv(data, size);
628 [ # # ]: 0 : evbuffer_drain(buf, size);
629 : 0 : return rv;
630 : 0 : }
631 : :
632 : 0 : void HTTPRequest::WriteHeader(const std::string& hdr, const std::string& value)
633 : : {
634 : 0 : struct evkeyvalq* headers = evhttp_request_get_output_headers(req);
635 [ # # ]: 0 : assert(headers);
636 : 0 : evhttp_add_header(headers, hdr.c_str(), value.c_str());
637 : 0 : }
638 : :
639 : : /** Closure sent to main thread to request a reply to be sent to
640 : : * a HTTP request.
641 : : * Replies must be sent in the main loop in the main http thread,
642 : : * this cannot be done from worker threads.
643 : : */
644 : 0 : void HTTPRequest::WriteReply(int nStatus, std::span<const std::byte> reply)
645 : : {
646 [ # # # # ]: 0 : assert(!replySent && req);
647 [ # # ]: 0 : if (m_interrupt) {
648 [ # # # # ]: 0 : WriteHeader("Connection", "close");
649 : : }
650 : : // Send event to main http thread to send reply message
651 : 0 : struct evbuffer* evb = evhttp_request_get_output_buffer(req);
652 [ # # ]: 0 : assert(evb);
653 : 0 : evbuffer_add(evb, reply.data(), reply.size());
654 : 0 : auto req_copy = req;
655 [ # # ]: 0 : HTTPEvent* ev = new HTTPEvent(eventBase, true, [req_copy, nStatus]{
656 : 0 : evhttp_send_reply(req_copy, nStatus, nullptr, nullptr);
657 : : // Re-enable reading from the socket. This is the second part of the libevent
658 : : // workaround above.
659 [ # # # # ]: 0 : if (event_get_version_number() >= 0x02010600 && event_get_version_number() < 0x02010900) {
660 : 0 : evhttp_connection* conn = evhttp_request_get_connection(req_copy);
661 [ # # ]: 0 : if (conn) {
662 : 0 : bufferevent* bev = evhttp_connection_get_bufferevent(conn);
663 [ # # ]: 0 : if (bev) {
664 : 0 : bufferevent_enable(bev, EV_READ | EV_WRITE);
665 : : }
666 : : }
667 : : }
668 [ # # ]: 0 : });
669 : 0 : ev->trigger(nullptr);
670 : 0 : replySent = true;
671 : 0 : req = nullptr; // transferred back to main thread
672 : 0 : }
673 : :
674 : 0 : CService HTTPRequest::GetPeer() const
675 : : {
676 : 0 : evhttp_connection* con = evhttp_request_get_connection(req);
677 : 0 : CService peer;
678 [ # # ]: 0 : if (con) {
679 : : // evhttp retains ownership over returned address string
680 : 0 : const char* address = "";
681 : 0 : uint16_t port = 0;
682 : :
683 : : #ifdef HAVE_EVHTTP_CONNECTION_GET_PEER_CONST_CHAR
684 : : evhttp_connection_get_peer(con, &address, &port);
685 : : #else
686 [ # # ]: 0 : evhttp_connection_get_peer(con, (char**)&address, &port);
687 : : #endif // HAVE_EVHTTP_CONNECTION_GET_PEER_CONST_CHAR
688 : :
689 [ # # # # : 0 : peer = MaybeFlipIPv6toCJDNS(LookupNumeric(address, port));
# # # # ]
690 : : }
691 : 0 : return peer;
692 : 0 : }
693 : :
694 : 0 : std::string HTTPRequest::GetURI() const
695 : : {
696 : 0 : return evhttp_request_get_uri(req);
697 : : }
698 : :
699 : 0 : HTTPRequest::RequestMethod HTTPRequest::GetRequestMethod() const
700 : : {
701 [ # # # # : 0 : switch (evhttp_request_get_command(req)) {
# ]
702 : : case EVHTTP_REQ_GET:
703 : : return GET;
704 : 0 : case EVHTTP_REQ_POST:
705 : 0 : return POST;
706 : 0 : case EVHTTP_REQ_HEAD:
707 : 0 : return HEAD;
708 : 0 : case EVHTTP_REQ_PUT:
709 : 0 : return PUT;
710 : 0 : default:
711 : 0 : return UNKNOWN;
712 : : }
713 : : }
714 : :
715 : 0 : std::optional<std::string> HTTPRequest::GetQueryParameter(const std::string& key) const
716 : : {
717 : 0 : const char* uri{evhttp_request_get_uri(req)};
718 : :
719 : 0 : return GetQueryParameterFromUri(uri, key);
720 : : }
721 : :
722 : 0 : std::optional<std::string> GetQueryParameterFromUri(const char* uri, const std::string& key)
723 : : {
724 : 0 : evhttp_uri* uri_parsed{evhttp_uri_parse(uri)};
725 [ # # ]: 0 : if (!uri_parsed) {
726 [ # # ]: 0 : throw std::runtime_error("URI parsing failed, it likely contained RFC 3986 invalid characters");
727 : : }
728 : 0 : const char* query{evhttp_uri_get_query(uri_parsed)};
729 : 0 : std::optional<std::string> result;
730 : :
731 [ # # ]: 0 : if (query) {
732 : : // Parse the query string into a key-value queue and iterate over it
733 : 0 : struct evkeyvalq params_q;
734 [ # # ]: 0 : evhttp_parse_query_str(query, ¶ms_q);
735 : :
736 [ # # ]: 0 : for (struct evkeyval* param{params_q.tqh_first}; param != nullptr; param = param->next.tqe_next) {
737 [ # # ]: 0 : if (param->key == key) {
738 [ # # ]: 0 : result = param->value;
739 : : break;
740 : : }
741 : : }
742 [ # # ]: 0 : evhttp_clear_headers(¶ms_q);
743 : : }
744 [ # # ]: 0 : evhttp_uri_free(uri_parsed);
745 : :
746 : 0 : return result;
747 : 0 : }
748 : :
749 : 0 : void RegisterHTTPHandler(const std::string &prefix, bool exactMatch, const HTTPRequestHandler &handler)
750 : : {
751 [ # # ]: 0 : LogDebug(BCLog::HTTP, "Registering HTTP handler for %s (exactmatch %d)\n", prefix, exactMatch);
752 : 0 : LOCK(g_httppathhandlers_mutex);
753 [ # # ]: 0 : pathHandlers.emplace_back(prefix, exactMatch, handler);
754 : 0 : }
755 : :
756 : 0 : void UnregisterHTTPHandler(const std::string &prefix, bool exactMatch)
757 : : {
758 : 0 : LOCK(g_httppathhandlers_mutex);
759 : 0 : std::vector<HTTPPathHandler>::iterator i = pathHandlers.begin();
760 : 0 : std::vector<HTTPPathHandler>::iterator iend = pathHandlers.end();
761 [ # # ]: 0 : for (; i != iend; ++i)
762 [ # # # # ]: 0 : if (i->prefix == prefix && i->exactMatch == exactMatch)
763 : : break;
764 [ # # ]: 0 : if (i != iend)
765 : : {
766 [ # # # # : 0 : LogDebug(BCLog::HTTP, "Unregistering HTTP handler for %s (exactmatch %d)\n", prefix, exactMatch);
# # ]
767 : 0 : pathHandlers.erase(i);
768 : : }
769 : 0 : }
|
