aboutsummaryrefslogtreecommitdiffstats
path: root/src/modules/m_services.cpp
diff options
context:
space:
mode:
authorGravatar Sadie Powell2024-07-17 00:06:50 +0100
committerGravatar Sadie Powell2024-07-17 00:06:50 +0100
commit889d521e05f2e922683d48c74eb00290e7a2f548 (patch)
treeb4c56bd4cdf0881601c7e4d6ff571e491af10bf4 /src/modules/m_services.cpp
parentUse std::endian from C++20 in the sha1 module. (diff)
downloadinspircd++-889d521e05f2e922683d48c74eb00290e7a2f548.tar.gz
inspircd++-889d521e05f2e922683d48c74eb00290e7a2f548.tar.bz2
inspircd++-889d521e05f2e922683d48c74eb00290e7a2f548.zip
Shuffle the modules about a bit.
Diffstat (limited to 'src/modules/m_services.cpp')
-rw-r--r--src/modules/m_services.cpp710
1 files changed, 0 insertions, 710 deletions
diff --git a/src/modules/m_services.cpp b/src/modules/m_services.cpp
deleted file mode 100644
index 4d9c84de4..000000000
--- a/src/modules/m_services.cpp
+++ /dev/null
@@ -1,710 +0,0 @@
-/*
- * InspIRCd -- Internet Relay Chat Daemon
- *
- * Copyright (C) 2022-2024 Sadie Powell <sadie@witchery.services>
- *
- * 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 "listmode.h"
-#include "modules/account.h"
-#include "modules/ctctags.h"
-#include "modules/server.h"
-#include "modules/stats.h"
-#include "timeutils.h"
-#include "xline.h"
-
-enum
-{
- // From UnrealIRCd.
- ERR_KILLDENY = 485,
-
- // From Charybdis.
- ERR_MLOCKRESTRICTED = 742,
-
- // InspIRCd-specific.
- ERR_TOPICLOCK = 744,
-};
-
-class RegisteredChannel final
- : public SimpleChannelMode
-{
-public:
- RegisteredChannel(Module* Creator)
- : SimpleChannelMode(Creator, "c_registered", 'r')
- {
- if (ServerInstance->Config->ConfValue("servicesintegration")->getBool("disablemodes"))
- DisableAutoRegister();
- }
-
- bool OnModeChange(User* source, User* dest, Channel* channel, Modes::Change& change) override
- {
- if (IS_LOCAL(source))
- {
- source->WriteNumeric(ERR_NOPRIVILEGES, fmt::format("Only a server may modify the +{} channel mode", GetModeChar()));
- return false;
- }
-
- return SimpleChannelMode::OnModeChange(source, dest, channel, change);
- }
-};
-
-class RegisteredUser final
- : public SimpleUserMode
-{
-
-public:
- RegisteredUser(Module* Creator)
- : SimpleUserMode(Creator, "u_registered", 'r')
- {
- if (ServerInstance->Config->ConfValue("servicesintegration")->getBool("disablemodes"))
- DisableAutoRegister();
- }
-
- bool OnModeChange(User* source, User* dest, Channel* channel, Modes::Change& change) override
- {
- if (IS_LOCAL(source))
- {
- source->WriteNumeric(ERR_NOPRIVILEGES, fmt::format("Only a server may modify the +{} user mode", GetModeChar()));
- return false;
- }
-
- return SimpleUserMode::OnModeChange(source, dest, channel, change);
- }
-};
-
-class ServiceTag final
- : public CTCTags::TagProvider
-{
-public:
- ServiceTag(Module* mod)
- : CTCTags::TagProvider(mod)
- {
- }
-
- void OnPopulateTags(ClientProtocol::Message& msg) override
- {
- const auto* user = msg.GetSourceUser();
- if (user && user->server->IsService())
- msg.AddTag("inspircd.org/service", this, "");
- }
-};
-
-class ServProtect final
- : public SimpleUserMode
-{
-public:
- ServProtect(Module* Creator)
- : SimpleUserMode(Creator, "servprotect", 'k', true)
- {
- }
-
- bool OnModeChange(User* source, User* dest, Channel* channel, Modes::Change& change) override
- {
- // As this mode is only intended for use by pseudoclients the only way
- // to set it is by introducing a user with it.
- return false;
- }
-};
-
-class SVSHold final
- : public XLine
-{
-private:
- std::string nickname;
-
-public:
- SVSHold(time_t settime, unsigned long period, const std::string& setter, const std::string& message, const std::string& nick)
- : XLine(settime, period, setter, message, "SVSHOLD")
- , nickname(nick)
- {
- }
-
- void Apply(User* u) override
- {
- u->WriteNumeric(RPL_SAVENICK, u->nick, fmt::format("Services reserved nickname: {}", reason));
- u->ChangeNick(u->uuid);
- }
-
- const std::string& Displayable() const override
- {
- return nickname;
- }
-
- void DisplayExpiry() override
- {
- // SVSHOLDs do not generate any messages.
- }
-
- bool Matches(User* user) const override
- {
- return irc::equals(user->nick, nickname);
- }
-
- bool Matches(const std::string& text) const override
- {
- return irc::equals(text, nickname);
- }
-};
-
-class SVSHoldFactory final
- : public XLineFactory
-{
-public:
- SVSHoldFactory()
- : XLineFactory("SVSHOLD")
- {
- }
-
- XLine* Generate(time_t settime, unsigned long duration, const std::string& source, const std::string& reason, const std::string& nick) override
- {
- return new SVSHold(settime, duration, source, reason, nick);
- }
-};
-
-class CommandSVSCMode final
- : public Command
-{
-public:
- CommandSVSCMode(Module* mod)
- : Command(mod, "SVSCMODE", 3)
- {
- access_needed = CmdAccess::SERVER;
- }
-
- CmdResult Handle(User* user, const Params& parameters) override
- {
- // The command can only be executed by remote services servers.
- if (IS_LOCAL(user) || !user->server->IsService())
- return CmdResult::FAILURE;
-
- auto* u = ServerInstance->Users.FindUUID(parameters[0]);
- if (!u)
- return CmdResult::FAILURE;
-
- auto* c = ServerInstance->Channels.Find(parameters[1]);
- if (!c)
- return CmdResult::FAILURE;
-
- for (auto mode : parameters[2])
- {
- auto* mh = ServerInstance->Modes.FindMode(mode, MODETYPE_CHANNEL);
- if (!mh || !mh->IsListModeBase())
- continue; // Not a list mode.
-
- auto* list = mh->IsListModeBase()->GetList(c);
- if (!list)
- continue; // No list modes set.
-
- Modes::ChangeList changelist;
- for (const auto& entry : *list)
- {
- if (c->CheckBan(u, entry.mask))
- changelist.push(mh, false, entry.mask);
- }
- ServerInstance->Modes.Process(user, c, nullptr, changelist);
- }
- return CmdResult::SUCCESS;
- }
-};
-
-class CommandSVSHold final
- : public Command
-{
-public:
- CommandSVSHold(Module* Creator)
- : Command(Creator, "SVSHOLD")
- {
- access_needed = CmdAccess::SERVER;
- }
-
- CmdResult Handle(User* user, const Params& parameters) override
- {
- // The command can only be executed by remote services servers.
- if (IS_LOCAL(user) || !user->server->IsService())
- return CmdResult::FAILURE;
-
- if (parameters.size() == 1)
- {
- // :36DAAAAAA SVSHOLD ChanServ
- std::string reason;
- return ServerInstance->XLines->DelLine(parameters[0], "SVSHOLD", reason, user) ? CmdResult::SUCCESS : CmdResult::FAILURE;
- }
-
- if (parameters.size() == 3)
- {
- /// :36DAAAAAA SVSHOLD NickServ 86400 :Reserved for services
- /// :36DAAAAAA SVSHOLD NickServ 1d :Reserved for services
- unsigned long duration;
- if (!Duration::TryFrom(parameters[1], duration))
- return CmdResult::FAILURE;
-
- auto* svshold = new SVSHold(ServerInstance->Time(), duration, user->nick, parameters[2], parameters[0]);
- return ServerInstance->XLines->AddLine(svshold, user) ? CmdResult::SUCCESS : CmdResult::FAILURE;
- }
-
- return CmdResult::FAILURE;
- }
-
- RouteDescriptor GetRouting(User* user, const Params& parameters) override
- {
- return ROUTE_BROADCAST;
- }
-};
-
-class CommandSVSJoin final
- : public Command
-{
-public:
- CommandSVSJoin(Module* mod)
- : Command(mod, "SVSJOIN", 2)
- {
- access_needed = CmdAccess::SERVER;
- }
-
- CmdResult Handle(User* user, const Params& parameters) override
- {
- // The command can only be executed by remote services servers.
- if (IS_LOCAL(user) || !user->server->IsService())
- return CmdResult::FAILURE;
-
- // Check for a valid channel name.
- if (!ServerInstance->Channels.IsChannel(parameters[1]))
- return CmdResult::FAILURE;
-
- // Check the target exists/
- auto* u = ServerInstance->Users.FindUUID(parameters[0]);
- if (!u)
- return CmdResult::FAILURE;
-
- /* only join if it's local, otherwise just pass it on! */
- auto* lu = IS_LOCAL(u);
- if (lu)
- {
- bool override = false;
- std::string key;
- if (parameters.size() >= 3)
- {
- key = parameters[2];
- if (key.empty())
- override = true;
- }
-
- Channel::JoinUser(lu, parameters[1], override, key);
- }
-
- return CmdResult::SUCCESS;
- }
-
- RouteDescriptor GetRouting(User* user, const Params& parameters) override
- {
- return ROUTE_UNICAST(parameters[0]);
- }
-};
-
-class CommandSVSNick final
- : public Command
-{
-public:
- CommandSVSNick(Module* mod)
- : Command(mod, "SVSNICK", 3)
- {
- access_needed = CmdAccess::SERVER;
- }
-
- CmdResult Handle(User* user, const Params& parameters) override
- {
- // The command can only be executed by remote services servers.
- if (IS_LOCAL(user) || !user->server->IsService())
- return CmdResult::FAILURE;
-
- auto* u = ServerInstance->Users.Find(parameters[0]);
- if (u && IS_LOCAL(u))
- {
- // The 4th parameter is optional and it is the expected nick TS of the target user. If
- // this parameter is present and it doesn't match the user's nick TS, the SVSNICK is not
- // acted upon.
- //
- // This makes it possible to detect the case when services wants to change the nick of
- // a user, but the user changes their nick before the SVSNICK arrives, making the
- // SVSNICK nick change (usually to a guest nick) unnecessary. Consider the following for
- // example:
- //
- // 1. test changes nick to Attila which is protected by services
- // 2. Services SVSNICKs the user to Guest12345
- // 3. Attila changes nick to Attila_ which isn't protected by services
- // 4. SVSNICK arrives
- // 5. Attila_ gets his nick changed to Guest12345 unnecessarily
- //
- // In this case when the SVSNICK is processed the target has already changed their nick
- // to something which isn't protected, so changing the nick again to a Guest nick is not
- // desired. However, if the expected nick TS parameter is present in the SVSNICK then
- // the nick change in step 5 won't happen because the timestamps won't match.
- if (parameters.size() > 3)
- {
- time_t expectedts = ConvToNum<time_t>(parameters[3]);
- if (!expectedts)
- return CmdResult::INVALID; // Malformed message
-
- if (u->nickchanged != expectedts)
- return CmdResult::FAILURE; // Ignore SVSNICK
- }
-
- std::string nick = parameters[1];
- if (isdigit(nick[0]))
- nick = u->uuid;
-
- time_t nickts = ConvToNum<time_t>(parameters[2]);
- if (!nickts)
- return CmdResult::INVALID; // Malformed message
-
- if (!u->ChangeNick(nick, nickts))
- {
- // Changing to 'nick' failed (it may already be in use), change to the uuid
- u->WriteNumeric(RPL_SAVENICK, u->uuid, "Your nickname is in use by an older user on a new server.");
- u->ChangeNick(u->uuid);
- }
- }
- return CmdResult::SUCCESS;
- }
-
- RouteDescriptor GetRouting(User* user, const Params& parameters) override
- {
- return ROUTE_UNICAST(parameters[0]);
- }
-};
-
-class CommandSVSOper final
- : public Command
-{
-public:
- CommandSVSOper(Module* Creator)
- : Command(Creator, "SVSOPER", 2, 2)
- {
- access_needed = CmdAccess::SERVER;
- }
-
- CmdResult Handle(User* user, const Params& parameters) override
- {
- if (!user->server->IsService())
- return CmdResult::FAILURE;
-
- auto* target = ServerInstance->Users.FindUUID(parameters[0]);
- if (!target)
- return CmdResult::FAILURE;
-
- if (IS_LOCAL(target))
- {
- auto iter = ServerInstance->Config->OperTypes.find(parameters[1]);
- if (iter == ServerInstance->Config->OperTypes.end())
- return CmdResult::FAILURE;
-
- auto automatic = parameters.GetTags().find("~automatic") != parameters.GetTags().end();
- auto account = std::make_shared<OperAccount>(MODNAME, iter->second, ServerInstance->Config->EmptyTag);
- target->OperLogin(account, automatic, true);
- }
-
- return CmdResult::SUCCESS;
- }
-
- RouteDescriptor GetRouting(User* user, const Params& parameters) override
- {
- auto* target = ServerInstance->Users.FindUUID(parameters[0]);
- if (!target)
- return ROUTE_LOCALONLY;
- return ROUTE_OPT_UCAST(target->server);
- }
-};
-
-class CommandSVSPart final
- : public Command
-{
-public:
- CommandSVSPart(Module* mod)
- : Command(mod, "SVSPART", 2)
- {
- access_needed = CmdAccess::SERVER;
- }
-
- CmdResult Handle(User* user, const Params& parameters) override
- {
- // The command can only be executed by remote services servers.
- if (IS_LOCAL(user) || !user->server->IsService())
- return CmdResult::FAILURE;
-
- auto* u = ServerInstance->Users.FindUUID(parameters[0]);
- if (!u)
- return CmdResult::FAILURE;
-
- auto* c = ServerInstance->Channels.Find(parameters[1]);
- if (!c)
- return CmdResult::FAILURE;
-
- if (IS_LOCAL(u))
- c->PartUser(u, parameters.size() == 3 ? parameters[2] : "Services forced part");
-
- return CmdResult::SUCCESS;
- }
-
- RouteDescriptor GetRouting(User* user, const Params& parameters) override
- {
- return ROUTE_UNICAST(parameters[0]);
- }
-};
-
-class CommandSVSTopic final
- : public Command
-{
-public:
- CommandSVSTopic(Module* mod)
- : Command(mod, "SVSTOPIC", 1, 4)
- {
- access_needed = CmdAccess::SERVER;
- allow_empty_last_param = true;
- }
-
- CmdResult Handle(User* user, const Params& parameters) override
- {
- // The command can only be executed by remote services servers.
- if (IS_LOCAL(user) || !user->server->IsService())
- return CmdResult::FAILURE;
-
- auto* chan = ServerInstance->Channels.Find(parameters[0]);
- if (!chan)
- return CmdResult::FAILURE;
-
- if (parameters.size() == 4)
- {
- // 4 parameter version, set all topic data on the channel to the ones given in the parameters.
- time_t topicts = ConvToNum<time_t>(parameters[1]);
- if (!topicts)
- {
- ServerInstance->Logs.Debug(MODNAME, "Received SVSTOPIC with a 0 topicts; dropped.");
- return CmdResult::INVALID;
- }
-
- chan->SetTopic(user, parameters[3], topicts, &parameters[2]);
- }
- else
- {
- // 1 parameter version, nuke the topic
- chan->SetTopic(user, std::string(), 0);
- chan->setby.clear();
- }
-
- return CmdResult::SUCCESS;
- }
-
- RouteDescriptor GetRouting(User* user, const Params& parameters) override
- {
- return ROUTE_BROADCAST;
- }
-};
-
-class ModuleServices final
- : public Module
- , public ServerProtocol::RouteEventListener
- , public Stats::EventListener
-{
-private:
- Account::API accountapi;
- RegisteredChannel registeredcmode;
- RegisteredUser registeredumode;
- ServiceTag servicetag;
- ServProtect servprotectmode;
- SVSHoldFactory svsholdfactory;
- BoolExtItem auspexext;
- StringExtItem mlockext;
- BoolExtItem topiclockext;
- CommandSVSCMode svscmodecmd;
- CommandSVSHold svsholdcmd;
- CommandSVSJoin svsjoincmd;
- CommandSVSNick svsnickcmd;
- CommandSVSOper svsopercmd;
- CommandSVSPart svspartcmd;
- CommandSVSTopic svstopiccmd;
- bool accountoverrideshold;
-
- bool HandleModeLock(User* user, Channel* chan, const Modes::Change& change)
- {
- const auto* mlock = mlockext.Get(chan);
- if (!mlock)
- return true; // No mode lock.
-
- if (mlock->find(change.mh->GetModeChar()) == std::string::npos)
- return true; // Mode is not locked.
-
- user->WriteNumeric(ERR_MLOCKRESTRICTED, chan->name, change.mh->GetModeChar(), *mlock, fmt::format("Mode cannot be changed as it has been locked {} by services!",
- chan->IsModeSet(change.mh) ? "on" : "off"));
- return false;
- }
-
- bool HandleProtectedService(User* user, Channel* chan, const Modes::Change& change)
- {
- if (change.adding || change.param.empty())
- return true; // We only care about local users removing prefix modes.
-
- const auto* pm = change.mh->IsPrefixMode();
- if (!pm)
- return true; // Mode is not a prefix mode.
-
- auto* target = ServerInstance->Users.Find(change.param);
- if (!target)
- return true; // Target does not exist.
-
- Membership* memb = chan->GetUser(target);
- if (!memb || !memb->HasMode(pm))
- return true; // Target does not have the mode.
-
- if (!target->IsModeSet(servprotectmode))
- return true; // Target is not a protected service.
-
- user->WriteNumeric(ERR_RESTRICTED, chan->name, fmt::format("You are not permitted to remove privileges from {} services!", ServerInstance->Config->Network));
- return false;
- }
-
-public:
- ModuleServices()
- : Module(VF_COMMON | VF_VENDOR, "Provides support for integrating with a services server.")
- , ServerProtocol::RouteEventListener(this)
- , Stats::EventListener(this)
- , accountapi(this)
- , registeredcmode(this)
- , registeredumode(this)
- , servicetag(this)
- , servprotectmode(this)
- , auspexext(this, "auspex", ExtensionType::CHANNEL, true)
- , mlockext(this, "mlock", ExtensionType::CHANNEL, true)
- , topiclockext(this, "topiclock", ExtensionType::CHANNEL, true)
- , svscmodecmd(this)
- , svsholdcmd(this)
- , svsjoincmd(this)
- , svsnickcmd(this)
- , svsopercmd(this)
- , svspartcmd(this)
- , svstopiccmd(this)
- {
- }
-
- ~ModuleServices() override
- {
- ServerInstance->XLines->DelAll("SVSHOLD");
- ServerInstance->XLines->UnregisterFactory(&svsholdfactory);
- }
-
- void init() override
- {
- ServerInstance->XLines->RegisterFactory(&svsholdfactory);
- }
-
- void ReadConfig(ConfigStatus& status) override
- {
- const auto& tag = ServerInstance->Config->ConfValue("servicesintegration");
- accountoverrideshold = tag->getBool("accountoverrideshold");
- }
-
- ModResult OnRouteMessage(const Channel* channel, const Server* server) override
- {
- if (!server->IsService() || !auspexext.Get(channel))
- return MOD_RES_PASSTHRU;
-
- // Allow services to see messages in this channel even if not guarded.
- return MOD_RES_ALLOW;
- }
-
- ModResult OnKill(User* source, User* dest, const std::string& reason) override
- {
- if (!source)
- return MOD_RES_PASSTHRU;
-
- if (dest->IsModeSet(servprotectmode))
- {
- source->WriteNumeric(ERR_KILLDENY, fmt::format("You are not permitted to kill {} services!", ServerInstance->Config->Network));
- return MOD_RES_DENY;
- }
- return MOD_RES_PASSTHRU;
- }
-
- ModResult OnPreTopicChange(User* user, Channel* chan, const std::string& topic) override
- {
- if (!IS_LOCAL(user) || !topiclockext.Get(chan))
- return MOD_RES_PASSTHRU; // Remote user or no topiclock.
-
- user->WriteNumeric(ERR_TOPICLOCK, chan->name, "Topic cannot be changed as it has been locked by services!");
- return MOD_RES_DENY;
- }
-
- ModResult OnRawMode(User* user, Channel* chan, const Modes::Change& change) override
- {
- if (!IS_LOCAL(user) || !chan)
- return MOD_RES_PASSTHRU; // Not our job to handle.
-
- if (!HandleProtectedService(user, chan, change))
- return MOD_RES_DENY;
-
- if (!HandleModeLock(user, chan, change))
- return MOD_RES_DENY;
-
- return MOD_RES_PASSTHRU;
- }
-
- ModResult OnStats(Stats::Context& stats) override
- {
- if (stats.GetSymbol() != 'S')
- return MOD_RES_PASSTHRU;
-
- ServerInstance->XLines->InvokeStats("SVSHOLD", stats);
- return MOD_RES_DENY;
- }
-
- ModResult OnUserPreKick(User* source, Membership* memb, const std::string& reason) override
- {
- if (memb->user->IsModeSet(servprotectmode))
- {
- source->WriteNumeric(ERR_RESTRICTED, memb->chan->name, fmt::format("You are not permitted to kick {} services!", ServerInstance->Config->Network));
- return MOD_RES_DENY;
- }
- return MOD_RES_PASSTHRU;
- }
-
- ModResult OnUserPreNick(LocalUser* user, const std::string& newnick) override
- {
- auto* svshold = ServerInstance->XLines->MatchesLine("SVSHOLD", newnick);
- if (!svshold)
- return MOD_RES_PASSTHRU;
-
- if (accountoverrideshold && accountapi)
- {
- Account::NickList* nicks = accountapi->GetAccountNicks(user);
- if (nicks && nicks->find(svshold->Displayable()) != nicks->end())
- {
- std::string reason;
- ServerInstance->XLines->DelLine(svshold, reason, user);
- return MOD_RES_PASSTHRU;
- }
- }
-
- user->WriteNumeric(ERR_ERRONEUSNICKNAME, newnick, fmt::format("Services reserved nickname: {}", svshold->reason));
- return MOD_RES_DENY;
- }
-
- void OnUserPostNick(User* user, const std::string& oldnick) override
- {
- if (user->IsModeSet(registeredumode) && !irc::equals(oldnick, user->nick))
- registeredumode.RemoveMode(user);
- }
-};
-
-MODULE_INIT(ModuleServices)