-/* +------------------------------------+
- * | 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) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
+ * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
+ * Copyright (C) 2007 John Brooks <john.brooks@dereferenced.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
*
- * 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_config.h"
-#include "configreader.h"
-#include "inspircd.h"
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "m_hash.h"
+#include "inspircd.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,
+ /** 2.0 cloak of IP hash, split at 2 common CIDR range points */
+ MODE_OPAQUE
+};
-/* Used to vary the output a little more depending on the cloak keys */
-static const char* xtab[] = {"F92E45D871BCA630", "A1B9D80C72E653F4", "1ABC078934DEF562", "ABCDEF5678901234"};
+// lowercase-only encoding similar to base64, used for hash output
+static const char base32[] = "0123456789abcdefghijklmnopqrstuv";
/** Handles user mode +x
*/
class CloakUser : public ModeHandler
{
-
- std::string prefix;
- unsigned int key1;
- unsigned int key2;
- unsigned int key3;
- unsigned int key4;
- Module* Sender;
- Module* HashProvider;
-
public:
- CloakUser(InspIRCd* Instance, Module* Source, Module* Hash) : ModeHandler(Instance, 'x', 0, 0, false, MODETYPE_USER, false), Sender(Source), HashProvider(Hash)
+ LocalStringExt ext;
+ std::string debounce_uid;
+ time_t debounce_ts;
+ int debounce_count;
+
+ CloakUser(Module* source)
+ : ModeHandler(source, "cloak", 'x', PARAM_NONE, MODETYPE_USER),
+ ext("cloaked_host", source), debounce_ts(0), debounce_count(0)
{
}
- ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding)
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
{
- /* Only opers can change other users modes */
- if ((source != dest) && (!*source->oper))
- 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)
+ {
+ 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 */
+ if (source == dest)
+ user->CommandFloodPenalty += 5000;
if (adding)
{
- if(!dest->IsModeSet('x'))
+ std::string* cloak = ext.get(user);
+
+ if (!cloak)
{
- /* 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)
- {
- /* 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.
- */
-
- unsigned int iv[] = { key1, key2, key3, key4 };
- std::string a = (n1 ? n1 : n2);
- std::string b;
- insp_inaddr testaddr;
-
- /** 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.
- */
-
- if ((insp_aton(dest->host,&testaddr) < 1) && (hostcloak.length() <= 64))
- {
- // if they have a hostname, make something appropriate
- b = hostcloak;
- }
- else
- {
- b = ((b.find(':') == std::string::npos) ? Cloak4(dest->host) : Cloak6(dest->host));
- }
- dest->ChangeDisplayedHost(b.c_str());
- }
-
- dest->SetMode('x',true);
- return MODEACTION_ALLOW;
+ /* Force creation of missing cloak */
+ creator->OnUserConnect(user);
+ cloak = ext.get(user);
}
- }
- else
- {
- if (dest->IsModeSet('x'))
+ if (cloak)
{
- /* 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(*cloak);
+ 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->host.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(const std::vector<std::string> ¶meters, User *user);
+};
+
+class ModuleCloaking : public Module
+{
+ public:
+ CloakUser cu;
+ CloakMode mode;
+ CommandCloak ck;
+ std::string prefix;
+ std::string suffix;
+ std::string key;
+ const char* xtab[4];
+ dynamic_reference<HashProvider> Hash;
+
+ ModuleCloaking() : cu(this), mode(MODE_OPAQUE), 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++)
+ /** 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)
+ {
+ int dots = 0;
+ std::string::size_type splitdot = host.length();
+
+ for (std::string::size_type x = host.length() - 1; x; --x)
{
- octet[j] = seps.GetToken();
- i[j] = atoi(octet[j].c_str());
+ if (host[x] == '.')
+ {
+ splitdot = x;
+ dots++;
+ }
+ if (dots >= 3)
+ 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];
-
- /* Reset the Hash module and send it our IV */
- HashResetRequest(Sender, HashProvider).Send();
- HashKeyRequest(Sender, HashProvider, iv).Send();
+ if (splitdot == host.length())
+ return "";
+ else
+ return host.substr(splitdot);
+ }
- /* Send the Hash module a different hex table for each octet group's Hash sum */
- for (int k = 0; k < 4; k++)
+ /**
+ * 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 std::string& item, char id, int len)
+ {
+ std::string input;
+ input.reserve(key.length() + 3 + item.length());
+ input.append(1, id);
+ input.append(key);
+ input.append(1, '\0'); // null does not terminate a C++ string
+ input.append(item);
+
+ std::string rv = Hash->sum(input).substr(0,len);
+ for(int 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 irc::sockets::sockaddrs& ip, bool full)
{
- unsigned int iv[] = { key1, key2, key3, key4 };
- std::vector<std::string> hashies;
- std::string item = "";
- int rounds = 0;
+ std::string bindata;
+ int hop1, hop2, hop3;
+ int len1, len2;
+ std::string rv;
+ if (ip.sa.sa_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(prefix.length() + 26 + 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(prefix.length() + 15 + suffix.length());
+ }
- /* Reset the Hash module and send it our IV */
- HashResetRequest(Sender, HashProvider).Send();
- HashKeyRequest(Sender, HashProvider, iv).Send();
+ rv.append(prefix);
+ rv.append(SegmentCloak(bindata, 10, len1));
+ rv.append(1, '.');
+ bindata.erase(hop1);
+ rv.append(SegmentCloak(bindata, 11, len2));
+ if (hop2)
+ {
+ rv.append(1, '.');
+ bindata.erase(hop2);
+ rv.append(SegmentCloak(bindata, 12, len2));
+ }
- for (const char* input = ip; *input; input++)
+ if (full)
{
- item += *input;
- if (item.length() > 5)
+ rv.append(1, '.');
+ bindata.erase(hop3);
+ rv.append(SegmentCloak(bindata, 13, 6));
+ rv.append(suffix);
+ }
+ else
+ {
+ char buf[50];
+ if (ip.sa.sa_family == AF_INET6)
{
- /* 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,10));
- item = "";
+ snprintf(buf, 50, ".%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], suffix.c_str());
}
- rounds++;
+ else
+ {
+ const unsigned char* ip4 = (const unsigned char*)&ip.in4.sin_addr;
+ snprintf(buf, 50, ".%d.%d%s", ip4[1], ip4[0], suffix.c_str());
+ }
+ rv.append(buf);
}
- 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;
+
+ OnUserConnect(lu);
+ std::string* cloak = cu.ext.get(user);
+ /* Check if they have a cloaked host, but are not using it */
+ if (cloak && *cloak != user->dhost)
{
- /* 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,10));
- item = "";
+ 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()
{
- ConfigReader Conf(ServerInstance);
- key1 = key2 = key3 = key4 = 0;
- key1 = Conf.ReadInteger("cloak","key1",0,true);
- key2 = Conf.ReadInteger("cloak","key2",0,true);
- key3 = Conf.ReadInteger("cloak","key3",0,true);
- key4 = Conf.ReadInteger("cloak","key4",0,true);
- prefix = Conf.ReadValue("cloak","prefix",0);
-
- if (prefix.empty())
- prefix = ServerInstance->Config->Network;
-
- if (!key1 && !key2 && !key3 && !key4)
- throw ModuleException("You have not defined cloak keys for m_cloaking!!! THIS IS INSECURE AND SHOULD BE CHECKED!");
+ /* Needs to be after m_banexception etc. */
+ ServerInstance->Modules->SetPriority(this, I_OnCheckBan, PRIORITY_LAST);
}
-};
-
-class ModuleCloaking : public Module
-{
- private:
-
- CloakUser* cu;
- Module* HashModule;
-
- public:
- ModuleCloaking(InspIRCd* Me)
- : Module::Module(Me)
+ // 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
{
- ServerInstance->UseInterface("HashRequest");
-
- /* Attempt to locate the md5 service provider, bail if we can't find it */
- HashModule = ServerInstance->FindModule("m_md5.so");
- if (!HashModule)
- throw ModuleException("Can't find m_md5.so. Please load m_md5.so before m_cloaking.so.");
-
- /* Create new mode handler object */
- cu = new CloakUser(ServerInstance, this, HashModule);
-
- /* Register it with the core */
- ServerInstance->AddMode(cu, 'x');
-
- OnRehash("");
+ if (u->IsModeSet(cu))
+ {
+ u->SetMode(cu, false);
+ u->WriteCommand("MODE", "-" + ConvToStr(cu.GetModeChar()));
+ }
}
-
- virtual ~ModuleCloaking()
+
+ Version GetVersion() CXX11_OVERRIDE
{
- ServerInstance->Modes->DelMode(cu);
- DELETE(cu);
- ServerInstance->DoneWithInterface("HashRequest");
+ std::string testcloak = "broken";
+ if (Hash)
+ {
+ switch (mode)
+ {
+ case MODE_HALF_CLOAK:
+ testcloak = prefix + SegmentCloak("*", 3, 8) + suffix;
+ break;
+ case MODE_OPAQUE:
+ testcloak = prefix + SegmentCloak("*", 4, 8) + suffix;
+ }
+ }
+ return Version("Provides masking of user hostnames", VF_COMMON|VF_VENDOR, testcloak);
}
-
- virtual Version GetVersion()
+
+ void ReadConfig(ConfigStatus& status) 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);
+ ConfigTag* tag = ServerInstance->Config->ConfValue("cloak");
+ prefix = tag->getString("prefix");
+ suffix = tag->getString("suffix", ".IP");
+
+ std::string modestr = tag->getString("mode");
+ if (modestr == "half")
+ mode = MODE_HALF_CLOAK;
+ else if (modestr == "full")
+ mode = MODE_OPAQUE;
+ else
+ throw ModuleException("Bad value for <cloak:mode>; must be half or full");
+
+ key = tag->getString("key");
+ if (key.empty() || key == "secret")
+ throw ModuleException("You have not defined cloak keys for m_cloaking. Define <cloak:key> as a network-wide secret.");
}
- virtual void OnRehash(const std::string ¶meter)
+ std::string GenCloak(const irc::sockets::sockaddrs& ip, const std::string& ipstr, const std::string& host)
{
- cu->DoRehash();
+ std::string chost;
+
+ switch (mode)
+ {
+ case MODE_HALF_CLOAK:
+ {
+ if (ipstr != host)
+ chost = prefix + SegmentCloak(host, 1, 6) + LastTwoDomainParts(host);
+ if (chost.empty() || chost.length() > 50)
+ chost = SegmentIP(ip, false);
+ break;
+ }
+ case MODE_OPAQUE:
+ default:
+ chost = SegmentIP(ip, true);
+ }
+ return chost;
}
- void Implements(char* List)
+ void OnUserConnect(LocalUser* dest) CXX11_OVERRIDE
{
- List[I_OnRehash] = 1;
+ std::string* cloak = cu.ext.get(dest);
+ if (cloak)
+ return;
+
+ cu.ext.set(dest, GenCloak(dest->client_sa, dest->GetIPString(), dest->host));
}
};
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
-
-class ModuleCloakingFactory : public ModuleFactory
+CmdResult CommandCloak::Handle(const std::vector<std::string> ¶meters, User *user)
{
- public:
- ModuleCloakingFactory()
- {
- }
-
- ~ModuleCloakingFactory()
- {
- }
-
- virtual Module * CreateModule(InspIRCd* Me)
- {
- return new ModuleCloaking(Me);
- }
-
-};
+ ModuleCloaking* mod = (ModuleCloaking*)(Module*)creator;
+ irc::sockets::sockaddrs sa;
+ std::string cloak;
+ if (irc::sockets::aptosa(parameters[0], 0, sa))
+ cloak = mod->GenCloak(sa, parameters[0], parameters[0]);
+ else
+ cloak = mod->GenCloak(sa, "", parameters[0]);
-extern "C" void * init_module( void )
-{
- return new ModuleCloakingFactory;
+ user->WriteNotice("*** Cloak for " + parameters[0] + " is " + cloak);
+
+ return CMD_SUCCESS;
}
+
+MODULE_INIT(ModuleCloaking)