/* * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2019 Matt Schatz * Copyright (C) 2018 linuxdaemon * Copyright (C) 2013, 2018-2023, 2025 Sadie Powell * Copyright (C) 2012-2013, 2016 Attila Molnar * Copyright (C) 2012, 2019 Robby * Copyright (C) 2009-2010 Daniel De Graaf * Copyright (C) 2008-2009 Robin Burchell * Copyright (C) 2008 Thomas Stagner * Copyright (C) 2008 Craig Edwards * * 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 . */ #include "inspircd.h" #include "modules/regex.h" #include "modules/stats.h" #include "timeutils.h" #include "xline.h" namespace { bool addedzline = false; bool useflags = false; bool zlineonmatch = false; } class RLine final : public XLine { public: RLine(time_t s_time, unsigned long d, const std::string& src, const std::string& re, const std::string& regexs, Regex::EngineReference& rxfactory) : XLine(s_time, d, src, re, "R") , matchtext(regexs) { /* This can throw on failure, but if it does we DONT catch it here, we catch it and display it * where the object is created, we might not ALWAYS want it to output stuff to snomask x all the time */ regex = useflags ? rxfactory->CreateHuman(regexs) : rxfactory->Create(regexs); } bool Matches(User* u) const override { LocalUser* lu = IS_LOCAL(u); if (lu && lu->exempt) return false; const std::string host = u->nick + "!" + u->GetRealUser() + "@" + u->GetRealHost() + " " + u->GetRealName(); const std::string ip = u->nick + "!" + u->GetRealUser() + "@" + u->GetAddress() + " " + u->GetRealName(); return (regex->IsMatch(host) || regex->IsMatch(ip)); } bool Matches(const std::string& compare) const override { return regex->IsMatch(compare); } void Apply(User* u) override { if (zlineonmatch) { auto* zl = new ZLine(ServerInstance->Time(), duration ? expiry - ServerInstance->Time() : 0, MODNAME "@" + ServerInstance->Config->ServerName, reason, u->GetAddress()); if (ServerInstance->XLines->AddLine(zl, nullptr)) { if (!duration) { ServerInstance->SNO.WriteToSnoMask('x', "{} added a permanent Z-line on {}: {}", zl->source, u->GetAddress(), zl->reason); } else { ServerInstance->SNO.WriteToSnoMask('x', "{} added a timed Z-line on {}, expires in {} (on {}): {}", zl->source, u->GetAddress(), Duration::ToLongString(zl->duration), Time::ToString(zl->duration), zl->reason); } addedzline = true; } else delete zl; } DefaultApply(u, false); } const std::string& Displayable() const override { return matchtext; } std::string matchtext; Regex::PatternPtr regex; }; /** An XLineFactory specialized to generate RLine* pointers */ class RLineFactory final : public XLineFactory { private: const Module* creator; Regex::EngineReference& rxfactory; public: RLineFactory(const Module* mod, Regex::EngineReference& rx) : XLineFactory("R") , creator(mod) , rxfactory(rx) { } /** Generate a RLine */ XLine* Generate(time_t set_time, unsigned long duration, const std::string& source, const std::string& reason, const std::string& xline_specific_mask) override { if (!rxfactory) { ServerInstance->SNO.WriteToSnoMask('a', "Cannot create regexes until engine is set to a loaded provider!"); throw ModuleException(creator, "Regex engine not set or loaded!"); } return new RLine(set_time, duration, source, reason, xline_specific_mask, rxfactory); } }; class CommandRLine final : public Command { std::string rxengine; RLineFactory& factory; public: CommandRLine(Module* Creator, RLineFactory& rlf) : Command(Creator, "RLINE", 1, 3) , factory(rlf) { access_needed = CmdAccess::OPERATOR; syntax = { " [[] :]" }; } CmdResult Handle(User* user, const Params& parameters) override { if (parameters.size() > 1) { // Adding - XXX todo make this respect tag perhaps.. unsigned long duration = 0; if (parameters.size() > 2 && !Duration::TryFrom(parameters[1], duration)) { user->WriteNotice("*** Invalid duration for R-line."); return CmdResult::FAILURE; } XLine* r = nullptr; try { r = factory.Generate(ServerInstance->Time(), duration, user->nick, parameters.back(), parameters[0]); } catch (const ModuleException& e) { ServerInstance->SNO.WriteToSnoMask('a', "Could not add R-line: " + e.GetReason()); } if (r) { if (ServerInstance->XLines->AddLine(r, user)) { if (!duration) { ServerInstance->SNO.WriteToSnoMask('x', "{} added a permanent R-line on {}: {}", user->nick, parameters[0], r->reason); } else { ServerInstance->SNO.WriteToSnoMask('x', "{} added a timed R-line on {}, expires in {} (on {}): {}", user->nick, parameters[0], Duration::ToLongString(duration), Time::FromNow(duration), r->reason); } ServerInstance->XLines->ApplyLines(); } else { delete r; user->WriteNotice("*** R-line for " + parameters[0] + " already exists."); } } } else { std::string reason; if (ServerInstance->XLines->DelLine(parameters[0], "R", reason, user)) { ServerInstance->SNO.WriteToSnoMask('x', "{} removed R-line on {}: {}", user->nick, parameters[0], reason); } else { user->WriteNotice("*** R-line " + parameters[0] + " not found on the list."); } } return CmdResult::SUCCESS; } }; class ModuleRLine final : public Module , public Stats::EventListener { private: Regex::EngineReference rxfactory; RLineFactory f; CommandRLine r; bool matchonnickchange; bool initing = true; Regex::Engine* factory; public: ModuleRLine() : Module(VF_VENDOR | VF_COMMON, "Adds the /RLINE command which allows server operators to prevent users matching a \"nickname!username@hostname realname\" regular expression from connecting to the server.") , Stats::EventListener(this) , rxfactory(this) , f(this, rxfactory) , r(this, f) { } void init() override { ServerInstance->XLines->RegisterFactory(&f); } ~ModuleRLine() override { ServerInstance->XLines->DelAll("R"); ServerInstance->XLines->UnregisterFactory(&f); } void GetLinkData(LinkData& data, std::string& compatdata) override { if (rxfactory) { compatdata = rxfactory->name; // e.g. regex/pcre data["regex"] = rxfactory->GetName(); // e.g. pcre } else data["regex"] = "broken"; if (useflags) data["flags"]; } ModResult OnUserRegister(LocalUser* user) override { // Apply lines on user connect XLine* rl = ServerInstance->XLines->MatchesLine("R", user); if (rl) { // Bang. :P rl->Apply(user); return MOD_RES_DENY; } return MOD_RES_PASSTHRU; } void ReadConfig(ConfigStatus& status) override { const auto& tag = ServerInstance->Config->ConfValue("rline"); matchonnickchange = tag->getBool("matchonnickchange"); useflags = tag->getBool("useflags"); zlineonmatch = tag->getBool("zlineonmatch"); std::string newrxengine = tag->getString("engine"); factory = rxfactory ? (rxfactory.operator->()) : nullptr; rxfactory.SetEngine(newrxengine); if (!rxfactory) { if (newrxengine.empty()) ServerInstance->SNO.WriteToSnoMask('r', "WARNING: No regex engine loaded - R-line functionality disabled until this is corrected."); else ServerInstance->SNO.WriteToSnoMask('r', "WARNING: Regex engine '{}' is not loaded - R-line functionality disabled until this is corrected.", newrxengine); ServerInstance->XLines->DelAll(f.GetType()); } else if ((!initing) && (rxfactory.operator->() != factory)) { ServerInstance->SNO.WriteToSnoMask('r', "Regex engine has changed, removing all R-lines."); ServerInstance->XLines->DelAll(f.GetType()); } initing = false; } ModResult OnStats(Stats::Context& stats) override { if (stats.GetSymbol() != 'R') return MOD_RES_PASSTHRU; ServerInstance->XLines->InvokeStats("R", stats); return MOD_RES_DENY; } void OnUserPostNick(User* user, const std::string& oldnick) override { if (!IS_LOCAL(user)) return; if (!matchonnickchange) return; XLine* rl = ServerInstance->XLines->MatchesLine("R", user); if (rl) { // Bang! :D rl->Apply(user); } } void OnBackgroundTimer(time_t curtime) override { if (addedzline) { addedzline = false; ServerInstance->XLines->ApplyLines(); } } void OnUnloadModule(Module* mod) override { // If the regex engine became unavailable or has changed, remove all R-lines. if (!rxfactory) { ServerInstance->XLines->DelAll(f.GetType()); } else if (rxfactory.operator->() != factory) { factory = rxfactory.operator->(); ServerInstance->XLines->DelAll(f.GetType()); } } void Prioritize() override { ServerInstance->Modules.SetPriority(this, I_OnUserRegister, PRIORITY_AFTER, "gateway"); } }; MODULE_INIT(ModuleRLine)