#include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "ghc/filesystem.hpp" namespace llarp { // constants for config file default values constexpr int DefaultMinConnectionsForRouter = 6; constexpr int DefaultMaxConnectionsForRouter = 60; constexpr int DefaultMinConnectionsForClient = 4; constexpr int DefaultMaxConnectionsForClient = 6; const char* lokinetEnv(string_view suffix) { std::string env; env.reserve(8 + suffix.size()); env.append("LOKINET_"s); env.append(suffix.begin(), suffix.end()); return std::getenv(env.c_str()); } std::string fromEnv(string_view val, string_view envNameSuffix) { if (const char* ptr = lokinetEnv(envNameSuffix)) return ptr; return {val.begin(), val.end()}; } int fromEnv(const int& val, string_view envNameSuffix) { if (const char* ptr = lokinetEnv(envNameSuffix)) return std::atoi(ptr); return val; } uint16_t fromEnv(const uint16_t& val, string_view envNameSuffix) { if (const char* ptr = lokinetEnv(envNameSuffix)) return std::atoi(ptr); return val; } size_t fromEnv(const size_t& val, string_view envNameSuffix) { if (const char* ptr = lokinetEnv(envNameSuffix)) return std::atoll(ptr); return val; } nonstd::optional fromEnv(const nonstd::optional& val, string_view envNameSuffix) { if (const char* ptr = lokinetEnv(envNameSuffix)) return IsTrueValue(ptr); return val; } LoggingConfig::LogType LoggingConfig::LogTypeFromString(const std::string& str) { if (str == "unknown") return LogType::Unknown; else if (str == "file") return LogType::File; else if (str == "json") return LogType::Json; else if (str == "syslog") return LogType::Syslog; return LogType::Unknown; } void RouterConfig::defineConfigOptions(Configuration& conf) { conf.defineOption("router", "job-queue-size", false, m_JobQueueSize, [this](int arg) { if (arg < 1024) throw std::invalid_argument("job-queue-size must be 1024 or greater"); m_JobQueueSize = arg; }); // TODO: we don't support other protocols now; remove conf.defineOption("router", "default-protocol", false, m_DefaultLinkProto, [this](std::string arg) { m_DefaultLinkProto = arg; }); conf.defineOption("router", "netid", true, m_netId, [this](std::string arg) { if(arg.size() > NetID::size()) throw std::invalid_argument(stringify( "netid is too long, max length is ", NetID::size())); m_netId = std::move(arg); }); int minConnections = (isRelay ? DefaultMinConnectionsForRouter : DefaultMinConnectionsForClient); conf.defineOption("router", "min-connections", false, minConnections, [=](int arg) { if (arg < minConnections) throw std::invalid_argument(stringify("min-connections must be >= ", minConnections)); m_minConnectedRouters = arg; }); int maxConnections = (isRelay ? DefaultMaxConnectionsForRouter : DefaultMaxConnectionsForClient); conf.defineOption("router", "max-connections", false, maxConnections, [=](int arg) { if (arg < maxConnections) throw std::invalid_argument(stringify("max-connections must be >= ", maxConnections)); m_maxConnectedRouters = arg; }); // additional check that min <= max // TODO: where can we perform this check now? // if (m_minConnectedRouters > m_maxConnectedRouters) // throw std::invalid_argument("[router]:min-connections must be less than [router]:max-connections"); conf.defineOption("router", "nickname", false, m_nickname, [this](std::string arg) { m_nickname = std::move(arg); // TODO: side effect here, no side effects in config parsing!! LogContext::Instance().nodeName = nickname(); }); conf.defineOption("router", "encryption-privkey", false, m_encryptionKeyfile, [this](std::string arg) { m_encryptionKeyfile = std::move(arg); }); conf.defineOption("router", "contact-file", false, m_ourRcFile, [this](std::string arg) { m_ourRcFile = std::move(arg); }); conf.defineOption("router", "transport-privkey", false, m_transportKeyfile, [this](std::string arg) { m_transportKeyfile = std::move(arg); }); conf.defineOption("router", "identity-privkey", false, m_identKeyfile, [this](std::string arg) { m_identKeyfile = std::move(arg); }); conf.defineOption("router", "public-address", false, "", [this](std::string arg) { llarp::LogInfo("public ip ", arg, " size ", arg.size()); if(arg.size() < 17) { // assume IPv4 llarp::Addr a(arg); llarp::LogInfo("setting public ipv4 ", a); m_addrInfo.ip = *a.addr6(); m_publicOverride = true; } }); conf.defineOption("router", "public-port", false, 1090, [this](int arg) { if (arg <= 0) throw std::invalid_argument("public-port must be > 0"); // Not needed to flip upside-down - this is done in llarp::Addr(const AddressInfo&) m_ip4addr.sin_port = arg; m_addrInfo.port = arg; m_publicOverride = true; }); conf.defineOption("router", "worker-threads", false, m_workerThreads, [this](int arg) { if (arg <= 0) throw std::invalid_argument("worker-threads must be > 0"); m_workerThreads = arg; }); conf.defineOption("router", "net-threads", false, m_numNetThreads, [this](int arg) { if (arg <= 0) throw std::invalid_argument("net-threads must be > 0"); m_numNetThreads = arg; }); conf.defineOption("router", "block-bogons", false, m_blockBogons, [this](bool arg) { m_blockBogons = arg; }); } void NetworkConfig::defineConfigOptions(Configuration& conf) { // TODO: review default value conf.defineOption("network", "profiling", false, m_enableProfiling, [this](bool arg) { m_enableProfiling = arg; }); conf.defineOption("network", "profiles", false, m_routerProfilesFile, [this](std::string arg) { m_routerProfilesFile = std::move(arg); }); conf.defineOption("network", "strict-connect", false, m_strictConnect, [this](std::string arg) { m_strictConnect = std::move(arg); }); // TODO: NetConfig was collecting all other k:v pairs here } void NetdbConfig::defineConfigOptions(Configuration& conf) { conf.defineOption("netdb", "dir", false, m_nodedbDir, [this](std::string arg) { m_nodedbDir = str(arg); }); } void DnsConfig::defineConfigOptions(Configuration& conf) { // TODO: this was previously a multi-value option conf.defineOption("dns", "upstream", false, "", [this](std::string arg) { netConfig.emplace("upstream-dns", std::move(arg)); }); // TODO: this was previously a multi-value option conf.defineOption("dns", "bind", false, "", [this](std::string arg) { netConfig.emplace("local-dns", std::move(arg)); }); } LinksConfig::LinkInfo LinksConfig::LinkInfoFromINIValues(string_view name, string_view value) { // we treat the INI k:v pair as: // k: interface name, * indicating outbound // v: a comma-separated list of values, an int indicating port (everything else ignored) // this is somewhat of a backwards- and forwards-compatibility thing LinkInfo info; info.addressFamily = AF_INET; info.interface = str(name); std::vector splits = split(value, ','); for (string_view str : splits) { int asNum = std::atoi(str.data()); if (asNum > 0) info.port = asNum; // otherwise, ignore ("future-proofing") } return info; } void LinksConfig::defineConfigOptions(Configuration& conf) { conf.addUndeclaredHandler("bind", [&](string_view, string_view name, string_view value) { LinkInfo info = LinkInfoFromINIValues(name, value); if (info.port <= 0) throw std::invalid_argument(stringify("Invalid [bind] port specified on interface", name)); if(name == "*") { info.port = fromEnv(info.port, "OUTBOUND_PORT"); m_OutboundLink = std::move(info); } else { m_InboundLinks.emplace_back(std::move(info)); } return true; }); } void ConnectConfig::defineConfigOptions(Configuration& conf) { conf.addUndeclaredHandler("connect", [this](string_view section, string_view name, string_view value) { (void)section; (void)name; routers.emplace_back(value); return true; }); } void ServicesConfig::defineConfigOptions(Configuration& conf) { conf.addUndeclaredHandler("services", [this](string_view section, string_view name, string_view value) { (void)section; services.emplace_back(name, value); return true; }); } void SystemConfig::defineConfigOptions(Configuration& conf) { conf.defineOption("system", "pidfile", false, pidfile, [this](std::string arg) { pidfile = std::move(arg); }); } void ApiConfig::defineConfigOptions(Configuration& conf) { conf.defineOption("api", "enabled", false, m_enableRPCServer, [this](bool arg) { m_enableRPCServer = arg; }); conf.defineOption("api", "bind", false, m_rpcBindAddr, [this](std::string arg) { m_rpcBindAddr = std::move(arg); }); // TODO: this was from pre-refactor: // TODO: add pubkey to whitelist } void LokidConfig::defineConfigOptions(Configuration& conf) { conf.defineOption("lokid", "service-node-seed", false, "", [this](std::string arg) { if (not arg.empty()) { usingSNSeed = true; ident_keyfile = std::move(arg); } }); conf.defineOption("lokid", "enabled", false, whitelistRouters, [this](bool arg) { whitelistRouters = arg; }); // TODO: was also aliased as "addr" -- presumably because loki-launcher conf.defineOption("lokid", "jsonrpc", false, lokidRPCAddr, [this](std::string arg) { lokidRPCAddr = arg; }); conf.defineOption("lokid", "username", false, lokidRPCUser, [this](std::string arg) { lokidRPCUser = arg; }); conf.defineOption("lokid", "password", false, lokidRPCPassword, [this](std::string arg) { lokidRPCPassword = arg; }); } void BootstrapConfig::defineConfigOptions(Configuration& conf) { conf.addUndeclaredHandler("bootstrap", [&](string_view, string_view name, string_view value) { if (name != "add-node") { return false; } else { routers.emplace_back(str(value)); return true; } }); } void LoggingConfig::defineConfigOptions(Configuration& conf) { conf.defineOption("logging", "type", false, "file", [this](std::string arg) { LoggingConfig::LogType type = LogTypeFromString(arg); if (type == LogType::Unknown) throw std::invalid_argument(stringify("invalid log type: ", arg)); m_logType = type; }); conf.defineOption("logging", "level", false, "info", [this](std::string arg) { nonstd::optional level = LogLevelFromString(arg); if (not level.has_value()) throw std::invalid_argument(stringify( "invalid log level value: ", arg)); m_logLevel = level.value(); }); conf.defineOption("logging", "file", false, "stdout", [this](std::string arg) { m_logFile = arg; }); } bool Config::Load(const char *fname) { // TODO: DRY try { Configuration conf; initializeConfig(conf); ConfigParser parser; if(!parser.LoadFile(fname)) { return false; } parser.IterAll([&](string_view section, const SectionValues_t& values) { for (const auto& pair : values) { conf.addConfigValue(section, pair.first, pair.second); } }); // TODO: hand parsed data to conf, pull out values return true; } catch(const std::exception& e) { LogError("Error trying to init and parse config from file: ", e.what()); return false; } } void Config::initializeConfig(Configuration& conf) { // TODO: this seems like a random place to put this, should this be closer // to main() ? if(Lokinet_INIT()) throw std::runtime_error("Can't initializeConfig() when Lokinet_INIT() == true"); router.defineConfigOptions(conf); network.defineConfigOptions(conf); connect.defineConfigOptions(conf); netdb.defineConfigOptions(conf); dns.defineConfigOptions(conf); links.defineConfigOptions(conf); services.defineConfigOptions(conf); system.defineConfigOptions(conf); api.defineConfigOptions(conf); lokid.defineConfigOptions(conf); bootstrap.defineConfigOptions(conf); logging.defineConfigOptions(conf); } fs::path GetDefaultConfigDir() { #ifdef _WIN32 const fs::path homedir = fs::path(getenv("APPDATA")); #else const fs::path homedir = fs::path(getenv("HOME")); #endif return homedir / fs::path(".lokinet/"); } fs::path GetDefaultConfigFilename() { return fs::path("lokinet.ini"); } fs::path GetDefaultConfigPath() { return GetDefaultConfigDir() / GetDefaultConfigFilename(); } void ensureConfig(const fs::path& dir, const fs::path& filename, bool overwrite, bool asRouter) { fs::path fullPath = dir / filename; std::error_code ec; // fail to overwrite if not instructed to do so if(fs::exists(fullPath, ec) && !overwrite) throw std::invalid_argument(stringify("Config file ", fullPath, " already exists")); if (ec) throw std::runtime_error(stringify("filesystem error: ", ec)); // create parent dir if it doesn't exist if (not fs::exists(dir, ec)) { if (not fs::create_directory(dir)) throw std::runtime_error(stringify("Failed to create parent directory ", dir)); } if (ec) throw std::runtime_error(stringify("filesystem error: ", ec)); llarp::LogInfo("Attempting to create config file, asRouter: ", asRouter, " path: ", fullPath); llarp::Config config; std::string confStr; if (asRouter) confStr = config.generateBaseRouterConfig(); else confStr = config.generateBaseClientConfig(); // open a filestream auto stream = llarp::util::OpenFileStream(fullPath.c_str(), std::ios::binary); if (not stream.has_value() or not stream.value().is_open()) throw std::runtime_error(stringify("Failed to open file ", fullPath, " for writing")); llarp::LogInfo("confStr: ", confStr); stream.value() << confStr; stream.value().flush(); llarp::LogInfo("Generated new config ", fullPath); } std::string Config::generateBaseClientConfig() { llarp::Configuration def; initializeConfig(def); // TODO: pass these in const std::string basepath = ""; // router def.addSectionComment("router", "Configuration for routing activity."); def.addOptionComment("router", "threads", "The number of threads available for performing cryptographic functions."); def.addOptionComment("router", "threads", "The minimum is one thread, but network performance may increase with more."); def.addOptionComment("router", "threads", "threads. Should not exceed the number of logical CPU cores."); def.addOptionComment("router", "contact-file", "Path to store signed RC."); def.addConfigValue("router", "contact-file", stringify(basepath, "self.signed")); def.addOptionComment("router", "transport-privkey", "Path to store transport private key."); def.addConfigValue("router", "transport-privkey", stringify(basepath, "transport.private")); def.addOptionComment("router", "identity-privkey", "Path to store identity signing key."); def.addConfigValue("router", "identity-privkey", stringify(basepath, "identity.private")); def.addOptionComment("router", "encryption-privkey", "Encryption key for onion routing."); def.addConfigValue("router", "encryption-privkey", stringify(basepath, "encryption.private")); // TODO: why did Kee want this, and/or what does it really do? Something about logs? def.addOptionComment("router", "nickname", "Router nickname. Kee wanted it."); def.addOptionComment("router", "min-connections", "Minimum number of routers lokinet will attempt to maintain connections to."); def.addOptionComment("router", "max-connections", "Maximum number (hard limit) of routers lokinet will be connected to at any time."); // logging def.addSectionComment("logging", "logging settings"); def.addOptionComment("logging", "level", "Minimum log level to print. Logging below this level will be ignored."); def.addOptionComment("logging", "level", "Valid log levels, in ascending order, are:"); def.addOptionComment("logging", "level", " trace"); def.addOptionComment("logging", "level", " debug"); def.addOptionComment("logging", "level", " info"); def.addOptionComment("logging", "level", " warn"); def.addOptionComment("logging", "level", " error"); def.addConfigValue("logging", "level", "info"); def.addOptionComment("logging", "type", "Log type (format). Valid options are:"); def.addOptionComment("logging", "type", " file - plaintext formatting"); def.addOptionComment("logging", "type", " json - json-formatted log statements"); def.addOptionComment("logging", "type", " syslog - logs directed to syslog"); // api def.addSectionComment("api", "JSON API settings"); def.addOptionComment("api", "enabled", "Determines whether or not the JSON API is enabled."); def.addOptionComment("api", "bind", "IP address and port to bind to."); def.addOptionComment("api", "bind", "Recommend localhost-only for security purposes."); // system def.addSectionComment("system", "System setings for running lokinet."); def.addOptionComment("system", "user", "The user which lokinet should run as."); def.addOptionComment("system", "group", "The group which lokinet should run as."); def.addOptionComment("system", "pidfile", "Location of the pidfile for lokinet."); // dns def.addSectionComment("dns", "DNS configuration"); def.addOptionComment("dns", "upstream", "Upstream resolver to use as fallback for non-loki addresses."); def.addOptionComment("dns", "upstream", "Multiple values accepted."); def.addOptionComment("dns", "bind", "Address to bind to for handling DNS requests."); def.addOptionComment("dns", "bind", "Multiple values accepted."); // netdb def.addSectionComment("netdb", "Configuration for lokinet's database of service nodes"); def.addOptionComment("netdb", "dir", "Root directory of netdb."); // bootstrap def.addSectionComment("bootstrap", "Configure nodes that will bootstrap us onto the network"); def.addOptionComment("bootstrap", "add-node", "Specify a bootstrap file containing a signed RouterContact of a service node"); def.addOptionComment("bootstrap", "add-node", "which can act as a bootstrap. Accepts multiple values."); // network def.addSectionComment("network", "Network settings"); def.addOptionComment("network", "profiles", "File to contain router profiles."); def.addOptionComment("network", "strict-connect", "Public key of a router which will act as sole first-hop. This may be used to"); def.addOptionComment("network", "strict-connect", "provide a trusted router (consider that you are not fully anonymous with your"); def.addOptionComment("network", "strict-connect", "first hop)."); def.addOptionComment("network", "exit-node", "Public key of an exit-node."); def.addOptionComment("network", "ifname", "Interface name for lokinet traffic."); def.addOptionComment("network", "ifaddr", "Local IP address for lokinet traffic."); return def.generateINIConfig(true); } std::string Config::generateBaseRouterConfig() { llarp::Configuration def; initializeConfig(def); // lokid def.addSectionComment("lokid", "Lokid configuration (settings for talking to lokid"); def.addOptionComment("lokid", "enabled", "Whether or not we should talk to lokid. Must be enabled for staked routers."); def.addOptionComment("lokid", "jsonrpc", "Host and port of running lokid that we should talk to."); // TODO: doesn't appear to be used in the codebase def.addOptionComment("lokid", "service-node-seed", "File containing service node's seed."); // extra [network] options // TODO: probably better to create an [exit] section and only allow it for routers def.addOptionComment("network", "exit", "Whether or not we should act as an exit node. Beware that this increases demand"); def.addOptionComment("network", "exit", "on the server and may pose liability concerns. Enable at your own risk."); // TODO: define the order of precedence (e.g. is whitelist applied before blacklist?) // additionally, what's default? What if I don't whitelist anything? def.addOptionComment("network", "exit-whitelist", "List of destination protocol:port pairs to whitelist, example: udp:*"); def.addOptionComment("network", "exit-whitelist", "or tcp:80. Multiple values supported."); def.addOptionComment("network", "exit-blacklist", "Blacklist of destinations (same format as whitelist)."); return def.generateINIConfig(true); } } // namespace llarp bool llarp_ensure_client_config(std::ofstream& f, std::string basepath) { return true; /* * TODO: remove this function. comments left as evidence of what a snapp config does * * // write snapp-example.ini const std::string snappExample_fpath = basepath + "snapp-example.ini"; { auto stream = llarp::util::OpenFileStream(snappExample_fpath, std::ios::binary); if (!stream) { return false; } auto& example_f = stream.value(); if (example_f.is_open()) { // pick ip // don't revert me const static std::string ip = "10.33.0.1/16"; // std::string ip = llarp::findFreePrivateRange(); // if(ip == "") // { // llarp::LogError( // "Couldn't easily detect a private range to map lokinet onto"); // return false; // } example_f << "# this is an example configuration for a snapp\n"; example_f << "[example-snapp]\n"; example_f << "# keyfile is the path to the private key of the snapp, " "your .loki is tied to this key, DON'T LOSE IT\n"; example_f << "keyfile=" << basepath << "example-snap-keyfile.private\n"; example_f << "# ifaddr is the ip range to allocate to this snapp\n"; example_f << "ifaddr=" << ip << std::endl; // probably fine to leave this (and not-auto-detect it) I'm not worried // about any collisions example_f << "# ifname is the name to try and give to the network " "interface this snap owns\n"; example_f << "ifname=snapp-tun0\n"; } else { llarp::LogError("failed to write ", snappExample_fpath); } } // now do up fname f << "\n\n"; f << "# snapps configuration section\n"; f << "[services]\n"; f << "# uncomment next line to enable a snapp\n"; f << "#example-snapp=" << snappExample_fpath << std::endl; f << "\n\n"; return true; */ }