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>
37 #if defined(DEBUG) && defined(HAVE_MTRACE)
53 #include "rendezvous.h"
60 static void Initialize_Signal_Handler PARAMS(( void ));
61 static void Signal_Handler PARAMS(( int Signal ));
63 static void Show_Version PARAMS(( void ));
64 static void Show_Help PARAMS(( void ));
66 static void Pidfile_Create PARAMS(( pid_t pid ));
67 static void Pidfile_Delete PARAMS(( void ));
69 static void Fill_Version PARAMS(( void ));
71 static void Setup_FDStreams PARAMS(( void ));
73 static bool NGIRCd_Init PARAMS(( bool ));
76 * The main() function of ngIRCd.
77 * Here all starts: this function is called by the operating system loader,
78 * it is the first portion of code executed of ngIRCd.
79 * @param argc The number of arguments passed to ngIRCd on the command line.
80 * @param argv An array containing all the arguments passed to ngIRCd.
81 * @return Global exit code of ngIRCd, zero on success.
84 main( int argc, const char *argv[] )
86 bool ok, configtest = false;
87 bool NGIRCd_NoDaemon = false;
91 #if defined(DEBUG) && defined(HAVE_MTRACE)
92 /* enable GNU libc memory tracing when running in debug mode
93 * and functionality available */
99 NGIRCd_SignalQuit = NGIRCd_SignalRestart = NGIRCd_SignalRehash = false;
100 NGIRCd_Passive = false;
102 NGIRCd_Debug = false;
105 NGIRCd_Sniffer = false;
107 strlcpy( NGIRCd_ConfFile, SYSCONFDIR, sizeof( NGIRCd_ConfFile ));
108 strlcat( NGIRCd_ConfFile, CONFIG_FILE, sizeof( NGIRCd_ConfFile ));
112 /* Kommandozeile parsen */
113 for( i = 1; i < argc; i++ )
116 if(( argv[i][0] == '-' ) && ( argv[i][1] == '-' ))
120 if( strcmp( argv[i], "--config" ) == 0 )
124 /* Ok, there's an parameter left */
125 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
131 if( strcmp( argv[i], "--configtest" ) == 0 )
137 if( strcmp( argv[i], "--debug" ) == 0 )
143 if( strcmp( argv[i], "--help" ) == 0 )
146 puts( "" ); Show_Help( ); puts( "" );
149 if( strcmp( argv[i], "--nodaemon" ) == 0 )
151 NGIRCd_NoDaemon = true;
154 if( strcmp( argv[i], "--passive" ) == 0 )
156 NGIRCd_Passive = true;
160 if( strcmp( argv[i], "--sniffer" ) == 0 )
162 NGIRCd_Sniffer = true;
166 if( strcmp( argv[i], "--version" ) == 0 )
172 else if(( argv[i][0] == '-' ) && ( argv[i][1] != '-' ))
175 for( n = 1; n < strlen( argv[i] ); n++ )
179 if (argv[i][n] == 'd') {
184 if (argv[i][n] == 'f') {
185 if(( ! argv[i][n + 1] ) && ( i + 1 < argc ))
187 /* Ok, next character is a blank */
188 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
190 /* go to the following parameter */
192 n = strlen( argv[i] );
197 if (argv[i][n] == 'h') {
199 puts(""); Show_Help(); puts("");
203 if (argv[i][n] == 'n') {
204 NGIRCd_NoDaemon = true;
207 if (argv[i][n] == 'p') {
208 NGIRCd_Passive = true;
212 if (argv[i][n] == 's') {
213 NGIRCd_Sniffer = true;
217 if (argv[i][n] == 't') {
222 if (argv[i][n] == 'V') {
228 printf( "%s: invalid option \"-%c\"!\n", PACKAGE_NAME, argv[i][n] );
229 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
237 printf( "%s: invalid option \"%s\"!\n", PACKAGE_NAME, argv[i] );
238 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
243 /* Debug-Level (fuer IRC-Befehl "VERSION") ermitteln */
244 NGIRCd_DebugLevel[0] = '\0';
246 if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" );
252 strcpy( NGIRCd_DebugLevel, "2" );
256 /* Soll nur die Konfigurations ueberprueft und ausgegeben werden? */
259 Show_Version( ); puts( "" );
263 while( ! NGIRCd_SignalQuit )
265 /* Initialize global variables */
266 NGIRCd_Start = time( NULL );
267 (void)strftime( NGIRCd_StartStr, 64, "%a %b %d %Y at %H:%M:%S (%Z)", localtime( &NGIRCd_Start ));
269 NGIRCd_SignalRehash = false;
270 NGIRCd_SignalRestart = false;
271 NGIRCd_SignalQuit = false;
273 /* Initialize modules, part I */
274 Log_Init( ! NGIRCd_NoDaemon );
277 /* Initialize the "main program": chroot environment, user and
279 if (!NGIRCd_Init(NGIRCd_NoDaemon)) {
280 Log(LOG_ALERT, "Fatal: Initialization failed");
284 /* Initialize modules, part II: these functions are eventually
285 * called with already dropped privileges ... */
294 /* Redirect stderr handle to "error file" for debugging
295 * when not running in "no daemon" mode: */
296 if( ! NGIRCd_NoDaemon ) Log_InitErrorfile( );
299 /* Signal-Handler initialisieren */
300 Initialize_Signal_Handler( );
302 /* Protokoll- und Server-Identifikation erzeugen. Die vom ngIRCd
303 * beim PASS-Befehl verwendete Syntax sowie die erweiterten Flags
304 * sind in doc/Protocol.txt beschrieben. */
306 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS );
308 strcat( NGIRCd_ProtoID, "Z" );
310 if( Conf_OperCanMode ) strcat( NGIRCd_ProtoID, "o" );
312 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s", PROTOVER, PROTOIRC, PACKAGE_NAME, PACKAGE_VERSION );
314 strlcat( NGIRCd_ProtoID, " P", sizeof NGIRCd_ProtoID );
316 strlcat( NGIRCd_ProtoID, "Z", sizeof NGIRCd_ProtoID );
318 Log( LOG_DEBUG, "Protocol and server ID is \"%s\".", NGIRCd_ProtoID );
320 /* Vordefinierte Channels anlegen */
321 Channel_InitPredefined( );
323 /* Listen-Ports initialisieren */
324 if( Conn_InitListeners( ) < 1 )
326 Log( LOG_ALERT, "Server isn't listening on a single port!" );
327 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
351 * Generate ngIRCd "version string".
352 * This string is generated once and then stored in NGIRCd_Version for
353 * further usage, for example by the IRC command VERSION and the --version
354 * command line switch.
359 NGIRCd_VersionAddition[0] = '\0';
362 strlcpy( NGIRCd_VersionAddition, "SYSLOG", sizeof NGIRCd_VersionAddition );
365 if( NGIRCd_VersionAddition[0] )
366 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
368 strlcat( NGIRCd_VersionAddition, "ZLIB", sizeof NGIRCd_VersionAddition );
371 if( NGIRCd_VersionAddition[0] )
372 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
374 strlcat( NGIRCd_VersionAddition, "TCPWRAP", sizeof NGIRCd_VersionAddition );
377 if( NGIRCd_VersionAddition[0] )
378 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
380 strlcat( NGIRCd_VersionAddition, "ZEROCONF", sizeof NGIRCd_VersionAddition );
383 if( NGIRCd_VersionAddition[0] )
384 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
386 strlcat( NGIRCd_VersionAddition, "IDENT", sizeof NGIRCd_VersionAddition );
389 if( NGIRCd_VersionAddition[0] )
390 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
392 strlcat( NGIRCd_VersionAddition, "DEBUG", sizeof NGIRCd_VersionAddition );
395 if( NGIRCd_VersionAddition[0] )
396 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
398 strlcat( NGIRCd_VersionAddition, "SNIFFER", sizeof NGIRCd_VersionAddition );
401 if( NGIRCd_VersionAddition[0] )
402 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
404 strlcat( NGIRCd_VersionAddition, "RFC", sizeof NGIRCd_VersionAddition );
407 if( NGIRCd_VersionAddition[0] )
408 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
410 strlcat( NGIRCd_VersionAddition, "IRCPLUS", sizeof NGIRCd_VersionAddition );
413 if (NGIRCd_VersionAddition[0])
414 strlcat(NGIRCd_VersionAddition, "+", sizeof(NGIRCd_VersionAddition));
416 strlcat(NGIRCd_VersionAddition, "IPv6", sizeof(NGIRCd_VersionAddition));
418 if( NGIRCd_VersionAddition[0] )
419 strlcat( NGIRCd_VersionAddition, "-", sizeof( NGIRCd_VersionAddition ));
421 strlcat( NGIRCd_VersionAddition, TARGET_CPU, sizeof( NGIRCd_VersionAddition ));
422 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
423 strlcat( NGIRCd_VersionAddition, TARGET_VENDOR, sizeof( NGIRCd_VersionAddition ));
424 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
425 strlcat( NGIRCd_VersionAddition, TARGET_OS, sizeof( NGIRCd_VersionAddition ));
427 snprintf(NGIRCd_Version, sizeof NGIRCd_Version, "%s %s-%s",
428 PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_VersionAddition);
433 * Reload the server configuration file.
436 NGIRCd_Rehash( void )
438 char old_name[CLIENT_ID_LEN];
439 unsigned old_nicklen;
441 Log( LOG_NOTICE|LOG_snotice, "Re-reading configuration NOW!" );
442 NGIRCd_SignalRehash = false;
444 /* Remember old server name and nick name length */
445 strlcpy( old_name, Conf_ServerName, sizeof old_name );
446 old_nicklen = Conf_MaxNickLength;
448 /* Re-read configuration ... */
452 /* Close down all listening sockets */
453 Conn_ExitListeners( );
455 /* Recover old server name and nick name length: these values can't
456 * be changed during run-time */
457 if (strcmp(old_name, Conf_ServerName) != 0 ) {
458 strlcpy(Conf_ServerName, old_name, sizeof Conf_ServerName);
459 Log(LOG_ERR, "Can't change \"ServerName\" on runtime! Ignored new name.");
461 if (old_nicklen != Conf_MaxNickLength) {
462 Conf_MaxNickLength = old_nicklen;
463 Log(LOG_ERR, "Can't change \"MaxNickLength\" on runtime! Ignored new value.");
466 /* Create new pre-defined channels */
467 Channel_InitPredefined( );
469 /* Start listening on sockets */
470 Conn_InitListeners( );
472 /* Sync configuration with established connections */
473 Conn_SyncServerStruct( );
475 Log( LOG_NOTICE|LOG_snotice, "Re-reading of configuration done." );
476 } /* NGIRCd_Rehash */
480 * Initialize the signal handler.
483 Initialize_Signal_Handler( void )
485 /* Signal-Handler initialisieren: einige Signale
486 * werden ignoriert, andere speziell behandelt. */
488 #ifdef HAVE_SIGACTION
489 /* sigaction() ist vorhanden */
491 struct sigaction saction;
493 /* Signal-Struktur initialisieren */
494 memset( &saction, 0, sizeof( saction ));
495 saction.sa_handler = Signal_Handler;
497 saction.sa_flags |= SA_RESTART;
500 saction.sa_flags |= SA_NOCLDWAIT;
503 /* Signal-Handler einhaengen */
504 sigaction(SIGINT, &saction, NULL);
505 sigaction(SIGQUIT, &saction, NULL);
506 sigaction(SIGTERM, &saction, NULL);
507 sigaction(SIGHUP, &saction, NULL);
508 sigaction(SIGCHLD, &saction, NULL);
510 /* einige Signale ignorieren */
511 saction.sa_handler = SIG_IGN;
512 sigaction(SIGPIPE, &saction, NULL);
514 /* kein sigaction() vorhanden */
516 /* Signal-Handler einhaengen */
517 signal(SIGINT, Signal_Handler);
518 signal(SIGQUIT, Signal_Handler);
519 signal(SIGTERM, Signal_Handler);
520 signal(SIGHUP, Signal_Handler);
521 signal(SIGCHLD, Signal_Handler);
523 /* einige Signale ignorieren */
524 signal(SIGPIPE, SIG_IGN);
526 } /* Initialize_Signal_Handler */
530 * Signal handler of ngIRCd.
531 * This function is called whenever ngIRCd catches a signal sent by the
532 * user and/or the system to it. For example SIGTERM and SIGHUP.
533 * @param Signal Number of the signal to handle.
536 Signal_Handler( int Signal )
543 /* wir soll(t)en uns wohl beenden ... */
544 NGIRCd_SignalQuit = true;
547 /* Konfiguration neu einlesen: */
548 NGIRCd_SignalRehash = true;
551 /* Child-Prozess wurde beendet. Zombies vermeiden: */
552 while( waitpid( -1, NULL, WNOHANG ) > 0);
556 /* unbekanntes bzw. unbehandeltes Signal */
557 Log( LOG_DEBUG, "Got signal %d! Ignored.", Signal );
560 } /* Signal_Handler */
564 * Display copyright and version information of ngIRCd on the console.
569 puts( NGIRCd_Version );
570 puts( "Copyright (c)2001-2008 Alexander Barton (<alex@barton.de>) and Contributors." );
571 puts( "Homepage: <http://ngircd.barton.de/>\n" );
572 puts( "This is free software; see the source for copying conditions. There is NO" );
573 puts( "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." );
578 * Display a short help text on the console.
579 * This help depends on the configuration of the executable and only shows
580 * options that are actually enabled.
586 puts( " -d, --debug log extra debug messages" );
588 puts( " -f, --config <f> use file <f> as configuration file" );
589 puts( " -n, --nodaemon don't fork and don't detach from controlling terminal" );
590 puts( " -p, --passive disable automatic connections to other servers" );
592 puts( " -s, --sniffer enable network sniffer and display all IRC traffic" );
594 puts( " -t, --configtest read, validate and display configuration; then exit" );
595 puts( " -V, --version output version information and exit" );
596 puts( " -h, --help display this help and exit" );
601 * Delete the file containing the process ID (PID).
604 Pidfile_Delete( void )
606 /* Pidfile configured? */
607 if( ! Conf_PidFile[0] ) return;
610 Log( LOG_DEBUG, "Removing PID file (%s) ...", Conf_PidFile );
613 if( unlink( Conf_PidFile ))
614 Log( LOG_ERR, "Error unlinking PID file (%s): %s", Conf_PidFile, strerror( errno ));
615 } /* Pidfile_Delete */
619 * Create the file containing the process ID of ngIRCd ("PID file").
620 * @param pid The process ID to be stored in this file.
623 Pidfile_Create(pid_t pid)
629 /* Pidfile configured? */
630 if( ! Conf_PidFile[0] ) return;
633 Log( LOG_DEBUG, "Creating PID file (%s) ...", Conf_PidFile );
636 pidfd = open( Conf_PidFile, O_RDWR|O_CREAT|O_EXCL, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
638 Log( LOG_ERR, "Error writing PID file (%s): %s", Conf_PidFile, strerror( errno ));
642 len = snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
643 if (len < 0 || len >= (int)sizeof pidbuf) {
644 Log( LOG_ERR, "Error converting pid");
648 if (write(pidfd, pidbuf, (size_t)len) != (ssize_t)len)
649 Log( LOG_ERR, "Can't write PID file (%s): %s", Conf_PidFile, strerror( errno ));
651 if( close(pidfd) != 0 )
652 Log( LOG_ERR, "Error closing PID file (%s): %s", Conf_PidFile, strerror( errno ));
653 } /* Pidfile_Create */
657 * Redirect stdin, stdout and stderr to apropriate file handles.
660 Setup_FDStreams( void )
664 /* Test if we can open /dev/null for reading and writing. If not
665 * we are most probably chrooted already and the server has been
666 * restarted. So we simply don't try to redirect stdXXX ... */
667 fd = open( "/dev/null", O_RDWR );
669 Log(LOG_WARNING, "Could not open /dev/null: %s", strerror(errno));
676 /* Create new stdin(0), stdout(1) and stderr(2) descriptors */
677 dup2( fd, 0 ); dup2( fd, 1 ); dup2( fd, 2 );
679 /* Close newly opened file descriptor if not stdin/out/err */
680 if( fd > 2 ) close( fd );
681 } /* Setup_FDStreams */
685 NGIRCd_getNobodyID(uid_t *uid, gid_t *gid )
691 * It can return EINVAL instead of EPERM
692 * so, if we are already unprivileged,
693 * use id of current user.
695 if (geteuid() && getuid()) {
702 pwd = getpwnam("nobody");
703 if (!pwd) return false;
705 if ( !pwd->pw_uid || !pwd->pw_gid)
717 NGIRCd_Init( bool NGIRCd_NoDaemon )
719 static bool initialized;
720 bool chrooted = false;
729 if( Conf_Chroot[0] ) {
730 if( chdir( Conf_Chroot ) != 0 ) {
731 Log( LOG_ERR, "Can't chdir() in ChrootDir (%s): %s", Conf_Chroot, strerror( errno ));
735 if( chroot( Conf_Chroot ) != 0 ) {
736 if (errno != EPERM) {
737 Log( LOG_ERR, "Can't change root directory to \"%s\": %s",
738 Conf_Chroot, strerror( errno ));
744 Log( LOG_INFO, "Changed root and working directory to \"%s\".", Conf_Chroot );
749 Log(LOG_INFO, "ServerUID must not be 0, using \"nobody\" instead.", Conf_UID);
751 if (! NGIRCd_getNobodyID(&Conf_UID, &Conf_GID)) {
752 Log(LOG_WARNING, "Could not get user/group ID of user \"nobody\": %s",
753 errno ? strerror(errno) : "not found" );
758 if (getgid() != Conf_GID) {
759 /* Change group ID */
760 if (setgid(Conf_GID) != 0) {
762 Log( LOG_ERR, "Can't change group ID to %u: %s", Conf_GID, strerror( errno ));
763 if (real_errno != EPERM)
768 if (getuid() != Conf_UID) {
770 if (setuid(Conf_UID) != 0) {
772 Log(LOG_ERR, "Can't change user ID to %u: %s", Conf_UID, strerror(errno));
773 if (real_errno != EPERM)
780 /* Normally a child process is forked which isn't any longer
781 * connected to ther controlling terminal. Use "--nodaemon"
782 * to disable this "daemon mode" (useful for debugging). */
783 if ( ! NGIRCd_NoDaemon ) {
786 /* "Old" process: exit. */
791 fprintf( stderr, "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
792 PACKAGE_NAME, strerror( errno ));
796 /* New child process */
800 setpgrp(0, getpid());
804 /* Detach stdin, stdout and stderr */
809 Pidfile_Create( pid );
811 /* Check UID/GID we are running as, can be different from values
812 * configured (e. g. if we were already started with a UID>0. */
816 pwd = getpwuid( Conf_UID );
817 grp = getgrgid( Conf_GID );
819 Log( LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
820 pwd ? pwd->pw_name : "unknown", Conf_UID,
821 grp ? grp->gr_name : "unknown", Conf_GID, pid);
824 Log( LOG_INFO, "Running chrooted, chrootdir \"%s\".", Conf_Chroot );
827 Log( LOG_INFO, "Not running chrooted." );
830 /* Change working directory to home directory of the user
831 * we are running as (only when running in daemon mode and not in chroot) */
834 if (!NGIRCd_NoDaemon ) {
835 if( chdir( pwd->pw_dir ) == 0 )
836 Log( LOG_DEBUG, "Changed working directory to \"%s\" ...", pwd->pw_dir );
838 Log( LOG_INFO, "Notice: Can't change working directory to \"%s\": %s",
839 pwd->pw_dir, strerror( errno ));
842 Log( LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID );