2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2011 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)
47 #include "sighandlers.h"
55 static void Show_Version PARAMS(( void ));
56 static void Show_Help PARAMS(( void ));
58 static void Pidfile_Create PARAMS(( pid_t pid ));
59 static void Pidfile_Delete PARAMS(( void ));
61 static void Fill_Version PARAMS(( void ));
63 static void Random_Init PARAMS(( void ));
65 static void Setup_FDStreams PARAMS(( int fd ));
67 static bool NGIRCd_Init PARAMS(( bool ));
71 * 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.
76 * @param argc The number of arguments passed to ngIRCd on the command line.
77 * @param argv An array containing all the arguments passed to ngIRCd.
78 * @return Global exit code of ngIRCd, zero on success.
81 main( int argc, const char *argv[] )
83 bool ok, configtest = false;
84 bool NGIRCd_NoDaemon = false;
88 #if defined(DEBUG) && defined(HAVE_MTRACE)
89 /* enable GNU libc memory tracing when running in debug mode
90 * and functionality available */
96 NGIRCd_SignalQuit = NGIRCd_SignalRestart = false;
97 NGIRCd_Passive = false;
102 NGIRCd_Sniffer = false;
104 strlcpy( NGIRCd_ConfFile, SYSCONFDIR, sizeof( NGIRCd_ConfFile ));
105 strlcat( NGIRCd_ConfFile, CONFIG_FILE, sizeof( NGIRCd_ConfFile ));
109 /* parse conmmand line */
110 for( i = 1; i < argc; i++ )
113 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 for "VERSION" command */
240 NGIRCd_DebugLevel[0] = '\0';
242 if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" );
248 strcpy( NGIRCd_DebugLevel, "2" );
254 Show_Version( ); puts( "" );
258 while( ! NGIRCd_SignalQuit )
260 /* Initialize global variables */
261 NGIRCd_Start = time( NULL );
262 (void)strftime( NGIRCd_StartStr, 64, "%a %b %d %Y at %H:%M:%S (%Z)", localtime( &NGIRCd_Start ));
264 NGIRCd_SignalRestart = false;
265 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 ... */
286 if (!io_library_init(CONNECTION_POOL)) {
287 Log(LOG_ALERT, "Fatal: Cannot initialize IO routines: %s", strerror(errno));
291 if (!Signals_Init()) {
292 Log(LOG_ALERT, "Fatal: Could not set up signal handlers: %s", strerror(errno));
296 /* Create protocol and server identification. The syntax
297 * used by ngIRCd in PASS commands and the known "extended
298 * flags" are described in doc/Protocol.txt. */
300 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS );
302 strcat( NGIRCd_ProtoID, "Z" );
304 if( Conf_OperCanMode ) strcat( NGIRCd_ProtoID, "o" );
306 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s", PROTOVER, PROTOIRC, PACKAGE_NAME, PACKAGE_VERSION );
308 strlcat( NGIRCd_ProtoID, " P", sizeof NGIRCd_ProtoID );
310 strlcat( NGIRCd_ProtoID, "Z", sizeof NGIRCd_ProtoID );
312 LogDebug("Protocol and server ID is \"%s\".", NGIRCd_ProtoID);
314 Channel_InitPredefined( );
316 if( Conn_InitListeners( ) < 1 )
318 Log( LOG_ALERT, "Server isn't listening on a single port!" );
319 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
339 * Generate ngIRCd "version strings".
341 * The ngIRCd version information is generated once and then stored in the
342 * NGIRCd_Version and NGIRCd_VersionAddition string variables for further
343 * usage, for example by the IRC command "VERSION" and the --version command
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 );
357 strlcat( NGIRCd_VersionAddition, "ZLIB", sizeof NGIRCd_VersionAddition );
360 if ( NGIRCd_VersionAddition[0] ) strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
361 strlcat( NGIRCd_VersionAddition, "SSL", sizeof NGIRCd_VersionAddition );
364 if( NGIRCd_VersionAddition[0] )
365 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
366 strlcat( NGIRCd_VersionAddition, "TCPWRAP", sizeof NGIRCd_VersionAddition );
369 if( NGIRCd_VersionAddition[0] )
370 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
371 strlcat( NGIRCd_VersionAddition, "IDENT", sizeof NGIRCd_VersionAddition );
374 if (NGIRCd_VersionAddition[0])
375 strlcat(NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition);
376 strlcat(NGIRCd_VersionAddition, "PAM", sizeof NGIRCd_VersionAddition);
379 if( NGIRCd_VersionAddition[0] )
380 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
381 strlcat( NGIRCd_VersionAddition, "DEBUG", sizeof NGIRCd_VersionAddition );
384 if( NGIRCd_VersionAddition[0] )
385 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
386 strlcat( NGIRCd_VersionAddition, "SNIFFER", sizeof NGIRCd_VersionAddition );
389 if( NGIRCd_VersionAddition[0] )
390 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
391 strlcat( NGIRCd_VersionAddition, "RFC", sizeof NGIRCd_VersionAddition );
394 if( NGIRCd_VersionAddition[0] )
395 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
396 strlcat( NGIRCd_VersionAddition, "IRCPLUS", sizeof NGIRCd_VersionAddition );
399 if (NGIRCd_VersionAddition[0])
400 strlcat(NGIRCd_VersionAddition, "+", sizeof(NGIRCd_VersionAddition));
401 strlcat(NGIRCd_VersionAddition, "IPv6", sizeof(NGIRCd_VersionAddition));
403 if( NGIRCd_VersionAddition[0] )
404 strlcat( NGIRCd_VersionAddition, "-", sizeof( NGIRCd_VersionAddition ));
406 strlcat( NGIRCd_VersionAddition, TARGET_CPU, sizeof( NGIRCd_VersionAddition ));
407 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
408 strlcat( NGIRCd_VersionAddition, TARGET_VENDOR, sizeof( NGIRCd_VersionAddition ));
409 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
410 strlcat( NGIRCd_VersionAddition, TARGET_OS, sizeof( NGIRCd_VersionAddition ));
412 snprintf(NGIRCd_Version, sizeof NGIRCd_Version, "%s %s-%s",
413 PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_VersionAddition);
418 * Display copyright and version information of ngIRCd on the console.
423 puts( NGIRCd_Version );
424 puts( "Copyright (c)2001-2011 Alexander Barton (<alex@barton.de>) and Contributors." );
425 puts( "Homepage: <http://ngircd.barton.de/>\n" );
426 puts( "This is free software; see the source for copying conditions. There is NO" );
427 puts( "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." );
432 * Display a short help text on the console.
433 * This help depends on the configuration of the executable and only shows
434 * options that are actually enabled.
440 puts( " -d, --debug log extra debug messages" );
442 puts( " -f, --config <f> use file <f> as configuration file" );
443 puts( " -n, --nodaemon don't fork and don't detach from controlling terminal" );
444 puts( " -p, --passive disable automatic connections to other servers" );
446 puts( " -s, --sniffer enable network sniffer and display all IRC traffic" );
448 puts( " -t, --configtest read, validate and display configuration; then exit" );
449 puts( " -V, --version output version information and exit" );
450 puts( " -h, --help display this help and exit" );
455 * Delete the file containing the process ID (PID).
458 Pidfile_Delete( void )
460 /* Pidfile configured? */
461 if( ! Conf_PidFile[0] ) return;
464 Log( LOG_DEBUG, "Removing PID file (%s) ...", Conf_PidFile );
467 if( unlink( Conf_PidFile ))
468 Log( LOG_ERR, "Error unlinking PID file (%s): %s", Conf_PidFile, strerror( errno ));
469 } /* Pidfile_Delete */
473 * Create the file containing the process ID of ngIRCd ("PID file").
475 * @param pid The process ID to be stored in this file.
478 Pidfile_Create(pid_t pid)
484 /* Pidfile configured? */
485 if( ! Conf_PidFile[0] ) return;
488 Log( LOG_DEBUG, "Creating PID file (%s) ...", Conf_PidFile );
491 pidfd = open( Conf_PidFile, O_RDWR|O_CREAT|O_EXCL, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
493 Log( LOG_ERR, "Error writing PID file (%s): %s", Conf_PidFile, strerror( errno ));
497 len = snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
498 if (len < 0 || len >= (int)sizeof pidbuf) {
499 Log( LOG_ERR, "Error converting pid");
503 if (write(pidfd, pidbuf, (size_t)len) != (ssize_t)len)
504 Log( LOG_ERR, "Can't write PID file (%s): %s", Conf_PidFile, strerror( errno ));
506 if( close(pidfd) != 0 )
507 Log( LOG_ERR, "Error closing PID file (%s): %s", Conf_PidFile, strerror( errno ));
508 } /* Pidfile_Create */
512 * Redirect stdin, stdout and stderr to apropriate file handles.
514 * @param fd The file handle stdin, stdout and stderr should be redirected to.
517 Setup_FDStreams(int fd)
525 /* Create new stdin(0), stdout(1) and stderr(2) descriptors */
526 dup2( fd, 0 ); dup2( fd, 1 ); dup2( fd, 2 );
527 } /* Setup_FDStreams */
531 * Get user and group ID of unprivileged "nobody" user.
534 * @param gid Group ID
535 * @return true on success.
538 NGIRCd_getNobodyID(uid_t *uid, gid_t *gid )
544 * It can return EINVAL instead of EPERM
545 * so, if we are already unprivileged,
546 * use id of current user.
548 if (geteuid() && getuid()) {
555 pwd = getpwnam("nobody");
556 if (!pwd) return false;
558 if ( !pwd->pw_uid || !pwd->pw_gid)
566 } /* NGIRCd_getNobodyID */
570 Random_Init_Kern(const char *file)
574 int fd = open(file, O_RDONLY);
576 if (read(fd, &seed, sizeof(seed)) == sizeof(seed))
585 * Initialize libc rand(3) number generator
590 if (Random_Init_Kern("/dev/urandom"))
592 if (Random_Init_Kern("/dev/random"))
594 if (Random_Init_Kern("/dev/arandom"))
596 srand(rand() ^ getpid() ^ time(NULL));
601 * Initialize ngIRCd daemon.
603 * @param NGIRCd_NoDaemon Set to true if ngIRCd should run in the
604 * foreground and not as a daemon.
605 * @return true on success.
608 NGIRCd_Init( bool NGIRCd_NoDaemon )
610 static bool initialized;
611 bool chrooted = false;
614 int real_errno, fd = -1;
620 if (!NGIRCd_NoDaemon) {
621 /* open /dev/null before chroot() */
622 fd = open( "/dev/null", O_RDWR);
624 Log(LOG_WARNING, "Could not open /dev/null: %s", strerror(errno));
627 if (!ConnSSL_InitLibrary())
629 "Warning: Error during SSL initialization, continuing ...");
631 if( Conf_Chroot[0] ) {
632 if( chdir( Conf_Chroot ) != 0 ) {
633 Log( LOG_ERR, "Can't chdir() in ChrootDir (%s): %s", Conf_Chroot, strerror( errno ));
637 if( chroot( Conf_Chroot ) != 0 ) {
638 if (errno != EPERM) {
639 Log( LOG_ERR, "Can't change root directory to \"%s\": %s",
640 Conf_Chroot, strerror( errno ));
645 Log( LOG_INFO, "Changed root and working directory to \"%s\".", Conf_Chroot );
650 Log(LOG_INFO, "ServerUID must not be 0, using \"nobody\" instead.", Conf_UID);
652 if (! NGIRCd_getNobodyID(&Conf_UID, &Conf_GID)) {
653 Log(LOG_WARNING, "Could not get user/group ID of user \"nobody\": %s",
654 errno ? strerror(errno) : "not found" );
659 if (getgid() != Conf_GID) {
660 /* Change group ID */
661 if (setgid(Conf_GID) != 0) {
663 Log( LOG_ERR, "Can't change group ID to %u: %s", Conf_GID, strerror( errno ));
664 if (real_errno != EPERM)
669 if (getuid() != Conf_UID) {
671 if (setuid(Conf_UID) != 0) {
673 Log(LOG_ERR, "Can't change user ID to %u: %s", Conf_UID, strerror(errno));
674 if (real_errno != EPERM)
681 /* Normally a child process is forked which isn't any longer
682 * connected to ther controlling terminal. Use "--nodaemon"
683 * to disable this "daemon mode" (useful for debugging). */
684 if ( ! NGIRCd_NoDaemon ) {
687 /* "Old" process: exit. */
692 fprintf( stderr, "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
693 PACKAGE_NAME, strerror( errno ));
697 /* New child process */
701 setpgrp(0, getpid());
703 if (chdir( "/" ) != 0)
704 Log(LOG_ERR, "Can't change directory to '/': %s",
707 /* Detach stdin, stdout and stderr */
714 Pidfile_Create( pid );
716 /* Check UID/GID we are running as, can be different from values
717 * configured (e. g. if we were already started with a UID>0. */
721 pwd = getpwuid( Conf_UID );
722 grp = getgrgid( Conf_GID );
724 Log(LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
725 pwd ? pwd->pw_name : "unknown", (long)Conf_UID,
726 grp ? grp->gr_name : "unknown", (long)Conf_GID, (long)pid);
729 Log(LOG_INFO, "Running with root directory \"%s\".",
733 Log(LOG_INFO, "Not running with changed root directory.");
735 /* Change working directory to home directory of the user
736 * we are running as (only when running in daemon mode and not in chroot) */
739 if (!NGIRCd_NoDaemon ) {
740 if( chdir( pwd->pw_dir ) == 0 )
741 Log( LOG_DEBUG, "Changed working directory to \"%s\" ...", pwd->pw_dir );
743 Log( LOG_INFO, "Notice: Can't change working directory to \"%s\": %s",
744 pwd->pw_dir, strerror( errno ));
747 Log( LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID );