src/bitcoin-cli.cpp

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2016 The Bitcoin Core developers
   3 // Distributed under the MIT software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6 #if defined(HAVE_CONFIG_H)
   7 #include "config/bitcoin-config.h"
   8 #endif
   9
  10 #include "chainparamsbase.h"
  11 #include "clientversion.h"
  12 #include "fs.h"
  13 #include "rpc/client.h"
  14 #include "rpc/protocol.h"
  15 #include "util.h"
  16 #include "utilstrencodings.h"
  17
  18 #include <stdio.h>
  19
  20 #include <event2/buffer.h>
  21 #include <event2/keyvalq_struct.h>
  22 #include "support/events.h"
  23
  24 #include <univalue.h>
  25
  26 static const char DEFAULT_RPCCONNECT[] = "127.0.0.1";
  27 static const int DEFAULT_HTTP_CLIENT_TIMEOUT=900;
  28 static const bool DEFAULT_NAMED=false;
  29 static const int CONTINUE_EXECUTION=-1;
  30
  31 std::string HelpMessageCli()
  32 {
  33     const auto defaultBaseParams = CreateBaseChainParams(CBaseChainParams::MAIN);
  34     const auto testnetBaseParams = CreateBaseChainParams(CBaseChainParams::TESTNET);
  35     std::string strUsage;
  36     strUsage += HelpMessageGroup(_("Options:"));
  37     strUsage += HelpMessageOpt("-?", _("This help message"));
  38     strUsage += HelpMessageOpt("-conf=<file>", strprintf(_("Specify configuration file (default: %s)"), BITCOIN_CONF_FILENAME));
  39     strUsage += HelpMessageOpt("-datadir=<dir>", _("Specify data directory"));
  40     strUsage += HelpMessageOpt("-getinfo", _("Get general information from the remote server. Note that unlike server-side RPC calls, the results of -getinfo is the result of multiple non-atomic requests. Some entries in the result may represent results from different states (e.g. wallet balance may be as of a different block from the chain state reported)"));
  41     AppendParamsHelpMessages(strUsage);
  42     strUsage += HelpMessageOpt("-named", strprintf(_("Pass named instead of positional arguments (default: %s)"), DEFAULT_NAMED));
  43     strUsage += HelpMessageOpt("-rpcconnect=<ip>", strprintf(_("Send commands to node running on <ip> (default: %s)"), DEFAULT_RPCCONNECT));
  44     strUsage += HelpMessageOpt("-rpcport=<port>", strprintf(_("Connect to JSON-RPC on <port> (default: %u or testnet: %u)"), defaultBaseParams->RPCPort(), testnetBaseParams->RPCPort()));
  45     strUsage += HelpMessageOpt("-rpcwait", _("Wait for RPC server to start"));
  46     strUsage += HelpMessageOpt("-rpcuser=<user>", _("Username for JSON-RPC connections"));
  47     strUsage += HelpMessageOpt("-rpcpassword=<pw>", _("Password for JSON-RPC connections"));
  48     strUsage += HelpMessageOpt("-rpcclienttimeout=<n>", strprintf(_("Timeout in seconds during HTTP requests, or 0 for no timeout. (default: %d)"), DEFAULT_HTTP_CLIENT_TIMEOUT));
  49     strUsage += HelpMessageOpt("-stdinrpcpass", strprintf(_("Read RPC password from standard input as a single line.  When combined with -stdin, the first line from standard input is used for the RPC password.")));
  50     strUsage += HelpMessageOpt("-stdin", _("Read extra arguments from standard input, one per line until EOF/Ctrl-D (recommended for sensitive information such as passphrases).  When combined with -stdinrpcpass, the first line from standard input is used for the RPC password."));
  51     strUsage += HelpMessageOpt("-rpcwallet=<walletname>", _("Send RPC for non-default wallet on RPC server (argument is wallet filename in bitcoind directory, required if bitcoind/-Qt runs with multiple wallets)"));
  52
  53     return strUsage;
  54 }
  55
  56 //////////////////////////////////////////////////////////////////////////////
  57 //
  58 // Start
  59 //
  60
  61 //
  62 // Exception thrown on connection error.  This error is used to determine
  63 // when to wait if -rpcwait is given.
  64 //
  65 class CConnectionFailed : public std::runtime_error
  66 {
  67 public:
  68
  69     explicit inline CConnectionFailed(const std::string& msg) :
  70         std::runtime_error(msg)
  71     {}
  72
  73 };
  74
  75 //
  76 // This function returns either one of EXIT_ codes when it's expected to stop the process or
  77 // CONTINUE_EXECUTION when it's expected to continue further.
  78 //
  79 static int AppInitRPC(int argc, char* argv[])
  80 {
  81     //
  82     // Parameters
  83     //
  84     gArgs.ParseParameters(argc, argv);
  85     if (argc<2 || gArgs.IsArgSet("-?") || gArgs.IsArgSet("-h") || gArgs.IsArgSet("-help") || gArgs.IsArgSet("-version")) {
  86         std::string strUsage = strprintf(_("%s RPC client version"), _(PACKAGE_NAME)) + " " + FormatFullVersion() + "\n";
  87         if (!gArgs.IsArgSet("-version")) {
  88             strUsage += "\n" + _("Usage:") + "\n" +
  89                   "  bitcoin-cli [options] <command> [params]  " + strprintf(_("Send command to %s"), _(PACKAGE_NAME)) + "\n" +
  90                   "  bitcoin-cli [options] -named <command> [name=value] ... " + strprintf(_("Send command to %s (with named arguments)"), _(PACKAGE_NAME)) + "\n" +
  91                   "  bitcoin-cli [options] help                " + _("List commands") + "\n" +
  92                   "  bitcoin-cli [options] help <command>      " + _("Get help for a command") + "\n";
  93
  94             strUsage += "\n" + HelpMessageCli();
  95         }
  96
  97         fprintf(stdout, "%s", strUsage.c_str());
  98         if (argc < 2) {
  99             fprintf(stderr, "Error: too few parameters\n");
 100             return EXIT_FAILURE;
 101         }
 102         return EXIT_SUCCESS;
 103     }
 104     if (!fs::is_directory(GetDataDir(false))) {
 105         fprintf(stderr, "Error: Specified data directory \"%s\" does not exist.\n", gArgs.GetArg("-datadir", "").c_str());
 106         return EXIT_FAILURE;
 107     }
 108     try {
 109         gArgs.ReadConfigFile(gArgs.GetArg("-conf", BITCOIN_CONF_FILENAME));
 110     } catch (const std::exception& e) {
 111         fprintf(stderr,"Error reading configuration file: %s\n", e.what());
 112         return EXIT_FAILURE;
 113     }
 114     // Check for -testnet or -regtest parameter (BaseParams() calls are only valid after this clause)
 115     try {
 116         SelectBaseParams(ChainNameFromCommandLine());
 117     } catch (const std::exception& e) {
 118         fprintf(stderr, "Error: %s\n", e.what());
 119         return EXIT_FAILURE;
 120     }
 121     if (gArgs.GetBoolArg("-rpcssl", false))
 122     {
 123         fprintf(stderr, "Error: SSL mode for RPC (-rpcssl) is no longer supported.\n");
 124         return EXIT_FAILURE;
 125     }
 126     return CONTINUE_EXECUTION;
 127 }
 128
 129
 130 /** Reply structure for request_done to fill in */
 131 struct HTTPReply
 132 {
 133     HTTPReply(): status(0), error(-1) {}
 134
 135     int status;
 136     int error;
 137     std::string body;
 138 };
 139
 140 const char *http_errorstring(int code)
 141 {
 142     switch(code) {
 143 #if LIBEVENT_VERSION_NUMBER >= 0x02010300
 144     case EVREQ_HTTP_TIMEOUT:
 145         return "timeout reached";
 146     case EVREQ_HTTP_EOF:
 147         return "EOF reached";
 148     case EVREQ_HTTP_INVALID_HEADER:
 149         return "error while reading header, or invalid header";
 150     case EVREQ_HTTP_BUFFER_ERROR:
 151         return "error encountered while reading or writing";
 152     case EVREQ_HTTP_REQUEST_CANCEL:
 153         return "request was canceled";
 154     case EVREQ_HTTP_DATA_TOO_LONG:
 155         return "response body is larger than allowed";
 156 #endif
 157     default:
 158         return "unknown";
 159     }
 160 }
 161
 162 static void http_request_done(struct evhttp_request *req, void *ctx)
 163 {
 164     HTTPReply *reply = static_cast<HTTPReply*>(ctx);
 165
 166     if (req == nullptr) {
 167         /* If req is nullptr, it means an error occurred while connecting: the
 168          * error code will have been passed to http_error_cb.
 169          */
 170         reply->status = 0;
 171         return;
 172     }
 173
 174     reply->status = evhttp_request_get_response_code(req);
 175
 176     struct evbuffer *buf = evhttp_request_get_input_buffer(req);
 177     if (buf)
 178     {
 179         size_t size = evbuffer_get_length(buf);
 180         const char *data = (const char*)evbuffer_pullup(buf, size);
 181         if (data)
 182             reply->body = std::string(data, size);
 183         evbuffer_drain(buf, size);
 184     }
 185 }
 186
 187 #if LIBEVENT_VERSION_NUMBER >= 0x02010300
 188 static void http_error_cb(enum evhttp_request_error err, void *ctx)
 189 {
 190     HTTPReply *reply = static_cast<HTTPReply*>(ctx);
 191     reply->error = err;
 192 }
 193 #endif
 194
 195 /** Class that handles the conversion from a command-line to a JSON-RPC request,
 196  * as well as converting back to a JSON object that can be shown as result.
 197  */
 198 class BaseRequestHandler
 199 {
 200 public:
 201     virtual UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) = 0;
 202     virtual UniValue ProcessReply(const UniValue &batch_in) = 0;
 203 };
 204
 205 /** Process getinfo requests */
 206 class GetinfoRequestHandler: public BaseRequestHandler
 207 {
 208 public:
 209     const int ID_NETWORKINFO = 0;
 210     const int ID_BLOCKCHAININFO = 1;
 211     const int ID_WALLETINFO = 2;
 212
 213     /** Create a simulated `getinfo` request. */
 214     UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
 215     {
 216         UniValue result(UniValue::VARR);
 217         result.push_back(JSONRPCRequestObj("getnetworkinfo", NullUniValue, ID_NETWORKINFO));
 218         result.push_back(JSONRPCRequestObj("getblockchaininfo", NullUniValue, ID_BLOCKCHAININFO));
 219         result.push_back(JSONRPCRequestObj("getwalletinfo", NullUniValue, ID_WALLETINFO));
 220         return result;
 221     }
 222
 223     /** Collect values from the batch and form a simulated `getinfo` reply. */
 224     UniValue ProcessReply(const UniValue &batch_in) override
 225     {
 226         UniValue result(UniValue::VOBJ);
 227         std::vector<UniValue> batch = JSONRPCProcessBatchReply(batch_in, 3);
 228         // Errors in getnetworkinfo() and getblockchaininfo() are fatal, pass them on
 229         // getwalletinfo() is allowed to fail in case there is no wallet.
 230         if (!batch[ID_NETWORKINFO]["error"].isNull()) {
 231             return batch[ID_NETWORKINFO];
 232         }
 233         if (!batch[ID_BLOCKCHAININFO]["error"].isNull()) {
 234             return batch[ID_BLOCKCHAININFO];
 235         }
 236         result.pushKV("version", batch[ID_NETWORKINFO]["result"]["version"]);
 237         result.pushKV("protocolversion", batch[ID_NETWORKINFO]["result"]["protocolversion"]);
 238         if (!batch[ID_WALLETINFO].isNull()) {
 239             result.pushKV("walletversion", batch[ID_WALLETINFO]["result"]["walletversion"]);
 240             result.pushKV("balance", batch[ID_WALLETINFO]["result"]["balance"]);
 241         }
 242         result.pushKV("blocks", batch[ID_BLOCKCHAININFO]["result"]["blocks"]);
 243         result.pushKV("timeoffset", batch[ID_NETWORKINFO]["result"]["timeoffset"]);
 244         result.pushKV("connections", batch[ID_NETWORKINFO]["result"]["connections"]);
 245         result.pushKV("proxy", batch[ID_NETWORKINFO]["result"]["networks"][0]["proxy"]);
 246         result.pushKV("difficulty", batch[ID_BLOCKCHAININFO]["result"]["difficulty"]);
 247         result.pushKV("testnet", UniValue(batch[ID_BLOCKCHAININFO]["result"]["chain"].get_str() == "test"));
 248         if (!batch[ID_WALLETINFO].isNull()) {
 249             result.pushKV("walletversion", batch[ID_WALLETINFO]["result"]["walletversion"]);
 250             result.pushKV("balance", batch[ID_WALLETINFO]["result"]["balance"]);
 251             result.pushKV("keypoololdest", batch[ID_WALLETINFO]["result"]["keypoololdest"]);
 252             result.pushKV("keypoolsize", batch[ID_WALLETINFO]["result"]["keypoolsize"]);
 253             if (!batch[ID_WALLETINFO]["result"]["unlocked_until"].isNull()) {
 254                 result.pushKV("unlocked_until", batch[ID_WALLETINFO]["result"]["unlocked_until"]);
 255             }
 256             result.pushKV("paytxfee", batch[ID_WALLETINFO]["result"]["paytxfee"]);
 257         }
 258         result.pushKV("relayfee", batch[ID_NETWORKINFO]["result"]["relayfee"]);
 259         result.pushKV("warnings", batch[ID_NETWORKINFO]["result"]["warnings"]);
 260         return JSONRPCReplyObj(result, NullUniValue, 1);
 261     }
 262 };
 263
 264 /** Process default single requests */
 265 class DefaultRequestHandler: public BaseRequestHandler {
 266 public:
 267     UniValue PrepareRequest(const std::string& method, const std::vector<std::string>& args) override
 268     {
 269         UniValue params;
 270         if(gArgs.GetBoolArg("-named", DEFAULT_NAMED)) {
 271             params = RPCConvertNamedValues(method, args);
 272         } else {
 273             params = RPCConvertValues(method, args);
 274         }
 275         return JSONRPCRequestObj(method, params, 1);
 276     }
 277
 278     UniValue ProcessReply(const UniValue &reply) override
 279     {
 280         return reply.get_obj();
 281     }
 282 };
 283
 284 static UniValue CallRPC(BaseRequestHandler *rh, const std::string& strMethod, const std::vector<std::string>& args)
 285 {
 286     std::string host;
 287     // In preference order, we choose the following for the port:
 288     //     1. -rpcport
 289     //     2. port in -rpcconnect (ie following : in ipv4 or ]: in ipv6)
 290     //     3. default port for chain
 291     int port = BaseParams().RPCPort();
 292     SplitHostPort(gArgs.GetArg("-rpcconnect", DEFAULT_RPCCONNECT), port, host);
 293     port = gArgs.GetArg("-rpcport", port);
 294
 295     // Obtain event base
 296     raii_event_base base = obtain_event_base();
 297
 298     // Synchronously look up hostname
 299     raii_evhttp_connection evcon = obtain_evhttp_connection_base(base.get(), host, port);
 300     evhttp_connection_set_timeout(evcon.get(), gArgs.GetArg("-rpcclienttimeout", DEFAULT_HTTP_CLIENT_TIMEOUT));
 301
 302     HTTPReply response;
 303     raii_evhttp_request req = obtain_evhttp_request(http_request_done, (void*)&response);
 304     if (req == nullptr)
 305         throw std::runtime_error("create http request failed");
 306 #if LIBEVENT_VERSION_NUMBER >= 0x02010300
 307     evhttp_request_set_error_cb(req.get(), http_error_cb);
 308 #endif
 309
 310     // Get credentials
 311     std::string strRPCUserColonPass;
 312     if (gArgs.GetArg("-rpcpassword", "") == "") {
 313         // Try fall back to cookie-based authentication if no password is provided
 314         if (!GetAuthCookie(&strRPCUserColonPass)) {
 315             throw std::runtime_error(strprintf(
 316                 _("Could not locate RPC credentials. No authentication cookie could be found, and RPC password is not set.  See -rpcpassword and -stdinrpcpass.  Configuration file: (%s)"),
 317                     GetConfigFile(gArgs.GetArg("-conf", BITCOIN_CONF_FILENAME)).string().c_str()));
 318
 319         }
 320     } else {
 321         strRPCUserColonPass = gArgs.GetArg("-rpcuser", "") + ":" + gArgs.GetArg("-rpcpassword", "");
 322     }
 323
 324     struct evkeyvalq* output_headers = evhttp_request_get_output_headers(req.get());
 325     assert(output_headers);
 326     evhttp_add_header(output_headers, "Host", host.c_str());
 327     evhttp_add_header(output_headers, "Connection", "close");
 328     evhttp_add_header(output_headers, "Authorization", (std::string("Basic ") + EncodeBase64(strRPCUserColonPass)).c_str());
 329
 330     // Attach request data
 331     std::string strRequest = rh->PrepareRequest(strMethod, args).write() + "\n";
 332     struct evbuffer* output_buffer = evhttp_request_get_output_buffer(req.get());
 333     assert(output_buffer);
 334     evbuffer_add(output_buffer, strRequest.data(), strRequest.size());
 335
 336     // check if we should use a special wallet endpoint
 337     std::string endpoint = "/";
 338     std::string walletName = gArgs.GetArg("-rpcwallet", "");
 339     if (!walletName.empty()) {
 340         char *encodedURI = evhttp_uriencode(walletName.c_str(), walletName.size(), false);
 341         if (encodedURI) {
 342             endpoint = "/wallet/"+ std::string(encodedURI);
 343             free(encodedURI);
 344         }
 345         else {
 346             throw CConnectionFailed("uri-encode failed");
 347         }
 348     }
 349     int r = evhttp_make_request(evcon.get(), req.get(), EVHTTP_REQ_POST, endpoint.c_str());
 350     req.release(); // ownership moved to evcon in above call
 351     if (r != 0) {
 352         throw CConnectionFailed("send http request failed");
 353     }
 354
 355     event_base_dispatch(base.get());
 356
 357     if (response.status == 0)
 358         throw CConnectionFailed(strprintf("couldn't connect to server: %s (code %d)\n(make sure server is running and you are connecting to the correct RPC port)", http_errorstring(response.error), response.error));
 359     else if (response.status == HTTP_UNAUTHORIZED)
 360         throw std::runtime_error("incorrect rpcuser or rpcpassword (authorization failed)");
 361     else if (response.status >= 400 && response.status != HTTP_BAD_REQUEST && response.status != HTTP_NOT_FOUND && response.status != HTTP_INTERNAL_SERVER_ERROR)
 362         throw std::runtime_error(strprintf("server returned HTTP error %d", response.status));
 363     else if (response.body.empty())
 364         throw std::runtime_error("no response from server");
 365
 366     // Parse reply
 367     UniValue valReply(UniValue::VSTR);
 368     if (!valReply.read(response.body))
 369         throw std::runtime_error("couldn't parse reply from server");
 370     const UniValue reply = rh->ProcessReply(valReply);
 371     if (reply.empty())
 372         throw std::runtime_error("expected reply to have result, error and id properties");
 373
 374     return reply;
 375 }
 376
 377 int CommandLineRPC(int argc, char *argv[])
 378 {
 379     std::string strPrint;
 380     int nRet = 0;
 381     try {
 382         // Skip switches
 383         while (argc > 1 && IsSwitchChar(argv[1][0])) {
 384             argc--;
 385             argv++;
 386         }
 387         std::string rpcPass;
 388         if (gArgs.GetBoolArg("-stdinrpcpass", false)) {
 389             if (!std::getline(std::cin, rpcPass)) {
 390                 throw std::runtime_error("-stdinrpcpass specified but failed to read from standard input");
 391             }
 392             gArgs.ForceSetArg("-rpcpassword", rpcPass);
 393         }
 394         std::vector<std::string> args = std::vector<std::string>(&argv[1], &argv[argc]);
 395         if (gArgs.GetBoolArg("-stdin", false)) {
 396             // Read one arg per line from stdin and append
 397             std::string line;
 398             while (std::getline(std::cin, line)) {
 399                 args.push_back(line);
 400             }
 401         }
 402         std::unique_ptr<BaseRequestHandler> rh;
 403         std::string method;
 404         if (gArgs.GetBoolArg("-getinfo", false)) {
 405             rh.reset(new GetinfoRequestHandler());
 406             method = "";
 407         } else {
 408             rh.reset(new DefaultRequestHandler());
 409             if (args.size() < 1) {
 410                 throw std::runtime_error("too few parameters (need at least command)");
 411             }
 412             method = args[0];
 413             args.erase(args.begin()); // Remove trailing method name from arguments vector
 414         }
 415
 416         // Execute and handle connection failures with -rpcwait
 417         const bool fWait = gArgs.GetBoolArg("-rpcwait", false);
 418         do {
 419             try {
 420                 const UniValue reply = CallRPC(rh.get(), method, args);
 421
 422                 // Parse reply
 423                 const UniValue& result = find_value(reply, "result");
 424                 const UniValue& error  = find_value(reply, "error");
 425
 426                 if (!error.isNull()) {
 427                     // Error
 428                     int code = error["code"].get_int();
 429                     if (fWait && code == RPC_IN_WARMUP)
 430                         throw CConnectionFailed("server in warmup");
 431                     strPrint = "error: " + error.write();
 432                     nRet = abs(code);
 433                     if (error.isObject())
 434                     {
 435                         UniValue errCode = find_value(error, "code");
 436                         UniValue errMsg  = find_value(error, "message");
 437                         strPrint = errCode.isNull() ? "" : "error code: "+errCode.getValStr()+"\n";
 438
 439                         if (errMsg.isStr())
 440                             strPrint += "error message:\n"+errMsg.get_str();
 441
 442                         if (errCode.isNum() && errCode.get_int() == RPC_WALLET_NOT_SPECIFIED) {
 443                             strPrint += "\nTry adding \"-rpcwallet=<filename>\" option to bitcoin-cli command line.";
 444                         }
 445                     }
 446                 } else {
 447                     // Result
 448                     if (result.isNull())
 449                         strPrint = "";
 450                     else if (result.isStr())
 451                         strPrint = result.get_str();
 452                     else
 453                         strPrint = result.write(2);
 454                 }
 455                 // Connection succeeded, no need to retry.
 456                 break;
 457             }
 458             catch (const CConnectionFailed&) {
 459                 if (fWait)
 460                     MilliSleep(1000);
 461                 else
 462                     throw;
 463             }
 464         } while (fWait);
 465     }
 466     catch (const boost::thread_interrupted&) {
 467         throw;
 468     }
 469     catch (const std::exception& e) {
 470         strPrint = std::string("error: ") + e.what();
 471         nRet = EXIT_FAILURE;
 472     }
 473     catch (...) {
 474         PrintExceptionContinue(nullptr, "CommandLineRPC()");
 475         throw;
 476     }
 477
 478     if (strPrint != "") {
 479         fprintf((nRet == 0 ? stdout : stderr), "%s\n", strPrint.c_str());
 480     }
 481     return nRet;
 482 }
 483
 484 int main(int argc, char* argv[])
 485 {
 486     SetupEnvironment();
 487     if (!SetupNetworking()) {
 488         fprintf(stderr, "Error: Initializing networking failed\n");
 489         return EXIT_FAILURE;
 490     }
 491
 492     try {
 493         int ret = AppInitRPC(argc, argv);
 494         if (ret != CONTINUE_EXECUTION)
 495             return ret;
 496     }
 497     catch (const std::exception& e) {
 498         PrintExceptionContinue(&e, "AppInitRPC()");
 499         return EXIT_FAILURE;
 500     } catch (...) {
 501         PrintExceptionContinue(nullptr, "AppInitRPC()");
 502         return EXIT_FAILURE;
 503     }
 504
 505     int ret = EXIT_FAILURE;
 506     try {
 507         ret = CommandLineRPC(argc, argv);
 508     }
 509     catch (const std::exception& e) {
 510         PrintExceptionContinue(&e, "CommandLineRPC()");
 511     } catch (...) {
 512         PrintExceptionContinue(nullptr, "CommandLineRPC()");
 513     }
 514     return ret;
 515 }