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