2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2005 by Alexander Barton (alex@barton.de)
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.
15 static char UNUSED id[] = "$Id: ngircd.c,v 1.100 2005/06/17 23:17:09 fw Exp $";
19 * The main program, including the C function main() which is called
20 * by the loader of the operating system.
32 #include <sys/types.h>
45 #include "cvs-version.h"
52 #include "rendezvous.h"
59 LOCAL void Initialize_Signal_Handler PARAMS(( void ));
60 LOCAL void Signal_Handler PARAMS(( int Signal ));
62 LOCAL void Show_Version PARAMS(( void ));
63 LOCAL void Show_Help PARAMS(( void ));
65 LOCAL void Pidfile_Create PARAMS(( long ));
66 LOCAL void Pidfile_Delete PARAMS(( void ));
68 LOCAL void Fill_Version PARAMS(( void ));
70 LOCAL void Setup_FDStreams PARAMS(( void ));
72 LOCAL bool NGIRCd_Init PARAMS(( bool ));
75 * The main() function of ngIRCd.
76 * Here all starts: this function is called by the operating system loader,
77 * it is the first portion of code executed of ngIRCd.
78 * @param argc The number of arguments passed to ngIRCd on the command line.
79 * @param argv An array containing all the arguments passed to ngIRCd.
80 * @return Global exit code of ngIRCd, zero on success.
83 main( int argc, const char *argv[] )
85 bool ok, configtest = false;
91 NGIRCd_SignalQuit = NGIRCd_SignalRestart = NGIRCd_SignalRehash = false;
92 NGIRCd_NoDaemon = NGIRCd_Passive = false;
97 NGIRCd_Sniffer = false;
99 strlcpy( NGIRCd_ConfFile, SYSCONFDIR, sizeof( NGIRCd_ConfFile ));
100 strlcat( NGIRCd_ConfFile, CONFIG_FILE, sizeof( NGIRCd_ConfFile ));
104 /* Kommandozeile parsen */
105 for( i = 1; i < argc; i++ )
108 if(( argv[i][0] == '-' ) && ( argv[i][1] == '-' ))
112 if( strcmp( argv[i], "--config" ) == 0 )
116 /* Ok, there's an parameter left */
117 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
123 if( strcmp( argv[i], "--configtest" ) == 0 )
129 if( strcmp( argv[i], "--debug" ) == 0 )
135 if( strcmp( argv[i], "--help" ) == 0 )
138 puts( "" ); Show_Help( ); puts( "" );
141 if( strcmp( argv[i], "--nodaemon" ) == 0 )
143 NGIRCd_NoDaemon = true;
146 if( strcmp( argv[i], "--passive" ) == 0 )
148 NGIRCd_Passive = true;
152 if( strcmp( argv[i], "--sniffer" ) == 0 )
154 NGIRCd_Sniffer = true;
158 if( strcmp( argv[i], "--version" ) == 0 )
164 else if(( argv[i][0] == '-' ) && ( argv[i][1] != '-' ))
167 for( n = 1; n < strlen( argv[i] ); n++ )
171 if( argv[i][n] == 'd' )
177 if( argv[i][n] == 'f' )
179 if(( ! argv[i][n + 1] ) && ( i + 1 < argc ))
181 /* Ok, next character is a blank */
182 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
184 /* go to the following parameter */
186 n = strlen( argv[i] );
190 if( argv[i][n] == 'n' )
192 NGIRCd_NoDaemon = true;
195 if( argv[i][n] == 'p' )
197 NGIRCd_Passive = true;
201 if( argv[i][n] == 's' )
203 NGIRCd_Sniffer = true;
207 if( argv[i][n] == 't' )
215 printf( "%s: invalid option \"-%c\"!\n", PACKAGE_NAME, argv[i][n] );
216 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
224 printf( "%s: invalid option \"%s\"!\n", PACKAGE_NAME, argv[i] );
225 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
230 /* Debug-Level (fuer IRC-Befehl "VERSION") ermitteln */
231 NGIRCd_DebugLevel[0] = '\0';
233 if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" );
239 strcpy( NGIRCd_DebugLevel, "2" );
243 /* Soll nur die Konfigurations ueberprueft und ausgegeben werden? */
246 Show_Version( ); puts( "" );
250 while( ! NGIRCd_SignalQuit )
252 /* Initialize global variables */
253 NGIRCd_Start = time( NULL );
254 (void)strftime( NGIRCd_StartStr, 64, "%a %b %d %Y at %H:%M:%S (%Z)", localtime( &NGIRCd_Start ));
256 NGIRCd_SignalRehash = false;
257 NGIRCd_SignalRestart = false;
258 NGIRCd_SignalQuit = false;
260 /* Initialize modules, part I */
264 if (!NGIRCd_Init( NGIRCd_NoDaemon )) {
265 Log(LOG_WARNING, "Fatal: Initialization failed");
269 /* Initialize modules, part II: these functions are eventually
270 * called with already dropped privileges ... */
281 /* Redirect stderr handle to "error file" for debugging
282 * when not running in "no daemon" mode: */
283 if( ! NGIRCd_NoDaemon ) Log_InitErrorfile( );
286 /* Signal-Handler initialisieren */
287 Initialize_Signal_Handler( );
289 /* Protokoll- und Server-Identifikation erzeugen. Die vom ngIRCd
290 * beim PASS-Befehl verwendete Syntax sowie die erweiterten Flags
291 * sind in doc/Protocol.txt beschrieben. */
293 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS );
295 strcat( NGIRCd_ProtoID, "Z" );
297 if( Conf_OperCanMode ) strcat( NGIRCd_ProtoID, "o" );
299 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s", PROTOVER, PROTOIRC, PACKAGE_NAME, PACKAGE_VERSION );
301 strlcat( NGIRCd_ProtoID, " P", sizeof NGIRCd_ProtoID );
303 strlcat( NGIRCd_ProtoID, "Z", sizeof NGIRCd_ProtoID );
305 Log( LOG_DEBUG, "Protocol and server ID is \"%s\".", NGIRCd_ProtoID );
307 /* Vordefinierte Channels anlegen */
308 Channel_InitPredefined( );
310 /* Listen-Ports initialisieren */
311 if( Conn_InitListeners( ) < 1 )
313 Log( LOG_ALERT, "Server isn't listening on a single port!" );
314 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
339 * Generate ngIRCd "version string".
340 * This string is generated once and then stored in NGIRCd_Version for
341 * further usage, for example by the IRC command VERSION and the --version
342 * command line switch.
347 NGIRCd_VersionAddition[0] = '\0';
350 strlcpy( NGIRCd_VersionAddition, "SYSLOG", sizeof NGIRCd_VersionAddition );
353 if( NGIRCd_VersionAddition[0] )
354 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
356 strlcat( NGIRCd_VersionAddition, "ZLIB", sizeof NGIRCd_VersionAddition );
359 if( NGIRCd_VersionAddition[0] )
360 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
362 strlcat( NGIRCd_VersionAddition, "TCPWRAP", sizeof NGIRCd_VersionAddition );
365 if( NGIRCd_VersionAddition[0] )
366 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
368 strlcat( NGIRCd_VersionAddition, "RENDEZVOUS", sizeof NGIRCd_VersionAddition );
371 if( NGIRCd_VersionAddition[0] )
372 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
374 strlcat( NGIRCd_VersionAddition, "IDENT", sizeof NGIRCd_VersionAddition );
377 if( NGIRCd_VersionAddition[0] )
378 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
380 strlcat( NGIRCd_VersionAddition, "DEBUG", sizeof NGIRCd_VersionAddition );
383 if( NGIRCd_VersionAddition[0] )
384 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
386 strlcat( NGIRCd_VersionAddition, "SNIFFER", sizeof NGIRCd_VersionAddition );
389 if( NGIRCd_VersionAddition[0] )
390 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
392 strlcat( NGIRCd_VersionAddition, "RFC", sizeof NGIRCd_VersionAddition );
395 if( NGIRCd_VersionAddition[0] )
396 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
398 strlcat( NGIRCd_VersionAddition, "IRCPLUS", sizeof NGIRCd_VersionAddition );
401 if( NGIRCd_VersionAddition[0] )
402 strlcat( NGIRCd_VersionAddition, "-", sizeof( NGIRCd_VersionAddition ));
404 strlcat( NGIRCd_VersionAddition, TARGET_CPU, sizeof( NGIRCd_VersionAddition ));
405 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
406 strlcat( NGIRCd_VersionAddition, TARGET_VENDOR, sizeof( NGIRCd_VersionAddition ));
407 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
408 strlcat( NGIRCd_VersionAddition, TARGET_OS, sizeof( NGIRCd_VersionAddition ));
411 snprintf( NGIRCd_Version, sizeof NGIRCd_Version,"%s %s(%s)-%s", PACKAGE_NAME, PACKAGE_VERSION, CVSDATE, NGIRCd_VersionAddition);
413 snprintf( NGIRCd_Version, sizeof NGIRCd_Version, "%s %s-%s", PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_VersionAddition);
419 * Reload the server configuration file.
422 NGIRCd_Rehash( void )
424 char old_name[CLIENT_ID_LEN];
426 Log( LOG_NOTICE|LOG_snotice, "Re-reading configuration NOW!" );
427 NGIRCd_SignalRehash = false;
429 /* Close down all listening sockets */
430 Conn_ExitListeners( );
432 /* Remember old server name */
433 strlcpy( old_name, Conf_ServerName, sizeof old_name );
435 /* Re-read configuration ... */
438 /* Recover old server name: it can't be changed during run-time */
439 if( strcmp( old_name, Conf_ServerName ) != 0 )
441 strcpy( Conf_ServerName, old_name );
442 Log( LOG_ERR, "Can't change \"ServerName\" on runtime! Ignored new name." );
445 /* Create new pre-defined channels */
446 Channel_InitPredefined( );
448 /* Start listening on sockets */
449 Conn_InitListeners( );
451 /* Sync configuration with established connections */
452 Conn_SyncServerStruct( );
454 Log( LOG_NOTICE|LOG_snotice, "Re-reading of configuration done." );
455 } /* NGIRCd_Rehash */
459 * Initialize the signal handler.
462 Initialize_Signal_Handler( void )
464 /* Signal-Handler initialisieren: einige Signale
465 * werden ignoriert, andere speziell behandelt. */
467 #ifdef HAVE_SIGACTION
468 /* sigaction() ist vorhanden */
470 struct sigaction saction;
472 /* Signal-Struktur initialisieren */
473 memset( &saction, 0, sizeof( saction ));
474 saction.sa_handler = Signal_Handler;
476 saction.sa_flags |= SA_RESTART;
479 saction.sa_flags |= SA_NOCLDWAIT;
482 /* Signal-Handler einhaengen */
483 sigaction( SIGINT, &saction, NULL );
484 sigaction( SIGQUIT, &saction, NULL );
485 sigaction( SIGTERM, &saction, NULL);
486 sigaction( SIGHUP, &saction, NULL);
487 sigaction( SIGCHLD, &saction, NULL);
489 /* einige Signale ignorieren */
490 saction.sa_handler = SIG_IGN;
491 sigaction( SIGPIPE, &saction, NULL );
493 /* kein sigaction() vorhanden */
495 /* Signal-Handler einhaengen */
496 signal( SIGINT, Signal_Handler );
497 signal( SIGQUIT, Signal_Handler );
498 signal( SIGTERM, Signal_Handler );
499 signal( SIGHUP, Signal_Handler );
500 signal( SIGCHLD, Signal_Handler );
502 /* einige Signale ignorieren */
503 signal( SIGPIPE, SIG_IGN );
505 } /* Initialize_Signal_Handler */
509 * Signal handler of ngIRCd.
510 * This function is called whenever ngIRCd catches a signal sent by the
511 * user and/or the system to it. For example SIGTERM and SIGHUP.
512 * @param Signal Number of the signal to handle.
515 Signal_Handler( int Signal )
522 /* wir soll(t)en uns wohl beenden ... */
523 NGIRCd_SignalQuit = true;
526 /* Konfiguration neu einlesen: */
527 NGIRCd_SignalRehash = true;
530 /* Child-Prozess wurde beendet. Zombies vermeiden: */
531 while( waitpid( -1, NULL, WNOHANG ) > 0);
535 /* unbekanntes bzw. unbehandeltes Signal */
536 Log( LOG_DEBUG, "Got signal %d! Ignored.", Signal );
539 } /* Signal_Handler */
543 * Display copyright and version information of ngIRCd on the console.
548 puts( NGIRCd_Version );
549 puts( "Copyright (c)2001-2005 by Alexander Barton (<alex@barton.de>)." );
550 puts( "Homepage: <http://arthur.ath.cx/~alex/ngircd/>\n" );
551 puts( "This is free software; see the source for copying conditions. There is NO" );
552 puts( "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." );
557 * Display a short help text on the console.
558 * This help depends on the configuration of the executable and only shows
559 * options that are actually enabled.
565 puts( " -d, --debug log extra debug messages" );
567 puts( " -f, --config <f> use file <f> as configuration file" );
568 puts( " -n, --nodaemon don't fork and don't detach from controlling terminal" );
569 puts( " -p, --passive disable automatic connections to other servers" );
571 puts( " -s, --sniffer enable network sniffer and display all IRC traffic" );
573 puts( " -t, --configtest read, validate and display configuration; then exit" );
574 puts( " --version output version information and exit" );
575 puts( " --help display this help and exit" );
580 * Delete the file containing the process ID (PID).
583 Pidfile_Delete( void )
585 /* Pidfile configured? */
586 if( ! Conf_PidFile[0] ) return;
589 Log( LOG_DEBUG, "Removing PID file (%s) ...", Conf_PidFile );
592 if( unlink( Conf_PidFile ))
593 Log( LOG_ERR, "Error unlinking PID file (%s): %s", Conf_PidFile, strerror( errno ));
594 } /* Pidfile_Delete */
598 * Create the file containing the process ID of ngIRCd ("PID file").
599 * @param pid The process ID to be stored in this file.
602 Pidfile_Create( long pid )
608 /* Pidfile configured? */
609 if( ! Conf_PidFile[0] ) return;
612 Log( LOG_DEBUG, "Creating PID file (%s) ...", Conf_PidFile );
615 pidfd = open( Conf_PidFile, O_RDWR|O_CREAT|O_EXCL, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
617 Log( LOG_ERR, "Error writing PID file (%s): %s", Conf_PidFile, strerror( errno ));
621 len = snprintf( pidbuf, sizeof pidbuf, "%ld\n", pid );
622 if (len < 0|| len < (int)sizeof pid) {
623 Log( LOG_ERR, "Error converting pid");
627 if( write( pidfd, pidbuf, len) != len)
628 Log( LOG_ERR, "Can't write PID file (%s): %s", Conf_PidFile, strerror( errno ));
630 if( close(pidfd) != 0 )
631 Log( LOG_ERR, "Error closing PID file (%s): %s", Conf_PidFile, strerror( errno ));
632 } /* Pidfile_Create */
636 * Redirect stdin, stdout and stderr to apropriate file handles.
639 Setup_FDStreams( void )
643 /* Test if we can open /dev/null for reading and writing. If not
644 * we are most probably chrooted already and the server has been
645 * restarted. So we simply don't try to redirect stdXXX ... */
646 fd = open( "/dev/null", O_RDWR );
648 Log(LOG_WARNING, "Could not open /dev/null: %s", strerror(errno));
655 /* Create new stdin(0), stdout(1) and stderr(2) descriptors */
656 dup2( fd, 0 ); dup2( fd, 1 ); dup2( fd, 2 );
658 /* Close newly opened file descriptor if not stdin/out/err */
659 if( fd > 2 ) close( fd );
660 } /* Setup_FDStreams */
664 NGIRCd_getNobodyID(unsigned int *uid, unsigned int *gid )
668 pwd = getpwnam("nobody");
669 if (!pwd) return false;
671 if ( !pwd->pw_uid || !pwd->pw_gid)
683 NGIRCd_Init( bool NGIRCd_NoDaemon )
685 static bool initialized;
686 bool chrooted = false;
695 if( Conf_Chroot[0] ) {
696 if( chdir( Conf_Chroot ) != 0 ) {
697 Log( LOG_ERR, "Can't chdir() in ChrootDir (%s): %s", Conf_Chroot, strerror( errno ));
701 if( chroot( Conf_Chroot ) != 0 ) {
702 if (errno != EPERM) {
703 Log( LOG_ERR, "Can't change root directory to \"%s\": %s",
704 Conf_Chroot, strerror( errno ));
710 Log( LOG_INFO, "Changed root and working directory to \"%s\".", Conf_Chroot );
714 if ( Conf_UID == 0 ) {
715 Log( LOG_INFO, "Conf_UID must not be 0, switching to user nobody", Conf_UID );
717 if (!NGIRCd_getNobodyID(&Conf_UID, &Conf_GID )) {
718 Log( LOG_WARNING, "Could not get uid/gid of user nobody: %s",
719 errno ? strerror(errno) : "not found" );
724 if( setgid( Conf_GID ) != 0 ) {
726 Log( LOG_ERR, "Can't change group ID to %u: %s", Conf_GID, strerror( errno ));
727 if (real_errno != EPERM)
731 if( setuid( Conf_UID ) != 0 ) {
733 Log( LOG_ERR, "Can't change user ID to %u: %s", Conf_UID, strerror( errno ));
734 if (real_errno != EPERM)
740 /* Normally a child process is forked which isn't any longer
741 * connected to ther controlling terminal. Use "--nodaemon"
742 * to disable this "daemon mode" (useful for debugging). */
743 if ( ! NGIRCd_NoDaemon ) {
747 /* "Old" process: exit. */
752 fprintf( stderr, "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
753 PACKAGE_NAME, strerror( errno ));
757 /* New child process */
761 /* Detach stdin, stdout and stderr */
766 Pidfile_Create( pid );
768 /* check uid we are running as, can be different from values configured (e.g. if we were already
769 started with a uid > 0 */
773 assert( Conf_GID > 0);
774 assert( Conf_UID > 0);
776 pwd = getpwuid( Conf_UID );
777 grp = getgrgid( Conf_GID );
778 Log( LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
779 pwd ? pwd->pw_name : "unknown", Conf_UID,
780 grp ? grp->gr_name : "unknown", Conf_GID, pid);
783 Log( LOG_INFO, "Running chrooted, chrootdir \"%s\".", Conf_Chroot );
786 Log( LOG_INFO, "Not running chrooted." );
789 /* Change working directory to home directory of the user
790 * we are running as (only when running in daemon mode and not in chroot) */
793 if (!NGIRCd_NoDaemon ) {
794 if( chdir( pwd->pw_dir ) == 0 )
795 Log( LOG_DEBUG, "Changed working directory to \"%s\" ...", pwd->pw_dir );
797 Log( LOG_ERR, "Can't change working directory to \"%s\": %s",
798 pwd->pw_dir, strerror( errno ));
801 Log( LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID );