diff --git a/docs/conf/modules.conf.example b/docs/conf/modules.conf.example index bd3dae18a..fea6f64ab 100644 --- a/docs/conf/modules.conf.example +++ b/docs/conf/modules.conf.example @@ -716,6 +716,29 @@ # case="lower" # pathparts="1"> +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# Static cloak module: Adds the "static" (fixed value) cloak method. +# +# +#-#-#-#-#-#-#-#-#-#- ACCOUNT CLOAK CONFIGURATION -#-#-#-#-#-#-#-#-#-#-# +# To use the cloak_static module you must define a tag. This # +# tag can have the following fields. # +# # +# class - If non-empty then a comma-delimited list of connect class # +# names that a user has to be in to get the cloak from this tag. # +# # +# cloak - The cloak to give to users. # +# # +# IMPORTANT: Changing these details will break all of your existing # +# bans. If you do not want this to happen you can define multiple # +# cloak tags. The first will be used for hostnames and the rest will # +# be used for checking if a user is banned in a channel. # +#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# +# +# + #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# # Codepage module: Allows using a custom 8-bit codepage for nicknames # and case mapping. diff --git a/src/modules/m_cloak_static.cpp b/src/modules/m_cloak_static.cpp new file mode 100644 index 000000000..7c56654f6 --- /dev/null +++ b/src/modules/m_cloak_static.cpp @@ -0,0 +1,84 @@ +/* + * InspIRCd -- Internet Relay Chat Daemon + * + * Copyright (C) 2023 Sadie Powell + * + * 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/cloak.h" + +class StaticMethod final + : public Cloak::Method +{ +private: + // The cloak to set on users. + std::string cloak; + +public: + StaticMethod(const Cloak::Engine* engine, const std::shared_ptr& tag) ATTR_NOT_NULL(2) + : Cloak::Method(engine, tag) + , cloak(tag->getString("cloak")) + { + } + + std::string Generate(LocalUser* user) override ATTR_NOT_NULL(2) + { + if (!MatchesUser(user)) + return {}; // We shouldn't cloak this user. + + return cloak; + } + + std::string Generate(const std::string& hostip) override + { + return cloak; + } + + void GetLinkData(Module::LinkData& data, std::string& compatdata) override + { + data["cloak"] = cloak; + } +}; + +class StaticEngine final + : public Cloak::Engine +{ +public: + StaticEngine(Module* Creator) + : Cloak::Engine(Creator, "static") + { + } + + Cloak::MethodPtr Create(const std::shared_ptr& tag, bool primary) override + { + return std::make_shared(this, tag); + } +}; + +class ModuleCloakStatic final + : public Module +{ +private: + StaticEngine nickcloak; + +public: + ModuleCloakStatic() + : Module(VF_VENDOR, "Adds the static cloaking method for use with the cloak module.") + , nickcloak(this) + { + } +}; + +MODULE_INIT(ModuleCloakStatic)