ircd/IPcheck.c

   1 /*
   2  * IRC - Internet Relay Chat, ircd/IPcheck.c
   3  * Copyright (C) 1998 Carlo Wood ( Run @ undernet.org )
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2, or (at your option)
   8  * any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  *
  19  * $Id$
  20  *
  21  *
  22  * This file should be edited in a window with a width of 141 characters
  23  * ick
  24  */
  25 #include "config.h"
  26
  27 #include "IPcheck.h"
  28 #include "client.h"
  29 #include "ircd.h"
  30 #include "msg.h"
  31 #include "numnicks.h"       /* NumNick, NumServ (GODMODE) */
  32 #include "ircd_alloc.h"
  33 #include "ircd_events.h"
  34 #include "ircd_features.h"
  35 #include "s_debug.h"        /* Debug */
  36 #include "s_user.h"         /* TARGET_DELAY */
  37 #include "send.h"
  38
  39 #include <assert.h>
  40 #include <string.h>
  41
  42 struct IPTargetEntry {
  43   int           count;
  44   unsigned char targets[MAXTARGETS];
  45 };
  46
  47 struct IPRegistryEntry {
  48   struct IPRegistryEntry*  next;
  49   struct IPTargetEntry*    target;
  50   unsigned int             addr;
  51   int                      last_connect;
  52   unsigned short           connected;
  53   unsigned char            attempts;
  54 };
  55
  56 /*
  57  * Hash table for IPv4 address registry
  58  *
  59  * Hash table size must be a power of 2
  60  * Use 64K hash table to conserve memory
  61  */
  62 #define IP_REGISTRY_TABLE_SIZE 0x10000
  63 #define MASK_16                0xffff
  64
  65 #define NOW ((unsigned short)(CurrentTime & MASK_16))
  66 #define CONNECTED_SINCE(x) (NOW - (x))
  67
  68 #define IPCHECK_CLONE_LIMIT feature_int(FEAT_IPCHECK_CLONE_LIMIT)
  69 #define IPCHECK_CLONE_PERIOD feature_int(FEAT_IPCHECK_CLONE_PERIOD)
  70 #define IPCHECK_CLONE_DELAY feature_int(FEAT_IPCHECK_CLONE_DELAY)
  71
  72
  73 static struct IPRegistryEntry* hashTable[IP_REGISTRY_TABLE_SIZE];
  74 static struct IPRegistryEntry* freeList = 0;
  75
  76 static struct Timer expireTimer;
  77
  78 static unsigned int ip_registry_hash(unsigned int ip)
  79 {
  80   return ((ip >> 16) ^ ip) & (IP_REGISTRY_TABLE_SIZE - 1);
  81 }
  82
  83 static struct IPRegistryEntry* ip_registry_find(unsigned int ip)
  84 {
  85   struct IPRegistryEntry* entry = hashTable[ip_registry_hash(ip)];
  86   for ( ; entry; entry = entry->next) {
  87     if (entry->addr == ip)
  88       break;
  89   }
  90   return entry;
  91 }
  92
  93 static void ip_registry_add(struct IPRegistryEntry* entry)
  94 {
  95   unsigned int bucket = ip_registry_hash(entry->addr);
  96   entry->next = hashTable[bucket];
  97   hashTable[bucket] = entry;
  98 }
  99
 100 static void ip_registry_remove(struct IPRegistryEntry* entry)
 101 {
 102   unsigned int bucket = ip_registry_hash(entry->addr);
 103   if (hashTable[bucket] == entry)
 104     hashTable[bucket] = entry->next;
 105   else {
 106     struct IPRegistryEntry* prev = hashTable[bucket];
 107     for ( ; prev; prev = prev->next) {
 108       if (prev->next == entry) {
 109         prev->next = entry->next;
 110         break;
 111       }
 112     }
 113   }
 114 }
 115
 116 static struct IPRegistryEntry* ip_registry_new_entry()
 117 {
 118   struct IPRegistryEntry* entry = freeList;
 119   if (entry)
 120     freeList = entry->next;
 121   else
 122     entry = (struct IPRegistryEntry*) MyMalloc(sizeof(struct IPRegistryEntry));
 123
 124   assert(0 != entry);
 125   memset(entry, 0, sizeof(struct IPRegistryEntry));
 126   entry->last_connect = NOW;     /* Seconds since last connect attempt */
 127   entry->connected    = 1;       /* connected clients for this IP */
 128   entry->attempts     = 1;       /* Number attempts for this IP */
 129   return entry;
 130 }
 131
 132 static void ip_registry_delete_entry(struct IPRegistryEntry* entry)
 133 {
 134   if (entry->target)
 135     MyFree(entry->target);
 136   entry->next = freeList;
 137   freeList = entry;
 138 }
 139
 140 static unsigned int ip_registry_update_free_targets(struct IPRegistryEntry* entry)
 141 {
 142   unsigned int free_targets = STARTTARGETS;
 143
 144   if (entry->target) {
 145     free_targets = entry->target->count + (CONNECTED_SINCE(entry->last_connect) / TARGET_DELAY);
 146     if (free_targets > STARTTARGETS)
 147       free_targets = STARTTARGETS;
 148     entry->target->count = free_targets;
 149   }
 150   return free_targets;
 151 }
 152
 153 static void ip_registry_expire_entry(struct IPRegistryEntry* entry)
 154 {
 155   /*
 156    * Don't touch this number, it has statistical significance
 157    * XXX - blah blah blah
 158    */
 159   if (CONNECTED_SINCE(entry->last_connect) > 600) {
 160     /*
 161      * expired
 162      */
 163     ip_registry_remove(entry);
 164     ip_registry_delete_entry(entry);
 165   }
 166   else if (CONNECTED_SINCE(entry->last_connect) > 120 && 0 != entry->target) {
 167     /*
 168      * Expire storage of targets
 169      */
 170     MyFree(entry->target);
 171     entry->target = 0;
 172   }
 173 }
 174
 175 /* Callback to run an expiry of the IPcheck registry */
 176 static void ip_registry_expire(struct Event* ev)
 177 {
 178   int i;
 179   struct IPRegistryEntry* entry;
 180   struct IPRegistryEntry* entry_next;
 181
 182   assert(ET_EXPIRE == ev_type(ev));
 183   assert(0 != ev_timer(ev));
 184
 185   for (i = 0; i < IP_REGISTRY_TABLE_SIZE; ++i) {
 186     for (entry = hashTable[i]; entry; entry = entry_next) {
 187       entry_next = entry->next;
 188       if (0 == entry->connected)
 189         ip_registry_expire_entry(entry);
 190     }
 191   }
 192 }
 193
 194 /*
 195  * IPcheck_init()
 196  *
 197  * Initializes the registry timer
 198  */
 199 void IPcheck_init(void)
 200 {
 201   timer_add(timer_init(&expireTimer), ip_registry_expire, 0, TT_PERIODIC, 60);
 202 }
 203
 204 /*
 205  * IPcheck_local_connect
 206  *
 207  * Event:
 208  *   A new connection was accept()-ed with IP number `cptr->ip.s_addr'.
 209  *
 210  * Action:
 211  *   Update the IPcheck registry.
 212  *   Return:
 213  *     1 : You're allowed to connect.
 214  *     0 : You're not allowed to connect.
 215  *
 216  * Throttling:
 217  *
 218  * A connection should be rejected when a connection from the same IP number was
 219  * received IPCHECK_CLONE_LIMIT times before this connect attempt, with
 220  * reconnect intervals of IPCHECK_CLONE_PERIOD seconds or less.
 221  *
 222  * Free target inheritance:
 223  *
 224  * When the client is accepted, then the number of Free Targets
 225  * of the cptr is set to the value stored in the found IPregistry
 226  * structure, or left at STARTTARGETS.  This can be done by changing
 227  * cptr->nexttarget to be `now - (TARGET_DELAY * (FREE_TARGETS - 1))',
 228  * where FREE_TARGETS may range from 0 till STARTTARGETS.
 229  */
 230 int ip_registry_check_local(unsigned int addr, time_t* next_target_out)
 231 {
 232   struct IPRegistryEntry* entry = ip_registry_find(addr);
 233   unsigned int free_targets = STARTTARGETS;
 234
 235   if (0 == entry) {
 236     entry       = ip_registry_new_entry();
 237     entry->addr = addr;    /* The IP number of registry entry */
 238     ip_registry_add(entry);
 239     return 1;
 240   }
 241   /* Note that this also connects server connects.
 242    * It is hard and not interesting, to change that.
 243    *
 244    * Don't allow more then 255 connects from one IP number, ever
 245    */
 246   if (0 == ++entry->connected)
 247     return 0;
 248
 249   if (CONNECTED_SINCE(entry->last_connect) > IPCHECK_CLONE_PERIOD)
 250     entry->attempts = 0;
 251
 252   free_targets = ip_registry_update_free_targets(entry);
 253   entry->last_connect = NOW;
 254
 255   if (0 == ++entry->attempts)   /* Check for overflow */
 256     --entry->attempts;
 257
 258   if (entry->attempts < IPCHECK_CLONE_LIMIT) {
 259     if (next_target_out)
 260       *next_target_out = CurrentTime - (TARGET_DELAY * free_targets - 1);
 261   }
 262   else if ((CurrentTime - cli_since(&me)) > IPCHECK_CLONE_DELAY) {
 263     /*
 264      * Don't refuse connection when we just rebooted the server
 265      */
 266 #ifdef NOTHROTTLE
 267     return 1;
 268 #else
 269     --entry->connected;
 270     return 0;
 271 #endif
 272   }
 273   return 1;
 274 }
 275
 276 /*
 277  * IPcheck_remote_connect
 278  *
 279  * Event:
 280  *   A remote client connected to Undernet, with IP number `cptr->ip.s_addr'
 281  *   and hostname `hostname'.
 282  *
 283  * Action:
 284  *   Update the IPcheck registry.
 285  *   Return 0 on failure, 1 on success.
 286  */
 287 int ip_registry_check_remote(struct Client* cptr, int is_burst)
 288 {
 289   struct IPRegistryEntry* entry = ip_registry_find((cli_ip(cptr)).s_addr);
 290
 291   /*
 292    * Mark that we did add/update an IPregistry entry
 293    */
 294   SetIPChecked(cptr);
 295   if (0 == entry) {
 296     entry = ip_registry_new_entry();
 297     entry->addr = (cli_ip(cptr)).s_addr;
 298     if (is_burst)
 299       entry->attempts = 0;
 300     ip_registry_add(entry);
 301   }
 302   else {
 303     if (0 == ++entry->connected) {
 304       /*
 305        * Don't allow more then 255 connects from one IP number, ever
 306        */
 307       return 0;
 308     }
 309     if (CONNECTED_SINCE(entry->last_connect) > IPCHECK_CLONE_PERIOD)
 310       entry->attempts = 0;
 311     if (!is_burst) {
 312       if (0 == ++entry->attempts) {
 313         /*
 314          * Check for overflow
 315          */
 316         --entry->attempts;
 317       }
 318       ip_registry_update_free_targets(entry);
 319       entry->last_connect = NOW;
 320     }
 321   }
 322   return 1;
 323 }
 324
 325 /*
 326  * IPcheck_connect_fail
 327  *
 328  * Event:
 329  *   This local client failed to connect due to legal reasons.
 330  *
 331  * Action:
 332  *   Neutralize the effect of calling IPcheck_local_connect, in such
 333  *   a way that the client won't be penalized when trying to reconnect
 334  *   again.
 335  */
 336 void ip_registry_connect_fail(unsigned int addr)
 337 {
 338   struct IPRegistryEntry* entry = ip_registry_find(addr);
 339   if (entry)
 340     --entry->attempts;
 341 }
 342
 343 /*
 344  * IPcheck_connect_succeeded
 345  *
 346  * Event:
 347  *   A client succeeded to finish the registration.
 348  *
 349  * Finish IPcheck registration of a successfully, locally connected client.
 350  */
 351 void ip_registry_connect_succeeded(struct Client *cptr)
 352 {
 353   const char*             tr    = "";
 354   unsigned int free_targets     = STARTTARGETS;
 355   struct IPRegistryEntry* entry = ip_registry_find((cli_ip(cptr)).s_addr);
 356
 357   if (!entry) {
 358     Debug((DEBUG_ERROR, "Missing registry entry for: %s", cli_sock_ip(cptr)));
 359     return;
 360   }
 361   if (entry->target) {
 362     memcpy(cli_targets(cptr), entry->target->targets, MAXTARGETS);
 363     free_targets = entry->target->count;
 364     tr = " tr";
 365   }
 366   sendcmdto_one(&me, CMD_NOTICE, cptr, "%C :on %u ca %u(%u) ft %u(%u)%s",
 367                 cptr, entry->connected, entry->attempts, IPCHECK_CLONE_LIMIT,
 368                 free_targets, STARTTARGETS, tr);
 369 }
 370
 371 /*
 372  * IPcheck_disconnect
 373  *
 374  * Event:
 375  *   A local client disconnected or a remote client left Undernet.
 376  *
 377  * Action:
 378  *   Update the IPcheck registry.
 379  *   Remove all expired IPregistry structures from the hash bucket
 380  *     that belongs to this clients IP number.
 381  */
 382 void ip_registry_disconnect(struct Client *cptr)
 383 {
 384   struct IPRegistryEntry* entry = ip_registry_find((cli_ip(cptr)).s_addr);
 385   if (0 == entry) {
 386     /*
 387      * trying to find an entry for a server causes this to happen,
 388      * servers should never have FLAG_IPCHECK set
 389      */
 390     return;
 391   }
 392   /*
 393    * If this was the last one, set `last_connect' to disconnect time (used for expiration)
 394    */
 395   if (0 == --entry->connected) {
 396     if (CONNECTED_SINCE(entry->last_connect) > IPCHECK_CLONE_LIMIT * IPCHECK_CLONE_PERIOD) {
 397       /*
 398        * Otherwise we'd penetalize for this old value if the client reconnects within 20 seconds
 399        */
 400       entry->attempts = 0;
 401     }
 402     ip_registry_update_free_targets(entry);
 403     entry->last_connect = NOW;
 404   }
 405   if (MyConnect(cptr)) {
 406     unsigned int free_targets;
 407     /*
 408      * Copy the clients targets
 409      */
 410     if (0 == entry->target) {
 411       entry->target = (struct IPTargetEntry*) MyMalloc(sizeof(struct IPTargetEntry));
 412       entry->target->count = STARTTARGETS;
 413     }
 414     assert(0 != entry->target);
 415
 416     memcpy(entry->target->targets, cli_targets(cptr), MAXTARGETS);
 417     /*
 418      * This calculation can be pretty unfair towards large multi-user hosts, but
 419      * there is "nothing" we can do without also allowing spam bots to send more
 420      * messages or by drastically increasing the ammount of memory used in the IPregistry.
 421      *
 422      * The problem is that when a client disconnects, leaving no free targets, then
 423      * the next client from that IP number has to pay for it (getting no free targets).
 424      * But ALSO the next client, and the next client, and the next client etc - until
 425      * another client disconnects that DOES leave free targets.  The reason for this
 426      * is that if there are 10 SPAM bots, and they all disconnect at once, then they
 427      * ALL should get no free targets when reconnecting.  We'd need to store an entry
 428      * per client (instead of per IP number) to avoid this.
 429      */
 430     if (cli_nexttarget(cptr) < CurrentTime) {
 431         /*
 432          * Number of free targets
 433          */
 434       free_targets = (CurrentTime - cli_nexttarget(cptr)) / TARGET_DELAY + 1;
 435     }
 436     else
 437       free_targets = 0;
 438     /*
 439      * Add bonus, this is pretty fuzzy, but it will help in some cases.
 440      */
 441     if ((CurrentTime - cli_firsttime(cptr)) > 600)
 442       /*
 443        * Was longer then 10 minutes online?
 444        */
 445       free_targets += (CurrentTime - cli_firsttime(cptr) - 600) / TARGET_DELAY;
 446     /*
 447      * Finally, store smallest value for Judgement Day
 448      */
 449     if (free_targets < entry->target->count)
 450       entry->target->count = free_targets;
 451   }
 452 }
 453
 454 /*
 455  * IPcheck_nr
 456  *
 457  * Returns number of clients with the same IP number
 458  */
 459 int ip_registry_count(unsigned int addr)
 460 {
 461   struct IPRegistryEntry* entry = ip_registry_find(addr);
 462   return (entry) ? entry->connected : 0;
 463 }
 464
 465 /*
 466  * IPcheck_local_connect
 467  *
 468  * Event:
 469  *   A new connection was accept()-ed with IP number `cptr->ip.s_addr'.
 470  *
 471  * Action:
 472  *   Update the IPcheck registry.
 473  *   Return:
 474  *     1 : You're allowed to connect.
 475  *     0 : You're not allowed to connect.
 476  *
 477  * Throttling:
 478  *
 479  * A connection should be rejected when a connection from the same IP number was
 480  * received IPCHECK_CLONE_LIMIT times before this connect attempt, with
 481  * reconnect intervals of IPCHECK_CLONE_PERIOD seconds or less.
 482  *
 483  * Free target inheritance:
 484  *
 485  * When the client is accepted, then the number of Free Targets
 486  * of the cptr is set to the value stored in the found IPregistry
 487  * structure, or left at STARTTARGETS.  This can be done by changing
 488  * cptr->nexttarget to be `now - (TARGET_DELAY * (FREE_TARGETS - 1))',
 489  * where FREE_TARGETS may range from 0 till STARTTARGETS.
 490  */
 491 int IPcheck_local_connect(struct in_addr a, time_t* next_target_out)
 492 {
 493   assert(0 != next_target_out);
 494   return ip_registry_check_local(a.s_addr, next_target_out);
 495 }
 496
 497 /*
 498  * IPcheck_remote_connect
 499  *
 500  * Event:
 501  *   A remote client connected to Undernet, with IP number `cptr->ip.s_addr'
 502  *   and hostname `hostname'.
 503  *
 504  * Action:
 505  *   Update the IPcheck registry.
 506  *   Return 0 on failure, 1 on success.
 507  */
 508 int IPcheck_remote_connect(struct Client *cptr, int is_burst)
 509 {
 510   assert(0 != cptr);
 511   return ip_registry_check_remote(cptr, is_burst);
 512 }
 513
 514 /*
 515  * IPcheck_connect_fail
 516  *
 517  * Event:
 518  *   This local client failed to connect due to legal reasons.
 519  *
 520  * Action:
 521  *   Neutralize the effect of calling IPcheck_local_connect, in such
 522  *   a way that the client won't be penalized when trying to reconnect
 523  *   again.
 524  */
 525 void IPcheck_connect_fail(struct in_addr a)
 526 {
 527   ip_registry_connect_fail(a.s_addr);
 528 }
 529
 530 /*
 531  * IPcheck_connect_succeeded
 532  *
 533  * Event:
 534  *   A client succeeded to finish the registration.
 535  *
 536  * Finish IPcheck registration of a successfully, locally connected client.
 537  */
 538 void IPcheck_connect_succeeded(struct Client *cptr)
 539 {
 540   assert(0 != cptr);
 541   ip_registry_connect_succeeded(cptr);
 542 }
 543
 544 /*
 545  * IPcheck_disconnect
 546  *
 547  * Event:
 548  *   A local client disconnected or a remote client left Undernet.
 549  *
 550  * Action:
 551  *   Update the IPcheck registry.
 552  *   Remove all expired IPregistry structures from the hash bucket
 553  *     that belongs to this clients IP number.
 554  */
 555 void IPcheck_disconnect(struct Client *cptr)
 556 {
 557   assert(0 != cptr);
 558   ip_registry_disconnect(cptr);
 559 }
 560
 561 /*
 562  * IPcheck_nr
 563  *
 564  * Returns number of clients with the same IP number
 565  */
 566 unsigned short IPcheck_nr(struct Client *cptr)
 567 {
 568   assert(0 != cptr);
 569   return ip_registry_count(cli_ip(cptr).s_addr);
 570 }