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