src/modules/m_cloaking.cpp

   1 /*
   2  * InspIRCd -- Internet Relay Chat Daemon
   3  *
   4  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
   5  *   Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
   6  *   Copyright (C) 2008 Pippijn van Steenhoven <pip88nl@gmail.com>
   7  *   Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
   8  *   Copyright (C) 2007 John Brooks <john.brooks@dereferenced.net>
   9  *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
  10  *   Copyright (C) 2006 Oliver Lupton <oliverlupton@gmail.com>
  11  *
  12  * This file is part of InspIRCd.  InspIRCd is free software: you can
  13  * redistribute it and/or modify it under the terms of the GNU General Public
  14  * License as published by the Free Software Foundation, version 2.
  15  *
  16  * This program is distributed in the hope that it will be useful, but WITHOUT
  17  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  18  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
  19  * details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24
  25
  26 #include "inspircd.h"
  27 #include "modules/hash.h"
  28
  29 enum CloakMode
  30 {
  31         /** 2.0 cloak of "half" of the hostname plus the full IP hash */
  32         MODE_HALF_CLOAK,
  33         /** 2.0 cloak of IP hash, split at 2 common CIDR range points */
  34         MODE_OPAQUE
  35 };
  36
  37 // lowercase-only encoding similar to base64, used for hash output
  38 static const char base32[] = "0123456789abcdefghijklmnopqrstuv";
  39
  40 /** Handles user mode +x
  41  */
  42 class CloakUser : public ModeHandler
  43 {
  44  public:
  45         LocalStringExt ext;
  46         std::string debounce_uid;
  47         time_t debounce_ts;
  48         int debounce_count;
  49
  50         CloakUser(Module* source)
  51                 : ModeHandler(source, "cloak", 'x', PARAM_NONE, MODETYPE_USER),
  52                 ext("cloaked_host", source), debounce_ts(0), debounce_count(0)
  53         {
  54         }
  55
  56         ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string &parameter, bool adding)
  57         {
  58                 LocalUser* user = IS_LOCAL(dest);
  59
  60                 /* For remote clients, we don't take any action, we just allow it.
  61                  * The local server where they are will set their cloak instead.
  62                  * This is fine, as we will receive it later.
  63                  */
  64                 if (!user)
  65                 {
  66                         dest->SetMode(this, adding);
  67                         return MODEACTION_ALLOW;
  68                 }
  69
  70                 if (user->uuid == debounce_uid && debounce_ts == ServerInstance->Time())
  71                 {
  72                         // prevent spamming using /mode user +x-x+x-x+x-x
  73                         if (++debounce_count > 2)
  74                                 return MODEACTION_DENY;
  75                 }
  76                 else
  77                 {
  78                         debounce_uid = user->uuid;
  79                         debounce_count = 1;
  80                         debounce_ts = ServerInstance->Time();
  81                 }
  82
  83                 if (adding == user->IsModeSet(this))
  84                         return MODEACTION_DENY;
  85
  86                 /* don't allow this user to spam modechanges */
  87                 if (source == dest)
  88                         user->CommandFloodPenalty += 5000;
  89
  90                 if (adding)
  91                 {
  92                         std::string* cloak = ext.get(user);
  93
  94                         if (!cloak)
  95                         {
  96                                 /* Force creation of missing cloak */
  97                                 creator->OnUserConnect(user);
  98                                 cloak = ext.get(user);
  99                         }
 100                         if (cloak)
 101                         {
 102                                 user->ChangeDisplayedHost(*cloak);
 103                                 user->SetMode(this, true);
 104                                 return MODEACTION_ALLOW;
 105                         }
 106                         else
 107                                 return MODEACTION_DENY;
 108                 }
 109                 else
 110                 {
 111                         /* User is removing the mode, so restore their real host
 112                          * and make it match the displayed one.
 113                          */
 114                         user->SetMode(this, false);
 115                         user->ChangeDisplayedHost(user->host.c_str());
 116                         return MODEACTION_ALLOW;
 117                 }
 118         }
 119 };
 120
 121 class CommandCloak : public Command
 122 {
 123  public:
 124         CommandCloak(Module* Creator) : Command(Creator, "CLOAK", 1)
 125         {
 126                 flags_needed = 'o';
 127                 syntax = "<host>";
 128         }
 129
 130         CmdResult Handle(const std::vector<std::string> &parameters, User *user);
 131 };
 132
 133 class ModuleCloaking : public Module
 134 {
 135  public:
 136         CloakUser cu;
 137         CloakMode mode;
 138         CommandCloak ck;
 139         std::string prefix;
 140         std::string suffix;
 141         std::string key;
 142         const char* xtab[4];
 143         dynamic_reference<HashProvider> Hash;
 144
 145         ModuleCloaking() : cu(this), mode(MODE_OPAQUE), ck(this), Hash(this, "hash/md5")
 146         {
 147         }
 148
 149         /** This function takes a domain name string and returns just the last two domain parts,
 150          * or the last domain part if only two are available. Failing that it just returns what it was given.
 151          *
 152          * For example, if it is passed "svn.inspircd.org" it will return ".inspircd.org".
 153          * If it is passed "brainbox.winbot.co.uk" it will return ".co.uk",
 154          * and if it is passed "localhost.localdomain" it will return ".localdomain".
 155          *
 156          * This is used to ensure a significant part of the host is always cloaked (see Bug #216)
 157          */
 158         std::string LastTwoDomainParts(const std::string &host)
 159         {
 160                 int dots = 0;
 161                 std::string::size_type splitdot = host.length();
 162
 163                 for (std::string::size_type x = host.length() - 1; x; --x)
 164                 {
 165                         if (host[x] == '.')
 166                         {
 167                                 splitdot = x;
 168                                 dots++;
 169                         }
 170                         if (dots >= 3)
 171                                 break;
 172                 }
 173
 174                 if (splitdot == host.length())
 175                         return "";
 176                 else
 177                         return host.substr(splitdot);
 178         }
 179
 180         /**
 181          * 2.0-style cloaking function
 182          * @param item The item to cloak (part of an IP or hostname)
 183          * @param id A unique ID for this type of item (to make it unique if the item matches)
 184          * @param len The length of the output. Maximum for MD5 is 16 characters.
 185          */
 186         std::string SegmentCloak(const std::string& item, char id, int len)
 187         {
 188                 std::string input;
 189                 input.reserve(key.length() + 3 + item.length());
 190                 input.append(1, id);
 191                 input.append(key);
 192                 input.append(1, '\0'); // null does not terminate a C++ string
 193                 input.append(item);
 194
 195                 std::string rv = Hash->GenerateRaw(input).substr(0,len);
 196                 for(int i=0; i < len; i++)
 197                 {
 198                         // this discards 3 bits per byte. We have an
 199                         // overabundance of bits in the hash output, doesn't
 200                         // matter which ones we are discarding.
 201                         rv[i] = base32[rv[i] & 0x1F];
 202                 }
 203                 return rv;
 204         }
 205
 206         std::string SegmentIP(const irc::sockets::sockaddrs& ip, bool full)
 207         {
 208                 std::string bindata;
 209                 int hop1, hop2, hop3;
 210                 int len1, len2;
 211                 std::string rv;
 212                 if (ip.sa.sa_family == AF_INET6)
 213                 {
 214                         bindata = std::string((const char*)ip.in6.sin6_addr.s6_addr, 16);
 215                         hop1 = 8;
 216                         hop2 = 6;
 217                         hop3 = 4;
 218                         len1 = 6;
 219                         len2 = 4;
 220                         // pfx s1.s2.s3. (xxxx.xxxx or s4) sfx
 221                         //     6  4  4    9/6
 222                         rv.reserve(prefix.length() + 26 + suffix.length());
 223                 }
 224                 else
 225                 {
 226                         bindata = std::string((const char*)&ip.in4.sin_addr, 4);
 227                         hop1 = 3;
 228                         hop2 = 0;
 229                         hop3 = 2;
 230                         len1 = len2 = 3;
 231                         // pfx s1.s2. (xxx.xxx or s3) sfx
 232                         rv.reserve(prefix.length() + 15 + suffix.length());
 233                 }
 234
 235                 rv.append(prefix);
 236                 rv.append(SegmentCloak(bindata, 10, len1));
 237                 rv.append(1, '.');
 238                 bindata.erase(hop1);
 239                 rv.append(SegmentCloak(bindata, 11, len2));
 240                 if (hop2)
 241                 {
 242                         rv.append(1, '.');
 243                         bindata.erase(hop2);
 244                         rv.append(SegmentCloak(bindata, 12, len2));
 245                 }
 246
 247                 if (full)
 248                 {
 249                         rv.append(1, '.');
 250                         bindata.erase(hop3);
 251                         rv.append(SegmentCloak(bindata, 13, 6));
 252                         rv.append(suffix);
 253                 }
 254                 else
 255                 {
 256                         char buf[50];
 257                         if (ip.sa.sa_family == AF_INET6)
 258                         {
 259                                 snprintf(buf, 50, ".%02x%02x.%02x%02x%s",
 260                                         ip.in6.sin6_addr.s6_addr[2], ip.in6.sin6_addr.s6_addr[3],
 261                                         ip.in6.sin6_addr.s6_addr[0], ip.in6.sin6_addr.s6_addr[1], suffix.c_str());
 262                         }
 263                         else
 264                         {
 265                                 const unsigned char* ip4 = (const unsigned char*)&ip.in4.sin_addr;
 266                                 snprintf(buf, 50, ".%d.%d%s", ip4[1], ip4[0], suffix.c_str());
 267                         }
 268                         rv.append(buf);
 269                 }
 270                 return rv;
 271         }
 272
 273         ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask) CXX11_OVERRIDE
 274         {
 275                 LocalUser* lu = IS_LOCAL(user);
 276                 if (!lu)
 277                         return MOD_RES_PASSTHRU;
 278
 279                 OnUserConnect(lu);
 280                 std::string* cloak = cu.ext.get(user);
 281                 /* Check if they have a cloaked host, but are not using it */
 282                 if (cloak && *cloak != user->dhost)
 283                 {
 284                         const std::string cloakMask = user->nick + "!" + user->ident + "@" + *cloak;
 285                         if (InspIRCd::Match(cloakMask, mask))
 286                                 return MOD_RES_DENY;
 287                 }
 288                 return MOD_RES_PASSTHRU;
 289         }
 290
 291         void Prioritize()
 292         {
 293                 /* Needs to be after m_banexception etc. */
 294                 ServerInstance->Modules->SetPriority(this, I_OnCheckBan, PRIORITY_LAST);
 295         }
 296
 297         // this unsets umode +x on every host change. If we are actually doing a +x
 298         // mode change, we will call SetMode back to true AFTER the host change is done.
 299         void OnChangeHost(User* u, const std::string& host) CXX11_OVERRIDE
 300         {
 301                 if (u->IsModeSet(cu))
 302                 {
 303                         u->SetMode(cu, false);
 304                         u->WriteCommand("MODE", "-" + ConvToStr(cu.GetModeChar()));
 305                 }
 306         }
 307
 308         Version GetVersion() CXX11_OVERRIDE
 309         {
 310                 std::string testcloak = "broken";
 311                 if (Hash)
 312                 {
 313                         switch (mode)
 314                         {
 315                                 case MODE_HALF_CLOAK:
 316                                         testcloak = prefix + SegmentCloak("*", 3, 8) + suffix;
 317                                         break;
 318                                 case MODE_OPAQUE:
 319                                         testcloak = prefix + SegmentCloak("*", 4, 8) + suffix;
 320                         }
 321                 }
 322                 return Version("Provides masking of user hostnames", VF_COMMON|VF_VENDOR, testcloak);
 323         }
 324
 325         void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
 326         {
 327                 ConfigTag* tag = ServerInstance->Config->ConfValue("cloak");
 328                 prefix = tag->getString("prefix");
 329                 suffix = tag->getString("suffix", ".IP");
 330
 331                 std::string modestr = tag->getString("mode");
 332                 if (modestr == "half")
 333                         mode = MODE_HALF_CLOAK;
 334                 else if (modestr == "full")
 335                         mode = MODE_OPAQUE;
 336                 else
 337                         throw ModuleException("Bad value for <cloak:mode>; must be half or full");
 338
 339                 key = tag->getString("key");
 340                 if (key.empty() || key == "secret")
 341                         throw ModuleException("You have not defined cloak keys for m_cloaking. Define <cloak:key> as a network-wide secret.");
 342         }
 343
 344         std::string GenCloak(const irc::sockets::sockaddrs& ip, const std::string& ipstr, const std::string& host)
 345         {
 346                 std::string chost;
 347
 348                 switch (mode)
 349                 {
 350                         case MODE_HALF_CLOAK:
 351                         {
 352                                 if (ipstr != host)
 353                                         chost = prefix + SegmentCloak(host, 1, 6) + LastTwoDomainParts(host);
 354                                 if (chost.empty() || chost.length() > 50)
 355                                         chost = SegmentIP(ip, false);
 356                                 break;
 357                         }
 358                         case MODE_OPAQUE:
 359                         default:
 360                                 chost = SegmentIP(ip, true);
 361                 }
 362                 return chost;
 363         }
 364
 365         void OnUserConnect(LocalUser* dest) CXX11_OVERRIDE
 366         {
 367                 std::string* cloak = cu.ext.get(dest);
 368                 if (cloak)
 369                         return;
 370
 371                 cu.ext.set(dest, GenCloak(dest->client_sa, dest->GetIPString(), dest->host));
 372         }
 373 };
 374
 375 CmdResult CommandCloak::Handle(const std::vector<std::string> &parameters, User *user)
 376 {
 377         ModuleCloaking* mod = (ModuleCloaking*)(Module*)creator;
 378         irc::sockets::sockaddrs sa;
 379         std::string cloak;
 380
 381         if (irc::sockets::aptosa(parameters[0], 0, sa))
 382                 cloak = mod->GenCloak(sa, parameters[0], parameters[0]);
 383         else
 384                 cloak = mod->GenCloak(sa, "", parameters[0]);
 385
 386         user->WriteNotice("*** Cloak for " + parameters[0] + " is " + cloak);
 387
 388         return CMD_SUCCESS;
 389 }
 390
 391 MODULE_INIT(ModuleCloaking)