 |
Bitcoin Core
21.99.0
P2P Digital Currency
|
Go to the documentation of this file.
25 #include <sys/types.h>
28 #include <event2/thread.h>
29 #include <event2/buffer.h>
30 #include <event2/bufferevent.h>
31 #include <event2/util.h>
32 #include <event2/keyvalq_struct.h>
52 std::unique_ptr<HTTPRequest>
req;
62 template <
typename WorkItem>
68 std::condition_variable
cond;
69 std::deque<std::unique_ptr<WorkItem>>
queue;
90 queue.emplace_back(std::unique_ptr<WorkItem>(item));
98 std::unique_ptr<WorkItem> i;
105 i = std::move(
queue.front());
133 static struct event_base*
eventBase =
nullptr;
152 if (subnet.Match(netaddr))
167 for (
const std::string& strAllow :
gArgs.
GetArgs(
"-rpcallowip")) {
172 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),
178 std::string strAllowed;
180 strAllowed += subnet.ToString() +
" ";
210 if (event_get_version_number() >= 0x02010600 && event_get_version_number() < 0x02020001) {
211 evhttp_connection* conn = evhttp_request_get_connection(req);
213 bufferevent* bev = evhttp_connection_get_bufferevent(conn);
215 bufferevent_disable(bev, EV_READ);
219 std::unique_ptr<HTTPRequest> hreq(
new HTTPRequest(req));
223 LogPrint(
BCLog::HTTP,
"HTTP request from %s rejected: Client network is not allowed RPC access\n",
224 hreq->GetPeer().ToString());
232 hreq->GetPeer().ToString());
241 std::string strURI = hreq->GetURI();
243 std::vector<HTTPPathHandler>::const_iterator i =
pathHandlers.begin();
244 std::vector<HTTPPathHandler>::const_iterator iend =
pathHandlers.end();
245 for (; i != iend; ++i) {
248 match = (strURI == i->prefix);
250 match = (strURI.substr(0, i->prefix.size()) == i->prefix);
252 path = strURI.substr(i->prefix.size());
259 std::unique_ptr<HTTPWorkItem> item(
new HTTPWorkItem(std::move(hreq), path, i->handler));
264 LogPrintf(
"WARNING: request rejected because http work queue depth exceeded, it can be increased with the -rpcworkqueue= setting\n");
276 evhttp_send_error(req, HTTP_SERVUNAVAIL,
nullptr);
284 event_base_dispatch(base);
287 return event_base_got_break(base) == 0;
294 std::vector<std::pair<std::string, uint16_t>> endpoints;
298 endpoints.push_back(std::make_pair(
"::1", http_port));
299 endpoints.push_back(std::make_pair(
"127.0.0.1", http_port));
301 LogPrintf(
"WARNING: option -rpcallowip was specified without -rpcbind; this doesn't usually make sense\n");
304 LogPrintf(
"WARNING: option -rpcbind was ignored because -rpcallowip was not specified, refusing to allow everyone to connect\n");
307 for (
const std::string& strRPCBind :
gArgs.
GetArgs(
"-rpcbind")) {
308 uint16_t port{http_port};
311 endpoints.push_back(std::make_pair(host, port));
316 for (std::vector<std::pair<std::string, uint16_t> >::iterator i = endpoints.begin(); i != endpoints.end(); ++i) {
318 evhttp_bound_socket *bind_handle = evhttp_bind_socket_with_handle(http, i->first.empty() ?
nullptr : i->first.c_str(), i->second);
322 LogPrintf(
"WARNING: the RPC server is not safe to expose to untrusted networks such as the public internet\n");
326 LogPrintf(
"Binding RPC on address %s port %i failed.\n", i->first, i->second);
342 #ifndef EVENT_LOG_WARN
344 # define EVENT_LOG_WARN _EVENT_LOG_WARN
367 evthread_use_windows_threads();
369 evthread_use_pthreads();
376 struct evhttp* http = http_ctr.get();
378 LogPrintf(
"couldn't create evhttp. Exiting.\n");
384 evhttp_set_max_body_size(http,
MAX_SIZE);
388 LogPrintf(
"Unable to bind any endpoint for RPC server\n");
394 LogPrintf(
"HTTP: creating work queue of depth %d\n", workQueueDepth);
404 #if LIBEVENT_VERSION_NUMBER >= 0x02010100
406 event_enable_debug_logging(EVENT_DBG_ALL);
408 event_enable_debug_logging(EVENT_DBG_NONE);
424 LogPrintf(
"HTTP: starting %d worker threads\n", rpcThreads);
427 for (
int i = 0; i < rpcThreads; i++) {
458 evhttp_del_accept_socket(
eventHTTP, socket);
486 if (self->deleteWhenTriggered)
490 HTTPEvent::HTTPEvent(
struct event_base* base,
bool _deleteWhenTriggered,
const std::function<
void()>& _handler):
491 deleteWhenTriggered(_deleteWhenTriggered),
handler(_handler)
503 event_active(
ev, 0, 0);
515 LogPrintf(
"%s: Unhandled request\n", __func__);
523 const struct evkeyvalq* headers = evhttp_request_get_input_headers(
req);
525 const char* val = evhttp_find_header(headers, hdr.c_str());
527 return std::make_pair(
true, val);
529 return std::make_pair(
false,
"");
534 struct evbuffer* buf = evhttp_request_get_input_buffer(
req);
537 size_t size = evbuffer_get_length(buf);
544 const char* data = (
const char*)evbuffer_pullup(buf, size);
547 std::string rv(data, size);
548 evbuffer_drain(buf, size);
554 struct evkeyvalq* headers = evhttp_request_get_output_headers(
req);
556 evhttp_add_header(headers, hdr.c_str(), value.c_str());
571 struct evbuffer* evb = evhttp_request_get_output_buffer(
req);
573 evbuffer_add(evb, strReply.data(), strReply.size());
576 evhttp_send_reply(req_copy, nStatus,
nullptr,
nullptr);
579 if (event_get_version_number() >= 0x02010600 && event_get_version_number() < 0x02020001) {
580 evhttp_connection* conn = evhttp_request_get_connection(req_copy);
582 bufferevent* bev = evhttp_connection_get_bufferevent(conn);
584 bufferevent_enable(bev, EV_READ | EV_WRITE);
596 evhttp_connection* con = evhttp_request_get_connection(
req);
600 const char* address =
"";
602 evhttp_connection_get_peer(con, (
char**)&address, &port);
610 return evhttp_request_get_uri(
req);
615 switch (evhttp_request_get_command(
req)) {
619 case EVHTTP_REQ_POST:
622 case EVHTTP_REQ_HEAD:
642 std::vector<HTTPPathHandler>::iterator i =
pathHandlers.begin();
643 std::vector<HTTPPathHandler>::iterator iend =
pathHandlers.end();
644 for (; i != iend; ++i)
645 if (i->prefix ==
prefix && i->exactMatch == exactMatch)
bool ShutdownRequested()
Returns true if a shutdown is requested, false otherwise.
A combination of a network address (CNetAddr) and a (TCP) port.
RequestMethod GetRequestMethod() const
Get request method.
bool LookupHost(const std::string &name, std::vector< CNetAddr > &vIP, unsigned int nMaxSolutions, bool fAllowLookup, DNSLookupFn dns_lookup_function)
Resolve a host string to its corresponding network addresses.
@ HTTP_SERVICE_UNAVAILABLE
bool LookupSubNet(const std::string &strSubnet, CSubNet &ret, DNSLookupFn dns_lookup_function)
Parse and resolve a specified subnet string into the appropriate internal representation.
void UnregisterHTTPHandler(const std::string &prefix, bool exactMatch)
Unregister handler for prefix.
static bool ClientAllowed(const CNetAddr &netaddr)
Check if a network address is allowed to access the HTTP server.
static const int DEFAULT_HTTP_WORKQUEUE
CClientUIInterface uiInterface
static void HTTPWorkQueueRun(WorkQueue< HTTPClosure > *queue, int worker_num)
Simple wrapper to set thread name and run work queue.
static WorkQueue< HTTPClosure > * workQueue
Work queue for handling longer requests off the event loop thread.
bool(* handler)(const std::any &context, HTTPRequest *req, const std::string &strReq)
HTTPPathHandler(std::string _prefix, bool _exactMatch, HTTPRequestHandler _handler)
struct event_base * EventBase()
Return evhttp event base.
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
CService GetPeer() const
Get CService (address:ip) for the origin of the http request.
bool Enqueue(WorkItem *item)
Enqueue a work item.
void WriteHeader(const std::string &hdr, const std::string &value)
Write output header.
void StartHTTPServer()
Start HTTP server.
std::string GetURI() const
Get requested URI.
std::pair< bool, std::string > GetHeader(const std::string &hdr) const
Get the request header specified by hdr, or an empty string.
std::unique_ptr< HTTPRequest > req
HTTPEvent(struct event_base *base, bool deleteWhenTriggered, const std::function< void()> &handler)
Create a new event.
std::deque< std::unique_ptr< WorkItem > > queue
Mutex cs
Mutex protects entire object.
static const size_t MAX_HEADERS_SIZE
Maximum size of http request (request line + headers)
static void http_request_cb(struct evhttp_request *req, void *arg)
HTTP request callback.
Simple work queue for distributing work over multiple threads.
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...
static struct evhttp * eventHTTP
HTTP server.
void SplitHostPort(std::string in, uint16_t &portOut, std::string &hostOut)
void operator()() override
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
HTTPWorkItem(std::unique_ptr< HTTPRequest > _req, const std::string &_path, const HTTPRequestHandler &_func)
bool UpdateHTTPServerLogging(bool enable)
Change logging level for libevent.
static struct event_base * eventBase
HTTP module state.
static std::vector< std::thread > g_thread_http_workers
void ThreadRename(std::string &&)
Rename a thread both in terms of an internal (in-memory) name as well as its system thread name.
std::string ReadBody()
Read request body.
HTTPRequest(struct evhttp_request *req, bool replySent=false)
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
static std::vector< evhttp_bound_socket * > boundSockets
Bound listening sockets.
void Run()
Thread function.
std::condition_variable cond
@ SAFE_CHARS_URI
Chars allowed in URIs (RFC 3986)
#define LogPrint(category,...)
struct evhttp_request * req
std::string SanitizeString(const std::string &str, int rule)
Remove unsafe chars.
static std::vector< HTTPPathHandler > pathHandlers
Handlers for (sub)paths.
raii_event_base obtain_event_base()
static void libevent_log_cb(int severity, const char *msg)
libevent event log callback
void trigger(struct timeval *tv)
Trigger the event.
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
void InterruptHTTPServer()
Interrupt HTTP server threads.
static bool InitHTTPAllowList()
Initialize ACL list for HTTP server.
std::function< bool(HTTPRequest *req, const std::string &)> HTTPRequestHandler
Handler for requests to a certain HTTP path.
static void httpevent_callback_fn(evutil_socket_t, short, void *data)
static std::vector< CSubNet > rpc_allow_subnets
List of subnets to allow RPC connections from.
BCLog::Logger & LogInstance()
WorkQueue(size_t _maxDepth)
static bool HTTPBindAddresses(struct evhttp *http)
Bind HTTP server to specified addresses.
std::string RequestMethodString(HTTPRequest::RequestMethod m)
HTTP request method as string - use for logging only.
void Interrupt()
Interrupt and exit loops.
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.
static void http_reject_request_cb(struct evhttp_request *req, void *)
Callback to reject HTTP requests after shutdown.
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
static bool ThreadHTTP(struct event_base *base)
Event dispatcher thread.
void DisableCategory(LogFlags flag)
void StopHTTPServer()
Stop HTTP server.
void RegisterHTTPHandler(const std::string &prefix, bool exactMatch, const HTTPRequestHandler &handler)
Register handler for prefix.
static std::thread g_thread_http
void WriteReply(int nStatus, const std::string &strReply="")
Write HTTP reply.
assert(std::addressof(::ChainstateActive().CoinsTip())==std::addressof(coins_cache))
static const int DEFAULT_HTTP_THREADS
~WorkQueue()
Precondition: worker threads have all stopped (they have been joined).
#define WAIT_LOCK(cs, name)
HTTPRequestHandler handler
bool InitHTTPServer()
Initialize HTTP server.
static const int DEFAULT_HTTP_SERVER_TIMEOUT
std::function< void()> handler
raii_evhttp obtain_evhttp(struct event_base *base)
@ HTTP_INTERNAL_SERVER_ERROR