-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2017, 2019 B00mX0r <b00mx0r@aureus.pw>
+ * Copyright (C) 2017 Sheogorath <sheogorath@shivering-isles.com>
+ * Copyright (C) 2016 Adam <Adam@anope.org>
+ * Copyright (C) 2014 Thomas Fargeix <t.fargeix@gmail.com>
+ * Copyright (C) 2013, 2018 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2013, 2016-2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2011 jackmcbarn <jackmcbarn@inspircd.org>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2007-2009 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007-2008 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2007 John Brooks <special@inspircd.org>
+ * Copyright (C) 2006 Oliver Lupton <om@inspircd.org>
+ * Copyright (C) 2003, 2007-2008, 2010 Craig Edwards <brain@inspircd.org>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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 "m_hash.h"
+#include "modules/hash.h"
-/* $ModDesc: Provides masking of user hostnames */
-/* $ModDep: m_hash.h */
+enum CloakMode
+{
+ /** 2.0 cloak of "half" of the hostname plus the full IP hash */
+ MODE_HALF_CLOAK,
-/** Handles user mode +x
- */
-class CloakUser : public ModeHandler
+ /** 2.0 cloak of IP hash, split at 2 common CIDR range points */
+ MODE_OPAQUE
+};
+
+// lowercase-only encoding similar to base64, used for hash output
+static const char base32[] = "0123456789abcdefghijklmnopqrstuv";
+
+// The minimum length of a cloak key.
+static const size_t minkeylen = 30;
+
+struct CloakInfo
{
+ // The method used for cloaking users.
+ CloakMode mode;
+
+ // The number of parts of the hostname shown when using half cloaking.
+ unsigned int domainparts;
+
+ // Whether to ignore the case of a hostname when cloaking it.
+ bool ignorecase;
+
+ // The secret used for generating cloaks.
+ std::string key;
+
+ // The prefix for cloaks (e.g. MyNet-).
std::string prefix;
- unsigned int key1;
- unsigned int key2;
- unsigned int key3;
- unsigned int key4;
- bool ipalways;
- Module* Sender;
- Module* HashProvider;
- const char *xtab[4];
-
- /** This function takes a domain name string and returns just the last two domain parts,
- * or the last domain part if only two are available. Failing that it just returns what it was given.
- *
- * For example, if it is passed "svn.inspircd.org" it will return ".inspircd.org".
- * If it is passed "brainbox.winbot.co.uk" it will return ".co.uk",
- * and if it is passed "localhost.localdomain" it will return ".localdomain".
- *
- * This is used to ensure a significant part of the host is always cloaked (see Bug #216)
- */
- std::string LastTwoDomainParts(const std::string &host)
+
+ // The suffix for IP cloaks (e.g. .IP).
+ std::string suffix;
+
+ CloakInfo(CloakMode Mode, const std::string& Key, const std::string& Prefix, const std::string& Suffix, bool IgnoreCase, unsigned int DomainParts = 0)
+ : mode(Mode)
+ , domainparts(DomainParts)
+ , ignorecase(IgnoreCase)
+ , key(Key)
+ , prefix(Prefix)
+ , suffix(Suffix)
{
- int dots = 0;
- std::string::size_type splitdot = host.length();
+ }
+};
- for (std::string::size_type x = host.length() - 1; x; --x)
- {
- if (host[x] == '.')
- {
- splitdot = x;
- dots++;
- }
- if (dots >= 3)
- break;
- }
+typedef std::vector<std::string> CloakList;
- if (splitdot == host.length())
- return host;
- else
- return host.substr(splitdot);
+class CloakExtItem : public SimpleExtItem<CloakList>
+{
+ public:
+ CloakExtItem(Module* Creator)
+ : SimpleExtItem("cloaks", ExtensionItem::EXT_USER, Creator)
+ {
}
-
+
+ std::string ToHuman(const Extensible* container, void* item) const CXX11_OVERRIDE
+ {
+ return stdalgo::string::join(*static_cast<CloakList*>(item), ' ');
+ }
+};
+
+class CloakUser : public ModeHandler
+{
public:
- CloakUser(InspIRCd* Instance, Module* Source, Module* Hash) : ModeHandler(Instance, 'x', 0, 0, false, MODETYPE_USER, false), Sender(Source), HashProvider(Hash)
+ bool active;
+ CloakExtItem ext;
+ std::string debounce_uid;
+ time_t debounce_ts;
+ int debounce_count;
+
+ CloakUser(Module* source)
+ : ModeHandler(source, "cloak", 'x', PARAM_NONE, MODETYPE_USER)
+ , active(false)
+ , ext(source)
+ , debounce_ts(0)
+ , debounce_count(0)
{
}
- ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
{
- if (source != dest)
- return MODEACTION_DENY;
+ LocalUser* user = IS_LOCAL(dest);
- /* For remote clients, we dont take any action, we just allow it.
+ /* For remote clients, we don't take any action, we just allow it.
* The local server where they are will set their cloak instead.
+ * This is fine, as we will receive it later.
*/
- if (!IS_LOCAL(dest))
+ if (!user)
+ {
+ // Remote setters broadcast mode before host while local setters do the opposite, so this takes that into account
+ active = IS_LOCAL(source) ? adding : !adding;
+ dest->SetMode(this, adding);
return MODEACTION_ALLOW;
+ }
+
+ if (user->uuid == debounce_uid && debounce_ts == ServerInstance->Time())
+ {
+ // prevent spamming using /mode user +x-x+x-x+x-x
+ if (++debounce_count > 2)
+ return MODEACTION_DENY;
+ }
+ else
+ {
+ debounce_uid = user->uuid;
+ debounce_count = 1;
+ debounce_ts = ServerInstance->Time();
+ }
+
+ if (adding == user->IsModeSet(this))
+ return MODEACTION_DENY;
/* don't allow this user to spam modechanges */
- dest->IncreasePenalty(5);
+ if (source == dest)
+ user->CommandFloodPenalty += 5000;
if (adding)
{
- if(!dest->IsModeSet('x'))
+ // assume this is more correct
+ if (user->registered != REG_ALL && user->GetRealHost() != user->GetDisplayedHost())
+ return MODEACTION_DENY;
+
+ CloakList* cloaks = ext.get(user);
+ if (!cloaks)
{
- /* The mode is being turned on - so attempt to
- * allocate the user a cloaked host using a non-reversible
- * algorithm (its simple, but its non-reversible so the
- * simplicity doesnt really matter). This algorithm
- * will not work if the user has only one level of domain
- * naming in their hostname (e.g. if they are on a lan or
- * are connecting via localhost) -- this doesnt matter much.
- */
-
- char* n1 = strchr(dest->host,'.');
- char* n2 = strchr(dest->host,':');
-
- if (n1 || n2)
+ /* Force creation of missing cloak */
+ try
{
- unsigned int iv[] = { key1, key2, key3, key4 };
- std::string a = LastTwoDomainParts(dest->host);
- std::string b;
-
- /* InspIRCd users have two hostnames; A displayed
- * hostname which can be modified by modules (e.g.
- * to create vhosts, implement chghost, etc) and a
- * 'real' hostname which you shouldnt write to.
- */
-
- /* 2007/08/18: add <cloak:ipalways> which always cloaks
- * the IP, for anonymity. --nenolod
- */
- if (!ipalways)
- {
- /** Reset the Hash module, and send it our IV and hex table */
- HashResetRequest(Sender, HashProvider).Send();
- HashKeyRequest(Sender, HashProvider, iv).Send();
- HashHexRequest(Sender, HashProvider, xtab[(*dest->host) % 4]);
-
- /* Generate a cloak using specialized Hash */
- std::string hostcloak = prefix + "-" + std::string(HashSumRequest(Sender, HashProvider, dest->host).Send()).substr(0,8) + a;
-
- /* Fix by brain - if the cloaked host is > the max length of a host (64 bytes
- * according to the DNS RFC) then tough titty, they get cloaked as an IP.
- * Their ISP shouldnt go to town on subdomains, or they shouldnt have a kiddie
- * vhost.
- */
-#ifdef IPV6
- in6_addr testaddr;
- in_addr testaddr2;
- if ((dest->GetProtocolFamily() == AF_INET6) && (inet_pton(AF_INET6,dest->host,&testaddr) < 1) && (hostcloak.length() <= 64))
- /* Invalid ipv6 address, and ipv6 user (resolved host) */
- b = hostcloak;
- else if ((dest->GetProtocolFamily() == AF_INET) && (inet_aton(dest->host,&testaddr2) < 1) && (hostcloak.length() <= 64))
- /* Invalid ipv4 address, and ipv4 user (resolved host) */
- b = hostcloak;
- else
- /* Valid ipv6 or ipv4 address (not resolved) ipv4 or ipv6 user */
- b = ((!strchr(dest->host,':')) ? Cloak4(dest->host) : Cloak6(dest->host));
-#else
- in_addr testaddr;
- if ((inet_aton(dest->host,&testaddr) < 1) && (hostcloak.length() <= 64))
- /* Invalid ipv4 address, and ipv4 user (resolved host) */
- b = hostcloak;
- else
- /* Valid ipv4 address (not resolved) ipv4 user */
- b = Cloak4(dest->host);
-#endif
- }
- else
- {
-#ifdef IPV6
- if (dest->GetProtocolFamily() == AF_INET6)
- b = Cloak6(dest->GetIPString());
-#endif
- if (dest->GetProtocolFamily() == AF_INET)
- b = Cloak4(dest->GetIPString());
- }
-
- dest->ChangeDisplayedHost(b.c_str());
+ creator->OnUserConnect(user);
+ cloaks = ext.get(user);
+ }
+ catch (CoreException& modexcept)
+ {
+ ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Exception caught when generating cloak: " + modexcept.GetReason());
+ return MODEACTION_DENY;
}
-
- dest->SetMode('x',true);
- return MODEACTION_ALLOW;
}
- }
- else
- {
- if (dest->IsModeSet('x'))
+
+ // If we have a cloak then set the hostname.
+ if (cloaks && !cloaks->empty())
{
- /* User is removing the mode, so just restore their real host
- * and make it match the displayed one.
- */
- dest->ChangeDisplayedHost(dest->host);
- dest->SetMode('x',false);
+ user->ChangeDisplayedHost(cloaks->front());
+ user->SetMode(this, true);
return MODEACTION_ALLOW;
}
+ else
+ return MODEACTION_DENY;
}
+ else
+ {
+ /* User is removing the mode, so restore their real host
+ * and make it match the displayed one.
+ */
+ user->SetMode(this, false);
+ user->ChangeDisplayedHost(user->GetRealHost().c_str());
+ return MODEACTION_ALLOW;
+ }
+ }
+};
- return MODEACTION_DENY;
+class CommandCloak : public Command
+{
+ public:
+ CommandCloak(Module* Creator) : Command(Creator, "CLOAK", 1)
+ {
+ flags_needed = 'o';
+ syntax = "<host>";
}
- std::string Cloak4(const char* ip)
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE;
+};
+
+class ModuleCloaking : public Module
+{
+ public:
+ CloakUser cu;
+ CommandCloak ck;
+ std::vector<CloakInfo> cloaks;
+ dynamic_reference<HashProvider> Hash;
+
+ ModuleCloaking()
+ : cu(this)
+ , ck(this)
+ , Hash(this, "hash/md5")
{
- unsigned int iv[] = { key1, key2, key3, key4 };
- irc::sepstream seps(ip, '.');
- std::string ra[4];;
- std::string octet[4];
- int i[4];
+ }
- for (int j = 0; j < 4; j++)
+ /** Takes a domain name and retrieves the subdomain which should be visible.
+ * This is usually the last \p domainparts labels but if not enough are
+ * present then all but the most specific label are used. If the domain name
+ * consists of one label only then none are used.
+ *
+ * Here are some examples for how domain names will be shortened assuming
+ * \p domainparts is set to the default of 3.
+ *
+ * "this.is.an.example.com" => ".an.example.com"
+ * "an.example.com" => ".example.com"
+ * "example.com" => ".com"
+ * "localhost" => ""
+ *
+ * @param host The hostname to cloak.
+ * @param domainparts The number of domain labels that should be visible.
+ * @return The visible segment of the hostname.
+ */
+ std::string VisibleDomainParts(const std::string& host, unsigned int domainparts)
+ {
+ // The position at which we found the last dot.
+ std::string::const_reverse_iterator dotpos;
+
+ // The number of dots we have seen so far.
+ unsigned int seendots = 0;
+
+ for (std::string::const_reverse_iterator iter = host.rbegin(); iter != host.rend(); ++iter)
{
- seps.GetToken(octet[j]);
- i[j] = atoi(octet[j].c_str());
+ if (*iter != '.')
+ continue;
+
+ // We have found a dot!
+ dotpos = iter;
+ seendots += 1;
+
+ // Do we have enough segments to stop?
+ if (seendots >= domainparts)
+ break;
}
- octet[3] = octet[0] + "." + octet[1] + "." + octet[2] + "." + octet[3];
- octet[2] = octet[0] + "." + octet[1] + "." + octet[2];
- octet[1] = octet[0] + "." + octet[1];
+ // We only returns a domain part if more than one label is
+ // present. See above for a full explanation.
+ if (!seendots)
+ return "";
+ return std::string(dotpos.base() - 1, host.end());
+ }
- /* Reset the Hash module and send it our IV */
- HashResetRequest(Sender, HashProvider).Send();
- HashKeyRequest(Sender, HashProvider, iv).Send();
+ /**
+ * 2.0-style cloaking function
+ * @param item The item to cloak (part of an IP or hostname)
+ * @param id A unique ID for this type of item (to make it unique if the item matches)
+ * @param len The length of the output. Maximum for MD5 is 16 characters.
+ */
+ std::string SegmentCloak(const CloakInfo& info, const std::string& item, char id, size_t len)
+ {
+ std::string input;
+ input.reserve(info.key.length() + 3 + item.length());
+ input.append(1, id);
+ input.append(info.key);
+ input.append(1, '\0'); // null does not terminate a C++ string
+ if (info.ignorecase)
+ std::transform(item.begin(), item.end(), std::back_inserter(input), ::tolower);
+ else
+ input.append(item);
- /* Send the Hash module a different hex table for each octet group's Hash sum */
- for (int k = 0; k < 4; k++)
+ std::string rv = Hash->GenerateRaw(input).substr(0,len);
+ for(size_t i = 0; i < len; i++)
{
- HashHexRequest(Sender, HashProvider, xtab[(iv[k]+i[k]) % 4]).Send();
- ra[k] = std::string(HashSumRequest(Sender, HashProvider, octet[k]).Send()).substr(0,6);
+ // this discards 3 bits per byte. We have an
+ // overabundance of bits in the hash output, doesn't
+ // matter which ones we are discarding.
+ rv[i] = base32[rv[i] & 0x1F];
}
- /* Stick them all together */
- return std::string().append(ra[0]).append(".").append(ra[1]).append(".").append(ra[2]).append(".").append(ra[3]);
+ return rv;
}
- std::string Cloak6(const char* ip)
+ std::string SegmentIP(const CloakInfo& info, const irc::sockets::sockaddrs& ip, bool full)
{
- /* Theyre using 4in6 (YUCK). Translate as ipv4 cloak */
- if (!strncmp(ip, "0::ffff:", 8))
- return Cloak4(ip + 8);
-
- /* If we get here, yes it really is an ipv6 ip */
- unsigned int iv[] = { key1, key2, key3, key4 };
- std::vector<std::string> hashies;
- std::string item;
- int rounds = 0;
+ std::string bindata;
+ size_t hop1, hop2, hop3;
+ size_t len1, len2;
+ std::string rv;
+ if (ip.family() == AF_INET6)
+ {
+ bindata = std::string((const char*)ip.in6.sin6_addr.s6_addr, 16);
+ hop1 = 8;
+ hop2 = 6;
+ hop3 = 4;
+ len1 = 6;
+ len2 = 4;
+ // pfx s1.s2.s3. (xxxx.xxxx or s4) sfx
+ // 6 4 4 9/6
+ rv.reserve(info.prefix.length() + 26 + info.suffix.length());
+ }
+ else
+ {
+ bindata = std::string((const char*)&ip.in4.sin_addr, 4);
+ hop1 = 3;
+ hop2 = 0;
+ hop3 = 2;
+ len1 = len2 = 3;
+ // pfx s1.s2. (xxx.xxx or s3) sfx
+ rv.reserve(info.prefix.length() + 15 + info.suffix.length());
+ }
- /* Reset the Hash module and send it our IV */
- HashResetRequest(Sender, HashProvider).Send();
- HashKeyRequest(Sender, HashProvider, iv).Send();
+ rv.append(info.prefix);
+ rv.append(SegmentCloak(info, bindata, 10, len1));
+ rv.append(1, '.');
+ bindata.erase(hop1);
+ rv.append(SegmentCloak(info, bindata, 11, len2));
+ if (hop2)
+ {
+ rv.append(1, '.');
+ bindata.erase(hop2);
+ rv.append(SegmentCloak(info, bindata, 12, len2));
+ }
- for (const char* input = ip; *input; input++)
+ if (full)
{
- item += *input;
- if (item.length() > 7)
+ rv.append(1, '.');
+ bindata.erase(hop3);
+ rv.append(SegmentCloak(info, bindata, 13, 6));
+ rv.append(info.suffix);
+ }
+ else
+ {
+ if (ip.family() == AF_INET6)
+ {
+ rv.append(InspIRCd::Format(".%02x%02x.%02x%02x%s",
+ ip.in6.sin6_addr.s6_addr[2], ip.in6.sin6_addr.s6_addr[3],
+ ip.in6.sin6_addr.s6_addr[0], ip.in6.sin6_addr.s6_addr[1], info.suffix.c_str()));
+ }
+ else
{
- /* Send the Hash module a different hex table for each octet group's Hash sum */
- HashHexRequest(Sender, HashProvider, xtab[(key1+rounds) % 4]).Send();
- hashies.push_back(std::string(HashSumRequest(Sender, HashProvider, item).Send()).substr(0,8));
- item.clear();
+ const unsigned char* ip4 = (const unsigned char*)&ip.in4.sin_addr;
+ rv.append(InspIRCd::Format(".%d.%d%s", ip4[1], ip4[0], info.suffix.c_str()));
}
- rounds++;
}
- if (!item.empty())
+ return rv;
+ }
+
+ ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask) CXX11_OVERRIDE
+ {
+ LocalUser* lu = IS_LOCAL(user);
+ if (!lu)
+ return MOD_RES_PASSTHRU;
+
+ // Force the creation of cloaks if not already set.
+ OnUserConnect(lu);
+
+ // If the user has no cloaks (i.e. UNIX socket) then we do nothing here.
+ CloakList* cloaklist = cu.ext.get(user);
+ if (!cloaklist || cloaklist->empty())
+ return MOD_RES_PASSTHRU;
+
+ // Check if they have a cloaked host but are not using it.
+ for (CloakList::const_iterator iter = cloaklist->begin(); iter != cloaklist->end(); ++iter)
{
- /* Send the Hash module a different hex table for each octet group's Hash sum */
- HashHexRequest(Sender, HashProvider, xtab[(key1+rounds) % 4]).Send();
- hashies.push_back(std::string(HashSumRequest(Sender, HashProvider, item).Send()).substr(0,8));
- item.clear();
+ const std::string& cloak = *iter;
+ if (cloak != user->GetDisplayedHost())
+ {
+ const std::string cloakMask = user->nick + "!" + user->ident + "@" + cloak;
+ if (InspIRCd::Match(cloakMask, mask))
+ return MOD_RES_DENY;
+ }
}
- /* Stick them all together */
- return irc::stringjoiner(":", hashies, 0, hashies.size() - 1).GetJoined();
+ return MOD_RES_PASSTHRU;
}
-
- void DoRehash()
+
+ void Prioritize() CXX11_OVERRIDE
+ {
+ /* Needs to be after m_banexception etc. */
+ ServerInstance->Modules->SetPriority(this, I_OnCheckBan, PRIORITY_LAST);
+ }
+
+ // this unsets umode +x on every host change. If we are actually doing a +x
+ // mode change, we will call SetMode back to true AFTER the host change is done.
+ void OnChangeHost(User* u, const std::string& host) CXX11_OVERRIDE
{
- ConfigReader Conf(ServerInstance);
- bool lowercase;
-
- /* These are *not* using the need_positive parameter of ReadInteger -
- * that will limit the valid values to only the positive values in a
- * signed int. Instead, accept any value that fits into an int and
- * cast it to an unsigned int. That will, a bit oddly, give us the full
- * spectrum of an unsigned integer. - Special */
- key1 = key2 = key3 = key4 = 0;
- key1 = (unsigned int) Conf.ReadInteger("cloak","key1",0,false);
- key2 = (unsigned int) Conf.ReadInteger("cloak","key2",0,false);
- key3 = (unsigned int) Conf.ReadInteger("cloak","key3",0,false);
- key4 = (unsigned int) Conf.ReadInteger("cloak","key4",0,false);
- prefix = Conf.ReadValue("cloak","prefix",0);
- ipalways = Conf.ReadFlag("cloak", "ipalways", 0);
- lowercase = Conf.ReadFlag("cloak", "lowercase", 0);
-
- if (!lowercase)
+ if (u->IsModeSet(cu) && !cu.active)
{
- xtab[0] = "F92E45D871BCA630";
- xtab[1] = "A1B9D80C72E653F4";
- xtab[2] = "1ABC078934DEF562";
- xtab[3] = "ABCDEF5678901234";
+ u->SetMode(cu, false);
+
+ LocalUser* luser = IS_LOCAL(u);
+ if (!luser)
+ return;
+
+ Modes::ChangeList modechangelist;
+ modechangelist.push_remove(&cu);
+ ClientProtocol::Events::Mode modeevent(ServerInstance->FakeClient, NULL, u, modechangelist);
+ luser->Send(modeevent);
}
- else
+ cu.active = false;
+ }
+
+ Version GetVersion() CXX11_OVERRIDE
+ {
+ std::string testcloak = "broken";
+ if (Hash && !cloaks.empty())
{
- xtab[0] = "f92e45d871bca630";
- xtab[1] = "a1b9d80c72e653f4";
- xtab[2] = "1abc078934def562";
- xtab[3] = "abcdef5678901234";
+ const CloakInfo& info = cloaks.front();
+ switch (info.mode)
+ {
+ case MODE_HALF_CLOAK:
+ // Use old cloaking verification to stay compatible with 2.0
+ // But verify domainparts and ignorecase when use 3.0-only features
+ if (info.domainparts == 3 && !info.ignorecase)
+ testcloak = info.prefix + SegmentCloak(info, "*", 3, 8) + info.suffix;
+ else
+ {
+ irc::sockets::sockaddrs sa;
+ testcloak = GenCloak(info, sa, "", testcloak + ConvToStr(info.domainparts)) + (info.ignorecase ? "-ci" : "");
+ }
+ break;
+ case MODE_OPAQUE:
+ testcloak = info.prefix + SegmentCloak(info, "*", 4, 8) + info.suffix + (info.ignorecase ? "-ci" : "");
+ }
}
+ return Version("Adds user mode x (cloak) which allows user hostnames to be hidden.", VF_COMMON|VF_VENDOR, testcloak);
+ }
- if (prefix.empty())
- prefix = ServerInstance->Config->Network;
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
+ {
+ ConfigTagList tags = ServerInstance->Config->ConfTags("cloak");
+ if (tags.first == tags.second)
+ throw ModuleException("You have loaded the cloaking module but not configured any <cloak> tags!");
- if (!key1 || !key2 || !key3 || !key4)
+ std::vector<CloakInfo> newcloaks;
+ for (ConfigIter i = tags.first; i != tags.second; ++i)
{
- std::string detail;
- if (!key1)
- detail = "<cloak:key1> is not valid, it may be set to a too high/low value, or it may not exist.";
- else if (!key2)
- detail = "<cloak:key2> is not valid, it may be set to a too high/low value, or it may not exist.";
- else if (!key3)
- detail = "<cloak:key3> is not valid, it may be set to a too high/low value, or it may not exist.";
- else if (!key4)
- detail = "<cloak:key4> is not valid, it may be set to a too high/low value, or it may not exist.";
-
- throw ModuleException("You have not defined cloak keys for m_cloaking!!! THIS IS INSECURE AND SHOULD BE CHECKED! - " + detail);
+ ConfigTag* tag = i->second;
+
+ // Ensure that we have the <cloak:key> parameter.
+ const std::string key = tag->getString("key");
+ if (key.empty())
+ throw ModuleException("You have not defined a cloaking key. Define <cloak:key> as a " + ConvToStr(minkeylen) + "+ character network-wide secret, at " + tag->getTagLocation());
+
+ // If we are the first cloak method then mandate a strong key.
+ if (i == tags.first && key.length() < minkeylen)
+ throw ModuleException("Your cloaking key is not secure. It should be at least " + ConvToStr(minkeylen) + " characters long, at " + tag->getTagLocation());
+
+ const bool ignorecase = tag->getBool("ignorecase");
+ const std::string mode = tag->getString("mode");
+ const std::string prefix = tag->getString("prefix");
+ const std::string suffix = tag->getString("suffix", ".IP");
+ if (stdalgo::string::equalsci(mode, "half"))
+ {
+ unsigned int domainparts = tag->getUInt("domainparts", 3, 1, 10);
+ newcloaks.push_back(CloakInfo(MODE_HALF_CLOAK, key, prefix, suffix, ignorecase, domainparts));
+ }
+ else if (stdalgo::string::equalsci(mode, "full"))
+ newcloaks.push_back(CloakInfo(MODE_OPAQUE, key, prefix, suffix, ignorecase));
+ else
+ throw ModuleException(mode + " is an invalid value for <cloak:mode>; acceptable values are 'half' and 'full', at " + tag->getTagLocation());
}
- }
-};
+ // The cloak configuration was valid so we can apply it.
+ cloaks.swap(newcloaks);
+ }
-class ModuleCloaking : public Module
-{
- private:
-
- CloakUser* cu;
- Module* HashModule;
-
- public:
- ModuleCloaking(InspIRCd* Me)
- : Module(Me)
+ std::string GenCloak(const CloakInfo& info, const irc::sockets::sockaddrs& ip, const std::string& ipstr, const std::string& host)
{
- ServerInstance->Modules->UseInterface("HashRequest");
+ std::string chost;
- /* Attempt to locate the md5 service provider, bail if we can't find it */
- HashModule = ServerInstance->Modules->Find("m_md5.so");
- if (!HashModule)
- throw ModuleException("Can't find m_md5.so. Please load m_md5.so before m_cloaking.so.");
+ irc::sockets::sockaddrs hostip;
+ bool host_is_ip = irc::sockets::aptosa(host, ip.port(), hostip) && hostip == ip;
- /* Create new mode handler object */
- cu = new CloakUser(ServerInstance, this, HashModule);
+ switch (info.mode)
+ {
+ case MODE_HALF_CLOAK:
+ {
+ if (!host_is_ip)
+ chost = info.prefix + SegmentCloak(info, host, 1, 6) + VisibleDomainParts(host, info.domainparts);
+ if (chost.empty() || chost.length() > 50)
+ chost = SegmentIP(info, ip, false);
+ break;
+ }
+ case MODE_OPAQUE:
+ default:
+ chost = SegmentIP(info, ip, true);
+ }
+ return chost;
+ }
- OnRehash(NULL,"");
+ void OnSetUserIP(LocalUser* user) CXX11_OVERRIDE
+ {
+ // Connecting users are handled in OnUserConnect not here.
+ if (user->registered != REG_ALL || user->quitting)
+ return;
- /* Register it with the core */
- if (!ServerInstance->AddMode(cu))
- throw ModuleException("Could not add new modes!");
+ // Remove the cloaks and generate new ones.
+ cu.ext.unset(user);
+ OnUserConnect(user);
- Implementation eventlist[] = { I_OnRehash };
- ServerInstance->Modules->Attach(eventlist, this, 1);
- }
-
- virtual ~ModuleCloaking()
- {
- ServerInstance->Modes->DelMode(cu);
- delete cu;
- ServerInstance->Modules->DoneWithInterface("HashRequest");
+ // If a user is using a cloak then update it.
+ if (user->IsModeSet(cu))
+ {
+ CloakList* cloaklist = cu.ext.get(user);
+ user->ChangeDisplayedHost(cloaklist->front());
+ }
}
-
- virtual Version GetVersion()
+
+ void OnUserConnect(LocalUser* dest) CXX11_OVERRIDE
{
- // returns the version number of the module to be
- // listed in /MODULES
- return Version(1,1,0,2,VF_COMMON|VF_VENDOR,API_VERSION);
+ if (cu.ext.get(dest))
+ return;
+
+ // TODO: decide how we are going to cloak AF_UNIX hostnames.
+ if (dest->client_sa.family() != AF_INET && dest->client_sa.family() != AF_INET6)
+ return;
+
+ CloakList cloaklist;
+ for (std::vector<CloakInfo>::const_iterator iter = cloaks.begin(); iter != cloaks.end(); ++iter)
+ cloaklist.push_back(GenCloak(*iter, dest->client_sa, dest->GetIPString(), dest->GetRealHost()));
+ cu.ext.set(dest, cloaklist);
}
+};
- virtual void OnRehash(User* user, const std::string ¶meter)
+CmdResult CommandCloak::Handle(User* user, const Params& parameters)
+{
+ ModuleCloaking* mod = (ModuleCloaking*)(Module*)creator;
+
+ // If we're cloaking an IP address we pass it in the IP field too.
+ irc::sockets::sockaddrs sa;
+ const char* ipaddr = irc::sockets::aptosa(parameters[0], 0, sa) ? parameters[0].c_str() : "";
+
+ unsigned int id = 0;
+ for (std::vector<CloakInfo>::const_iterator iter = mod->cloaks.begin(); iter != mod->cloaks.end(); ++iter)
{
- cu->DoRehash();
+ const std::string cloak = mod->GenCloak(*iter, sa, ipaddr, parameters[0]);
+ user->WriteNotice(InspIRCd::Format("*** Cloak #%u for %s is %s", ++id, parameters[0].c_str(), cloak.c_str()));
}
-
-};
+ return CMD_SUCCESS;
+}
MODULE_INIT(ModuleCloaking)
projects / user / henk / code / inspircd.git / blobdiff