src/rpcserver.cpp

   1 // Copyright (c) 2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2014 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 #include "rpcserver.h"
   7
   8 #include "base58.h"
   9 #include "init.h"
  10 #include "random.h"
  11 #include "sync.h"
  12 #include "ui_interface.h"
  13 #include "util.h"
  14 #include "utilstrencodings.h"
  15 #ifdef ENABLE_WALLET
  16 #include "wallet/wallet.h"
  17 #endif
  18
  19 #include <boost/algorithm/string.hpp>
  20 #include <boost/asio.hpp>
  21 #include <boost/asio/ssl.hpp>
  22 #include <boost/bind.hpp>
  23 #include <boost/filesystem.hpp>
  24 #include <boost/foreach.hpp>
  25 #include <boost/iostreams/concepts.hpp>
  26 #include <boost/iostreams/stream.hpp>
  27 #include <boost/shared_ptr.hpp>
  28 #include <boost/signals2/signal.hpp>
  29 #include <boost/thread.hpp>
  30 #include "json/json_spirit_writer_template.h"
  31
  32 using namespace boost::asio;
  33 using namespace json_spirit;
  34 using namespace RPCServer;
  35 using namespace std;
  36
  37 static std::string strRPCUserColonPass;
  38
  39 static bool fRPCRunning = false;
  40 static bool fRPCInWarmup = true;
  41 static std::string rpcWarmupStatus("RPC server started");
  42 static CCriticalSection cs_rpcWarmup;
  43
  44 //! These are created by StartRPCThreads, destroyed in StopRPCThreads
  45 static boost::asio::io_service* rpc_io_service = NULL;
  46 static map<string, boost::shared_ptr<deadline_timer> > deadlineTimers;
  47 static ssl::context* rpc_ssl_context = NULL;
  48 static boost::thread_group* rpc_worker_group = NULL;
  49 static boost::asio::io_service::work *rpc_dummy_work = NULL;
  50 static std::vector<CSubNet> rpc_allow_subnets; //!< List of subnets to allow RPC connections from
  51 static std::vector< boost::shared_ptr<ip::tcp::acceptor> > rpc_acceptors;
  52
  53 static struct CRPCSignals
  54 {
  55     boost::signals2::signal<void ()> Started;
  56     boost::signals2::signal<void ()> Stopped;
  57     boost::signals2::signal<void (const CRPCCommand&)> PreCommand;
  58     boost::signals2::signal<void (const CRPCCommand&)> PostCommand;
  59 } g_rpcSignals;
  60
  61 void RPCServer::OnStarted(boost::function<void ()> slot)
  62 {
  63     g_rpcSignals.Started.connect(slot);
  64 }
  65
  66 void RPCServer::OnStopped(boost::function<void ()> slot)
  67 {
  68     g_rpcSignals.Stopped.connect(slot);
  69 }
  70
  71 void RPCServer::OnPreCommand(boost::function<void (const CRPCCommand&)> slot)
  72 {
  73     g_rpcSignals.PreCommand.connect(boost::bind(slot, _1));
  74 }
  75
  76 void RPCServer::OnPostCommand(boost::function<void (const CRPCCommand&)> slot)
  77 {
  78     g_rpcSignals.PostCommand.connect(boost::bind(slot, _1));
  79 }
  80
  81 void RPCTypeCheck(const Array& params,
  82                   const list<Value_type>& typesExpected,
  83                   bool fAllowNull)
  84 {
  85     unsigned int i = 0;
  86     BOOST_FOREACH(Value_type t, typesExpected)
  87     {
  88         if (params.size() <= i)
  89             break;
  90
  91         const Value& v = params[i];
  92         if (!((v.type() == t) || (fAllowNull && (v.type() == null_type))))
  93         {
  94             string err = strprintf("Expected type %s, got %s",
  95                                    Value_type_name[t], Value_type_name[v.type()]);
  96             throw JSONRPCError(RPC_TYPE_ERROR, err);
  97         }
  98         i++;
  99     }
 100 }
 101
 102 void RPCTypeCheck(const Object& o,
 103                   const map<string, Value_type>& typesExpected,
 104                   bool fAllowNull)
 105 {
 106     BOOST_FOREACH(const PAIRTYPE(string, Value_type)& t, typesExpected)
 107     {
 108         const Value& v = find_value(o, t.first);
 109         if (!fAllowNull && v.type() == null_type)
 110             throw JSONRPCError(RPC_TYPE_ERROR, strprintf("Missing %s", t.first));
 111
 112         if (!((v.type() == t.second) || (fAllowNull && (v.type() == null_type))))
 113         {
 114             string err = strprintf("Expected type %s for %s, got %s",
 115                                    Value_type_name[t.second], t.first, Value_type_name[v.type()]);
 116             throw JSONRPCError(RPC_TYPE_ERROR, err);
 117         }
 118     }
 119 }
 120
 121 static inline int64_t roundint64(double d)
 122 {
 123     return (int64_t)(d > 0 ? d + 0.5 : d - 0.5);
 124 }
 125
 126 CAmount AmountFromValue(const Value& value)
 127 {
 128     double dAmount = value.get_real();
 129     if (dAmount <= 0.0 || dAmount > 21000000.0)
 130         throw JSONRPCError(RPC_TYPE_ERROR, "Invalid amount");
 131     CAmount nAmount = roundint64(dAmount * COIN);
 132     if (!MoneyRange(nAmount))
 133         throw JSONRPCError(RPC_TYPE_ERROR, "Invalid amount");
 134     return nAmount;
 135 }
 136
 137 Value ValueFromAmount(const CAmount& amount)
 138 {
 139     return (double)amount / (double)COIN;
 140 }
 141
 142 uint256 ParseHashV(const Value& v, string strName)
 143 {
 144     string strHex;
 145     if (v.type() == str_type)
 146         strHex = v.get_str();
 147     if (!IsHex(strHex)) // Note: IsHex("") is false
 148         throw JSONRPCError(RPC_INVALID_PARAMETER, strName+" must be hexadecimal string (not '"+strHex+"')");
 149     uint256 result;
 150     result.SetHex(strHex);
 151     return result;
 152 }
 153 uint256 ParseHashO(const Object& o, string strKey)
 154 {
 155     return ParseHashV(find_value(o, strKey), strKey);
 156 }
 157 vector<unsigned char> ParseHexV(const Value& v, string strName)
 158 {
 159     string strHex;
 160     if (v.type() == str_type)
 161         strHex = v.get_str();
 162     if (!IsHex(strHex))
 163         throw JSONRPCError(RPC_INVALID_PARAMETER, strName+" must be hexadecimal string (not '"+strHex+"')");
 164     return ParseHex(strHex);
 165 }
 166 vector<unsigned char> ParseHexO(const Object& o, string strKey)
 167 {
 168     return ParseHexV(find_value(o, strKey), strKey);
 169 }
 170
 171
 172 /**
 173  * Note: This interface may still be subject to change.
 174  */
 175
 176 string CRPCTable::help(string strCommand) const
 177 {
 178     string strRet;
 179     string category;
 180     set<rpcfn_type> setDone;
 181     vector<pair<string, const CRPCCommand*> > vCommands;
 182
 183     for (map<string, const CRPCCommand*>::const_iterator mi = mapCommands.begin(); mi != mapCommands.end(); ++mi)
 184         vCommands.push_back(make_pair(mi->second->category + mi->first, mi->second));
 185     sort(vCommands.begin(), vCommands.end());
 186
 187     BOOST_FOREACH(const PAIRTYPE(string, const CRPCCommand*)& command, vCommands)
 188     {
 189         const CRPCCommand *pcmd = command.second;
 190         string strMethod = pcmd->name;
 191         // We already filter duplicates, but these deprecated screw up the sort order
 192         if (strMethod.find("label") != string::npos)
 193             continue;
 194         if ((strCommand != "" || pcmd->category == "hidden") && strMethod != strCommand)
 195             continue;
 196         try
 197         {
 198             Array params;
 199             rpcfn_type pfn = pcmd->actor;
 200             if (setDone.insert(pfn).second)
 201                 (*pfn)(params, true);
 202         }
 203         catch (const std::exception& e)
 204         {
 205             // Help text is returned in an exception
 206             string strHelp = string(e.what());
 207             if (strCommand == "")
 208             {
 209                 if (strHelp.find('\n') != string::npos)
 210                     strHelp = strHelp.substr(0, strHelp.find('\n'));
 211
 212                 if (category != pcmd->category)
 213                 {
 214                     if (!category.empty())
 215                         strRet += "\n";
 216                     category = pcmd->category;
 217                     string firstLetter = category.substr(0,1);
 218                     boost::to_upper(firstLetter);
 219                     strRet += "== " + firstLetter + category.substr(1) + " ==\n";
 220                 }
 221             }
 222             strRet += strHelp + "\n";
 223         }
 224     }
 225     if (strRet == "")
 226         strRet = strprintf("help: unknown command: %s\n", strCommand);
 227     strRet = strRet.substr(0,strRet.size()-1);
 228     return strRet;
 229 }
 230
 231 Value help(const Array& params, bool fHelp)
 232 {
 233     if (fHelp || params.size() > 1)
 234         throw runtime_error(
 235             "help ( \"command\" )\n"
 236             "\nList all commands, or get help for a specified command.\n"
 237             "\nArguments:\n"
 238             "1. \"command\"     (string, optional) The command to get help on\n"
 239             "\nResult:\n"
 240             "\"text\"     (string) The help text\n"
 241         );
 242
 243     string strCommand;
 244     if (params.size() > 0)
 245         strCommand = params[0].get_str();
 246
 247     return tableRPC.help(strCommand);
 248 }
 249
 250
 251 Value stop(const Array& params, bool fHelp)
 252 {
 253     // Accept the deprecated and ignored 'detach' boolean argument
 254     if (fHelp || params.size() > 1)
 255         throw runtime_error(
 256             "stop\n"
 257             "\nStop Bitcoin server.");
 258     // Shutdown will take long enough that the response should get back
 259     StartShutdown();
 260     return "Bitcoin server stopping";
 261 }
 262
 263
 264
 265 /**
 266  * Call Table
 267  */
 268 static const CRPCCommand vRPCCommands[] =
 269 { //  category              name                      actor (function)         okSafeMode
 270   //  --------------------- ------------------------  -----------------------  ----------
 271     /* Overall control/query calls */
 272     { "control",            "getinfo",                &getinfo,                true  }, /* uses wallet if enabled */
 273     { "control",            "help",                   &help,                   true  },
 274     { "control",            "stop",                   &stop,                   true  },
 275
 276     /* P2P networking */
 277     { "network",            "getnetworkinfo",         &getnetworkinfo,         true  },
 278     { "network",            "addnode",                &addnode,                true  },
 279     { "network",            "getaddednodeinfo",       &getaddednodeinfo,       true  },
 280     { "network",            "getconnectioncount",     &getconnectioncount,     true  },
 281     { "network",            "getnettotals",           &getnettotals,           true  },
 282     { "network",            "getpeerinfo",            &getpeerinfo,            true  },
 283     { "network",            "ping",                   &ping,                   true  },
 284
 285     /* Block chain and UTXO */
 286     { "blockchain",         "getblockchaininfo",      &getblockchaininfo,      true  },
 287     { "blockchain",         "getbestblockhash",       &getbestblockhash,       true  },
 288     { "blockchain",         "getblockcount",          &getblockcount,          true  },
 289     { "blockchain",         "getblock",               &getblock,               true  },
 290     { "blockchain",         "getblockhash",           &getblockhash,           true  },
 291     { "blockchain",         "getchaintips",           &getchaintips,           true  },
 292     { "blockchain",         "getdifficulty",          &getdifficulty,          true  },
 293     { "blockchain",         "getmempoolinfo",         &getmempoolinfo,         true  },
 294     { "blockchain",         "getrawmempool",          &getrawmempool,          true  },
 295     { "blockchain",         "gettxout",               &gettxout,               true  },
 296     { "blockchain",         "gettxoutproof",          &gettxoutproof,          true  },
 297     { "blockchain",         "verifytxoutproof",       &verifytxoutproof,       true  },
 298     { "blockchain",         "gettxoutsetinfo",        &gettxoutsetinfo,        true  },
 299     { "blockchain",         "verifychain",            &verifychain,            true  },
 300
 301     /* Mining */
 302     { "mining",             "getblocktemplate",       &getblocktemplate,       true  },
 303     { "mining",             "getmininginfo",          &getmininginfo,          true  },
 304     { "mining",             "getnetworkhashps",       &getnetworkhashps,       true  },
 305     { "mining",             "prioritisetransaction",  &prioritisetransaction,  true  },
 306     { "mining",             "submitblock",            &submitblock,            true  },
 307
 308 #ifdef ENABLE_WALLET
 309     /* Coin generation */
 310     { "generating",         "getgenerate",            &getgenerate,            true  },
 311     { "generating",         "setgenerate",            &setgenerate,            true  },
 312     { "generating",         "generate",               &generate,               true  },
 313 #endif
 314
 315     /* Raw transactions */
 316     { "rawtransactions",    "createrawtransaction",   &createrawtransaction,   true  },
 317     { "rawtransactions",    "decoderawtransaction",   &decoderawtransaction,   true  },
 318     { "rawtransactions",    "decodescript",           &decodescript,           true  },
 319     { "rawtransactions",    "getrawtransaction",      &getrawtransaction,      true  },
 320     { "rawtransactions",    "sendrawtransaction",     &sendrawtransaction,     false },
 321     { "rawtransactions",    "signrawtransaction",     &signrawtransaction,     false }, /* uses wallet if enabled */
 322
 323     /* Utility functions */
 324     { "util",               "createmultisig",         &createmultisig,         true  },
 325     { "util",               "validateaddress",        &validateaddress,        true  }, /* uses wallet if enabled */
 326     { "util",               "verifymessage",          &verifymessage,          true  },
 327     { "util",               "estimatefee",            &estimatefee,            true  },
 328     { "util",               "estimatepriority",       &estimatepriority,       true  },
 329
 330     /* Not shown in help */
 331     { "hidden",             "invalidateblock",        &invalidateblock,        true  },
 332     { "hidden",             "reconsiderblock",        &reconsiderblock,        true  },
 333     { "hidden",             "setmocktime",            &setmocktime,            true  },
 334 #ifdef ENABLE_WALLET
 335     { "hidden",             "resendwallettransactions", &resendwallettransactions, true},
 336 #endif
 337
 338 #ifdef ENABLE_WALLET
 339     /* Wallet */
 340     { "wallet",             "addmultisigaddress",     &addmultisigaddress,     true  },
 341     { "wallet",             "backupwallet",           &backupwallet,           true  },
 342     { "wallet",             "dumpprivkey",            &dumpprivkey,            true  },
 343     { "wallet",             "dumpwallet",             &dumpwallet,             true  },
 344     { "wallet",             "encryptwallet",          &encryptwallet,          true  },
 345     { "wallet",             "getaccountaddress",      &getaccountaddress,      true  },
 346     { "wallet",             "getaccount",             &getaccount,             true  },
 347     { "wallet",             "getaddressesbyaccount",  &getaddressesbyaccount,  true  },
 348     { "wallet",             "getbalance",             &getbalance,             false },
 349     { "wallet",             "getnewaddress",          &getnewaddress,          true  },
 350     { "wallet",             "getrawchangeaddress",    &getrawchangeaddress,    true  },
 351     { "wallet",             "getreceivedbyaccount",   &getreceivedbyaccount,   false },
 352     { "wallet",             "getreceivedbyaddress",   &getreceivedbyaddress,   false },
 353     { "wallet",             "gettransaction",         &gettransaction,         false },
 354     { "wallet",             "getunconfirmedbalance",  &getunconfirmedbalance,  false },
 355     { "wallet",             "getwalletinfo",          &getwalletinfo,          false },
 356     { "wallet",             "importprivkey",          &importprivkey,          true  },
 357     { "wallet",             "importwallet",           &importwallet,           true  },
 358     { "wallet",             "importaddress",          &importaddress,          true  },
 359     { "wallet",             "keypoolrefill",          &keypoolrefill,          true  },
 360     { "wallet",             "listaccounts",           &listaccounts,           false },
 361     { "wallet",             "listaddressgroupings",   &listaddressgroupings,   false },
 362     { "wallet",             "listlockunspent",        &listlockunspent,        false },
 363     { "wallet",             "listreceivedbyaccount",  &listreceivedbyaccount,  false },
 364     { "wallet",             "listreceivedbyaddress",  &listreceivedbyaddress,  false },
 365     { "wallet",             "listsinceblock",         &listsinceblock,         false },
 366     { "wallet",             "listtransactions",       &listtransactions,       false },
 367     { "wallet",             "listunspent",            &listunspent,            false },
 368     { "wallet",             "lockunspent",            &lockunspent,            true  },
 369     { "wallet",             "move",                   &movecmd,                false },
 370     { "wallet",             "sendfrom",               &sendfrom,               false },
 371     { "wallet",             "sendmany",               &sendmany,               false },
 372     { "wallet",             "sendtoaddress",          &sendtoaddress,          false },
 373     { "wallet",             "setaccount",             &setaccount,             true  },
 374     { "wallet",             "settxfee",               &settxfee,               true  },
 375     { "wallet",             "signmessage",            &signmessage,            true  },
 376     { "wallet",             "walletlock",             &walletlock,             true  },
 377     { "wallet",             "walletpassphrasechange", &walletpassphrasechange, true  },
 378     { "wallet",             "walletpassphrase",       &walletpassphrase,       true  },
 379 #endif // ENABLE_WALLET
 380 };
 381
 382 CRPCTable::CRPCTable()
 383 {
 384     unsigned int vcidx;
 385     for (vcidx = 0; vcidx < (sizeof(vRPCCommands) / sizeof(vRPCCommands[0])); vcidx++)
 386     {
 387         const CRPCCommand *pcmd;
 388
 389         pcmd = &vRPCCommands[vcidx];
 390         mapCommands[pcmd->name] = pcmd;
 391     }
 392 }
 393
 394 const CRPCCommand *CRPCTable::operator[](string name) const
 395 {
 396     map<string, const CRPCCommand*>::const_iterator it = mapCommands.find(name);
 397     if (it == mapCommands.end())
 398         return NULL;
 399     return (*it).second;
 400 }
 401
 402
 403 bool HTTPAuthorized(map<string, string>& mapHeaders)
 404 {
 405     string strAuth = mapHeaders["authorization"];
 406     if (strAuth.substr(0,6) != "Basic ")
 407         return false;
 408     string strUserPass64 = strAuth.substr(6); boost::trim(strUserPass64);
 409     string strUserPass = DecodeBase64(strUserPass64);
 410     return TimingResistantEqual(strUserPass, strRPCUserColonPass);
 411 }
 412
 413 void ErrorReply(std::ostream& stream, const Object& objError, const Value& id)
 414 {
 415     // Send error reply from json-rpc error object
 416     int nStatus = HTTP_INTERNAL_SERVER_ERROR;
 417     int code = find_value(objError, "code").get_int();
 418     if (code == RPC_INVALID_REQUEST) nStatus = HTTP_BAD_REQUEST;
 419     else if (code == RPC_METHOD_NOT_FOUND) nStatus = HTTP_NOT_FOUND;
 420     string strReply = JSONRPCReply(Value::null, objError, id);
 421     stream << HTTPReply(nStatus, strReply, false) << std::flush;
 422 }
 423
 424 CNetAddr BoostAsioToCNetAddr(boost::asio::ip::address address)
 425 {
 426     CNetAddr netaddr;
 427     // Make sure that IPv4-compatible and IPv4-mapped IPv6 addresses are treated as IPv4 addresses
 428     if (address.is_v6()
 429      && (address.to_v6().is_v4_compatible()
 430       || address.to_v6().is_v4_mapped()))
 431         address = address.to_v6().to_v4();
 432
 433     if(address.is_v4())
 434     {
 435         boost::asio::ip::address_v4::bytes_type bytes = address.to_v4().to_bytes();
 436         netaddr.SetRaw(NET_IPV4, &bytes[0]);
 437     }
 438     else
 439     {
 440         boost::asio::ip::address_v6::bytes_type bytes = address.to_v6().to_bytes();
 441         netaddr.SetRaw(NET_IPV6, &bytes[0]);
 442     }
 443     return netaddr;
 444 }
 445
 446 bool ClientAllowed(const boost::asio::ip::address& address)
 447 {
 448     CNetAddr netaddr = BoostAsioToCNetAddr(address);
 449     BOOST_FOREACH(const CSubNet &subnet, rpc_allow_subnets)
 450         if (subnet.Match(netaddr))
 451             return true;
 452     return false;
 453 }
 454
 455 template <typename Protocol>
 456 class AcceptedConnectionImpl : public AcceptedConnection
 457 {
 458 public:
 459     AcceptedConnectionImpl(
 460             boost::asio::io_service& io_service,
 461             ssl::context &context,
 462             bool fUseSSL) :
 463         sslStream(io_service, context),
 464         _d(sslStream, fUseSSL),
 465         _stream(_d)
 466     {
 467     }
 468
 469     virtual std::iostream& stream()
 470     {
 471         return _stream;
 472     }
 473
 474     virtual std::string peer_address_to_string() const
 475     {
 476         return peer.address().to_string();
 477     }
 478
 479     virtual void close()
 480     {
 481         _stream.close();
 482     }
 483
 484     typename Protocol::endpoint peer;
 485     boost::asio::ssl::stream<typename Protocol::socket> sslStream;
 486
 487 private:
 488     SSLIOStreamDevice<Protocol> _d;
 489     boost::iostreams::stream< SSLIOStreamDevice<Protocol> > _stream;
 490 };
 491
 492 void ServiceConnection(AcceptedConnection *conn);
 493
 494 //! Forward declaration required for RPCListen
 495 template <typename Protocol, typename SocketAcceptorService>
 496 static void RPCAcceptHandler(boost::shared_ptr< basic_socket_acceptor<Protocol, SocketAcceptorService> > acceptor,
 497                              ssl::context& context,
 498                              bool fUseSSL,
 499                              boost::shared_ptr< AcceptedConnection > conn,
 500                              const boost::system::error_code& error);
 501
 502 /**
 503  * Sets up I/O resources to accept and handle a new connection.
 504  */
 505 template <typename Protocol, typename SocketAcceptorService>
 506 static void RPCListen(boost::shared_ptr< basic_socket_acceptor<Protocol, SocketAcceptorService> > acceptor,
 507                    ssl::context& context,
 508                    const bool fUseSSL)
 509 {
 510     // Accept connection
 511     boost::shared_ptr< AcceptedConnectionImpl<Protocol> > conn(new AcceptedConnectionImpl<Protocol>(acceptor->get_io_service(), context, fUseSSL));
 512
 513     acceptor->async_accept(
 514             conn->sslStream.lowest_layer(),
 515             conn->peer,
 516             boost::bind(&RPCAcceptHandler<Protocol, SocketAcceptorService>,
 517                 acceptor,
 518                 boost::ref(context),
 519                 fUseSSL,
 520                 conn,
 521                 _1));
 522 }
 523
 524
 525 /**
 526  * Accept and handle incoming connection.
 527  */
 528 template <typename Protocol, typename SocketAcceptorService>
 529 static void RPCAcceptHandler(boost::shared_ptr< basic_socket_acceptor<Protocol, SocketAcceptorService> > acceptor,
 530                              ssl::context& context,
 531                              const bool fUseSSL,
 532                              boost::shared_ptr< AcceptedConnection > conn,
 533                              const boost::system::error_code& error)
 534 {
 535     // Immediately start accepting new connections, except when we're cancelled or our socket is closed.
 536     if (error != boost::asio::error::operation_aborted && acceptor->is_open())
 537         RPCListen(acceptor, context, fUseSSL);
 538
 539     AcceptedConnectionImpl<ip::tcp>* tcp_conn = dynamic_cast< AcceptedConnectionImpl<ip::tcp>* >(conn.get());
 540
 541     if (error)
 542     {
 543         // TODO: Actually handle errors
 544         LogPrintf("%s: Error: %s\n", __func__, error.message());
 545     }
 546     // Restrict callers by IP.  It is important to
 547     // do this before starting client thread, to filter out
 548     // certain DoS and misbehaving clients.
 549     else if (tcp_conn && !ClientAllowed(tcp_conn->peer.address()))
 550     {
 551         // Only send a 403 if we're not using SSL to prevent a DoS during the SSL handshake.
 552         if (!fUseSSL)
 553             conn->stream() << HTTPError(HTTP_FORBIDDEN, false) << std::flush;
 554         conn->close();
 555     }
 556     else {
 557         ServiceConnection(conn.get());
 558         conn->close();
 559     }
 560 }
 561
 562 static ip::tcp::endpoint ParseEndpoint(const std::string &strEndpoint, int defaultPort)
 563 {
 564     std::string addr;
 565     int port = defaultPort;
 566     SplitHostPort(strEndpoint, port, addr);
 567     return ip::tcp::endpoint(boost::asio::ip::address::from_string(addr), port);
 568 }
 569
 570 void StartRPCThreads()
 571 {
 572     rpc_allow_subnets.clear();
 573     rpc_allow_subnets.push_back(CSubNet("127.0.0.0/8")); // always allow IPv4 local subnet
 574     rpc_allow_subnets.push_back(CSubNet("::1")); // always allow IPv6 localhost
 575     if (mapMultiArgs.count("-rpcallowip"))
 576     {
 577         const vector<string>& vAllow = mapMultiArgs["-rpcallowip"];
 578         BOOST_FOREACH(string strAllow, vAllow)
 579         {
 580             CSubNet subnet(strAllow);
 581             if(!subnet.IsValid())
 582             {
 583                 uiInterface.ThreadSafeMessageBox(
 584                     strprintf("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),
 585                     "", CClientUIInterface::MSG_ERROR);
 586                 StartShutdown();
 587                 return;
 588             }
 589             rpc_allow_subnets.push_back(subnet);
 590         }
 591     }
 592     std::string strAllowed;
 593     BOOST_FOREACH(const CSubNet &subnet, rpc_allow_subnets)
 594         strAllowed += subnet.ToString() + " ";
 595     LogPrint("rpc", "Allowing RPC connections from: %s\n", strAllowed);
 596
 597     strRPCUserColonPass = mapArgs["-rpcuser"] + ":" + mapArgs["-rpcpassword"];
 598     if (((mapArgs["-rpcpassword"] == "") ||
 599          (mapArgs["-rpcuser"] == mapArgs["-rpcpassword"])) && Params().RequireRPCPassword())
 600     {
 601         unsigned char rand_pwd[32];
 602         GetRandBytes(rand_pwd, 32);
 603         uiInterface.ThreadSafeMessageBox(strprintf(
 604             _("To use bitcoind, or the -server option to bitcoin-qt, you must set an rpcpassword in the configuration file:\n"
 605               "%s\n"
 606               "It is recommended you use the following random password:\n"
 607               "rpcuser=bitcoinrpc\n"
 608               "rpcpassword=%s\n"
 609               "(you do not need to remember this password)\n"
 610               "The username and password MUST NOT be the same.\n"
 611               "If the file does not exist, create it with owner-readable-only file permissions.\n"
 612               "It is also recommended to set alertnotify so you are notified of problems;\n"
 613               "for example: alertnotify=echo %%s | mail -s \"Bitcoin Alert\" [email protected]\n"),
 614                 GetConfigFile().string(),
 615                 EncodeBase58(&rand_pwd[0],&rand_pwd[0]+32)),
 616                 "", CClientUIInterface::MSG_ERROR | CClientUIInterface::SECURE);
 617         StartShutdown();
 618         return;
 619     }
 620
 621     assert(rpc_io_service == NULL);
 622     rpc_io_service = new boost::asio::io_service();
 623     rpc_ssl_context = new ssl::context(*rpc_io_service, ssl::context::sslv23);
 624
 625     const bool fUseSSL = GetBoolArg("-rpcssl", false);
 626
 627     if (fUseSSL)
 628     {
 629         rpc_ssl_context->set_options(ssl::context::no_sslv2 | ssl::context::no_sslv3);
 630
 631         boost::filesystem::path pathCertFile(GetArg("-rpcsslcertificatechainfile", "server.cert"));
 632         if (!pathCertFile.is_complete()) pathCertFile = boost::filesystem::path(GetDataDir()) / pathCertFile;
 633         if (boost::filesystem::exists(pathCertFile)) rpc_ssl_context->use_certificate_chain_file(pathCertFile.string());
 634         else LogPrintf("ThreadRPCServer ERROR: missing server certificate file %s\n", pathCertFile.string());
 635
 636         boost::filesystem::path pathPKFile(GetArg("-rpcsslprivatekeyfile", "server.pem"));
 637         if (!pathPKFile.is_complete()) pathPKFile = boost::filesystem::path(GetDataDir()) / pathPKFile;
 638         if (boost::filesystem::exists(pathPKFile)) rpc_ssl_context->use_private_key_file(pathPKFile.string(), ssl::context::pem);
 639         else LogPrintf("ThreadRPCServer ERROR: missing server private key file %s\n", pathPKFile.string());
 640
 641         string strCiphers = GetArg("-rpcsslciphers", "TLSv1.2+HIGH:TLSv1+HIGH:!SSLv2:!aNULL:!eNULL:!3DES:@STRENGTH");
 642         SSL_CTX_set_cipher_list(rpc_ssl_context->impl(), strCiphers.c_str());
 643     }
 644
 645     std::vector<ip::tcp::endpoint> vEndpoints;
 646     bool bBindAny = false;
 647     int defaultPort = GetArg("-rpcport", BaseParams().RPCPort());
 648     if (!mapArgs.count("-rpcallowip")) // Default to loopback if not allowing external IPs
 649     {
 650         vEndpoints.push_back(ip::tcp::endpoint(boost::asio::ip::address_v6::loopback(), defaultPort));
 651         vEndpoints.push_back(ip::tcp::endpoint(boost::asio::ip::address_v4::loopback(), defaultPort));
 652         if (mapArgs.count("-rpcbind"))
 653         {
 654             LogPrintf("WARNING: option -rpcbind was ignored because -rpcallowip was not specified, refusing to allow everyone to connect\n");
 655         }
 656     } else if (mapArgs.count("-rpcbind")) // Specific bind address
 657     {
 658         BOOST_FOREACH(const std::string &addr, mapMultiArgs["-rpcbind"])
 659         {
 660             try {
 661                 vEndpoints.push_back(ParseEndpoint(addr, defaultPort));
 662             }
 663             catch (const boost::system::system_error&)
 664             {
 665                 uiInterface.ThreadSafeMessageBox(
 666                     strprintf(_("Could not parse -rpcbind value %s as network address"), addr),
 667                     "", CClientUIInterface::MSG_ERROR);
 668                 StartShutdown();
 669                 return;
 670             }
 671         }
 672     } else { // No specific bind address specified, bind to any
 673         vEndpoints.push_back(ip::tcp::endpoint(boost::asio::ip::address_v6::any(), defaultPort));
 674         vEndpoints.push_back(ip::tcp::endpoint(boost::asio::ip::address_v4::any(), defaultPort));
 675         // Prefer making the socket dual IPv6/IPv4 instead of binding
 676         // to both addresses seperately.
 677         bBindAny = true;
 678     }
 679
 680     bool fListening = false;
 681     std::string strerr;
 682     std::string straddress;
 683     BOOST_FOREACH(const ip::tcp::endpoint &endpoint, vEndpoints)
 684     {
 685         try {
 686             boost::asio::ip::address bindAddress = endpoint.address();
 687             straddress = bindAddress.to_string();
 688             LogPrintf("Binding RPC on address %s port %i (IPv4+IPv6 bind any: %i)\n", straddress, endpoint.port(), bBindAny);
 689             boost::system::error_code v6_only_error;
 690             boost::shared_ptr<ip::tcp::acceptor> acceptor(new ip::tcp::acceptor(*rpc_io_service));
 691
 692             acceptor->open(endpoint.protocol());
 693             acceptor->set_option(boost::asio::ip::tcp::acceptor::reuse_address(true));
 694
 695             // Try making the socket dual IPv6/IPv4 when listening on the IPv6 "any" address
 696             acceptor->set_option(boost::asio::ip::v6_only(
 697                 !bBindAny || bindAddress != boost::asio::ip::address_v6::any()), v6_only_error);
 698
 699             acceptor->bind(endpoint);
 700             acceptor->listen(socket_base::max_connections);
 701
 702             RPCListen(acceptor, *rpc_ssl_context, fUseSSL);
 703
 704             fListening = true;
 705             rpc_acceptors.push_back(acceptor);
 706             // If dual IPv6/IPv4 bind successful, skip binding to IPv4 separately
 707             if(bBindAny && bindAddress == boost::asio::ip::address_v6::any() && !v6_only_error)
 708                 break;
 709         }
 710         catch (const boost::system::system_error& e)
 711         {
 712             LogPrintf("ERROR: Binding RPC on address %s port %i failed: %s\n", straddress, endpoint.port(), e.what());
 713             strerr = strprintf(_("An error occurred while setting up the RPC address %s port %u for listening: %s"), straddress, endpoint.port(), e.what());
 714         }
 715     }
 716
 717     if (!fListening) {
 718         uiInterface.ThreadSafeMessageBox(strerr, "", CClientUIInterface::MSG_ERROR);
 719         StartShutdown();
 720         return;
 721     }
 722
 723     rpc_worker_group = new boost::thread_group();
 724     for (int i = 0; i < GetArg("-rpcthreads", 4); i++)
 725         rpc_worker_group->create_thread(boost::bind(&boost::asio::io_service::run, rpc_io_service));
 726     fRPCRunning = true;
 727     g_rpcSignals.Started();
 728 }
 729
 730 void StartDummyRPCThread()
 731 {
 732     if(rpc_io_service == NULL)
 733     {
 734         rpc_io_service = new boost::asio::io_service();
 735         /* Create dummy "work" to keep the thread from exiting when no timeouts active,
 736          * see http://www.boost.org/doc/libs/1_51_0/doc/html/boost_asio/reference/io_service.html#boost_asio.reference.io_service.stopping_the_io_service_from_running_out_of_work */
 737         rpc_dummy_work = new boost::asio::io_service::work(*rpc_io_service);
 738         rpc_worker_group = new boost::thread_group();
 739         rpc_worker_group->create_thread(boost::bind(&boost::asio::io_service::run, rpc_io_service));
 740         fRPCRunning = true;
 741     }
 742 }
 743
 744 void StopRPCThreads()
 745 {
 746     if (rpc_io_service == NULL) return;
 747     // Set this to false first, so that longpolling loops will exit when woken up
 748     fRPCRunning = false;
 749
 750     // First, cancel all timers and acceptors
 751     // This is not done automatically by ->stop(), and in some cases the destructor of
 752     // boost::asio::io_service can hang if this is skipped.
 753     boost::system::error_code ec;
 754     BOOST_FOREACH(const boost::shared_ptr<ip::tcp::acceptor> &acceptor, rpc_acceptors)
 755     {
 756         acceptor->cancel(ec);
 757         if (ec)
 758             LogPrintf("%s: Warning: %s when cancelling acceptor", __func__, ec.message());
 759     }
 760     rpc_acceptors.clear();
 761     BOOST_FOREACH(const PAIRTYPE(std::string, boost::shared_ptr<deadline_timer>) &timer, deadlineTimers)
 762     {
 763         timer.second->cancel(ec);
 764         if (ec)
 765             LogPrintf("%s: Warning: %s when cancelling timer", __func__, ec.message());
 766     }
 767     deadlineTimers.clear();
 768
 769     rpc_io_service->stop();
 770     g_rpcSignals.Stopped();
 771     if (rpc_worker_group != NULL)
 772         rpc_worker_group->join_all();
 773     delete rpc_dummy_work; rpc_dummy_work = NULL;
 774     delete rpc_worker_group; rpc_worker_group = NULL;
 775     delete rpc_ssl_context; rpc_ssl_context = NULL;
 776     delete rpc_io_service; rpc_io_service = NULL;
 777 }
 778
 779 bool IsRPCRunning()
 780 {
 781     return fRPCRunning;
 782 }
 783
 784 void SetRPCWarmupStatus(const std::string& newStatus)
 785 {
 786     LOCK(cs_rpcWarmup);
 787     rpcWarmupStatus = newStatus;
 788 }
 789
 790 void SetRPCWarmupFinished()
 791 {
 792     LOCK(cs_rpcWarmup);
 793     assert(fRPCInWarmup);
 794     fRPCInWarmup = false;
 795 }
 796
 797 bool RPCIsInWarmup(std::string *outStatus)
 798 {
 799     LOCK(cs_rpcWarmup);
 800     if (outStatus)
 801         *outStatus = rpcWarmupStatus;
 802     return fRPCInWarmup;
 803 }
 804
 805 void RPCRunHandler(const boost::system::error_code& err, boost::function<void(void)> func)
 806 {
 807     if (!err)
 808         func();
 809 }
 810
 811 void RPCRunLater(const std::string& name, boost::function<void(void)> func, int64_t nSeconds)
 812 {
 813     assert(rpc_io_service != NULL);
 814
 815     if (deadlineTimers.count(name) == 0)
 816     {
 817         deadlineTimers.insert(make_pair(name,
 818                                         boost::shared_ptr<deadline_timer>(new deadline_timer(*rpc_io_service))));
 819     }
 820     deadlineTimers[name]->expires_from_now(boost::posix_time::seconds(nSeconds));
 821     deadlineTimers[name]->async_wait(boost::bind(RPCRunHandler, _1, func));
 822 }
 823
 824 class JSONRequest
 825 {
 826 public:
 827     Value id;
 828     string strMethod;
 829     Array params;
 830
 831     JSONRequest() { id = Value::null; }
 832     void parse(const Value& valRequest);
 833 };
 834
 835 void JSONRequest::parse(const Value& valRequest)
 836 {
 837     // Parse request
 838     if (valRequest.type() != obj_type)
 839         throw JSONRPCError(RPC_INVALID_REQUEST, "Invalid Request object");
 840     const Object& request = valRequest.get_obj();
 841
 842     // Parse id now so errors from here on will have the id
 843     id = find_value(request, "id");
 844
 845     // Parse method
 846     Value valMethod = find_value(request, "method");
 847     if (valMethod.type() == null_type)
 848         throw JSONRPCError(RPC_INVALID_REQUEST, "Missing method");
 849     if (valMethod.type() != str_type)
 850         throw JSONRPCError(RPC_INVALID_REQUEST, "Method must be a string");
 851     strMethod = valMethod.get_str();
 852     if (strMethod != "getblocktemplate")
 853         LogPrint("rpc", "ThreadRPCServer method=%s\n", SanitizeString(strMethod));
 854
 855     // Parse params
 856     Value valParams = find_value(request, "params");
 857     if (valParams.type() == array_type)
 858         params = valParams.get_array();
 859     else if (valParams.type() == null_type)
 860         params = Array();
 861     else
 862         throw JSONRPCError(RPC_INVALID_REQUEST, "Params must be an array");
 863 }
 864
 865
 866 static Object JSONRPCExecOne(const Value& req)
 867 {
 868     Object rpc_result;
 869
 870     JSONRequest jreq;
 871     try {
 872         jreq.parse(req);
 873
 874         Value result = tableRPC.execute(jreq.strMethod, jreq.params);
 875         rpc_result = JSONRPCReplyObj(result, Value::null, jreq.id);
 876     }
 877     catch (const Object& objError)
 878     {
 879         rpc_result = JSONRPCReplyObj(Value::null, objError, jreq.id);
 880     }
 881     catch (const std::exception& e)
 882     {
 883         rpc_result = JSONRPCReplyObj(Value::null,
 884                                      JSONRPCError(RPC_PARSE_ERROR, e.what()), jreq.id);
 885     }
 886
 887     return rpc_result;
 888 }
 889
 890 static string JSONRPCExecBatch(const Array& vReq)
 891 {
 892     Array ret;
 893     for (unsigned int reqIdx = 0; reqIdx < vReq.size(); reqIdx++)
 894         ret.push_back(JSONRPCExecOne(vReq[reqIdx]));
 895
 896     return write_string(Value(ret), false) + "\n";
 897 }
 898
 899 static bool HTTPReq_JSONRPC(AcceptedConnection *conn,
 900                             string& strRequest,
 901                             map<string, string>& mapHeaders,
 902                             bool fRun)
 903 {
 904     // Check authorization
 905     if (mapHeaders.count("authorization") == 0)
 906     {
 907         conn->stream() << HTTPError(HTTP_UNAUTHORIZED, false) << std::flush;
 908         return false;
 909     }
 910
 911     if (!HTTPAuthorized(mapHeaders))
 912     {
 913         LogPrintf("ThreadRPCServer incorrect password attempt from %s\n", conn->peer_address_to_string());
 914         /* Deter brute-forcing
 915            We don't support exposing the RPC port, so this shouldn't result
 916            in a DoS. */
 917         MilliSleep(250);
 918
 919         conn->stream() << HTTPError(HTTP_UNAUTHORIZED, false) << std::flush;
 920         return false;
 921     }
 922
 923     JSONRequest jreq;
 924     try
 925     {
 926         // Parse request
 927         Value valRequest;
 928         if (!read_string(strRequest, valRequest))
 929             throw JSONRPCError(RPC_PARSE_ERROR, "Parse error");
 930
 931         // Return immediately if in warmup
 932         {
 933             LOCK(cs_rpcWarmup);
 934             if (fRPCInWarmup)
 935                 throw JSONRPCError(RPC_IN_WARMUP, rpcWarmupStatus);
 936         }
 937
 938         string strReply;
 939
 940         // singleton request
 941         if (valRequest.type() == obj_type) {
 942             jreq.parse(valRequest);
 943
 944             Value result = tableRPC.execute(jreq.strMethod, jreq.params);
 945
 946             // Send reply
 947             strReply = JSONRPCReply(result, Value::null, jreq.id);
 948
 949         // array of requests
 950         } else if (valRequest.type() == array_type)
 951             strReply = JSONRPCExecBatch(valRequest.get_array());
 952         else
 953             throw JSONRPCError(RPC_PARSE_ERROR, "Top-level object parse error");
 954
 955         conn->stream() << HTTPReplyHeader(HTTP_OK, fRun, strReply.size()) << strReply << std::flush;
 956     }
 957     catch (const Object& objError)
 958     {
 959         ErrorReply(conn->stream(), objError, jreq.id);
 960         return false;
 961     }
 962     catch (const std::exception& e)
 963     {
 964         ErrorReply(conn->stream(), JSONRPCError(RPC_PARSE_ERROR, e.what()), jreq.id);
 965         return false;
 966     }
 967     return true;
 968 }
 969
 970 void ServiceConnection(AcceptedConnection *conn)
 971 {
 972     bool fRun = true;
 973     while (fRun && !ShutdownRequested())
 974     {
 975         int nProto = 0;
 976         map<string, string> mapHeaders;
 977         string strRequest, strMethod, strURI;
 978
 979         // Read HTTP request line
 980         if (!ReadHTTPRequestLine(conn->stream(), nProto, strMethod, strURI))
 981             break;
 982
 983         // Read HTTP message headers and body
 984         ReadHTTPMessage(conn->stream(), mapHeaders, strRequest, nProto, MAX_SIZE);
 985
 986         // HTTP Keep-Alive is false; close connection immediately
 987         if ((mapHeaders["connection"] == "close") || (!GetBoolArg("-rpckeepalive", true)))
 988             fRun = false;
 989
 990         // Process via JSON-RPC API
 991         if (strURI == "/") {
 992             if (!HTTPReq_JSONRPC(conn, strRequest, mapHeaders, fRun))
 993                 break;
 994
 995         // Process via HTTP REST API
 996         } else if (strURI.substr(0, 6) == "/rest/" && GetBoolArg("-rest", false)) {
 997             if (!HTTPReq_REST(conn, strURI, strRequest, mapHeaders, fRun))
 998                 break;
 999
1000         } else {
1001             conn->stream() << HTTPError(HTTP_NOT_FOUND, false) << std::flush;
1002             break;
1003         }
1004     }
1005 }
1006
1007 json_spirit::Value CRPCTable::execute(const std::string &strMethod, const json_spirit::Array &params) const
1008 {
1009     // Find method
1010     const CRPCCommand *pcmd = tableRPC[strMethod];
1011     if (!pcmd)
1012         throw JSONRPCError(RPC_METHOD_NOT_FOUND, "Method not found");
1013
1014     g_rpcSignals.PreCommand(*pcmd);
1015
1016     try
1017     {
1018         // Execute
1019         return pcmd->actor(params, false);
1020     }
1021     catch (const std::exception& e)
1022     {
1023         throw JSONRPCError(RPC_MISC_ERROR, e.what());
1024     }
1025
1026     g_rpcSignals.PostCommand(*pcmd);
1027 }
1028
1029 std::string HelpExampleCli(string methodname, string args){
1030     return "> bitcoin-cli " + methodname + " " + args + "\n";
1031 }
1032
1033 std::string HelpExampleRpc(string methodname, string args){
1034     return "> curl --user myusername --data-binary '{\"jsonrpc\": \"1.0\", \"id\":\"curltest\", "
1035         "\"method\": \"" + methodname + "\", \"params\": [" + args + "] }' -H 'content-type: text/plain;' http://127.0.0.1:8332/\n";
1036 }
1037
1038 const CRPCTable tableRPC;