Skip to content
This repository has been archived by the owner on Sep 1, 2022. It is now read-only.

RouterInfo: refactor RI writer/creator + add docs #626

Merged
merged 2 commits into from
Apr 21, 2017
Merged

RouterInfo: refactor RI writer/creator + add docs #626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4af22c6
RouterInfo: add docs to caps flag traits
anonimal Apr 18, 2017
97bdf53
RouterInfo: refactor RI writer/creator
anonimal Apr 21, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
322 changes: 178 additions & 144 deletions src/core/router/info.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,7 +174,7 @@ void RouterInfo::Update(
m_SupportedTransports = 0;
m_Caps = 0;
m_Addresses.clear();
m_Properties.clear();
m_Options.clear();
memcpy(m_Buffer.get(), buf, len);
m_BufferLen = len;
ReadFromBuffer(true);
Expand Down Expand Up @@ -530,128 +530,173 @@ void RouterInfo::UpdateCapsProperty()
SetProperty("caps", caps);
}

void RouterInfo::WriteToStream(
std::ostream& s) {
std::uint64_t ts = htobe64(m_Timestamp);
s.write(reinterpret_cast<char *>(&ts), sizeof(ts));
// addresses
std::uint8_t num_addresses = m_Addresses.size();
s.write(reinterpret_cast<char *>(&num_addresses), sizeof(num_addresses));
for (auto& address : m_Addresses) {
s.write(reinterpret_cast<char *>(&address.cost), sizeof(address.cost));
s.write(reinterpret_cast<char *>(&address.date), sizeof(address.date));
std::stringstream properties;
if (address.transport == Transport::NTCP) {
WriteString("NTCP", s);
} else if (address.transport == Transport::SSU) {
WriteString("SSU", s);
// caps
WriteString("caps", properties);
properties << '=';
std::string caps;
if (IsPeerTesting())
caps += GetTrait(CapsFlag::SSUTesting);
if (IsIntroducer())
caps += GetTrait(CapsFlag::SSUIntroducer);
WriteString(caps, properties);
properties << ';';
} else {
WriteString("", s);
}
WriteString("host", properties);
properties << '=';
WriteString(address.host.to_string(), properties);
properties << ';';
if (address.transport == Transport::SSU) {
// write introducers if any
if (address.introducers.size() > 0) {
int i = 0;
for (auto introducer : address.introducers) {
WriteString(
"ihost" + boost::lexical_cast<std::string>(i),
properties);
properties << '=';
WriteString(
introducer.host.to_string(),
properties);
properties << ';';
i++;
}
i = 0;
for (auto introducer : address.introducers) {
WriteString("ikey" + boost::lexical_cast<std::string>(i), properties);
properties << '=';
char value[64];
std::size_t len =
kovri::core::ByteStreamToBase64(introducer.key, 32, value, 64);
value[len] = 0;
WriteString(value, properties);
properties << ';';
i++;
}
i = 0;
for (auto introducer : address.introducers) {
WriteString(
"iport" + boost::lexical_cast<std::string>(i),
properties);
properties << '=';
WriteString(
boost::lexical_cast<std::string>(introducer.port),
properties);
properties << ';';
i++;
// TODO(anonimal): debug + trace logging
// TODO(anonimal): unit-test
void RouterInfo::CreateRouterInfo(
core::StringStream& router_info,
const PrivateKeys& private_keys)
{
LOG(debug) << "RouterInfo: " << __func__;

// Write ident
// TODO(anonimal): review the following arbitrary size (must be >= 387)
std::array<std::uint8_t, 1024> ident{};
auto ident_len =
private_keys.GetPublic().ToBuffer(ident.data(), ident.size());
router_info.Write(ident.data(), ident_len);

// Set published timestamp
SetTimestamp(core::GetMillisecondsSinceEpoch());

// Write published timestamp
std::uint64_t timestamp = htobe64(GetTimestamp());
router_info.Write(&timestamp, sizeof(timestamp));

// Write number of addresses to follow
std::uint8_t num_addresses = GetAddresses().size();
router_info.Write(&num_addresses, sizeof(num_addresses));

// RI options, once populated, written to RI stream
core::StringStream options(
GetTrait(Trait::Delimiter), GetTrait(Trait::Terminator));

LOG(debug) << "RouterInfo: " << __func__ << ": processing "
<< GetAddresses().size() << " addresses";

// Write each address + options
for (const auto& address : GetAddresses())
{
// Reset options for next address
options.Str(std::string());

// Write cost + date
router_info.Write(&address.cost, sizeof(address.cost));
router_info.Write(&address.date, sizeof(address.date));

// Write transport
switch (address.transport)
{
case Transport::NTCP:
router_info.WriteByteAndString(GetTrait(Trait::NTCP));
break;
case Transport::SSU:
{
router_info.WriteByteAndString(GetTrait(Trait::SSU));

// Get SSU capabilities
std::string caps;
if (IsPeerTesting())
caps += GetTrait(CapsFlag::SSUTesting);
if (IsIntroducer())
caps += GetTrait(CapsFlag::SSUIntroducer);

// Write SSU capabilities
options.WriteKeyPair(GetTrait(Trait::Caps), caps);
break;
}
default:
// TODO(anonimal): review
router_info.WriteByteAndString(GetTrait(Trait::Unknown));
break;
}
i = 0;
for (auto introducer : address.introducers) {
WriteString(
"itag" + boost::lexical_cast<std::string>(i),
properties);
properties << '=';
WriteString(
boost::lexical_cast<std::string>(introducer.tag),
properties);
properties << ';';
i++;

// Write host
options.WriteKeyPair(GetTrait(Trait::Host), address.host.to_string());

// SSU
if (address.transport == Transport::SSU)
{
// Write introducers (if any)
if (!address.introducers.empty())
{
LOG(debug) << "RouterInfo: " << __func__ << " writing "
<< address.introducers.size() << " introducers";

std::uint8_t count{};
for (const auto& introducer : address.introducers)
{
std::string num = boost::lexical_cast<std::string>(count);

// Write introducer host
options.WriteKeyPair(
GetTrait(Trait::IntroHost) + num,
introducer.host.to_string());

// Write introducer key
std::array<char, 64> key{};
core::ByteStreamToBase64(
introducer.key,
sizeof(introducer.key),
key.data(),
key.size());

options.WriteKeyPair(
GetTrait(Trait::IntroKey) + num, key.data());

// Write introducer port
options.WriteKeyPair(
GetTrait(Trait::IntroPort) + num,
boost::lexical_cast<std::string>(introducer.port));

// Write introducer tag
options.WriteKeyPair(
GetTrait(Trait::IntroTag) + num,
boost::lexical_cast<std::string>(introducer.tag));

count++;
}
}

// Write key
std::array<char, 64> value{};
core::ByteStreamToBase64(
address.key, sizeof(address.key), value.data(), value.size());

options.WriteKeyPair(GetTrait(Trait::Key), value.data());

// Write MTU
if (address.mtu)
options.WriteKeyPair(
GetTrait(Trait::MTU),
boost::lexical_cast<std::string>(address.mtu));
}
}
// write intro key
WriteString("key", properties);
properties << '=';
char value[64];
std::size_t len = kovri::core::ByteStreamToBase64(address.key, 32, value, 64);
value[len] = 0;
WriteString(value, properties);
properties << ';';
// write mtu
if (address.mtu) {
WriteString("mtu", properties);
properties << '=';
WriteString(boost::lexical_cast<std::string>(address.mtu), properties);
properties << ';';
}

// Write port
options.WriteKeyPair(
GetTrait(Trait::Port),
boost::lexical_cast<std::string>(address.port));

// Write size of populated options
std::uint16_t size = htobe16(options.Str().size());
router_info.Write(&size, sizeof(size));

// Write options to RI
router_info.Write(options.Str().c_str(), options.Str().size());
}
WriteString("port", properties);
properties << '=';
WriteString(boost::lexical_cast<std::string>(address.port), properties);
properties << ';';
std::uint16_t size = htobe16(properties.str().size());
s.write(reinterpret_cast<char *>(&size), sizeof(size));
s.write(properties.str().c_str(), properties.str().size());
}
// peers
std::uint8_t num_peers = 0;
s.write(reinterpret_cast<char *>(&num_peers), sizeof(num_peers));
// properties
std::stringstream properties;
for (auto& p : m_Properties) {
WriteString(p.first, properties);
properties << '=';
WriteString(p.second, properties);
properties << ';';
}
std::uint16_t size = htobe16(properties.str().size());
s.write(reinterpret_cast<char *>(&size), sizeof(size));
s.write(properties.str().c_str(), properties.str().size());

// Write number of peers
// Note: this is unused / unimplemented, see RI spec
std::uint8_t num_peers{};
router_info.Write(&num_peers, sizeof(num_peers));

// Reset for more options
options.Str(std::string());

// Write remaining options
for (const auto& opt : GetOptions())
options.WriteKeyPair(opt.first, opt.second);

// Write size of remaining options
std::uint16_t size = htobe16(options.Str().size());
router_info.Write(&size, sizeof(size));

// Write remaining options to RI
router_info.Write(options.Str().c_str(), options.Str().size());

// TODO(anonimal): we should implement RI signing *here*

LOG(debug) << "RouterInfo: " << __func__
<< " total RI size: " << router_info.Str().size();
}

const std::uint8_t* RouterInfo::LoadBuffer() {
Expand All @@ -664,23 +709,20 @@ const std::uint8_t* RouterInfo::LoadBuffer() {
return m_Buffer.get();
}

void RouterInfo::CreateBuffer(const PrivateKeys& privateKeys) {
m_Timestamp = kovri::core::GetMillisecondsSinceEpoch(); // refresh timestamp
std::stringstream s;
std::uint8_t ident[1024];
auto ident_len = privateKeys.GetPublic().ToBuffer(ident, 1024);
s.write(reinterpret_cast<char *>(ident), ident_len);
WriteToStream(s);
m_BufferLen = s.str().size();
void RouterInfo::CreateBuffer(const PrivateKeys& private_keys) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wrong brackets style (Sorry, it was too tempting :) )

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I chose not to run clang-format on this function because it would've done more than just newline brace and, from the contributing guide:

please try to not mix formatting fixes with non-formatting commits

I'm guilty of mixing elsewhere but that's because of the amount of re-write that was involved (in those places).

If this brace bugs you enough, that can be fixed. Otherwise, I had planned on doing a complete style check-in / running clang-format on both files once RI refactoring was done.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was mostly for the joke

core::StringStream router_info;
CreateRouterInfo(router_info, private_keys);
m_BufferLen = router_info.Str().size();
if (!m_Buffer)
m_Buffer = std::make_unique<std::uint8_t[]>(MAX_RI_BUFFER_SIZE);
memcpy(m_Buffer.get(), s.str().c_str(), m_BufferLen);
memcpy(m_Buffer.get(), router_info.Str().c_str(), m_BufferLen);
// signature
privateKeys.Sign(
// TODO(anonimal): signing should be done when creating RI, not after. Requires other refactoring.
private_keys.Sign(
reinterpret_cast<std::uint8_t *>(m_Buffer.get()),
m_BufferLen,
reinterpret_cast<std::uint8_t *>(m_Buffer.get()) + m_BufferLen);
m_BufferLen += privateKeys.GetPublic().GetSignatureLen();
m_BufferLen += private_keys.GetPublic().GetSignatureLen();
}

void RouterInfo::SaveToFile(
Expand All @@ -697,14 +739,6 @@ void RouterInfo::SaveToFile(
}
}

void RouterInfo::WriteString(
const std::string& str,
std::ostream& s) {
std::uint8_t len = str.size();
s.write(reinterpret_cast<char *>(&len), 1);
s.write(str.c_str(), len);
}

void RouterInfo::AddNTCPAddress(
const std::string& host,
std::uint16_t port) {
Expand Down Expand Up @@ -795,12 +829,12 @@ void RouterInfo::SetCaps(
void RouterInfo::SetProperty(
const std::string& key,
const std::string& value) {
m_Properties[key] = value;
m_Options[key] = value;
}

void RouterInfo::DeleteProperty(
const std::string& key) {
m_Properties.erase(key);
m_Options.erase(key);
}

bool RouterInfo::IsFloodfill() const {
Expand Down Expand Up @@ -909,9 +943,9 @@ const std::string RouterInfo::GetDescription(const std::string& tabs) const
<< m_RouterIdentity.GetDescription(tabs + "\t") << tabs
<< "\tPublished: " << boost::posix_time::to_simple_string(timestamp)
<< std::endl
<< tabs << "\tOptions(" << m_Properties.size() << "): " << std::endl;
for (const auto& p : m_Properties)
ss << tabs << "\t\t[" << p.first << "] : [" << p.second << "]" << std::endl;
<< tabs << "\tOptions(" << m_Options.size() << "): " << std::endl;
for (const auto& opt : m_Options)
ss << tabs << "\t\t[" << opt.first << "] : [" << opt.second << "]" << std::endl;
ss << tabs << "\tSSU Caps: ["
<< (IsPeerTesting() ? GetTrait(CapsFlag::SSUTesting)
: GetTrait(CapsFlag::Unknown))
Expand Down
Loading