2021-03-09 23:24:35 +01:00
|
|
|
#pragma once
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-04-20 22:36:42 +02:00
|
|
|
#include <chrono>
|
2021-03-09 23:24:35 +01:00
|
|
|
#include <llarp/crypto/types.hpp>
|
|
|
|
#include <llarp/router_contact.hpp>
|
|
|
|
#include <llarp/util/fs.hpp>
|
|
|
|
#include <llarp/util/str.hpp>
|
|
|
|
#include "ini.hpp"
|
|
|
|
#include "definition.hpp"
|
|
|
|
#include <llarp/constants/files.hpp>
|
|
|
|
#include <llarp/net/ip_address.hpp>
|
|
|
|
#include <llarp/net/net_int.hpp>
|
|
|
|
#include <llarp/net/ip_range_map.hpp>
|
|
|
|
#include <llarp/service/address.hpp>
|
|
|
|
#include <llarp/service/auth.hpp>
|
|
|
|
#include <llarp/dns/srv_data.hpp>
|
|
|
|
|
|
|
|
#include <llarp/router_contact.hpp>
|
2021-02-18 14:28:53 +01:00
|
|
|
|
2019-07-02 02:58:23 +02:00
|
|
|
#include <cstdlib>
|
2019-07-02 23:28:28 +02:00
|
|
|
#include <functional>
|
2021-03-18 16:59:02 +01:00
|
|
|
#include <optional>
|
2019-07-02 23:28:28 +02:00
|
|
|
#include <string>
|
|
|
|
#include <utility>
|
|
|
|
#include <vector>
|
2019-08-26 13:16:46 +02:00
|
|
|
#include <unordered_set>
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2021-02-02 15:35:40 +01:00
|
|
|
#include <oxenmq/address.h>
|
2020-06-30 18:38:08 +02:00
|
|
|
|
2019-07-02 23:28:28 +02:00
|
|
|
namespace llarp
|
|
|
|
{
|
2020-03-13 21:45:33 +01:00
|
|
|
using SectionValues_t = llarp::ConfigParser::SectionValues_t;
|
|
|
|
using Config_impl_t = llarp::ConfigParser::Config_impl_t;
|
2019-07-06 15:46:21 +02:00
|
|
|
|
2020-03-31 17:25:29 +02:00
|
|
|
// TODO: don't use these maps. they're sloppy and difficult to follow
|
2020-03-27 22:39:40 +01:00
|
|
|
/// Small struct to gather all parameters needed for config generation to reduce the number of
|
|
|
|
/// parameters that need to be passed around.
|
|
|
|
struct ConfigGenParameters
|
|
|
|
{
|
|
|
|
bool isRelay = false;
|
|
|
|
fs::path defaultDataDir;
|
|
|
|
};
|
|
|
|
|
2020-03-27 22:53:43 +01:00
|
|
|
struct RouterConfig
|
2019-07-02 23:28:28 +02:00
|
|
|
{
|
2020-05-20 23:15:06 +02:00
|
|
|
size_t m_minConnectedRouters = 0;
|
|
|
|
size_t m_maxConnectedRouters = 0;
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-03-31 17:51:24 +02:00
|
|
|
std::string m_netId;
|
2019-07-02 01:55:02 +02:00
|
|
|
std::string m_nickname;
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-04-02 17:12:45 +02:00
|
|
|
fs::path m_dataDir;
|
2019-07-02 01:55:02 +02:00
|
|
|
|
2020-05-20 23:15:06 +02:00
|
|
|
bool m_blockBogons = false;
|
2019-08-27 01:29:17 +02:00
|
|
|
|
2020-05-06 22:38:44 +02:00
|
|
|
IpAddress m_publicAddress;
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-05-20 23:15:06 +02:00
|
|
|
int m_workerThreads = -1;
|
|
|
|
int m_numNetThreads = -1;
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-05-20 23:15:06 +02:00
|
|
|
size_t m_JobQueueSize = 0;
|
2019-11-25 22:30:34 +01:00
|
|
|
|
2020-04-29 21:41:39 +02:00
|
|
|
std::string m_routerContactFile;
|
|
|
|
std::string m_encryptionKeyFile;
|
|
|
|
std::string m_identityKeyFile;
|
|
|
|
std::string m_transportKeyFile;
|
|
|
|
|
2020-08-14 17:36:08 +02:00
|
|
|
bool m_isRelay = false;
|
2020-05-26 19:03:21 +02:00
|
|
|
|
2020-03-18 19:24:23 +01:00
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2019-07-02 23:28:28 +02:00
|
|
|
};
|
|
|
|
|
2021-02-18 14:28:53 +01:00
|
|
|
/// config for path hop selection
|
|
|
|
struct PeerSelectionConfig
|
|
|
|
{
|
|
|
|
/// in our hops what netmask will we use for unique ips for hops
|
|
|
|
/// i.e. 32 for every hop unique ip, 24 unique /24 per hop, etc
|
|
|
|
///
|
2021-02-19 23:19:21 +01:00
|
|
|
int m_UniqueHopsNetmaskSize;
|
2021-02-18 14:28:53 +01:00
|
|
|
|
|
|
|
/// set of countrys to exclude from path building (2 char country code)
|
|
|
|
std::unordered_set<std::string> m_ExcludeCountries;
|
|
|
|
|
|
|
|
void
|
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
|
|
|
|
|
|
|
/// return true if this set of router contacts is acceptable against this config
|
|
|
|
bool
|
2021-02-18 18:20:58 +01:00
|
|
|
Acceptable(const std::set<RouterContact>& hops) const;
|
2021-02-18 14:28:53 +01:00
|
|
|
};
|
|
|
|
|
2020-03-27 22:53:43 +01:00
|
|
|
struct NetworkConfig
|
2019-07-02 23:28:28 +02:00
|
|
|
{
|
2020-05-01 21:51:15 +02:00
|
|
|
std::optional<bool> m_enableProfiling;
|
2021-04-02 18:08:06 +02:00
|
|
|
bool m_saveProfiles;
|
2021-04-12 13:39:07 +02:00
|
|
|
std::set<RouterID> m_strictConnect;
|
2020-04-27 17:24:05 +02:00
|
|
|
std::string m_ifname;
|
2020-06-24 15:24:07 +02:00
|
|
|
IPRange m_ifaddr;
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-06-08 14:42:10 +02:00
|
|
|
std::optional<fs::path> m_keyfile;
|
2020-05-01 00:11:05 +02:00
|
|
|
std::string m_endpointType;
|
2020-05-20 23:15:06 +02:00
|
|
|
bool m_reachable = false;
|
2020-06-08 14:42:10 +02:00
|
|
|
std::optional<int> m_Hops;
|
|
|
|
std::optional<int> m_Paths;
|
2020-05-21 16:18:23 +02:00
|
|
|
bool m_AllowExit = false;
|
2020-05-01 00:11:05 +02:00
|
|
|
std::set<RouterID> m_snodeBlacklist;
|
2020-06-24 15:24:07 +02:00
|
|
|
net::IPRangeMap<service::Address> m_ExitMap;
|
2020-10-21 11:39:01 +02:00
|
|
|
net::IPRangeMap<std::string> m_LNSExitMap;
|
|
|
|
|
2021-03-09 19:39:40 +01:00
|
|
|
std::unordered_map<service::Address, service::AuthInfo> m_ExitAuths;
|
2020-10-21 11:39:01 +02:00
|
|
|
std::unordered_map<std::string, service::AuthInfo> m_LNSExitAuths;
|
|
|
|
|
2020-05-21 16:18:23 +02:00
|
|
|
std::unordered_map<huint128_t, service::Address> m_mapAddrs;
|
2020-05-01 00:11:05 +02:00
|
|
|
|
2020-06-30 18:02:29 +02:00
|
|
|
service::AuthType m_AuthType = service::AuthType::eAuthTypeNone;
|
2020-06-02 23:10:42 +02:00
|
|
|
std::optional<std::string> m_AuthUrl;
|
|
|
|
std::optional<std::string> m_AuthMethod;
|
2021-03-09 19:39:40 +01:00
|
|
|
std::unordered_set<service::Address> m_AuthWhitelist;
|
2020-06-02 23:10:42 +02:00
|
|
|
|
2020-08-31 22:07:17 +02:00
|
|
|
std::vector<llarp::dns::SRVData> m_SRVRecords;
|
|
|
|
|
2021-03-18 16:59:02 +01:00
|
|
|
std::optional<huint128_t> m_baseV6Address;
|
|
|
|
|
2021-04-14 21:40:57 +02:00
|
|
|
std::set<IPRange> m_OwnedRanges;
|
2021-04-14 17:07:06 +02:00
|
|
|
std::optional<net::TrafficPolicy> m_TrafficPolicy;
|
|
|
|
|
2021-05-01 22:25:32 +02:00
|
|
|
std::optional<llarp_time_t> m_PathAlignmentTimeout;
|
|
|
|
|
2021-06-17 18:05:50 +02:00
|
|
|
std::optional<fs::path> m_AddrMapPersistFile;
|
2020-05-01 00:11:05 +02:00
|
|
|
|
2020-03-18 19:24:23 +01:00
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2019-07-02 23:28:28 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
struct DnsConfig
|
|
|
|
{
|
2021-05-30 19:29:00 +02:00
|
|
|
SockAddr m_bind;
|
|
|
|
std::vector<SockAddr> m_upstreamDNS;
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-03-18 19:24:23 +01:00
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2019-07-02 23:28:28 +02:00
|
|
|
};
|
|
|
|
|
2020-03-27 22:53:43 +01:00
|
|
|
struct LinksConfig
|
2019-07-02 23:28:28 +02:00
|
|
|
{
|
2020-03-19 23:20:45 +01:00
|
|
|
struct LinkInfo
|
|
|
|
{
|
|
|
|
std::string interface;
|
2020-05-20 23:15:06 +02:00
|
|
|
int addressFamily = -1;
|
2020-03-23 17:15:00 +01:00
|
|
|
uint16_t port = -1;
|
2020-03-19 23:20:45 +01:00
|
|
|
};
|
2020-03-23 17:15:00 +01:00
|
|
|
/// Create a LinkInfo from the given string.
|
|
|
|
/// @throws if str does not represent a LinkInfo.
|
|
|
|
LinkInfo
|
2020-05-01 21:51:15 +02:00
|
|
|
LinkInfoFromINIValues(std::string_view name, std::string_view value);
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2019-08-07 18:33:29 +02:00
|
|
|
LinkInfo m_OutboundLink;
|
2020-03-19 23:20:45 +01:00
|
|
|
std::vector<LinkInfo> m_InboundLinks;
|
2019-07-09 01:29:37 +02:00
|
|
|
|
2020-03-18 19:24:23 +01:00
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2019-07-02 23:28:28 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
struct ConnectConfig
|
|
|
|
{
|
2020-04-02 17:12:45 +02:00
|
|
|
std::vector<fs::path> routers;
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-03-18 19:24:23 +01:00
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2019-07-02 23:28:28 +02:00
|
|
|
};
|
|
|
|
|
2020-03-27 22:53:43 +01:00
|
|
|
struct ApiConfig
|
2019-07-02 23:28:28 +02:00
|
|
|
{
|
2020-05-20 23:15:06 +02:00
|
|
|
bool m_enableRPCServer = false;
|
2020-03-31 17:51:24 +02:00
|
|
|
std::string m_rpcBindAddr;
|
2019-07-09 01:29:37 +02:00
|
|
|
|
2020-03-18 19:24:23 +01:00
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2019-07-02 23:28:28 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
struct LokidConfig
|
|
|
|
{
|
2020-05-20 23:15:06 +02:00
|
|
|
bool whitelistRouters = false;
|
2020-04-02 17:48:20 +02:00
|
|
|
fs::path ident_keyfile;
|
2021-02-02 15:35:40 +01:00
|
|
|
oxenmq::address lokidRPCAddr;
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-03-18 19:24:23 +01:00
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2019-07-02 23:28:28 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
struct BootstrapConfig
|
|
|
|
{
|
2021-04-02 17:10:37 +02:00
|
|
|
std::vector<fs::path> files;
|
|
|
|
std::set<RouterContact> routers;
|
2020-10-21 14:58:08 +02:00
|
|
|
bool seednode;
|
2020-03-18 19:24:23 +01:00
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2019-07-02 23:28:28 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
struct LoggingConfig
|
|
|
|
{
|
2020-05-20 23:15:06 +02:00
|
|
|
LogType m_logType = LogType::Unknown;
|
|
|
|
LogLevel m_logLevel = eLogNone;
|
2020-03-19 22:51:22 +01:00
|
|
|
std::string m_logFile;
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-03-30 18:25:02 +02:00
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
defineConfigOptions(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2020-03-30 18:25:02 +02:00
|
|
|
};
|
|
|
|
|
2019-07-02 23:28:28 +02:00
|
|
|
struct Config
|
|
|
|
{
|
2020-10-21 14:58:08 +02:00
|
|
|
explicit Config(fs::path datadir);
|
|
|
|
|
|
|
|
~Config() = default;
|
|
|
|
|
2019-07-02 23:28:28 +02:00
|
|
|
RouterConfig router;
|
|
|
|
NetworkConfig network;
|
2021-02-18 14:28:53 +01:00
|
|
|
PeerSelectionConfig paths;
|
2019-07-02 23:28:28 +02:00
|
|
|
ConnectConfig connect;
|
|
|
|
DnsConfig dns;
|
2019-08-07 18:33:29 +02:00
|
|
|
LinksConfig links;
|
2019-07-02 23:28:28 +02:00
|
|
|
ApiConfig api;
|
|
|
|
LokidConfig lokid;
|
|
|
|
BootstrapConfig bootstrap;
|
|
|
|
LoggingConfig logging;
|
|
|
|
|
2020-03-23 21:53:42 +01:00
|
|
|
// Initialize config definition
|
|
|
|
void
|
2020-03-31 19:33:36 +02:00
|
|
|
initializeConfig(ConfigDefinition& conf, const ConfigGenParameters& params);
|
2020-03-23 21:53:42 +01:00
|
|
|
|
2020-04-29 18:47:51 +02:00
|
|
|
/// Insert config entries for backwards-compatibility (e.g. so that the config system will
|
|
|
|
/// tolerate old values that are no longer accepted)
|
|
|
|
///
|
|
|
|
/// @param conf is the config to modify
|
|
|
|
void
|
|
|
|
addBackwardsCompatibleConfigOptions(ConfigDefinition& conf);
|
|
|
|
|
2020-10-21 14:58:08 +02:00
|
|
|
// Load a config from the given file if the config file is not provided LoadDefault is called
|
2019-07-02 23:28:28 +02:00
|
|
|
bool
|
2020-10-21 14:58:08 +02:00
|
|
|
Load(std::optional<fs::path> fname = std::nullopt, bool isRelay = false);
|
|
|
|
|
|
|
|
std::string
|
|
|
|
generateBaseClientConfig();
|
|
|
|
|
|
|
|
std::string
|
|
|
|
generateBaseRouterConfig();
|
|
|
|
|
|
|
|
void
|
|
|
|
Save();
|
|
|
|
|
|
|
|
void
|
|
|
|
Override(std::string section, std::string key, std::string value);
|
2019-07-06 15:46:21 +02:00
|
|
|
|
2021-03-02 19:18:22 +01:00
|
|
|
void
|
|
|
|
AddDefault(std::string section, std::string key, std::string value);
|
|
|
|
|
2021-04-01 13:13:39 +02:00
|
|
|
/// create a config with the default parameters for an embedded lokinet
|
|
|
|
static std::shared_ptr<Config>
|
|
|
|
EmbeddedConfig();
|
|
|
|
|
2020-10-21 14:58:08 +02:00
|
|
|
private:
|
2020-04-24 19:10:05 +02:00
|
|
|
/// Load (initialize) a default config.
|
|
|
|
///
|
|
|
|
/// This delegates to the ConfigDefinition to generate a default config,
|
|
|
|
/// as though an empty config were specified.
|
|
|
|
///
|
|
|
|
/// If using Config without the intention of loading from file (or string), this is necessary
|
|
|
|
/// in order to obtain sane defaults.
|
|
|
|
///
|
|
|
|
/// @param isRelay determines whether the config will reflect that of a relay or client
|
|
|
|
/// @param dataDir is a path representing a directory to be used as the data dir
|
|
|
|
/// @return true on success, false otherwise
|
|
|
|
bool
|
2020-10-21 14:58:08 +02:00
|
|
|
LoadDefault(bool isRelay);
|
2020-08-27 14:43:53 +02:00
|
|
|
|
|
|
|
void
|
2020-10-21 14:58:08 +02:00
|
|
|
LoadOverrides();
|
2020-08-27 14:43:53 +02:00
|
|
|
|
2021-03-02 19:18:22 +01:00
|
|
|
std::vector<std::array<std::string, 3>> m_Additional;
|
2020-08-27 14:43:53 +02:00
|
|
|
ConfigParser m_Parser;
|
2020-10-21 14:58:08 +02:00
|
|
|
const fs::path m_DataDir;
|
2019-07-02 23:28:28 +02:00
|
|
|
};
|
|
|
|
|
2020-03-23 21:53:42 +01:00
|
|
|
void
|
2020-10-30 14:38:17 +01:00
|
|
|
ensureConfig(fs::path dataDir, fs::path confFile, bool overwrite, bool asRouter);
|
2019-07-02 23:28:28 +02:00
|
|
|
|
2020-03-23 21:53:42 +01:00
|
|
|
} // namespace llarp
|