2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2012 Alexander Barton (alex@barton.de) and Contributors.
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.
16 * The main program, including the C function main() which is called
17 * by the loader of the operating system.
29 #include <sys/types.h>
35 #if defined(DEBUG) && defined(HAVE_MTRACE)
48 #include "sighandlers.h"
56 static void Show_Version PARAMS(( void ));
57 static void Show_Help PARAMS(( void ));
59 static void Pidfile_Create PARAMS(( pid_t pid ));
60 static void Pidfile_Delete PARAMS(( void ));
62 static void Fill_Version PARAMS(( void ));
64 static void Random_Init PARAMS(( void ));
66 static void Setup_FDStreams PARAMS(( int fd ));
68 static bool NGIRCd_Init PARAMS(( bool ));
72 * The main() function of ngIRCd.
74 * Here all starts: this function is called by the operating system loader,
75 * it is the first portion of code executed of ngIRCd.
77 * @param argc The number of arguments passed to ngIRCd on the command line.
78 * @param argv An array containing all the arguments passed to ngIRCd.
79 * @return Global exit code of ngIRCd, zero on success.
82 main( int argc, const char *argv[] )
84 bool ok, configtest = false;
85 bool NGIRCd_NoDaemon = false;
89 #if defined(DEBUG) && defined(HAVE_MTRACE)
90 /* enable GNU libc memory tracing when running in debug mode
91 * and functionality available */
97 NGIRCd_SignalQuit = NGIRCd_SignalRestart = false;
98 NGIRCd_Passive = false;
100 NGIRCd_Debug = false;
103 NGIRCd_Sniffer = false;
105 strlcpy( NGIRCd_ConfFile, SYSCONFDIR, sizeof( NGIRCd_ConfFile ));
106 strlcat( NGIRCd_ConfFile, CONFIG_FILE, sizeof( NGIRCd_ConfFile ));
110 /* parse conmmand line */
111 for( i = 1; i < argc; i++ )
114 if(( argv[i][0] == '-' ) && ( argv[i][1] == '-' ))
117 if( strcmp( argv[i], "--config" ) == 0 )
121 /* Ok, there's an parameter left */
122 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
128 if( strcmp( argv[i], "--configtest" ) == 0 )
134 if( strcmp( argv[i], "--debug" ) == 0 )
140 if( strcmp( argv[i], "--help" ) == 0 )
143 puts( "" ); Show_Help( ); puts( "" );
146 if( strcmp( argv[i], "--nodaemon" ) == 0 )
148 NGIRCd_NoDaemon = true;
151 if( strcmp( argv[i], "--passive" ) == 0 )
153 NGIRCd_Passive = true;
157 if( strcmp( argv[i], "--sniffer" ) == 0 )
159 NGIRCd_Sniffer = true;
163 if( strcmp( argv[i], "--version" ) == 0 )
169 else if(( argv[i][0] == '-' ) && ( argv[i][1] != '-' ))
172 for( n = 1; n < strlen( argv[i] ); n++ )
176 if (argv[i][n] == 'd') {
181 if (argv[i][n] == 'f') {
182 if(( ! argv[i][n + 1] ) && ( i + 1 < argc ))
184 /* Ok, next character is a blank */
185 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
187 /* go to the following parameter */
189 n = strlen( argv[i] );
194 if (argv[i][n] == 'h') {
196 puts(""); Show_Help(); puts("");
200 if (argv[i][n] == 'n') {
201 NGIRCd_NoDaemon = true;
204 if (argv[i][n] == 'p') {
205 NGIRCd_Passive = true;
209 if (argv[i][n] == 's') {
210 NGIRCd_Sniffer = true;
214 if (argv[i][n] == 't') {
219 if (argv[i][n] == 'V') {
225 printf( "%s: invalid option \"-%c\"!\n", PACKAGE_NAME, argv[i][n] );
226 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
234 printf( "%s: invalid option \"%s\"!\n", PACKAGE_NAME, argv[i] );
235 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
240 /* Debug level for "VERSION" command */
241 NGIRCd_DebugLevel[0] = '\0';
243 if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" );
249 strcpy( NGIRCd_DebugLevel, "2" );
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_SignalRestart = false;
266 NGIRCd_SignalQuit = false;
270 /* Initialize modules, part I */
271 Log_Init( ! NGIRCd_NoDaemon );
274 /* Initialize the "main program": chroot environment, user and
276 if (!NGIRCd_Init(NGIRCd_NoDaemon)) {
277 Log(LOG_ALERT, "Fatal: Initialization failed");
281 /* Initialize modules, part II: these functions are eventually
282 * called with already dropped privileges ... */
288 if (!io_library_init(CONNECTION_POOL)) {
289 Log(LOG_ALERT, "Fatal: Cannot initialize IO routines: %s", strerror(errno));
293 if (!Signals_Init()) {
294 Log(LOG_ALERT, "Fatal: Could not set up signal handlers: %s", strerror(errno));
298 /* Create protocol and server identification. The syntax
299 * used by ngIRCd in PASS commands and the known "extended
300 * flags" are described in doc/Protocol.txt. */
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 LogDebug("Protocol and server ID is \"%s\".", NGIRCd_ProtoID);
316 Channel_InitPredefined( );
318 if( Conn_InitListeners( ) < 1 )
320 Log( LOG_ALERT, "Server isn't listening on a single port!" );
321 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
342 * Generate ngIRCd "version strings".
344 * The ngIRCd version information is generated once and then stored in the
345 * NGIRCd_Version and NGIRCd_VersionAddition string variables for further
346 * usage, for example by the IRC command "VERSION" and the --version command
352 NGIRCd_VersionAddition[0] = '\0';
355 strlcpy( NGIRCd_VersionAddition, "SYSLOG", sizeof NGIRCd_VersionAddition );
358 if( NGIRCd_VersionAddition[0] )
359 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
360 strlcat( NGIRCd_VersionAddition, "ZLIB", sizeof NGIRCd_VersionAddition );
363 if ( NGIRCd_VersionAddition[0] ) strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
364 strlcat( NGIRCd_VersionAddition, "SSL", sizeof NGIRCd_VersionAddition );
367 if( NGIRCd_VersionAddition[0] )
368 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
369 strlcat( NGIRCd_VersionAddition, "TCPWRAP", sizeof NGIRCd_VersionAddition );
372 if( NGIRCd_VersionAddition[0] )
373 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);
379 strlcat(NGIRCd_VersionAddition, "PAM", sizeof NGIRCd_VersionAddition);
382 if( NGIRCd_VersionAddition[0] )
383 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
384 strlcat( NGIRCd_VersionAddition, "DEBUG", sizeof NGIRCd_VersionAddition );
387 if( NGIRCd_VersionAddition[0] )
388 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
389 strlcat( NGIRCd_VersionAddition, "SNIFFER", sizeof NGIRCd_VersionAddition );
392 if( NGIRCd_VersionAddition[0] )
393 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 );
399 strlcat( NGIRCd_VersionAddition, "IRCPLUS", sizeof NGIRCd_VersionAddition );
402 if (NGIRCd_VersionAddition[0])
403 strlcat(NGIRCd_VersionAddition, "+", sizeof(NGIRCd_VersionAddition));
404 strlcat(NGIRCd_VersionAddition, "IPv6", sizeof(NGIRCd_VersionAddition));
406 if( NGIRCd_VersionAddition[0] )
407 strlcat( NGIRCd_VersionAddition, "-", sizeof( NGIRCd_VersionAddition ));
409 strlcat( NGIRCd_VersionAddition, TARGET_CPU, sizeof( NGIRCd_VersionAddition ));
410 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
411 strlcat( NGIRCd_VersionAddition, TARGET_VENDOR, sizeof( NGIRCd_VersionAddition ));
412 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
413 strlcat( NGIRCd_VersionAddition, TARGET_OS, sizeof( NGIRCd_VersionAddition ));
415 snprintf(NGIRCd_Version, sizeof NGIRCd_Version, "%s %s-%s",
416 PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_VersionAddition);
421 * Display copyright and version information of ngIRCd on the console.
426 puts( NGIRCd_Version );
427 puts( "Copyright (c)2001-2012 Alexander Barton (<alex@barton.de>) and Contributors." );
428 puts( "Homepage: <http://ngircd.barton.de/>\n" );
429 puts( "This is free software; see the source for copying conditions. There is NO" );
430 puts( "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." );
435 * Display a short help text on the console.
436 * This help depends on the configuration of the executable and only shows
437 * options that are actually enabled.
443 puts( " -d, --debug log extra debug messages" );
445 puts( " -f, --config <f> use file <f> as configuration file" );
446 puts( " -n, --nodaemon don't fork and don't detach from controlling terminal" );
447 puts( " -p, --passive disable automatic connections to other servers" );
449 puts( " -s, --sniffer enable network sniffer and display all IRC traffic" );
451 puts( " -t, --configtest read, validate and display configuration; then exit" );
452 puts( " -V, --version output version information and exit" );
453 puts( " -h, --help display this help and exit" );
458 * Delete the file containing the process ID (PID).
461 Pidfile_Delete( void )
463 /* Pidfile configured? */
464 if( ! Conf_PidFile[0] ) return;
467 Log( LOG_DEBUG, "Removing PID file (%s) ...", Conf_PidFile );
470 if( unlink( Conf_PidFile ))
471 Log( LOG_ERR, "Error unlinking PID file (%s): %s", Conf_PidFile, strerror( errno ));
472 } /* Pidfile_Delete */
476 * Create the file containing the process ID of ngIRCd ("PID file").
478 * @param pid The process ID to be stored in this file.
481 Pidfile_Create(pid_t pid)
487 /* Pidfile configured? */
488 if( ! Conf_PidFile[0] ) return;
491 Log( LOG_DEBUG, "Creating PID file (%s) ...", Conf_PidFile );
494 pidfd = open( Conf_PidFile, O_RDWR|O_CREAT|O_EXCL, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
496 Log( LOG_ERR, "Error writing PID file (%s): %s", Conf_PidFile, strerror( errno ));
500 len = snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
501 if (len < 0 || len >= (int)sizeof pidbuf) {
502 Log( LOG_ERR, "Error converting pid");
506 if (write(pidfd, pidbuf, (size_t)len) != (ssize_t)len)
507 Log( LOG_ERR, "Can't write PID file (%s): %s", Conf_PidFile, strerror( errno ));
509 if( close(pidfd) != 0 )
510 Log( LOG_ERR, "Error closing PID file (%s): %s", Conf_PidFile, strerror( errno ));
511 } /* Pidfile_Create */
515 * Redirect stdin, stdout and stderr to apropriate file handles.
517 * @param fd The file handle stdin, stdout and stderr should be redirected to.
520 Setup_FDStreams(int fd)
528 /* Create new stdin(0), stdout(1) and stderr(2) descriptors */
529 dup2( fd, 0 ); dup2( fd, 1 ); dup2( fd, 2 );
530 } /* Setup_FDStreams */
534 * Get user and group ID of unprivileged "nobody" user.
537 * @param gid Group ID
538 * @return true on success.
541 NGIRCd_getNobodyID(uid_t *uid, gid_t *gid )
547 * It can return EINVAL instead of EPERM
548 * so, if we are already unprivileged,
549 * use id of current user.
551 if (geteuid() && getuid()) {
558 pwd = getpwnam("nobody");
559 if (!pwd) return false;
561 if ( !pwd->pw_uid || !pwd->pw_gid)
569 } /* NGIRCd_getNobodyID */
573 Random_Init_Kern(const char *file)
577 int fd = open(file, O_RDONLY);
579 if (read(fd, &seed, sizeof(seed)) == sizeof(seed))
588 * Initialize libc rand(3) number generator
593 if (Random_Init_Kern("/dev/urandom"))
595 if (Random_Init_Kern("/dev/random"))
597 if (Random_Init_Kern("/dev/arandom"))
599 srand(rand() ^ (unsigned)getpid() ^ (unsigned)time(NULL));
604 * Initialize ngIRCd daemon.
606 * @param NGIRCd_NoDaemon Set to true if ngIRCd should run in the
607 * foreground and not as a daemon.
608 * @return true on success.
611 NGIRCd_Init( bool NGIRCd_NoDaemon )
613 static bool initialized;
614 bool chrooted = false;
617 int real_errno, fd = -1;
623 if (!NGIRCd_NoDaemon) {
624 /* open /dev/null before chroot() */
625 fd = open( "/dev/null", O_RDWR);
627 Log(LOG_WARNING, "Could not open /dev/null: %s", strerror(errno));
630 if (!ConnSSL_InitLibrary())
632 "Warning: Error during SSL initialization, continuing ...");
634 if( Conf_Chroot[0] ) {
635 if( chdir( Conf_Chroot ) != 0 ) {
636 Log( LOG_ERR, "Can't chdir() in ChrootDir (%s): %s", Conf_Chroot, strerror( errno ));
640 if( chroot( Conf_Chroot ) != 0 ) {
641 if (errno != EPERM) {
642 Log( LOG_ERR, "Can't change root directory to \"%s\": %s",
643 Conf_Chroot, strerror( errno ));
648 Log( LOG_INFO, "Changed root and working directory to \"%s\".", Conf_Chroot );
653 Log(LOG_INFO, "ServerUID must not be 0, using \"nobody\" instead.", Conf_UID);
655 if (! NGIRCd_getNobodyID(&Conf_UID, &Conf_GID)) {
656 Log(LOG_WARNING, "Could not get user/group ID of user \"nobody\": %s",
657 errno ? strerror(errno) : "not found" );
662 if (getgid() != Conf_GID) {
663 /* Change group ID */
664 if (setgid(Conf_GID) != 0) {
666 Log( LOG_ERR, "Can't change group ID to %u: %s", Conf_GID, strerror( errno ));
667 if (real_errno != EPERM)
672 if (getuid() != Conf_UID) {
674 if (setuid(Conf_UID) != 0) {
676 Log(LOG_ERR, "Can't change user ID to %u: %s", Conf_UID, strerror(errno));
677 if (real_errno != EPERM)
684 /* Normally a child process is forked which isn't any longer
685 * connected to ther controlling terminal. Use "--nodaemon"
686 * to disable this "daemon mode" (useful for debugging). */
687 if ( ! NGIRCd_NoDaemon ) {
690 /* "Old" process: exit. */
695 fprintf( stderr, "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
696 PACKAGE_NAME, strerror( errno ));
700 /* New child process */
704 setpgrp(0, getpid());
706 if (chdir( "/" ) != 0)
707 Log(LOG_ERR, "Can't change directory to '/': %s",
710 /* Detach stdin, stdout and stderr */
717 Pidfile_Create( pid );
719 /* Check UID/GID we are running as, can be different from values
720 * configured (e. g. if we were already started with a UID>0. */
724 pwd = getpwuid( Conf_UID );
725 grp = getgrgid( Conf_GID );
727 Log(LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
728 pwd ? pwd->pw_name : "unknown", (long)Conf_UID,
729 grp ? grp->gr_name : "unknown", (long)Conf_GID, (long)pid);
732 Log(LOG_INFO, "Running with root directory \"%s\".",
736 Log(LOG_INFO, "Not running with changed root directory.");
738 /* Change working directory to home directory of the user
739 * we are running as (only when running in daemon mode and not in chroot) */
742 if (!NGIRCd_NoDaemon ) {
743 if( chdir( pwd->pw_dir ) == 0 )
744 Log( LOG_DEBUG, "Changed working directory to \"%s\" ...", pwd->pw_dir );
746 Log( LOG_INFO, "Notice: Can't change working directory to \"%s\": %s",
747 pwd->pw_dir, strerror( errno ));
750 Log( LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID );