Branch data Line data Source code
1 : : // Copyright (c) 2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-2022 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 <rpc/request.h>
7 : :
8 : : #include <common/args.h>
9 : : #include <logging.h>
10 : : #include <random.h>
11 : : #include <rpc/protocol.h>
12 : : #include <util/fs.h>
13 : : #include <util/fs_helpers.h>
14 : : #include <util/strencodings.h>
15 : :
16 : : #include <fstream>
17 : : #include <stdexcept>
18 : : #include <string>
19 : : #include <vector>
20 : :
21 : : /**
22 : : * JSON-RPC protocol. Bitcoin speaks version 1.0 for maximum compatibility,
23 : : * but uses JSON-RPC 1.1/2.0 standards for parts of the 1.0 standard that were
24 : : * unspecified (HTTP errors and contents of 'error').
25 : : *
26 : : * 1.0 spec: http://json-rpc.org/wiki/specification
27 : : * 1.2 spec: http://jsonrpc.org/historical/json-rpc-over-http.html
28 : : *
29 : : * If the server receives a request with the JSON-RPC 2.0 marker `{"jsonrpc": "2.0"}`
30 : : * then Bitcoin will respond with a strictly specified response.
31 : : * It will only return an HTTP error code if an actual HTTP error is encountered
32 : : * such as the endpoint is not found (404) or the request is not formatted correctly (500).
33 : : * Otherwise the HTTP code is always OK (200) and RPC errors will be included in the
34 : : * response body.
35 : : *
36 : : * 2.0 spec: https://www.jsonrpc.org/specification
37 : : *
38 : : * Also see http://www.simple-is-better.org/rpc/#differences-between-1-0-and-2-0
39 : : */
40 : :
41 : 843 : UniValue JSONRPCRequestObj(const std::string& strMethod, const UniValue& params, const UniValue& id)
42 : : {
43 : 843 : UniValue request(UniValue::VOBJ);
44 [ + - + - : 1686 : request.pushKV("method", strMethod);
+ - ]
45 [ + - + - : 1686 : request.pushKV("params", params);
+ - ]
46 [ + - + - : 1686 : request.pushKV("id", id);
+ - ]
47 [ + - + - : 1686 : request.pushKV("jsonrpc", "2.0");
+ - ]
48 : 843 : return request;
49 : 0 : }
50 : :
51 : 201321 : UniValue JSONRPCReplyObj(UniValue result, UniValue error, std::optional<UniValue> id, JSONRPCVersion jsonrpc_version)
52 : : {
53 : 201321 : UniValue reply(UniValue::VOBJ);
54 : : // Add JSON-RPC version number field in v2 only.
55 [ + + + - : 402492 : if (jsonrpc_version == JSONRPCVersion::V2) reply.pushKV("jsonrpc", "2.0");
+ - + - ]
56 : :
57 : : // Add both result and error fields in v1, even though one will be null.
58 : : // Omit the null field in v2.
59 [ + + ]: 201321 : if (error.isNull()) {
60 [ + - + - ]: 389310 : reply.pushKV("result", std::move(result));
61 [ + + + - : 194785 : if (jsonrpc_version == JSONRPCVersion::V1_LEGACY) reply.pushKV("error", NullUniValue);
+ - + - ]
62 : : } else {
63 [ + + + - : 6686 : if (jsonrpc_version == JSONRPCVersion::V1_LEGACY) reply.pushKV("result", NullUniValue);
+ - + - ]
64 [ + - + - ]: 13332 : reply.pushKV("error", std::move(error));
65 : : }
66 [ + + + - : 402610 : if (id.has_value()) reply.pushKV("id", std::move(id.value()));
+ - ]
67 : 201321 : return reply;
68 : 0 : }
69 : :
70 : 6732 : UniValue JSONRPCError(int code, const std::string& message)
71 : : {
72 : 6732 : UniValue error(UniValue::VOBJ);
73 [ + - + - : 13464 : error.pushKV("code", code);
+ - ]
74 [ + - + - : 13464 : error.pushKV("message", message);
+ - ]
75 : 6732 : return error;
76 : 0 : }
77 : :
78 : : /** Username used when cookie authentication is in use (arbitrary, only for
79 : : * recognizability in debugging/logging purposes)
80 : : */
81 : : static const std::string COOKIEAUTH_USER = "__cookie__";
82 : : /** Default name for auth cookie file */
83 : : static const char* const COOKIEAUTH_FILE = ".cookie";
84 : :
85 : : /** Get name of RPC authentication cookie file */
86 : 3782 : static fs::path GetAuthCookieFile(bool temp=false)
87 : : {
88 [ + - + - ]: 7564 : fs::path arg = gArgs.GetPathArg("-rpccookiefile", COOKIEAUTH_FILE);
89 [ + + ]: 3782 : if (arg.empty()) {
90 : 1 : return {}; // -norpccookiefile was specified
91 : : }
92 [ + + ]: 3781 : if (temp) {
93 [ + - ]: 1001 : arg += ".tmp";
94 : : }
95 [ + - ]: 3781 : return AbsPathForConfigVal(gArgs, arg);
96 : 3782 : }
97 : :
98 : : static bool g_generated_cookie = false;
99 : :
100 : 1002 : bool GenerateAuthCookie(std::string* cookie_out, std::optional<fs::perms> cookie_perms)
101 : : {
102 : 1002 : const size_t COOKIE_SIZE = 32;
103 : 1002 : unsigned char rand_pwd[COOKIE_SIZE];
104 : 1002 : GetRandBytes(rand_pwd);
105 [ + - + - ]: 2004 : std::string cookie = COOKIEAUTH_USER + ":" + HexStr(rand_pwd);
106 : :
107 : : /** the umask determines what permissions are used to create this file -
108 : : * these are set to 0077 in common/system.cpp.
109 : : */
110 [ + - ]: 1002 : std::ofstream file;
111 [ + - ]: 1002 : fs::path filepath_tmp = GetAuthCookieFile(true);
112 [ + + ]: 1002 : if (filepath_tmp.empty()) {
113 : : return true; // -norpccookiefile
114 : : }
115 [ + - ]: 1001 : file.open(filepath_tmp);
116 [ + + ]: 1001 : if (!file.is_open()) {
117 [ + - + - ]: 2 : LogWarning("Unable to open cookie authentication file %s for writing", fs::PathToString(filepath_tmp));
118 : 1 : return false;
119 : : }
120 [ + - ]: 1000 : file << cookie;
121 [ + - ]: 1000 : file.close();
122 : :
123 [ + - ]: 1000 : fs::path filepath = GetAuthCookieFile(false);
124 [ + - + - : 3000 : if (!RenameOver(filepath_tmp, filepath)) {
+ - - + ]
125 [ # # # # : 0 : LogWarning("Unable to rename cookie authentication file %s to %s", fs::PathToString(filepath_tmp), fs::PathToString(filepath));
# # ]
126 : 0 : return false;
127 : : }
128 [ + + ]: 1000 : if (cookie_perms) {
129 : 3 : std::error_code code;
130 : 3 : fs::permissions(filepath, cookie_perms.value(), fs::perm_options::replace, code);
131 [ - + ]: 3 : if (code) {
132 [ # # # # ]: 0 : LogWarning("Unable to set permissions on cookie authentication file %s", fs::PathToString(filepath));
133 : 0 : return false;
134 : : }
135 : : }
136 : :
137 : 1000 : g_generated_cookie = true;
138 [ + - + - ]: 2000 : LogInfo("Generated RPC authentication cookie %s\n", fs::PathToString(filepath));
139 [ + - + - : 1000 : LogInfo("Permissions used for cookie: %s\n", PermsToSymbolicString(fs::status(filepath).permissions()));
+ - ]
140 : :
141 [ + - ]: 1000 : if (cookie_out)
142 [ + - ]: 2000 : *cookie_out = cookie;
143 : : return true;
144 : 2002 : }
145 : :
146 : 780 : bool GetAuthCookie(std::string *cookie_out)
147 : : {
148 : 780 : std::ifstream file;
149 [ + - ]: 780 : std::string cookie;
150 [ + - ]: 780 : fs::path filepath = GetAuthCookieFile();
151 [ + - ]: 780 : if (filepath.empty()) {
152 : : return true; // -norpccookiefile
153 : : }
154 [ + - ]: 780 : file.open(filepath);
155 [ + + ]: 780 : if (!file.is_open())
156 : : return false;
157 [ + - ]: 766 : std::getline(file, cookie);
158 [ + - ]: 766 : file.close();
159 : :
160 [ + - ]: 766 : if (cookie_out)
161 [ + - ]: 1546 : *cookie_out = cookie;
162 : : return true;
163 : 780 : }
164 : :
165 : 1037 : void DeleteAuthCookie()
166 : : {
167 : 1037 : try {
168 [ + + ]: 1037 : if (g_generated_cookie) {
169 : : // Delete the cookie file if it was generated by this process
170 [ + - + - ]: 2000 : fs::remove(GetAuthCookieFile());
171 : : }
172 [ - - ]: 0 : } catch (const fs::filesystem_error& e) {
173 [ - - - - ]: 0 : LogPrintf("%s: Unable to remove random auth cookie file: %s\n", __func__, fsbridge::get_filesystem_error_message(e));
174 : 0 : }
175 : 1037 : }
176 : :
177 : 19 : std::vector<UniValue> JSONRPCProcessBatchReply(const UniValue& in)
178 : : {
179 [ - + ]: 19 : if (!in.isArray()) {
180 [ # # ]: 0 : throw std::runtime_error("Batch must be an array");
181 : : }
182 : 19 : const size_t num {in.size()};
183 : 19 : std::vector<UniValue> batch(num);
184 [ + - + + ]: 95 : for (const UniValue& rec : in.getValues()) {
185 [ - + ]: 76 : if (!rec.isObject()) {
186 [ # # ]: 0 : throw std::runtime_error("Batch member must be an object");
187 : : }
188 [ + - + - : 76 : size_t id = rec["id"].getInt<int>();
+ - ]
189 [ - + ]: 76 : if (id >= num) {
190 [ # # ]: 0 : throw std::runtime_error("Batch member id is larger than batch size");
191 : : }
192 [ + - ]: 76 : batch[id] = rec;
193 : : }
194 : 19 : return batch;
195 : 0 : }
196 : :
197 : 201298 : void JSONRPCRequest::parse(const UniValue& valRequest)
198 : : {
199 : : // Parse request
200 [ - + ]: 201298 : if (!valRequest.isObject())
201 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_REQUEST, "Invalid Request object");
202 : 201298 : const UniValue& request = valRequest.get_obj();
203 : :
204 : : // Parse id now so errors from here on will have the id
205 [ + + ]: 402596 : if (request.exists("id")) {
206 : 201261 : id = request.find_value("id");
207 : : } else {
208 : 37 : id = std::nullopt;
209 : : }
210 : :
211 : : // Check for JSON-RPC 2.0 (default 1.1)
212 : 201298 : m_json_version = JSONRPCVersion::V1_LEGACY;
213 : 201298 : const UniValue& jsonrpc_version = request.find_value("jsonrpc");
214 [ + + ]: 201298 : if (!jsonrpc_version.isNull()) {
215 [ + + ]: 201155 : if (!jsonrpc_version.isStr()) {
216 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_REQUEST, "jsonrpc field must be a string");
217 : : }
218 : : // The "jsonrpc" key was added in the 2.0 spec, but some older documentation
219 : : // incorrectly included {"jsonrpc":"1.0"} in a request object, so we
220 : : // maintain that for backwards compatibility.
221 [ + + ]: 201154 : if (jsonrpc_version.get_str() == "1.0") {
222 : 4 : m_json_version = JSONRPCVersion::V1_LEGACY;
223 [ + + ]: 201150 : } else if (jsonrpc_version.get_str() == "2.0") {
224 : 201145 : m_json_version = JSONRPCVersion::V2;
225 : : } else {
226 [ + - + - ]: 10 : throw JSONRPCError(RPC_INVALID_REQUEST, "JSON-RPC version not supported");
227 : : }
228 : : }
229 : :
230 : : // Parse method
231 : 201292 : const UniValue& valMethod{request.find_value("method")};
232 [ + + ]: 201292 : if (valMethod.isNull())
233 [ + - + - ]: 16 : throw JSONRPCError(RPC_INVALID_REQUEST, "Missing method");
234 [ - + ]: 201284 : if (!valMethod.isStr())
235 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_REQUEST, "Method must be a string");
236 : 201284 : strMethod = valMethod.get_str();
237 [ + + ]: 201284 : if (fLogIPs)
238 [ + - + - ]: 58 : LogDebug(BCLog::RPC, "ThreadRPCServer method=%s user=%s peeraddr=%s\n", SanitizeString(strMethod),
239 : : this->authUser, this->peerAddr);
240 : : else
241 [ + - + - ]: 402510 : LogDebug(BCLog::RPC, "ThreadRPCServer method=%s user=%s\n", SanitizeString(strMethod), this->authUser);
242 : :
243 : : // Parse params
244 : 201284 : const UniValue& valParams{request.find_value("params")};
245 [ + + + + ]: 201284 : if (valParams.isArray() || valParams.isObject())
246 : 201167 : params = valParams;
247 [ + - ]: 117 : else if (valParams.isNull())
248 : 117 : params = UniValue(UniValue::VARR);
249 : : else
250 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_REQUEST, "Params must be an array or object");
251 : 201284 : }
|
