Bitcoin ABC  0.26.3
P2P Digital Currency
i2p.h
Go to the documentation of this file.
1 // Copyright (c) 2020-2020 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.h>
9 #include <fs.h>
10 #include <netaddress.h>
11 #include <sync.h>
12 #include <threadinterrupt.h>
13 #include <util/sock.h>
14 
15 #include <memory>
16 #include <optional>
17 #include <string>
18 #include <unordered_map>
19 #include <vector>
20 
21 namespace i2p {
22 
26 using Binary = std::vector<uint8_t>;
27 
31 struct Connection {
33  std::unique_ptr<Sock> sock;
34 
37 
40 };
41 
42 namespace sam {
43 
52  static constexpr size_t MAX_MSG_SIZE{65536};
53 
57  class Session {
58  public:
72  Session(const fs::path &private_key_file, const CService &control_host,
73  CThreadInterrupt *interrupt);
74 
82  ~Session();
83 
90  bool Listen(Connection &conn);
91 
99  bool Accept(Connection &conn);
100 
112  bool Connect(const CService &to, Connection &conn, bool &proxy_error);
113 
114  private:
118  struct Reply {
122  std::string full;
123 
127  std::string request;
128 
136  std::unordered_map<std::string, std::optional<std::string>> keys;
137 
149  std::string Get(const std::string &key) const;
150  };
151 
157  template <typename... Args>
158  void Log(const std::string &fmt, const Args &...args) const;
159 
170  Reply SendRequestAndGetReply(const Sock &sock,
171  const std::string &request,
172  bool check_result_ok = true) const;
173 
179  std::unique_ptr<Sock> Hello() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex);
180 
184  void CheckControlSock();
185 
193 
200  void GenerateAndSavePrivateKey(const Sock &sock)
202 
209 
216 
224 
229 
234  const fs::path m_private_key_file;
235 
240 
245 
249  mutable Mutex m_mutex;
250 
256  Binary m_private_key GUARDED_BY(m_mutex);
257 
266  std::unique_ptr<Sock> m_control_sock GUARDED_BY(m_mutex);
267 
273 
277  std::string m_session_id GUARDED_BY(m_mutex);
278  };
279 
280 } // namespace sam
281 } // namespace i2p
282 
283 #endif // BITCOIN_I2P_H
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:544
A helper class for interruptible sleeps.
RAII helper class that manages a socket.
Definition: sock.h:26
Path class wrapper to prepare application code for transition from boost::filesystem library to std::...
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:234
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:243
bool Accept(Connection &conn)
Wait for and accept a new incoming connection.
Definition: i2p.cpp:140
void CreateIfNotCreatedAlready() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Create the session if not already created.
Definition: i2p.cpp:353
void Disconnect() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:409
const CService m_control_host
The host and port of the SAM control service.
Definition: i2p.h:239
Session(const fs::path &private_key_file, const CService &control_host, CThreadInterrupt *interrupt)
Construct a session.
Definition: i2p.cpp:115
std::unique_ptr< Sock > Hello() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Open a new connection to the SAM proxy.
Definition: i2p.cpp:284
void CheckControlSock()
Check the control socket for errors and possibly disconnect.
Definition: i2p.cpp:302
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:387
bool Listen(Connection &conn)
Start listening for an incoming connection.
Definition: i2p.cpp:126
Binary MyDestination() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Derive own destination from m_private_key.
Definition: i2p.cpp:337
~Session()
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:121
bool Connect(const CService &to, Connection &conn, bool &proxy_error)
Connect to an I2P peer.
Definition: i2p.cpp:165
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:323
CThreadInterrupt *const m_interrupt
Cease network activity when this is signaled.
Definition: i2p.h:244
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:312
Binary m_private_key GUARDED_BY(m_mutex)
The private key of this peer.
void Log(const std::string &fmt, const Args &...args) const
Log a message in the BCLog::I2P category.
Definition: i2p.cpp:239
Mutex m_mutex
Mutex protecting the members that can be concurrently accessed.
Definition: i2p.h:249
Filesystem operations and types.
Definition: fs.h:19
static constexpr size_t MAX_MSG_SIZE
The maximum size of an incoming message from the I2P SAM proxy (in bytes).
Definition: i2p.h:52
Definition: i2p.cpp:28
std::vector< uint8_t > Binary
Binary data.
Definition: i2p.h:26
An established connection with another peer.
Definition: i2p.h:31
std::unique_ptr< Sock > sock
Connected socket.
Definition: i2p.h:33
CService me
Our I2P address.
Definition: i2p.h:36
CService peer
The peer's I2P address.
Definition: i2p.h:39
A reply from the SAM proxy.
Definition: i2p.h:118
std::string Get(const std::string &key) const
Get the value of a given key.
Definition: i2p.cpp:228
std::string full
Full, unparsed reply.
Definition: i2p.h:122
std::unordered_map< std::string, std::optional< std::string > > keys
A map of keywords from the parsed reply.
Definition: i2p.h:136
std::string request
Request, used for detailed error reporting.
Definition: i2p.h:127
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:56