mirror of
https://github.com/dashpay/dash.git
synced 2024-12-29 13:59:06 +01:00
dd6b9ad20f
e7156ad[RPC] pass HTTP basic authentication username to the JSONRequest object (Jonas Schnelli)69d1c25[RPC] Give RPC commands more information about the RPC request (Jonas Schnelli)23c32a9rpc: Change JSONRPCRequest to JSONRPCRequestObj (Wladimir J. van der Laan)
131 lines
3.8 KiB
C++
131 lines
3.8 KiB
C++
// Copyright (c) 2010 Satoshi Nakamoto
|
|
// Copyright (c) 2009-2015 The Bitcoin Core developers
|
|
// Copyright (c) 2014-2017 The Dash Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
#include "rpc/protocol.h"
|
|
|
|
#include "random.h"
|
|
#include "tinyformat.h"
|
|
#include "util.h"
|
|
#include "utilstrencodings.h"
|
|
#include "utiltime.h"
|
|
#include "version.h"
|
|
|
|
#include <stdint.h>
|
|
#include <fstream>
|
|
|
|
using namespace std;
|
|
|
|
/**
|
|
* JSON-RPC protocol. Bitcoin speaks version 1.0 for maximum compatibility,
|
|
* but uses JSON-RPC 1.1/2.0 standards for parts of the 1.0 standard that were
|
|
* unspecified (HTTP errors and contents of 'error').
|
|
*
|
|
* 1.0 spec: http://json-rpc.org/wiki/specification
|
|
* 1.2 spec: http://jsonrpc.org/historical/json-rpc-over-http.html
|
|
*/
|
|
|
|
UniValue JSONRPCRequestObj(const string& strMethod, const UniValue& params, const UniValue& id)
|
|
{
|
|
UniValue request(UniValue::VOBJ);
|
|
request.push_back(Pair("method", strMethod));
|
|
request.push_back(Pair("params", params));
|
|
request.push_back(Pair("id", id));
|
|
return request;
|
|
}
|
|
|
|
UniValue JSONRPCReplyObj(const UniValue& result, const UniValue& error, const UniValue& id)
|
|
{
|
|
UniValue reply(UniValue::VOBJ);
|
|
if (!error.isNull())
|
|
reply.push_back(Pair("result", NullUniValue));
|
|
else
|
|
reply.push_back(Pair("result", result));
|
|
reply.push_back(Pair("error", error));
|
|
reply.push_back(Pair("id", id));
|
|
return reply;
|
|
}
|
|
|
|
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 string& message)
|
|
{
|
|
UniValue error(UniValue::VOBJ);
|
|
error.push_back(Pair("code", code));
|
|
error.push_back(Pair("message", message));
|
|
return error;
|
|
}
|
|
|
|
/** Username used when cookie authentication is in use (arbitrary, only for
|
|
* recognizability in debugging/logging purposes)
|
|
*/
|
|
static const std::string COOKIEAUTH_USER = "__cookie__";
|
|
/** Default name for auth cookie file */
|
|
static const std::string COOKIEAUTH_FILE = ".cookie";
|
|
|
|
boost::filesystem::path GetAuthCookieFile()
|
|
{
|
|
boost::filesystem::path path(GetArg("-rpccookiefile", COOKIEAUTH_FILE));
|
|
if (!path.is_complete()) path = GetDataDir() / path;
|
|
return path;
|
|
}
|
|
|
|
bool GenerateAuthCookie(std::string *cookie_out)
|
|
{
|
|
const size_t COOKIE_SIZE = 32;
|
|
unsigned char rand_pwd[COOKIE_SIZE];
|
|
GetRandBytes(rand_pwd, COOKIE_SIZE);
|
|
|
|
std::string cookie = COOKIEAUTH_USER + ":" + HexStr(rand_pwd, rand_pwd+COOKIE_SIZE);
|
|
|
|
/** the umask determines what permissions are used to create this file -
|
|
* these are set to 077 in init.cpp unless overridden with -sysperms.
|
|
*/
|
|
std::ofstream file;
|
|
boost::filesystem::path filepath = GetAuthCookieFile();
|
|
file.open(filepath.string().c_str());
|
|
if (!file.is_open()) {
|
|
LogPrintf("Unable to open cookie authentication file %s for writing\n", filepath.string());
|
|
return false;
|
|
}
|
|
file << cookie;
|
|
file.close();
|
|
LogPrintf("Generated RPC authentication cookie %s\n", filepath.string());
|
|
|
|
if (cookie_out)
|
|
*cookie_out = cookie;
|
|
return true;
|
|
}
|
|
|
|
bool GetAuthCookie(std::string *cookie_out)
|
|
{
|
|
std::ifstream file;
|
|
std::string cookie;
|
|
boost::filesystem::path filepath = GetAuthCookieFile();
|
|
file.open(filepath.string().c_str());
|
|
if (!file.is_open())
|
|
return false;
|
|
std::getline(file, cookie);
|
|
file.close();
|
|
|
|
if (cookie_out)
|
|
*cookie_out = cookie;
|
|
return true;
|
|
}
|
|
|
|
void DeleteAuthCookie()
|
|
{
|
|
try {
|
|
boost::filesystem::remove(GetAuthCookieFile());
|
|
} catch (const boost::filesystem::filesystem_error& e) {
|
|
LogPrintf("%s: Unable to remove random auth cookie file: %s\n", __func__, e.what());
|
|
}
|
|
}
|
|
|