Branch data Line data Source code
1 : : // Copyright (c) 2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present 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: https://www.jsonrpc.org/specification_v1
27 : : * 1.2 spec: https://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 https://www.simple-is-better.org/rpc/#differences-between-1-0-and-2-0
39 : : */
40 : :
41 : 1005 : UniValue JSONRPCRequestObj(const std::string& strMethod, const UniValue& params, const UniValue& id)
42 : : {
43 : 1005 : UniValue request(UniValue::VOBJ);
44 [ + - + - : 2010 : request.pushKV("method", strMethod);
+ - ]
45 [ + - + - : 2010 : request.pushKV("params", params);
+ - ]
46 [ + - + - : 2010 : request.pushKV("id", id);
+ - ]
47 [ + - + - : 2010 : request.pushKV("jsonrpc", "2.0");
+ - ]
48 : 1005 : return request;
49 : 0 : }
50 : :
51 : 215398 : UniValue JSONRPCReplyObj(UniValue result, UniValue error, std::optional<UniValue> id, JSONRPCVersion jsonrpc_version)
52 : : {
53 : 215398 : UniValue reply(UniValue::VOBJ);
54 : : // Add JSON-RPC version number field in v2 only.
55 [ + + + - : 429616 : 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 [ + + ]: 215398 : if (error.isNull()) {
60 [ + - + - ]: 418452 : reply.pushKV("result", std::move(result));
61 [ + + + - : 210386 : if (jsonrpc_version == JSONRPCVersion::V1_LEGACY) reply.pushKV("error", NullUniValue);
+ - + - ]
62 : : } else {
63 [ + + + - : 6192 : if (jsonrpc_version == JSONRPCVersion::V1_LEGACY) reply.pushKV("result", NullUniValue);
+ - + - ]
64 [ + - + - ]: 12344 : reply.pushKV("error", std::move(error));
65 : : }
66 [ + + + - : 429734 : if (id.has_value()) reply.pushKV("id", std::move(id.value()));
+ - ]
67 : 215398 : return reply;
68 : 0 : }
69 : :
70 : 6244 : UniValue JSONRPCError(int code, const std::string& message)
71 : : {
72 : 6244 : UniValue error(UniValue::VOBJ);
73 [ + - + - : 12488 : error.pushKV("code", code);
+ - ]
74 [ + - + - : 12488 : error.pushKV("message", message);
+ - ]
75 : 6244 : 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 : 4397 : static fs::path GetAuthCookieFile(bool temp=false)
87 : : {
88 [ + - + - ]: 8794 : fs::path arg = gArgs.GetPathArg("-rpccookiefile", COOKIEAUTH_FILE);
89 [ + + ]: 4397 : if (arg.empty()) {
90 : 1 : return {}; // -norpccookiefile was specified
91 : : }
92 [ + + ]: 4396 : if (temp) {
93 [ + - ]: 1135 : arg += ".tmp";
94 : : }
95 [ + - ]: 4396 : return AbsPathForConfigVal(gArgs, arg);
96 : 4397 : }
97 : :
98 : : static bool g_generated_cookie = false;
99 : :
100 : 1136 : AuthCookieResult GenerateAuthCookie(const std::optional<fs::perms>& cookie_perms,
101 : : std::string& user,
102 : : std::string& pass)
103 : : {
104 : 1136 : const size_t COOKIE_SIZE = 32;
105 : 1136 : unsigned char rand_pwd[COOKIE_SIZE];
106 : 1136 : GetRandBytes(rand_pwd);
107 : 1136 : const std::string rand_pwd_hex{HexStr(rand_pwd)};
108 : :
109 : : /** the umask determines what permissions are used to create this file -
110 : : * these are set to 0077 in common/system.cpp.
111 : : */
112 [ + - ]: 1136 : std::ofstream file;
113 [ + - ]: 1136 : fs::path filepath_tmp = GetAuthCookieFile(true);
114 [ + + ]: 1136 : if (filepath_tmp.empty()) {
115 : : return AuthCookieResult::Disabled; // -norpccookiefile
116 : : }
117 [ + - ]: 1135 : file.open(filepath_tmp.std_path());
118 [ + + ]: 1135 : if (!file.is_open()) {
119 [ - + + - ]: 2 : LogWarning("Unable to open cookie authentication file %s for writing", fs::PathToString(filepath_tmp));
120 : 1 : return AuthCookieResult::Error;
121 : : }
122 [ - + + - : 2268 : file << COOKIEAUTH_USER << ":" << rand_pwd_hex;
- + ]
123 [ + - ]: 1134 : file.close();
124 : :
125 [ + - ]: 1134 : fs::path filepath = GetAuthCookieFile(false);
126 [ + - + - : 3402 : if (!RenameOver(filepath_tmp, filepath)) {
+ - - + ]
127 [ # # # # : 0 : LogWarning("Unable to rename cookie authentication file %s to %s", fs::PathToString(filepath_tmp), fs::PathToString(filepath));
# # ]
128 : 0 : return AuthCookieResult::Error;
129 : : }
130 [ + + ]: 1134 : if (cookie_perms) {
131 [ + - ]: 3 : std::error_code code;
132 [ + - ]: 3 : fs::permissions(filepath, cookie_perms.value(), fs::perm_options::replace, code);
133 [ - + ]: 3 : if (code) {
134 [ # # # # ]: 0 : LogWarning("Unable to set permissions on cookie authentication file %s", fs::PathToString(filepath));
135 : 0 : return AuthCookieResult::Error;
136 : : }
137 : : }
138 : :
139 : 1134 : g_generated_cookie = true;
140 [ - + + - ]: 2268 : LogInfo("Generated RPC authentication cookie %s\n", fs::PathToString(filepath));
141 [ + - + - : 1134 : LogInfo("Permissions used for cookie: %s\n", PermsToSymbolicString(fs::status(filepath).permissions()));
+ - ]
142 : :
143 [ + - ]: 1134 : user = COOKIEAUTH_USER;
144 [ + - ]: 2268 : pass = rand_pwd_hex;
145 : : return AuthCookieResult::Ok;
146 : 2270 : }
147 : :
148 : 993 : AuthCookieResult GetAuthCookie(std::string& cookie_out)
149 : : {
150 : 993 : std::ifstream file;
151 [ + - ]: 993 : fs::path filepath = GetAuthCookieFile();
152 [ + - ]: 993 : if (filepath.empty()) {
153 : : return AuthCookieResult::Disabled; // -norpccookiefile
154 : : }
155 [ + - ]: 993 : file.open(filepath.std_path());
156 [ + - ]: 993 : if (!file.is_open()) {
157 : : return AuthCookieResult::Error;
158 : : }
159 [ + - ]: 993 : std::getline(file, cookie_out);
160 [ + - ]: 993 : file.close();
161 : : return AuthCookieResult::Ok;
162 : 993 : }
163 : :
164 : 1178 : void DeleteAuthCookie()
165 : : {
166 : 1178 : try {
167 [ + + ]: 1178 : if (g_generated_cookie) {
168 : : // Delete the cookie file if it was generated by this process
169 [ + - + - ]: 2268 : fs::remove(GetAuthCookieFile());
170 : : }
171 [ - - ]: 0 : } catch (const fs::filesystem_error& e) {
172 [ - - - - : 0 : LogWarning("Unable to remove random auth cookie file %s: %s\n", fs::PathToString(e.path1()), e.code().message());
- - - - ]
173 : 0 : }
174 : 1178 : }
175 : :
176 : 0 : std::vector<UniValue> JSONRPCProcessBatchReply(const UniValue& in)
177 : : {
178 [ # # ]: 0 : if (!in.isArray()) {
179 [ # # ]: 0 : throw std::runtime_error("Batch must be an array");
180 : : }
181 [ # # ]: 0 : const size_t num {in.size()};
182 : 0 : std::vector<UniValue> batch(num);
183 [ # # # # ]: 0 : for (const UniValue& rec : in.getValues()) {
184 [ # # ]: 0 : if (!rec.isObject()) {
185 [ # # ]: 0 : throw std::runtime_error("Batch member must be an object");
186 : : }
187 [ # # # # : 0 : size_t id = rec["id"].getInt<int>();
# # ]
188 [ # # ]: 0 : if (id >= num) {
189 [ # # ]: 0 : throw std::runtime_error("Batch member id is larger than batch size");
190 : : }
191 [ # # ]: 0 : batch[id] = rec;
192 : : }
193 : 0 : return batch;
194 : 0 : }
195 : :
196 : 215407 : void JSONRPCRequest::parse(const UniValue& valRequest)
197 : : {
198 : : // Parse request
199 [ - + ]: 215407 : if (!valRequest.isObject())
200 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_REQUEST, "Invalid Request object");
201 : 215407 : const UniValue& request = valRequest.get_obj();
202 : :
203 : : // Parse id now so errors from here on will have the id
204 [ + + ]: 430814 : if (request.exists("id")) {
205 : 214334 : id = request.find_value("id");
206 : : } else {
207 : 1073 : id = std::nullopt;
208 : : }
209 : :
210 : : // Check for JSON-RPC 2.0 (default 1.1)
211 : 215407 : m_json_version = JSONRPCVersion::V1_LEGACY;
212 : 215407 : const UniValue& jsonrpc_version = request.find_value("jsonrpc");
213 [ + + ]: 215407 : if (!jsonrpc_version.isNull()) {
214 [ + + ]: 214228 : if (!jsonrpc_version.isStr()) {
215 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_REQUEST, "jsonrpc field must be a string");
216 : : }
217 : : // The "jsonrpc" key was added in the 2.0 spec, but some older documentation
218 : : // incorrectly included {"jsonrpc":"1.0"} in a request object, so we
219 : : // maintain that for backwards compatibility.
220 [ + + ]: 214227 : if (jsonrpc_version.get_str() == "1.0") {
221 : 4 : m_json_version = JSONRPCVersion::V1_LEGACY;
222 [ + + ]: 214223 : } else if (jsonrpc_version.get_str() == "2.0") {
223 : 214218 : m_json_version = JSONRPCVersion::V2;
224 : : } else {
225 [ + - + - ]: 10 : throw JSONRPCError(RPC_INVALID_REQUEST, "JSON-RPC version not supported");
226 : : }
227 : : }
228 : :
229 : : // Parse method
230 : 215401 : const UniValue& valMethod{request.find_value("method")};
231 [ + + ]: 215401 : if (valMethod.isNull())
232 [ + - + - ]: 16 : throw JSONRPCError(RPC_INVALID_REQUEST, "Missing method");
233 [ - + ]: 215393 : if (!valMethod.isStr())
234 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_REQUEST, "Method must be a string");
235 : 215393 : strMethod = valMethod.get_str();
236 [ + + ]: 215393 : if (fLogIPs)
237 [ + - - + : 64 : LogDebug(BCLog::RPC, "ThreadRPCServer method=%s user=%s peeraddr=%s\n", SanitizeString(strMethod),
+ - ]
238 : : this->authUser, this->peerAddr);
239 : : else
240 [ + - - + : 430722 : LogDebug(BCLog::RPC, "ThreadRPCServer method=%s user=%s\n", SanitizeString(strMethod), this->authUser);
+ - ]
241 : :
242 : : // Parse params
243 : 215393 : const UniValue& valParams{request.find_value("params")};
244 [ + + + + ]: 215393 : if (valParams.isArray() || valParams.isObject())
245 : 215339 : params = valParams;
246 [ + - ]: 54 : else if (valParams.isNull())
247 : 54 : params = UniValue(UniValue::VARR);
248 : : else
249 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_REQUEST, "Params must be an array or object");
250 : 215393 : }
|
