Bitcoin Core  27.99.0
P2P Digital Currency
i2p_tests.cpp
Go to the documentation of this file.
1 // Copyright (c) 2021-2022 The Bitcoin Core developers
2 // Distributed under the MIT software license, see the accompanying
3 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 
5 #include <common/args.h>
6 #include <i2p.h>
7 #include <logging.h>
8 #include <netaddress.h>
9 #include <netbase.h>
10 #include <test/util/logging.h>
11 #include <test/util/net.h>
12 #include <test/util/setup_common.h>
13 #include <util/readwritefile.h>
14 #include <util/threadinterrupt.h>
15 
16 #include <boost/test/unit_test.hpp>
17 
18 #include <memory>
19 #include <string>
20 
23 {
24 public:
25  explicit EnvTestingSetup(const ChainType chainType = ChainType::MAIN,
26  const std::vector<const char*>& extra_args = {})
27  : BasicTestingSetup{chainType, extra_args},
30  {
32  }
33 
35  {
38  }
39 
40 private:
42  const std::function<std::unique_ptr<Sock>(const sa_family_t&)> m_create_sock_orig;
43 };
44 
45 BOOST_FIXTURE_TEST_SUITE(i2p_tests, EnvTestingSetup)
46 
47 BOOST_AUTO_TEST_CASE(unlimited_recv)
48 {
49  // Mock CreateSock() to create MockSock.
50  CreateSock = [](const sa_family_t&) {
51  return std::make_unique<StaticContentsSock>(std::string(i2p::sam::MAX_MSG_SIZE + 1, 'a'));
52  };
53 
54  CThreadInterrupt interrupt;
55  const std::optional<CService> addr{Lookup("127.0.0.1", 9000, false)};
56  const Proxy sam_proxy(addr.value(), false);
57  i2p::sam::Session session(gArgs.GetDataDirNet() / "test_i2p_private_key", sam_proxy, &interrupt);
58 
59  {
60  ASSERT_DEBUG_LOG("Creating persistent SAM session");
61  ASSERT_DEBUG_LOG("too many bytes without a terminator");
62 
63  i2p::Connection conn;
64  bool proxy_error;
65  BOOST_REQUIRE(!session.Connect(CService{}, conn, proxy_error));
66  }
67 }
68 
69 BOOST_AUTO_TEST_CASE(listen_ok_accept_fail)
70 {
71  size_t num_sockets{0};
72  CreateSock = [&num_sockets](const sa_family_t&) {
73  // clang-format off
74  ++num_sockets;
75  // First socket is the control socket for creating the session.
76  if (num_sockets == 1) {
77  return std::make_unique<StaticContentsSock>(
78  // reply to HELLO
79  "HELLO REPLY RESULT=OK VERSION=3.1\n"
80  // reply to DEST GENERATE
81  "DEST REPLY PUB=WnGOLXRBqHQhdVjFlWqRxJwz9hxx~2~wGc2Vplta1KhacY4tdEGodCF1WMWVapHEnDP2HHH~b~AZzZWmW1rUqFpxji10Qah0IXVYxZVqkcScM~Yccf9v8BnNlaZbWtSoWnGOLXRBqHQhdVjFlWqRxJwz9hxx~2~wGc2Vplta1KhacY4tdEGodCF1WMWVapHEnDP2HHH~b~AZzZWmW1rUqFpxji10Qah0IXVYxZVqkcScM~Yccf9v8BnNlaZbWtSoWnGOLXRBqHQhdVjFlWqRxJwz9hxx~2~wGc2Vplta1KhacY4tdEGodCF1WMWVapHEnDP2HHH~b~AZzZWmW1rUqFpxji10Qah0IXVYxZVqkcScM~Yccf9v8BnNlaZbWtSoWnGOLXRBqHQhdVjFlWqRxJwz9hxx~2~wGc2Vplta1KhacY4tdEGodCF1WMWVapHEnDP2HHH~b~AZzZWmW1rUqLE4SD-yjT48UNI7qiTUfIPiDitCoiTTz2cr4QGfw89rBQAEAAcAAA== PRIV=WnGOLXRBqHQhdVjFlWqRxJwz9hxx~2~wGc2Vplta1KhacY4tdEGodCF1WMWVapHEnDP2HHH~b~AZzZWmW1rUqFpxji10Qah0IXVYxZVqkcScM~Yccf9v8BnNlaZbWtSoWnGOLXRBqHQhdVjFlWqRxJwz9hxx~2~wGc2Vplta1KhacY4tdEGodCF1WMWVapHEnDP2HHH~b~AZzZWmW1rUqFpxji10Qah0IXVYxZVqkcScM~Yccf9v8BnNlaZbWtSoWnGOLXRBqHQhdVjFlWqRxJwz9hxx~2~wGc2Vplta1KhacY4tdEGodCF1WMWVapHEnDP2HHH~b~AZzZWmW1rUqFpxji10Qah0IXVYxZVqkcScM~Yccf9v8BnNlaZbWtSoWnGOLXRBqHQhdVjFlWqRxJwz9hxx~2~wGc2Vplta1KhacY4tdEGodCF1WMWVapHEnDP2HHH~b~AZzZWmW1rUqLE4SD-yjT48UNI7qiTUfIPiDitCoiTTz2cr4QGfw89rBQAEAAcAAOvuCIKTyv5f~1QgGq7XQl-IqBULTB5WzB3gw5yGPtd1p0AeoADrq1ccZggLPQ4ZLUsGK-HVw373rcTfvxrcuwenqVjiN4tbbYLWtP7xXGWj6fM6HyORhU63GphrjEePpMUHDHXd3o7pWGM-ieVVQSK~1MzF9P93pQWI3Do52EeNAayz4HbpPjNhVBzG1hUEFwznfPmUZBPuaOR4-uBm1NEWEuONlNOCctE4-U0Ukh94z-Qb55U5vXjR5G4apmBblr68t6Wm1TKlzpgFHzSqLryh3stWqrOKY1H0z9eZ2z1EkHFOpD5LyF6nf51e-lV7HLMl44TYzoEHK8RRVodtLcW9lacVdBpv~tOzlZERIiDziZODPETENZMz5oy9DQ7UUw==\n"
82  // reply to SESSION CREATE
83  "SESSION STATUS RESULT=OK\n"
84  // dummy to avoid reporting EOF on the socket
85  "a"
86  );
87  }
88  // Subsequent sockets are for recreating the session or for listening and accepting incoming connections.
89  if (num_sockets % 2 == 0) {
90  // Replies to Listen() and Accept()
91  return std::make_unique<StaticContentsSock>(
92  // reply to HELLO
93  "HELLO REPLY RESULT=OK VERSION=3.1\n"
94  // reply to STREAM ACCEPT
95  "STREAM STATUS RESULT=OK\n"
96  // continued reply to STREAM ACCEPT, violating the protocol described at
97  // https://geti2p.net/en/docs/api/samv3#Accept%20Response
98  // should be base64, something like
99  // "IchV608baDoXbqzQKSqFDmTXPVgoDbPAhZJvNRXXxi4hyFXrTxtoOhdurNApKoUOZNc9WCgNs8CFkm81FdfGLiHIVetPG2g6F26s0CkqhQ5k1z1YKA2zwIWSbzUV18YuIchV608baDoXbqzQKSqFDmTXPVgoDbPAhZJvNRXXxi4hyFXrTxtoOhdurNApKoUOZNc9WCgNs8CFkm81FdfGLiHIVetPG2g6F26s0CkqhQ5k1z1YKA2zwIWSbzUV18YuIchV608baDoXbqzQKSqFDmTXPVgoDbPAhZJvNRXXxi4hyFXrTxtoOhdurNApKoUOZNc9WCgNs8CFkm81FdfGLiHIVetPG2g6F26s0CkqhQ5k1z1YKA2zwIWSbzUV18YuIchV608baDoXbqzQKSqFDmTXPVgoDbPAhZJvNRXXxi4hyFXrTxtoOhdurNApKoUOZNc9WCgNs8CFkm81FdfGLlSreVaCuCS5sdb-8ToWULWP7kt~lRPDeUNxQMq3cRSBBQAEAAcAAA==\n"
100  "STREAM STATUS RESULT=I2P_ERROR MESSAGE=\"Session was closed\"\n"
101  );
102  } else {
103  // Another control socket, but without creating a destination (it is cached in the session).
104  return std::make_unique<StaticContentsSock>(
105  // reply to HELLO
106  "HELLO REPLY RESULT=OK VERSION=3.1\n"
107  // reply to SESSION CREATE
108  "SESSION STATUS RESULT=OK\n"
109  // dummy to avoid reporting EOF on the socket
110  "a"
111  );
112  }
113  // clang-format on
114  };
115 
116  CThreadInterrupt interrupt;
117  const CService addr{in6_addr(IN6ADDR_LOOPBACK_INIT), /*port=*/7656};
118  const Proxy sam_proxy(addr, false);
119  i2p::sam::Session session(gArgs.GetDataDirNet() / "test_i2p_private_key",
120  sam_proxy,
121  &interrupt);
122 
123  i2p::Connection conn;
124  for (size_t i = 0; i < 5; ++i) {
125  ASSERT_DEBUG_LOG("Creating persistent SAM session");
126  ASSERT_DEBUG_LOG("Persistent SAM session" /* ... created */);
127  ASSERT_DEBUG_LOG("Error accepting");
128  ASSERT_DEBUG_LOG("Destroying SAM session");
129  BOOST_REQUIRE(session.Listen(conn));
130  BOOST_REQUIRE(!session.Accept(conn));
131  }
132 }
133 
134 BOOST_AUTO_TEST_CASE(damaged_private_key)
135 {
136  const auto CreateSockOrig = CreateSock;
137 
138  CreateSock = [](const sa_family_t&) {
139  return std::make_unique<StaticContentsSock>("HELLO REPLY RESULT=OK VERSION=3.1\n"
140  "SESSION STATUS RESULT=OK DESTINATION=\n");
141  };
142 
143  const auto i2p_private_key_file = m_args.GetDataDirNet() / "test_i2p_private_key_damaged";
144 
145  for (const auto& [file_contents, expected_error] : std::vector<std::tuple<std::string, std::string>>{
146  {"", "The private key is too short (0 < 387)"},
147 
148  {"abcd", "The private key is too short (4 < 387)"},
149 
150  {std::string(386, '\0'), "The private key is too short (386 < 387)"},
151 
152  {std::string(385, '\0') + '\0' + '\1',
153  "Certificate length (1) designates that the private key should be 388 bytes, but it is only "
154  "387 bytes"},
155 
156  {std::string(385, '\0') + '\0' + '\5' + "abcd",
157  "Certificate length (5) designates that the private key should be 392 bytes, but it is only "
158  "391 bytes"}}) {
159  BOOST_REQUIRE(WriteBinaryFile(i2p_private_key_file, file_contents));
160 
161  CThreadInterrupt interrupt;
162  const CService addr{in6_addr(IN6ADDR_LOOPBACK_INIT), /*port=*/7656};
163  const Proxy sam_proxy{addr, false};
164  i2p::sam::Session session(i2p_private_key_file, sam_proxy, &interrupt);
165 
166  {
167  ASSERT_DEBUG_LOG("Creating persistent SAM session");
168  ASSERT_DEBUG_LOG(expected_error);
169 
170  i2p::Connection conn;
171  bool proxy_error;
172  BOOST_CHECK(!session.Connect(CService{}, conn, proxy_error));
173  }
174  }
175 
176  CreateSock = CreateSockOrig;
177 }
178 
ArgsManager gArgs
Definition: args.cpp:41
ChainType
Definition: chaintype.h:11
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: args.h:232
void SetLogLevel(Level level)
Definition: logging.h:174
Level LogLevel() const
Definition: logging.h:173
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:531
A helper class for interruptible sleeps.
Save the log level and the value of CreateSock and restore them when the test ends.
Definition: i2p_tests.cpp:23
EnvTestingSetup(const ChainType chainType=ChainType::MAIN, const std::vector< const char * > &extra_args={})
Definition: i2p_tests.cpp:25
const BCLog::Level m_prev_log_level
Definition: i2p_tests.cpp:41
const std::function< std::unique_ptr< Sock >const sa_family_t &)> m_create_sock_orig
Definition: i2p_tests.cpp:42
Definition: netbase.h:59
I2P SAM session.
Definition: i2p.h:57
bool Listen(Connection &conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Start listening for an incoming connection.
Definition: i2p.cpp:140
bool Connect(const CService &to, Connection &conn, bool &proxy_error) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Connect to an I2P peer.
Definition: i2p.cpp:215
bool Accept(Connection &conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Wait for and accept a new incoming connection.
Definition: i2p.cpp:155
BOOST_AUTO_TEST_SUITE_END()
BOOST_AUTO_TEST_CASE(unlimited_recv)
Definition: i2p_tests.cpp:47
BCLog::Logger & LogInstance()
Definition: logging.cpp:19
Level
Definition: logging.h:74
static constexpr size_t MAX_MSG_SIZE
The maximum size of an incoming message from the I2P SAM proxy (in bytes).
Definition: i2p.h:51
std::vector< CService > Lookup(const std::string &name, uint16_t portDefault, bool fAllowLookup, unsigned int nMaxSolutions, DNSLookupFn dns_lookup_function)
Resolve a service string to its corresponding service.
Definition: netbase.cpp:182
std::function< std::unique_ptr< Sock >const sa_family_t &)> CreateSock
Socket factory.
Definition: netbase.cpp:541
#define BOOST_CHECK(expr)
Definition: object.cpp:17
bool WriteBinaryFile(const fs::path &filename, const std::string &data)
Write contents of std::string to a file.
Basic testing setup.
Definition: setup_common.h:54
An established connection with another peer.
Definition: i2p.h:32
#define ASSERT_DEBUG_LOG(message)
Definition: logging.h:39