#include "pathbuilder.hpp" #include "llarp/path/pathset.hpp" #include "path.hpp" #include "path_context.hpp" #include #include #include #include #include #include #include #include #include namespace llarp { namespace { auto path_cat = log::Cat("path"); } namespace path { bool BuildLimiter::Attempt(const RouterID& router) { return m_EdgeLimiter.Insert(router); } void BuildLimiter::Decay(llarp_time_t now) { m_EdgeLimiter.Decay(now); } bool BuildLimiter::Limited(const RouterID& router) const { return m_EdgeLimiter.Contains(router); } Builder::Builder(Router* p_router, size_t pathNum, size_t hops) : path::PathSet{pathNum}, _run{true}, router{p_router}, numHops{hops} {} /* - For each hop: * SetupHopKeys: * - Generate Ed keypair for the hop. ("commkey") * - Use that key and the hop's pubkey for DH key exchange (makes "hop.shared") * - Note: this *was* using hop's "enckey" but we're getting rid of that * - hop's "upstream" RouterID is next hop, or that hop's ID if it is terminal hop * - hop's chacha nonce is hash of symmetric key (hop.shared) from DH * - hop's "txID" and "rxID" are chosen before this step * - txID is the path ID for messages coming *from* the client/path origin * - rxID is the path ID for messages going *to* it. * * CreateHopInfoFrame: * - bt-encode "hop info": * - path lifetime * - protocol version * - txID * - rxID * - nonce * - upstream hop RouterID * - ephemeral public key (for DH) * - generate *second* ephemeral Ed keypair... ("framekey") TODO: why? * - generate DH symmetric key using "framekey" and hop's pubkey * - generate nonce for second encryption * - encrypt "hop info" using this symmetric key * - bt-encode nonce, "framekey" pubkey, encrypted "hop info" * - hash this bt-encoded string * - bt-encode hash and the frame in a dict, serialize * * * all of these "frames" go in a list, along with any needed dummy frames */ void Builder::setup_hop_keys(path::PathHopConfig& hop, const RouterID& nextHop) { // generate key crypto::encryption_keygen(hop.commkey); hop.nonce.Randomize(); // do key exchange if (!crypto::dh_client(hop.shared, hop.rc.router_id(), hop.commkey, hop.nonce)) { auto err = fmt::format("{} failed to generate shared key for path build!", Name()); log::error(path_cat, err); throw std::runtime_error{std::move(err)}; } // generate nonceXOR value self->hop->pathKey ShortHash hash; crypto::shorthash(hash, hop.shared.data(), hop.shared.size()); hop.nonceXOR = hash.data(); // nonceXOR is 24 bytes, ShortHash is 32; this will truncate hop.upstream = nextHop; } std::string Builder::create_hop_info_frame(const path::PathHopConfig& hop) { std::string hop_info; { oxenc::bt_dict_producer btdp; btdp.append("COMMKEY", hop.commkey.toPublic().ToView()); btdp.append("LIFETIME", path::DEFAULT_LIFETIME.count()); btdp.append("NONCE", hop.nonce.ToView()); btdp.append("RX", hop.rxID.ToView()); btdp.append("TX", hop.txID.ToView()); btdp.append("UPSTREAM", hop.upstream.ToView()); hop_info = std::move(btdp).str(); } SecretKey framekey; crypto::encryption_keygen(framekey); SharedSecret shared; SymmNonce outer_nonce; outer_nonce.Randomize(); // derive (outer) shared key if (!crypto::dh_client(shared, hop.rc.router_id(), framekey, outer_nonce)) { log::error(path_cat, "DH client failed during hop info encryption!"); throw std::runtime_error{"DH failed during hop info encryption"}; } // encrypt hop_info (mutates in-place) if (!crypto::xchacha20( reinterpret_cast(hop_info.data()), hop_info.size(), shared, outer_nonce)) { log::error(path_cat, "Hop info encryption failed!"); throw std::runtime_error{"Hop info encrypttion failed"}; } std::string hashed_data; { oxenc::bt_dict_producer btdp; btdp.append("ENCRYPTED", hop_info); btdp.append("NONCE", outer_nonce.ToView()); btdp.append("PUBKEY", framekey.toPublic().ToView()); hashed_data = std::move(btdp).str(); } std::string hash; hash.reserve(SHORTHASHSIZE); if (!crypto::hmac( reinterpret_cast(hash.data()), reinterpret_cast(hashed_data.data()), hashed_data.size(), shared)) { log::error(path_cat, "Failed to generate HMAC for hop info"); throw std::runtime_error{"Failed to generate HMAC for hop info"}; } oxenc::bt_dict_producer btdp; btdp.append("FRAME", hashed_data); btdp.append("HASH", hash); return std::move(btdp).str(); } void Builder::ResetInternalState() { buildIntervalLimit = PATH_BUILD_RATE; lastBuild = 0s; } void Builder::Tick(llarp_time_t now) { PathSet::Tick(now); now = llarp::time_now_ms(); router->pathbuild_limiter().Decay(now); ExpirePaths(now, router); if (ShouldBuildMore(now)) BuildOne(); TickPaths(router); if (m_BuildStats.attempts > 50) { if (m_BuildStats.SuccessRatio() <= BuildStats::MinGoodRatio && now - m_LastWarn > 5s) { LogWarn(Name(), " has a low path build success. ", m_BuildStats); m_LastWarn = now; } } } util::StatusObject Builder::ExtractStatus() const { util::StatusObject obj{ {"buildStats", m_BuildStats.ExtractStatus()}, {"numHops", uint64_t{numHops}}, {"numPaths", uint64_t{numDesiredPaths}}}; std::transform( m_Paths.begin(), m_Paths.end(), std::back_inserter(obj["paths"]), [](const auto& item) -> util::StatusObject { return item.second->ExtractStatus(); }); return obj; } std::optional Builder::SelectFirstHop(const std::set& exclude) const { std::optional found = std::nullopt; router->for_each_connection([&](link::Connection& conn) { const auto& rc = conn.remote_rc; const auto& rid = rc.router_id(); #ifndef TESTNET if (router->IsBootstrapNode(rid)) return; #endif if (exclude.count(rid)) return; if (BuildCooldownHit(rid)) return; if (router->router_profiling().IsBadForPath(rid)) return; found = rc; }); return found; } std::optional> Builder::GetHopsForBuild() { auto filter = [r = router](const auto& rc) -> bool { return not r->router_profiling().IsBadForPath(rc.router_id(), 1); }; if (const auto maybe = router->node_db()->GetRandom(filter)) { return GetHopsAlignedToForBuild(maybe->router_id()); } return std::nullopt; } bool Builder::Stop() { _run = false; // tell all our paths that they are to be ignored const auto now = Now(); for (auto& item : m_Paths) { item.second->EnterState(ePathIgnore, now); } return true; } bool Builder::IsStopped() const { return !_run.load(); } bool Builder::ShouldRemove() const { return IsStopped() and NumInStatus(ePathEstablished) == 0; } bool Builder::BuildCooldownHit(RouterID edge) const { return router->pathbuild_limiter().Limited(edge); } bool Builder::BuildCooldownHit(llarp_time_t now) const { return now < lastBuild + buildIntervalLimit; } bool Builder::ShouldBuildMore(llarp_time_t now) const { if (IsStopped()) return false; if (BuildCooldownHit(now)) return false; return PathSet::ShouldBuildMore(now); } void Builder::BuildOne(PathRole roles) { if (const auto maybe = GetHopsForBuild()) Build(*maybe, roles); } bool Builder::UrgentBuild(llarp_time_t) const { return buildIntervalLimit > MIN_PATH_BUILD_INTERVAL * 4; } std::optional> Builder::GetHopsAlignedToForBuild(RouterID endpoint, const std::set& exclude) { const auto pathConfig = router->config()->paths; std::vector hops; { const auto maybe = SelectFirstHop(exclude); if (not maybe.has_value()) { log::warning(path_cat, "{} has no first hop candidate", Name()); return std::nullopt; } hops.emplace_back(*maybe); }; RemoteRC endpointRC; if (const auto maybe = router->node_db()->get_rc(endpoint)) { endpointRC = *maybe; } else return std::nullopt; for (size_t idx = hops.size(); idx < numHops; ++idx) { if (idx + 1 == numHops) { hops.emplace_back(endpointRC); } else { auto filter = [&hops, r = router, endpointRC, pathConfig, exclude](const RemoteRC& rc) -> bool { const auto& rid = rc.router_id(); if (exclude.count(rid)) return false; std::set hopsSet; hopsSet.insert(endpointRC); hopsSet.insert(hops.begin(), hops.end()); if (r->router_profiling().IsBadForPath(rid, 1)) return false; for (const auto& hop : hopsSet) { if (hop.router_id() == rid) return false; } hopsSet.insert(rc); #ifndef TESTNET if (not pathConfig.Acceptable(hopsSet)) return false; #endif return rc.router_id() != endpointRC.router_id(); }; if (const auto maybe = router->node_db()->GetRandom(filter)) hops.emplace_back(*maybe); else return std::nullopt; } } return hops; } bool Builder::BuildOneAlignedTo(const RouterID remote) { if (const auto maybe = GetHopsAlignedToForBuild(remote); maybe.has_value()) { LogInfo(Name(), " building path to ", remote); Build(*maybe); return true; } return false; } llarp_time_t Builder::Now() const { return router->now(); } void Builder::Build(std::vector hops, PathRole roles) { if (IsStopped()) { log::info(path_cat, "Path builder is stopped, aborting path build..."); return; } lastBuild = llarp::time_now_ms(); const auto& edge = hops[0].router_id(); if (not router->pathbuild_limiter().Attempt(edge)) { log::warning(path_cat, "{} building too quickly to edge router {}", Name(), edge); return; } std::string path_shortName = "[path " + router->ShortName() + "-"; path_shortName = path_shortName + std::to_string(router->NextPathBuildNumber()) + "]"; auto path = std::make_shared(router, hops, GetWeak(), roles, std::move(path_shortName)); log::info( path_cat, "{} building path -> {} : {}", Name(), path->ShortName(), path->HopsString()); oxenc::bt_list_producer frames; auto& path_hops = path->hops; size_t n_hops = path_hops.size(); size_t last_len{0}; for (size_t i = 0; i < n_hops; i++) { bool lastHop = (i == (n_hops - 1)); const auto& nextHop = lastHop ? path_hops[i].rc.router_id() : path_hops[i + 1].rc.router_id(); PathBuildMessage::setup_hop_keys(path_hops[i], nextHop); auto frame_str = PathBuildMessage::serialize(path_hops[i]); // all frames should be the same length...not sure what that is yet if (last_len != 0) assert(frame_str.size() == last_len); last_len = frame_str.size(); frames.append(std::move(frame_str)); } std::string dummy; dummy.reserve(last_len); // append dummy frames; path build request must always have MAX_LEN frames // TODO: with the data structured as it is now (bt-encoded dict as each frame) // the dummy frames can't be completely random; they need to look like // normal frames for (size_t i = 0; i < path::MAX_LEN - n_hops; i++) { randombytes(reinterpret_cast(dummy.data()), dummy.size()); frames.append(dummy); } router->path_context().AddOwnPath(GetSelf(), path); PathBuildStarted(path); // TODO: // Path build fail and success are handled poorly at best and changing how we // handle these responses as well as how we store and use Paths as a whole might // be worth doing sooner rather than later. Leaving some TODOs below where fail // and success live. auto response_cb = [path](oxen::quic::message m) { try { if (m) { // TODO: inform success (what this means needs revisiting, badly) path->EnterState(path::ePathEstablished); return; } if (m.timed_out) { log::warning(path_cat, "Path build timed out"); } else { oxenc::bt_dict_consumer d{m.body()}; auto status = d.require(messages::STATUS_KEY); log::warning(path_cat, "Path build returned failure status: {}", status); } } catch (const std::exception& e) { log::warning(path_cat, "Failed parsing path build response."); } // TODO: inform failure (what this means needs revisiting, badly) path->EnterState(path::ePathFailed); }; if (not router->send_control_message( path->upstream(), "path_build", std::move(frames).str(), std::move(response_cb))) { log::warning(path_cat, "Error sending path_build control message"); // TODO: inform failure (what this means needs revisiting, badly) path->EnterState(path::ePathFailed, router->now()); } } void Builder::HandlePathBuilt(Path_ptr p) { buildIntervalLimit = PATH_BUILD_RATE; router->router_profiling().MarkPathSuccess(p.get()); LogInfo(p->name(), " built latency=", ToString(p->intro.latency)); m_BuildStats.success++; } void Builder::HandlePathBuildFailedAt(Path_ptr p, RouterID edge) { PathSet::HandlePathBuildFailedAt(p, edge); DoPathBuildBackoff(); } void Builder::DoPathBuildBackoff() { static constexpr std::chrono::milliseconds MaxBuildInterval = 30s; // linear backoff buildIntervalLimit = std::min(PATH_BUILD_RATE + buildIntervalLimit, MaxBuildInterval); LogWarn(Name(), " build interval is now ", ToString(buildIntervalLimit)); } void Builder::HandlePathBuildTimeout(Path_ptr p) { router->router_profiling().MarkPathTimeout(p.get()); PathSet::HandlePathBuildTimeout(p); DoPathBuildBackoff(); for (const auto& hop : p->hops) { const auto& target = hop.rc.router_id(); // look up router and see if it's still on the network log::info(path_cat, "Looking up RouterID {} due to path build timeout", target); router->rc_lookup_handler().get_rc( target, [this](auto rid, auto rc, auto success) { if (success && rc) { log::info(path_cat, "Refreshed RouterContact for {}", rid); router->node_db()->put_rc_if_newer(*rc); } else { // remove all connections to this router as it's probably not registered anymore log::warning(path_cat, "Removing router {} due to path build timeout", rid); router->link_manager().deregister_peer(rid); router->node_db()->remove_router(rid); } }, true); } } void Builder::ManualRebuild(size_t num, PathRole roles) { LogDebug(Name(), " manual rebuild ", num); while (num--) BuildOne(roles); } } // namespace path } // namespace llarp