Bitcoin Core  31.0.0
P2P Digital Currency
httpserver.cpp
Go to the documentation of this file.
1 // Copyright (c) 2015-present 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 <httpserver.h>
6 
7 #include <chainparamsbase.h>
8 #include <common/args.h>
9 #include <common/messages.h>
10 #include <compat/compat.h>
11 #include <logging.h>
12 #include <netbase.h>
13 #include <node/interface_ui.h>
14 #include <rpc/protocol.h>
15 #include <sync.h>
16 #include <util/check.h>
17 #include <util/signalinterrupt.h>
18 #include <util/strencodings.h>
19 #include <util/threadnames.h>
20 #include <util/threadpool.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 <thread>
32 #include <unordered_map>
33 #include <vector>
34 
35 #include <sys/types.h>
36 #include <sys/stat.h>
37 
38 #include <event2/buffer.h>
39 #include <event2/bufferevent.h>
40 #include <event2/http.h>
41 #include <event2/http_struct.h>
42 #include <event2/keyvalq_struct.h>
43 #include <event2/thread.h>
44 #include <event2/util.h>
45 
46 #include <support/events.h>
47 
49 
51 static const size_t MAX_HEADERS_SIZE = 8192;
52 
54 {
55  HTTPPathHandler(std::string _prefix, bool _exactMatch, HTTPRequestHandler _handler):
56  prefix(_prefix), exactMatch(_exactMatch), handler(_handler)
57  {
58  }
59  std::string prefix;
60  bool exactMatch;
62 };
63 
66 static struct event_base* eventBase = nullptr;
69 static struct evhttp* eventHTTP = nullptr;
71 static std::vector<CSubNet> rpc_allow_subnets;
74 static std::vector<HTTPPathHandler> pathHandlers GUARDED_BY(g_httppathhandlers_mutex);
76 static std::vector<evhttp_bound_socket *> boundSockets;
78 static ThreadPool g_threadpool_http("http");
79 static int g_max_queue_depth{100};
80 
86 {
87 private:
88  mutable Mutex m_mutex;
89  mutable std::condition_variable m_cv;
91  std::unordered_map<const evhttp_connection*, size_t> m_tracker GUARDED_BY(m_mutex);
92 
93  void RemoveConnectionInternal(const decltype(m_tracker)::iterator it) EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
94  {
95  m_tracker.erase(it);
96  if (m_tracker.empty()) m_cv.notify_all();
97  }
98 public:
100  void AddRequest(evhttp_request* req) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
101  {
102  const evhttp_connection* conn{Assert(evhttp_request_get_connection(Assert(req)))};
103  WITH_LOCK(m_mutex, ++m_tracker[conn]);
104  }
106  void RemoveRequest(evhttp_request* req) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
107  {
108  const evhttp_connection* conn{Assert(evhttp_request_get_connection(Assert(req)))};
109  LOCK(m_mutex);
110  auto it{m_tracker.find(conn)};
111  if (it != m_tracker.end() && it->second > 0) {
112  if (--(it->second) == 0) RemoveConnectionInternal(it);
113  }
114  }
116  void RemoveConnection(const evhttp_connection* conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
117  {
118  LOCK(m_mutex);
119  auto it{m_tracker.find(Assert(conn))};
120  if (it != m_tracker.end()) RemoveConnectionInternal(it);
121  }
123  {
124  return WITH_LOCK(m_mutex, return m_tracker.size());
125  }
128  {
129  WAIT_LOCK(m_mutex, lock);
130  m_cv.wait(lock, [this]() EXCLUSIVE_LOCKS_REQUIRED(m_mutex) { return m_tracker.empty(); });
131  }
132 };
135 
137 static bool ClientAllowed(const CNetAddr& netaddr)
138 {
139  if (!netaddr.IsValid())
140  return false;
141  for(const CSubNet& subnet : rpc_allow_subnets)
142  if (subnet.Match(netaddr))
143  return true;
144  return false;
145 }
146 
148 static bool InitHTTPAllowList()
149 {
150  rpc_allow_subnets.clear();
151  rpc_allow_subnets.emplace_back(LookupHost("127.0.0.1", false).value(), 8); // always allow IPv4 local subnet
152  rpc_allow_subnets.emplace_back(LookupHost("::1", false).value()); // always allow IPv6 localhost
153  for (const std::string& strAllow : gArgs.GetArgs("-rpcallowip")) {
154  const CSubNet subnet{LookupSubNet(strAllow)};
155  if (!subnet.IsValid()) {
156  uiInterface.ThreadSafeMessageBox(
157  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)),
159  return false;
160  }
161  rpc_allow_subnets.push_back(subnet);
162  }
163  std::string strAllowed;
164  for (const CSubNet& subnet : rpc_allow_subnets)
165  strAllowed += subnet.ToString() + " ";
166  LogDebug(BCLog::HTTP, "Allowing HTTP connections from: %s\n", strAllowed);
167  return true;
168 }
169 
172 {
173  switch (m) {
174  case HTTPRequest::GET:
175  return "GET";
176  case HTTPRequest::POST:
177  return "POST";
178  case HTTPRequest::HEAD:
179  return "HEAD";
180  case HTTPRequest::PUT:
181  return "PUT";
183  return "unknown";
184  } // no default case, so the compiler can warn about missing cases
185  assert(false);
186 }
187 
189 static void http_request_cb(struct evhttp_request* req, void* arg)
190 {
191  evhttp_connection* conn{evhttp_request_get_connection(req)};
192  // Track active requests
193  {
194  g_requests.AddRequest(req);
195  evhttp_request_set_on_complete_cb(req, [](struct evhttp_request* req, void*) {
197  }, nullptr);
198  evhttp_connection_set_closecb(conn, [](evhttp_connection* conn, void* arg) {
200  }, nullptr);
201  }
202 
203  // Disable reading to work around a libevent bug, fixed in 2.1.9
204  // See https://github.com/libevent/libevent/commit/5ff8eb26371c4dc56f384b2de35bea2d87814779
205  // and https://github.com/bitcoin/bitcoin/pull/11593.
206  if (event_get_version_number() >= 0x02010600 && event_get_version_number() < 0x02010900) {
207  if (conn) {
208  bufferevent* bev = evhttp_connection_get_bufferevent(conn);
209  if (bev) {
210  bufferevent_disable(bev, EV_READ);
211  }
212  }
213  }
214  auto hreq{std::make_shared<HTTPRequest>(req, *static_cast<const util::SignalInterrupt*>(arg))};
215 
216  // Early address-based allow check
217  if (!ClientAllowed(hreq->GetPeer())) {
218  LogDebug(BCLog::HTTP, "HTTP request from %s rejected: Client network is not allowed RPC access\n",
219  hreq->GetPeer().ToStringAddrPort());
220  hreq->WriteReply(HTTP_FORBIDDEN);
221  return;
222  }
223 
224  // Early reject unknown HTTP methods
225  if (hreq->GetRequestMethod() == HTTPRequest::UNKNOWN) {
226  LogDebug(BCLog::HTTP, "HTTP request from %s rejected: Unknown HTTP request method\n",
227  hreq->GetPeer().ToStringAddrPort());
228  hreq->WriteReply(HTTP_BAD_METHOD);
229  return;
230  }
231 
232  LogDebug(BCLog::HTTP, "Received a %s request for %s from %s\n",
233  RequestMethodString(hreq->GetRequestMethod()), SanitizeString(hreq->GetURI(), SAFE_CHARS_URI).substr(0, 100), hreq->GetPeer().ToStringAddrPort());
234 
235  // Find registered handler for prefix
236  std::string strURI = hreq->GetURI();
237  std::string path;
239  std::vector<HTTPPathHandler>::const_iterator i = pathHandlers.begin();
240  std::vector<HTTPPathHandler>::const_iterator iend = pathHandlers.end();
241  for (; i != iend; ++i) {
242  bool match = false;
243  if (i->exactMatch)
244  match = (strURI == i->prefix);
245  else
246  match = strURI.starts_with(i->prefix);
247  if (match) {
248  path = strURI.substr(i->prefix.size());
249  break;
250  }
251  }
252 
253  // Dispatch to worker thread
254  if (i != iend) {
255  if (static_cast<int>(g_threadpool_http.WorkQueueSize()) >= g_max_queue_depth) {
256  LogWarning("Request rejected because http work queue depth exceeded, it can be increased with the -rpcworkqueue= setting");
257  hreq->WriteReply(HTTP_SERVICE_UNAVAILABLE, "Work queue depth exceeded");
258  return;
259  }
260 
261  auto item = [req = hreq, in_path = std::move(path), fn = i->handler]() {
262  std::string err_msg;
263  try {
264  fn(req.get(), in_path);
265  return;
266  } catch (const std::exception& e) {
267  LogWarning("Unexpected error while processing request for '%s'. Error msg: '%s'", req->GetURI(), e.what());
268  err_msg = e.what();
269  } catch (...) {
270  LogWarning("Unknown error while processing request for '%s'", req->GetURI());
271  err_msg = "unknown error";
272  }
273  // Reply so the client doesn't hang waiting for the response.
274  req->WriteHeader("Connection", "close");
275  // TODO: Implement specific error formatting for the REST and JSON-RPC servers responses.
276  req->WriteReply(HTTP_INTERNAL_SERVER_ERROR, err_msg);
277  };
278 
279  if (auto res = g_threadpool_http.Submit(std::move(item)); !res.has_value()) {
280  Assume(hreq.use_count() == 1); // ensure request will be deleted
281  // Both SubmitError::Inactive and SubmitError::Interrupted mean shutdown
282  LogWarning("HTTP request rejected during server shutdown: '%s'", SubmitErrorString(res.error()));
283  hreq->WriteReply(HTTP_SERVICE_UNAVAILABLE, "Request rejected during server shutdown");
284  return;
285  }
286  } else {
287  hreq->WriteReply(HTTP_NOT_FOUND);
288  }
289 }
290 
292 static void http_reject_request_cb(struct evhttp_request* req, void*)
293 {
294  LogDebug(BCLog::HTTP, "Rejecting request while shutting down\n");
295  evhttp_send_error(req, HTTP_SERVUNAVAIL, nullptr);
296 }
297 
299 static void ThreadHTTP(struct event_base* base)
300 {
301  util::ThreadRename("http");
302  LogDebug(BCLog::HTTP, "Entering http event loop\n");
303  event_base_dispatch(base);
304  // Event loop will be interrupted by InterruptHTTPServer()
305  LogDebug(BCLog::HTTP, "Exited http event loop\n");
306 }
307 
309 static bool HTTPBindAddresses(struct evhttp* http)
310 {
311  uint16_t http_port{static_cast<uint16_t>(gArgs.GetIntArg("-rpcport", BaseParams().RPCPort()))};
312  std::vector<std::pair<std::string, uint16_t>> endpoints;
313 
314  // Determine what addresses to bind to
315  // To prevent misconfiguration and accidental exposure of the RPC
316  // interface, require -rpcallowip and -rpcbind to both be specified
317  // together. If either is missing, ignore both values, bind to localhost
318  // instead, and log warnings.
319  if (gArgs.GetArgs("-rpcallowip").empty() || gArgs.GetArgs("-rpcbind").empty()) { // Default to loopback if not allowing external IPs
320  endpoints.emplace_back("::1", http_port);
321  endpoints.emplace_back("127.0.0.1", http_port);
322  if (!gArgs.GetArgs("-rpcallowip").empty()) {
323  LogWarning("Option -rpcallowip was specified without -rpcbind; this doesn't usually make sense");
324  }
325  if (!gArgs.GetArgs("-rpcbind").empty()) {
326  LogWarning("Option -rpcbind was ignored because -rpcallowip was not specified, refusing to allow everyone to connect");
327  }
328  } else { // Specific bind addresses
329  for (const std::string& strRPCBind : gArgs.GetArgs("-rpcbind")) {
330  uint16_t port{http_port};
331  std::string host;
332  if (!SplitHostPort(strRPCBind, port, host)) {
333  LogError("%s\n", InvalidPortErrMsg("-rpcbind", strRPCBind).original);
334  return false;
335  }
336  endpoints.emplace_back(host, port);
337  }
338  }
339 
340  // Bind addresses
341  for (std::vector<std::pair<std::string, uint16_t> >::iterator i = endpoints.begin(); i != endpoints.end(); ++i) {
342  LogInfo("Binding RPC on address %s port %i", i->first, i->second);
343  evhttp_bound_socket *bind_handle = evhttp_bind_socket_with_handle(http, i->first.empty() ? nullptr : i->first.c_str(), i->second);
344  if (bind_handle) {
345  const std::optional<CNetAddr> addr{LookupHost(i->first, false)};
346  if (i->first.empty() || (addr.has_value() && addr->IsBindAny())) {
347  LogWarning("The RPC server is not safe to expose to untrusted networks such as the public internet");
348  }
349  // Set the no-delay option (disable Nagle's algorithm) on the TCP socket.
350  evutil_socket_t fd = evhttp_bound_socket_get_fd(bind_handle);
351  int one = 1;
352  if (setsockopt(fd, IPPROTO_TCP, TCP_NODELAY, reinterpret_cast<char*>(&one), sizeof(one)) == SOCKET_ERROR) {
353  LogInfo("WARNING: Unable to set TCP_NODELAY on RPC server socket, continuing anyway\n");
354  }
355  boundSockets.push_back(bind_handle);
356  } else {
357  LogWarning("Binding RPC on address %s port %i failed.", i->first, i->second);
358  }
359  }
360  return !boundSockets.empty();
361 }
362 
364 static void libevent_log_cb(int severity, const char *msg)
365 {
366  switch (severity) {
367  case EVENT_LOG_DEBUG:
368  LogDebug(BCLog::LIBEVENT, "%s", msg);
369  break;
370  case EVENT_LOG_MSG:
371  LogInfo("libevent: %s", msg);
372  break;
373  case EVENT_LOG_WARN:
374  LogWarning("libevent: %s", msg);
375  break;
376  default: // EVENT_LOG_ERR and others are mapped to error
377  LogError("libevent: %s", msg);
378  break;
379  }
380 }
381 
382 bool InitHTTPServer(const util::SignalInterrupt& interrupt)
383 {
384  if (!InitHTTPAllowList())
385  return false;
386 
387  // Redirect libevent's logging to our own log
388  event_set_log_callback(&libevent_log_cb);
389  // Update libevent's log handling.
391 
392 #ifdef WIN32
393  evthread_use_windows_threads();
394 #else
395  evthread_use_pthreads();
396 #endif
397 
398  raii_event_base base_ctr = obtain_event_base();
399 
400  /* Create a new evhttp object to handle requests. */
401  raii_evhttp http_ctr = obtain_evhttp(base_ctr.get());
402  struct evhttp* http = http_ctr.get();
403  if (!http) {
404  LogError("Couldn't create evhttp. Exiting.");
405  return false;
406  }
407 
408  evhttp_set_timeout(http, gArgs.GetIntArg("-rpcservertimeout", DEFAULT_HTTP_SERVER_TIMEOUT));
409  evhttp_set_max_headers_size(http, MAX_HEADERS_SIZE);
410  evhttp_set_max_body_size(http, MAX_SIZE);
411  evhttp_set_gencb(http, http_request_cb, (void*)&interrupt);
412 
413  if (!HTTPBindAddresses(http)) {
414  LogError("Unable to bind any endpoint for RPC server");
415  return false;
416  }
417 
418  LogDebug(BCLog::HTTP, "Initialized HTTP server\n");
419  g_max_queue_depth = std::max(gArgs.GetArg("-rpcworkqueue", DEFAULT_HTTP_WORKQUEUE), 1);
420  LogDebug(BCLog::HTTP, "set work queue of depth %d", g_max_queue_depth);
421 
422  // transfer ownership to eventBase/HTTP via .release()
423  eventBase = base_ctr.release();
424  eventHTTP = http_ctr.release();
425  return true;
426 }
427 
428 void UpdateHTTPServerLogging(bool enable) {
429  if (enable) {
430  event_enable_debug_logging(EVENT_DBG_ALL);
431  } else {
432  event_enable_debug_logging(EVENT_DBG_NONE);
433  }
434 }
435 
436 static std::thread g_thread_http;
437 
439 {
440  int rpcThreads = std::max(gArgs.GetArg("-rpcthreads", DEFAULT_HTTP_THREADS), 1);
441  LogInfo("Starting HTTP server with %d worker threads", rpcThreads);
442  g_threadpool_http.Start(rpcThreads);
443  g_thread_http = std::thread(ThreadHTTP, eventBase);
444 }
445 
447 {
448  LogDebug(BCLog::HTTP, "Interrupting HTTP server\n");
449  if (eventHTTP) {
450  // Reject requests on current connections
451  evhttp_set_gencb(eventHTTP, http_reject_request_cb, nullptr);
452  }
453  // Interrupt pool after disabling requests
455 }
456 
458 {
459  LogDebug(BCLog::HTTP, "Stopping HTTP server\n");
460 
461  LogDebug(BCLog::HTTP, "Waiting for HTTP worker threads to exit\n");
463 
464  // Unlisten sockets, these are what make the event loop running, which means
465  // that after this and all connections are closed the event loop will quit.
466  for (evhttp_bound_socket *socket : boundSockets) {
467  evhttp_del_accept_socket(eventHTTP, socket);
468  }
469  boundSockets.clear();
470  {
471  if (const auto n_connections{g_requests.CountActiveConnections()}; n_connections != 0) {
472  LogDebug(BCLog::HTTP, "Waiting for %d connections to stop HTTP server\n", n_connections);
473  }
475  }
476  if (eventHTTP) {
477  // Schedule a callback to call evhttp_free in the event base thread, so
478  // that evhttp_free does not need to be called again after the handling
479  // of unfinished request connections that follows.
480  event_base_once(eventBase, -1, EV_TIMEOUT, [](evutil_socket_t, short, void*) {
481  evhttp_free(eventHTTP);
482  eventHTTP = nullptr;
483  }, nullptr, nullptr);
484  }
485  if (eventBase) {
486  LogDebug(BCLog::HTTP, "Waiting for HTTP event thread to exit\n");
487  if (g_thread_http.joinable()) g_thread_http.join();
488  event_base_free(eventBase);
489  eventBase = nullptr;
490  }
491  LogDebug(BCLog::HTTP, "Stopped HTTP server\n");
492 }
493 
494 struct event_base* EventBase()
495 {
496  return eventBase;
497 }
498 
499 static void httpevent_callback_fn(evutil_socket_t, short, void* data)
500 {
501  // Static handler: simply call inner handler
502  HTTPEvent *self = static_cast<HTTPEvent*>(data);
503  self->handler();
504  if (self->deleteWhenTriggered)
505  delete self;
506 }
507 
508 HTTPEvent::HTTPEvent(struct event_base* base, bool _deleteWhenTriggered, const std::function<void()>& _handler):
509  deleteWhenTriggered(_deleteWhenTriggered), handler(_handler)
510 {
511  ev = event_new(base, -1, 0, httpevent_callback_fn, this);
512  assert(ev);
513 }
515 {
516  event_free(ev);
517 }
518 void HTTPEvent::trigger(struct timeval* tv)
519 {
520  if (tv == nullptr)
521  event_active(ev, 0, 0); // immediately trigger event in main thread
522  else
523  evtimer_add(ev, tv); // trigger after timeval passed
524 }
525 HTTPRequest::HTTPRequest(struct evhttp_request* _req, const util::SignalInterrupt& interrupt, bool _replySent)
526  : req(_req), m_interrupt(interrupt), replySent(_replySent)
527 {
528 }
529 
531 {
532  if (!replySent) {
533  // Keep track of whether reply was sent to avoid request leaks
534  LogWarning("Unhandled HTTP request");
535  WriteReply(HTTP_INTERNAL_SERVER_ERROR, "Unhandled request");
536  }
537  // evhttpd cleans up the request, as long as a reply was sent.
538 }
539 
540 std::pair<bool, std::string> HTTPRequest::GetHeader(const std::string& hdr) const
541 {
542  const struct evkeyvalq* headers = evhttp_request_get_input_headers(req);
543  assert(headers);
544  const char* val = evhttp_find_header(headers, hdr.c_str());
545  if (val)
546  return std::make_pair(true, val);
547  else
548  return std::make_pair(false, "");
549 }
550 
552 {
553  struct evbuffer* buf = evhttp_request_get_input_buffer(req);
554  if (!buf)
555  return "";
556  size_t size = evbuffer_get_length(buf);
563  const char* data = (const char*)evbuffer_pullup(buf, size);
564  if (!data) // returns nullptr in case of empty buffer
565  return "";
566  std::string rv(data, size);
567  evbuffer_drain(buf, size);
568  return rv;
569 }
570 
571 void HTTPRequest::WriteHeader(const std::string& hdr, const std::string& value)
572 {
573  struct evkeyvalq* headers = evhttp_request_get_output_headers(req);
574  assert(headers);
575  evhttp_add_header(headers, hdr.c_str(), value.c_str());
576 }
577 
583 void HTTPRequest::WriteReply(int nStatus, std::span<const std::byte> reply)
584 {
585  assert(!replySent && req);
586  if (m_interrupt) {
587  WriteHeader("Connection", "close");
588  }
589  // Send event to main http thread to send reply message
590  struct evbuffer* evb = evhttp_request_get_output_buffer(req);
591  assert(evb);
592  evbuffer_add(evb, reply.data(), reply.size());
593  auto req_copy = req;
594  HTTPEvent* ev = new HTTPEvent(eventBase, true, [req_copy, nStatus]{
595  evhttp_send_reply(req_copy, nStatus, nullptr, nullptr);
596  // Re-enable reading from the socket. This is the second part of the libevent
597  // workaround above.
598  if (event_get_version_number() >= 0x02010600 && event_get_version_number() < 0x02010900) {
599  evhttp_connection* conn = evhttp_request_get_connection(req_copy);
600  if (conn) {
601  bufferevent* bev = evhttp_connection_get_bufferevent(conn);
602  if (bev) {
603  bufferevent_enable(bev, EV_READ | EV_WRITE);
604  }
605  }
606  }
607  });
608  ev->trigger(nullptr);
609  replySent = true;
610  req = nullptr; // transferred back to main thread
611 }
612 
614 {
615  evhttp_connection* con = evhttp_request_get_connection(req);
616  CService peer;
617  if (con) {
618  // evhttp retains ownership over returned address string
619  const char* address = "";
620  uint16_t port = 0;
621 
622 #ifdef HAVE_EVHTTP_CONNECTION_GET_PEER_CONST_CHAR
623  evhttp_connection_get_peer(con, &address, &port);
624 #else
625  evhttp_connection_get_peer(con, (char**)&address, &port);
626 #endif // HAVE_EVHTTP_CONNECTION_GET_PEER_CONST_CHAR
627 
628  peer = MaybeFlipIPv6toCJDNS(LookupNumeric(address, port));
629  }
630  return peer;
631 }
632 
633 std::string HTTPRequest::GetURI() const
634 {
635  return evhttp_request_get_uri(req);
636 }
637 
639 {
640  switch (evhttp_request_get_command(req)) {
641  case EVHTTP_REQ_GET:
642  return GET;
643  case EVHTTP_REQ_POST:
644  return POST;
645  case EVHTTP_REQ_HEAD:
646  return HEAD;
647  case EVHTTP_REQ_PUT:
648  return PUT;
649  default:
650  return UNKNOWN;
651  }
652 }
653 
654 std::optional<std::string> HTTPRequest::GetQueryParameter(const std::string& key) const
655 {
656  const char* uri{evhttp_request_get_uri(req)};
657 
658  return GetQueryParameterFromUri(uri, key);
659 }
660 
661 std::optional<std::string> GetQueryParameterFromUri(const char* uri, const std::string& key)
662 {
663  evhttp_uri* uri_parsed{evhttp_uri_parse(uri)};
664  if (!uri_parsed) {
665  throw std::runtime_error("URI parsing failed, it likely contained RFC 3986 invalid characters");
666  }
667  const char* query{evhttp_uri_get_query(uri_parsed)};
668  std::optional<std::string> result;
669 
670  if (query) {
671  // Parse the query string into a key-value queue and iterate over it
672  struct evkeyvalq params_q;
673  evhttp_parse_query_str(query, &params_q);
674 
675  for (struct evkeyval* param{params_q.tqh_first}; param != nullptr; param = param->next.tqe_next) {
676  if (param->key == key) {
677  result = param->value;
678  break;
679  }
680  }
681  evhttp_clear_headers(&params_q);
682  }
683  evhttp_uri_free(uri_parsed);
684 
685  return result;
686 }
687 
688 void RegisterHTTPHandler(const std::string &prefix, bool exactMatch, const HTTPRequestHandler &handler)
689 {
690  LogDebug(BCLog::HTTP, "Registering HTTP handler for %s (exactmatch %d)\n", prefix, exactMatch);
692  pathHandlers.emplace_back(prefix, exactMatch, handler);
693 }
694 
695 void UnregisterHTTPHandler(const std::string &prefix, bool exactMatch)
696 {
698  std::vector<HTTPPathHandler>::iterator i = pathHandlers.begin();
699  std::vector<HTTPPathHandler>::iterator iend = pathHandlers.end();
700  for (; i != iend; ++i)
701  if (i->prefix == prefix && i->exactMatch == exactMatch)
702  break;
703  if (i != iend)
704  {
705  LogDebug(BCLog::HTTP, "Unregistering HTTP handler for %s (exactmatch %d)\n", prefix, exactMatch);
706  pathHandlers.erase(i);
707  }
708 }
HTTPRequest(struct evhttp_request *req, const util::SignalInterrupt &interrupt, bool replySent=false)
Definition: httpserver.cpp:525
static HTTPRequestTracker g_requests
Track active requests.
Definition: httpserver.cpp:134
raii_event_base obtain_event_base()
Definition: events.h:30
bool InitHTTPServer(const util::SignalInterrupt &interrupt)
Initialize HTTP server.
Definition: httpserver.cpp:382
BCLog::Logger & LogInstance()
Definition: logging.cpp:26
static std::vector< evhttp_bound_socket * > boundSockets
Bound listening sockets.
Definition: httpserver.cpp:76
std::unordered_map< const evhttp_connection *, size_t > m_tracker GUARDED_BY(m_mutex)
For each connection, keep a counter of how many requests are open.
CClientUIInterface uiInterface
assert(!tx.IsCoinBase())
void WriteReply(int nStatus, std::string_view reply="")
Write HTTP reply.
Definition: httpserver.h:141
static const int DEFAULT_HTTP_SERVER_TIMEOUT
Definition: httpserver.h:28
#define LogWarning(...)
Definition: log.h:96
bool SplitHostPort(std::string_view in, uint16_t &portOut, std::string &hostOut)
Splits socket address string into host string and port value.
raii_evhttp obtain_evhttp(struct event_base *base)
Definition: events.h:41
is a home for simple string functions returning descriptive messages that are used in RPC and GUI int...
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
static const int DEFAULT_HTTP_WORKQUEUE
The default value for -rpcworkqueue.
Definition: httpserver.h:26
Helps keep track of open evhttp_connections with active evhttp_requests
Definition: httpserver.cpp:85
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:82
Event class.
Definition: httpserver.h:164
const char * prefix
Definition: rest.cpp:1141
size_t CountActiveConnections() const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: httpserver.cpp:122
static ThreadPool g_threadpool_http("http")
Http thread pool - future: encapsulate in HttpContext.
static void httpevent_callback_fn(evutil_socket_t, short, void *data)
Definition: httpserver.cpp:499
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
static std::vector< CSubNet > rpc_allow_subnets
List of subnets to allow RPC connections from.
Definition: httpserver.cpp:71
std::optional< std::string > GetQueryParameter(const std::string &key) const
Get the query parameter value from request uri for a specified key, or std::nullopt if the key is not...
Definition: httpserver.cpp:654
void RemoveRequest(evhttp_request *req) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Decrease request counter for the associated connection by 1, remove connection if counter is 0...
Definition: httpserver.cpp:106
static void libevent_log_cb(int severity, const char *msg)
libevent event log callback
Definition: httpserver.cpp:364
CService MaybeFlipIPv6toCJDNS(const CService &service)
If an IPv6 address belongs to the address range used by the CJDNS network and the CJDNS network is re...
Definition: netbase.cpp:942
void RemoveConnection(const evhttp_connection *conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Remove a connection entirely.
Definition: httpserver.cpp:116
struct evhttp_request * req
Definition: httpserver.h:73
CService LookupNumeric(const std::string &name, uint16_t portDefault, DNSLookupFn dns_lookup_function)
Resolve a service string with a numeric IP to its first corresponding service.
Definition: netbase.cpp:216
static bool InitHTTPAllowList()
Initialize ACL list for HTTP server.
Definition: httpserver.cpp:148
void InterruptHTTPServer()
Interrupt HTTP server threads.
Definition: httpserver.cpp:446
bool(* handler)(const std::any &context, HTTPRequest *req, const std::string &strReq)
Definition: rest.cpp:1142
void ThreadRename(const std::string &)
Rename a thread both in terms of an internal (in-memory) name as well as its system thread name...
Definition: threadnames.cpp:55
void AddRequest(evhttp_request *req) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Increase request counter for the associated connection by 1.
Definition: httpserver.cpp:100
struct event * ev
Definition: httpserver.h:182
static bool HTTPBindAddresses(struct evhttp *http)
Bind HTTP server to specified addresses.
Definition: httpserver.cpp:309
void RegisterHTTPHandler(const std::string &prefix, bool exactMatch, const HTTPRequestHandler &handler)
Register handler for prefix.
Definition: httpserver.cpp:688
bool IsValid() const
Definition: netaddress.cpp:424
std::string RequestMethodString(HTTPRequest::RequestMethod m)
HTTP request method as string - use for logging only.
Definition: httpserver.cpp:171
Fixed-size thread pool for running arbitrary tasks concurrently.
Definition: threadpool.h:46
std::string SanitizeString(std::string_view str, int rule)
Remove unsafe chars.
HTTPPathHandler(std::string _prefix, bool _exactMatch, HTTPRequestHandler _handler)
Definition: httpserver.cpp:55
void WaitUntilEmpty() const EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Wait until there are no more connections with active requests in the tracker.
Definition: httpserver.cpp:127
static void http_reject_request_cb(struct evhttp_request *req, void *)
Callback to reject HTTP requests after shutdown.
Definition: httpserver.cpp:292
#define SOCKET_ERROR
Definition: compat.h:68
static int g_max_queue_depth
Definition: httpserver.cpp:79
static std::thread g_thread_http
Definition: httpserver.cpp:436
void StopHTTPServer()
Stop HTTP server.
Definition: httpserver.cpp:457
std::vector< CNetAddr > LookupHost(const std::string &name, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function)
Resolve a host string to its corresponding network addresses.
Definition: netbase.cpp:173
#define LOCK(cs)
Definition: sync.h:258
HTTPEvent(struct event_base *base, bool deleteWhenTriggered, const std::function< void()> &handler)
Create a new event.
Definition: httpserver.cpp:508
#define LogInfo(...)
Definition: log.h:95
RequestMethod GetRequestMethod() const
Get request method.
Definition: httpserver.cpp:638
constexpr std::string_view SubmitErrorString(const ThreadPool::SubmitError err) noexcept
Definition: threadpool.h:235
static std::vector< HTTPPathHandler > pathHandlers GUARDED_BY(g_httppathhandlers_mutex)
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:529
static void ThreadHTTP(struct event_base *base)
Event dispatcher thread.
Definition: httpserver.cpp:299
void Start(int num_workers) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Start worker threads.
Definition: threadpool.h:104
void UnregisterHTTPHandler(const std::string &prefix, bool exactMatch)
Unregister handler for prefix.
Definition: httpserver.cpp:695
void UpdateHTTPServerLogging(bool enable)
Change logging level for libevent.
Definition: httpserver.cpp:428
#define WAIT_LOCK(cs, name)
Definition: sync.h:264
void RemoveConnectionInternal(const decltype(m_tracker)::iterator it) EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Definition: httpserver.cpp:93
const util::SignalInterrupt & m_interrupt
Definition: httpserver.h:74
static GlobalMutex g_httppathhandlers_mutex
Handlers for (sub)paths.
Definition: httpserver.cpp:73
#define WITH_LOCK(cs, code)
Run code while locking a mutex.
Definition: sync.h:289
#define Assume(val)
Assume is the identity function.
Definition: check.h:125
struct event_base * EventBase()
Return evhttp event base.
Definition: httpserver.cpp:494
ArgsManager gArgs
Definition: args.cpp:40
static bool ClientAllowed(const CNetAddr &netaddr)
Check if a network address is allowed to access the HTTP server.
Definition: httpserver.cpp:137
Helper class that manages an interrupt flag, and allows a thread or signal to interrupt another threa...
Network address.
Definition: netaddress.h:112
#define LogDebug(category,...)
Definition: log.h:115
void Interrupt() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Stop accepting new tasks and begin asynchronous shutdown.
Definition: threadpool.h:218
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:51
util::Expected< std::future< std::invoke_result_t< F > >, SubmitError > Submit(F &&fn) noexcept EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Enqueues a new task for asynchronous execution.
Definition: threadpool.h:174
auto result
Definition: common-types.h:74
std::string prefix
Definition: httpserver.cpp:59
void WriteHeader(const std::string &hdr, const std::string &value)
Write output header.
Definition: httpserver.cpp:571
void trigger(struct timeval *tv)
Trigger the event.
Definition: httpserver.cpp:518
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Definition: args.h:306
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:461
void Stop() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Stop all worker threads and wait for them to exit.
Definition: threadpool.h:127
std::pair< bool, std::string > GetHeader(const std::string &hdr) const
Get the request header specified by hdr, or an empty string.
Definition: httpserver.cpp:540
std::function< void()> handler
Definition: httpserver.h:180
std::condition_variable m_cv
Definition: httpserver.cpp:89
static constexpr uint64_t MAX_SIZE
The maximum size of a serialized object in bytes or number of elements (for eg vectors) when the size...
Definition: serialize.h:32
std::optional< std::string > GetQueryParameterFromUri(const char *uri, const std::string &key)
Get the query parameter value from request uri for a specified key, or std::nullopt if the key is not...
Definition: httpserver.cpp:661
std::function< bool(HTTPRequest *req, const std::string &)> HTTPRequestHandler
Handler for requests to a certain HTTP path.
Definition: httpserver.h:53
static const size_t MAX_HEADERS_SIZE
Maximum size of http request (request line + headers)
Definition: httpserver.cpp:51
static void http_request_cb(struct evhttp_request *req, void *arg)
HTTP request callback.
Definition: httpserver.cpp:189
CService GetPeer() const
Get CService (address:ip) for the origin of the http request.
Definition: httpserver.cpp:613
size_t WorkQueueSize() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Definition: threadpool.h:224
std::string ReadBody()
Read request body.
Definition: httpserver.cpp:551
void StartHTTPServer()
Start HTTP server.
Definition: httpserver.cpp:438
bilingual_str InvalidPortErrMsg(const std::string &optname, const std::string &invalid_value)
Definition: messages.cpp:156
Different type to mark Mutex at global scope.
Definition: sync.h:134
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
Definition: args.cpp:366
HTTPRequestHandler handler
Definition: httpserver.cpp:61
Chars allowed in URIs (RFC 3986)
Definition: strencodings.h:36
bool replySent
Definition: httpserver.h:75
static struct evhttp * eventHTTP
HTTP server.
Definition: httpserver.cpp:69
static const int DEFAULT_HTTP_THREADS
The default value for -rpcthreads.
Definition: httpserver.h:20
std::string GetURI() const
Get requested URI.
Definition: httpserver.cpp:633
CSubNet LookupSubNet(const std::string &subnet_str)
Parse and resolve a specified subnet string into the appropriate internal representation.
Definition: netbase.cpp:812
#define Assert(val)
Identity function.
Definition: check.h:113
#define LogError(...)
Definition: log.h:97
static struct event_base * eventBase
HTTP module state.
Definition: httpserver.cpp:67