mirror of
https://github.com/PurpleI2P/i2pd.git
synced 2024-10-31 09:20:38 +00:00
309 lines
10 KiB
C++
309 lines
10 KiB
C++
#ifndef TUNNEL_H__
|
|
#define TUNNEL_H__
|
|
|
|
#include <inttypes.h>
|
|
#include <map>
|
|
#include <unordered_map>
|
|
#include <list>
|
|
#include <vector>
|
|
#include <string>
|
|
#include <thread>
|
|
#include <mutex>
|
|
#include <memory>
|
|
#include "Queue.h"
|
|
#include "Crypto.h"
|
|
#include "TunnelConfig.h"
|
|
#include "TunnelPool.h"
|
|
#include "TransitTunnel.h"
|
|
#include "TunnelEndpoint.h"
|
|
#include "TunnelGateway.h"
|
|
#include "TunnelBase.h"
|
|
#include "I2NPProtocol.h"
|
|
#include "Event.h"
|
|
|
|
namespace i2p
|
|
{
|
|
namespace tunnel
|
|
{
|
|
|
|
template<typename TunnelT>
|
|
static void EmitTunnelEvent(const std::string & ev, const TunnelT & t)
|
|
{
|
|
#ifdef WITH_EVENTS
|
|
EmitEvent({{"type", ev}, {"tid", std::to_string(t->GetTunnelID())}});
|
|
#else
|
|
(void) ev;
|
|
(void) t;
|
|
#endif
|
|
}
|
|
|
|
template<typename TunnelT, typename T>
|
|
static void EmitTunnelEvent(const std::string & ev, TunnelT * t, const T & val)
|
|
{
|
|
#ifdef WITH_EVENTS
|
|
EmitEvent({{"type", ev}, {"tid", std::to_string(t->GetTunnelID())}, {"value", std::to_string(val)}, {"inbound", std::to_string(t->IsInbound())}});
|
|
#else
|
|
(void) ev;
|
|
(void) t;
|
|
(void) val;
|
|
#endif
|
|
}
|
|
|
|
template<typename TunnelT>
|
|
static void EmitTunnelEvent(const std::string & ev, TunnelT * t, const std::string & val)
|
|
{
|
|
#ifdef WITH_EVENTS
|
|
EmitEvent({{"type", ev}, {"tid", std::to_string(t->GetTunnelID())}, {"value", val}, {"inbound", std::to_string(t->IsInbound())}});
|
|
#else
|
|
(void) ev;
|
|
(void) t;
|
|
(void) val;
|
|
#endif
|
|
}
|
|
|
|
|
|
const int TUNNEL_EXPIRATION_TIMEOUT = 660; // 11 minutes
|
|
const int TUNNEL_EXPIRATION_THRESHOLD = 60; // 1 minute
|
|
const int TUNNEL_RECREATION_THRESHOLD = 90; // 1.5 minutes
|
|
const int TUNNEL_CREATION_TIMEOUT = 30; // 30 seconds
|
|
const int STANDARD_NUM_RECORDS = 5; // in VariableTunnelBuild message
|
|
|
|
enum TunnelState
|
|
{
|
|
eTunnelStatePending,
|
|
eTunnelStateBuildReplyReceived,
|
|
eTunnelStateBuildFailed,
|
|
eTunnelStateEstablished,
|
|
eTunnelStateTestFailed,
|
|
eTunnelStateFailed,
|
|
eTunnelStateExpiring
|
|
};
|
|
|
|
class OutboundTunnel;
|
|
class InboundTunnel;
|
|
class Tunnel: public TunnelBase
|
|
{
|
|
struct TunnelHop
|
|
{
|
|
std::shared_ptr<const i2p::data::IdentityEx> ident;
|
|
i2p::crypto::TunnelDecryption decryption;
|
|
};
|
|
|
|
public:
|
|
|
|
Tunnel (std::shared_ptr<const TunnelConfig> config);
|
|
~Tunnel ();
|
|
|
|
void Build (uint32_t replyMsgID, std::shared_ptr<OutboundTunnel> outboundTunnel = nullptr);
|
|
|
|
std::shared_ptr<const TunnelConfig> GetTunnelConfig () const { return m_Config; }
|
|
std::vector<std::shared_ptr<const i2p::data::IdentityEx> > GetPeers () const;
|
|
std::vector<std::shared_ptr<const i2p::data::IdentityEx> > GetInvertedPeers () const;
|
|
TunnelState GetState () const { return m_State; };
|
|
void SetState (TunnelState state);
|
|
bool IsEstablished () const { return m_State == eTunnelStateEstablished; };
|
|
bool IsFailed () const { return m_State == eTunnelStateFailed; };
|
|
bool IsRecreated () const { return m_IsRecreated; };
|
|
void SetIsRecreated () { m_IsRecreated = true; };
|
|
virtual bool IsInbound() const = 0;
|
|
|
|
std::shared_ptr<TunnelPool> GetTunnelPool () const { return m_Pool; };
|
|
void SetTunnelPool (std::shared_ptr<TunnelPool> pool) { m_Pool = pool; };
|
|
|
|
bool HandleTunnelBuildResponse (uint8_t * msg, size_t len);
|
|
|
|
virtual void Print (std::stringstream&) const {};
|
|
|
|
// implements TunnelBase
|
|
void SendTunnelDataMsg (std::shared_ptr<i2p::I2NPMessage> msg);
|
|
void EncryptTunnelMsg (std::shared_ptr<const I2NPMessage> in, std::shared_ptr<I2NPMessage> out);
|
|
|
|
/** @brief add latency sample */
|
|
void AddLatencySample(const uint64_t ms) { m_Latency = (m_Latency + ms) >> 1; }
|
|
/** @brief get this tunnel's estimated latency */
|
|
uint64_t GetMeanLatency() const { return m_Latency; }
|
|
/** @breif return true if this tunnel's latency fits in range [lowerbound, upperbound] */
|
|
bool LatencyFitsRange(uint64_t lowerbound, uint64_t upperbound) const;
|
|
|
|
bool LatencyIsKnown() const { return m_Latency > 0; }
|
|
protected:
|
|
|
|
void PrintHops (std::stringstream& s) const;
|
|
|
|
private:
|
|
|
|
std::shared_ptr<const TunnelConfig> m_Config;
|
|
std::vector<std::unique_ptr<TunnelHop> > m_Hops;
|
|
std::shared_ptr<TunnelPool> m_Pool; // pool, tunnel belongs to, or null
|
|
TunnelState m_State;
|
|
bool m_IsRecreated;
|
|
uint64_t m_Latency; // in milliseconds
|
|
};
|
|
|
|
class OutboundTunnel: public Tunnel
|
|
{
|
|
public:
|
|
|
|
OutboundTunnel (std::shared_ptr<const TunnelConfig> config):
|
|
Tunnel (config), m_Gateway (this), m_EndpointIdentHash (config->GetLastIdentHash ()) {};
|
|
|
|
void SendTunnelDataMsg (const uint8_t * gwHash, uint32_t gwTunnel, std::shared_ptr<i2p::I2NPMessage> msg);
|
|
virtual void SendTunnelDataMsg (const std::vector<TunnelMessageBlock>& msgs); // multiple messages
|
|
const i2p::data::IdentHash& GetEndpointIdentHash () const { return m_EndpointIdentHash; };
|
|
virtual size_t GetNumSentBytes () const { return m_Gateway.GetNumSentBytes (); };
|
|
void Print (std::stringstream& s) const;
|
|
|
|
// implements TunnelBase
|
|
void HandleTunnelDataMsg (std::shared_ptr<const i2p::I2NPMessage> tunnelMsg);
|
|
|
|
bool IsInbound() const { return false; }
|
|
|
|
private:
|
|
|
|
std::mutex m_SendMutex;
|
|
TunnelGateway m_Gateway;
|
|
i2p::data::IdentHash m_EndpointIdentHash;
|
|
};
|
|
|
|
class InboundTunnel: public Tunnel, public std::enable_shared_from_this<InboundTunnel>
|
|
{
|
|
public:
|
|
|
|
InboundTunnel (std::shared_ptr<const TunnelConfig> config): Tunnel (config), m_Endpoint (true) {};
|
|
void HandleTunnelDataMsg (std::shared_ptr<const I2NPMessage> msg);
|
|
virtual size_t GetNumReceivedBytes () const { return m_Endpoint.GetNumReceivedBytes (); };
|
|
void Print (std::stringstream& s) const;
|
|
bool IsInbound() const { return true; }
|
|
|
|
// override TunnelBase
|
|
void Cleanup () { m_Endpoint.Cleanup (); };
|
|
|
|
private:
|
|
|
|
TunnelEndpoint m_Endpoint;
|
|
};
|
|
|
|
class ZeroHopsInboundTunnel: public InboundTunnel
|
|
{
|
|
public:
|
|
|
|
ZeroHopsInboundTunnel ();
|
|
void SendTunnelDataMsg (std::shared_ptr<i2p::I2NPMessage> msg);
|
|
void Print (std::stringstream& s) const;
|
|
size_t GetNumReceivedBytes () const { return m_NumReceivedBytes; };
|
|
|
|
private:
|
|
|
|
size_t m_NumReceivedBytes;
|
|
};
|
|
|
|
class ZeroHopsOutboundTunnel: public OutboundTunnel
|
|
{
|
|
public:
|
|
|
|
ZeroHopsOutboundTunnel ();
|
|
void SendTunnelDataMsg (const std::vector<TunnelMessageBlock>& msgs);
|
|
void Print (std::stringstream& s) const;
|
|
size_t GetNumSentBytes () const { return m_NumSentBytes; };
|
|
|
|
private:
|
|
|
|
size_t m_NumSentBytes;
|
|
};
|
|
|
|
class Tunnels
|
|
{
|
|
public:
|
|
|
|
Tunnels ();
|
|
~Tunnels ();
|
|
void Start ();
|
|
void Stop ();
|
|
|
|
std::shared_ptr<InboundTunnel> GetPendingInboundTunnel (uint32_t replyMsgID);
|
|
std::shared_ptr<OutboundTunnel> GetPendingOutboundTunnel (uint32_t replyMsgID);
|
|
std::shared_ptr<InboundTunnel> GetNextInboundTunnel ();
|
|
std::shared_ptr<OutboundTunnel> GetNextOutboundTunnel ();
|
|
std::shared_ptr<TunnelPool> GetExploratoryPool () const { return m_ExploratoryPool; };
|
|
std::shared_ptr<TunnelBase> GetTunnel (uint32_t tunnelID);
|
|
int GetTransitTunnelsExpirationTimeout ();
|
|
void AddTransitTunnel (std::shared_ptr<TransitTunnel> tunnel);
|
|
void AddOutboundTunnel (std::shared_ptr<OutboundTunnel> newTunnel);
|
|
void AddInboundTunnel (std::shared_ptr<InboundTunnel> newTunnel);
|
|
std::shared_ptr<InboundTunnel> CreateInboundTunnel (std::shared_ptr<TunnelConfig> config, std::shared_ptr<OutboundTunnel> outboundTunnel);
|
|
std::shared_ptr<OutboundTunnel> CreateOutboundTunnel (std::shared_ptr<TunnelConfig> config);
|
|
void PostTunnelData (std::shared_ptr<I2NPMessage> msg);
|
|
void PostTunnelData (const std::vector<std::shared_ptr<I2NPMessage> >& msgs);
|
|
void AddPendingTunnel (uint32_t replyMsgID, std::shared_ptr<InboundTunnel> tunnel);
|
|
void AddPendingTunnel (uint32_t replyMsgID, std::shared_ptr<OutboundTunnel> tunnel);
|
|
std::shared_ptr<TunnelPool> CreateTunnelPool (int numInboundHops,
|
|
int numOuboundHops, int numInboundTunnels, int numOutboundTunnels);
|
|
void DeleteTunnelPool (std::shared_ptr<TunnelPool> pool);
|
|
void StopTunnelPool (std::shared_ptr<TunnelPool> pool);
|
|
|
|
private:
|
|
|
|
template<class TTunnel>
|
|
std::shared_ptr<TTunnel> CreateTunnel (std::shared_ptr<TunnelConfig> config, std::shared_ptr<OutboundTunnel> outboundTunnel = nullptr);
|
|
|
|
template<class TTunnel>
|
|
std::shared_ptr<TTunnel> GetPendingTunnel (uint32_t replyMsgID, const std::map<uint32_t, std::shared_ptr<TTunnel> >& pendingTunnels);
|
|
|
|
void HandleTunnelGatewayMsg (std::shared_ptr<TunnelBase> tunnel, std::shared_ptr<I2NPMessage> msg);
|
|
|
|
void Run ();
|
|
void ManageTunnels ();
|
|
void ManageOutboundTunnels ();
|
|
void ManageInboundTunnels ();
|
|
void ManageTransitTunnels ();
|
|
void ManagePendingTunnels ();
|
|
template<class PendingTunnels>
|
|
void ManagePendingTunnels (PendingTunnels& pendingTunnels);
|
|
void ManageTunnelPools ();
|
|
|
|
std::shared_ptr<ZeroHopsInboundTunnel> CreateZeroHopsInboundTunnel ();
|
|
std::shared_ptr<ZeroHopsOutboundTunnel> CreateZeroHopsOutboundTunnel ();
|
|
|
|
private:
|
|
|
|
bool m_IsRunning;
|
|
std::thread * m_Thread;
|
|
std::map<uint32_t, std::shared_ptr<InboundTunnel> > m_PendingInboundTunnels; // by replyMsgID
|
|
std::map<uint32_t, std::shared_ptr<OutboundTunnel> > m_PendingOutboundTunnels; // by replyMsgID
|
|
std::list<std::shared_ptr<InboundTunnel> > m_InboundTunnels;
|
|
std::list<std::shared_ptr<OutboundTunnel> > m_OutboundTunnels;
|
|
std::list<std::shared_ptr<TransitTunnel> > m_TransitTunnels;
|
|
std::unordered_map<uint32_t, std::shared_ptr<TunnelBase> > m_Tunnels; // tunnelID->tunnel known by this id
|
|
std::mutex m_PoolsMutex;
|
|
std::list<std::shared_ptr<TunnelPool>> m_Pools;
|
|
std::shared_ptr<TunnelPool> m_ExploratoryPool;
|
|
i2p::util::Queue<std::shared_ptr<I2NPMessage> > m_Queue;
|
|
|
|
// some stats
|
|
int m_NumSuccesiveTunnelCreations, m_NumFailedTunnelCreations;
|
|
|
|
public:
|
|
|
|
// for HTTP only
|
|
const decltype(m_OutboundTunnels)& GetOutboundTunnels () const { return m_OutboundTunnels; };
|
|
const decltype(m_InboundTunnels)& GetInboundTunnels () const { return m_InboundTunnels; };
|
|
const decltype(m_TransitTunnels)& GetTransitTunnels () const { return m_TransitTunnels; };
|
|
|
|
size_t CountTransitTunnels() const;
|
|
size_t CountInboundTunnels() const;
|
|
size_t CountOutboundTunnels() const;
|
|
|
|
int GetQueueSize () { return m_Queue.GetSize (); };
|
|
int GetTunnelCreationSuccessRate () const // in percents
|
|
{
|
|
int totalNum = m_NumSuccesiveTunnelCreations + m_NumFailedTunnelCreations;
|
|
return totalNum ? m_NumSuccesiveTunnelCreations*100/totalNum : 0;
|
|
}
|
|
};
|
|
|
|
extern Tunnels tunnels;
|
|
}
|
|
}
|
|
|
|
#endif
|