* | Inspire Internet Relay Chat Daemon |
* +------------------------------------+
*
- * InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
- * E-mail:
- * <brain@chatspike.net>
- * <Craig@chatspike.net>
- *
- * Written by Craig Edwards, Craig McLure, and others.
+ * InspIRCd: (C) 2002-2009 InspIRCd Development Team
+ * See: http://wiki.inspircd.org/Credits
+ *
* This program is free but copyrighted software; see
- * the file COPYING for details.
+ * the file COPYING for details.
*
* ---------------------------------------------------
*/
-#include "inspircd_config.h"
-#include "configreader.h"
#include "inspircd.h"
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-
-#include "m_md5.h"
+#include "m_hash.h"
/* $ModDesc: Provides masking of user hostnames */
-
-static const char* xtab[] = {"F92E45D871BCA630", "A1B9D80C72E653F4", "1ABC078934DEF562", "ABCDEF5678901234"};
+/* $ModDep: m_hash.h */
/** Handles user mode +x
*/
class CloakUser : public ModeHandler
{
-
+ public:
std::string prefix;
unsigned int key1;
unsigned int key2;
unsigned int key3;
unsigned int key4;
- Module* Sender;
- Module* MD5Provider;
-
- public:
- CloakUser(InspIRCd* Instance, Module* Source, Module* MD5) : ModeHandler(Instance, 'x', 0, 0, false, MODETYPE_USER, false), Sender(Source), MD5Provider(MD5)
+ bool ipalways;
+ Module* HashProvider;
+ const char *xtab[4];
+ LocalStringExt ext;
+
+ /** 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)
+ {
+ if (host[x] == '.')
+ {
+ splitdot = x;
+ dots++;
+ }
+ if (dots >= 3)
+ break;
+ }
+
+ if (splitdot == host.length())
+ return host;
+ else
+ return host.substr(splitdot);
}
- ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding)
+ CloakUser(Module* source, Module* Hash)
+ : ModeHandler(source, 'x', PARAM_NONE, MODETYPE_USER), HashProvider(Hash),
+ ext("cloaked_host", source)
{
- /* Only opers can change other users modes */
- if ((source != dest) && (!*source->oper))
- return MODEACTION_DENY;
+ }
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string ¶meter, bool adding)
+ {
/* For remote clients, we dont take any action, we just allow it.
* The local server where they are will set their cloak instead.
+ * This is fine, as we will recieve it later.
*/
if (!IS_LOCAL(dest))
+ {
+ dest->SetMode('x',adding);
return MODEACTION_ALLOW;
+ }
+
+ /* don't allow this user to spam modechanges */
+ dest->IncreasePenalty(5);
if (adding)
{
* naming in their hostname (e.g. if they are on a lan or
* are connecting via localhost) -- this doesnt matter much.
*/
-
- if (strchr(dest->host,'.') || strchr(dest->host,':'))
+
+ std::string* cloak = ext.get(dest);
+
+ if (!cloak)
{
- /* 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.
- */
-
- char* n = strstr(dest->host,".");
- if (!n)
- n = strstr(dest->host,":");
-
- std::string a = n;
-
- std::string b;
- insp_inaddr testaddr;
- std::string hostcloak = prefix + "-" + MD5SumRequest(Sender, MD5Provider, dest->host).Send() + 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));
- }
- ServerInstance->Log(DEBUG,"cloak: allocated "+b);
- dest->ChangeDisplayedHost(b.c_str());
+ /* Force creation of missing cloak */
+ creator->OnUserConnect(dest);
+ cloak = ext.get(dest);
+ }
+ if (cloak)
+ {
+ dest->ChangeDisplayedHost(cloak->c_str());
+ dest->SetMode('x',true);
+ return MODEACTION_ALLOW;
}
-
- dest->SetMode('x',true);
- return MODEACTION_ALLOW;
}
}
else
- {
+ {
if (dest->IsModeSet('x'))
{
- /* User is removing the mode, so just restore their real host
- * and make it match the displayed one.
+ /* User is removing the mode, so just restore their real host
+ * and make it match the displayed one.
*/
- dest->ChangeDisplayedHost(dest->host);
+ dest->ChangeDisplayedHost(dest->host.c_str());
dest->SetMode('x',false);
return MODEACTION_ALLOW;
}
{
unsigned int iv[] = { key1, key2, key3, key4 };
irc::sepstream seps(ip, '.');
- std::string ra1, ra2, ra3, ra4;
- int i1, i2, i3, i4;
- std::string octet1 = seps.GetToken();
- std::string octet2 = seps.GetToken();
- std::string octet3 = seps.GetToken();
- std::string octet4 = seps.GetToken();
- i1 = atoi(octet1.c_str());
- i2 = atoi(octet2.c_str());
- i3 = atoi(octet3.c_str());
- i4 = atoi(octet4.c_str());
- octet4 = octet1 + "." + octet2 + "." + octet3 + "." + octet4;
- octet3 = octet1 + "." + octet2 + "." + octet3;
- octet2 = octet1 + "." + octet2;
-
- MD5ResetRequest(Sender, MD5Provider).Send();
- MD5KeyRequest(Sender, MD5Provider, iv).Send();
-
- MD5HexRequest(Sender, MD5Provider, xtab[(key1+i1) % 4]).Send();
- ra1 = std::string(MD5SumRequest(Sender, MD5Provider, octet1).Send()).substr(0,6);
-
- MD5HexRequest(Sender, MD5Provider, xtab[(key2+i2) % 4]).Send();
- ra2 = std::string(MD5SumRequest(Sender, MD5Provider, octet2).Send()).substr(0,6);
-
- MD5HexRequest(Sender, MD5Provider, xtab[(key3+i3) % 4]).Send();
- ra3 = std::string(MD5SumRequest(Sender, MD5Provider, octet3).Send()).substr(0,6);
-
- MD5HexRequest(Sender, MD5Provider, xtab[(key4+i4) % 4]).Send();
- ra4 = std::string(MD5SumRequest(Sender, MD5Provider, octet4).Send()).substr(0,6);
-
- /* This is safe as we know the length generated by our genhash is always 16 */
- return std::string().append(ra1).append(".").append(ra2).append(".").append(ra3).append(".").append(ra4);
+ std::string ra[4];;
+ std::string octet[4];
+ int i[4];
+
+ for (int j = 0; j < 4; j++)
+ {
+ seps.GetToken(octet[j]);
+ i[j] = atoi(octet[j].c_str());
+ }
+
+ 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(creator, HashProvider).Send();
+ HashKeyRequest(creator, HashProvider, iv).Send();
+
+ /* Send the Hash module a different hex table for each octet group's Hash sum */
+ for (int k = 0; k < 4; k++)
+ {
+ HashHexRequest(creator, HashProvider, xtab[(iv[k]+i[k]) % 4]).Send();
+ ra[k] = std::string(HashSumRequest(creator, HashProvider, octet[k]).Send()).substr(0,6);
+ }
+ /* Stick them all together */
+ return std::string().append(ra[0]).append(".").append(ra[1]).append(".").append(ra[2]).append(".").append(ra[3]);
}
std::string Cloak6(const char* ip)
{
unsigned int iv[] = { key1, key2, key3, key4 };
std::vector<std::string> hashies;
- std::string item = "";
+ std::string item;
int rounds = 0;
- MD5ResetRequest(Sender, MD5Provider).Send();
- MD5KeyRequest(Sender, MD5Provider, iv).Send();
+ /* Reset the Hash module and send it our IV */
+ HashResetRequest(creator, HashProvider).Send();
+ HashKeyRequest(creator, HashProvider, iv).Send();
for (const char* input = ip; *input; input++)
{
item += *input;
- if (item.length() > 5)
+ if (item.length() > 7)
{
- MD5HexRequest(Sender, MD5Provider, xtab[(key1+rounds) % 4]).Send();
- hashies.push_back(std::string(MD5SumRequest(Sender, MD5Provider, item).Send()).substr(0,10));
- item = "";
+ /* Send the Hash module a different hex table for each octet group's Hash sum */
+ HashHexRequest(creator, HashProvider, xtab[(key1+rounds) % 4]).Send();
+ hashies.push_back(std::string(HashSumRequest(creator, HashProvider, item).Send()).substr(0,8));
+ item.clear();
}
rounds++;
}
if (!item.empty())
{
- MD5HexRequest(Sender, MD5Provider, xtab[(key1+rounds) % 4]).Send();
- hashies.push_back(std::string(MD5SumRequest(Sender, MD5Provider, item).Send()).substr(0,10));
- item = "";
+ /* Send the Hash module a different hex table for each octet group's Hash sum */
+ HashHexRequest(creator, HashProvider, xtab[(key1+rounds) % 4]).Send();
+ hashies.push_back(std::string(HashSumRequest(creator, HashProvider, item).Send()).substr(0,8));
+ item.clear();
}
+ /* Stick them all together */
return irc::stringjoiner(":", hashies, 0, hashies.size() - 1).GetJoined();
}
- /* XXX: Uncomment and call to use the test suite
- void TestSuite()
- {
- printf("%s %s\n", "192.168.1.1", Cloak4("192.168.1.1").c_str());
- printf("%s %s\n", "192.168.1.2", Cloak4("192.168.1.2").c_str());
- printf("%s %s\n", "192.168.10.1", Cloak4("192.168.10.1").c_str());
- printf("%s %s\n", "192.168.10.1", Cloak4("192.168.10.2").c_str());
- printf("%s %s\n", "192.169.1.1", Cloak4("192.169.1.1").c_str());
- printf("%s %s\n", "192.169.2.1", Cloak4("192.169.2.1").c_str());
- printf("%s %s\n", "200.168.1.1", Cloak4("200.168.1.1").c_str());
- printf("%s %s\n", "200.168.1.3", Cloak4("200.168.1.3").c_str());
- printf("%s %s\n", "200.168.3.3", Cloak4("200.168.3.3").c_str());
- printf("%s %s\n", "200.169.4.3", Cloak4("200.169.4.3").c_str());
- printf("---\n");
- printf("%s %s\n", "9a05:2f00:3f11::5f12::1", Cloak6("9a05:2f00:3f11::5f12::1").c_str());
- printf("%s %s\n", "9a05:2f00:3f11::5f12::2", Cloak6("9a05:2f00:3f11::5f12::2").c_str());
- printf("%s %s\n", "9a05:2f00:3f11::5a12::1", Cloak6("9a05:2f00:3f11::5a12::1").c_str());
- printf("%s %s\n", "9a05:2f00:3f11::5a12::2", Cloak6("9a05:2f00:3f11::5a12::2").c_str());
- printf("%s %s\n", "9a05:3f01:3f11::5f12::1", Cloak6("9a05:3f01:3f11::5f12::1").c_str());
- printf("%s %s\n", "9a05:4f00:3f11::5f13::2", Cloak6("9a05:4f00:3f11::5f13::2").c_str());
- printf("%s %s\n", "ffff:2f00:3f11::5f12::1", Cloak6("ffff:2f00:3f11::5f12::1").c_str());
- printf("%s %s\n", "ffff:2f00:3f11::5f13::2", Cloak6("ffff:2f00:3f11::5f13::2").c_str());
- exit(0);
- }
- */
-
void DoRehash()
{
- ConfigReader Conf(ServerInstance);
+ ConfigReader Conf;
+ 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 = Conf.ReadInteger("cloak","key1",0,false);
- key2 = Conf.ReadInteger("cloak","key2",0,false);
- key3 = Conf.ReadInteger("cloak","key3",0,false);
- key4 = Conf.ReadInteger("cloak","key4",0,false);
-
+ 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);
- if (prefix == "")
+ ipalways = Conf.ReadFlag("cloak", "ipalways", 0);
+ lowercase = Conf.ReadFlag("cloak", "lowercase", 0);
+
+ if (!lowercase)
{
- prefix = ServerInstance->Config->Network;
+ xtab[0] = "F92E45D871BCA630";
+ xtab[1] = "A1B9D80C72E653F4";
+ xtab[2] = "1ABC078934DEF562";
+ xtab[3] = "ABCDEF5678901234";
+ }
+ else
+ {
+ xtab[0] = "f92e45d871bca630";
+ xtab[1] = "a1b9d80c72e653f4";
+ xtab[2] = "1abc078934def562";
+ xtab[3] = "abcdef5678901234";
}
- if (!key1 && !key2 && !key3 && !key4)
+
+ if (prefix.empty())
+ prefix = ServerInstance->Config->Network;
+
+ if (!key1 || !key2 || !key3 || !key4)
{
- ModuleException ex("You have not defined cloak keys for m_cloaking!!! THIS IS INSECURE AND SHOULD BE CHECKED!");
- throw (ex);
+ 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);
}
}
};
class ModuleCloaking : public Module
{
private:
-
CloakUser* cu;
- Module* MD5Module;
public:
- ModuleCloaking(InspIRCd* Me)
- : Module::Module(Me)
+ ModuleCloaking()
{
- MD5Module = ServerInstance->FindModule("m_md5.so");
- if (!MD5Module)
+ /* Attempt to locate the md5 service provider, bail if we can't find it */
+ Module* 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.");
- /* Create new mode handler object */
- cu = new CloakUser(ServerInstance, this, MD5Module);
+ cu = new CloakUser(this, HashModule);
- /* Register it with the core */
- ServerInstance->AddMode(cu, 'x');
+ try
+ {
+ OnRehash(NULL);
+ }
+ catch (ModuleException &e)
+ {
+ delete cu;
+ throw e;
+ }
+
+ /* Register it with the core */
+ if (!ServerInstance->Modes->AddMode(cu))
+ {
+ delete cu;
+ throw ModuleException("Could not add new modes!");
+ }
+
+ ServerInstance->Modules->UseInterface("HashRequest");
+ Extensible::Register(&cu->ext);
- OnRehash("");
+ Implementation eventlist[] = { I_OnRehash, I_OnCheckBan, I_OnUserConnect };
+ ServerInstance->Modules->Attach(eventlist, this, 3);
+
+ CloakExistingUsers();
}
-
- virtual ~ModuleCloaking()
+
+ void CloakExistingUsers()
{
- ServerInstance->Modes->DelMode(cu);
- DELETE(cu);
+ std::string* cloak;
+ for (std::vector<User*>::iterator u = ServerInstance->Users->local_users.begin(); u != ServerInstance->Users->local_users.end(); u++)
+ {
+ cloak = cu->ext.get(*u);
+ if (!cloak)
+ {
+ OnUserConnect(*u);
+ }
+ }
}
-
- virtual Version GetVersion()
+
+ ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask)
{
- // returns the version number of the module to be
- // listed in /MODULES
- return Version(1,1,0,2,VF_COMMON|VF_VENDOR,API_VERSION);
+ char cmask[MAXBUF];
+ std::string* cloak = cu->ext.get(user);
+ /* Check if they have a cloaked host, but are not using it */
+ if (cloak && *cloak != user->dhost)
+ {
+ snprintf(cmask, MAXBUF, "%s!%s@%s", user->nick.c_str(), user->ident.c_str(), cloak->c_str());
+ if (InspIRCd::Match(cmask,mask))
+ return MOD_RES_DENY;
+ }
+ return MOD_RES_PASSTHRU;
}
- virtual void OnRehash(const std::string ¶meter)
+ void Prioritize()
{
- cu->DoRehash();
+ /* Needs to be after m_banexception etc. */
+ ServerInstance->Modules->SetPriority(this, I_OnCheckBan, PRIORITY_LAST);
+
+ /* but before m_conn_umodes, so host is generated ready to apply */
+ Module *um = ServerInstance->Modules->Find("m_conn_umodes.so");
+ ServerInstance->Modules->SetPriority(this, I_OnUserConnect, PRIORITY_AFTER, &um);
}
- void Implements(char* List)
+ ~ModuleCloaking()
{
- List[I_OnRehash] = 1;
+ ServerInstance->Modes->DelMode(cu);
+ delete cu;
+ ServerInstance->Modules->DoneWithInterface("HashRequest");
}
-};
-
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
-class ModuleCloakingFactory : public ModuleFactory
-{
- public:
- ModuleCloakingFactory()
+ Version GetVersion()
{
+ // returns the version number of the module to be
+ // listed in /MODULES
+ return Version("Provides masking of user hostnames", VF_COMMON|VF_VENDOR,API_VERSION);
}
-
- ~ModuleCloakingFactory()
+
+ void OnRehash(User* user)
{
+ cu->DoRehash();
}
-
- virtual Module * CreateModule(InspIRCd* Me)
+
+ void OnUserConnect(User* dest)
{
- return new ModuleCloaking(Me);
+ std::string* cloak = cu->ext.get(dest);
+ if (cloak)
+ return;
+
+ if (dest->host.find('.') != std::string::npos || dest->host.find(':') != std::string::npos)
+ {
+ unsigned int iv[] = { cu->key1, cu->key2, cu->key3, cu->key4 };
+ std::string a = cu->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.
+ */
+
+ /* 2008/08/18: add <cloak:ipalways> which always cloaks
+ * the IP, for anonymity. --nenolod
+ */
+ if (!cu->ipalways)
+ {
+ /** Reset the Hash module, and send it our IV and hex table */
+ HashResetRequest(this, cu->HashProvider).Send();
+ HashKeyRequest(this, cu->HashProvider, iv).Send();
+ HashHexRequest(this, cu->HashProvider, cu->xtab[(dest->host[0]) % 4]);
+
+ /* Generate a cloak using specialized Hash */
+ std::string hostcloak = cu->prefix + "-" + std::string(HashSumRequest(this, cu->HashProvider, dest->host.c_str()).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.
+ */
+ std::string testaddr;
+ int testport;
+ if (!irc::sockets::satoap(&dest->client_sa, testaddr, testport) && (hostcloak.length() <= 64))
+ /* not a valid address, must have been a host, so cloak as a host */
+ b = hostcloak;
+ else if (dest->client_sa.sa.sa_family == AF_INET6)
+ b = cu->Cloak6(dest->GetIPString());
+ else
+ b = cu->Cloak4(dest->GetIPString());
+ }
+ else
+ {
+ if (dest->client_sa.sa.sa_family == AF_INET6)
+ b = cu->Cloak6(dest->GetIPString());
+ else
+ b = cu->Cloak4(dest->GetIPString());
+ }
+
+ cu->ext.set(dest,b);
+ }
}
-
-};
+};
-extern "C" void * init_module( void )
-{
- return new ModuleCloakingFactory;
-}
+MODULE_INIT(ModuleCloaking)