lokinet/llarp/router_contact.hpp
Stephen Shelton 273270916e
The Great Wall of Blame
This commit reflects changes to clang-format rules. Unfortunately,
these rule changes create a massive change to the codebase, which
causes an apparent rewrite of git history.

Git blame's --ignore-rev flag can be used to ignore this commit when
attempting to `git blame` some code.
2020-04-07 12:38:56 -06:00

230 lines
4.4 KiB
C++

#ifndef LLARP_RC_HPP
#define LLARP_RC_HPP
#include <constants/version.hpp>
#include <crypto/types.hpp>
#include <net/address_info.hpp>
#include <net/exit_info.hpp>
#include <util/aligned.hpp>
#include <util/bencode.hpp>
#include <util/status.hpp>
#include <router_version.hpp>
#include <functional>
#include <nlohmann/json.hpp>
#include <vector>
#define MAX_RC_SIZE (1024)
#define NICKLEN (32)
namespace llarp
{
/// NetID
struct NetID final : public AlignedBuffer<8>
{
static NetID&
DefaultValue();
NetID();
explicit NetID(const byte_t* val);
explicit NetID(const NetID& other) = default;
bool
operator==(const NetID& other) const;
bool
operator!=(const NetID& other) const
{
return !(*this == other);
}
std::ostream&
print(std::ostream& stream, int level, int spaces) const
{
Printer printer(stream, level, spaces);
printer.printValue(ToString());
return stream;
}
std::string
ToString() const;
bool
BDecode(llarp_buffer_t* buf);
bool
BEncode(llarp_buffer_t* buf) const;
};
inline std::ostream&
operator<<(std::ostream& out, const NetID& id)
{
return id.print(out, -1, -1);
}
/// RouterContact
struct RouterContact
{
/// for unit tests
static bool BlockBogons;
static llarp_time_t Lifetime;
static llarp_time_t UpdateInterval;
static llarp_time_t StaleInsertionAge;
RouterContact()
{
Clear();
}
struct Hash
{
size_t
operator()(const RouterContact& r) const
{
return PubKey::Hash()(r.pubkey);
}
};
// advertised addresses
std::vector<AddressInfo> addrs;
// network identifier
NetID netID;
// public encryption public key
llarp::PubKey enckey;
// public signing public key
llarp::PubKey pubkey;
// advertised exits
std::vector<ExitInfo> exits;
// signature
llarp::Signature signature;
/// node nickname, yw kee
llarp::AlignedBuffer<NICKLEN> nickname;
llarp_time_t last_updated = 0s;
uint64_t version = LLARP_PROTO_VERSION;
nonstd::optional<RouterVersion> routerVersion;
util::StatusObject
ExtractStatus() const;
nlohmann::json
ToJson() const
{
return ExtractStatus();
}
std::string
ToString() const
{
return ToJson().dump();
}
bool
BEncode(llarp_buffer_t* buf) const;
bool
operator==(const RouterContact& other) const
{
return addrs == other.addrs && enckey == other.enckey && pubkey == other.pubkey
&& signature == other.signature && nickname == other.nickname
&& last_updated == other.last_updated && netID == other.netID;
}
bool
operator<(const RouterContact& other) const
{
return pubkey < other.pubkey;
}
bool
operator!=(const RouterContact& other) const
{
return !(*this == other);
}
void
Clear();
bool
IsExit() const
{
return !exits.empty();
}
bool
BDecode(llarp_buffer_t* buf)
{
Clear();
return bencode_decode_dict(*this, buf);
}
bool
DecodeKey(const llarp_buffer_t& k, llarp_buffer_t* buf);
bool
HasNick() const;
std::string
Nick() const;
bool
IsPublicRouter() const;
void
SetNick(string_view nick);
bool
Verify(llarp_time_t now, bool allowExpired = true) const;
bool
Sign(const llarp::SecretKey& secret);
/// does this RC expire soon? default delta is 1 minute
bool
ExpiresSoon(llarp_time_t now, llarp_time_t dlt = 1min) const;
/// returns true if this RC is expired and should be removed
bool
IsExpired(llarp_time_t now) const;
/// returns time in ms until we expire or 0 if we have expired
llarp_time_t
TimeUntilExpires(llarp_time_t now) const;
/// get the age of this RC in ms
llarp_time_t
Age(llarp_time_t now) const;
bool
OtherIsNewer(const RouterContact& other) const
{
return last_updated < other.last_updated;
}
std::ostream&
print(std::ostream& stream, int level, int spaces) const;
bool
Read(const char* fname);
bool
Write(const char* fname) const;
bool
VerifySignature() const;
};
inline std::ostream&
operator<<(std::ostream& out, const RouterContact& rc)
{
return rc.print(out, -1, -1);
}
using RouterLookupHandler = std::function<void(const std::vector<RouterContact>&)>;
} // namespace llarp
#endif