You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
lokinet/llarp/rpc/rpc_server.cpp

713 lines
26 KiB
C++

#include "rpc_server.hpp"
#include <llarp/router/route_poker.hpp>
#include <llarp/constants/platform.hpp>
#include <llarp/constants/version.hpp>
#include <nlohmann/json.hpp>
#include <llarp/exit/context.hpp>
#include <llarp/net/ip_range.hpp>
#include <llarp/quic/tunnel.hpp>
#include <llarp/service/context.hpp>
#include <llarp/service/outbound_context.hpp>
#include <llarp/service/auth.hpp>
#include <llarp/service/name.hpp>
#include <llarp/router/abstractrouter.hpp>
#include <llarp/dns/dns.hpp>
namespace llarp::rpc
{
RpcServer::RpcServer(LMQ_ptr lmq, AbstractRouter* r) : m_LMQ(std::move(lmq)), m_Router(r)
Config file improvements (#1397) * Config file API/comment improvements API improvements: ================= Make the config API use position-independent tag parameters (Required, Default{123}, MultiValue) rather than a sequence of bools with overloads. For example, instead of: conf.defineOption<int>("a", "b", false, true, 123, [] { ... }); you now write: conf.defineOption<int>("a", "b", MultiValue, Default{123}, [] { ... }); The tags are: - Required - MultiValue - Default{value} plus new abilities (see below): - Hidden - RelayOnly - ClientOnly - Comment{"line1", "line2", "line3"} Made option definition more powerful: ===================================== - `Hidden` allows you to define an option that won't show up in the generated config file if it isn't set. - `RelayOnly`/`ClientOnly` sets up an option that is only accepted and only shows up for relay or client configs. (If neither is specified the option shows up in both modes). - `Comment{...}` lets the option comments be specified as part of the defineOption. Comment improvements ==================== - Rewrote comments for various options to expand on details. - Inlined all the comments with the option definitions. - Several options that were missing comments got comments added. - Made various options for deprecated and or internal options hidden by default so that they don't show up in a default config file. - show the section comment (but not option comments) *after* the [section] tag instead of before it as it makes more sense that way (particularly for the [bind] section which has a new long comment to describe how it works). Disable profiling by default ============================ We had this weird state where we use and store profiling by default but never *load* it when starting up. This commit makes us just not use profiling at all unless explicitly enabled. Other misc changes: =================== - change default worker threads to 0 (= num cpus) instead of 1, and fix it to allow 0. - Actually apply worker-threads option - fixed default data-dir value erroneously having quotes around it - reordered ifname/ifaddr/mapaddr (was previously mapaddr/ifaddr/ifname) as mapaddr is a sort of specialization of ifaddr and so makes more sense to come after it (particularly because it now references ifaddr in its help message). - removed peer-stats option (since we always require it for relays and never use it for clients) - removed router profiles filename option (this doesn't need to be configurable) - removed defunct `service-node-seed` option - Change default logging output file to "" (which means stdout), and also made "-" work for stdout. * Router hive compilation fixes * Comments for SNApp SRV settings in ini file * Add extra blank line after section comments * Better deprecated option handling Allow {client,relay}-only options in {relay,client} configs to be specified as implicitly deprecated options: they warn, and don't set anything. Add an explicit `Deprecated` tag and move deprecated option handling into definition.cpp. * Move backwards compat options into section definitions Keep the "addBackwardsCompatibleConfigOptions" only for options in sections that no longer exist. * Fix INI parsing issues & C++17-ify - don't allow inline comments because it seems they aren't allowed in ini formats in general, and is going to cause problems if there is a comment character in a value (e.g. an exit auth string). Additionally it was breaking on a line such as: # some comment; see? because it was treating only `; see?` as the comment and then producing an error message about the rest of the line being invalid. - make section parsing stricter: the `[` and `]` have to be at the beginning at end of the line now (after stripping whitespace). - Move whitespace stripping to the top since everything in here does it. - chop off string_view suffix/prefix rather than maintaining position values - fix potential infinite loop/segfault when given a line such as `]foo[` * Make config parsing failure fatal Load() LogError's and returns false on failure, so we weren't aborting on config file errors. * Formatting: allow `{}` for empty functions/structs Instead of using two lines when empty: { } * Make default dns bind 127.0.0.1 on non-Linux * Don't show empty section; fix tests We can conceivably have sections that only make sense for clients or relays, and so want to completely omit that section if we have no options for the type of config being generated. Also fixes missing empty lines between tests. Co-authored-by: Thomas Winget <tewinget@gmail.com>
4 years ago
{}
/// maybe parse json from message paramter at index
std::optional<nlohmann::json>
MaybeParseJSON(const oxenmq::Message& msg, size_t index = 0)
{
try
{
const auto& str = msg.data.at(index);
return nlohmann::json::parse(str);
}
catch (std::exception&)
{
return std::nullopt;
}
}
template <typename Result_t>
std::string
CreateJSONResponse(Result_t result)
{
const auto obj = nlohmann::json{
{"error", nullptr},
{"result", result},
};
return obj.dump();
}
std::string
CreateJSONError(std::string_view msg)
{
const auto obj = nlohmann::json{
{"error", msg},
};
return obj.dump();
}
/// fake packet source that serializes repsonses back into dns
class DummyPacketSource : public dns::PacketSource_Base
{
std::function<void(std::optional<dns::Message>)> func;
public:
SockAddr dumb;
template <typename Callable>
DummyPacketSource(Callable&& f) : func{std::forward<Callable>(f)}
{}
bool
WouldLoop(const SockAddr&, const SockAddr&) const override
{
return false;
};
/// send packet with src and dst address containing buf on this packet source
void
SendTo(const SockAddr&, const SockAddr&, OwnedBuffer buf) const override
{
func(dns::MaybeParseDNSMessage(buf));
}
/// stop reading packets and end operation
void
Stop() override{};
/// returns the sockaddr we are bound on if applicable
std::optional<SockAddr>
BoundOn() const override
{
return std::nullopt;
}
};
/// a function that replies to an rpc request
using ReplyFunction_t = std::function<void(std::string)>;
std::shared_ptr<EndpointBase>
GetEndpointByName(AbstractRouter* r, std::string name)
{
if (r->IsServiceNode())
{
return r->exitContext().GetExitEndpoint(name);
}
else
{
return r->hiddenServiceContext().GetEndpointByName(name);
}
}
void
HandleJSONRequest(
oxenmq::Message& msg, std::function<void(nlohmann::json, ReplyFunction_t)> handleRequest)
{
const auto maybe = MaybeParseJSON(msg);
if (not maybe.has_value())
{
msg.send_reply(CreateJSONError("failed to parse json"));
return;
}
if (not maybe->is_object())
{
msg.send_reply(CreateJSONError("request data not a json object"));
return;
}
try
{
handleRequest(
*maybe, [defer = msg.send_later()](std::string result) { defer.reply(result); });
}
catch (std::exception& ex)
{
msg.send_reply(CreateJSONError(ex.what()));
}
}
4 years ago
void
RpcServer::AsyncServeRPC(oxenmq::address url)
{
m_LMQ->listen_plain(url.zmq_address());
m_LMQ->add_category("llarp", oxenmq::AuthLevel::none)
.add_command(
"halt",
[&](oxenmq::Message& msg) {
if (not m_Router->IsRunning())
{
msg.send_reply(CreateJSONError("router is not running"));
return;
}
msg.send_reply(CreateJSONResponse("OK"));
m_Router->Stop();
})
4 years ago
.add_request_command(
"version",
[r = m_Router](oxenmq::Message& msg) {
util::StatusObject result{
{"version", llarp::VERSION_FULL}, {"uptime", to_json(r->Uptime())}};
msg.send_reply(CreateJSONResponse(result));
})
.add_request_command(
"status",
[&](oxenmq::Message& msg) {
m_Router->loop()->call([defer = msg.send_later(), r = m_Router]() {
std::string data;
if (r->IsRunning())
{
data = CreateJSONResponse(r->ExtractStatus());
}
else
{
data = CreateJSONError("router not yet ready");
}
defer.reply(data);
});
})
.add_request_command(
"get_status",
[&](oxenmq::Message& msg) {
m_Router->loop()->call([defer = msg.send_later(), r = m_Router]() {
defer.reply(CreateJSONResponse(r->ExtractSummaryStatus()));
});
})
.add_request_command(
"quic_connect",
[&](oxenmq::Message& msg) {
HandleJSONRequest(msg, [r = m_Router](nlohmann::json obj, ReplyFunction_t reply) {
std::string endpoint = "default";
if (auto itr = obj.find("endpoint"); itr != obj.end())
endpoint = itr->get<std::string>();
std::string bindAddr = "127.0.0.1:0";
if (auto itr = obj.find("bind"); itr != obj.end())
bindAddr = itr->get<std::string>();
std::string remoteHost;
if (auto itr = obj.find("host"); itr != obj.end())
remoteHost = itr->get<std::string>();
uint16_t port = 0;
if (auto itr = obj.find("port"); itr != obj.end())
port = itr->get<uint16_t>();
int closeID = 0;
if (auto itr = obj.find("close"); itr != obj.end())
closeID = itr->get<int>();
if (port == 0 and closeID == 0)
{
reply(CreateJSONError("port not provided"));
return;
}
if (remoteHost.empty() and closeID == 0)
{
reply(CreateJSONError("host not provided"));
return;
}
SockAddr laddr{};
laddr.fromString(bindAddr);
3 years ago
r->loop()->call([reply, endpoint, r, remoteHost, port, closeID, laddr]() {
auto ep = GetEndpointByName(r, endpoint);
if (not ep)
{
reply(CreateJSONError("no such local endpoint"));
return;
}
auto quic = ep->GetQUICTunnel();
if (not quic)
{
reply(CreateJSONError("local endpoint has no quic tunnel"));
return;
}
if (closeID)
{
quic->close(closeID);
reply(CreateJSONResponse("OK"));
return;
}
3 years ago
try
{
auto [addr, id] = quic->open(
remoteHost, port, [](auto&&) {}, laddr);
util::StatusObject status;
status["addr"] = addr.ToString();
3 years ago
status["id"] = id;
reply(CreateJSONResponse(status));
}
catch (std::exception& ex)
{
reply(CreateJSONError(ex.what()));
}
});
});
})
.add_request_command(
"quic_listener",
[&](oxenmq::Message& msg) {
HandleJSONRequest(msg, [r = m_Router](nlohmann::json obj, ReplyFunction_t reply) {
std::string endpoint = "default";
if (auto itr = obj.find("endpoint"); itr != obj.end())
endpoint = itr->get<std::string>();
std::string remote = "127.0.0.1";
if (auto itr = obj.find("host"); itr != obj.end())
remote = itr->get<std::string>();
uint16_t port = 0;
if (auto itr = obj.find("port"); itr != obj.end())
port = itr->get<uint16_t>();
int closeID = 0;
if (auto itr = obj.find("close"); itr != obj.end())
closeID = itr->get<int>();
std::string srvProto;
if (auto itr = obj.find("srv-proto"); itr != obj.end())
srvProto = itr->get<std::string>();
if (port == 0 and closeID == 0)
{
reply(CreateJSONError("invalid arguments"));
return;
}
r->loop()->call([reply, endpoint, remote, port, r, closeID, srvProto]() {
auto ep = GetEndpointByName(r, endpoint);
if (not ep)
{
reply(CreateJSONError("no such local endpoint"));
return;
}
auto quic = ep->GetQUICTunnel();
if (not quic)
{
reply(CreateJSONError("no quic interface available on endpoint " + endpoint));
return;
}
if (port)
{
int id = 0;
try
{
SockAddr addr{remote + ":" + std::to_string(port)};
id = quic->listen(addr);
}
catch (std::exception& ex)
{
reply(CreateJSONError(ex.what()));
return;
}
util::StatusObject result;
result["id"] = id;
std::string localAddress;
var::visit(
[&](auto&& addr) { localAddress = addr.ToString(); }, ep->LocalAddress());
result["addr"] = localAddress + ":" + std::to_string(port);
if (not srvProto.empty())
{
auto srvData =
dns::SRVData::fromTuple(std::make_tuple(srvProto, 1, 1, port, ""));
ep->PutSRVRecord(std::move(srvData));
}
reply(CreateJSONResponse(result));
}
else if (closeID)
{
quic->forget(closeID);
reply(CreateJSONResponse("OK"));
}
});
});
})
.add_request_command(
"lookup_snode",
[&](oxenmq::Message& msg) {
HandleJSONRequest(msg, [r = m_Router](nlohmann::json obj, ReplyFunction_t reply) {
if (not r->IsServiceNode())
{
reply(CreateJSONError("not supported"));
return;
}
RouterID routerID;
if (auto itr = obj.find("snode"); itr != obj.end())
{
std::string remote = itr->get<std::string>();
if (not routerID.FromString(remote))
{
reply(CreateJSONError("invalid remote: " + remote));
return;
}
}
else
{
reply(CreateJSONError("no remote provided"));
return;
}
std::string endpoint = "default";
r->loop()->call([r, endpoint, routerID, reply]() {
auto ep = r->exitContext().GetExitEndpoint(endpoint);
if (ep == nullptr)
{
reply(CreateJSONError("cannot find local endpoint: " + endpoint));
return;
}
ep->ObtainSNodeSession(routerID, [routerID, ep, reply](auto session) {
if (session and session->IsReady())
{
const auto ip = net::TruncateV6(ep->GetIPForIdent(PubKey{routerID}));
util::StatusObject status{{"ip", ip.ToString()}};
reply(CreateJSONResponse(status));
}
else
reply(CreateJSONError("failed to obtain snode session"));
});
});
});
})
.add_request_command(
"endpoint",
3 years ago
[&](oxenmq::Message& msg) {
HandleJSONRequest(msg, [r = m_Router](nlohmann::json obj, ReplyFunction_t reply) {
if (r->IsServiceNode())
{
reply(CreateJSONError("not supported"));
return;
}
std::string endpoint = "default";
std::unordered_set<service::Address> kills;
{
const auto itr = obj.find("endpoint");
if (itr != obj.end())
endpoint = itr->get<std::string>();
}
{
const auto itr = obj.find("kill");
if (itr != obj.end())
{
if (itr->is_array())
{
for (auto kill_itr = itr->begin(); kill_itr != itr->end(); ++kill_itr)
{
if (kill_itr->is_string())
kills.emplace(kill_itr->get<std::string>());
}
}
else if (itr->is_string())
{
kills.emplace(itr->get<std::string>());
}
}
}
if (kills.empty())
{
reply(CreateJSONError("no action taken"));
return;
}
r->loop()->call([r, endpoint, kills, reply]() {
auto ep = r->hiddenServiceContext().GetEndpointByName(endpoint);
if (ep == nullptr)
{
reply(CreateJSONError("no endpoint with name " + endpoint));
return;
}
std::size_t removed = 0;
for (auto kill : kills)
{
removed += ep->RemoveAllConvoTagsFor(std::move(kill));
}
reply(CreateJSONResponse(
"removed " + std::to_string(removed) + " flow" + (removed == 1 ? "" : "s")));
});
});
})
.add_request_command(
"exit",
[&](oxenmq::Message& msg) {
HandleJSONRequest(msg, [r = m_Router](nlohmann::json obj, ReplyFunction_t reply) {
if (r->IsServiceNode())
{
reply(CreateJSONError("not supported"));
return;
}
std::optional<service::Address> exit;
std::optional<std::string> lnsExit;
IPRange range;
bool map = true;
const auto exit_itr = obj.find("exit");
if (exit_itr != obj.end())
{
service::Address addr;
const auto exit_str = exit_itr->get<std::string>();
if (service::NameIsValid(exit_str) or exit_str == "null")
{
lnsExit = exit_str;
}
else if (not addr.FromString(exit_str))
{
reply(CreateJSONError("invalid exit address"));
return;
}
else
{
exit = addr;
}
}
const auto unmap_itr = obj.find("unmap");
if (unmap_itr != obj.end() and unmap_itr->get<bool>())
{
map = false;
}
const auto range_itr = obj.find("range");
if (range_itr == obj.end())
{
// platforms without ipv6 support will shit themselves
// here if we give them an exit mapping that is ipv6
if constexpr (platform::supports_ipv6)
{
range.FromString("::/0");
}
else
{
range.FromString("0.0.0.0/0");
}
}
else if (not range.FromString(range_itr->get<std::string>()))
{
reply(CreateJSONError("invalid ip range"));
return;
}
if (not platform::supports_ipv6 and not range.IsV4())
{
reply(CreateJSONError("ipv6 ranges not supported on this platform"));
return;
}
std::optional<std::string> token;
const auto token_itr = obj.find("token");
if (token_itr != obj.end())
{
token = token_itr->get<std::string>();
}
std::string endpoint = "default";
const auto endpoint_itr = obj.find("endpoint");
if (endpoint_itr != obj.end())
{
endpoint = endpoint_itr->get<std::string>();
}
r->loop()->call([map, exit, lnsExit, range, token, endpoint, r, reply]() mutable {
3 years ago
auto ep = r->hiddenServiceContext().GetEndpointByName(endpoint);
if (ep == nullptr)
{
reply(CreateJSONError("no endpoint with name " + endpoint));
return;
}
if (map and (exit.has_value() or lnsExit.has_value()))
{
auto mapExit = [=](service::Address addr) mutable {
ep->MapExitRange(range, addr);
r->routePoker()->Up();
3 years ago
bool shouldSendAuth = false;
if (token.has_value())
{
3 years ago
shouldSendAuth = true;
ep->SetAuthInfoForEndpoint(*exit, service::AuthInfo{*token});
}
auto onGoodResult = [r, reply](std::string reason) {
if (r->HasClientExit())
reply(CreateJSONResponse(reason));
else
reply(CreateJSONError("we dont have an exit?"));
};
auto onBadResult = [r, reply, ep, range](std::string reason) {
r->routePoker()->Down();
ep->UnmapExitRange(range);
reply(CreateJSONError(reason));
};
if (addr.IsZero())
{
onGoodResult("added null exit");
return;
}
ep->MarkAddressOutbound(addr);
3 years ago
ep->EnsurePathToService(
addr,
[onBadResult, onGoodResult, shouldSendAuth, addrStr = addr.ToString()](
auto, service::OutboundContext* ctx) {
3 years ago
if (ctx == nullptr)
{
onBadResult("could not find exit");
return;
}
3 years ago
if (not shouldSendAuth)
{
onGoodResult("OK: connected to " + addrStr);
return;
}
ctx->AsyncSendAuth(
[onGoodResult, onBadResult](service::AuthResult result) {
// TODO: refactor this code. We are 5 lambdas deep here!
if (result.code != service::AuthResultCode::eAuthAccepted)
{
onBadResult(result.reason);
return;
}
onGoodResult(result.reason);
});
});
3 years ago
};
if (exit.has_value())
{
mapExit(*exit);
}
else if (lnsExit.has_value())
{
const std::string name = *lnsExit;
if (name == "null")
{
service::Address nullAddr{};
mapExit(nullAddr);
return;
}
ep->LookupNameAsync(name, [reply, mapExit](auto maybe) mutable {
3 years ago
if (not maybe.has_value())
{
reply(CreateJSONError("we could not find an exit with that name"));
return;
}
if (auto ptr = std::get_if<service::Address>(&*maybe))
{
if (ptr->IsZero())
reply(CreateJSONError("name does not exist"));
else
mapExit(*ptr);
}
else
{
reply(CreateJSONError("lns name resolved to a snode"));
}
3 years ago
});
}
else
{
reply(
CreateJSONError("WTF inconsistent request, no exit address or lns "
"name provided?"));
}
return;
}
else if (map and not exit.has_value())
{
reply(CreateJSONError("no exit address provided"));
return;
}
else if (not map)
{
r->routePoker()->Down();
3 years ago
ep->UnmapExitRange(range);
reply(CreateJSONResponse("OK"));
3 years ago
}
});
});
})
.add_request_command(
"dns_query",
[&](oxenmq::Message& msg) {
HandleJSONRequest(msg, [r = m_Router](nlohmann::json obj, ReplyFunction_t reply) {
std::string endpoint{"default"};
if (const auto itr = obj.find("endpoint"); itr != obj.end())
{
endpoint = itr->get<std::string>();
}
std::string qname{};
dns::QType_t qtype = dns::qTypeA;
if (const auto itr = obj.find("qname"); itr != obj.end())
{
qname = itr->get<std::string>();
}
if (const auto itr = obj.find("qtype"); itr != obj.end())
{
qtype = itr->get<dns::QType_t>();
}
dns::Message msg{dns::Question{qname, qtype}};
if (auto ep_ptr = GetEndpointByName(r, endpoint))
{
if (auto dns = ep_ptr->DNS())
{
auto src = std::make_shared<DummyPacketSource>([reply](auto result) {
if (result)
reply(CreateJSONResponse(result->ToJSON()));
else
reply(CreateJSONError("no response from dns"));
});
if (not dns->MaybeHandlePacket(src, src->dumb, src->dumb, msg.ToBuffer()))
{
reply(CreateJSONError("dns query not accepted by endpoint"));
}
}
else
reply(CreateJSONError("endpoint does not have dns"));
return;
}
reply(CreateJSONError("no such endpoint for dns query"));
});
})
.add_request_command("config", [&](oxenmq::Message& msg) {
HandleJSONRequest(msg, [r = m_Router](nlohmann::json obj, ReplyFunction_t reply) {
{
const auto itr = obj.find("override");
if (itr != obj.end())
{
if (not itr->is_object())
{
reply(CreateJSONError("override is not an object"));
return;
}
for (const auto& [section, value] : itr->items())
{
if (not value.is_object())
{
reply(CreateJSONError(
fmt::format("failed to set [{}]: section is not an object", section)));
return;
}
for (const auto& [key, value] : value.items())
{
if (not value.is_string())
{
reply(CreateJSONError(fmt::format(
"failed to set [{}]:{}: value is not a string", section, key)));
return;
}
r->GetConfig()->Override(section, key, value.get<std::string>());
}
}
}
}
{
const auto itr = obj.find("reload");
if (itr != obj.end() and itr->get<bool>())
{
r->QueueDiskIO([conf = r->GetConfig()]() { conf->Save(); });
}
}
reply(CreateJSONResponse("OK"));
4 years ago
});
});
}
} // namespace llarp::rpc