mirror of
https://github.com/monero-project/monero.git
synced 2024-12-23 12:09:54 +00:00
e71c8bf190
- When background syncing, the wallet wipes the spend key from memory and processes all new transactions. The wallet saves all receives, spends, and "plausible" spends of receives the wallet does not know key images for. - When background sync disabled, the wallet processes all background synced txs and then clears the background sync cache. - Adding "plausible" spends to the background sync cache ensures that the wallet does not need to query the daemon to see if any received outputs were spent while background sync was enabled. This would harm privacy especially for users of 3rd party daemons. - To enable the feature in the CLI wallet, the user can set background-sync to reuse-wallet-password or custom-background-password and the wallet automatically syncs in the background when the wallet locks, then processes all background synced txs when the wallet is unlocked. - The custom-background-password option enables the user to open a distinct background wallet that only has a view key saved and can be opened/closed/synced separately from the main wallet. When the main wallet opens, it processes the background wallet's cache. - To enable the feature in the RPC wallet, there is a new `/setup_background_sync` endpoint. - HW, multsig and view-only wallets cannot background sync.
225 lines
7.1 KiB
C++
225 lines
7.1 KiB
C++
// Copyright (c) 2018-2023, The Monero Project
|
|
|
|
//
|
|
// All rights reserved.
|
|
//
|
|
// Redistribution and use in source and binary forms, with or without modification, are
|
|
// permitted provided that the following conditions are met:
|
|
//
|
|
// 1. Redistributions of source code must retain the above copyright notice, this list of
|
|
// conditions and the following disclaimer.
|
|
//
|
|
// 2. Redistributions in binary form must reproduce the above copyright notice, this list
|
|
// of conditions and the following disclaimer in the documentation and/or other
|
|
// materials provided with the distribution.
|
|
//
|
|
// 3. Neither the name of the copyright holder nor the names of its contributors may be
|
|
// used to endorse or promote products derived from this software without specific
|
|
// prior written permission.
|
|
//
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
|
|
// EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
|
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
|
|
// THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
|
|
// STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
|
// THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
#include <boost/optional/optional.hpp>
|
|
#include <string.h>
|
|
#include "gtest/gtest.h"
|
|
|
|
#include "misc_log_ex.h"
|
|
#include "wipeable_string.h"
|
|
#include "hex.h"
|
|
|
|
TEST(wipeable_string, ctor)
|
|
{
|
|
epee::wipeable_string s0;
|
|
ASSERT_EQ(s0.size(), 0);
|
|
|
|
epee::wipeable_string s1(std::string("foo"));
|
|
ASSERT_EQ(s1.size(), 3);
|
|
ASSERT_TRUE(!memcmp(s1.data(), "foo", s1.size()));
|
|
|
|
epee::wipeable_string s2(std::string("bar"));
|
|
ASSERT_EQ(s2.size(), 3);
|
|
ASSERT_TRUE(!memcmp(s2.data(), "bar", s2.size()));
|
|
|
|
epee::wipeable_string s3(std::string("quux"));
|
|
ASSERT_EQ(s3.size(), 4);
|
|
ASSERT_TRUE(!memcmp(s3.data(), "quux", s3.size()));
|
|
}
|
|
|
|
TEST(wipeable_string, wipe)
|
|
{
|
|
epee::wipeable_string s0(std::string("foo"));
|
|
ASSERT_EQ(s0.size(), 3);
|
|
s0.wipe();
|
|
ASSERT_EQ(s0.size(), 3);
|
|
ASSERT_TRUE(!memcmp(s0.data(), "\0\0\0", 3));
|
|
}
|
|
|
|
TEST(wipeable_string, clear)
|
|
{
|
|
epee::wipeable_string s0(std::string("foo"));
|
|
ASSERT_EQ(s0.size(), 3);
|
|
s0.clear();
|
|
ASSERT_EQ(s0.size(), 0);
|
|
}
|
|
|
|
TEST(wipeable_string, push_back)
|
|
{
|
|
epee::wipeable_string s0(std::string("fo"));
|
|
ASSERT_EQ(s0.size(), 2);
|
|
s0.push_back('o');
|
|
ASSERT_EQ(s0.size(), 3);
|
|
ASSERT_TRUE(!memcmp(s0.data(), "foo", s0.size()));
|
|
}
|
|
|
|
TEST(wipeable_string, append_char)
|
|
{
|
|
epee::wipeable_string s0(std::string("fo"));
|
|
ASSERT_EQ(s0.size(), 2);
|
|
s0 += 'o';
|
|
ASSERT_EQ(s0.size(), 3);
|
|
ASSERT_TRUE(!memcmp(s0.data(), "foo", s0.size()));
|
|
}
|
|
|
|
TEST(wipeable_string, append_string)
|
|
{
|
|
epee::wipeable_string s0(std::string("foo"));
|
|
ASSERT_EQ(s0.size(), 3);
|
|
s0 += "bar";
|
|
ASSERT_EQ(s0.size(), 6);
|
|
ASSERT_TRUE(!memcmp(s0.data(), "foobar", s0.size()));
|
|
}
|
|
|
|
TEST(wipeable_string, empty)
|
|
{
|
|
epee::wipeable_string s0;
|
|
ASSERT_TRUE(s0.empty());
|
|
s0.push_back(' ');
|
|
ASSERT_FALSE(s0.empty());
|
|
ASSERT_EQ(s0.pop_back(), ' ');
|
|
ASSERT_TRUE(s0.empty());
|
|
}
|
|
|
|
TEST(wipeable_string, pop_back)
|
|
{
|
|
epee::wipeable_string s = "test";
|
|
ASSERT_EQ(s.size(), 4);
|
|
ASSERT_EQ(s.pop_back(), 't');
|
|
ASSERT_EQ(s.size(), 3);
|
|
ASSERT_TRUE(!memcmp(s.data(), "tes", s.size()));
|
|
}
|
|
|
|
TEST(wipeable_string, equal)
|
|
{
|
|
epee::wipeable_string s0 = "foo";
|
|
epee::wipeable_string s1 = "bar";
|
|
epee::wipeable_string s0_2 = "foo";
|
|
ASSERT_TRUE(s0 == s0);
|
|
ASSERT_TRUE(s0 == s0_2);
|
|
ASSERT_TRUE(s1 == s1);
|
|
ASSERT_FALSE(s1 == s0);
|
|
ASSERT_FALSE(s1 == s0_2);
|
|
}
|
|
|
|
TEST(wipeable_string, not_equal)
|
|
{
|
|
epee::wipeable_string s0 = "foo";
|
|
epee::wipeable_string s1 = "bar";
|
|
epee::wipeable_string s0_2 = "foo";
|
|
ASSERT_FALSE(s0 != s0);
|
|
ASSERT_FALSE(s0 != s0_2);
|
|
ASSERT_FALSE(s1 != s1);
|
|
ASSERT_TRUE(s1 != s0);
|
|
ASSERT_TRUE(s1 != s0_2);
|
|
}
|
|
|
|
static epee::wipeable_string trimmed(const char *s)
|
|
{
|
|
epee::wipeable_string str(s);
|
|
str.trim();
|
|
return str;
|
|
}
|
|
|
|
TEST(wipeable_string, trim)
|
|
{
|
|
ASSERT_TRUE(trimmed("") == "");
|
|
ASSERT_TRUE(trimmed(" ") == "");
|
|
ASSERT_TRUE(trimmed(" ") == "");
|
|
ASSERT_TRUE(trimmed("a") == "a");
|
|
ASSERT_TRUE(trimmed(" a") == "a");
|
|
ASSERT_TRUE(trimmed(" a") == "a");
|
|
ASSERT_TRUE(trimmed("a ") == "a");
|
|
ASSERT_TRUE(trimmed("a ") == "a");
|
|
ASSERT_TRUE(trimmed(" a ") == "a");
|
|
ASSERT_TRUE(trimmed(" a ") == "a");
|
|
ASSERT_TRUE(trimmed(" ab ") == "ab");
|
|
ASSERT_TRUE(trimmed(" a b ") == "a b");
|
|
ASSERT_TRUE(trimmed(" a b ") == "a b");
|
|
}
|
|
|
|
static bool check_split(const char *s, const std::vector<epee::wipeable_string> &v)
|
|
{
|
|
epee::wipeable_string str(s);
|
|
std::vector<epee::wipeable_string> fields;
|
|
str.split(fields);
|
|
return v == fields;
|
|
}
|
|
|
|
TEST(wipeable_string, split)
|
|
{
|
|
ASSERT_TRUE(check_split("", {}));
|
|
ASSERT_TRUE(check_split("foo", {"foo"}));
|
|
ASSERT_TRUE(check_split(" foo ", {"foo"}));
|
|
ASSERT_TRUE(check_split("foo bar", {"foo", "bar"}));
|
|
ASSERT_TRUE(check_split("foo bar", {"foo", "bar"}));
|
|
ASSERT_TRUE(check_split("foo bar baz", {"foo", "bar", "baz"}));
|
|
ASSERT_TRUE(check_split(" foo bar baz ", {"foo", "bar", "baz"}));
|
|
ASSERT_TRUE(check_split(" foo bar baz", {"foo", "bar", "baz"}));
|
|
ASSERT_TRUE(check_split("foo bar baz ", {"foo", "bar", "baz"}));
|
|
ASSERT_TRUE(check_split("\tfoo\n bar\r\nbaz", {"foo", "bar", "baz"}));
|
|
}
|
|
|
|
TEST(wipeable_string, parse_hexstr)
|
|
{
|
|
boost::optional<epee::wipeable_string> s;
|
|
|
|
ASSERT_TRUE(boost::none == epee::wipeable_string("x").parse_hexstr());
|
|
ASSERT_TRUE(boost::none == epee::wipeable_string("x0000000000000000").parse_hexstr());
|
|
ASSERT_TRUE(boost::none == epee::wipeable_string("0000000000000000x").parse_hexstr());
|
|
ASSERT_TRUE(boost::none == epee::wipeable_string("0").parse_hexstr());
|
|
ASSERT_TRUE(boost::none == epee::wipeable_string("000").parse_hexstr());
|
|
|
|
ASSERT_TRUE((s = epee::wipeable_string("").parse_hexstr()) != boost::none);
|
|
ASSERT_TRUE(*s == "");
|
|
ASSERT_TRUE((s = epee::wipeable_string("00").parse_hexstr()) != boost::none);
|
|
ASSERT_TRUE(*s == epee::wipeable_string("", 1));
|
|
ASSERT_TRUE((s = epee::wipeable_string("41").parse_hexstr()) != boost::none);
|
|
ASSERT_TRUE(*s == epee::wipeable_string("A"));
|
|
ASSERT_TRUE((s = epee::wipeable_string("414243").parse_hexstr()) != boost::none);
|
|
ASSERT_TRUE(*s == epee::wipeable_string("ABC"));
|
|
}
|
|
|
|
TEST(wipeable_string, to_hex)
|
|
{
|
|
ASSERT_TRUE(epee::to_hex::wipeable_string(epee::span<const uint8_t>((const uint8_t*)"", 0)) == epee::wipeable_string(""));
|
|
ASSERT_TRUE(epee::to_hex::wipeable_string(epee::span<const uint8_t>((const uint8_t*)"abc", 3)) == epee::wipeable_string("616263"));
|
|
}
|
|
|
|
TEST(wipeable_string, to_string)
|
|
{
|
|
// Converting a wipeable_string to a string defeats the purpose of wipeable_string,
|
|
// but nice to know this works
|
|
std::string str;
|
|
{
|
|
epee::wipeable_string wipeable_str("foo");
|
|
str = std::string(wipeable_str.data(), wipeable_str.size());
|
|
}
|
|
ASSERT_TRUE(str == std::string("foo"));
|
|
}
|