src/ngircd/client.c

   1 /*
   2  * ngIRCd -- The Next Generation IRC Daemon
   3  * Copyright (c)2001-2010 Alexander Barton (alex@barton.de)
   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 of the License, or
   8  * (at your option) any later version.
   9  * Please read the file COPYING, README and AUTHORS for more information.
  10  */
  11
  12 #define __client_c__
  13
  14 #include "portab.h"
  15
  16 /**
  17  * @file
  18  * Client management.
  19  */
  20
  21 #include "imp.h"
  22 #include <assert.h>
  23 #include <unistd.h>
  24 #include <stdio.h>
  25 #include <stdlib.h>
  26 #include <string.h>
  27 #include <strings.h>
  28 #include <netdb.h>
  29
  30 #include "defines.h"
  31 #include "conn.h"
  32
  33 #include "exp.h"
  34 #include "client.h"
  35
  36 #include <imp.h>
  37 #include "ngircd.h"
  38 #include "channel.h"
  39 #include "conf.h"
  40 #include "conn-func.h"
  41 #include "hash.h"
  42 #include "irc-write.h"
  43 #include "log.h"
  44 #include "messages.h"
  45
  46 #include <exp.h>
  47
  48 #define GETID_LEN (CLIENT_NICK_LEN-1) + 1 + (CLIENT_USER_LEN-1) + 1 + (CLIENT_HOST_LEN-1) + 1
  49
  50 static CLIENT *This_Server, *My_Clients;
  51
  52 static WHOWAS My_Whowas[MAX_WHOWAS];
  53 static int Last_Whowas = -1;
  54 static long Max_Users, My_Max_Users;
  55
  56
  57 static unsigned long Count PARAMS(( CLIENT_TYPE Type ));
  58 static unsigned long MyCount PARAMS(( CLIENT_TYPE Type ));
  59
  60 static CLIENT *New_Client_Struct PARAMS(( void ));
  61 static void Generate_MyToken PARAMS(( CLIENT *Client ));
  62 static void Adjust_Counters PARAMS(( CLIENT *Client ));
  63
  64 static CLIENT *Init_New_Client PARAMS((CONN_ID Idx, CLIENT *Introducer,
  65                                        CLIENT *TopServer, int Type, const char *ID,
  66                                        const char *User, const char *Hostname, const char *Info,
  67                                        int Hops, int Token, const char *Modes,
  68                                        bool Idented));
  69
  70 static void Destroy_UserOrService PARAMS((CLIENT *Client,const char *Txt, const char *FwdMsg,
  71                                         bool SendQuit));
  72
  73 static void cb_introduceClient PARAMS((CLIENT *Client, CLIENT *Prefix,
  74                                        void *i));
  75
  76 GLOBAL void
  77 Client_Init( void )
  78 {
  79         struct hostent *h;
  80
  81         This_Server = New_Client_Struct( );
  82         if( ! This_Server )
  83         {
  84                 Log( LOG_EMERG, "Can't allocate client structure for server! Going down." );
  85                 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
  86                 exit( 1 );
  87         }
  88
  89         /* Client-Struktur dieses Servers */
  90         This_Server->next = NULL;
  91         This_Server->type = CLIENT_SERVER;
  92         This_Server->conn_id = NONE;
  93         This_Server->introducer = This_Server;
  94         This_Server->mytoken = 1;
  95         This_Server->hops = 0;
  96
  97         gethostname( This_Server->host, CLIENT_HOST_LEN );
  98         if (Conf_DNS) {
  99                 h = gethostbyname( This_Server->host );
 100                 if (h) strlcpy(This_Server->host, h->h_name, sizeof(This_Server->host));
 101         }
 102         Client_SetID( This_Server, Conf_ServerName );
 103         Client_SetInfo( This_Server, Conf_ServerInfo );
 104
 105         My_Clients = This_Server;
 106
 107         memset( &My_Whowas, 0, sizeof( My_Whowas ));
 108 } /* Client_Init */
 109
 110
 111 GLOBAL void
 112 Client_Exit( void )
 113 {
 114         CLIENT *c, *next;
 115         int cnt;
 116
 117         if( NGIRCd_SignalRestart ) Client_Destroy( This_Server, "Server going down (restarting).", NULL, false );
 118         else Client_Destroy( This_Server, "Server going down.", NULL, false );
 119
 120         cnt = 0;
 121         c = My_Clients;
 122         while( c )
 123         {
 124                 cnt++;
 125                 next = (CLIENT *)c->next;
 126                 free( c );
 127                 c = next;
 128         }
 129         if( cnt ) Log( LOG_INFO, "Freed %d client structure%s.", cnt, cnt == 1 ? "" : "s" );
 130 } /* Client_Exit */
 131
 132
 133 GLOBAL CLIENT *
 134 Client_ThisServer( void )
 135 {
 136         return This_Server;
 137 } /* Client_ThisServer */
 138
 139
 140 /**
 141  * Initialize new local client; wrapper function for Init_New_Client().
 142  * @return New CLIENT structure.
 143  */
 144 GLOBAL CLIENT *
 145 Client_NewLocal(CONN_ID Idx, const char *Hostname, int Type, bool Idented)
 146 {
 147         return Init_New_Client(Idx, This_Server, NULL, Type, NULL, NULL,
 148                 Hostname, NULL, 0, 0, NULL, Idented);
 149 } /* Client_NewLocal */
 150
 151
 152 /**
 153  * Initialize new remote server; wrapper function for Init_New_Client().
 154  * @return New CLIENT structure.
 155  */
 156 GLOBAL CLIENT *
 157 Client_NewRemoteServer(CLIENT *Introducer, const char *Hostname, CLIENT *TopServer,
 158  int Hops, int Token, const char *Info, bool Idented)
 159 {
 160         return Init_New_Client(NONE, Introducer, TopServer, CLIENT_SERVER,
 161                 Hostname, NULL, Hostname, Info, Hops, Token, NULL, Idented);
 162 } /* Client_NewRemoteServer */
 163
 164
 165 /**
 166  * Initialize new remote client; wrapper function for Init_New_Client().
 167  * @return New CLIENT structure.
 168  */
 169 GLOBAL CLIENT *
 170 Client_NewRemoteUser(CLIENT *Introducer, const char *Nick, int Hops, const char *User,
 171  const char *Hostname, int Token, const char *Modes, const char *Info, bool Idented)
 172 {
 173         return Init_New_Client(NONE, Introducer, NULL, CLIENT_USER, Nick,
 174                 User, Hostname, Info, Hops, Token, Modes, Idented);
 175 } /* Client_NewRemoteUser */
 176
 177
 178 /**
 179  * Initialize new client and set up the given parameters like client type,
 180  * user name, host name, introducing server etc. ...
 181  * @return New CLIENT structure.
 182  */
 183 static CLIENT *
 184 Init_New_Client(CONN_ID Idx, CLIENT *Introducer, CLIENT *TopServer,
 185   int Type, const char *ID, const char *User, const char *Hostname,
 186   const char *Info, int Hops, int Token, const char *Modes, bool Idented)
 187 {
 188         CLIENT *client;
 189
 190         assert(Idx >= NONE);
 191         assert(Introducer != NULL);
 192
 193         client = New_Client_Struct();
 194         if (!client)
 195                 return NULL;
 196
 197         client->starttime = time(NULL);
 198         client->conn_id = Idx;
 199         client->introducer = Introducer;
 200         client->topserver = TopServer;
 201         client->type = Type;
 202         if (ID)
 203                 Client_SetID(client, ID);
 204         if (User) {
 205                 Client_SetUser(client, User, Idented);
 206                 Client_SetOrigUser(client, User);
 207         }
 208         if (Hostname)
 209                 Client_SetHostname(client, Hostname);
 210         if (Info)
 211                 Client_SetInfo(client, Info);
 212         client->hops = Hops;
 213         client->token = Token;
 214         if (Modes)
 215                 Client_SetModes(client, Modes);
 216         if (Type == CLIENT_SERVER)
 217                 Generate_MyToken(client);
 218
 219         if (strchr(client->modes, 'a'))
 220                 strlcpy(client->away, DEFAULT_AWAY_MSG, sizeof(client->away));
 221
 222         client->next = (POINTER *)My_Clients;
 223         My_Clients = client;
 224
 225         Adjust_Counters(client);
 226
 227         return client;
 228 } /* Init_New_Client */
 229
 230
 231 GLOBAL void
 232 Client_Destroy( CLIENT *Client, const char *LogMsg, const char *FwdMsg, bool SendQuit )
 233 {
 234         /* remove a client */
 235
 236         CLIENT *last, *c;
 237         char msg[LINE_LEN];
 238         const char *txt;
 239
 240         assert( Client != NULL );
 241
 242         if( LogMsg ) txt = LogMsg;
 243         else txt = FwdMsg;
 244         if( ! txt ) txt = "Reason unknown.";
 245
 246         /* netsplit message */
 247         if( Client->type == CLIENT_SERVER ) {
 248                 strlcpy(msg, This_Server->id, sizeof (msg));
 249                 strlcat(msg, " ", sizeof (msg));
 250                 strlcat(msg, Client->id, sizeof (msg));
 251         }
 252
 253         last = NULL;
 254         c = My_Clients;
 255         while( c )
 256         {
 257                 if(( Client->type == CLIENT_SERVER ) && ( c->introducer == Client ) && ( c != Client ))
 258                 {
 259                         /*
 260                          * The client that is about to be removed is a server,
 261                          * the client we are checking right now is a child of that
 262                          * server and thus has to be removed, too.
 263                          *
 264                          * Call Client_Destroy() recursively with the server as the
 265                          * new "object to be removed". This starts the cycle again, until
 266                          * all servers that are linked via the original server have been
 267                          * removed.
 268                          */
 269                         Client_Destroy( c, NULL, msg, false );
 270                         last = NULL;
 271                         c = My_Clients;
 272                         continue;
 273                 }
 274                 if( c == Client )
 275                 {
 276                         /* found  the client: remove it */
 277                         if( last ) last->next = c->next;
 278                         else My_Clients = (CLIENT *)c->next;
 279
 280                         if(c->type == CLIENT_USER || c->type == CLIENT_SERVICE)
 281                                 Destroy_UserOrService(c, txt, FwdMsg, SendQuit);
 282                         else if( c->type == CLIENT_SERVER )
 283                         {
 284                                 if( c != This_Server )
 285                                 {
 286                                         if( c->conn_id != NONE ) Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
 287                                         else Log( LOG_NOTICE|LOG_snotice, "Server \"%s\" unregistered: %s", c->id, txt );
 288                                 }
 289
 290                                 /* inform other servers */
 291                                 if( ! NGIRCd_SignalQuit )
 292                                 {
 293                                         if( FwdMsg ) IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :%s", c->id, FwdMsg );
 294                                         else IRC_WriteStrServersPrefix( Client_NextHop( c ), c, "SQUIT %s :", c->id );
 295                                 }
 296                         }
 297                         else
 298                         {
 299                                 if( c->conn_id != NONE )
 300                                 {
 301                                         if( c->id[0] ) Log( LOG_NOTICE, "Client \"%s\" unregistered (connection %d): %s", c->id, c->conn_id, txt );
 302                                         else Log( LOG_NOTICE, "Client unregistered (connection %d): %s", c->conn_id, txt );
 303                                 } else {
 304                                         Log(LOG_WARNING, "Unregistered unknown client \"%s\": %s",
 305                                                                 c->id[0] ? c->id : "(No Nick)", txt );
 306                                 }
 307                         }
 308
 309                         free( c );
 310                         break;
 311                 }
 312                 last = c;
 313                 c = (CLIENT *)c->next;
 314         }
 315 } /* Client_Destroy */
 316
 317
 318 /**
 319  * Set client hostname.
 320  *
 321  * If global hostname cloaking is in effect, don't set the real hostname
 322  * but the configured one.
 323  *
 324  * @param Client The client of which the hostname should be set.
 325  * @param Hostname The new hostname.
 326  */
 327 GLOBAL void
 328 Client_SetHostname( CLIENT *Client, const char *Hostname )
 329 {
 330         assert(Client != NULL);
 331         assert(Hostname != NULL);
 332
 333         if (strlen(Conf_CloakHost)) {
 334                 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
 335                          Client_ID(Client), Client->host, Conf_CloakHost);
 336                 strlcpy(Client->host, Conf_CloakHost, sizeof(Client->host));
 337         } else {
 338                 LogDebug("Updating hostname of \"%s\": \"%s\" -> \"%s\"",
 339                          Client_ID(Client), Client->host, Hostname);
 340                 strlcpy(Client->host, Hostname, sizeof(Client->host));
 341         }
 342 } /* Client_SetHostname */
 343
 344
 345 GLOBAL void
 346 Client_SetID( CLIENT *Client, const char *ID )
 347 {
 348         assert( Client != NULL );
 349         assert( ID != NULL );
 350
 351         strlcpy( Client->id, ID, sizeof( Client->id ));
 352
 353         if (Conf_CloakUserToNick) {
 354                 strlcpy( Client->user, ID, sizeof( Client->user ));
 355                 strlcpy( Client->info, ID, sizeof( Client->info ));
 356         }
 357
 358         /* Hash */
 359         Client->hash = Hash( Client->id );
 360 } /* Client_SetID */
 361
 362
 363 GLOBAL void
 364 Client_SetUser( CLIENT *Client, const char *User, bool Idented )
 365 {
 366         /* set clients username */
 367
 368         assert( Client != NULL );
 369         assert( User != NULL );
 370
 371         if (Conf_CloakUserToNick) {
 372                 strlcpy(Client->user, Client->id, sizeof(Client->user));
 373         } else if (Idented) {
 374                 strlcpy(Client->user, User, sizeof(Client->user));
 375         } else {
 376                 Client->user[0] = '~';
 377                 strlcpy(Client->user + 1, User, sizeof(Client->user) - 1);
 378         }
 379 } /* Client_SetUser */
 380
 381
 382 /**
 383  * Set "original" user name of a client.
 384  * This function saves the "original" user name, the user name specified by
 385  * the peer using the USER command, into the CLIENT structure. This user
 386  * name may be used for authentication, for example.
 387  * @param Client The client.
 388  * @param User User name to set.
 389  */
 390 GLOBAL void
 391 Client_SetOrigUser(CLIENT UNUSED *Client, const char UNUSED *User)
 392 {
 393         assert(Client != NULL);
 394         assert(User != NULL);
 395
 396 #if defined(PAM) && defined(IDENTAUTH)
 397         strlcpy(Client->orig_user, User, sizeof(Client->orig_user));
 398 #endif
 399 } /* Client_SetOrigUser */
 400
 401
 402 GLOBAL void
 403 Client_SetInfo( CLIENT *Client, const char *Info )
 404 {
 405         /* set client hostname */
 406
 407         assert( Client != NULL );
 408         assert( Info != NULL );
 409
 410         if (Conf_CloakUserToNick)
 411                 strlcpy(Client->info, Client->id, sizeof(Client->info));
 412         else
 413                 strlcpy(Client->info, Info, sizeof(Client->info));
 414 } /* Client_SetInfo */
 415
 416
 417 GLOBAL void
 418 Client_SetModes( CLIENT *Client, const char *Modes )
 419 {
 420         assert( Client != NULL );
 421         assert( Modes != NULL );
 422
 423         strlcpy(Client->modes, Modes, sizeof( Client->modes ));
 424 } /* Client_SetModes */
 425
 426
 427 GLOBAL void
 428 Client_SetFlags( CLIENT *Client, const char *Flags )
 429 {
 430         assert( Client != NULL );
 431         assert( Flags != NULL );
 432
 433         strlcpy(Client->flags, Flags, sizeof(Client->flags));
 434 } /* Client_SetFlags */
 435
 436
 437 GLOBAL void
 438 Client_SetPassword( CLIENT *Client, const char *Pwd )
 439 {
 440         /* set password sent by client */
 441
 442         assert( Client != NULL );
 443         assert( Pwd != NULL );
 444
 445         strlcpy(Client->pwd, Pwd, sizeof(Client->pwd));
 446 } /* Client_SetPassword */
 447
 448
 449 GLOBAL void
 450 Client_SetAway( CLIENT *Client, const char *Txt )
 451 {
 452         /* Set AWAY reason of client */
 453
 454         assert( Client != NULL );
 455         assert( Txt != NULL );
 456
 457         strlcpy( Client->away, Txt, sizeof( Client->away ));
 458         LogDebug("%s \"%s\" is away: %s", Client_TypeText(Client),
 459                  Client_Mask(Client), Txt);
 460 } /* Client_SetAway */
 461
 462
 463 GLOBAL void
 464 Client_SetType( CLIENT *Client, int Type )
 465 {
 466         assert( Client != NULL );
 467         Client->type = Type;
 468         if( Type == CLIENT_SERVER ) Generate_MyToken( Client );
 469         Adjust_Counters( Client );
 470 } /* Client_SetType */
 471
 472
 473 GLOBAL void
 474 Client_SetHops( CLIENT *Client, int Hops )
 475 {
 476         assert( Client != NULL );
 477         Client->hops = Hops;
 478 } /* Client_SetHops */
 479
 480
 481 GLOBAL void
 482 Client_SetToken( CLIENT *Client, int Token )
 483 {
 484         assert( Client != NULL );
 485         Client->token = Token;
 486 } /* Client_SetToken */
 487
 488
 489 GLOBAL void
 490 Client_SetIntroducer( CLIENT *Client, CLIENT *Introducer )
 491 {
 492         assert( Client != NULL );
 493         assert( Introducer != NULL );
 494         Client->introducer = Introducer;
 495 } /* Client_SetIntroducer */
 496
 497
 498 GLOBAL void
 499 Client_SetOperByMe( CLIENT *Client, bool OperByMe )
 500 {
 501         assert( Client != NULL );
 502         Client->oper_by_me = OperByMe;
 503 } /* Client_SetOperByMe */
 504
 505
 506 GLOBAL bool
 507 Client_ModeAdd( CLIENT *Client, char Mode )
 508 {
 509         /* Set Mode.
 510          * If Client already alread had Mode, return false.
 511          * If the Mode was newly set, return true.
 512          */
 513
 514         char x[2];
 515
 516         assert( Client != NULL );
 517
 518         x[0] = Mode; x[1] = '\0';
 519         if (!strchr( Client->modes, x[0])) {
 520                 strlcat( Client->modes, x, sizeof( Client->modes ));
 521                 return true;
 522         }
 523         else return false;
 524 } /* Client_ModeAdd */
 525
 526
 527 GLOBAL bool
 528 Client_ModeDel( CLIENT *Client, char Mode )
 529 {
 530         /* Delete Mode.
 531          * If Mode was removed, return true.
 532          * If Client did not have Mode, return false.
 533          */
 534
 535         char x[2], *p;
 536
 537         assert( Client != NULL );
 538
 539         x[0] = Mode; x[1] = '\0';
 540
 541         p = strchr( Client->modes, x[0] );
 542         if( ! p ) return false;
 543
 544         /* Client has Mode -> delete */
 545         while( *p )
 546         {
 547                 *p = *(p + 1);
 548                 p++;
 549         }
 550         return true;
 551 } /* Client_ModeDel */
 552
 553
 554 GLOBAL CLIENT *
 555 Client_Search( const char *Nick )
 556 {
 557         /* return Client-Structure that has the corresponding Nick.
 558          * If none is found, return NULL.
 559          */
 560
 561         char search_id[CLIENT_ID_LEN], *ptr;
 562         CLIENT *c = NULL;
 563         UINT32 search_hash;
 564
 565         assert( Nick != NULL );
 566
 567         /* copy Nick and truncate hostmask if necessary */
 568         strlcpy( search_id, Nick, sizeof( search_id ));
 569         ptr = strchr( search_id, '!' );
 570         if( ptr ) *ptr = '\0';
 571
 572         search_hash = Hash(search_id);
 573
 574         c = My_Clients;
 575         while (c) {
 576                 if (c->hash == search_hash && strcasecmp(c->id, search_id) == 0)
 577                         return c;
 578                 c = (CLIENT *)c->next;
 579         }
 580         return NULL;
 581 } /* Client_Search */
 582
 583
 584 /**
 585  * Get client structure ("introducer") identfied by a server token.
 586  * @return CLIENT structure or NULL if none could be found.
 587  */
 588 GLOBAL CLIENT *
 589 Client_GetFromToken( CLIENT *Client, int Token )
 590 {
 591         CLIENT *c;
 592
 593         assert( Client != NULL );
 594
 595         if (!Token)
 596                 return NULL;
 597
 598         c = My_Clients;
 599         while (c) {
 600                 if ((c->type == CLIENT_SERVER) && (c->introducer == Client) &&
 601                         (c->token == Token))
 602                                 return c;
 603                 c = (CLIENT *)c->next;
 604         }
 605         return NULL;
 606 } /* Client_GetFromToken */
 607
 608
 609 GLOBAL int
 610 Client_Type( CLIENT *Client )
 611 {
 612         assert( Client != NULL );
 613         return Client->type;
 614 } /* Client_Type */
 615
 616
 617 GLOBAL CONN_ID
 618 Client_Conn( CLIENT *Client )
 619 {
 620         assert( Client != NULL );
 621         return Client->conn_id;
 622 } /* Client_Conn */
 623
 624
 625 GLOBAL char *
 626 Client_ID( CLIENT *Client )
 627 {
 628         assert( Client != NULL );
 629
 630 #ifdef DEBUG
 631         if(Client->type == CLIENT_USER)
 632                 assert(strlen(Client->id) < Conf_MaxNickLength);
 633 #endif
 634
 635         if( Client->id[0] ) return Client->id;
 636         else return "*";
 637 } /* Client_ID */
 638
 639
 640 GLOBAL char *
 641 Client_Info( CLIENT *Client )
 642 {
 643         assert( Client != NULL );
 644         return Client->info;
 645 } /* Client_Info */
 646
 647
 648 GLOBAL char *
 649 Client_User( CLIENT *Client )
 650 {
 651         assert( Client != NULL );
 652         return Client->user[0] ? Client->user : "~";
 653 } /* Client_User */
 654
 655
 656 #ifdef PAM
 657
 658 /**
 659  * Get the "original" user name as supplied by the USER command.
 660  * The user name as given by the client is used for authentication instead
 661  * of the one detected using IDENT requests.
 662  * @param Client The client.
 663  * @return Original user name.
 664  */
 665 GLOBAL char *
 666 Client_OrigUser(CLIENT *Client) {
 667 #ifndef IDENTAUTH
 668         char *user = Client->user;
 669
 670         if (user[0] == '~')
 671                 user++;
 672         return user;
 673 #else
 674         return Client->orig_user;
 675 #endif
 676 } /* Client_OrigUser */
 677
 678 #endif
 679
 680
 681 /**
 682  * Return the hostname of a client.
 683  * @param Client Pointer to client structure
 684  * @return Pointer to client hostname
 685  */
 686 GLOBAL char *
 687 Client_Hostname(CLIENT *Client)
 688 {
 689         assert (Client != NULL);
 690         return Client->host;
 691 } /* Client_Hostname */
 692
 693
 694 /**
 695  * Get potentially cloaked hostname of a client.
 696  * If the client has not enabled cloaking, the real hostname is used.
 697  * @param Client Pointer to client structure
 698  * @return Pointer to client hostname
 699  */
 700 GLOBAL char *
 701 Client_HostnameCloaked(CLIENT *Client)
 702 {
 703         assert(Client != NULL);
 704         if (Client_HasMode(Client, 'x'))
 705                 return Client_ID(Client->introducer);
 706         else
 707                 return Client_Hostname(Client);
 708 } /* Client_HostnameCloaked */
 709
 710
 711 GLOBAL char *
 712 Client_Password( CLIENT *Client )
 713 {
 714         assert( Client != NULL );
 715         return Client->pwd;
 716 } /* Client_Password */
 717
 718
 719 GLOBAL char *
 720 Client_Modes( CLIENT *Client )
 721 {
 722         assert( Client != NULL );
 723         return Client->modes;
 724 } /* Client_Modes */
 725
 726
 727 GLOBAL char *
 728 Client_Flags( CLIENT *Client )
 729 {
 730         assert( Client != NULL );
 731         return Client->flags;
 732 } /* Client_Flags */
 733
 734
 735 GLOBAL bool
 736 Client_OperByMe( CLIENT *Client )
 737 {
 738         assert( Client != NULL );
 739         return Client->oper_by_me;
 740 } /* Client_OperByMe */
 741
 742
 743 GLOBAL int
 744 Client_Hops( CLIENT *Client )
 745 {
 746         assert( Client != NULL );
 747         return Client->hops;
 748 } /* Client_Hops */
 749
 750
 751 GLOBAL int
 752 Client_Token( CLIENT *Client )
 753 {
 754         assert( Client != NULL );
 755         return Client->token;
 756 } /* Client_Token */
 757
 758
 759 GLOBAL int
 760 Client_MyToken( CLIENT *Client )
 761 {
 762         assert( Client != NULL );
 763         return Client->mytoken;
 764 } /* Client_MyToken */
 765
 766
 767 GLOBAL CLIENT *
 768 Client_NextHop( CLIENT *Client )
 769 {
 770         CLIENT *c;
 771
 772         assert( Client != NULL );
 773
 774         c = Client;
 775         while( c->introducer && ( c->introducer != c ) && ( c->introducer != This_Server ))
 776                 c = c->introducer;
 777
 778         return c;
 779 } /* Client_NextHop */
 780
 781
 782 /**
 783  * Return ID of a client: "client!user@host"
 784  * This client ID is used for IRC prefixes, for example.
 785  * Please note that this function uses a global static buffer, so you can't
 786  * nest invocations without overwriting earlier results!
 787  * @param Client Pointer to client structure
 788  * @return Pointer to global buffer containing the client ID
 789  */
 790 GLOBAL char *
 791 Client_Mask( CLIENT *Client )
 792 {
 793         static char Mask_Buffer[GETID_LEN];
 794
 795         assert (Client != NULL);
 796
 797         /* Servers: return name only, there is no "mask" */
 798         if (Client->type == CLIENT_SERVER)
 799                 return Client->id;
 800
 801         snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
 802                  Client->id, Client->user, Client->host);
 803         return Mask_Buffer;
 804 } /* Client_Mask */
 805
 806
 807 /**
 808  * Return ID of a client with cloaked hostname: "client!user@server-name"
 809  * This client ID is used for IRC prefixes, for example.
 810  * Please note that this function uses a global static buffer, so you can't
 811  * nest invocations without overwriting earlier results!
 812  * If the client has not enabled cloaking, the real hostname is used.
 813  * @param Client Pointer to client structure
 814  * @return Pointer to global buffer containing the client ID
 815  */
 816 GLOBAL char *
 817 Client_MaskCloaked(CLIENT *Client)
 818 {
 819         static char Mask_Buffer[GETID_LEN];
 820
 821         assert (Client != NULL);
 822
 823         /* Is the client using cloaking at all? */
 824         if (!Client_HasMode(Client, 'x'))
 825             return Client_Mask(Client);
 826
 827         snprintf(Mask_Buffer, GETID_LEN, "%s!%s@%s",
 828                  Client->id, Client->user,
 829                  *Conf_CloakHostModeX ? Conf_CloakHostModeX
 830                                       : Client_ID(Client->introducer));
 831         return Mask_Buffer;
 832 } /* Client_MaskCloaked */
 833
 834
 835 GLOBAL CLIENT *
 836 Client_Introducer( CLIENT *Client )
 837 {
 838         assert( Client != NULL );
 839         return Client->introducer;
 840 } /* Client_Introducer */
 841
 842
 843 GLOBAL CLIENT *
 844 Client_TopServer( CLIENT *Client )
 845 {
 846         assert( Client != NULL );
 847         return Client->topserver;
 848 } /* Client_TopServer */
 849
 850
 851 GLOBAL bool
 852 Client_HasMode( CLIENT *Client, char Mode )
 853 {
 854         assert( Client != NULL );
 855         return strchr( Client->modes, Mode ) != NULL;
 856 } /* Client_HasMode */
 857
 858
 859 GLOBAL char *
 860 Client_Away( CLIENT *Client )
 861 {
 862         assert( Client != NULL );
 863         return Client->away;
 864 } /* Client_Away */
 865
 866
 867 /**
 868  * Make sure that a given nickname is valid.
 869  *
 870  * If the nickname is not valid for the given client, this function sends back
 871  * the appropriate error messages.
 872  *
 873  * @param       Client Client that wants to change the nickname.
 874  * @param       Nick New nick name.
 875  * @returns     true if nickname is valid, false otherwise.
 876  */
 877 GLOBAL bool
 878 Client_CheckNick(CLIENT *Client, char *Nick)
 879 {
 880         assert(Client != NULL);
 881         assert(Nick != NULL);
 882
 883         if (!Client_IsValidNick(Nick)) {
 884                 if (strlen(Nick ) >= Conf_MaxNickLength)
 885                         IRC_WriteStrClient(Client, ERR_NICKNAMETOOLONG_MSG,
 886                                            Client_ID(Client), Nick,
 887                                            Conf_MaxNickLength - 1);
 888                 else
 889                         IRC_WriteStrClient(Client, ERR_ERRONEUSNICKNAME_MSG,
 890                                            Client_ID(Client), Nick);
 891                 return false;
 892         }
 893
 894         /* Nickname already registered? */
 895         if (Client_Search(Nick)) {
 896                 IRC_WriteStrClient(Client, ERR_NICKNAMEINUSE_MSG,
 897                         Client_ID(Client), Nick);
 898                 return false;
 899         }
 900
 901         return true;
 902 } /* Client_CheckNick */
 903
 904
 905 GLOBAL bool
 906 Client_CheckID( CLIENT *Client, char *ID )
 907 {
 908         char str[COMMAND_LEN];
 909         CLIENT *c;
 910
 911         assert( Client != NULL );
 912         assert( Client->conn_id > NONE );
 913         assert( ID != NULL );
 914
 915         /* ID too long? */
 916         if (strlen(ID) > CLIENT_ID_LEN) {
 917                 IRC_WriteStrClient(Client, ERR_ERRONEUSNICKNAME_MSG, Client_ID(Client), ID);
 918                 return false;
 919         }
 920
 921         /* ID already in use? */
 922         c = My_Clients;
 923         while (c) {
 924                 if (strcasecmp(c->id, ID) == 0) {
 925                         snprintf(str, sizeof(str), "ID \"%s\" already registered", ID);
 926                         if (c->conn_id != NONE)
 927                                 Log(LOG_ERR, "%s (on connection %d)!", str, c->conn_id);
 928                         else
 929                                 Log(LOG_ERR, "%s (via network)!", str);
 930                         Conn_Close(Client->conn_id, str, str, true);
 931                         return false;
 932                 }
 933                 c = (CLIENT *)c->next;
 934         }
 935
 936         return true;
 937 } /* Client_CheckID */
 938
 939
 940 GLOBAL CLIENT *
 941 Client_First( void )
 942 {
 943         return My_Clients;
 944 } /* Client_First */
 945
 946
 947 GLOBAL CLIENT *
 948 Client_Next( CLIENT *c )
 949 {
 950         assert( c != NULL );
 951         return (CLIENT *)c->next;
 952 } /* Client_Next */
 953
 954
 955 GLOBAL long
 956 Client_UserCount( void )
 957 {
 958         return Count( CLIENT_USER );
 959 } /* Client_UserCount */
 960
 961
 962 GLOBAL long
 963 Client_ServiceCount( void )
 964 {
 965         return Count( CLIENT_SERVICE );;
 966 } /* Client_ServiceCount */
 967
 968
 969 GLOBAL long
 970 Client_ServerCount( void )
 971 {
 972         return Count( CLIENT_SERVER );
 973 } /* Client_ServerCount */
 974
 975
 976 GLOBAL long
 977 Client_MyUserCount( void )
 978 {
 979         return MyCount( CLIENT_USER );
 980 } /* Client_MyUserCount */
 981
 982
 983 GLOBAL long
 984 Client_MyServiceCount( void )
 985 {
 986         return MyCount( CLIENT_SERVICE );
 987 } /* Client_MyServiceCount */
 988
 989
 990 GLOBAL unsigned long
 991 Client_MyServerCount( void )
 992 {
 993         CLIENT *c;
 994         unsigned long cnt = 0;
 995
 996         c = My_Clients;
 997         while( c )
 998         {
 999                 if(( c->type == CLIENT_SERVER ) && ( c->hops == 1 )) cnt++;
1000                 c = (CLIENT *)c->next;
1001         }
1002         return cnt;
1003 } /* Client_MyServerCount */
1004
1005
1006 GLOBAL unsigned long
1007 Client_OperCount( void )
1008 {
1009         CLIENT *c;
1010         unsigned long cnt = 0;
1011
1012         c = My_Clients;
1013         while( c )
1014         {
1015                 if( c && ( c->type == CLIENT_USER ) && ( strchr( c->modes, 'o' ))) cnt++;
1016                 c = (CLIENT *)c->next;
1017         }
1018         return cnt;
1019 } /* Client_OperCount */
1020
1021
1022 GLOBAL unsigned long
1023 Client_UnknownCount( void )
1024 {
1025         CLIENT *c;
1026         unsigned long cnt = 0;
1027
1028         c = My_Clients;
1029         while( c )
1030         {
1031                 if( c && ( c->type != CLIENT_USER ) && ( c->type != CLIENT_SERVICE ) && ( c->type != CLIENT_SERVER )) cnt++;
1032                 c = (CLIENT *)c->next;
1033         }
1034
1035         return cnt;
1036 } /* Client_UnknownCount */
1037
1038
1039 GLOBAL long
1040 Client_MaxUserCount( void )
1041 {
1042         return Max_Users;
1043 } /* Client_MaxUserCount */
1044
1045
1046 GLOBAL long
1047 Client_MyMaxUserCount( void )
1048 {
1049         return My_Max_Users;
1050 } /* Client_MyMaxUserCount */
1051
1052
1053 /**
1054  * Check that a given nickname is valid.
1055  *
1056  * @param       Nick the nickname to check.
1057  * @returns     true if nickname is valid, false otherwise.
1058  */
1059 GLOBAL bool
1060 Client_IsValidNick(const char *Nick)
1061 {
1062         const char *ptr;
1063         static const char goodchars[] = ";0123456789-";
1064
1065         assert (Nick != NULL);
1066
1067         if (strchr(goodchars, Nick[0]))
1068                 return false;
1069         if (strlen(Nick ) >= Conf_MaxNickLength)
1070                 return false;
1071
1072         ptr = Nick;
1073         while (*ptr) {
1074                 if (*ptr < 'A' && !strchr(goodchars, *ptr ))
1075                         return false;
1076                 if (*ptr > '}')
1077                         return false;
1078                 ptr++;
1079         }
1080
1081         return true;
1082 } /* Client_IsValidNick */
1083
1084
1085 /**
1086  * Return pointer to "My_Whowas" structure.
1087  */
1088 GLOBAL WHOWAS *
1089 Client_GetWhowas( void )
1090 {
1091         return My_Whowas;
1092 } /* Client_GetWhowas */
1093
1094 /**
1095  * Return the index of the last used WHOWAS entry.
1096  */
1097 GLOBAL int
1098 Client_GetLastWhowasIndex( void )
1099 {
1100         return Last_Whowas;
1101 } /* Client_GetLastWhowasIndex */
1102
1103
1104 /**
1105  * Get the start time of this client.
1106  * The result is the start time in seconds since 1970-01-01, as reported
1107  * by the C function time(NULL).
1108  */
1109 GLOBAL time_t
1110 Client_StartTime(CLIENT *Client)
1111 {
1112         assert( Client != NULL );
1113         return Client->starttime;
1114 } /* Client_Uptime */
1115
1116
1117 /**
1118  * Reject a client when logging in.
1119  *
1120  * This function is called when a client isn't allowed to connect to this
1121  * server. Possible reasons are bad server password, bad PAM password,
1122  * or that the client is G/K-Line'd.
1123  *
1124  * After calling this function, the client isn't connected any more.
1125  *
1126  * @param Client The client to reject.
1127  * @param Reason The reason why the client has been rejected.
1128  * @param InformClient If true, send the exact reason to the client.
1129  */
1130 GLOBAL void
1131 Client_Reject(CLIENT *Client, const char *Reason, bool InformClient)
1132 {
1133         char info[COMMAND_LEN];
1134
1135         assert(Client != NULL);
1136         assert(Reason != NULL);
1137
1138         if (InformClient)
1139                 snprintf(info, sizeof(info), "Access denied: %s", Reason);
1140         else
1141                 strcpy(info, "Access denied: Bad password?");
1142
1143         Log(LOG_ERR,
1144             "User \"%s\" rejected (connection %d): %s!",
1145             Client_Mask(Client), Client_Conn(Client), Reason);
1146         Conn_Close(Client_Conn(Client), Reason, info, true);
1147 }
1148
1149
1150 /**
1151  * Introduce a new user or service client in the network.
1152  *
1153  * @param From Remote server introducing the client or NULL (local).
1154  * @param Client New client.
1155  * @param Type Type of the client (CLIENT_USER or CLIENT_SERVICE).
1156  */
1157 GLOBAL void
1158 Client_Introduce(CLIENT *From, CLIENT *Client, int Type)
1159 {
1160         /* Set client type (user or service) */
1161         Client_SetType(Client, Type);
1162
1163         if (From) {
1164                 if (Conf_IsService(Conf_GetServer(Client_Conn(From)),
1165                                    Client_ID(Client)))
1166                         Client_SetType(Client, CLIENT_SERVICE);
1167                 LogDebug("%s \"%s\" (+%s) registered (via %s, on %s, %d hop%s).",
1168                          Client_TypeText(Client), Client_Mask(Client),
1169                          Client_Modes(Client), Client_ID(From),
1170                          Client_ID(Client_Introducer(Client)),
1171                          Client_Hops(Client), Client_Hops(Client) > 1 ? "s": "");
1172         } else {
1173                 Log(LOG_NOTICE, "%s \"%s\" registered (connection %d).",
1174                     Client_TypeText(Client), Client_Mask(Client),
1175                     Client_Conn(Client));
1176                 Log_ServerNotice('c', "Client connecting: %s (%s@%s) [%s] - %s",
1177                                  Client_ID(Client), Client_User(Client),
1178                                  Client_Hostname(Client),
1179                                  Conn_IPA(Client_Conn(Client)),
1180                                  Client_TypeText(Client));
1181         }
1182
1183         /* Inform other servers */
1184         IRC_WriteStrServersPrefixFlag_CB(From,
1185                                 From != NULL ? From : Client_ThisServer(),
1186                                 '\0', cb_introduceClient, (void *)Client);
1187 } /* Client_Introduce */
1188
1189
1190 static unsigned long
1191 Count( CLIENT_TYPE Type )
1192 {
1193         CLIENT *c;
1194         unsigned long cnt = 0;
1195
1196         c = My_Clients;
1197         while( c )
1198         {
1199                 if( c->type == Type ) cnt++;
1200                 c = (CLIENT *)c->next;
1201         }
1202         return cnt;
1203 } /* Count */
1204
1205
1206 static unsigned long
1207 MyCount( CLIENT_TYPE Type )
1208 {
1209         CLIENT *c;
1210         unsigned long cnt = 0;
1211
1212         c = My_Clients;
1213         while( c )
1214         {
1215                 if(( c->introducer == This_Server ) && ( c->type == Type )) cnt++;
1216                 c = (CLIENT *)c->next;
1217         }
1218         return cnt;
1219 } /* MyCount */
1220
1221
1222 static CLIENT *
1223 New_Client_Struct( void )
1224 {
1225         /* Neue CLIENT-Struktur pre-initialisieren */
1226
1227         CLIENT *c;
1228
1229         c = (CLIENT *)malloc( sizeof( CLIENT ));
1230         if( ! c )
1231         {
1232                 Log( LOG_EMERG, "Can't allocate memory! [New_Client_Struct]" );
1233                 return NULL;
1234         }
1235
1236         memset( c, 0, sizeof ( CLIENT ));
1237
1238         c->type = CLIENT_UNKNOWN;
1239         c->conn_id = NONE;
1240         c->oper_by_me = false;
1241         c->hops = -1;
1242         c->token = -1;
1243         c->mytoken = -1;
1244
1245         return c;
1246 } /* New_Client */
1247
1248
1249 static void
1250 Generate_MyToken( CLIENT *Client )
1251 {
1252         CLIENT *c;
1253         int token;
1254
1255         c = My_Clients;
1256         token = 2;
1257         while( c )
1258         {
1259                 if( c->mytoken == token )
1260                 {
1261                         /* Das Token wurde bereits vergeben */
1262                         token++;
1263                         c = My_Clients;
1264                         continue;
1265                 }
1266                 else c = (CLIENT *)c->next;
1267         }
1268         Client->mytoken = token;
1269         LogDebug("Assigned token %d to server \"%s\".", token, Client->id);
1270 } /* Generate_MyToken */
1271
1272
1273 static void
1274 Adjust_Counters( CLIENT *Client )
1275 {
1276         long count;
1277
1278         assert( Client != NULL );
1279
1280         if( Client->type != CLIENT_USER ) return;
1281
1282         if( Client->conn_id != NONE )
1283         {
1284                 /* Local connection */
1285                 count = Client_MyUserCount( );
1286                 if( count > My_Max_Users ) My_Max_Users = count;
1287         }
1288         count = Client_UserCount( );
1289         if( count > Max_Users ) Max_Users = count;
1290 } /* Adjust_Counters */
1291
1292
1293 /**
1294  * Register client in My_Whowas structure for further recall by WHOWAS.
1295  * Note: Only clients that have been connected at least 30 seconds will be
1296  * registered to prevent automated IRC bots to "destroy" a nice server
1297  * history database.
1298  */
1299 GLOBAL void
1300 Client_RegisterWhowas( CLIENT *Client )
1301 {
1302         int slot;
1303         time_t now;
1304
1305         assert( Client != NULL );
1306
1307         /* Don't register WHOWAS information when "MorePrivacy" is enabled. */
1308         if (Conf_MorePrivacy)
1309                 return;
1310
1311         now = time(NULL);
1312         /* Don't register clients that were connected less than 30 seconds. */
1313         if( now - Client->starttime < 30 )
1314                 return;
1315
1316         slot = Last_Whowas + 1;
1317         if( slot >= MAX_WHOWAS || slot < 0 ) slot = 0;
1318
1319 #ifdef DEBUG
1320         Log( LOG_DEBUG, "Saving WHOWAS information to slot %d ...", slot );
1321 #endif
1322
1323         My_Whowas[slot].time = now;
1324         strlcpy( My_Whowas[slot].id, Client_ID( Client ),
1325                  sizeof( My_Whowas[slot].id ));
1326         strlcpy( My_Whowas[slot].user, Client_User( Client ),
1327                  sizeof( My_Whowas[slot].user ));
1328         strlcpy( My_Whowas[slot].host, Client_HostnameCloaked( Client ),
1329                  sizeof( My_Whowas[slot].host ));
1330         strlcpy( My_Whowas[slot].info, Client_Info( Client ),
1331                  sizeof( My_Whowas[slot].info ));
1332         strlcpy( My_Whowas[slot].server, Client_ID( Client_Introducer( Client )),
1333                  sizeof( My_Whowas[slot].server ));
1334
1335         Last_Whowas = slot;
1336 } /* Client_RegisterWhowas */
1337
1338
1339 GLOBAL const char *
1340 Client_TypeText(CLIENT *Client)
1341 {
1342         assert(Client != NULL);
1343         switch (Client_Type(Client)) {
1344                 case CLIENT_USER:
1345                         return "User";
1346                         break;
1347                 case CLIENT_SERVICE:
1348                         return "Service";
1349                         break;
1350                 case CLIENT_SERVER:
1351                         return "Server";
1352                         break;
1353                 default:
1354                         return "Client";
1355         }
1356 } /* Client_TypeText */
1357
1358
1359 /**
1360  * Destroy user or service client.
1361  */
1362 static void
1363 Destroy_UserOrService(CLIENT *Client, const char *Txt, const char *FwdMsg, bool SendQuit)
1364 {
1365         if(Client->conn_id != NONE) {
1366                 /* Local (directly connected) client */
1367                 Log(LOG_NOTICE,
1368                     "%s \"%s\" unregistered (connection %d): %s",
1369                     Client_TypeText(Client), Client_Mask(Client),
1370                     Client->conn_id, Txt);
1371                 Log_ServerNotice('c', "Client exiting: %s (%s@%s) [%s]",
1372                                  Client_ID(Client), Client_User(Client),
1373                                  Client_Hostname(Client), Txt);
1374
1375                 if (SendQuit) {
1376                         /* Inforam all the other servers */
1377                         if (FwdMsg)
1378                                 IRC_WriteStrServersPrefix(NULL,
1379                                                 Client, "QUIT :%s", FwdMsg );
1380                         else
1381                                 IRC_WriteStrServersPrefix(NULL,
1382                                                 Client, "QUIT :");
1383                 }
1384         } else {
1385                 /* Remote client */
1386                 LogDebug("%s \"%s\" unregistered: %s",
1387                          Client_TypeText(Client), Client_Mask(Client), Txt);
1388
1389                 if(SendQuit) {
1390                         /* Inform all the other servers, but the ones in the
1391                          * direction we got the QUIT from */
1392                         if(FwdMsg)
1393                                 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1394                                                 Client, "QUIT :%s", FwdMsg );
1395                         else
1396                                 IRC_WriteStrServersPrefix(Client_NextHop(Client),
1397                                                 Client, "QUIT :" );
1398                 }
1399         }
1400
1401         /* Unregister client from channels */
1402         Channel_Quit(Client, FwdMsg ? FwdMsg : Client->id);
1403
1404         /* Register client in My_Whowas structure */
1405         Client_RegisterWhowas(Client);
1406 } /* Destroy_UserOrService */
1407
1408
1409 /**
1410  * Introduce a new user or service client to a remote server.
1411  *
1412  * This function differentiates between RFC1459 and RFC2813 server links and
1413  * generates the appropriate commands to register the new user or service.
1414  *
1415  * @param To            The remote server to inform.
1416  * @param Prefix        Prefix for the generated commands.
1417  * @param data          CLIENT structure of the new client.
1418  */
1419 static void
1420 cb_introduceClient(CLIENT *To, CLIENT *Prefix, void *data)
1421 {
1422         CLIENT *c = (CLIENT *)data;
1423         CONN_ID conn;
1424         char *modes, *user, *host;
1425
1426         modes = Client_Modes(c);
1427         user = Client_User(c) ? Client_User(c) : "-";
1428         host = Client_Hostname(c) ? Client_Hostname(c) : "-";
1429
1430         conn = Client_Conn(To);
1431         if (Conn_Options(conn) & CONN_RFC1459) {
1432                 /* RFC 1459 mode: separate NICK and USER commands */
1433                 Conn_WriteStr(conn, "NICK %s :%d", Client_ID(c),
1434                               Client_Hops(c) + 1);
1435                 Conn_WriteStr(conn, ":%s USER %s %s %s :%s",
1436                               Client_ID(c), user, host,
1437                               Client_ID(Client_Introducer(c)), Client_Info(c));
1438                 if (modes[0])
1439                         Conn_WriteStr(conn, ":%s MODE %s +%s",
1440                                       Client_ID(c), Client_ID(c), modes);
1441         } else {
1442                 /* RFC 2813 mode: one combined NICK or SERVICE command */
1443                 if (Client_Type(c) == CLIENT_SERVICE
1444                     && strchr(Client_Flags(To), 'S'))
1445                         IRC_WriteStrClientPrefix(To, Prefix,
1446                                                  "SERVICE %s %d * +%s %d :%s",
1447                                                  Client_Mask(c),
1448                                                  Client_MyToken(Client_Introducer(c)),
1449                                                  Client_Modes(c), Client_Hops(c) + 1,
1450                                                  Client_Info(c));
1451                 else
1452                         IRC_WriteStrClientPrefix(To, Prefix,
1453                                                  "NICK %s %d %s %s %d +%s :%s",
1454                                                  Client_ID(c), Client_Hops(c) + 1,
1455                                                  user, host,
1456                                                  Client_MyToken(Client_Introducer(c)),
1457                                                  modes, Client_Info(c));
1458         }
1459 } /* cb_introduceClient */
1460
1461
1462 #ifdef DEBUG
1463
1464 GLOBAL void
1465 Client_DebugDump(void)
1466 {
1467         CLIENT *c;
1468
1469         Log(LOG_DEBUG, "Client status:");
1470         c = My_Clients;
1471         while (c) {
1472                 Log(LOG_DEBUG,
1473                     " - %s: type=%d, host=%s, user=%s, conn=%d, start=%ld, flags=%s",
1474                    Client_ID(c), Client_Type(c), Client_Hostname(c),
1475                    Client_User(c), Client_Conn(c), Client_StartTime(c),
1476                    Client_Flags(c));
1477                 c = (CLIENT *)c->next;
1478         }
1479 } /* Client_DumpClients */
1480
1481 #endif
1482
1483
1484 /* -eof- */