highperfocused/bitcoin
1
0
Fork 0
mirror of https://github.com/bitcoin/bitcoin.git synced 2025-11-12 06:58:57 +01:00
Code Issues Packages Projects Releases Wiki Activity

rpc: Run type check against RPCArgs

Browse Source
This commit is contained in:
MarcoFalke
2022-12-12 14:30:14 +01:00
parent faf96721a6
commit fa9f6d7bcd
12 changed files with 83 additions and 153 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
src/rpc/util.cpp
View File

@@ -30,23 +30,6 @@ std::string GetAllOutputTypes()
return Join(ret, ", ");
}
void RPCTypeCheck(const UniValue& params,
const std::list<UniValueType>& typesExpected,
bool fAllowNull)
{
unsigned int i = 0;
for (const UniValueType& t : typesExpected) {
if (params.size() <= i)
break;
const UniValue& v = params[i];
if (!(fAllowNull && v.isNull())) {
RPCTypeCheckArgument(v, t);
}
i++;
}
}
void RPCTypeCheckArgument(const UniValue& value, const UniValueType& typeExpected)
{
if (!typeExpected.typeAny && value.type() != typeExpected.type) {
@@ -579,6 +562,9 @@ UniValue RPCHelpMan::HandleRequest(const JSONRPCRequest& request) const
if (request.mode == JSONRPCRequest::GET_HELP || !IsValidNumArgs(request.params.size())) {
throw std::runtime_error(ToString());
}
for (size_t i{0}; i < m_args.size(); ++i) {
m_args.at(i).MatchesType(request.params[i]);
}
UniValue ret = m_fun(*this, request);
if (gArgs.GetBoolArg("-rpcdoccheck", DEFAULT_RPC_DOC_CHECK)) {
CHECK_NONFATAL(std::any_of(m_results.m_results.begin(), m_results.m_results.end(), [&ret](const RPCResult& res) { return res.MatchesType(ret); }));
@@ -677,6 +663,44 @@ UniValue RPCHelpMan::GetArgMap() const
return arr;
}
void RPCArg::MatchesType(const UniValue& request) const
{
if (m_opts.skip_type_check) return;
if (IsOptional() && request.isNull()) return;
switch (m_type) {
case Type::STR_HEX:
case Type::STR: {
RPCTypeCheckArgument(request, UniValue::VSTR);
return;
}
case Type::NUM: {
RPCTypeCheckArgument(request, UniValue::VNUM);
return;
}
case Type::AMOUNT: {
// VNUM or VSTR, checked inside AmountFromValue()
return;
}
case Type::RANGE: {
// VNUM or VARR, checked inside ParseRange()
return;
}
case Type::BOOL: {
RPCTypeCheckArgument(request, UniValue::VBOOL);
return;
}
case Type::OBJ:
case Type::OBJ_USER_KEYS: {
RPCTypeCheckArgument(request, UniValue::VOBJ);
return;
}
case Type::ARR: {
RPCTypeCheckArgument(request, UniValue::VARR);
return;
}
} // no default case, so the compiler can warn about missing cases
}
std::string RPCArg::GetFirstName() const
{
return m_names.substr(0, m_names.find("|"));