Bitcoin Core  27.99.0
P2P Digital Currency
i2p.h
Go to the documentation of this file.
1 // Copyright (c) 2020-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 #ifndef BITCOIN_I2P_H
6 #define BITCOIN_I2P_H
7 
8 #include <compat/compat.h>
9 #include <netaddress.h>
10 #include <netbase.h>
11 #include <sync.h>
12 #include <util/fs.h>
13 #include <util/sock.h>
14 #include <util/threadinterrupt.h>
15 
16 #include <memory>
17 #include <optional>
18 #include <string>
19 #include <unordered_map>
20 #include <vector>
21 
22 namespace i2p {
23 
27 using Binary = std::vector<uint8_t>;
28 
32 struct Connection {
34  std::unique_ptr<Sock> sock;
35 
38 
41 };
42 
43 namespace sam {
44 
51 static constexpr size_t MAX_MSG_SIZE{65536};
52 
56 class Session
57 {
58 public:
70  Session(const fs::path& private_key_file,
71  const Proxy& control_host,
72  CThreadInterrupt* interrupt);
73 
85  Session(const Proxy& control_host, CThreadInterrupt* interrupt);
86 
93  ~Session();
94 
102 
110 
120  bool Connect(const CService& to, Connection& conn, bool& proxy_error) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
121 
122 private:
126  struct Reply {
130  std::string full;
131 
135  std::string request;
136 
144  std::unordered_map<std::string, std::optional<std::string>> keys;
145 
156  std::string Get(const std::string& key) const;
157  };
158 
164  template <typename... Args>
165  void Log(const std::string& fmt, const Args&... args) const;
166 
175  Reply SendRequestAndGetReply(const Sock& sock,
176  const std::string& request,
177  bool check_result_ok = true) const;
178 
184  std::unique_ptr<Sock> Hello() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex);
185 
190 
197 
205 
212 
219 
227 
232 
236  const fs::path m_private_key_file;
237 
242 
247 
251  mutable Mutex m_mutex;
252 
257  Binary m_private_key GUARDED_BY(m_mutex);
258 
268  std::unique_ptr<Sock> m_control_sock GUARDED_BY(m_mutex);
269 
275 
279  std::string m_session_id GUARDED_BY(m_mutex);
280 
285  const bool m_transient;
286 };
287 
288 } // namespace sam
289 } // namespace i2p
290 
291 #endif // BITCOIN_I2P_H
ArgsManager & args
Definition: bitcoind.cpp:268
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:531
A helper class for interruptible sleeps.
Definition: netbase.h:59
RAII helper class that manages a socket and closes it automatically when it goes out of scope.
Definition: sock.h:27
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:33
I2P SAM session.
Definition: i2p.h:57
const fs::path m_private_key_file
The name of the file where this peer's private key is stored (in binary).
Definition: i2p.h:236
Reply SendRequestAndGetReply(const Sock &sock, const std::string &request, bool check_result_ok=true) const
Send request and get a reply from the SAM proxy.
Definition: i2p.cpp:292
Session(const fs::path &private_key_file, const Proxy &control_host, CThreadInterrupt *interrupt)
Construct a session.
Definition: i2p.cpp:117
bool Listen(Connection &conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Start listening for an incoming connection.
Definition: i2p.cpp:140
void CreateIfNotCreatedAlready() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Create the session if not already created.
Definition: i2p.cpp:407
void Disconnect() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:481
std::unique_ptr< Sock > Hello() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Open a new connection to the SAM proxy.
Definition: i2p.cpp:328
void CheckControlSock() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Check the control socket for errors and possibly disconnect.
Definition: i2p.cpp:341
std::unique_ptr< Sock > StreamAccept() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Open a new connection to the SAM proxy and issue "STREAM ACCEPT" request using the existing session i...
Definition: i2p.cpp:460
Binary MyDestination() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Derive own destination from m_private_key.
Definition: i2p.cpp:375
~Session()
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:134
const bool m_transient
Whether this is a transient session (the I2P private key will not be read or written to disk).
Definition: i2p.h:285
void GenerateAndSavePrivateKey(const Sock &sock) EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Generate a new destination with the SAM proxy, set m_private_key to it and save it on disk to m_priva...
Definition: i2p.cpp:363
bool Connect(const CService &to, Connection &conn, bool &proxy_error) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Connect to an I2P peer.
Definition: i2p.cpp:215
void Log(const std::string &fmt, const Args &... args) const
Log a message in the BCLog::I2P category.
Definition: i2p.cpp:287
CThreadInterrupt *const m_interrupt
Cease network activity when this is signaled.
Definition: i2p.h:246
void DestGenerate(const Sock &sock) EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Generate a new destination with the SAM proxy and set m_private_key to it.
Definition: i2p.cpp:352
Binary m_private_key GUARDED_BY(m_mutex)
The private key of this peer.
Mutex m_mutex
Mutex protecting the members that can be concurrently accessed.
Definition: i2p.h:251
bool Accept(Connection &conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Wait for and accept a new incoming connection.
Definition: i2p.cpp:155
const Proxy m_control_host
The SAM control service proxy.
Definition: i2p.h:241
Filesystem operations and types.
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
Definition: i2p.cpp:29
std::vector< uint8_t > Binary
Binary data.
Definition: i2p.h:27
An established connection with another peer.
Definition: i2p.h:32
std::unique_ptr< Sock > sock
Connected socket.
Definition: i2p.h:34
CService me
Our I2P address.
Definition: i2p.h:37
CService peer
The peer's I2P address.
Definition: i2p.h:40
A reply from the SAM proxy.
Definition: i2p.h:126
std::string Get(const std::string &key) const
Get the value of a given key.
Definition: i2p.cpp:276
std::string full
Full, unparsed reply.
Definition: i2p.h:130
std::unordered_map< std::string, std::optional< std::string > > keys
A map of keywords from the parsed reply.
Definition: i2p.h:144
std::string request
Request, used for detailed error reporting.
Definition: i2p.h:135
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:49