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