]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_cloaking.cpp
Add the override keyword in places that it is missing.
[user/henk/code/inspircd.git] / src / modules / m_cloaking.cpp
index 5a6e8748675b1fdec3e4b3fd2f15c37ed01f18a6..a1e4d1af70ef06adf485f86be36f9c5218a199bf 100644 (file)
@@ -1,27 +1,33 @@
-/*       +------------------------------------+
- *       | Inspire Internet Relay Chat Daemon |
- *       +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
  *
- *  InspIRCd: (C) 2002-2010 InspIRCd Development Team
- * See: http://wiki.inspircd.org/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.h"
-#include "hash.h"
 
-/* $ModDesc: Provides masking of user hostnames */
+#include "inspircd.h"
+#include "modules/hash.h"
 
 enum CloakMode
 {
-       /** 1.2-compatible host-based cloak */
-       MODE_COMPAT_HOST,
-       /** 1.2-compatible IP-only cloak */
-       MODE_COMPAT_IPONLY,
        /** 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 */
@@ -37,18 +43,17 @@ class CloakUser : public ModeHandler
 {
  public:
        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)
+               ext("cloaked_host", ExtensionItem::EXT_USER, source), debounce_ts(0), debounce_count(0)
        {
        }
 
-       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
+       ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
        {
                LocalUser* user = IS_LOCAL(dest);
 
@@ -58,7 +63,7 @@ class CloakUser : public ModeHandler
                 */
                if (!user)
                {
-                       dest->SetMode('x',adding);
+                       dest->SetMode(this, adding);
                        return MODEACTION_ALLOW;
                }
 
@@ -75,15 +80,19 @@ class CloakUser : public ModeHandler
                        debounce_ts = ServerInstance->Time();
                }
 
-               if (adding == user->IsModeSet('x'))
+               if (adding == user->IsModeSet(this))
                        return MODEACTION_DENY;
 
                /* don't allow this user to spam modechanges */
                if (source == dest)
                        user->CommandFloodPenalty += 5000;
-               
+
                if (adding)
                {
+                       // assume this is more correct
+                       if (user->registered != REG_ALL && user->GetRealHost() != user->GetDisplayedHost())
+                               return MODEACTION_DENY;
+
                        std::string* cloak = ext.get(user);
 
                        if (!cloak)
@@ -94,8 +103,8 @@ class CloakUser : public ModeHandler
                        }
                        if (cloak)
                        {
-                               user->ChangeDisplayedHost(cloak->c_str());
-                               user->SetMode('x',true);
+                               user->ChangeDisplayedHost(*cloak);
+                               user->SetMode(this, true);
                                return MODEACTION_ALLOW;
                        }
                        else
@@ -106,45 +115,41 @@ class CloakUser : public ModeHandler
                        /* User is removing the mode, so restore their real host
                         * and make it match the displayed one.
                         */
-                       user->ChangeDisplayedHost(user->host.c_str());
-                       user->SetMode('x',false);
+                       user->SetMode(this, false);
+                       user->ChangeDisplayedHost(user->GetRealHost().c_str());
                        return MODEACTION_ALLOW;
                }
        }
-
 };
 
+class CommandCloak : public Command
+{
+ public:
+       CommandCloak(Module* Creator) : Command(Creator, "CLOAK", 1)
+       {
+               flags_needed = 'o';
+               syntax = "<host>";
+       }
+
+       CmdResult Handle(const std::vector<std::string>& parameters, User* user) CXX11_OVERRIDE;
+};
 
 class ModuleCloaking : public Module
 {
- private:
+ public:
        CloakUser cu;
        CloakMode mode;
+       CommandCloak ck;
        std::string prefix;
+       std::string suffix;
        std::string key;
-       unsigned int compatkey[4];
-       const char* xtab[4];
+       unsigned int domainparts;
        dynamic_reference<HashProvider> Hash;
 
- public:
-       ModuleCloaking() : cu(this), mode(MODE_OPAQUE), Hash(this, "hash/md5")
+       ModuleCloaking() : cu(this), mode(MODE_OPAQUE), ck(this), Hash(this, "hash/md5")
        {
        }
 
-       void init()
-       {
-               OnRehash(NULL);
-
-               /* Register it with the core */
-               if (!ServerInstance->Modes->AddMode(&cu))
-                       throw ModuleException("Could not add new modes!");
-
-               ServerInstance->Extensions.Register(&cu.ext);
-
-               Implementation eventlist[] = { I_OnRehash, I_OnCheckBan, I_OnUserConnect, I_OnChangeHost };
-               ServerInstance->Modules->Attach(eventlist, this, 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.
         *
@@ -156,7 +161,7 @@ class ModuleCloaking : public Module
         */
        std::string LastTwoDomainParts(const std::string &host)
        {
-               int dots = 0;
+               unsigned int dots = 0;
                std::string::size_type splitdot = host.length();
 
                for (std::string::size_type x = host.length() - 1; x; --x)
@@ -166,7 +171,7 @@ class ModuleCloaking : public Module
                                splitdot = x;
                                dots++;
                        }
-                       if (dots >= 3)
+                       if (dots >= domainparts)
                                break;
                }
 
@@ -182,17 +187,17 @@ class ModuleCloaking : public Module
         * @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 SegmentCloak(const std::string& item, char id, size_t 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(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++)
+               std::string rv = Hash->GenerateRaw(input).substr(0,len);
+               for(size_t i = 0; i < len; i++)
                {
                        // this discards 3 bits per byte. We have an
                        // overabundance of bits in the hash output, doesn't
@@ -202,68 +207,11 @@ class ModuleCloaking : public Module
                return rv;
        }
 
-       std::string CompatCloak4(const char* ip)
-       {
-               irc::sepstream seps(ip, '.');
-               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 */
-
-               std::string rv;
-
-               /* Send the Hash module a different hex table for each octet group's Hash sum */
-               for (int k = 0; k < 4; k++)
-               {
-                       rv.append(Hash->sumIV(compatkey, xtab[(compatkey[k]+i[k]) % 4], octet[k]).substr(0,6));
-                       if (k < 3)
-                               rv.append(".");
-               }
-               /* Stick them all together */
-               return rv;
-       }
-
-       std::string CompatCloak6(const char* ip)
-       {
-               std::vector<std::string> hashies;
-               std::string item;
-               int rounds = 0;
-
-               /* Reset the Hash module and send it our IV */
-
-               for (const char* input = ip; *input; input++)
-               {
-                       item += *input;
-                       if (item.length() > 7)
-                       {
-                               hashies.push_back(Hash->sumIV(compatkey, xtab[(compatkey[1]+rounds) % 4], item).substr(0,8));
-                               item.clear();
-                       }
-                       rounds++;
-               }
-               if (!item.empty())
-               {
-                       hashies.push_back(Hash->sumIV(compatkey, xtab[(compatkey[1]+rounds) % 4], item).substr(0,8));
-               }
-               /* Stick them all together */
-               return irc::stringjoiner(":", hashies, 0, hashies.size() - 1).GetJoined();
-       }
-
        std::string SegmentIP(const irc::sockets::sockaddrs& ip, bool full)
        {
                std::string bindata;
-               int hop1, hop2, hop3;
-               int len1, len2;
+               size_t hop1, hop2, hop3;
+               size_t len1, len2;
                std::string rv;
                if (ip.sa.sa_family == AF_INET6)
                {
@@ -273,7 +221,9 @@ class ModuleCloaking : public Module
                        hop3 = 4;
                        len1 = 6;
                        len2 = 4;
-                       rv.reserve(prefix.length() + 29);
+                       // pfx s1.s2.s3. (xxxx.xxxx or s4) sfx
+                       //     6  4  4    9/6
+                       rv.reserve(prefix.length() + 26 + suffix.length());
                }
                else
                {
@@ -282,7 +232,8 @@ class ModuleCloaking : public Module
                        hop2 = 0;
                        hop3 = 2;
                        len1 = len2 = 3;
-                       rv.reserve(prefix.length() + 18);
+                       // pfx s1.s2. (xxx.xxx or s3) sfx
+                       rv.reserve(prefix.length() + 15 + suffix.length());
                }
 
                rv.append(prefix);
@@ -302,28 +253,26 @@ class ModuleCloaking : public Module
                        rv.append(1, '.');
                        bindata.erase(hop3);
                        rv.append(SegmentCloak(bindata, 13, 6));
-                       rv.append(".IP");
+                       rv.append(suffix);
                }
                else
                {
-                       char buf[50];
                        if (ip.sa.sa_family == AF_INET6)
                        {
-                               snprintf(buf, 50, ".%02x%02x.%02x%02x.IP",
+                               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]);
+                                       ip.in6.sin6_addr.s6_addr[0], ip.in6.sin6_addr.s6_addr[1], suffix.c_str()));
                        }
                        else
                        {
                                const unsigned char* ip4 = (const unsigned char*)&ip.in4.sin_addr;
-                               snprintf(buf, 50, ".%d.%d.IP", ip4[1], ip4[0]);
+                               rv.append(InspIRCd::Format(".%d.%d%s", ip4[1], ip4[0], suffix.c_str()));
                        }
-                       rv.append(buf);
                }
                return rv;
        }
 
-       ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask)
+       ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask) CXX11_OVERRIDE
        {
                LocalUser* lu = IS_LOCAL(user);
                if (!lu)
@@ -332,17 +281,16 @@ class ModuleCloaking : public Module
                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)
+               if (cloak && *cloak != user->GetDisplayedHost())
                {
-                       char cmask[MAXBUF];
-                       snprintf(cmask, MAXBUF, "%s!%s@%s", user->nick.c_str(), user->ident.c_str(), cloak->c_str());
-                       if (InspIRCd::Match(cmask,mask))
+                       const std::string cloakMask = user->nick + "!" + user->ident + "@" + *cloak;
+                       if (InspIRCd::Match(cloakMask, mask))
                                return MOD_RES_DENY;
                }
                return MOD_RES_PASSTHRU;
        }
 
-       void Prioritize()
+       void Prioritize() CXX11_OVERRIDE
        {
                /* Needs to be after m_banexception etc. */
                ServerInstance->Modules->SetPriority(this, I_OnCheckBan, PRIORITY_LAST);
@@ -350,164 +298,110 @@ class ModuleCloaking : public Module
 
        // 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)
-       {
-               u->SetMode('x', false);
-       }
-
-       ~ModuleCloaking()
+       void OnChangeHost(User* u, const std::string& host) CXX11_OVERRIDE
        {
+               if (u->IsModeSet(cu))
+               {
+                       u->SetMode(cu, false);
+                       u->WriteCommand("MODE", "-" + ConvToStr(cu.GetModeChar()));
+               }
        }
 
-       Version GetVersion()
+       Version GetVersion() CXX11_OVERRIDE
        {
                std::string testcloak = "broken";
                if (Hash)
                {
                        switch (mode)
                        {
-                               case MODE_COMPAT_HOST:
-                                       testcloak = prefix + "-" + Hash->sumIV(compatkey, xtab[0], "*").substr(0,10);
-                                       break;
-                               case MODE_COMPAT_IPONLY:
-                                       testcloak = Hash->sumIV(compatkey, xtab[0], "*").substr(0,10);
-                                       break;
                                case MODE_HALF_CLOAK:
-                                       testcloak = prefix + SegmentCloak("*", 3, 8);
+                                       // Use old cloaking verification to stay compatible with 2.0
+                                       // But verify domainparts when use 3.0-only features
+                                       if (domainparts == 3)
+                                               testcloak = prefix + SegmentCloak("*", 3, 8) + suffix;
+                                       else
+                                       {
+                                               irc::sockets::sockaddrs sa;
+                                               testcloak = GenCloak(sa, "", testcloak + ConvToStr(domainparts));
+                                       }
                                        break;
                                case MODE_OPAQUE:
-                                       testcloak = prefix + SegmentCloak("*", 4, 8);
+                                       testcloak = prefix + SegmentCloak("*", 4, 8) + suffix;
                        }
                }
                return Version("Provides masking of user hostnames", VF_COMMON|VF_VENDOR, testcloak);
        }
 
-       void OnRehash(User* user)
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
                ConfigTag* tag = ServerInstance->Config->ConfValue("cloak");
                prefix = tag->getString("prefix");
+               suffix = tag->getString("suffix", ".IP");
 
                std::string modestr = tag->getString("mode");
-               if (modestr == "compat-host")
-                       mode = MODE_COMPAT_HOST;
-               else if (modestr == "compat-ip")
-                       mode = MODE_COMPAT_IPONLY;
-               else if (modestr == "half")
+               if (modestr == "half")
+               {
                        mode = MODE_HALF_CLOAK;
+                       domainparts = tag->getInt("domainparts", 3, 1, 10);
+               }
                else if (modestr == "full")
                        mode = MODE_OPAQUE;
                else
-                       throw ModuleException("Bad value for <cloak:mode>; must be one of compat-host, compat-ip, half, full");
+                       throw ModuleException("Bad value for <cloak:mode>; must be half or full");
 
-               if (mode == MODE_COMPAT_HOST || mode == MODE_COMPAT_IPONLY)
-               {
-                       bool lowercase = tag->getBool("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
-                        *
-                        * We must limit the keys or else we get different results on
-                        * amd64/x86 boxes. - psychon */
-                       const unsigned int limit = 0x80000000;
-                       compatkey[0] = (unsigned int) tag->getInt("key1");
-                       compatkey[1] = (unsigned int) tag->getInt("key2");
-                       compatkey[2] = (unsigned int) tag->getInt("key3");
-                       compatkey[3] = (unsigned int) tag->getInt("key4");
-
-                       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 (!compatkey[0] || !compatkey[1] || !compatkey[2] || !compatkey[3] ||
-                               compatkey[0] >= limit || compatkey[1] >= limit || compatkey[2] >= limit || compatkey[3] >= limit)
-                       {
-                               std::string detail;
-                               if (!compatkey[0] || compatkey[0] >= limit)
-                                       detail = "<cloak:key1> is not valid, it may be set to a too high/low value, or it may not exist.";
-                               else if (!compatkey[1] || compatkey[1] >= limit)
-                                       detail = "<cloak:key2> is not valid, it may be set to a too high/low value, or it may not exist.";
-                               else if (!compatkey[2] || compatkey[2] >= limit)
-                                       detail = "<cloak:key3> is not valid, it may be set to a too high/low value, or it may not exist.";
-                               else if (!compatkey[3] || compatkey[3] >= limit)
-                                       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);
-                       }
-               }
-               else
-               {
-                       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.");
-               }
+               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.");
        }
 
-       void OnUserConnect(LocalUser* dest)
+       std::string GenCloak(const irc::sockets::sockaddrs& ip, const std::string& ipstr, const std::string& host)
        {
-               std::string* cloak = cu.ext.get(dest);
-               if (cloak)
-                       return;
-
-               std::string ipstr = dest->GetIPString();
                std::string chost;
 
+               irc::sockets::sockaddrs hostip;
+               bool host_is_ip = irc::sockets::aptosa(host, ip.port(), hostip) && hostip == ip;
+
                switch (mode)
                {
-                       case MODE_COMPAT_HOST:
-                       {
-                               if (ipstr != dest->host)
-                               {
-                                       std::string tail = LastTwoDomainParts(dest->host);
-
-                                       /* Generate a cloak using specialized Hash */
-                                       chost = prefix + "-" + Hash->sumIV(compatkey, xtab[(dest->host[0]) % 4], dest->host).substr(0,8) + tail;
-
-                                       /* Fix by brain - if the cloaked host is > the max length of a host (64 bytes
-                                        * according to the DNS RFC) then they get cloaked as an IP.
-                                        */
-                                       if (chost.length() <= 64)
-                                               break;
-                               }
-                               // fall through to IP cloak
-                       }
-                       case MODE_COMPAT_IPONLY:
-                               if (dest->client_sa.sa.sa_family == AF_INET6)
-                                       chost = CompatCloak6(ipstr.c_str());
-                               else
-                                       chost = CompatCloak4(ipstr.c_str());
-                               break;
                        case MODE_HALF_CLOAK:
                        {
-                               if (ipstr != dest->host)
-                                       chost = prefix + SegmentCloak(dest->host, 1, 6) + LastTwoDomainParts(dest->host);
+                               if (!host_is_ip)
+                                       chost = prefix + SegmentCloak(host, 1, 6) + LastTwoDomainParts(host);
                                if (chost.empty() || chost.length() > 50)
-                                       chost = SegmentIP(dest->client_sa, false);
+                                       chost = SegmentIP(ip, false);
                                break;
                        }
                        case MODE_OPAQUE:
                        default:
-                               chost = SegmentIP(dest->client_sa, true);
+                               chost = SegmentIP(ip, true);
                }
-               cu.ext.set(dest,chost);
+               return chost;
        }
 
+       void OnUserConnect(LocalUser* dest) CXX11_OVERRIDE
+       {
+               std::string* cloak = cu.ext.get(dest);
+               if (cloak)
+                       return;
+
+               cu.ext.set(dest, GenCloak(dest->client_sa, dest->GetIPString(), dest->GetRealHost()));
+       }
 };
 
+CmdResult CommandCloak::Handle(const std::vector<std::string> &parameters, User *user)
+{
+       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]);
+
+       user->WriteNotice("*** Cloak for " + parameters[0] + " is " + cloak);
+
+       return CMD_SUCCESS;
+}
+
 MODULE_INIT(ModuleCloaking)