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)
54 #include "rendezvous.h"
61 static void Initialize_Signal_Handler PARAMS(( void ));
62 static void Signal_Handler PARAMS(( int Signal ));
64 static void Show_Version PARAMS(( void ));
65 static void Show_Help PARAMS(( void ));
67 static void Pidfile_Create PARAMS(( pid_t pid ));
68 static void Pidfile_Delete PARAMS(( void ));
70 static void Fill_Version PARAMS(( void ));
72 static void Setup_FDStreams PARAMS(( void ));
74 static bool NGIRCd_Init PARAMS(( bool ));
77 * The main() function of ngIRCd.
78 * Here all starts: this function is called by the operating system loader,
79 * it is the first portion of code executed of ngIRCd.
80 * @param argc The number of arguments passed to ngIRCd on the command line.
81 * @param argv An array containing all the arguments passed to ngIRCd.
82 * @return Global exit code of ngIRCd, zero on success.
85 main( int argc, const char *argv[] )
87 bool ok, configtest = false;
88 bool NGIRCd_NoDaemon = false;
92 #if defined(DEBUG) && defined(HAVE_MTRACE)
93 /* enable GNU libc memory tracing when running in debug mode
94 * and functionality available */
100 NGIRCd_SignalQuit = NGIRCd_SignalRestart = NGIRCd_SignalRehash = false;
101 NGIRCd_Passive = false;
103 NGIRCd_Debug = false;
106 NGIRCd_Sniffer = false;
108 strlcpy( NGIRCd_ConfFile, SYSCONFDIR, sizeof( NGIRCd_ConfFile ));
109 strlcat( NGIRCd_ConfFile, CONFIG_FILE, sizeof( NGIRCd_ConfFile ));
113 /* Kommandozeile parsen */
114 for( i = 1; i < argc; i++ )
117 if(( argv[i][0] == '-' ) && ( argv[i][1] == '-' ))
121 if( strcmp( argv[i], "--config" ) == 0 )
125 /* Ok, there's an parameter left */
126 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
132 if( strcmp( argv[i], "--configtest" ) == 0 )
138 if( strcmp( argv[i], "--debug" ) == 0 )
144 if( strcmp( argv[i], "--help" ) == 0 )
147 puts( "" ); Show_Help( ); puts( "" );
150 if( strcmp( argv[i], "--nodaemon" ) == 0 )
152 NGIRCd_NoDaemon = true;
155 if( strcmp( argv[i], "--passive" ) == 0 )
157 NGIRCd_Passive = true;
161 if( strcmp( argv[i], "--sniffer" ) == 0 )
163 NGIRCd_Sniffer = true;
167 if( strcmp( argv[i], "--version" ) == 0 )
173 else if(( argv[i][0] == '-' ) && ( argv[i][1] != '-' ))
176 for( n = 1; n < strlen( argv[i] ); n++ )
180 if (argv[i][n] == 'd') {
185 if (argv[i][n] == 'f') {
186 if(( ! argv[i][n + 1] ) && ( i + 1 < argc ))
188 /* Ok, next character is a blank */
189 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
191 /* go to the following parameter */
193 n = strlen( argv[i] );
198 if (argv[i][n] == 'h') {
200 puts(""); Show_Help(); puts("");
204 if (argv[i][n] == 'n') {
205 NGIRCd_NoDaemon = true;
208 if (argv[i][n] == 'p') {
209 NGIRCd_Passive = true;
213 if (argv[i][n] == 's') {
214 NGIRCd_Sniffer = true;
218 if (argv[i][n] == 't') {
223 if (argv[i][n] == 'V') {
229 printf( "%s: invalid option \"-%c\"!\n", PACKAGE_NAME, argv[i][n] );
230 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
238 printf( "%s: invalid option \"%s\"!\n", PACKAGE_NAME, argv[i] );
239 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
244 /* Debug-Level (fuer IRC-Befehl "VERSION") ermitteln */
245 NGIRCd_DebugLevel[0] = '\0';
247 if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" );
253 strcpy( NGIRCd_DebugLevel, "2" );
257 /* Soll nur die Konfigurations ueberprueft und ausgegeben werden? */
260 Show_Version( ); puts( "" );
264 while( ! NGIRCd_SignalQuit )
266 /* Initialize global variables */
267 NGIRCd_Start = time( NULL );
268 (void)strftime( NGIRCd_StartStr, 64, "%a %b %d %Y at %H:%M:%S (%Z)", localtime( &NGIRCd_Start ));
270 NGIRCd_SignalRehash = false;
271 NGIRCd_SignalRestart = false;
272 NGIRCd_SignalQuit = false;
274 /* Initialize modules, part I */
275 Log_Init( ! NGIRCd_NoDaemon );
278 /* Initialize the "main program": chroot environment, user and
280 if (!NGIRCd_Init(NGIRCd_NoDaemon)) {
281 Log(LOG_ALERT, "Fatal: Initialization failed");
285 /* Initialize modules, part II: these functions are eventually
286 * called with already dropped privileges ... */
295 /* Redirect stderr handle to "error file" for debugging
296 * when not running in "no daemon" mode: */
297 if( ! NGIRCd_NoDaemon ) Log_InitErrorfile( );
300 /* Signal-Handler initialisieren */
301 Initialize_Signal_Handler( );
303 /* Protokoll- und Server-Identifikation erzeugen. Die vom ngIRCd
304 * beim PASS-Befehl verwendete Syntax sowie die erweiterten Flags
305 * sind in doc/Protocol.txt beschrieben. */
307 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS );
309 strcat( NGIRCd_ProtoID, "Z" );
311 if( Conf_OperCanMode ) strcat( NGIRCd_ProtoID, "o" );
313 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s", PROTOVER, PROTOIRC, PACKAGE_NAME, PACKAGE_VERSION );
315 strlcat( NGIRCd_ProtoID, " P", sizeof NGIRCd_ProtoID );
317 strlcat( NGIRCd_ProtoID, "Z", sizeof NGIRCd_ProtoID );
319 Log( LOG_DEBUG, "Protocol and server ID is \"%s\".", NGIRCd_ProtoID );
321 /* Vordefinierte Channels anlegen */
322 Channel_InitPredefined( );
324 /* Listen-Ports initialisieren */
325 if( Conn_InitListeners( ) < 1 )
327 Log( LOG_ALERT, "Server isn't listening on a single port!" );
328 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
352 * Generate ngIRCd "version string".
353 * This string is generated once and then stored in NGIRCd_Version for
354 * further usage, for example by the IRC command VERSION and the --version
355 * command line switch.
360 NGIRCd_VersionAddition[0] = '\0';
363 strlcpy( NGIRCd_VersionAddition, "SYSLOG", sizeof NGIRCd_VersionAddition );
366 if( NGIRCd_VersionAddition[0] )
367 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
369 strlcat( NGIRCd_VersionAddition, "ZLIB", sizeof NGIRCd_VersionAddition );
372 if ( NGIRCd_VersionAddition[0] ) strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
373 strlcat( NGIRCd_VersionAddition, "SSL", sizeof NGIRCd_VersionAddition );
376 if( NGIRCd_VersionAddition[0] )
377 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
379 strlcat( NGIRCd_VersionAddition, "TCPWRAP", sizeof NGIRCd_VersionAddition );
382 if( NGIRCd_VersionAddition[0] )
383 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
385 strlcat( NGIRCd_VersionAddition, "ZEROCONF", sizeof NGIRCd_VersionAddition );
388 if( NGIRCd_VersionAddition[0] )
389 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
391 strlcat( NGIRCd_VersionAddition, "IDENT", sizeof NGIRCd_VersionAddition );
394 if( NGIRCd_VersionAddition[0] )
395 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
397 strlcat( NGIRCd_VersionAddition, "DEBUG", sizeof NGIRCd_VersionAddition );
400 if( NGIRCd_VersionAddition[0] )
401 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
403 strlcat( NGIRCd_VersionAddition, "SNIFFER", sizeof NGIRCd_VersionAddition );
406 if( NGIRCd_VersionAddition[0] )
407 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
409 strlcat( NGIRCd_VersionAddition, "RFC", sizeof NGIRCd_VersionAddition );
412 if( NGIRCd_VersionAddition[0] )
413 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
415 strlcat( NGIRCd_VersionAddition, "IRCPLUS", sizeof NGIRCd_VersionAddition );
418 if (NGIRCd_VersionAddition[0])
419 strlcat(NGIRCd_VersionAddition, "+", sizeof(NGIRCd_VersionAddition));
421 strlcat(NGIRCd_VersionAddition, "IPv6", sizeof(NGIRCd_VersionAddition));
423 if( NGIRCd_VersionAddition[0] )
424 strlcat( NGIRCd_VersionAddition, "-", sizeof( NGIRCd_VersionAddition ));
426 strlcat( NGIRCd_VersionAddition, TARGET_CPU, sizeof( NGIRCd_VersionAddition ));
427 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
428 strlcat( NGIRCd_VersionAddition, TARGET_VENDOR, sizeof( NGIRCd_VersionAddition ));
429 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
430 strlcat( NGIRCd_VersionAddition, TARGET_OS, sizeof( NGIRCd_VersionAddition ));
432 snprintf(NGIRCd_Version, sizeof NGIRCd_Version, "%s %s-%s",
433 PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_VersionAddition);
438 * Reload the server configuration file.
441 NGIRCd_Rehash( void )
443 char old_name[CLIENT_ID_LEN];
444 unsigned old_nicklen;
446 Log( LOG_NOTICE|LOG_snotice, "Re-reading configuration NOW!" );
447 NGIRCd_SignalRehash = false;
449 /* Remember old server name and nick name length */
450 strlcpy( old_name, Conf_ServerName, sizeof old_name );
451 old_nicklen = Conf_MaxNickLength;
453 /* Re-read configuration ... */
457 /* Close down all listening sockets */
458 Conn_ExitListeners( );
460 /* Recover old server name and nick name length: these values can't
461 * be changed during run-time */
462 if (strcmp(old_name, Conf_ServerName) != 0 ) {
463 strlcpy(Conf_ServerName, old_name, sizeof Conf_ServerName);
464 Log(LOG_ERR, "Can't change \"ServerName\" on runtime! Ignored new name.");
466 if (old_nicklen != Conf_MaxNickLength) {
467 Conf_MaxNickLength = old_nicklen;
468 Log(LOG_ERR, "Can't change \"MaxNickLength\" on runtime! Ignored new value.");
471 /* Create new pre-defined channels */
472 Channel_InitPredefined( );
474 if (!ConnSSL_InitLibrary())
475 Log(LOG_WARNING, "Re-Initializing SSL failed, using old keys");
477 /* Start listening on sockets */
478 Conn_InitListeners( );
480 /* Sync configuration with established connections */
481 Conn_SyncServerStruct( );
483 Log( LOG_NOTICE|LOG_snotice, "Re-reading of configuration done." );
484 } /* NGIRCd_Rehash */
488 * Initialize the signal handler.
491 Initialize_Signal_Handler( void )
493 /* Signal-Handler initialisieren: einige Signale
494 * werden ignoriert, andere speziell behandelt. */
496 #ifdef HAVE_SIGACTION
497 /* sigaction() ist vorhanden */
499 struct sigaction saction;
501 /* Signal-Struktur initialisieren */
502 memset( &saction, 0, sizeof( saction ));
503 saction.sa_handler = Signal_Handler;
505 saction.sa_flags |= SA_RESTART;
508 saction.sa_flags |= SA_NOCLDWAIT;
511 /* Signal-Handler einhaengen */
512 sigaction(SIGINT, &saction, NULL);
513 sigaction(SIGQUIT, &saction, NULL);
514 sigaction(SIGTERM, &saction, NULL);
515 sigaction(SIGHUP, &saction, NULL);
516 sigaction(SIGCHLD, &saction, NULL);
518 /* einige Signale ignorieren */
519 saction.sa_handler = SIG_IGN;
520 sigaction(SIGPIPE, &saction, NULL);
522 /* kein sigaction() vorhanden */
524 /* Signal-Handler einhaengen */
525 signal(SIGINT, Signal_Handler);
526 signal(SIGQUIT, Signal_Handler);
527 signal(SIGTERM, Signal_Handler);
528 signal(SIGHUP, Signal_Handler);
529 signal(SIGCHLD, Signal_Handler);
531 /* einige Signale ignorieren */
532 signal(SIGPIPE, SIG_IGN);
534 } /* Initialize_Signal_Handler */
538 * Signal handler of ngIRCd.
539 * This function is called whenever ngIRCd catches a signal sent by the
540 * user and/or the system to it. For example SIGTERM and SIGHUP.
541 * @param Signal Number of the signal to handle.
544 Signal_Handler( int Signal )
551 /* wir soll(t)en uns wohl beenden ... */
552 NGIRCd_SignalQuit = true;
555 /* Konfiguration neu einlesen: */
556 NGIRCd_SignalRehash = true;
559 /* Child-Prozess wurde beendet. Zombies vermeiden: */
560 while( waitpid( -1, NULL, WNOHANG ) > 0);
564 /* unbekanntes bzw. unbehandeltes Signal */
565 Log( LOG_DEBUG, "Got signal %d! Ignored.", Signal );
568 } /* Signal_Handler */
572 * Display copyright and version information of ngIRCd on the console.
577 puts( NGIRCd_Version );
578 puts( "Copyright (c)2001-2008 Alexander Barton (<alex@barton.de>) and Contributors." );
579 puts( "Homepage: <http://ngircd.barton.de/>\n" );
580 puts( "This is free software; see the source for copying conditions. There is NO" );
581 puts( "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." );
586 * Display a short help text on the console.
587 * This help depends on the configuration of the executable and only shows
588 * options that are actually enabled.
594 puts( " -d, --debug log extra debug messages" );
596 puts( " -f, --config <f> use file <f> as configuration file" );
597 puts( " -n, --nodaemon don't fork and don't detach from controlling terminal" );
598 puts( " -p, --passive disable automatic connections to other servers" );
600 puts( " -s, --sniffer enable network sniffer and display all IRC traffic" );
602 puts( " -t, --configtest read, validate and display configuration; then exit" );
603 puts( " -V, --version output version information and exit" );
604 puts( " -h, --help display this help and exit" );
609 * Delete the file containing the process ID (PID).
612 Pidfile_Delete( void )
614 /* Pidfile configured? */
615 if( ! Conf_PidFile[0] ) return;
618 Log( LOG_DEBUG, "Removing PID file (%s) ...", Conf_PidFile );
621 if( unlink( Conf_PidFile ))
622 Log( LOG_ERR, "Error unlinking PID file (%s): %s", Conf_PidFile, strerror( errno ));
623 } /* Pidfile_Delete */
627 * Create the file containing the process ID of ngIRCd ("PID file").
628 * @param pid The process ID to be stored in this file.
631 Pidfile_Create(pid_t pid)
637 /* Pidfile configured? */
638 if( ! Conf_PidFile[0] ) return;
641 Log( LOG_DEBUG, "Creating PID file (%s) ...", Conf_PidFile );
644 pidfd = open( Conf_PidFile, O_RDWR|O_CREAT|O_EXCL, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
646 Log( LOG_ERR, "Error writing PID file (%s): %s", Conf_PidFile, strerror( errno ));
650 len = snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
651 if (len < 0 || len >= (int)sizeof pidbuf) {
652 Log( LOG_ERR, "Error converting pid");
656 if (write(pidfd, pidbuf, (size_t)len) != (ssize_t)len)
657 Log( LOG_ERR, "Can't write PID file (%s): %s", Conf_PidFile, strerror( errno ));
659 if( close(pidfd) != 0 )
660 Log( LOG_ERR, "Error closing PID file (%s): %s", Conf_PidFile, strerror( errno ));
661 } /* Pidfile_Create */
665 * Redirect stdin, stdout and stderr to apropriate file handles.
668 Setup_FDStreams( void )
672 /* Test if we can open /dev/null for reading and writing. If not
673 * we are most probably chrooted already and the server has been
674 * restarted. So we simply don't try to redirect stdXXX ... */
675 fd = open( "/dev/null", O_RDWR );
677 Log(LOG_WARNING, "Could not open /dev/null: %s", strerror(errno));
684 /* Create new stdin(0), stdout(1) and stderr(2) descriptors */
685 dup2( fd, 0 ); dup2( fd, 1 ); dup2( fd, 2 );
687 /* Close newly opened file descriptor if not stdin/out/err */
688 if( fd > 2 ) close( fd );
689 } /* Setup_FDStreams */
693 NGIRCd_getNobodyID(uid_t *uid, gid_t *gid )
699 * It can return EINVAL instead of EPERM
700 * so, if we are already unprivileged,
701 * use id of current user.
703 if (geteuid() && getuid()) {
710 pwd = getpwnam("nobody");
711 if (!pwd) return false;
713 if ( !pwd->pw_uid || !pwd->pw_gid)
725 NGIRCd_Init( bool NGIRCd_NoDaemon )
727 static bool initialized;
728 bool chrooted = false;
737 if (!ConnSSL_InitLibrary())
739 "Warning: Error during SSL initialization, continuing ...");
741 if( Conf_Chroot[0] ) {
742 if( chdir( Conf_Chroot ) != 0 ) {
743 Log( LOG_ERR, "Can't chdir() in ChrootDir (%s): %s", Conf_Chroot, strerror( errno ));
747 if( chroot( Conf_Chroot ) != 0 ) {
748 if (errno != EPERM) {
749 Log( LOG_ERR, "Can't change root directory to \"%s\": %s",
750 Conf_Chroot, strerror( errno ));
756 Log( LOG_INFO, "Changed root and working directory to \"%s\".", Conf_Chroot );
761 Log(LOG_INFO, "ServerUID must not be 0, using \"nobody\" instead.", Conf_UID);
763 if (! NGIRCd_getNobodyID(&Conf_UID, &Conf_GID)) {
764 Log(LOG_WARNING, "Could not get user/group ID of user \"nobody\": %s",
765 errno ? strerror(errno) : "not found" );
770 if (getgid() != Conf_GID) {
771 /* Change group ID */
772 if (setgid(Conf_GID) != 0) {
774 Log( LOG_ERR, "Can't change group ID to %u: %s", Conf_GID, strerror( errno ));
775 if (real_errno != EPERM)
780 if (getuid() != Conf_UID) {
782 if (setuid(Conf_UID) != 0) {
784 Log(LOG_ERR, "Can't change user ID to %u: %s", Conf_UID, strerror(errno));
785 if (real_errno != EPERM)
792 /* Normally a child process is forked which isn't any longer
793 * connected to ther controlling terminal. Use "--nodaemon"
794 * to disable this "daemon mode" (useful for debugging). */
795 if ( ! NGIRCd_NoDaemon ) {
798 /* "Old" process: exit. */
803 fprintf( stderr, "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
804 PACKAGE_NAME, strerror( errno ));
808 /* New child process */
812 setpgrp(0, getpid());
816 /* Detach stdin, stdout and stderr */
821 Pidfile_Create( pid );
823 /* Check UID/GID we are running as, can be different from values
824 * configured (e. g. if we were already started with a UID>0. */
828 pwd = getpwuid( Conf_UID );
829 grp = getgrgid( Conf_GID );
831 Log( LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
832 pwd ? pwd->pw_name : "unknown", Conf_UID,
833 grp ? grp->gr_name : "unknown", Conf_GID, pid);
836 Log(LOG_INFO, "Running with root directory \"%s\".",
840 Log(LOG_INFO, "Not running with changed root directory.");
842 /* Change working directory to home directory of the user
843 * we are running as (only when running in daemon mode and not in chroot) */
846 if (!NGIRCd_NoDaemon ) {
847 if( chdir( pwd->pw_dir ) == 0 )
848 Log( LOG_DEBUG, "Changed working directory to \"%s\" ...", pwd->pw_dir );
850 Log( LOG_INFO, "Notice: Can't change working directory to \"%s\": %s",
851 pwd->pw_dir, strerror( errno ));
854 Log( LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID );