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;
89 NGIRCd_SignalQuit = NGIRCd_SignalRestart = NGIRCd_SignalRehash = false;
90 NGIRCd_Passive = false;
95 NGIRCd_Sniffer = false;
97 strlcpy( NGIRCd_ConfFile, SYSCONFDIR, sizeof( NGIRCd_ConfFile ));
98 strlcat( NGIRCd_ConfFile, CONFIG_FILE, sizeof( NGIRCd_ConfFile ));
102 /* Kommandozeile parsen */
103 for( i = 1; i < argc; i++ )
106 if(( argv[i][0] == '-' ) && ( argv[i][1] == '-' ))
110 if( strcmp( argv[i], "--config" ) == 0 )
114 /* Ok, there's an parameter left */
115 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
121 if( strcmp( argv[i], "--configtest" ) == 0 )
127 if( strcmp( argv[i], "--debug" ) == 0 )
133 if( strcmp( argv[i], "--help" ) == 0 )
136 puts( "" ); Show_Help( ); puts( "" );
139 if( strcmp( argv[i], "--nodaemon" ) == 0 )
141 NGIRCd_NoDaemon = true;
144 if( strcmp( argv[i], "--passive" ) == 0 )
146 NGIRCd_Passive = true;
150 if( strcmp( argv[i], "--sniffer" ) == 0 )
152 NGIRCd_Sniffer = true;
156 if( strcmp( argv[i], "--version" ) == 0 )
162 else if(( argv[i][0] == '-' ) && ( argv[i][1] != '-' ))
165 for( n = 1; n < strlen( argv[i] ); n++ )
169 if (argv[i][n] == 'd') {
174 if (argv[i][n] == 'f') {
175 if(( ! argv[i][n + 1] ) && ( i + 1 < argc ))
177 /* Ok, next character is a blank */
178 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
180 /* go to the following parameter */
182 n = strlen( argv[i] );
187 if (argv[i][n] == 'h') {
189 puts(""); Show_Help(); puts("");
193 if (argv[i][n] == 'n') {
194 NGIRCd_NoDaemon = true;
197 if (argv[i][n] == 'p') {
198 NGIRCd_Passive = true;
202 if (argv[i][n] == 's') {
203 NGIRCd_Sniffer = true;
207 if (argv[i][n] == 't') {
212 if (argv[i][n] == 'V') {
218 printf( "%s: invalid option \"-%c\"!\n", PACKAGE_NAME, argv[i][n] );
219 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
227 printf( "%s: invalid option \"%s\"!\n", PACKAGE_NAME, argv[i] );
228 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
233 /* Debug-Level (fuer IRC-Befehl "VERSION") ermitteln */
234 NGIRCd_DebugLevel[0] = '\0';
236 if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" );
242 strcpy( NGIRCd_DebugLevel, "2" );
246 /* Soll nur die Konfigurations ueberprueft und ausgegeben werden? */
249 Show_Version( ); puts( "" );
253 while( ! NGIRCd_SignalQuit )
255 /* Initialize global variables */
256 NGIRCd_Start = time( NULL );
257 (void)strftime( NGIRCd_StartStr, 64, "%a %b %d %Y at %H:%M:%S (%Z)", localtime( &NGIRCd_Start ));
259 NGIRCd_SignalRehash = false;
260 NGIRCd_SignalRestart = false;
261 NGIRCd_SignalQuit = false;
263 /* Initialize modules, part I */
264 Log_Init( ! NGIRCd_NoDaemon );
267 /* Initialize the "main program": chroot environment, user and
269 if (!NGIRCd_Init(NGIRCd_NoDaemon)) {
270 Log(LOG_ALERT, "Fatal: Initialization failed");
274 /* Initialize modules, part II: these functions are eventually
275 * called with already dropped privileges ... */
284 /* Redirect stderr handle to "error file" for debugging
285 * when not running in "no daemon" mode: */
286 if( ! NGIRCd_NoDaemon ) Log_InitErrorfile( );
289 /* Signal-Handler initialisieren */
290 Initialize_Signal_Handler( );
292 /* Protokoll- und Server-Identifikation erzeugen. Die vom ngIRCd
293 * beim PASS-Befehl verwendete Syntax sowie die erweiterten Flags
294 * sind in doc/Protocol.txt beschrieben. */
296 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS );
298 strcat( NGIRCd_ProtoID, "Z" );
300 if( Conf_OperCanMode ) strcat( NGIRCd_ProtoID, "o" );
302 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s", PROTOVER, PROTOIRC, PACKAGE_NAME, PACKAGE_VERSION );
304 strlcat( NGIRCd_ProtoID, " P", sizeof NGIRCd_ProtoID );
306 strlcat( NGIRCd_ProtoID, "Z", sizeof NGIRCd_ProtoID );
308 Log( LOG_DEBUG, "Protocol and server ID is \"%s\".", NGIRCd_ProtoID );
310 /* Vordefinierte Channels anlegen */
311 Channel_InitPredefined( );
313 /* Listen-Ports initialisieren */
314 if( Conn_InitListeners( ) < 1 )
316 Log( LOG_ALERT, "Server isn't listening on a single port!" );
317 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
341 * Generate ngIRCd "version string".
342 * This string is generated once and then stored in NGIRCd_Version for
343 * further usage, for example by the IRC command VERSION and the --version
344 * command line switch.
349 NGIRCd_VersionAddition[0] = '\0';
352 strlcpy( NGIRCd_VersionAddition, "SYSLOG", sizeof NGIRCd_VersionAddition );
355 if( NGIRCd_VersionAddition[0] )
356 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
358 strlcat( NGIRCd_VersionAddition, "ZLIB", sizeof NGIRCd_VersionAddition );
361 if( NGIRCd_VersionAddition[0] )
362 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
364 strlcat( NGIRCd_VersionAddition, "TCPWRAP", sizeof NGIRCd_VersionAddition );
367 if( NGIRCd_VersionAddition[0] )
368 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
370 strlcat( NGIRCd_VersionAddition, "ZEROCONF", sizeof NGIRCd_VersionAddition );
373 if( NGIRCd_VersionAddition[0] )
374 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
376 strlcat( NGIRCd_VersionAddition, "IDENT", sizeof NGIRCd_VersionAddition );
379 if( NGIRCd_VersionAddition[0] )
380 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
382 strlcat( NGIRCd_VersionAddition, "DEBUG", sizeof NGIRCd_VersionAddition );
385 if( NGIRCd_VersionAddition[0] )
386 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
388 strlcat( NGIRCd_VersionAddition, "SNIFFER", sizeof NGIRCd_VersionAddition );
391 if( NGIRCd_VersionAddition[0] )
392 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
394 strlcat( NGIRCd_VersionAddition, "RFC", sizeof NGIRCd_VersionAddition );
397 if( NGIRCd_VersionAddition[0] )
398 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
400 strlcat( NGIRCd_VersionAddition, "IRCPLUS", sizeof NGIRCd_VersionAddition );
403 if (NGIRCd_VersionAddition[0])
404 strlcat(NGIRCd_VersionAddition, "+", sizeof(NGIRCd_VersionAddition));
406 strlcat(NGIRCd_VersionAddition, "IPv6", sizeof(NGIRCd_VersionAddition));
408 if( NGIRCd_VersionAddition[0] )
409 strlcat( NGIRCd_VersionAddition, "-", sizeof( NGIRCd_VersionAddition ));
411 strlcat( NGIRCd_VersionAddition, TARGET_CPU, sizeof( NGIRCd_VersionAddition ));
412 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
413 strlcat( NGIRCd_VersionAddition, TARGET_VENDOR, sizeof( NGIRCd_VersionAddition ));
414 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
415 strlcat( NGIRCd_VersionAddition, TARGET_OS, sizeof( NGIRCd_VersionAddition ));
417 snprintf(NGIRCd_Version, sizeof NGIRCd_Version, "%s %s-%s",
418 PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_VersionAddition);
423 * Reload the server configuration file.
426 NGIRCd_Rehash( void )
428 char old_name[CLIENT_ID_LEN];
429 unsigned old_nicklen;
431 Log( LOG_NOTICE|LOG_snotice, "Re-reading configuration NOW!" );
432 NGIRCd_SignalRehash = false;
434 /* Remember old server name and nick name length */
435 strlcpy( old_name, Conf_ServerName, sizeof old_name );
436 old_nicklen = Conf_MaxNickLength;
438 /* Re-read configuration ... */
442 /* Close down all listening sockets */
443 Conn_ExitListeners( );
445 /* Recover old server name and nick name length: these values can't
446 * be changed during run-time */
447 if (strcmp(old_name, Conf_ServerName) != 0 ) {
448 strlcpy(Conf_ServerName, old_name, sizeof Conf_ServerName);
449 Log(LOG_ERR, "Can't change \"ServerName\" on runtime! Ignored new name.");
451 if (old_nicklen != Conf_MaxNickLength) {
452 Conf_MaxNickLength = old_nicklen;
453 Log(LOG_ERR, "Can't change \"MaxNickLength\" on runtime! Ignored new value.");
456 /* Create new pre-defined channels */
457 Channel_InitPredefined( );
459 /* Start listening on sockets */
460 Conn_InitListeners( );
462 /* Sync configuration with established connections */
463 Conn_SyncServerStruct( );
465 Log( LOG_NOTICE|LOG_snotice, "Re-reading of configuration done." );
466 } /* NGIRCd_Rehash */
470 * Initialize the signal handler.
473 Initialize_Signal_Handler( void )
475 /* Signal-Handler initialisieren: einige Signale
476 * werden ignoriert, andere speziell behandelt. */
478 #ifdef HAVE_SIGACTION
479 /* sigaction() ist vorhanden */
481 struct sigaction saction;
483 /* Signal-Struktur initialisieren */
484 memset( &saction, 0, sizeof( saction ));
485 saction.sa_handler = Signal_Handler;
487 saction.sa_flags |= SA_RESTART;
490 saction.sa_flags |= SA_NOCLDWAIT;
493 /* Signal-Handler einhaengen */
494 sigaction(SIGINT, &saction, NULL);
495 sigaction(SIGQUIT, &saction, NULL);
496 sigaction(SIGTERM, &saction, NULL);
497 sigaction(SIGHUP, &saction, NULL);
498 sigaction(SIGCHLD, &saction, NULL);
500 /* einige Signale ignorieren */
501 saction.sa_handler = SIG_IGN;
502 sigaction(SIGPIPE, &saction, NULL);
504 /* kein sigaction() vorhanden */
506 /* Signal-Handler einhaengen */
507 signal(SIGINT, Signal_Handler);
508 signal(SIGQUIT, Signal_Handler);
509 signal(SIGTERM, Signal_Handler);
510 signal(SIGHUP, Signal_Handler);
511 signal(SIGCHLD, Signal_Handler);
513 /* einige Signale ignorieren */
514 signal(SIGPIPE, SIG_IGN);
516 } /* Initialize_Signal_Handler */
520 * Signal handler of ngIRCd.
521 * This function is called whenever ngIRCd catches a signal sent by the
522 * user and/or the system to it. For example SIGTERM and SIGHUP.
523 * @param Signal Number of the signal to handle.
526 Signal_Handler( int Signal )
533 /* wir soll(t)en uns wohl beenden ... */
534 NGIRCd_SignalQuit = true;
537 /* Konfiguration neu einlesen: */
538 NGIRCd_SignalRehash = true;
541 /* Child-Prozess wurde beendet. Zombies vermeiden: */
542 while( waitpid( -1, NULL, WNOHANG ) > 0);
546 /* unbekanntes bzw. unbehandeltes Signal */
547 Log( LOG_DEBUG, "Got signal %d! Ignored.", Signal );
550 } /* Signal_Handler */
554 * Display copyright and version information of ngIRCd on the console.
559 puts( NGIRCd_Version );
560 puts( "Copyright (c)2001-2008 Alexander Barton (<alex@barton.de>) and Contributors." );
561 puts( "Homepage: <http://ngircd.barton.de/>\n" );
562 puts( "This is free software; see the source for copying conditions. There is NO" );
563 puts( "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." );
568 * Display a short help text on the console.
569 * This help depends on the configuration of the executable and only shows
570 * options that are actually enabled.
576 puts( " -d, --debug log extra debug messages" );
578 puts( " -f, --config <f> use file <f> as configuration file" );
579 puts( " -n, --nodaemon don't fork and don't detach from controlling terminal" );
580 puts( " -p, --passive disable automatic connections to other servers" );
582 puts( " -s, --sniffer enable network sniffer and display all IRC traffic" );
584 puts( " -t, --configtest read, validate and display configuration; then exit" );
585 puts( " -V, --version output version information and exit" );
586 puts( " -h, --help display this help and exit" );
591 * Delete the file containing the process ID (PID).
594 Pidfile_Delete( void )
596 /* Pidfile configured? */
597 if( ! Conf_PidFile[0] ) return;
600 Log( LOG_DEBUG, "Removing PID file (%s) ...", Conf_PidFile );
603 if( unlink( Conf_PidFile ))
604 Log( LOG_ERR, "Error unlinking PID file (%s): %s", Conf_PidFile, strerror( errno ));
605 } /* Pidfile_Delete */
609 * Create the file containing the process ID of ngIRCd ("PID file").
610 * @param pid The process ID to be stored in this file.
613 Pidfile_Create(pid_t pid)
619 /* Pidfile configured? */
620 if( ! Conf_PidFile[0] ) return;
623 Log( LOG_DEBUG, "Creating PID file (%s) ...", Conf_PidFile );
626 pidfd = open( Conf_PidFile, O_RDWR|O_CREAT|O_EXCL, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
628 Log( LOG_ERR, "Error writing PID file (%s): %s", Conf_PidFile, strerror( errno ));
632 len = snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
633 if (len < 0 || len >= (int)sizeof pidbuf) {
634 Log( LOG_ERR, "Error converting pid");
638 if (write(pidfd, pidbuf, (size_t)len) != (ssize_t)len)
639 Log( LOG_ERR, "Can't write PID file (%s): %s", Conf_PidFile, strerror( errno ));
641 if( close(pidfd) != 0 )
642 Log( LOG_ERR, "Error closing PID file (%s): %s", Conf_PidFile, strerror( errno ));
643 } /* Pidfile_Create */
647 * Redirect stdin, stdout and stderr to apropriate file handles.
650 Setup_FDStreams( void )
654 /* Test if we can open /dev/null for reading and writing. If not
655 * we are most probably chrooted already and the server has been
656 * restarted. So we simply don't try to redirect stdXXX ... */
657 fd = open( "/dev/null", O_RDWR );
659 Log(LOG_WARNING, "Could not open /dev/null: %s", strerror(errno));
666 /* Create new stdin(0), stdout(1) and stderr(2) descriptors */
667 dup2( fd, 0 ); dup2( fd, 1 ); dup2( fd, 2 );
669 /* Close newly opened file descriptor if not stdin/out/err */
670 if( fd > 2 ) close( fd );
671 } /* Setup_FDStreams */
675 NGIRCd_getNobodyID(uid_t *uid, gid_t *gid )
681 * It can return EINVAL instead of EPERM
682 * so, if we are already unprivileged,
683 * use id of current user.
685 if (geteuid() && getuid()) {
692 pwd = getpwnam("nobody");
693 if (!pwd) return false;
695 if ( !pwd->pw_uid || !pwd->pw_gid)
707 NGIRCd_Init( bool NGIRCd_NoDaemon )
709 static bool initialized;
710 bool chrooted = false;
719 if( Conf_Chroot[0] ) {
720 if( chdir( Conf_Chroot ) != 0 ) {
721 Log( LOG_ERR, "Can't chdir() in ChrootDir (%s): %s", Conf_Chroot, strerror( errno ));
725 if( chroot( Conf_Chroot ) != 0 ) {
726 if (errno != EPERM) {
727 Log( LOG_ERR, "Can't change root directory to \"%s\": %s",
728 Conf_Chroot, strerror( errno ));
734 Log( LOG_INFO, "Changed root and working directory to \"%s\".", Conf_Chroot );
739 Log(LOG_INFO, "ServerUID must not be 0, using \"nobody\" instead.", Conf_UID);
741 if (! NGIRCd_getNobodyID(&Conf_UID, &Conf_GID)) {
742 Log(LOG_WARNING, "Could not get user/group ID of user \"nobody\": %s",
743 errno ? strerror(errno) : "not found" );
748 if (getgid() != Conf_GID) {
749 /* Change group ID */
750 if (setgid(Conf_GID) != 0) {
752 Log( LOG_ERR, "Can't change group ID to %u: %s", Conf_GID, strerror( errno ));
753 if (real_errno != EPERM)
758 if (getuid() != Conf_UID) {
760 if (setuid(Conf_UID) != 0) {
762 Log(LOG_ERR, "Can't change user ID to %u: %s", Conf_UID, strerror(errno));
763 if (real_errno != EPERM)
770 /* Normally a child process is forked which isn't any longer
771 * connected to ther controlling terminal. Use "--nodaemon"
772 * to disable this "daemon mode" (useful for debugging). */
773 if ( ! NGIRCd_NoDaemon ) {
776 /* "Old" process: exit. */
781 fprintf( stderr, "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
782 PACKAGE_NAME, strerror( errno ));
786 /* New child process */
790 setpgrp(0, getpid());
794 /* Detach stdin, stdout and stderr */
799 Pidfile_Create( pid );
801 /* Check UID/GID we are running as, can be different from values
802 * configured (e. g. if we were already started with a UID>0. */
806 pwd = getpwuid( Conf_UID );
807 grp = getgrgid( Conf_GID );
809 Log( LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
810 pwd ? pwd->pw_name : "unknown", Conf_UID,
811 grp ? grp->gr_name : "unknown", Conf_GID, pid);
814 Log( LOG_INFO, "Running chrooted, chrootdir \"%s\".", Conf_Chroot );
817 Log( LOG_INFO, "Not running chrooted." );
820 /* Change working directory to home directory of the user
821 * we are running as (only when running in daemon mode and not in chroot) */
824 if (!NGIRCd_NoDaemon ) {
825 if( chdir( pwd->pw_dir ) == 0 )
826 Log( LOG_DEBUG, "Changed working directory to \"%s\" ...", pwd->pw_dir );
828 Log( LOG_INFO, "Notice: Can't change working directory to \"%s\": %s",
829 pwd->pw_dir, strerror( errno ));
832 Log( LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID );