]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_cloaking.cpp
MetaData rework
[user/henk/code/inspircd.git] / src / modules / m_cloaking.cpp
index 033ac8c53eb6aa58bbe07b9ca136b79c8335ff2a..458d833dfab28258c9f992d802765860a6166089 100644 (file)
@@ -2,59 +2,85 @@
  *       | Inspire Internet Relay Chat Daemon |
  *       +------------------------------------+
  *
- *  InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ *  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_hash.h"
 
 /* $ModDesc: Provides masking of user hostnames */
 /* $ModDep: m_hash.h */
 
-/* Used to vary the output a little more depending on the cloak keys */
-static const char* xtab[] = {"F92E45D871BCA630", "A1B9D80C72E653F4", "1ABC078934DEF562", "ABCDEF5678901234"};
-
 /** Handles user mode +x
  */
 class CloakUser : public ModeHandler
 {
-       
+ public:
        std::string prefix;
        unsigned int key1;
        unsigned int key2;
        unsigned int key3;
        unsigned int key4;
+       bool ipalways;
        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)
+       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)
        {
+               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 &parameter, bool adding)
+       CloakUser(InspIRCd* Instance, Module* source, Module* Hash) : ModeHandler(Instance, 'x', 0, 0, false, MODETYPE_USER, false), Sender(source), HashProvider(Hash)
        {
-               /* 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 &parameter, bool adding, bool)
+       {
                /* 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)
                {
@@ -69,71 +95,29 @@ class CloakUser : public ModeHandler
                                 * are connecting via localhost) -- this doesnt matter much.
                                 */
 
-                               char* n1 = strchr(dest->host,'.');
-                               char* n2 = strchr(dest->host,':');
-                       
-                               if (n1 || n2)
+                               std::string* cloak;
+
+                               if (!dest->GetExt("cloaked_host", 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.
-                                        */
-
-                                       unsigned int iv[] = { key1, key2, key3, key4 };
-                                       std::string a = (n1 ? n1 : n2);
-                                       std::string b;
-
-                                       /** 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
-
-                                       dest->ChangeDisplayedHost(b.c_str());
+                                       /* Force creation of missing cloak */
+                                       Sender->OnUserConnect(dest);
+                               }
+                               if (dest->GetExt("cloaked_host", 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;
                        }
@@ -152,7 +136,7 @@ class CloakUser : public ModeHandler
 
                for (int j = 0; j < 4; j++)
                {
-                       octet[j] = seps.GetToken();
+                       seps.GetToken(octet[j]);
                        i[j] = atoi(octet[j].c_str());
                }
 
@@ -178,7 +162,7 @@ class CloakUser : public ModeHandler
        {
                unsigned int iv[] = { key1, key2, key3, key4 };
                std::vector<std::string> hashies;
-               std::string item = "";
+               std::string item;
                int rounds = 0;
 
                /* Reset the Hash module and send it our IV */
@@ -188,12 +172,12 @@ class CloakUser : public ModeHandler
                for (const char* input = ip; *input; input++)
                {
                        item += *input;
-                       if (item.length() > 5)
+                       if (item.length() > 7)
                        {
                                /* 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 = "";
+                               hashies.push_back(std::string(HashSumRequest(Sender, HashProvider, item).Send()).substr(0,8));
+                               item.clear();
                        }
                        rounds++;
                }
@@ -201,28 +185,64 @@ class CloakUser : public ModeHandler
                {
                        /* 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 = "";
+                       hashies.push_back(std::string(HashSumRequest(Sender, HashProvider, item).Send()).substr(0,8));
+                       item.clear();
                }
                /* Stick them all together */
                return irc::stringjoiner(":", hashies, 0, hashies.size() - 1).GetJoined();
        }
-       
+
        void DoRehash()
        {
                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 = 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);
+               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)
+               {
+                       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 (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!");
+               if (!key1 || !key2 || !key3 || !key4)
+               {
+                       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);
+               }
        }
 };
 
@@ -230,78 +250,183 @@ class CloakUser : public ModeHandler
 class ModuleCloaking : public Module
 {
  private:
-       
        CloakUser* cu;
-       Module* HashModule;
 
  public:
        ModuleCloaking(InspIRCd* Me)
-               : Module::Module(Me)
+               : Module(Me)
        {
-               ServerInstance->UseInterface("HashRequest");
-
                /* Attempt to locate the md5 service provider, bail if we can't find it */
-               HashModule = ServerInstance->FindModule("m_md5.so");
+               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, HashModule);
 
-               /* Register it with the core */         
-               if (!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");
+
+               Implementation eventlist[] = { I_OnRehash, I_OnUserDisconnect, I_OnCleanup, I_OnCheckBan, I_OnUserConnect, I_OnSyncUser, I_OnCleanup };
+               ServerInstance->Modules->Attach(eventlist, this, 6);
 
-               OnRehash(NULL,"");
+               CloakExistingUsers();
        }
-       
-       virtual ~ModuleCloaking()
+
+       void OnSyncUser(User* user, Module* proto,void* opaque)
        {
-               ServerInstance->Modes->DelMode(cu);
-               DELETE(cu);
-               ServerInstance->DoneWithInterface("HashRequest");
+               std::string* cloak;
+               if (user->GetExt("cloaked_host", cloak) && proto->ProtoTranslate(NULL) == "?")
+                       proto->ProtoSendMetaData(opaque, user, "cloaked_host", *cloak);
        }
-       
-       virtual Version GetVersion()
+
+       void CloakExistingUsers()
        {
-               // returns the version number of the module to be
-               // listed in /MODULES
-               return Version(1,1,0,2,VF_COMMON|VF_VENDOR,API_VERSION);
+               std::string* cloak;
+               for (std::vector<User*>::iterator u = ServerInstance->Users->local_users.begin(); u != ServerInstance->Users->local_users.end(); u++)
+               {
+                       if (!(*u)->GetExt("cloaked_host", cloak))
+                       {
+                               OnUserConnect(*u);
+                       }
+               }
        }
 
-       virtual void OnRehash(userrec* user, const std::string &parameter)
+       virtual int OnCheckBan(User* user, Channel* chan)
        {
-               cu->DoRehash();
+               char mask[MAXBUF];
+               std::string* tofree;
+               /* Check if they have a cloaked host, but are not using it */
+               if (user->GetExt("cloaked_host", tofree) && *tofree != user->dhost)
+               {
+                       snprintf(mask, MAXBUF, "%s!%s@%s", user->nick.c_str(), user->ident.c_str(), tofree->c_str());
+                       for (BanList::iterator i = chan->bans.begin(); i != chan->bans.end(); i++)
+                       {
+                               if (InspIRCd::Match(mask,i->data))
+                                       return -1;
+                       }
+               }
+               return 0;
        }
 
-       void Implements(char* List)
+       void Prioritize()
        {
-               List[I_OnRehash] = 1;
+               /* 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);
        }
-};
 
-// stuff down here is the module-factory stuff. For basic modules you can ignore this.
+       virtual void OnUserDisconnect(User* user)
+       {
+               std::string* tofree;
+               if (user->GetExt("cloaked_host", tofree))
+               {
+                       delete tofree;
+                       user->Shrink("cloaked_host");
+               }
+       }
 
-class ModuleCloakingFactory : public ModuleFactory
-{
- public:
-       ModuleCloakingFactory()
+       virtual void OnCleanup(int target_type, void* item)
        {
+               if (target_type == TYPE_USER)
+                       OnUserDisconnect((User*)item);
        }
-       
-       ~ModuleCloakingFactory()
+
+       virtual ~ModuleCloaking()
        {
+               ServerInstance->Modes->DelMode(cu);
+               delete cu;
+               ServerInstance->Modules->DoneWithInterface("HashRequest");
        }
-       
-       virtual Module * CreateModule(InspIRCd* Me)
+
+       virtual Version GetVersion()
        {
-               return new ModuleCloaking(Me);
+               // returns the version number of the module to be
+               // listed in /MODULES
+               return Version("$Id$", VF_COMMON|VF_VENDOR,API_VERSION);
        }
-       
-};
 
+       virtual void OnRehash(User* user)
+       {
+               cu->DoRehash();
+       }
 
-extern "C" void * init_module( void )
-{
-       return new ModuleCloakingFactory;
-}
+       virtual void OnUserConnect(User* dest)
+       {
+               std::string* tofree;
+               if (dest->GetExt("cloaked_host", tofree))
+                       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());
+                       }
+
+                       dest->Extend("cloaked_host", new std::string(b));
+               }
+       }
+
+};
+
+MODULE_INIT(ModuleCloaking)