Bitcoin ABC 0.33.1
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/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
15#include <memory>
16#include <optional>
17#include <string>
18#include <unordered_map>
19#include <vector>
20
22
23namespace i2p {
24
28using Binary = std::vector<uint8_t>;
29
33struct Connection {
35 std::unique_ptr<Sock> sock;
36
39
42};
43
44namespace sam {
45
54 static constexpr size_t MAX_MSG_SIZE{65536};
55
59 class Session {
60 public:
74 Session(const fs::path &private_key_file, const Proxy &control_host,
75 CThreadInterrupt *interrupt);
76
90 Session(const Proxy &control_host, CThreadInterrupt *interrupt);
91
99 ~Session();
100
108
117
129 bool Connect(const CService &to, Connection &conn, bool &proxy_error)
131
132 private:
136 struct Reply {
140 std::string full;
141
145 std::string request;
146
154 std::unordered_map<std::string, std::optional<std::string>> keys;
155
167 std::string Get(const std::string &key) const;
168 };
169
181 const std::string &request,
182 bool check_result_ok = true) const;
183
189 std::unique_ptr<Sock> Hello() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex);
190
195
203
210 void GenerateAndSavePrivateKey(const Sock &sock)
212
219
226
234
239
245
250
255
259 mutable Mutex m_mutex;
260
266 Binary m_private_key GUARDED_BY(m_mutex);
267
277 std::unique_ptr<Sock> m_control_sock GUARDED_BY(m_mutex);
278
284
288 std::string m_session_id GUARDED_BY(m_mutex);
289
294 const bool m_transient;
295 };
296
297} // namespace sam
298} // namespace i2p
299
300#endif // BITCOIN_I2P_H
A combination of a network address (CNetAddr) and a (TCP) port.
Definition: netaddress.h:573
A helper class for interruptible sleeps.
Definition: netbase.h:67
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:30
I2P SAM session.
Definition: i2p.h:59
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:244
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:250
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:131
void CreateIfNotCreatedAlready() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Create the session if not already created.
Definition: i2p.cpp:357
void Disconnect() EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:436
std::unique_ptr< Sock > Hello() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Open a new connection to the SAM proxy.
Definition: i2p.cpp:291
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:414
Binary MyDestination() const EXCLUSIVE_LOCKS_REQUIRED(m_mutex)
Derive own destination from m_private_key.
Definition: i2p.cpp:341
~Session()
Destroy the session, closing the internally used sockets.
Definition: i2p.cpp:126
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:294
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:327
bool Connect(const CService &to, Connection &conn, bool &proxy_error) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Connect to an I2P peer.
Definition: i2p.cpp:175
CThreadInterrupt *const m_interrupt
Cease network activity when this is signaled.
Definition: i2p.h:254
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:259
bool Accept(Connection &conn) EXCLUSIVE_LOCKS_REQUIRED(!m_mutex)
Wait for and accept a new incoming connection.
Definition: i2p.cpp:146
const Proxy m_control_host
The SAM control service proxy.
Definition: i2p.h:249
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:54
Definition: i2p.cpp:31
std::vector< uint8_t > Binary
Binary data.
Definition: i2p.h:28
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:33
std::unique_ptr< Sock > sock
Connected socket.
Definition: i2p.h:35
CService me
Our I2P address.
Definition: i2p.h:38
CService peer
The peer's I2P address.
Definition: i2p.h:41
A reply from the SAM proxy.
Definition: i2p.h:136
std::string Get(const std::string &key) const
Get the value of a given key.
Definition: i2p.cpp:240
std::string full
Full, unparsed reply.
Definition: i2p.h:140
std::unordered_map< std::string, std::optional< std::string > > keys
A map of keywords from the parsed reply.
Definition: i2p.h:154
std::string request
Request, used for detailed error reporting.
Definition: i2p.h:145
#define EXCLUSIVE_LOCKS_REQUIRED(...)
Definition: threadsafety.h:56