Files
rippled/src/test/rpc/AccountCurrencies_test.cpp
drlongle 78076a6903 fix!: Prevent API from accepting seed or public key for account (#4404)
The API would allow seeds (and public keys) to be used in place of
accounts at several locations in the API. For example, when calling
account_info, you could pass `"account": "foo"`. The string "foo" is
treated like a seed, so the method returns `actNotFound` (instead of
`actMalformed`, as most developers would expect). In the early days,
this was a convenience to make testing easier. However, it allows for
poor security practices, so it is no longer a good idea. Allowing a
secret or passphrase is now considered a bug. Previously, it was
controlled by the `strict` option on some methods. With this commit,
since the API does not interpret `account` as `seed`, the option
`strict` is no longer needed and is removed.

Removing this behavior from the API is a [breaking
change](https://xrpl.org/request-formatting.html#breaking-changes). One
could argue that it shouldn't be done without bumping the API version;
however, in this instance, there is no evidence that anyone is using the
API in the "legacy" way. Furthermore, it is a potential security hole,
as it allows users to send secrets to places where they are not needed,
where they could end up in logs, error messages, etc. There's no reason
to take such a risk with a seed/secret, since only the public address is
needed.

Resolves: #3329, #3330, #4337

BREAKING CHANGE: Remove non-strict account parsing (#3330)
2023-05-16 17:22:10 -07:00

204 lines
7.5 KiB
C++

//------------------------------------------------------------------------------
/*
This file is part of rippled: https://github.com/ripple/rippled
Copyright (c) 2017 Ripple Labs Inc.
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL , DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
#include <ripple/beast/unit_test.h>
#include <ripple/protocol/jss.h>
#include <test/jtx.h>
namespace ripple {
class AccountCurrencies_test : public beast::unit_test::suite
{
void
testBadInput()
{
testcase("Bad input to account_currencies");
using namespace test::jtx;
Env env{*this};
auto const alice = Account{"alice"};
env.fund(XRP(10000), alice);
env.close();
{ // invalid ledger (hash)
Json::Value params;
params[jss::ledger_hash] = 1;
auto const result = env.rpc(
"json",
"account_currencies",
boost::lexical_cast<std::string>(params))[jss::result];
BEAST_EXPECT(result[jss::error] == "invalidParams");
BEAST_EXPECT(result[jss::error_message] == "ledgerHashNotString");
}
{ // missing account field
auto const result =
env.rpc("json", "account_currencies", "{}")[jss::result];
BEAST_EXPECT(result[jss::error] == "invalidParams");
BEAST_EXPECT(
result[jss::error_message] == "Missing field 'account'.");
}
{
Json::Value params;
params[jss::account] =
"llIIOO"; // these are invalid in bitcoin alphabet
auto const result = env.rpc(
"json",
"account_currencies",
boost::lexical_cast<std::string>(params))[jss::result];
BEAST_EXPECT(result[jss::error] == "actMalformed");
BEAST_EXPECT(result[jss::error_message] == "Account malformed.");
}
{
// Cannot use a seed as account
Json::Value params;
params[jss::account] = "Bob";
auto const result = env.rpc(
"json",
"account_currencies",
boost::lexical_cast<std::string>(params))[jss::result];
BEAST_EXPECT(result[jss::error] == "actMalformed");
BEAST_EXPECT(result[jss::error_message] == "Account malformed.");
}
{ // ask for nonexistent account
Json::Value params;
params[jss::account] = Account{"bob"}.human();
auto const result = env.rpc(
"json",
"account_currencies",
boost::lexical_cast<std::string>(params))[jss::result];
BEAST_EXPECT(result[jss::error] == "actNotFound");
BEAST_EXPECT(result[jss::error_message] == "Account not found.");
}
}
void
testBasic()
{
testcase("Basic request for account_currencies");
using namespace test::jtx;
Env env{*this};
auto const alice = Account{"alice"};
auto const gw = Account{"gateway"};
env.fund(XRP(10000), alice, gw);
char currencySuffix{'A'};
std::vector<std::optional<IOU>> gwCurrencies(26); // A - Z
std::generate(gwCurrencies.begin(), gwCurrencies.end(), [&]() {
auto gwc = gw[std::string("US") + currencySuffix++];
env(trust(alice, gwc(100)));
return gwc;
});
env.close();
Json::Value params;
params[jss::account] = alice.human();
auto result = env.rpc(
"json",
"account_currencies",
boost::lexical_cast<std::string>(params))[jss::result];
auto arrayCheck =
[&result](
Json::StaticString const& fld,
std::vector<std::optional<IOU>> const& expected) -> bool {
bool stat = result.isMember(fld) && result[fld].isArray() &&
result[fld].size() == expected.size();
for (size_t i = 0; stat && i < expected.size(); ++i)
{
stat &=
(to_string(expected[i].value().currency) ==
result[fld][i].asString());
}
return stat;
};
BEAST_EXPECT(arrayCheck(jss::receive_currencies, gwCurrencies));
BEAST_EXPECT(arrayCheck(jss::send_currencies, {}));
// now form a payment for each currency
for (auto const& c : gwCurrencies)
env(pay(gw, alice, c.value()(50)));
// send_currencies should be populated now
result = env.rpc(
"json",
"account_currencies",
boost::lexical_cast<std::string>(params))[jss::result];
BEAST_EXPECT(arrayCheck(jss::receive_currencies, gwCurrencies));
BEAST_EXPECT(arrayCheck(jss::send_currencies, gwCurrencies));
// freeze the USD trust line and verify that the receive currencies
// does not change
env(trust(alice, gw["USD"](100), tfSetFreeze));
result = env.rpc("account_lines", alice.human());
for (auto const& l : result[jss::lines])
BEAST_EXPECT(
l[jss::freeze].asBool() == (l[jss::currency] == "USD"));
result = env.rpc(
"json",
"account_currencies",
boost::lexical_cast<std::string>(params))[jss::result];
BEAST_EXPECT(arrayCheck(jss::receive_currencies, gwCurrencies));
BEAST_EXPECT(arrayCheck(jss::send_currencies, gwCurrencies));
// clear the freeze
env(trust(alice, gw["USD"](100), tfClearFreeze));
// make a payment that exhausts the trustline from alice to gw for USA
env(pay(gw, alice, gw["USA"](50)));
// USA should now be missing from receive_currencies
result = env.rpc(
"json",
"account_currencies",
boost::lexical_cast<std::string>(params))[jss::result];
decltype(gwCurrencies) gwCurrenciesNoUSA(
gwCurrencies.begin() + 1, gwCurrencies.end());
BEAST_EXPECT(arrayCheck(jss::receive_currencies, gwCurrenciesNoUSA));
BEAST_EXPECT(arrayCheck(jss::send_currencies, gwCurrencies));
// add trust from gw to alice and then exhaust that trust line
// so that send_currencies for alice will now omit USA
env(trust(gw, alice["USA"](100)));
env(pay(alice, gw, alice["USA"](200)));
result = env.rpc(
"json",
"account_currencies",
boost::lexical_cast<std::string>(params))[jss::result];
BEAST_EXPECT(arrayCheck(jss::receive_currencies, gwCurrencies));
BEAST_EXPECT(arrayCheck(jss::send_currencies, gwCurrenciesNoUSA));
}
public:
void
run() override
{
testBadInput();
testBasic();
}
};
BEAST_DEFINE_TESTSUITE(AccountCurrencies, app, ripple);
} // namespace ripple