request.cpp

Go to the documentation of this file.

// Copyright (c) 2018-2019 The Bitcoin developers
// Copyright (c) 2009-2019 The Bitcoin Core developers
// Distributed under the MIT software license, see the accompanying
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
 
#include <rpc/request.h>
 
#include <common/args.h>
#include <logging.h>
#include <random.h>
#include <rpc/protocol.h>
#include <util/fs.h>
#include <util/fs_helpers.h>
#include <util/strencodings.h>
 
#include <fstream>
#include <stdexcept>
#include <string>
#include <vector>
 
UniValue JSONRPCRequestObj(const std::string &strMethod, const UniValue &params,
                           const UniValue &id) {
    UniValue request(UniValue::VOBJ);
    request.pushKV("method", strMethod);
    request.pushKV("params", params);
    request.pushKV("id", id);
    return request;
}
 
UniValue JSONRPCReplyObj(const UniValue &result, const UniValue &error,
                         const UniValue &id) {
    UniValue reply(UniValue::VOBJ);
    if (!error.isNull()) {
        reply.pushKV("result", NullUniValue);
    } else {
        reply.pushKV("result", result);
    }
    reply.pushKV("error", error);
    reply.pushKV("id", id);
    return reply;
}
 
std::string JSONRPCReply(const UniValue &result, const UniValue &error,
                         const UniValue &id) {
    UniValue reply = JSONRPCReplyObj(result, error, id);
    return reply.write() + "\n";
}
 
UniValue JSONRPCError(int code, const std::string &message) {
    UniValue error(UniValue::VOBJ);
    error.pushKV("code", code);
    error.pushKV("message", message);
    return error;
}
 
static const std::string COOKIEAUTH_USER = "__cookie__";
static const char *const COOKIEAUTH_FILE = ".cookie";
 
static fs::path GetAuthCookieFile(bool temp = false) {
    fs::path arg = gArgs.GetPathArg("-rpccookiefile", COOKIEAUTH_FILE);
    if (temp) {
        arg += ".tmp";
    }
    return AbsPathForConfigVal(gArgs, arg);
}
 
bool GenerateAuthCookie(std::string *cookie_out) {
    const size_t COOKIE_SIZE = 32;
    uint8_t rand_pwd[COOKIE_SIZE];
    GetRandBytes(rand_pwd);
    std::string cookie = COOKIEAUTH_USER + ":" + HexStr(rand_pwd);
 
    std::ofstream file;
    fs::path filepath_tmp = GetAuthCookieFile(true);
    file.open(filepath_tmp);
    if (!file.is_open()) {
        LogPrintf("Unable to open cookie authentication file %s for writing\n",
                  fs::PathToString(filepath_tmp));
        return false;
    }
    file << cookie;
    file.close();
 
    fs::path filepath = GetAuthCookieFile(false);
    if (!RenameOver(filepath_tmp, filepath)) {
        LogPrintf("Unable to rename cookie authentication file %s to %s\n",
                  fs::PathToString(filepath_tmp), fs::PathToString(filepath));
        return false;
    }
    LogPrintf("Generated RPC authentication cookie %s\n",
              fs::PathToString(filepath));
 
    if (cookie_out) {
        *cookie_out = cookie;
    }
    return true;
}
 
bool GetAuthCookie(std::string *cookie_out) {
    std::ifstream file;
    std::string cookie;
    fs::path filepath = GetAuthCookieFile();
    file.open(filepath);
    if (!file.is_open()) {
        return false;
    }
    std::getline(file, cookie);
    file.close();
 
    if (cookie_out) {
        *cookie_out = cookie;
    }
    return true;
}
 
void DeleteAuthCookie() {
    try {
        fs::remove(GetAuthCookieFile());
    } catch (const fs::filesystem_error &e) {
        LogPrintf("%s: Unable to remove random auth cookie file: %s\n",
                  __func__, fsbridge::get_filesystem_error_message(e));
    }
}
 
std::vector<UniValue> JSONRPCProcessBatchReply(const UniValue &in) {
    if (!in.isArray()) {
        throw std::runtime_error("Batch must be an array");
    }
    const size_t num{in.size()};
    std::vector<UniValue> batch(num);
    for (const UniValue &rec : in.getValues()) {
        if (!rec.isObject()) {
            throw std::runtime_error("Batch member must be an object");
        }
        size_t id = rec["id"].getInt<int>();
        if (id >= num) {
            throw std::runtime_error(
                "Batch member id is larger than batch size");
        }
        batch[id] = rec;
    }
    return batch;
}
 
void JSONRPCRequest::parse(const UniValue &valRequest) {
    // Parse request
    if (!valRequest.isObject()) {
        throw JSONRPCError(RPC_INVALID_REQUEST, "Invalid Request object");
    }
 
    const UniValue &request = valRequest.get_obj();
 
    // Parse id now so errors from here on will have the id
    id = request.find_value("id");
 
    // Parse method
    const UniValue &valMethod{request.find_value("method")};
    if (valMethod.isNull()) {
        throw JSONRPCError(RPC_INVALID_REQUEST, "Missing method");
    }
    if (!valMethod.isStr()) {
        throw JSONRPCError(RPC_INVALID_REQUEST, "Method must be a string");
    }
    strMethod = valMethod.get_str();
    if (fLogIPs) {
        LogPrint(BCLog::RPC, "ThreadRPCServer method=%s user=%s peeraddr=%s\n",
                 SanitizeString(strMethod), this->authUser, this->peerAddr);
    } else {
        LogPrint(BCLog::RPC, "ThreadRPCServer method=%s user=%s\n",
                 SanitizeString(strMethod), this->authUser);
    }
 
    // Parse params
    const UniValue &valParams{request.find_value("params")};
    if (valParams.isArray() || valParams.isObject()) {
        params = valParams;
    } else if (valParams.isNull()) {
        params = UniValue(UniValue::VARR);
    } else {
        throw JSONRPCError(RPC_INVALID_REQUEST,
                           "Params must be an array or object");
    }
}