Bitcoin ABC 0.32.4
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 <netaddress.h>
10#include <sync.h>
11#include <util/fs.h>
12#include <util/sock.h>
13
14#include <memory>
15#include <optional>
16#include <string>
17#include <unordered_map>
18#include <vector>
19
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
53 static constexpr size_t MAX_MSG_SIZE{65536};
54
58 class Session {
59 public:
73 Session(const fs::path &private_key_file, const CService &control_host,
74 CThreadInterrupt *interrupt);
75
83 ~Session();
84
92
101
113 bool Connect(const CService &to, Connection &conn, bool &proxy_error)
115
116 private:
120 struct Reply {
124 std::string full;
125
129 std::string request;
130
138 std::unordered_map<std::string, std::optional<std::string>> keys;
139
151 std::string Get(const std::string &key) const;
152 };
153
165 const std::string &request,
166 bool check_result_ok = true) const;
167
173 std::unique_ptr<Sock> Hello() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex);
174
179
187
194 void GenerateAndSavePrivateKey(const Sock &sock)
196
203
210
218
223
229
234
239
243 mutable Mutex m_mutex;
244
250 Binary m_private_key GUARDED_BY(m_mutex);
251
260 std::unique_ptr<Sock> m_control_sock GUARDED_BY(m_mutex);
261
267
271 std::string m_session_id GUARDED_BY(m_mutex);
272 };
273
274} // namespace sam
275} // namespace i2p
276
277#endif // BITCOIN_I2P_H
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:545
A helper class for interruptible sleeps.
RAII helper class that manages a socket.
Definition: sock.h:28
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:30
I2P SAM session.
Definition: i2p.h:58
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:228
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:245
bool Listen(Connection &conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Start listening for an incoming connection.
Definition: i2p.cpp:126
void CreateIfNotCreatedAlready() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Create the session if not already created.
Definition: i2p.cpp:356
void Disconnect() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:415
const CService m_control_host
The host and port of the SAM control service.
Definition: i2p.h:233
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:286
void CheckControlSock() EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Check the control socket for errors and possibly disconnect.
Definition: i2p.cpp:304
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:393
Binary MyDestination() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Derive own destination from m_private_key.
Definition: i2p.cpp:340
~Session()
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:121
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:326
bool Connect(const CService &to, Connection &conn, bool &proxy_error) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Connect to an I2P peer.
Definition: i2p.cpp:170
CThreadInterrupt *const m_interrupt
Cease network activity when this is signaled.
Definition: i2p.h:238
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:315
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:243
bool Accept(Connection &conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Wait for and accept a new incoming connection.
Definition: i2p.cpp:141
Filesystem operations and types.
Definition: fs.h:20
static constexpr size_t MAX_MSG_SIZE
The maximum size of an incoming message from the I2P SAM proxy (in bytes).
Definition: i2p.h:53
Definition: i2p.cpp:29
std::vector< uint8_t > Binary
Binary data.
Definition: i2p.h:27
Implement std::hash so RCUPtr can be used as a key for maps or sets.
Definition: rcu.h:259
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:120
std::string Get(const std::string &key) const
Get the value of a given key.
Definition: i2p.cpp:235
std::string full
Full, unparsed reply.
Definition: i2p.h:124
std::unordered_map< std::string, std::optional< std::string > > keys
A map of keywords from the parsed reply.
Definition: i2p.h:138
std::string request
Request, used for detailed error reporting.
Definition: i2p.h:129
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:56