2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2008 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.
17 * The main program, including the C function main() which is called
18 * by the loader of the operating system.
30 #include <sys/types.h>
49 #include "rendezvous.h"
56 static void Initialize_Signal_Handler PARAMS(( void ));
57 static void Signal_Handler PARAMS(( int Signal ));
59 static void Show_Version PARAMS(( void ));
60 static void Show_Help PARAMS(( void ));
62 static void Pidfile_Create PARAMS(( pid_t pid ));
63 static void Pidfile_Delete PARAMS(( void ));
65 static void Fill_Version PARAMS(( void ));
67 static void Setup_FDStreams PARAMS(( void ));
69 static bool NGIRCd_Init PARAMS(( bool ));
72 * The main() function of ngIRCd.
73 * Here all starts: this function is called by the operating system loader,
74 * it is the first portion of code executed of ngIRCd.
75 * @param argc The number of arguments passed to ngIRCd on the command line.
76 * @param argv An array containing all the arguments passed to ngIRCd.
77 * @return Global exit code of ngIRCd, zero on success.
80 main( int argc, const char *argv[] )
82 bool ok, configtest = false;
83 bool NGIRCd_NoDaemon = false;
87 #if defined(DEBUG) && defined(HAVE_MTRACE)
88 /* enable GNU libc memory tracing when running in debug mode
89 * and functionality available */
95 NGIRCd_SignalQuit = NGIRCd_SignalRestart = NGIRCd_SignalRehash = false;
96 NGIRCd_Passive = false;
101 NGIRCd_Sniffer = false;
103 strlcpy( NGIRCd_ConfFile, SYSCONFDIR, sizeof( NGIRCd_ConfFile ));
104 strlcat( NGIRCd_ConfFile, CONFIG_FILE, sizeof( NGIRCd_ConfFile ));
108 /* Kommandozeile parsen */
109 for( i = 1; i < argc; i++ )
112 if(( argv[i][0] == '-' ) && ( argv[i][1] == '-' ))
116 if( strcmp( argv[i], "--config" ) == 0 )
120 /* Ok, there's an parameter left */
121 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
127 if( strcmp( argv[i], "--configtest" ) == 0 )
133 if( strcmp( argv[i], "--debug" ) == 0 )
139 if( strcmp( argv[i], "--help" ) == 0 )
142 puts( "" ); Show_Help( ); puts( "" );
145 if( strcmp( argv[i], "--nodaemon" ) == 0 )
147 NGIRCd_NoDaemon = true;
150 if( strcmp( argv[i], "--passive" ) == 0 )
152 NGIRCd_Passive = true;
156 if( strcmp( argv[i], "--sniffer" ) == 0 )
158 NGIRCd_Sniffer = true;
162 if( strcmp( argv[i], "--version" ) == 0 )
168 else if(( argv[i][0] == '-' ) && ( argv[i][1] != '-' ))
171 for( n = 1; n < strlen( argv[i] ); n++ )
175 if (argv[i][n] == 'd') {
180 if (argv[i][n] == 'f') {
181 if(( ! argv[i][n + 1] ) && ( i + 1 < argc ))
183 /* Ok, next character is a blank */
184 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
186 /* go to the following parameter */
188 n = strlen( argv[i] );
193 if (argv[i][n] == 'h') {
195 puts(""); Show_Help(); puts("");
199 if (argv[i][n] == 'n') {
200 NGIRCd_NoDaemon = true;
203 if (argv[i][n] == 'p') {
204 NGIRCd_Passive = true;
208 if (argv[i][n] == 's') {
209 NGIRCd_Sniffer = true;
213 if (argv[i][n] == 't') {
218 if (argv[i][n] == 'V') {
224 printf( "%s: invalid option \"-%c\"!\n", PACKAGE_NAME, argv[i][n] );
225 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
233 printf( "%s: invalid option \"%s\"!\n", PACKAGE_NAME, argv[i] );
234 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
239 /* Debug-Level (fuer IRC-Befehl "VERSION") ermitteln */
240 NGIRCd_DebugLevel[0] = '\0';
242 if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" );
248 strcpy( NGIRCd_DebugLevel, "2" );
252 /* Soll nur die Konfigurations ueberprueft und ausgegeben werden? */
255 Show_Version( ); puts( "" );
259 while( ! NGIRCd_SignalQuit )
261 /* Initialize global variables */
262 NGIRCd_Start = time( NULL );
263 (void)strftime( NGIRCd_StartStr, 64, "%a %b %d %Y at %H:%M:%S (%Z)", localtime( &NGIRCd_Start ));
265 NGIRCd_SignalRehash = false;
266 NGIRCd_SignalRestart = false;
267 NGIRCd_SignalQuit = false;
269 /* Initialize modules, part I */
270 Log_Init( ! NGIRCd_NoDaemon );
273 /* Initialize the "main program": chroot environment, user and
275 if (!NGIRCd_Init(NGIRCd_NoDaemon)) {
276 Log(LOG_ALERT, "Fatal: Initialization failed");
280 /* Initialize modules, part II: these functions are eventually
281 * called with already dropped privileges ... */
290 /* Redirect stderr handle to "error file" for debugging
291 * when not running in "no daemon" mode: */
292 if( ! NGIRCd_NoDaemon ) Log_InitErrorfile( );
295 /* Signal-Handler initialisieren */
296 Initialize_Signal_Handler( );
298 /* Protokoll- und Server-Identifikation erzeugen. Die vom ngIRCd
299 * beim PASS-Befehl verwendete Syntax sowie die erweiterten Flags
300 * sind in doc/Protocol.txt beschrieben. */
302 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS );
304 strcat( NGIRCd_ProtoID, "Z" );
306 if( Conf_OperCanMode ) strcat( NGIRCd_ProtoID, "o" );
308 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s", PROTOVER, PROTOIRC, PACKAGE_NAME, PACKAGE_VERSION );
310 strlcat( NGIRCd_ProtoID, " P", sizeof NGIRCd_ProtoID );
312 strlcat( NGIRCd_ProtoID, "Z", sizeof NGIRCd_ProtoID );
314 Log( LOG_DEBUG, "Protocol and server ID is \"%s\".", NGIRCd_ProtoID );
316 /* Vordefinierte Channels anlegen */
317 Channel_InitPredefined( );
319 /* Listen-Ports initialisieren */
320 if( Conn_InitListeners( ) < 1 )
322 Log( LOG_ALERT, "Server isn't listening on a single port!" );
323 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
347 * Generate ngIRCd "version string".
348 * This string is generated once and then stored in NGIRCd_Version for
349 * further usage, for example by the IRC command VERSION and the --version
350 * command line switch.
355 NGIRCd_VersionAddition[0] = '\0';
358 strlcpy( NGIRCd_VersionAddition, "SYSLOG", sizeof NGIRCd_VersionAddition );
361 if( NGIRCd_VersionAddition[0] )
362 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
364 strlcat( NGIRCd_VersionAddition, "ZLIB", sizeof NGIRCd_VersionAddition );
367 if( NGIRCd_VersionAddition[0] )
368 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
370 strlcat( NGIRCd_VersionAddition, "TCPWRAP", sizeof NGIRCd_VersionAddition );
373 if( NGIRCd_VersionAddition[0] )
374 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
376 strlcat( NGIRCd_VersionAddition, "ZEROCONF", sizeof NGIRCd_VersionAddition );
379 if( NGIRCd_VersionAddition[0] )
380 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
382 strlcat( NGIRCd_VersionAddition, "IDENT", sizeof NGIRCd_VersionAddition );
385 if( NGIRCd_VersionAddition[0] )
386 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
388 strlcat( NGIRCd_VersionAddition, "DEBUG", sizeof NGIRCd_VersionAddition );
391 if( NGIRCd_VersionAddition[0] )
392 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
394 strlcat( NGIRCd_VersionAddition, "SNIFFER", sizeof NGIRCd_VersionAddition );
397 if( NGIRCd_VersionAddition[0] )
398 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
400 strlcat( NGIRCd_VersionAddition, "RFC", sizeof NGIRCd_VersionAddition );
403 if( NGIRCd_VersionAddition[0] )
404 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
406 strlcat( NGIRCd_VersionAddition, "IRCPLUS", sizeof NGIRCd_VersionAddition );
409 if (NGIRCd_VersionAddition[0])
410 strlcat(NGIRCd_VersionAddition, "+", sizeof(NGIRCd_VersionAddition));
412 strlcat(NGIRCd_VersionAddition, "IPv6", sizeof(NGIRCd_VersionAddition));
414 if( NGIRCd_VersionAddition[0] )
415 strlcat( NGIRCd_VersionAddition, "-", sizeof( NGIRCd_VersionAddition ));
417 strlcat( NGIRCd_VersionAddition, TARGET_CPU, sizeof( NGIRCd_VersionAddition ));
418 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
419 strlcat( NGIRCd_VersionAddition, TARGET_VENDOR, sizeof( NGIRCd_VersionAddition ));
420 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
421 strlcat( NGIRCd_VersionAddition, TARGET_OS, sizeof( NGIRCd_VersionAddition ));
423 snprintf(NGIRCd_Version, sizeof NGIRCd_Version, "%s %s-%s",
424 PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_VersionAddition);
429 * Reload the server configuration file.
432 NGIRCd_Rehash( void )
434 char old_name[CLIENT_ID_LEN];
435 unsigned old_nicklen;
437 Log( LOG_NOTICE|LOG_snotice, "Re-reading configuration NOW!" );
438 NGIRCd_SignalRehash = false;
440 /* Remember old server name and nick name length */
441 strlcpy( old_name, Conf_ServerName, sizeof old_name );
442 old_nicklen = Conf_MaxNickLength;
444 /* Re-read configuration ... */
448 /* Close down all listening sockets */
449 Conn_ExitListeners( );
451 /* Recover old server name and nick name length: these values can't
452 * be changed during run-time */
453 if (strcmp(old_name, Conf_ServerName) != 0 ) {
454 strlcpy(Conf_ServerName, old_name, sizeof Conf_ServerName);
455 Log(LOG_ERR, "Can't change \"ServerName\" on runtime! Ignored new name.");
457 if (old_nicklen != Conf_MaxNickLength) {
458 Conf_MaxNickLength = old_nicklen;
459 Log(LOG_ERR, "Can't change \"MaxNickLength\" on runtime! Ignored new value.");
462 /* Create new pre-defined channels */
463 Channel_InitPredefined( );
465 /* Start listening on sockets */
466 Conn_InitListeners( );
468 /* Sync configuration with established connections */
469 Conn_SyncServerStruct( );
471 Log( LOG_NOTICE|LOG_snotice, "Re-reading of configuration done." );
472 } /* NGIRCd_Rehash */
476 * Initialize the signal handler.
479 Initialize_Signal_Handler( void )
481 /* Signal-Handler initialisieren: einige Signale
482 * werden ignoriert, andere speziell behandelt. */
484 #ifdef HAVE_SIGACTION
485 /* sigaction() ist vorhanden */
487 struct sigaction saction;
489 /* Signal-Struktur initialisieren */
490 memset( &saction, 0, sizeof( saction ));
491 saction.sa_handler = Signal_Handler;
493 saction.sa_flags |= SA_RESTART;
496 saction.sa_flags |= SA_NOCLDWAIT;
499 /* Signal-Handler einhaengen */
500 sigaction(SIGINT, &saction, NULL);
501 sigaction(SIGQUIT, &saction, NULL);
502 sigaction(SIGTERM, &saction, NULL);
503 sigaction(SIGHUP, &saction, NULL);
504 sigaction(SIGCHLD, &saction, NULL);
506 /* einige Signale ignorieren */
507 saction.sa_handler = SIG_IGN;
508 sigaction(SIGPIPE, &saction, NULL);
510 /* kein sigaction() vorhanden */
512 /* Signal-Handler einhaengen */
513 signal(SIGINT, Signal_Handler);
514 signal(SIGQUIT, Signal_Handler);
515 signal(SIGTERM, Signal_Handler);
516 signal(SIGHUP, Signal_Handler);
517 signal(SIGCHLD, Signal_Handler);
519 /* einige Signale ignorieren */
520 signal(SIGPIPE, SIG_IGN);
522 } /* Initialize_Signal_Handler */
526 * Signal handler of ngIRCd.
527 * This function is called whenever ngIRCd catches a signal sent by the
528 * user and/or the system to it. For example SIGTERM and SIGHUP.
529 * @param Signal Number of the signal to handle.
532 Signal_Handler( int Signal )
539 /* wir soll(t)en uns wohl beenden ... */
540 NGIRCd_SignalQuit = true;
543 /* Konfiguration neu einlesen: */
544 NGIRCd_SignalRehash = true;
547 /* Child-Prozess wurde beendet. Zombies vermeiden: */
548 while( waitpid( -1, NULL, WNOHANG ) > 0);
552 /* unbekanntes bzw. unbehandeltes Signal */
553 Log( LOG_DEBUG, "Got signal %d! Ignored.", Signal );
556 } /* Signal_Handler */
560 * Display copyright and version information of ngIRCd on the console.
565 puts( NGIRCd_Version );
566 puts( "Copyright (c)2001-2008 Alexander Barton (<alex@barton.de>) and Contributors." );
567 puts( "Homepage: <http://ngircd.barton.de/>\n" );
568 puts( "This is free software; see the source for copying conditions. There is NO" );
569 puts( "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." );
574 * Display a short help text on the console.
575 * This help depends on the configuration of the executable and only shows
576 * options that are actually enabled.
582 puts( " -d, --debug log extra debug messages" );
584 puts( " -f, --config <f> use file <f> as configuration file" );
585 puts( " -n, --nodaemon don't fork and don't detach from controlling terminal" );
586 puts( " -p, --passive disable automatic connections to other servers" );
588 puts( " -s, --sniffer enable network sniffer and display all IRC traffic" );
590 puts( " -t, --configtest read, validate and display configuration; then exit" );
591 puts( " -V, --version output version information and exit" );
592 puts( " -h, --help display this help and exit" );
597 * Delete the file containing the process ID (PID).
600 Pidfile_Delete( void )
602 /* Pidfile configured? */
603 if( ! Conf_PidFile[0] ) return;
606 Log( LOG_DEBUG, "Removing PID file (%s) ...", Conf_PidFile );
609 if( unlink( Conf_PidFile ))
610 Log( LOG_ERR, "Error unlinking PID file (%s): %s", Conf_PidFile, strerror( errno ));
611 } /* Pidfile_Delete */
615 * Create the file containing the process ID of ngIRCd ("PID file").
616 * @param pid The process ID to be stored in this file.
619 Pidfile_Create(pid_t pid)
625 /* Pidfile configured? */
626 if( ! Conf_PidFile[0] ) return;
629 Log( LOG_DEBUG, "Creating PID file (%s) ...", Conf_PidFile );
632 pidfd = open( Conf_PidFile, O_RDWR|O_CREAT|O_EXCL, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
634 Log( LOG_ERR, "Error writing PID file (%s): %s", Conf_PidFile, strerror( errno ));
638 len = snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
639 if (len < 0 || len >= (int)sizeof pidbuf) {
640 Log( LOG_ERR, "Error converting pid");
644 if (write(pidfd, pidbuf, (size_t)len) != (ssize_t)len)
645 Log( LOG_ERR, "Can't write PID file (%s): %s", Conf_PidFile, strerror( errno ));
647 if( close(pidfd) != 0 )
648 Log( LOG_ERR, "Error closing PID file (%s): %s", Conf_PidFile, strerror( errno ));
649 } /* Pidfile_Create */
653 * Redirect stdin, stdout and stderr to apropriate file handles.
656 Setup_FDStreams( void )
660 /* Test if we can open /dev/null for reading and writing. If not
661 * we are most probably chrooted already and the server has been
662 * restarted. So we simply don't try to redirect stdXXX ... */
663 fd = open( "/dev/null", O_RDWR );
665 Log(LOG_WARNING, "Could not open /dev/null: %s", strerror(errno));
672 /* Create new stdin(0), stdout(1) and stderr(2) descriptors */
673 dup2( fd, 0 ); dup2( fd, 1 ); dup2( fd, 2 );
675 /* Close newly opened file descriptor if not stdin/out/err */
676 if( fd > 2 ) close( fd );
677 } /* Setup_FDStreams */
681 NGIRCd_getNobodyID(uid_t *uid, gid_t *gid )
687 * It can return EINVAL instead of EPERM
688 * so, if we are already unprivileged,
689 * use id of current user.
691 if (geteuid() && getuid()) {
698 pwd = getpwnam("nobody");
699 if (!pwd) return false;
701 if ( !pwd->pw_uid || !pwd->pw_gid)
713 NGIRCd_Init( bool NGIRCd_NoDaemon )
715 static bool initialized;
716 bool chrooted = false;
725 if( Conf_Chroot[0] ) {
726 if( chdir( Conf_Chroot ) != 0 ) {
727 Log( LOG_ERR, "Can't chdir() in ChrootDir (%s): %s", Conf_Chroot, strerror( errno ));
731 if( chroot( Conf_Chroot ) != 0 ) {
732 if (errno != EPERM) {
733 Log( LOG_ERR, "Can't change root directory to \"%s\": %s",
734 Conf_Chroot, strerror( errno ));
740 Log( LOG_INFO, "Changed root and working directory to \"%s\".", Conf_Chroot );
745 Log(LOG_INFO, "ServerUID must not be 0, using \"nobody\" instead.", Conf_UID);
747 if (! NGIRCd_getNobodyID(&Conf_UID, &Conf_GID)) {
748 Log(LOG_WARNING, "Could not get user/group ID of user \"nobody\": %s",
749 errno ? strerror(errno) : "not found" );
754 if (getgid() != Conf_GID) {
755 /* Change group ID */
756 if (setgid(Conf_GID) != 0) {
758 Log( LOG_ERR, "Can't change group ID to %u: %s", Conf_GID, strerror( errno ));
759 if (real_errno != EPERM)
764 if (getuid() != Conf_UID) {
766 if (setuid(Conf_UID) != 0) {
768 Log(LOG_ERR, "Can't change user ID to %u: %s", Conf_UID, strerror(errno));
769 if (real_errno != EPERM)
776 /* Normally a child process is forked which isn't any longer
777 * connected to ther controlling terminal. Use "--nodaemon"
778 * to disable this "daemon mode" (useful for debugging). */
779 if ( ! NGIRCd_NoDaemon ) {
782 /* "Old" process: exit. */
787 fprintf( stderr, "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
788 PACKAGE_NAME, strerror( errno ));
792 /* New child process */
796 setpgrp(0, getpid());
800 /* Detach stdin, stdout and stderr */
805 Pidfile_Create( pid );
807 /* Check UID/GID we are running as, can be different from values
808 * configured (e. g. if we were already started with a UID>0. */
812 pwd = getpwuid( Conf_UID );
813 grp = getgrgid( Conf_GID );
815 Log( LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
816 pwd ? pwd->pw_name : "unknown", Conf_UID,
817 grp ? grp->gr_name : "unknown", Conf_GID, pid);
820 Log( LOG_INFO, "Running chrooted, chrootdir \"%s\".", Conf_Chroot );
823 Log( LOG_INFO, "Not running chrooted." );
826 /* Change working directory to home directory of the user
827 * we are running as (only when running in daemon mode and not in chroot) */
830 if (!NGIRCd_NoDaemon ) {
831 if( chdir( pwd->pw_dir ) == 0 )
832 Log( LOG_DEBUG, "Changed working directory to \"%s\" ...", pwd->pw_dir );
834 Log( LOG_INFO, "Notice: Can't change working directory to \"%s\": %s",
835 pwd->pw_dir, strerror( errno ));
838 Log( LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID );