src/modules/m_cloaking.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  InspIRCd is copyright (C) 2002-2006 ChatSpike-Dev.
   6  *                       E-mail:
   7  *                <brain@chatspike.net>
   8  *                <Craig@chatspike.net>
   9  *
  10  * Written by Craig Edwards, Craig McLure, and others.
  11  * This program is free but copyrighted software; see
  12  *            the file COPYING for details.
  13  *
  14  * ---------------------------------------------------
  15  */
  16
  17 // Hostname cloaking (+x mode) module for inspircd.
  18 // version 1.0.0.1 by brain (C. J. Edwards) Mar 2004.
  19 //
  20 // When loaded this module will automatically set the
  21 // +x mode on all connecting clients.
  22 //
  23 // Setting +x on a client causes the module to change the
  24 // dhost entry (displayed host) for each user who has the
  25 // mode, cloaking their host. Unlike unreal, the algorithm
  26 // is non-reversible as uncloaked hosts are passed along
  27 // the server->server link, and all encoding of hosts is
  28 // done locally on the server by this module.
  29
  30 #include <sys/types.h>
  31 #include <sys/socket.h>
  32 #include <netinet/in.h>
  33 #include <arpa/inet.h>
  34 #include "inspircd_config.h"
  35 #ifdef HAS_STDINT
  36 #include <stdint.h>
  37 #endif
  38 #include "configreader.h"
  39 #include "inspircd.h"
  40 #include "users.h"
  41 #include "channels.h"
  42 #include "modules.h"
  43
  44 /* $ModDesc: Provides masking of user hostnames */
  45
  46
  47
  48 /* The four core functions - F1 is optimized somewhat */
  49
  50 #define F1(x, y, z) (z ^ (x & (y ^ z)))
  51 #define F2(x, y, z) F1(z, x, y)
  52 #define F3(x, y, z) (x ^ y ^ z)
  53 #define F4(x, y, z) (y ^ (x | ~z))
  54 #define MD5STEP(f,w,x,y,z,in,s) (w += f(x,y,z) + in, w = (w<<s | w>>(32-s)) + x)
  55
  56 #ifndef HAS_STDINT
  57 typedef unsigned int uint32_t;
  58 #endif
  59
  60 typedef uint32_t word32; /* NOT unsigned long. We don't support 16 bit platforms, anyway. */
  61 typedef unsigned char byte;
  62
  63 /** An MD5 context, used by m_cloaking
  64  */
  65 class xMD5Context : public classbase
  66 {
  67  public:
  68         word32 buf[4];
  69         word32 bytes[2];
  70         word32 in[16];
  71 };
  72
  73 /** Handles user mode +x
  74  */
  75 class CloakUser : public ModeHandler
  76 {
  77
  78         std::string prefix;
  79         word32 key1;
  80         word32 key2;
  81         word32 key3;
  82         word32 key4;
  83
  84         void byteSwap(word32 *buf, unsigned words)
  85         {
  86                 byte *p = (byte *)buf;
  87
  88                 do
  89                 {
  90                         *buf++ = (word32)((unsigned)p[3] << 8 | p[2]) << 16 |
  91                                 ((unsigned)p[1] << 8 | p[0]);
  92                         p += 4;
  93                 } while (--words);
  94         }
  95
  96         void xMD5Init(struct xMD5Context *ctx)
  97         {
  98                 ctx->buf[0] = key1;
  99                 ctx->buf[1] = key2;
 100                 ctx->buf[2] = key3;
 101                 ctx->buf[3] = key4;
 102
 103                 ctx->bytes[0] = 0;
 104                 ctx->bytes[1] = 0;
 105         }
 106
 107         void xMD5Update(struct xMD5Context *ctx, byte const *buf, int len)
 108         {
 109                 word32 t;
 110
 111                 /* Update byte count */
 112
 113                 t = ctx->bytes[0];
 114                 if ((ctx->bytes[0] = t + len) < t)
 115                         ctx->bytes[1]++;        /* Carry from low to high */
 116
 117                 t = 64 - (t & 0x3f);    /* Space available in ctx->in (at least 1) */
 118                 if ((unsigned)t > (unsigned)len)
 119                 {
 120                         memcpy((byte *)ctx->in + 64 - (unsigned)t, buf, len);
 121                         return;
 122                 }
 123                 /* First chunk is an odd size */
 124                 memcpy((byte *)ctx->in + 64 - (unsigned)t, buf, (unsigned)t);
 125                 byteSwap(ctx->in, 16);
 126                 xMD5Transform(ctx->buf, ctx->in);
 127                 buf += (unsigned)t;
 128                 len -= (unsigned)t;
 129
 130                 /* Process data in 64-byte chunks */
 131                 while (len >= 64)
 132                 {
 133                         memcpy(ctx->in, buf, 64);
 134                         byteSwap(ctx->in, 16);
 135                         xMD5Transform(ctx->buf, ctx->in);
 136                         buf += 64;
 137                         len -= 64;
 138                 }
 139
 140                 /* Handle any remaining bytes of data. */
 141                 memcpy(ctx->in, buf, len);
 142         }
 143
 144         void xMD5Final(byte digest[16], struct xMD5Context *ctx)
 145         {
 146                 int count = (int)(ctx->bytes[0] & 0x3f); /* Bytes in ctx->in */
 147                 byte *p = (byte *)ctx->in + count;      /* First unused byte */
 148
 149                 /* Set the first char of padding to 0x80.  There is always room. */
 150                 *p++ = 0x80;
 151
 152                 /* Bytes of padding needed to make 56 bytes (-8..55) */
 153                 count = 56 - 1 - count;
 154
 155                 if (count < 0)
 156                 {       /* Padding forces an extra block */
 157                         memset(p, 0, count+8);
 158                         byteSwap(ctx->in, 16);
 159                         xMD5Transform(ctx->buf, ctx->in);
 160                         p = (byte *)ctx->in;
 161                         count = 56;
 162                 }
 163                 memset(p, 0, count+8);
 164                 byteSwap(ctx->in, 14);
 165
 166                 /* Append length in bits and transform */
 167                 ctx->in[14] = ctx->bytes[0] << 3;
 168                 ctx->in[15] = ctx->bytes[1] << 3 | ctx->bytes[0] >> 29;
 169                 xMD5Transform(ctx->buf, ctx->in);
 170
 171                 byteSwap(ctx->buf, 4);
 172                 memcpy(digest, ctx->buf, 16);
 173                 memset(ctx, 0, sizeof(ctx));
 174         }
 175
 176         void xMD5Transform(word32 buf[4], word32 const in[16])
 177         {
 178                 register word32 a, b, c, d;
 179
 180                 a = buf[0];
 181                 b = buf[1];
 182                 c = buf[2];
 183                 d = buf[3];
 184
 185                 MD5STEP(F1, a, b, c, d, in[0] + 0xd76aa478, 7);
 186                 MD5STEP(F1, d, a, b, c, in[1] + 0xe8c7b756, 12);
 187                 MD5STEP(F1, c, d, a, b, in[2] + 0x242070db, 17);
 188                 MD5STEP(F1, b, c, d, a, in[3] + 0xc1bdceee, 22);
 189                 MD5STEP(F1, a, b, c, d, in[4] + 0xf57c0faf, 7);
 190                 MD5STEP(F1, d, a, b, c, in[5] + 0x4787c62a, 12);
 191                 MD5STEP(F1, c, d, a, b, in[6] + 0xa8304613, 17);
 192                 MD5STEP(F1, b, c, d, a, in[7] + 0xfd469501, 22);
 193                 MD5STEP(F1, a, b, c, d, in[8] + 0x698098d8, 7);
 194                 MD5STEP(F1, d, a, b, c, in[9] + 0x8b44f7af, 12);
 195                 MD5STEP(F1, c, d, a, b, in[10] + 0xffff5bb1, 17);
 196                 MD5STEP(F1, b, c, d, a, in[11] + 0x895cd7be, 22);
 197                 MD5STEP(F1, a, b, c, d, in[12] + 0x6b901122, 7);
 198                 MD5STEP(F1, d, a, b, c, in[13] + 0xfd987193, 12);
 199                 MD5STEP(F1, c, d, a, b, in[14] + 0xa679438e, 17);
 200                 MD5STEP(F1, b, c, d, a, in[15] + 0x49b40821, 22);
 201
 202                 MD5STEP(F2, a, b, c, d, in[1] + 0xf61e2562, 5);
 203                 MD5STEP(F2, d, a, b, c, in[6] + 0xc040b340, 9);
 204                 MD5STEP(F2, c, d, a, b, in[11] + 0x265e5a51, 14);
 205                 MD5STEP(F2, b, c, d, a, in[0] + 0xe9b6c7aa, 20);
 206                 MD5STEP(F2, a, b, c, d, in[5] + 0xd62f105d, 5);
 207                 MD5STEP(F2, d, a, b, c, in[10] + 0x02441453, 9);
 208                 MD5STEP(F2, c, d, a, b, in[15] + 0xd8a1e681, 14);
 209                 MD5STEP(F2, b, c, d, a, in[4] + 0xe7d3fbc8, 20);
 210                 MD5STEP(F2, a, b, c, d, in[9] + 0x21e1cde6, 5);
 211                 MD5STEP(F2, d, a, b, c, in[14] + 0xc33707d6, 9);
 212                 MD5STEP(F2, c, d, a, b, in[3] + 0xf4d50d87, 14);
 213                 MD5STEP(F2, b, c, d, a, in[8] + 0x455a14ed, 20);
 214                 MD5STEP(F2, a, b, c, d, in[13] + 0xa9e3e905, 5);
 215                 MD5STEP(F2, d, a, b, c, in[2] + 0xfcefa3f8, 9);
 216                 MD5STEP(F2, c, d, a, b, in[7] + 0x676f02d9, 14);
 217                 MD5STEP(F2, b, c, d, a, in[12] + 0x8d2a4c8a, 20);
 218
 219                 MD5STEP(F3, a, b, c, d, in[5] + 0xfffa3942, 4);
 220                 MD5STEP(F3, d, a, b, c, in[8] + 0x8771f681, 11);
 221                 MD5STEP(F3, c, d, a, b, in[11] + 0x6d9d6122, 16);
 222                 MD5STEP(F3, b, c, d, a, in[14] + 0xfde5380c, 23);
 223                 MD5STEP(F3, a, b, c, d, in[1] + 0xa4beea44, 4);
 224                 MD5STEP(F3, d, a, b, c, in[4] + 0x4bdecfa9, 11);
 225                 MD5STEP(F3, c, d, a, b, in[7] + 0xf6bb4b60, 16);
 226                 MD5STEP(F3, b, c, d, a, in[10] + 0xbebfbc70, 23);
 227                 MD5STEP(F3, a, b, c, d, in[13] + 0x289b7ec6, 4);
 228                 MD5STEP(F3, d, a, b, c, in[0] + 0xeaa127fa, 11);
 229                 MD5STEP(F3, c, d, a, b, in[3] + 0xd4ef3085, 16);
 230                 MD5STEP(F3, b, c, d, a, in[6] + 0x04881d05, 23);
 231                 MD5STEP(F3, a, b, c, d, in[9] + 0xd9d4d039, 4);
 232                 MD5STEP(F3, d, a, b, c, in[12] + 0xe6db99e5, 11);
 233                 MD5STEP(F3, c, d, a, b, in[15] + 0x1fa27cf8, 16);
 234                 MD5STEP(F3, b, c, d, a, in[2] + 0xc4ac5665, 23);
 235
 236                 MD5STEP(F4, a, b, c, d, in[0] + 0xf4292244, 6);
 237                 MD5STEP(F4, d, a, b, c, in[7] + 0x432aff97, 10);
 238                 MD5STEP(F4, c, d, a, b, in[14] + 0xab9423a7, 15);
 239                 MD5STEP(F4, b, c, d, a, in[5] + 0xfc93a039, 21);
 240                 MD5STEP(F4, a, b, c, d, in[12] + 0x655b59c3, 6);
 241                 MD5STEP(F4, d, a, b, c, in[3] + 0x8f0ccc92, 10);
 242                 MD5STEP(F4, c, d, a, b, in[10] + 0xffeff47d, 15);
 243                 MD5STEP(F4, b, c, d, a, in[1] + 0x85845dd1, 21);
 244                 MD5STEP(F4, a, b, c, d, in[8] + 0x6fa87e4f, 6);
 245                 MD5STEP(F4, d, a, b, c, in[15] + 0xfe2ce6e0, 10);
 246                 MD5STEP(F4, c, d, a, b, in[6] + 0xa3014314, 15);
 247                 MD5STEP(F4, b, c, d, a, in[13] + 0x4e0811a1, 21);
 248                 MD5STEP(F4, a, b, c, d, in[4] + 0xf7537e82, 6);
 249                 MD5STEP(F4, d, a, b, c, in[11] + 0xbd3af235, 10);
 250                 MD5STEP(F4, c, d, a, b, in[2] + 0x2ad7d2bb, 15);
 251                 MD5STEP(F4, b, c, d, a, in[9] + 0xeb86d391, 21);
 252
 253                 buf[0] += a;
 254                 buf[1] += b;
 255                 buf[2] += c;
 256                 buf[3] += d;
 257         }
 258
 259
 260         void MyMD5(void *dest, const void *orig, int len)
 261         {
 262                 struct xMD5Context context;
 263
 264                 xMD5Init(&context);
 265                 xMD5Update(&context, (const unsigned char*)orig, len);
 266                 xMD5Final((unsigned char*)dest, &context);
 267         }
 268
 269
 270         void GenHash(const char* src, char* dest, int xtable = 0)
 271         {
 272                 // purposefully lossy md5 - only gives them the most significant 4 bits
 273                 // of every md5 output byte.
 274                 int i = 0;
 275                 unsigned char bytes[16];
 276                 char hash[MAXBUF];
 277                 *hash = 0;
 278                 MyMD5(bytes, src, strlen(src));
 279                 for (i = 0; i < 16; i++)
 280                 {
 281                         const char* xtab[] = {"F92E45D871BCA630", "A1B9D80C72E653F4", "1ABC078934DEF562", "ABCDEF5678901234"};
 282                         char hx[2] = { xtab[xtable][bytes[i] / 16], 0};
 283                         strlcat(hash,hx,MAXBUF);
 284                 }
 285                 strlcpy(dest,hash,MAXBUF);
 286         }
 287
 288  public:
 289         CloakUser(InspIRCd* Instance) : ModeHandler(Instance, 'x', 0, 0, false, MODETYPE_USER, false) { }
 290
 291         ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string &parameter, bool adding)
 292         {
 293                 /* Only opers can change other users modes */
 294                 if ((source != dest) && (!*source->oper))
 295                         return MODEACTION_DENY;
 296
 297                 /* For remote clients, we dont take any action, we just allow it.
 298                  * The local server where they are will set their cloak instead.
 299                  */
 300                 if (!IS_LOCAL(dest))
 301                         return MODEACTION_ALLOW;
 302
 303                 if (adding)
 304                 {
 305                         if(!dest->IsModeSet('x'))
 306                         {
 307                                 /* The mode is being turned on - so attempt to
 308                                  * allocate the user a cloaked host using a non-reversible
 309                                  * algorithm (its simple, but its non-reversible so the
 310                                  * simplicity doesnt really matter). This algorithm
 311                                  * will not work if the user has only one level of domain
 312                                  * naming in their hostname (e.g. if they are on a lan or
 313                                  * are connecting via localhost) -- this doesnt matter much.
 314                                  */
 315
 316                                 if (strchr(dest->host,'.') || strchr(dest->host,':'))
 317                                 {
 318                                         /* InspIRCd users have two hostnames; A displayed
 319                                          * hostname which can be modified by modules (e.g.
 320                                          * to create vhosts, implement chghost, etc) and a
 321                                          * 'real' hostname which you shouldnt write to.
 322                                          */
 323
 324                                         char* n = strstr(dest->host,".");
 325                                         if (!n)
 326                                                 n = strstr(dest->host,":");
 327
 328                                         std::string a = n;
 329
 330                                         char ra[64];
 331                                         this->GenHash(dest->host,ra);
 332                                         std::string b;
 333                                         insp_inaddr testaddr;
 334                                         std::string hostcloak = prefix + "-" + ra + a;
 335
 336                                         /* Fix by brain - if the cloaked host is > the max length of a host (64 bytes
 337                                          * according to the DNS RFC) then tough titty, they get cloaked as an IP.
 338                                          * Their ISP shouldnt go to town on subdomains, or they shouldnt have a kiddie
 339                                          * vhost.
 340                                          */
 341
 342                                         if ((insp_aton(dest->host,&testaddr) < 1) && (hostcloak.length() <= 64))
 343                                         {
 344                                                 // if they have a hostname, make something appropriate
 345                                                 b = hostcloak;
 346                                         }
 347                                         else
 348                                         {
 349                                                 if (b.find(':') == std::string::npos)
 350                                                 {
 351                                                         /* IP4 ip */
 352                                                         irc::sepstream seps(dest->host, '.');
 353                                                         char ra1[64], ra2[64], ra3[64], ra4[64];
 354                                                         std::string octet1 = seps.GetToken();
 355                                                         std::string octet2 = seps.GetToken();
 356                                                         std::string octet3 = seps.GetToken();
 357                                                         std::string octet4 = seps.GetToken();
 358                                                         ServerInstance->Log(DEBUG,"oct1=%s, oct2=%s, oct3=%s, oct4=%s", octet1.c_str(), octet2.c_str(), octet3.c_str(), octet4.c_str());
 359                                                         this->GenHash(octet1.c_str(),ra1, (key1+atoi(octet3.c_str())) % 4);
 360                                                         this->GenHash(octet2.c_str(),ra2, (key2+atoi(octet1.c_str())) % 4);
 361                                                         this->GenHash(octet3.c_str(),ra3, (key3+atoi(octet4.c_str())) % 4);
 362                                                         this->GenHash(octet4.c_str(),ra4, (key4+atoi(octet2.c_str())) % 4);
 363                                                         ServerInstance->Log(DEBUG,"ra1=%s, ra2=%s, ra3=%s, ra4=%s", ra1, ra2, ra3, ra4);
 364                                                         /* This is safe as we know the length generated by our genhash is always 16 */
 365                                                         ra1[8] = ra2[8] = ra3[8] = ra4[8] = 0;
 366                                                         b.append(ra1).append(".").append(ra2).append(".").append(ra3).append(".").append(ra4);
 367                                                 }
 368                                                 else
 369                                                 {
 370                                                         /* IP6 ip */
 371                                                         b.append(ra).append(".").append(prefix).append(".cloak");
 372
 373                                                 }
 374                                         }
 375                                         ServerInstance->Log(DEBUG,"cloak: allocated "+b);
 376                                         dest->ChangeDisplayedHost(b.c_str());
 377                                 }
 378
 379                                 dest->SetMode('x',true);
 380                                 return MODEACTION_ALLOW;
 381                         }
 382                 }
 383                 else
 384                 {
 385                         if (dest->IsModeSet('x'))
 386                         {
 387                                 /* User is removing the mode, so just restore their real host
 388                                  * and make it match the displayed one.
 389                                  */
 390                                 dest->ChangeDisplayedHost(dest->host);
 391                                 dest->SetMode('x',false);
 392                                 return MODEACTION_ALLOW;
 393                         }
 394                 }
 395
 396                 return MODEACTION_DENY;
 397         }
 398
 399         void DoRehash()
 400         {
 401                 ConfigReader Conf(ServerInstance);
 402                 key1 = key2 = key3 = key4 = 0;
 403                 key1 = Conf.ReadInteger("cloak","key1",0,false);
 404                 key2 = Conf.ReadInteger("cloak","key2",0,false);
 405                 key3 = Conf.ReadInteger("cloak","key3",0,false);
 406                 key4 = Conf.ReadInteger("cloak","key4",0,false);
 407
 408                 prefix = Conf.ReadValue("cloak","prefix",0);
 409                 if (prefix == "")
 410                 {
 411                         prefix = ServerInstance->Config->Network;
 412                 }
 413                 if (!key1 && !key2 && !key3 && !key4)
 414                 {
 415                         ModuleException ex("You have not defined cloak keys for m_cloaking!!! THIS IS INSECURE AND SHOULD BE CHECKED!");
 416                         throw (ex);
 417                 }
 418         }
 419 };
 420
 421
 422 class ModuleCloaking : public Module
 423 {
 424  private:
 425
 426         CloakUser* cu;
 427
 428  public:
 429         ModuleCloaking(InspIRCd* Me)
 430                 : Module::Module(Me)
 431         {
 432                 /* Create new mode handler object */
 433                 cu = new CloakUser(ServerInstance);
 434
 435                 /* Register it with the core */
 436                 ServerInstance->AddMode(cu, 'x');
 437
 438                 OnRehash("");
 439         }
 440
 441         virtual ~ModuleCloaking()
 442         {
 443                 ServerInstance->Modes->DelMode(cu);
 444                 DELETE(cu);
 445         }
 446
 447         virtual Version GetVersion()
 448         {
 449                 // returns the version number of the module to be
 450                 // listed in /MODULES
 451                 return Version(1,1,0,2,VF_COMMON|VF_VENDOR,API_VERSION);
 452         }
 453
 454         virtual void OnRehash(const std::string &parameter)
 455         {
 456                 cu->DoRehash();
 457         }
 458
 459         void Implements(char* List)
 460         {
 461                 List[I_OnRehash] = 1;
 462         }
 463 };
 464
 465 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
 466
 467 class ModuleCloakingFactory : public ModuleFactory
 468 {
 469  public:
 470         ModuleCloakingFactory()
 471         {
 472         }
 473
 474         ~ModuleCloakingFactory()
 475         {
 476         }
 477
 478         virtual Module * CreateModule(InspIRCd* Me)
 479         {
 480                 return new ModuleCloaking(Me);
 481         }
 482
 483 };
 484
 485
 486 extern "C" void * init_module( void )
 487 {
 488         return new ModuleCloakingFactory;
 489 }