Bitcoin Core 30.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
22namespace i2p {
23
27using Binary = std::vector<uint8_t>;
28
32struct Connection {
34 std::unique_ptr<Sock> sock;
35
38
41};
42
43namespace sam {
44
51static constexpr size_t MAX_MSG_SIZE{65536};
52
57{
58public:
68 Session(const fs::path& private_key_file,
69 const Proxy& control_host,
70 std::shared_ptr<CThreadInterrupt> interrupt);
71
81 Session(const Proxy& control_host, std::shared_ptr<CThreadInterrupt> interrupt);
82
89 ~Session();
90
98
106
116 bool Connect(const CService& to, Connection& conn, bool& proxy_error) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex);
117
118private:
122 struct Reply {
126 std::string full;
127
131 std::string request;
132
140 std::unordered_map<std::string, std::optional<std::string>> keys;
141
152 std::string Get(const std::string& key) const;
153 };
154
164 const std::string& request,
165 bool check_result_ok = true) const;
166
172 std::unique_ptr<Sock> Hello() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex);
173
178
185
193
200
207
215
220
224 const fs::path m_private_key_file;
225
230
234 const std::shared_ptr<CThreadInterrupt> m_interrupt;
235
239 mutable Mutex m_mutex;
240
245 Binary m_private_key GUARDED_BY(m_mutex);
246
256 std::unique_ptr<Sock> m_control_sock GUARDED_BY(m_mutex);
257
263
267 std::string m_session_id GUARDED_BY(m_mutex);
268
273 const bool m_transient;
274};
275
276} // namespace sam
277} // namespace i2p
278
279#endif // BITCOIN_I2P_H
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
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:224
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:293
Session(const fs::path &private_key_file, const Proxy &control_host, std::shared_ptr< CThreadInterrupt > interrupt)
Construct a session.
Definition: i2p.cpp:120
bool Listen(Connection &conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Start listening for an incoming connection.
Definition: i2p.cpp:143
void CreateIfNotCreatedAlready() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Create the session if not already created.
Definition: i2p.cpp:408
void Disconnect() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:482
std::unique_ptr< Sock > Hello() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Open a new connection to the SAM proxy.
Definition: i2p.cpp:329
void CheckControlSock() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Check the control socket for errors and possibly disconnect.
Definition: i2p.cpp:342
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:461
Binary MyDestination() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Derive own destination from m_private_key.
Definition: i2p.cpp:376
~Session()
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:137
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:273
const std::shared_ptr< CThreadInterrupt > m_interrupt
Cease network activity when this is signaled.
Definition: i2p.h:234
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:364
bool Connect(const CService &to, Connection &conn, bool &proxy_error) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Connect to an I2P peer.
Definition: i2p.cpp:222
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:353
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:239
bool Accept(Connection &conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Wait for and accept a new incoming connection.
Definition: i2p.cpp:158
const Proxy m_control_host
The SAM control service proxy.
Definition: i2p.h:229
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:32
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:122
std::string Get(const std::string &key) const
Get the value of a given key.
Definition: i2p.cpp:283
std::string full
Full, unparsed reply.
Definition: i2p.h:126
std::unordered_map< std::string, std::optional< std::string > > keys
A map of keywords from the parsed reply.
Definition: i2p.h:140
std::string request
Request, used for detailed error reporting.
Definition: i2p.h:131
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:51