/*
* InspIRCd -- Internet Relay Chat Daemon
*
* Copyright (C) 2019 Matt Schatz <genius3000@g3k.solutions>
* Copyright (C) 2013-2016 Attila Molnar <attilamolnar@hush.com>
* Copyright (C) 2013-2014, 2016-2021 Sadie Powell <sadie@witchery.services>
* Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
* Copyright (C) 2012 Robby <robby@chatbelgie.be>
* Copyright (C) 2012 Justin Crawford <Justasic@Gmail.com>
* Copyright (C) 2012 DjSlash <djslash@djslash.org>
* Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
* Copyright (C) 2009-2011 Daniel De Graaf <danieldg@inspircd.org>
* Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
* Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
* Copyright (C) 2007-2010 Robin Burchell <robin+git@viroteck.net>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
* Copyright (C) 2006-2008 Craig Edwards <brain@inspircd.org>
* Copyright (C) 2006 Oliver Lupton <om@inspircd.org>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
* License as published by the Free Software Foundation, version 2.
*
* This program is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
* details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#include "inspircd.h"
#include "xline.h"
#include "listmode.h"
#include "exitcodes.h"
#include "configparser.h"
#include <iostream>
ServerLimits::ServerLimits(std::shared_ptr<ConfigTag> tag)
: MaxLine(tag->getUInt("maxline", 512, 512))
, MaxNick(tag->getUInt("maxnick", 30, 1, MaxLine))
, MaxChannel(tag->getUInt("maxchan", 60, 1, MaxLine))
, MaxModes(tag->getUInt("maxmodes", 20, 1))
, MaxUser(tag->getUInt("maxident", 10, 1))
, MaxQuit(tag->getUInt("maxquit", 300, 0, MaxLine))
, MaxTopic(tag->getUInt("maxtopic", 330, 1, MaxLine))
, MaxKick(tag->getUInt("maxkick", 300, 1, MaxLine))
, MaxReal(tag->getUInt("maxreal", 130, 1, MaxLine))
, MaxAway(tag->getUInt("maxaway", 200, 1, MaxLine))
, MaxHost(tag->getUInt("maxhost", 64, 1, MaxLine))
{
}
ServerConfig::ServerPaths::ServerPaths(std::shared_ptr<ConfigTag> tag)
: Config(tag->getString("configdir", INSPIRCD_CONFIG_PATH, 1))
, Data(tag->getString("datadir", INSPIRCD_DATA_PATH, 1))
, Log(tag->getString("logdir", INSPIRCD_LOG_PATH, 1))
, Module(tag->getString("moduledir", INSPIRCD_MODULE_PATH, 1))
, Runtime(tag->getString("runtimedir", INSPIRCD_RUNTIME_PATH, 1))
{
}
ServerConfig::ServerConfig()
: EmptyTag(std::make_shared<ConfigTag>("empty", FilePosition("<auto>", 0, 0)))
, Limits(EmptyTag)
, Paths(EmptyTag)
, CaseMapping("ascii")
{
}
static void ReadXLine(ServerConfig* conf, const std::string& tag, const std::string& key, XLineFactory* make)
{
insp::flat_set<std::string> configlines;
for (const auto& [_, ctag] : conf->ConfTags(tag))
{
const std::string mask = ctag->getString(key);
if (mask.empty())
throw CoreException("<" + tag + ":" + key + "> missing at " + ctag->source.str());
const std::string reason = ctag->getString("reason");
if (reason.empty())
throw CoreException("<" + tag + ":reason> missing at " + ctag->source.str());
XLine* xl = make->Generate(ServerInstance->Time(), 0, ServerInstance->Config->ServerName, reason, mask);
xl->from_config = true;
configlines.insert(xl->Displayable());
if (!ServerInstance->XLines->AddLine(xl, NULL))
delete xl;
}
ServerInstance->XLines->ExpireRemovedConfigLines(make->GetType(), configlines);
}
typedef std::map<std::string, std::shared_ptr<ConfigTag>> LocalIndex;
void ServerConfig::CrossCheckOperClassType()
{
LocalIndex operclass;
for (const auto& [_, tag] : ConfTags("class"))
{
std::string name = tag->getString("name");
if (name.empty())
throw CoreException("<class:name> missing from tag at " + tag->source.str());
if (operclass.find(name) != operclass.end())
throw CoreException("Duplicate class block with name " + name + " at " + tag->source.str());
operclass[name] = tag;
}
for (const auto& [_, tag] : ConfTags("type"))
{
std::string name = tag->getString("name");
if (name.empty())
throw CoreException("<type:name> is missing from tag at " + tag->source.str());
if (OperTypes.find(name) != OperTypes.end())
throw CoreException("Duplicate type block with name " + name + " at " + tag->source.str());
auto ifo = std::make_shared<OperInfo>(name);
OperTypes[name] = ifo;
ifo->type_block = tag;
std::string classname;
irc::spacesepstream str(tag->getString("classes"));
while (str.GetToken(classname))
{
LocalIndex::iterator cls = operclass.find(classname);
if (cls == operclass.end())
throw CoreException("Oper type " + name + " has missing class " + classname);
ifo->class_blocks.push_back(cls->second);
}
}
for (const auto& [_, tag] : ConfTags("oper"))
{
std::string name = tag->getString("name");
if (name.empty())
throw CoreException("<oper:name> missing from tag at " + tag->source.str());
std::string type = tag->getString("type");
OperIndex::iterator tblk = OperTypes.find(type);
if (tblk == OperTypes.end())
throw CoreException("Oper block " + name + " has missing type " + type);
if (oper_blocks.find(name) != oper_blocks.end())
throw CoreException("Duplicate oper block with name " + name + " at " + tag->source.str());
auto ifo = std::make_shared<OperInfo>(type);
ifo->oper_block = tag;
ifo->type_block = tblk->second->type_block;
ifo->class_blocks.assign(tblk->second->class_blocks.begin(), tblk->second->class_blocks.end());
oper_blocks[name] = ifo;
}
}
void ServerConfig::CrossCheckConnectBlocks(ServerConfig* current)
{
typedef std::map<std::pair<std::string, ConnectClass::Type>, std::shared_ptr<ConnectClass>> ClassMap;
ClassMap oldBlocksByMask;
if (current)
{
for (const auto& c : current->Classes)
{
switch (c->type)
{
case ConnectClass::ALLOW:
case ConnectClass::DENY:
oldBlocksByMask[std::make_pair(stdalgo::string::join(c->GetHosts()), c->type)] = c;
break;
case ConnectClass::NAMED:
oldBlocksByMask[std::make_pair(c->GetName(), c->type)] = c;
break;
}
}
}
size_t blk_count = config_data.count("connect");
if (blk_count == 0)
{
// No connect blocks found; make a trivial default block
auto tag = std::make_shared<ConfigTag>("connect", FilePosition("<auto>", 0, 0));
tag->GetItems()["allow"] = "*";
config_data.emplace("connect", tag);
blk_count = 1;
}
Classes.resize(blk_count);
std::map<std::string, size_t> names;
bool try_again = true;
for(size_t tries = 0; try_again; tries++)
{
try_again = false;
size_t i = 0;
for (const auto& [_, tag] : ConfTags("connect"))
{
if (Classes[i])
{
i++;
continue;
}
std::shared_ptr<ConnectClass> parent;
std::string parentName = tag->getString("parent");
if (!parentName.empty())
{
std::map<std::string, size_t>::const_iterator parentIter = names.find(parentName);
if (parentIter == names.end())
{
try_again = true;
// couldn't find parent this time. If it's the last time, we'll never find it.
if (tries >= blk_count)
throw CoreException("Could not find parent connect class \"" + parentName + "\" for connect block at " + tag->source.str());
i++;
continue;
}
parent = Classes[parentIter->second];
}
std::string name = tag->getString("name");
std::string mask;
ConnectClass::Type type;
if (tag->readString("allow", mask, false) && !mask.empty())
type = ConnectClass::ALLOW;
else if (tag->readString("deny", mask, false) && !mask.empty())
type = ConnectClass::DENY;
else if (!name.empty())
type = ConnectClass::NAMED;
else
throw CoreException("Connect class must have allow, deny, or name specified at " + tag->source.str());
if (name.empty())
name = "unnamed-" + ConvToStr(i);
if (names.find(name) != names.end())
throw CoreException("Two connect classes with name \"" + name + "\" defined!");
names[name] = i;
std::vector<std::string> masks;
irc::spacesepstream maskstream(mask);
for (std::string maskentry; maskstream.GetToken(maskentry); )
masks.push_back(maskentry);
auto me = parent
? std::make_shared<ConnectClass>(tag, type, masks, parent)
: std::make_shared<ConnectClass>(tag, type, masks);
me->Configure(name, tag);
ClassMap::iterator oldMask = oldBlocksByMask.find(std::make_pair(me->name, me->type));
if (oldMask != oldBlocksByMask.end())
{
std::shared_ptr<ConnectClass> old = oldMask->second;
oldBlocksByMask.erase(oldMask);
old->Update(me);
me = old;
}
Classes[i] = me;
i++;
}
}
}
static std::string GetServerHost()
{
#ifndef _WIN32
char hostname[256];
if (gethostname(hostname, sizeof(hostname)) == 0)
{
std::string name(hostname);
if (name.find('.') == std::string::npos)
name.append(".local");
if (name.length() <= ServerInstance->Config->Limits.MaxHost && InspIRCd::IsHost(name))
return name;
}
#endif
return "irc.example.com";
}
void ServerConfig::Fill()
{
auto options = ConfValue("options");
auto security = ConfValue("security");
auto server = ConfValue("server");
if (sid.empty())
{
ServerName = server->getString("name", GetServerHost(), InspIRCd::IsHost);
sid = server->getString("id");
if (!sid.empty() && !InspIRCd::IsSID(sid))
throw CoreException(sid + " is not a valid server ID. A server ID must be 3 characters long, with the first character a digit and the next two characters a digit or letter.");
}
else
{
std::string name = server->getString("name");
if (!name.empty() && name != ServerName)
throw CoreException("You must restart to change the server name");
std::string nsid = server->getString("id");
if (!nsid.empty() && nsid != sid)
throw CoreException("You must restart to change the server id");
}
SoftLimit = ConfValue("performance")->getUInt("softlimit", (SocketEngine::GetMaxFds() > 0 ? SocketEngine::GetMaxFds() : LONG_MAX), 10);
CCOnConnect = ConfValue("performance")->getBool("clonesonconnect", true);
MaxConn = static_cast<int>(ConfValue("performance")->getUInt("somaxconn", SOMAXCONN));
TimeSkipWarn = ConfValue("performance")->getDuration("timeskipwarn", 2, 0, 30);
XLineMessage = options->getString("xlinemessage", "You're banned!", 1);
ServerDesc = server->getString("description", "Configure Me", 1);
Network = server->getString("network", "Network", 1);
NetBufferSize = ConfValue("performance")->getInt("netbuffersize", 10240, 1024, 65534);
CustomVersion = security->getString("customversion");
HideBans = security->getBool("hidebans");
HideServer = security->getString("hideserver", "", InspIRCd::IsHost);
SyntaxHints = options->getBool("syntaxhints");
FullHostInTopic = options->getBool("hostintopic");
MaxTargets = security->getUInt("maxtargets", 20, 1, 31);
DefaultModes = options->getString("defaultmodes", "not");
c_ipv4_range = ConfValue("cidr")->getUInt("ipv4clone", 32, 1, 32);
c_ipv6_range = ConfValue("cidr")->getUInt("ipv6clone", 128, 1, 128);
Limits = ServerLimits(ConfValue("limits"));
Paths = ServerPaths(ConfValue("path"));
NoSnoticeStack = options->getBool("nosnoticestack", false);
std::string defbind = options->getString("defaultbind");
if (stdalgo::string::equalsci(defbind, "ipv4"))
{
WildcardIPv6 = false;
}
else if (stdalgo::string::equalsci(defbind, "ipv6"))
{
WildcardIPv6 = true;
}
else
{
WildcardIPv6 = true;
int socktest = socket(AF_INET6, SOCK_STREAM, 0);
if (socktest < 0)
WildcardIPv6 = false;
else
SocketEngine::Close(socktest);
}
ReadXLine(this, "badip", "ipmask", ServerInstance->XLines->GetFactory("Z"));
ReadXLine(this, "badnick", "nick", ServerInstance->XLines->GetFactory("Q"));
ReadXLine(this, "badhost", "host", ServerInstance->XLines->GetFactory("K"));
ReadXLine(this, "exception", "host", ServerInstance->XLines->GetFactory("E"));
const std::string restrictbannedusers = options->getString("restrictbannedusers", "yes", 1);
if (stdalgo::string::equalsci(restrictbannedusers, "no"))
RestrictBannedUsers = ServerConfig::BUT_NORMAL;
else if (stdalgo::string::equalsci(restrictbannedusers, "silent"))
RestrictBannedUsers = ServerConfig::BUT_RESTRICT_SILENT;
else if (stdalgo::string::equalsci(restrictbannedusers, "yes"))
RestrictBannedUsers = ServerConfig::BUT_RESTRICT_NOTIFY;
else
throw CoreException(restrictbannedusers + " is an invalid <options:restrictbannedusers> value, at " + options->source.str());
}
// WARNING: it is not safe to use most of the codebase in this function, as it
// will run in the config reader thread
void ServerConfig::Read()
{
/* Load and parse the config file, if there are any errors then explode */
ParseStack stack(this);
try
{
valid = stack.ParseFile(ServerInstance->ConfigFileName, 0);
}
catch (CoreException& err)
{
valid = false;
errstr << err.GetReason() << std::endl;
}
}
void ServerConfig::Apply(ServerConfig* old, const std::string &useruid)
{
valid = true;
if (old)
{
/*
* These values can only be set on boot. Keep their old values. Do it before we send messages so we actually have a servername.
*/
this->CaseMapping = old->CaseMapping;
this->ServerName = old->ServerName;
this->sid = old->sid;
this->cmdline = old->cmdline;
}
/* The stuff in here may throw CoreException, be sure we're in a position to catch it. */
try
{
// Ensure the user has actually edited ther config.
auto dietags = ConfTags("die");
if (!dietags.empty())
{
errstr << "Your configuration has not been edited correctly!" << std::endl;
for (const auto& [_, tag] : dietags)
{
const std::string reason = tag->getString("reason", "You left a <die> tag in your config", 1);
errstr << reason << " (at " << tag->source.str() << ")" << std::endl;
}
}
// Reject the broken configs that outdated tutorials keep pushing.
if (!ConfValue("power")->getString("pause").empty())
{
errstr << "You appear to be using a config file from an ancient outdated tutorial!" << std::endl
<< "This will almost certainly not work. You should instead create a config" << std::endl
<< "file using the examples shipped with InspIRCd or by referring to the" << std::endl
<< "docs available at " INSPIRCD_DOCS "configuration." << std::endl;
}
Fill();
// Handle special items
CrossCheckOperClassType();
CrossCheckConnectBlocks(old);
}
catch (CoreException &ce)
{
errstr << ce.GetReason() << std::endl;
}
// Check errors before dealing with failed binds, since continuing on failed bind is wanted in some circumstances.
valid = errstr.str().empty();
// write once here, to try it out and make sure its ok
if (valid)
ServerInstance->WritePID(!old);
auto binds = ConfTags("bind");
if (binds.empty())
errstr << "Possible configuration error: you have not defined any <bind> blocks." << std::endl
<< "You will need to do this if you want clients to be able to connect!" << std::endl;
if (old && valid)
{
// On first run, ports are bound later on
FailedPortList pl;
ServerInstance->BindPorts(pl);
if (!pl.empty())
{
errstr << "Warning! Some of your listener" << (pl.size() == 1 ? "s" : "") << " failed to bind:" << std::endl;
for (const auto& fp : pl)
{
errstr << " " << fp.sa.str() << ": " << strerror(fp.error) << std::endl
<< " " << "Created from <bind> tag at " << fp.tag->source.str() << std::endl;
}
}
}
User* user = ServerInstance->Users.FindUUID(useruid);
if (!valid)
{
ServerInstance->Logs.Log("CONFIG", LOG_DEFAULT, "There were errors in your configuration file:");
Classes.clear();
}
while (errstr.good())
{
std::string line;
getline(errstr, line, '\n');
if (line.empty())
continue;
// On startup, print out to console (still attached at this point)
if (!old)
std::cout << line << std::endl;
// If a user is rehashing, tell them directly
if (user)
user->WriteRemoteNotice(InspIRCd::Format("*** %s", line.c_str()));
// Also tell opers
ServerInstance->SNO.WriteGlobalSno('r', line);
}
errstr.clear();
errstr.str(std::string());
/* No old configuration -> initial boot, nothing more to do here */
if (!old)
{
if (!valid)
{
ServerInstance->Exit(EXIT_STATUS_CONFIG);
}
return;
}
// If there were errors processing configuration, don't touch modules.
if (!valid)
return;
ApplyModules(user);
if (user)
user->WriteRemoteNotice("*** Successfully rehashed server.");
ServerInstance->SNO.WriteGlobalSno('r', "*** Successfully rehashed server.");
}
void ServerConfig::ApplyModules(User* user)
{
std::vector<std::string> added_modules;
ModuleManager::ModuleMap removed_modules = ServerInstance->Modules.GetModules();
for (const auto& [_, tag] : ConfTags("module"))
{
std::string name;
if (tag->readString("name", name))
{
name = ModuleManager::ExpandModName(name);
// if this module is already loaded, the erase will succeed, so we need do nothing
// otherwise, we need to add the module (which will be done later)
if (removed_modules.erase(name) == 0)
added_modules.push_back(name);
}
}
for (const auto& [modname, mod] : removed_modules)
{
// Don't remove core_*, just remove m_*
if (InspIRCd::Match(modname, "core_*" DLL_EXTENSION, ascii_case_insensitive_map))
continue;
if (ServerInstance->Modules.Unload(mod))
{
ServerInstance->SNO.WriteGlobalSno('r', "*** REHASH UNLOADED MODULE: %s", modname.c_str());
if (user)
user->WriteNumeric(RPL_UNLOADEDMODULE, modname, InspIRCd::Format("The %s module was unloaded.", modname.c_str()));
else
ServerInstance->SNO.WriteGlobalSno('r', "The %s module was unloaded.", modname.c_str());
}
else
{
if (user)
user->WriteNumeric(ERR_CANTUNLOADMODULE, modname, InspIRCd::Format("Failed to unload the %s module: %s", modname.c_str(), ServerInstance->Modules.LastError().c_str()));
else
ServerInstance->SNO.WriteGlobalSno('r', "Failed to unload the %s module: %s", modname.c_str(), ServerInstance->Modules.LastError().c_str());
}
}
for (const auto& modname : added_modules)
{
// Skip modules which are already loaded.
if (ServerInstance->Modules.Find(modname))
continue;
if (ServerInstance->Modules.Load(modname))
{
ServerInstance->SNO.WriteGlobalSno('r', "*** REHASH LOADED MODULE: %s", modname.c_str());
if (user)
user->WriteNumeric(RPL_LOADEDMODULE, modname, InspIRCd::Format("The %s module was loaded.", modname.c_str()));
else
ServerInstance->SNO.WriteGlobalSno('r', "The %s module was loaded.", modname.c_str());
}
else
{
if (user)
user->WriteNumeric(ERR_CANTLOADMODULE, modname, InspIRCd::Format("Failed to load the %s module: %s", modname.c_str(), ServerInstance->Modules.LastError().c_str()));
else
ServerInstance->SNO.WriteGlobalSno('r', "Failed to load the %s module: %s", modname.c_str(), ServerInstance->Modules.LastError().c_str());
}
}
}
std::shared_ptr<ConfigTag> ServerConfig::ConfValue(const std::string& tag, std::shared_ptr<ConfigTag> def)
{
auto tags = insp::equal_range(config_data, tag);
if (tags.empty())
return def ? def : EmptyTag;
if (tags.count() > 1)
{
ServerInstance->Logs.Log("CONFIG", LOG_DEFAULT, "Multiple (%zu) <%s> tags found; only the first will be used (first at %s, last at %s)",
tags.count(), tag.c_str(), tags.begin()->second->source.str().c_str(), std::prev(tags.end())->second->source.str().c_str());
}
return tags.begin()->second;
}
ServerConfig::TagList ServerConfig::ConfTags(const std::string& tag, std::optional<TagList> def)
{
auto range = insp::equal_range(config_data, tag);
return range.empty() && def ? *def : range;
}
std::string ServerConfig::Escape(const std::string& str)
{
std::stringstream escaped;
for (const auto& chr : str)
{
switch (chr)
{
case '"':
escaped << """;
break;
case '&':
escaped << "&";
break;
default:
escaped << chr;
break;
}
}
return escaped.str();
}
void ConfigReaderThread::OnStart()
{
Config->Read();
done = true;
}
void ConfigReaderThread::OnStop()
{
ServerConfig* old = ServerInstance->Config;
ServerInstance->Logs.Log("CONFIG", LOG_DEBUG, "Switching to new configuration...");
ServerInstance->Config = this->Config;
Config->Apply(old, UUID);
if (Config->valid)
{
/*
* Apply the changed configuration from the rehash.
*
* XXX: The order of these is IMPORTANT, do not reorder them without testing
* thoroughly!!!
*/
ServerInstance->Users.RehashCloneCounts();
ServerInstance->XLines->CheckELines();
ServerInstance->XLines->ApplyLines();
User* user = ServerInstance->Users.FindUUID(UUID);
ConfigStatus status(user);
for (const auto& [modname, mod] : ServerInstance->Modules.GetModules())
{
try
{
ServerInstance->Logs.Log("MODULE", LOG_DEBUG, "Rehashing " + modname);
mod->ReadConfig(status);
}
catch (CoreException& modex)
{
ServerInstance->Logs.Log("MODULE", LOG_DEFAULT, "Exception caught: " + modex.GetReason());
if (user)
user->WriteNotice(modname + ": " + modex.GetReason());
}
}
// The description of this server may have changed - update it for WHOIS etc.
ServerInstance->FakeClient->server->description = Config->ServerDesc;
ServerInstance->Logs.CloseLogs();
ServerInstance->Logs.OpenFileLogs();
if (Config->RawLog && !old->RawLog)
ServerInstance->Users.ServerNoticeAll("*** Raw I/O logging is enabled on this server. All messages, passwords, and commands are being recorded.");
Config = old;
}
else
{
// whoops, abort!
ServerInstance->Config = old;
}
}
