2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2007 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.115 2007/04/09 01:24:05 alex 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 static void Initialize_Signal_Handler PARAMS(( void ));
60 static void Signal_Handler PARAMS(( int Signal ));
62 static void Show_Version PARAMS(( void ));
63 static void Show_Help PARAMS(( void ));
65 static void Pidfile_Create PARAMS(( pid_t pid ));
66 static void Pidfile_Delete PARAMS(( void ));
68 static void Fill_Version PARAMS(( void ));
70 static void Setup_FDStreams PARAMS(( void ));
72 static 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;
86 bool NGIRCd_NoDaemon = false;
92 NGIRCd_SignalQuit = NGIRCd_SignalRestart = NGIRCd_SignalRehash = false;
93 NGIRCd_Passive = false;
98 NGIRCd_Sniffer = false;
100 strlcpy( NGIRCd_ConfFile, SYSCONFDIR, sizeof( NGIRCd_ConfFile ));
101 strlcat( NGIRCd_ConfFile, CONFIG_FILE, sizeof( NGIRCd_ConfFile ));
105 /* Kommandozeile parsen */
106 for( i = 1; i < argc; i++ )
109 if(( argv[i][0] == '-' ) && ( argv[i][1] == '-' ))
113 if( strcmp( argv[i], "--config" ) == 0 )
117 /* Ok, there's an parameter left */
118 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
124 if( strcmp( argv[i], "--configtest" ) == 0 )
130 if( strcmp( argv[i], "--debug" ) == 0 )
136 if( strcmp( argv[i], "--help" ) == 0 )
139 puts( "" ); Show_Help( ); puts( "" );
142 if( strcmp( argv[i], "--nodaemon" ) == 0 )
144 NGIRCd_NoDaemon = true;
147 if( strcmp( argv[i], "--passive" ) == 0 )
149 NGIRCd_Passive = true;
153 if( strcmp( argv[i], "--sniffer" ) == 0 )
155 NGIRCd_Sniffer = true;
159 if( strcmp( argv[i], "--version" ) == 0 )
165 else if(( argv[i][0] == '-' ) && ( argv[i][1] != '-' ))
168 for( n = 1; n < strlen( argv[i] ); n++ )
172 if( argv[i][n] == 'd' )
178 if( argv[i][n] == 'f' )
180 if(( ! argv[i][n + 1] ) && ( i + 1 < argc ))
182 /* Ok, next character is a blank */
183 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
185 /* go to the following parameter */
187 n = strlen( argv[i] );
191 if( argv[i][n] == 'n' )
193 NGIRCd_NoDaemon = true;
196 if( argv[i][n] == 'p' )
198 NGIRCd_Passive = true;
202 if( argv[i][n] == 's' )
204 NGIRCd_Sniffer = true;
208 if( argv[i][n] == 't' )
216 printf( "%s: invalid option \"-%c\"!\n", PACKAGE_NAME, argv[i][n] );
217 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
225 printf( "%s: invalid option \"%s\"!\n", PACKAGE_NAME, argv[i] );
226 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
231 /* Debug-Level (fuer IRC-Befehl "VERSION") ermitteln */
232 NGIRCd_DebugLevel[0] = '\0';
234 if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" );
240 strcpy( NGIRCd_DebugLevel, "2" );
244 /* Soll nur die Konfigurations ueberprueft und ausgegeben werden? */
247 Show_Version( ); puts( "" );
251 while( ! NGIRCd_SignalQuit )
253 /* Initialize global variables */
254 NGIRCd_Start = time( NULL );
255 (void)strftime( NGIRCd_StartStr, 64, "%a %b %d %Y at %H:%M:%S (%Z)", localtime( &NGIRCd_Start ));
257 NGIRCd_SignalRehash = false;
258 NGIRCd_SignalRestart = false;
259 NGIRCd_SignalQuit = false;
261 /* Initialize modules, part I */
262 Log_Init( ! NGIRCd_NoDaemon );
265 /* Initialize the "main program": chroot environment, user and
267 if (!NGIRCd_Init(NGIRCd_NoDaemon)) {
268 Log(LOG_ALERT, "Fatal: Initialization failed");
272 /* Initialize modules, part II: these functions are eventually
273 * called with already dropped privileges ... */
282 /* Redirect stderr handle to "error file" for debugging
283 * when not running in "no daemon" mode: */
284 if( ! NGIRCd_NoDaemon ) Log_InitErrorfile( );
287 /* Signal-Handler initialisieren */
288 Initialize_Signal_Handler( );
290 /* Protokoll- und Server-Identifikation erzeugen. Die vom ngIRCd
291 * beim PASS-Befehl verwendete Syntax sowie die erweiterten Flags
292 * sind in doc/Protocol.txt beschrieben. */
294 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS );
296 strcat( NGIRCd_ProtoID, "Z" );
298 if( Conf_OperCanMode ) strcat( NGIRCd_ProtoID, "o" );
300 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s", PROTOVER, PROTOIRC, PACKAGE_NAME, PACKAGE_VERSION );
302 strlcat( NGIRCd_ProtoID, " P", sizeof NGIRCd_ProtoID );
304 strlcat( NGIRCd_ProtoID, "Z", sizeof NGIRCd_ProtoID );
306 Log( LOG_DEBUG, "Protocol and server ID is \"%s\".", NGIRCd_ProtoID );
308 /* Vordefinierte Channels anlegen */
309 Channel_InitPredefined( );
311 /* Listen-Ports initialisieren */
312 if( Conn_InitListeners( ) < 1 )
314 Log( LOG_ALERT, "Server isn't listening on a single port!" );
315 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, "ZEROCONF", 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 strlcpy( Conf_ServerName, old_name, sizeof Conf_ServerName );
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-2007 Alexander Barton (<alex@barton.de>) and Contributors." );
550 puts( "Homepage: <http://ngircd.barton.de/>\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(pid_t 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", (long)pid);
622 if (len < 0 || len >= (int)sizeof pidbuf) {
623 Log( LOG_ERR, "Error converting pid");
627 if (write(pidfd, pidbuf, (size_t)len) != (ssize_t)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(uid_t *uid, gid_t *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 );
715 Log(LOG_INFO, "ServerUID must not be 0, using \"nobody\" instead.", Conf_UID);
717 if (! NGIRCd_getNobodyID(&Conf_UID, &Conf_GID)) {
718 Log(LOG_WARNING, "Could not get user/group ID of user \"nobody\": %s",
719 errno ? strerror(errno) : "not found" );
724 if (getgid() != Conf_GID) {
725 /* Change group ID */
726 if (setgid(Conf_GID) != 0) {
728 Log( LOG_ERR, "Can't change group ID to %u: %s", Conf_GID, strerror( errno ));
729 if (real_errno != EPERM)
734 if (getuid() != Conf_UID) {
736 if (setuid(Conf_UID) != 0) {
738 Log(LOG_ERR, "Can't change user ID to %u: %s", Conf_UID, strerror(errno));
739 if (real_errno != EPERM)
746 /* Normally a child process is forked which isn't any longer
747 * connected to ther controlling terminal. Use "--nodaemon"
748 * to disable this "daemon mode" (useful for debugging). */
749 if ( ! NGIRCd_NoDaemon ) {
752 /* "Old" process: exit. */
757 fprintf( stderr, "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
758 PACKAGE_NAME, strerror( errno ));
762 /* New child process */
766 /* Detach stdin, stdout and stderr */
771 Pidfile_Create( pid );
773 /* Check UID/GID we are running as, can be different from values
774 * configured (e. g. if we were already started with a UID>0. */
778 pwd = getpwuid( Conf_UID );
779 grp = getgrgid( Conf_GID );
781 Log( LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
782 pwd ? pwd->pw_name : "unknown", Conf_UID,
783 grp ? grp->gr_name : "unknown", Conf_GID, pid);
786 Log( LOG_INFO, "Running chrooted, chrootdir \"%s\".", Conf_Chroot );
789 Log( LOG_INFO, "Not running chrooted." );
792 /* Change working directory to home directory of the user
793 * we are running as (only when running in daemon mode and not in chroot) */
796 if (!NGIRCd_NoDaemon ) {
797 if( chdir( pwd->pw_dir ) == 0 )
798 Log( LOG_DEBUG, "Changed working directory to \"%s\" ...", pwd->pw_dir );
800 Log( LOG_ERR, "Can't change working directory to \"%s\": %s",
801 pwd->pw_dir, strerror( errno ));
804 Log( LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID );