READ THE CODE

Inside Bitcoin

The code behind the network, with room to understand it.

Stable release v32.1bitcoin/bitcoin · f0de87f04062 ↗3,020 source files · 47.5 MB stored on the server340 file guides

Release published 2026-10-28 · Snapshot fetched 2026-11-01. Latest stable release at fetch time; development branches and Git history are excluded. Only the selected code window and visible folders load here.

57,277 bytes · SHA-256 9d692896a72b887a… · View upstream ↗

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 <bitcoin-build-config.h> // IWYU pragma: keep
6
7#include <httpserver.h>
8
9#include <chainparamsbase.h>
10#include <common/args.h>
11#include <common/messages.h>
12#include <common/url.h>
13#include <compat/compat.h>
14#include <logging.h>
15#include <netbase.h>
16#include <node/interface_ui.h>
17#include <rpc/protocol.h>
18#include <span.h>
19#include <sync.h>
20#include <util/check.h>
21#include <util/signalinterrupt.h>
22#include <util/sock.h>
23#include <util/strencodings.h>
24#include <util/thread.h>
25#include <util/threadnames.h>
26#include <util/threadpool.h>
27#include <util/time.h>
28#include <util/translation.h>
29
30#include <condition_variable>
31#include <cstdio>
32#include <cstdlib>
33#include <memory>
34#include <optional>
35#include <span>
36#include <string>
37#include <string_view>
38#include <thread>
39#include <unordered_map>
40#include <vector>
41
42#include <sys/types.h>
43#include <sys/stat.h>
44
45//! The set of sockets cannot be modified while waiting, so
46//! the sleep time needs to be small to avoid new sockets stalling.
47static constexpr auto SELECT_TIMEOUT{50ms};
48
49//! Explicit alias for setting socket option methods.
50static constexpr int SOCKET_OPTION_TRUE{1};
51
52using common::InvalidPortErrMsg;
53using util::LineReader;
54using namespace bitcoin_http;
55
56struct HTTPPathHandler
57{
58    HTTPPathHandler(std::string _prefix, bool _exactMatch, HTTPRequestHandler _handler):
59        prefix(_prefix), exactMatch(_exactMatch), handler(_handler)
60    {
61    }
62    std::string prefix;
63    bool exactMatch;
64    HTTPRequestHandler handler;
65};
66
67/** HTTP module state */
68
69static std::unique_ptr<HTTPServer> g_http_server{nullptr};
70//! Handlers for (sub)paths
71static GlobalMutex g_httppathhandlers_mutex;
72static std::vector<HTTPPathHandler> pathHandlers GUARDED_BY(g_httppathhandlers_mutex);
73/// \anchor http_pool
74//! Http thread pool - future: encapsulate in HttpContext
75static ThreadPool g_threadpool_http("http");
76static int g_max_queue_depth{100};
77
78/** Check if a network address is allowed to access the HTTP server */
79bool HTTPServer::ClientAllowed(const CNetAddr& netaddr) const
80{
81    if (!netaddr.IsValid())
82        return false;
83    for(const CSubNet& subnet : m_allow_subnets)
84        if (subnet.Match(netaddr))
85            return true;
86    return false;
87}
88
89/** Initialize ACL list for HTTP server */
90bool HTTPServer::InitHTTPAllowList()
91{
92    // Must be run before StartSocketThreads() because ThreadSocketHandler()
93    // will check m_allow_subnets from the I/O thread.
94    Assume(!m_thread_socket_handler.joinable());
95
96    m_allow_subnets.clear();
97    m_allow_subnets.emplace_back(LookupHost("127.0.0.1", false).value(), 8);  // always allow IPv4 local subnet
98    m_allow_subnets.emplace_back(LookupHost("::1", false).value());  // always allow IPv6 localhost
99    for (const std::string& strAllow : gArgs.GetArgs("-rpcallowip")) {
100        const CSubNet subnet{LookupSubNet(strAllow)};
101        if (!subnet.IsValid()) {
102            uiInterface.ThreadSafeMessageBox(
103                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)),
104                CClientUIInterface::MSG_ERROR);
105            return false;
106        }
107        m_allow_subnets.push_back(subnet);
108    }
109    std::string strAllowed;
110    for (const CSubNet& subnet : m_allow_subnets)
111        strAllowed += subnet.ToString() + " ";
112    LogDebug(BCLog::HTTP, "Allowing HTTP connections from: %s\n", strAllowed);
113    return true;
114}
115
116/** HTTP request method as string - use for logging only */
117std::string_view RequestMethodString(HTTPRequestMethod m)
118{
119    switch (m) {
120    using enum HTTPRequestMethod;
121    case GET: return "GET";
122    case POST: return "POST";
123    case HEAD: return "HEAD";
124    case PUT: return "PUT";
125    case UNKNOWN: return "unknown";
126    } // no default case, so the compiler can warn about missing cases
127    assert(false);
128}
129
130static void WriteNoStoreErrorReply(HTTPRequest& req, HTTPStatusCode status, std::string_view reply = {})
131{
132    req.WriteHeader("Cache-Control", "no-store");
133    req.WriteReply(status, reply);
134}
135
136static void MaybeDispatchRequestToWorker(std::shared_ptr<HTTPRequest> hreq)
137{
138    // Early reject unknown HTTP methods
139    if (hreq->GetRequestMethod() == HTTPRequestMethod::UNKNOWN) {
140        LogDebug(BCLog::HTTP, "HTTP request from %s rejected: Unknown HTTP request method\n",
141                 hreq->GetPeer().ToStringAddrPort());
142        WriteNoStoreErrorReply(*hreq, HTTP_BAD_METHOD);
143        return;
144    }
145
146    // Find registered handler for prefix
147    std::string strURI = hreq->GetURI();
148    std::string path;
149    LOCK(g_httppathhandlers_mutex);
150    std::vector<HTTPPathHandler>::const_iterator i = pathHandlers.begin();
151    std::vector<HTTPPathHandler>::const_iterator iend = pathHandlers.end();
152    for (; i != iend; ++i) {
153        bool match = false;
154        if (i->exactMatch)
155            match = (strURI == i->prefix);
156        else
157            match = strURI.starts_with(i->prefix);
158        if (match) {
159            path = strURI.substr(i->prefix.size());
160            break;
161        }
162    }
163
164    // Dispatch to worker thread
165    if (i != iend) {
166        if (static_cast<int>(g_threadpool_http.WorkQueueSize()) >= g_max_queue_depth) {
167            LogWarning("Request rejected because http work queue depth exceeded, it can be increased with the -rpcworkqueue= setting");
168            WriteNoStoreErrorReply(*hreq, HTTP_SERVICE_UNAVAILABLE, "Work queue depth exceeded");
169            return;
170        }
171
172        auto item = [req = hreq, in_path = std::move(path), fn = i->handler]() {
173            std::string err_msg;
174            try {
175                fn(req.get(), in_path);
176                return;
177            } catch (const std::exception& e) {
178                LogWarning("Unexpected error while processing request for '%s'. Error msg: '%s'", req->GetURI(), e.what());
179                err_msg = e.what();
180            } catch (...) {
181                LogWarning("Unknown error while processing request for '%s'", req->GetURI());
182                err_msg = "unknown error";
183            }
184            // Reply so the client doesn't hang waiting for the response.
185            req->WriteHeader("Connection", "close");
186            // TODO: Implement specific error formatting for the REST and JSON-RPC servers responses.
187            WriteNoStoreErrorReply(*req, HTTP_INTERNAL_SERVER_ERROR, err_msg);
188        };
189
190        if (auto res = g_threadpool_http.Submit(std::move(item)); !res.has_value()) {
191            Assume(hreq.use_count() == 1); // ensure request will be deleted
192            // Both SubmitError::Inactive and SubmitError::Interrupted mean shutdown
193            LogWarning("HTTP request rejected during server shutdown: '%s'", SubmitErrorString(res.error()));
194            WriteNoStoreErrorReply(*hreq, HTTP_SERVICE_UNAVAILABLE, "Request rejected during server shutdown");
195            return;
196        }
197    } else {
198        WriteNoStoreErrorReply(*hreq, HTTP_NOT_FOUND);
199    }
200}
201
202static void RejectRequest(std::unique_ptr<HTTPRequest> hreq)
203{
204    LogDebug(BCLog::HTTP, "Rejecting request while shutting down");
205    WriteNoStoreErrorReply(*hreq, HTTP_SERVICE_UNAVAILABLE);
206}
207
208static std::vector<std::pair<std::string, uint16_t>> GetBindAddresses()
209{
210    uint16_t http_port{static_cast<uint16_t>(gArgs.GetIntArg("-rpcport", BaseParams().RPCPort()))};
211    std::vector<std::pair<std::string, uint16_t>> endpoints;
212
213    // Determine what addresses to bind to
214    // To prevent misconfiguration and accidental exposure of the RPC
215    // interface, require -rpcallowip and -rpcbind to both be specified
216    // together. If either is missing, ignore both values, bind to localhost
217    // instead, and log warnings.
218    if (gArgs.GetArgs("-rpcallowip").empty() || gArgs.GetArgs("-rpcbind").empty()) { // Default to loopback if not allowing external IPs
219        endpoints.emplace_back("::1", http_port);
220        endpoints.emplace_back("127.0.0.1", http_port);
221        if (!gArgs.GetArgs("-rpcallowip").empty()) {
222            LogWarning("Option -rpcallowip was specified without -rpcbind; this doesn't usually make sense");
223        }
224        if (!gArgs.GetArgs("-rpcbind").empty()) {
225            LogWarning("Option -rpcbind was ignored because -rpcallowip was not specified, refusing to allow everyone to connect");
226        }
227    } else { // Specific bind addresses
228        for (const std::string& strRPCBind : gArgs.GetArgs("-rpcbind")) {
229            uint16_t port{http_port};
230            std::string host;
231            if (!SplitHostPort(strRPCBind, port, host)) {
232                LogError("%s\n", InvalidPortErrMsg("-rpcbind", strRPCBind).original);
233                return {}; // empty
234            }
235            endpoints.emplace_back(host, port);
236        }
237    }
238    return endpoints;
239}
240
241void RegisterHTTPHandler(const std::string &prefix, bool exactMatch, const HTTPRequestHandler &handler)
242{
243    LogDebug(BCLog::HTTP, "Registering HTTP handler for %s (exactmatch %d)\n", prefix, exactMatch);
244    LOCK(g_httppathhandlers_mutex);
245    pathHandlers.emplace_back(prefix, exactMatch, handler);
246}
247
248void UnregisterHTTPHandler(const std::string &prefix, bool exactMatch)
249{
250    LOCK(g_httppathhandlers_mutex);

src/wallet/receive.cpp

src/wallet/coinselection.cpp

src/consensus/validation.h

src/primitives/transaction.cpp

src/script/descriptor.cpp

src/bitcoin-cli.cpp

src/rpc/blockchain.cpp

src/rpc/rawtransaction.cpp

src/init.cpp

src/crypto/sha256.cpp

src/consensus/merkle.h

src/consensus/tx_check.h

src/consensus/tx_verify.h

src/policy/feerate.h

src/policy/feerate.cpp

src/primitives/transaction_identifier.h

src/chainparamsbase.h

src/chainparamsbase.cpp

src/util/moneystr.cpp

src/crypto/ripemd160.h

src/crypto/sha1.h

src/crypto/sha512.h

src/crypto/hmac_sha256.h

src/crypto/hmac_sha512.h

src/crypto/hmac_sha256.cpp

src/crypto/hmac_sha512.cpp

src/crypto/hkdf_sha256_32.h

src/crypto/hkdf_sha256_32.cpp

src/support/cleanse.h

src/support/cleanse.cpp

src/crypto/siphash.cpp

src/crypto/muhash.h

src/crypto/chacha20.h

src/crypto/poly1305.h

src/crypto/chacha20poly1305.h

src/crypto/chacha20poly1305.cpp

src/util/chaintype.cpp

src/util/obfuscation.h

src/util/byte_units.h

src/util/overflow.h

src/blockencodings.cpp

src/net_permissions.cpp

src/policy/packages.cpp

src/policy/rbf.cpp

src/policy/truc_policy.cpp

src/policy/ephemeral_policy.cpp

src/policy/settings.cpp

src/policy/policy.cpp

src/node/transaction.cpp

src/node/coin.cpp

src/rpc/client.cpp

src/rpc/external_signer.cpp

src/rpc/request.cpp

src/rpc/server_util.cpp

src/rpc/fees.cpp

src/rpc/output_script.cpp

src/rpc/rawtransaction_util.cpp

src/rpc/rawtransaction_util.h

src/rpc/register.h

src/rpc/request.h

src/rpc/server_util.h

src/rpc/protocol.h

src/rpc/server.h

src/rpc/signmessage.cpp

src/rpc/txoutproof.cpp

src/rpc/util.cpp

src/rpc/util.h

src/wallet/rpc/addresses.cpp

src/wallet/rpc/backup.cpp

src/wallet/rpc/coins.cpp

src/wallet/rpc/encrypt.cpp

src/wallet/rpc/signmessage.cpp

src/wallet/rpc/util.cpp

src/wallet/rpc/util.h

src/wallet/coincontrol.cpp

src/wallet/coincontrol.h

src/wallet/context.cpp

src/wallet/context.h

src/wallet/crypter.cpp

src/wallet/crypter.h

src/wallet/db.cpp

src/wallet/export.cpp

src/wallet/external_signer_scriptpubkeyman.cpp

src/wallet/rpc/spend.cpp

src/wallet/rpc/transactions.cpp

src/wallet/rpc/wallet.cpp

src/wallet/feebumper.cpp

src/wallet/feebumper.h

src/index/base.h

src/index/base.cpp

src/index/txindex.h

src/index/txindex.cpp

src/index/txindex_key.h

src/index/txospenderindex.h

src/index/txospenderindex.cpp

src/index/blockfilterindex.h

src/index/blockfilterindex.cpp

src/index/coinstatsindex.h

src/index/coinstatsindex.cpp

src/index/db_key.h

src/index/disktxpos.h

src/kernel/chain.cpp

src/kernel/chain.h

src/kernel/checks.cpp

src/kernel/checks.h

src/kernel/context.cpp

src/kernel/context.h

src/kernel/cs_main.cpp

src/kernel/cs_main.h

src/kernel/disconnected_transactions.cpp

src/kernel/disconnected_transactions.h

src/kernel/mempool_removal_reason.cpp

src/kernel/mempool_removal_reason.h

src/kernel/coinstats.cpp

src/kernel/coinstats.h

src/kernel/chainparams.cpp

src/kernel/chainparams.h

src/wallet/sqlite.cpp

src/wallet/sqlite.h

src/wallet/transaction.cpp

src/wallet/transaction.h

src/wallet/dump.cpp

src/wallet/dump.h

src/wallet/init.cpp

src/wallet/walletutil.cpp

src/wallet/walletutil.h

src/wallet/wallettool.cpp

src/wallet/wallettool.h

src/wallet/export.h

src/wallet/migrate.cpp

src/wallet/migrate.h

src/wallet/db.h

src/wallet/walletdb.cpp

src/wallet/interfaces.cpp

src/wallet/scriptpubkeyman.cpp

src/wallet/scriptpubkeyman.h

src/kernel/bitcoinkernel.cpp

src/kernel/bitcoinkernel.h

src/kernel/bitcoinkernel_wrapper.h

src/node/chainstate.cpp

src/node/chainstate.h

src/node/blockstorage.cpp

src/node/blockstorage.h

src/node/mempool_persist.cpp

src/node/mempool_persist.h

src/node/utxo_snapshot.cpp

src/node/utxo_snapshot.h

src/node/kernel_notifications.cpp

src/node/kernel_notifications.h

src/node/blockmanager_args.cpp

src/kernel/blockmanager_opts.h

src/util/expected.cpp

src/policy/settings.h

src/util/types.h

src/kernel/messagestartchars.h

src/kernel/warning.h

src/util/exception.h

src/common/license_info.h

src/node/coins_view_args.h

src/node/database_args.h

src/util/batchpriority.h

src/util/ui_change_type.h

src/node/coins_view_args.cpp

src/node/peerman_args.h

src/util/serfloat.h

src/node/blockmanager_args.h

src/node/database_args.cpp

src/util/overloaded.h

src/interfaces/types.h

src/node/chainstatemanager_args.h

src/node/minisketchwrapper.h

src/util/macros.h

src/util/syserror.h

src/common/run_command.h

src/util/bytevectorhash.cpp

src/node/mempool_persist_args.cpp

src/util/exec.h

src/util/rbf.h

src/crypto/hex_base.h

src/node/mempool_persist_args.h

src/interfaces/echo.h

src/util/any.h

src/util/batchpriority.cpp

src/util/threadnames.h

src/node/coin.h

src/node/mempool_args.h

src/util/asmap.h

src/util/bytevectorhash.h

src/node/context.cpp

src/util/insert.h

src/util/readwritefile.h

src/node/peerman_args.cpp

src/node/interface_ui.cpp

src/interfaces/handler.h

src/node/mining_args.h

src/util/hasher.cpp

src/common/init.h

src/kernel/mempool_limits.h

src/common/system.h

src/crypto/sha3.h

src/util/threadinterrupt.cpp

src/node/protocol_version.h

src/util/exception.cpp

src/common/messages.h

src/node/connection_types.cpp

src/util/bip32.h

src/common/license_info.cpp

src/util/stdmutex.h

src/common/run_command.cpp

src/util/check.cpp

src/util/golombrice.h

src/node/types.h

src/node/timeoffsets.h

src/util/readwritefile.cpp

src/util/fastrange.h

src/util/signalinterrupt.h

src/util/task_runner.h

src/util/syserror.cpp

src/common/interfaces.cpp

src/common/types.h

src/util/threadinterrupt.h

src/kernel/chainstatemanager_opts.h

src/node/psbt.h

src/policy/ephemeral_policy.h

src/util/trace.h

src/common/url.cpp

src/kernel/mempool_options.h

src/util/serfloat.cpp

src/kernel/notifications_interface.h

src/node/timeoffsets.cpp

src/node/warnings.cpp

src/util/hash_type.h

src/crypto/hex_base.cpp

src/node/eviction.h

src/util/tokenbucket.h

src/crypto/aes.h

src/common/pcp.h

src/util/feefrac.cpp

src/node/transaction.h

src/util/threadnames.cpp

src/common/signmessage.h

src/util/exec.cpp

src/util/signalinterrupt.cpp

Independent explanations by MyBitcoinExplorer. Not affiliated with or endorsed by Bitcoin Core. Guides are educational and do not replace the source or its tests.

Bitcoin Core source © its contributors, distributed under the MIT license. Original notices and bundled third-party licenses are retained in the source tree.