mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-03-04 13:55:23 -05:00
bugfix: rest: avoid segfault for invalid URI
`evhttp_uri_parse` can return a nullptr, for example when the URI
contains invalid characters (e.g. "%").
`GetQueryParameterFromUri` passes the output of `evhttp_uri_parse`
straight into `evhttp_uri_get_query`, which means that anyone calling
a REST endpoint in which query parameters are used (e.g. `rest_headers`)
can cause a segfault.
This bugfix is designed to be minimal and without additional behaviour change.
Github-Pull: #27468
Rebased-From: 11422cc572
This commit is contained in:
parent
c40b1da2fd
commit
3a26b19df2
4 changed files with 21 additions and 2 deletions
|
@ -652,6 +652,9 @@ std::optional<std::string> HTTPRequest::GetQueryParameter(const std::string& key
|
|||
std::optional<std::string> GetQueryParameterFromUri(const char* uri, const std::string& key)
|
||||
{
|
||||
evhttp_uri* uri_parsed{evhttp_uri_parse(uri)};
|
||||
if (!uri_parsed) {
|
||||
throw std::runtime_error("URI parsing failed, it likely contained RFC 3986 invalid characters");
|
||||
}
|
||||
const char* query{evhttp_uri_get_query(uri_parsed)};
|
||||
std::optional<std::string> result;
|
||||
|
||||
|
|
12
src/rest.cpp
12
src/rest.cpp
|
@ -200,7 +200,11 @@ static bool rest_headers(const std::any& context,
|
|||
} else if (path.size() == 1) {
|
||||
// new path with query parameter: /rest/headers/<hash>?count=<count>
|
||||
hashStr = path[0];
|
||||
raw_count = req->GetQueryParameter("count").value_or("5");
|
||||
try {
|
||||
raw_count = req->GetQueryParameter("count").value_or("5");
|
||||
} catch (const std::runtime_error& e) {
|
||||
return RESTERR(req, HTTP_BAD_REQUEST, e.what());
|
||||
}
|
||||
} else {
|
||||
return RESTERR(req, HTTP_BAD_REQUEST, "Invalid URI format. Expected /rest/headers/<hash>.<ext>?count=<count>");
|
||||
}
|
||||
|
@ -369,7 +373,11 @@ static bool rest_filter_header(const std::any& context, HTTPRequest* req, const
|
|||
} else if (uri_parts.size() == 2) {
|
||||
// new path with query parameter: /rest/blockfilterheaders/<filtertype>/<blockhash>?count=<count>
|
||||
raw_blockhash = uri_parts[1];
|
||||
raw_count = req->GetQueryParameter("count").value_or("5");
|
||||
try {
|
||||
raw_count = req->GetQueryParameter("count").value_or("5");
|
||||
} catch (const std::runtime_error& e) {
|
||||
return RESTERR(req, HTTP_BAD_REQUEST, e.what());
|
||||
}
|
||||
} else {
|
||||
return RESTERR(req, HTTP_BAD_REQUEST, "Invalid URI format. Expected /rest/blockfilterheaders/<filtertype>/<blockhash>.<ext>?count=<count>");
|
||||
}
|
||||
|
|
|
@ -34,5 +34,9 @@ BOOST_AUTO_TEST_CASE(test_query_parameters)
|
|||
// Invalid query string syntax is the same as not having parameters
|
||||
uri = "/rest/endpoint/someresource.json&p1=v1&p2=v2";
|
||||
BOOST_CHECK(!GetQueryParameterFromUri(uri.c_str(), "p1").has_value());
|
||||
|
||||
// URI with invalid characters (%) raises a runtime error regardless of which query parameter is queried
|
||||
uri = "/rest/endpoint/someresource.json&p1=v1&p2=v2%";
|
||||
BOOST_CHECK_EXCEPTION(GetQueryParameterFromUri(uri.c_str(), "p1"), std::runtime_error, HasReason("URI parsing failed, it likely contained RFC 3986 invalid characters"));
|
||||
}
|
||||
BOOST_AUTO_TEST_SUITE_END()
|
||||
|
|
|
@ -281,6 +281,10 @@ class RESTTest (BitcoinTestFramework):
|
|||
assert_equal(len(json_obj), 1) # ensure that there is one header in the json response
|
||||
assert_equal(json_obj[0]['hash'], bb_hash) # request/response hash should be the same
|
||||
|
||||
# Check invalid uri (% symbol at the end of the request)
|
||||
resp = self.test_rest_request(f"/headers/{bb_hash}%", ret_type=RetType.OBJ, status=400)
|
||||
assert_equal(resp.read().decode('utf-8').rstrip(), "URI parsing failed, it likely contained RFC 3986 invalid characters")
|
||||
|
||||
# Compare with normal RPC block response
|
||||
rpc_block_json = self.nodes[0].getblock(bb_hash)
|
||||
for key in ['hash', 'confirmations', 'height', 'version', 'merkleroot', 'time', 'nonce', 'bits', 'difficulty', 'chainwork', 'previousblockhash']:
|
||||
|
|
Loading…
Add table
Reference in a new issue