src/modules/m_cloaking.cpp

   1 /*       +------------------------------------+
   2  *       | Inspire Internet Relay Chat Daemon |
   3  *       +------------------------------------+
   4  *
   5  *  Inspire is copyright (C) 2002-2004 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 <stdio.h>
  31 #include "users.h"
  32 #include "channels.h"
  33 #include "modules.h"
  34
  35 /* $ModDesc: Provides masking of user hostnames */
  36
  37
  38 /* The four core functions - F1 is optimized somewhat */
  39
  40 #define F1(x, y, z) (z ^ (x & (y ^ z)))
  41 #define F2(x, y, z) F1(z, x, y)
  42 #define F3(x, y, z) (x ^ y ^ z)
  43 #define F4(x, y, z) (y ^ (x | ~z))
  44 #define MD5STEP(f,w,x,y,z,in,s) (w += f(x,y,z) + in, w = (w<<s | w>>(32-s)) + x)
  45
  46 typedef unsigned long word32;
  47 typedef unsigned char byte;
  48
  49 struct xMD5Context {
  50         word32 buf[4];
  51         word32 bytes[2];
  52         word32 in[16];
  53 };
  54
  55 class ModuleCloaking : public Module
  56 {
  57  private:
  58
  59          Server *Srv;
  60
  61         void byteSwap(word32 *buf, unsigned words)
  62         {
  63                 byte *p = (byte *)buf;
  64
  65                 do {
  66                         *buf++ = (word32)((unsigned)p[3] << 8 | p[2]) << 16 |
  67                                 ((unsigned)p[1] << 8 | p[0]);
  68                         p += 4;
  69                 } while (--words);
  70         }
  71
  72         void xMD5Init(struct xMD5Context *ctx)
  73         {
  74                 ctx->buf[0] = 0x67452301;
  75                 ctx->buf[1] = 0xefcdab89;
  76                 ctx->buf[2] = 0x98badcfe;
  77                 ctx->buf[3] = 0x10325476;
  78
  79                 ctx->bytes[0] = 0;
  80                 ctx->bytes[1] = 0;
  81         }
  82
  83         void xMD5Update(struct xMD5Context *ctx, byte const *buf, int len)
  84         {
  85                 word32 t;
  86
  87                 /* Update byte count */
  88
  89                 t = ctx->bytes[0];
  90                 if ((ctx->bytes[0] = t + len) < t)
  91                         ctx->bytes[1]++;        /* Carry from low to high */
  92
  93                 t = 64 - (t & 0x3f);    /* Space available in ctx->in (at least 1) */
  94                 if ((unsigned)t > (unsigned)len) {
  95                         memcpy((byte *)ctx->in + 64 - (unsigned)t, buf, len);
  96                         return;
  97                 }
  98                 /* First chunk is an odd size */
  99                 memcpy((byte *)ctx->in + 64 - (unsigned)t, buf, (unsigned)t);
 100                 byteSwap(ctx->in, 16);
 101                 xMD5Transform(ctx->buf, ctx->in);
 102                 buf += (unsigned)t;
 103                 len -= (unsigned)t;
 104
 105                 /* Process data in 64-byte chunks */
 106                 while (len >= 64) {
 107                         memcpy(ctx->in, buf, 64);
 108                         byteSwap(ctx->in, 16);
 109                         xMD5Transform(ctx->buf, ctx->in);
 110                         buf += 64;
 111                         len -= 64;
 112                 }
 113
 114                 /* Handle any remaining bytes of data. */
 115                 memcpy(ctx->in, buf, len);
 116         }
 117
 118         void xMD5Final(byte digest[16], struct xMD5Context *ctx)
 119         {
 120                 int count = (int)(ctx->bytes[0] & 0x3f); /* Bytes in ctx->in */
 121                 byte *p = (byte *)ctx->in + count;      /* First unused byte */
 122
 123                 /* Set the first char of padding to 0x80.  There is always room. */
 124                 *p++ = 0x80;
 125
 126                 /* Bytes of padding needed to make 56 bytes (-8..55) */
 127                 count = 56 - 1 - count;
 128
 129                 if (count < 0) {        /* Padding forces an extra block */
 130                         memset(p, 0, count+8);
 131                         byteSwap(ctx->in, 16);
 132                         xMD5Transform(ctx->buf, ctx->in);
 133                         p = (byte *)ctx->in;
 134                         count = 56;
 135                 }
 136                 memset(p, 0, count+8);
 137                 byteSwap(ctx->in, 14);
 138
 139                 /* Append length in bits and transform */
 140                 ctx->in[14] = ctx->bytes[0] << 3;
 141                 ctx->in[15] = ctx->bytes[1] << 3 | ctx->bytes[0] >> 29;
 142                 xMD5Transform(ctx->buf, ctx->in);
 143
 144                 byteSwap(ctx->buf, 4);
 145                 memcpy(digest, ctx->buf, 16);
 146                 memset(ctx, 0, sizeof(ctx));
 147         }
 148
 149         void xMD5Transform(word32 buf[4], word32 const in[16])
 150         {
 151                 register word32 a, b, c, d;
 152
 153                 a = buf[0];
 154                 b = buf[1];
 155                 c = buf[2];
 156                 d = buf[3];
 157
 158                 MD5STEP(F1, a, b, c, d, in[0] + 0xd76aa478, 7);
 159                 MD5STEP(F1, d, a, b, c, in[1] + 0xe8c7b756, 12);
 160                 MD5STEP(F1, c, d, a, b, in[2] + 0x242070db, 17);
 161                 MD5STEP(F1, b, c, d, a, in[3] + 0xc1bdceee, 22);
 162                 MD5STEP(F1, a, b, c, d, in[4] + 0xf57c0faf, 7);
 163                 MD5STEP(F1, d, a, b, c, in[5] + 0x4787c62a, 12);
 164                 MD5STEP(F1, c, d, a, b, in[6] + 0xa8304613, 17);
 165                 MD5STEP(F1, b, c, d, a, in[7] + 0xfd469501, 22);
 166                 MD5STEP(F1, a, b, c, d, in[8] + 0x698098d8, 7);
 167                 MD5STEP(F1, d, a, b, c, in[9] + 0x8b44f7af, 12);
 168                 MD5STEP(F1, c, d, a, b, in[10] + 0xffff5bb1, 17);
 169                 MD5STEP(F1, b, c, d, a, in[11] + 0x895cd7be, 22);
 170                 MD5STEP(F1, a, b, c, d, in[12] + 0x6b901122, 7);
 171                 MD5STEP(F1, d, a, b, c, in[13] + 0xfd987193, 12);
 172                 MD5STEP(F1, c, d, a, b, in[14] + 0xa679438e, 17);
 173                 MD5STEP(F1, b, c, d, a, in[15] + 0x49b40821, 22);
 174
 175                 MD5STEP(F2, a, b, c, d, in[1] + 0xf61e2562, 5);
 176                 MD5STEP(F2, d, a, b, c, in[6] + 0xc040b340, 9);
 177                 MD5STEP(F2, c, d, a, b, in[11] + 0x265e5a51, 14);
 178                 MD5STEP(F2, b, c, d, a, in[0] + 0xe9b6c7aa, 20);
 179                 MD5STEP(F2, a, b, c, d, in[5] + 0xd62f105d, 5);
 180                 MD5STEP(F2, d, a, b, c, in[10] + 0x02441453, 9);
 181                 MD5STEP(F2, c, d, a, b, in[15] + 0xd8a1e681, 14);
 182                 MD5STEP(F2, b, c, d, a, in[4] + 0xe7d3fbc8, 20);
 183                 MD5STEP(F2, a, b, c, d, in[9] + 0x21e1cde6, 5);
 184                 MD5STEP(F2, d, a, b, c, in[14] + 0xc33707d6, 9);
 185                 MD5STEP(F2, c, d, a, b, in[3] + 0xf4d50d87, 14);
 186                 MD5STEP(F2, b, c, d, a, in[8] + 0x455a14ed, 20);
 187                 MD5STEP(F2, a, b, c, d, in[13] + 0xa9e3e905, 5);
 188                 MD5STEP(F2, d, a, b, c, in[2] + 0xfcefa3f8, 9);
 189                 MD5STEP(F2, c, d, a, b, in[7] + 0x676f02d9, 14);
 190                 MD5STEP(F2, b, c, d, a, in[12] + 0x8d2a4c8a, 20);
 191
 192                 MD5STEP(F3, a, b, c, d, in[5] + 0xfffa3942, 4);
 193                 MD5STEP(F3, d, a, b, c, in[8] + 0x8771f681, 11);
 194                 MD5STEP(F3, c, d, a, b, in[11] + 0x6d9d6122, 16);
 195                 MD5STEP(F3, b, c, d, a, in[14] + 0xfde5380c, 23);
 196                 MD5STEP(F3, a, b, c, d, in[1] + 0xa4beea44, 4);
 197                 MD5STEP(F3, d, a, b, c, in[4] + 0x4bdecfa9, 11);
 198                 MD5STEP(F3, c, d, a, b, in[7] + 0xf6bb4b60, 16);
 199                 MD5STEP(F3, b, c, d, a, in[10] + 0xbebfbc70, 23);
 200                 MD5STEP(F3, a, b, c, d, in[13] + 0x289b7ec6, 4);
 201                 MD5STEP(F3, d, a, b, c, in[0] + 0xeaa127fa, 11);
 202                 MD5STEP(F3, c, d, a, b, in[3] + 0xd4ef3085, 16);
 203                 MD5STEP(F3, b, c, d, a, in[6] + 0x04881d05, 23);
 204                 MD5STEP(F3, a, b, c, d, in[9] + 0xd9d4d039, 4);
 205                 MD5STEP(F3, d, a, b, c, in[12] + 0xe6db99e5, 11);
 206                 MD5STEP(F3, c, d, a, b, in[15] + 0x1fa27cf8, 16);
 207                 MD5STEP(F3, b, c, d, a, in[2] + 0xc4ac5665, 23);
 208
 209                 MD5STEP(F4, a, b, c, d, in[0] + 0xf4292244, 6);
 210                 MD5STEP(F4, d, a, b, c, in[7] + 0x432aff97, 10);
 211                 MD5STEP(F4, c, d, a, b, in[14] + 0xab9423a7, 15);
 212                 MD5STEP(F4, b, c, d, a, in[5] + 0xfc93a039, 21);
 213                 MD5STEP(F4, a, b, c, d, in[12] + 0x655b59c3, 6);
 214                 MD5STEP(F4, d, a, b, c, in[3] + 0x8f0ccc92, 10);
 215                 MD5STEP(F4, c, d, a, b, in[10] + 0xffeff47d, 15);
 216                 MD5STEP(F4, b, c, d, a, in[1] + 0x85845dd1, 21);
 217                 MD5STEP(F4, a, b, c, d, in[8] + 0x6fa87e4f, 6);
 218                 MD5STEP(F4, d, a, b, c, in[15] + 0xfe2ce6e0, 10);
 219                 MD5STEP(F4, c, d, a, b, in[6] + 0xa3014314, 15);
 220                 MD5STEP(F4, b, c, d, a, in[13] + 0x4e0811a1, 21);
 221                 MD5STEP(F4, a, b, c, d, in[4] + 0xf7537e82, 6);
 222                 MD5STEP(F4, d, a, b, c, in[11] + 0xbd3af235, 10);
 223                 MD5STEP(F4, c, d, a, b, in[2] + 0x2ad7d2bb, 15);
 224                 MD5STEP(F4, b, c, d, a, in[9] + 0xeb86d391, 21);
 225
 226                 buf[0] += a;
 227                 buf[1] += b;
 228                 buf[2] += c;
 229                 buf[3] += d;
 230         }
 231
 232
 233         void MyMD5(void *dest, void *orig, int len)
 234         {
 235                 struct xMD5Context context;
 236
 237                 xMD5Init(&context);
 238                 xMD5Update(&context, (const unsigned char*)orig, len);
 239                 xMD5Final((unsigned char*)dest, &context);
 240         }
 241
 242
 243         void GenHash(char* src, char* dest)
 244         {
 245                 // purposefully lossy md5 - only gives them the most significant 4 bits
 246                 // of every md5 output byte.
 247                 int i = 0;
 248                 unsigned char bytes[16];
 249                 char hash[MAXBUF];
 250                 strcpy(hash,"");
 251                 MyMD5((char*)bytes,src,strlen(src));
 252                 for (i = 0; i < 16; i++)
 253                 {
 254                         const char* xtab = "F92E45D871BCA630";
 255                         unsigned char hi = xtab[bytes[i] / 16];
 256                         char hx[2];
 257                         hx[0] = hi;
 258                         hx[1] = '\0';
 259                         strlcat(hash,hx,MAXBUF);
 260                 }
 261                 strlcpy(dest,hash,MAXBUF);
 262         }
 263
 264  public:
 265         ModuleCloaking()
 266         {
 267                 // We must create an instance of the Server class to work with
 268                 Srv = new Server;
 269
 270                 // we must create a new mode. Set the parameters so the
 271                 // mode doesn't require oper, and is a client usermode
 272                 // with no parameters (actually, you cant have params for a umode!)
 273                 if (!Srv->AddExtendedMode('x',MT_CLIENT,false,0,0))
 274                 {
 275                         // we couldn't claim mode x... possibly anther module has it,
 276                         // this might become likely to happen if there are a lot of 3rd
 277                         // party modules around in the future -- any 3rd party modules
 278                         // SHOULD implement a system of configurable mode letters (e.g.
 279                         // from a config file)
 280                         Srv->Log(DEFAULT,"*** m_cloaking: ERROR, failed to allocate user mode +x!");
 281                         printf("Could not claim usermode +x for this module!");
 282                         return;
 283                 }
 284         }
 285
 286         virtual ~ModuleCloaking()
 287         {
 288                 // not really neccessary, but free it anyway
 289                 delete Srv;
 290         }
 291
 292         virtual Version GetVersion()
 293         {
 294                 // returns the version number of the module to be
 295                 // listed in /MODULES
 296                 return Version(1,0,0,1,VF_STATIC|VF_VENDOR);
 297         }
 298
 299         virtual int OnExtendedMode(userrec* user, void* target, char modechar, int type, bool mode_on, string_list &params)
 300         {
 301                 // this method is called for any extended mode character.
 302                 // all module modes for all modules pass through here
 303                 // (unless another module further up the chain claims them)
 304                 // so we must be VERY careful to only act upon modes which
 305                 // we have claimed ourselves. This is a feature to allow
 306                 // modules to 'spy' on extended mode activity if they so wish.
 307                 if ((modechar == 'x') && (type == MT_CLIENT))
 308                 {
 309                         // OnExtendedMode gives us a void* as the target, we must cast
 310                         // it into a userrec* or a chanrec* depending on the value of
 311                         // the 'type' parameter (MT_CLIENT or MT_CHANNEL)
 312                         userrec* dest = (userrec*)target;
 313
 314                         // we've now determined that this is our mode character...
 315                         // is the user adding the mode to their list or removing it?
 316                         if (mode_on)
 317                         {
 318                                 // the mode is being turned on - so attempt to
 319                                 // allocate the user a cloaked host using a non-reversible
 320                                 // algorithm (its simple, but its non-reversible so the
 321                                 // simplicity doesnt really matter). This algorithm
 322                                 // will not work if the user has only one level of domain
 323                                 // naming in their hostname (e.g. if they are on a lan or
 324                                 // are connecting via localhost) -- this doesnt matter much.
 325                                 if (strchr(dest->host,'.'))
 326                                 {
 327                                         // in inspircd users have two hostnames. A displayed
 328                                         // hostname which can be modified by modules (e.g.
 329                                         // to create vhosts, implement chghost, etc) and a
 330                                         // 'real' hostname which you shouldnt write to.
 331                                         std::string a = strstr(dest->host,".");
 332                                         char ra[64];
 333                                         this->GenHash(dest->host,ra);
 334                                         std::string b = "";
 335                                         in_addr testaddr;
 336                                         if (!inet_aton(dest->host,&testaddr))
 337                                         {
 338                                                 // if they have a hostname, make something appropriate
 339                                                 b = Srv->GetNetworkName() + "-" + std::string(ra) + a;
 340                                         }
 341                                         else
 342                                         {
 343                                                 // else, they have an ip
 344                                                 b = std::string(ra) + "." + Srv->GetNetworkName() + ".cloak";
 345                                         }
 346                                         Srv->Log(DEBUG,"cloak: allocated "+b);
 347                                         Srv->ChangeHost(dest,b);
 348                                 }
 349                         }
 350                         else
 351                         {
 352                                 // user is removing the mode, so just restore their real host
 353                                 // and make it match the displayed one.
 354                                 Srv->ChangeHost(dest,dest->host);
 355                         }
 356                         // this mode IS ours, and we have handled it. If we chose not to handle it,
 357                         // for example the user cannot cloak as they have a vhost or such, then
 358                         // we could return 0 here instead of 1 and the core would not send the mode
 359                         // change to the user.
 360                         return 1;
 361                 }
 362                 else
 363                 {
 364                         // this mode isn't ours, we have to bail and return 0 to not handle it.
 365                         return 0;
 366                 }
 367         }
 368
 369         virtual void OnUserConnect(userrec* user)
 370         {
 371                 // Heres the weird bit. When a user connects we must set +x on them, so
 372                 // we're going to use the SendMode method of the Server class to send
 373                 // the mode to the client. This is basically the same as sending an
 374                 // SAMODE in unreal. Note that to the user it will appear as if they set
 375                 // the mode on themselves.
 376
 377                 char* modes[2];                 // only two parameters
 378                 modes[0] = user->nick;          // first parameter is the nick
 379                 modes[1] = "+x";                // second parameter is the mode
 380                 Srv->SendMode(modes,2,user);    // send these, forming the command "MODE <nick> +x"
 381         }
 382
 383 };
 384
 385 // stuff down here is the module-factory stuff. For basic modules you can ignore this.
 386
 387 class ModuleCloakingFactory : public ModuleFactory
 388 {
 389  public:
 390         ModuleCloakingFactory()
 391         {
 392         }
 393
 394         ~ModuleCloakingFactory()
 395         {
 396         }
 397
 398         virtual Module * CreateModule()
 399         {
 400                 return new ModuleCloaking;
 401         }
 402
 403 };
 404
 405
 406 extern "C" void * init_module( void )
 407 {
 408         return new ModuleCloakingFactory;
 409 }
 410