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.
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>
36 #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 Setup_FDStreams PARAMS(( int fd ));
66 static bool NGIRCd_Init PARAMS(( bool ));
70 * The main() function of ngIRCd.
71 * Here all starts: this function is called by the operating system loader,
72 * it is the first portion of code executed of ngIRCd.
73 * @param argc The number of arguments passed to ngIRCd on the command line.
74 * @param argv An array containing all the arguments passed to ngIRCd.
75 * @return Global exit code of ngIRCd, zero on success.
78 main( int argc, const char *argv[] )
80 bool ok, configtest = false;
81 bool NGIRCd_NoDaemon = false;
85 #if defined(DEBUG) && defined(HAVE_MTRACE)
86 /* enable GNU libc memory tracing when running in debug mode
87 * and functionality available */
93 NGIRCd_SignalQuit = NGIRCd_SignalRestart = false;
94 NGIRCd_Passive = false;
99 NGIRCd_Sniffer = false;
101 strlcpy( NGIRCd_ConfFile, SYSCONFDIR, sizeof( NGIRCd_ConfFile ));
102 strlcat( NGIRCd_ConfFile, CONFIG_FILE, sizeof( NGIRCd_ConfFile ));
106 /* parse conmmand line */
107 for( i = 1; i < argc; i++ )
110 if(( argv[i][0] == '-' ) && ( argv[i][1] == '-' ))
113 if( strcmp( argv[i], "--config" ) == 0 )
117 /* Ok, there's an parameter left */
118 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
124 if( strcmp( argv[i], "--configtest" ) == 0 )
130 if( strcmp( argv[i], "--debug" ) == 0 )
136 if( strcmp( argv[i], "--help" ) == 0 )
139 puts( "" ); Show_Help( ); puts( "" );
142 if( strcmp( argv[i], "--nodaemon" ) == 0 )
144 NGIRCd_NoDaemon = true;
147 if( strcmp( argv[i], "--passive" ) == 0 )
149 NGIRCd_Passive = true;
153 if( strcmp( argv[i], "--sniffer" ) == 0 )
155 NGIRCd_Sniffer = true;
159 if( strcmp( argv[i], "--version" ) == 0 )
165 else if(( argv[i][0] == '-' ) && ( argv[i][1] != '-' ))
168 for( n = 1; n < strlen( argv[i] ); n++ )
172 if (argv[i][n] == 'd') {
177 if (argv[i][n] == 'f') {
178 if(( ! argv[i][n + 1] ) && ( i + 1 < argc ))
180 /* Ok, next character is a blank */
181 strlcpy( NGIRCd_ConfFile, argv[i + 1], sizeof( NGIRCd_ConfFile ));
183 /* go to the following parameter */
185 n = strlen( argv[i] );
190 if (argv[i][n] == 'h') {
192 puts(""); Show_Help(); puts("");
196 if (argv[i][n] == 'n') {
197 NGIRCd_NoDaemon = true;
200 if (argv[i][n] == 'p') {
201 NGIRCd_Passive = true;
205 if (argv[i][n] == 's') {
206 NGIRCd_Sniffer = true;
210 if (argv[i][n] == 't') {
215 if (argv[i][n] == 'V') {
221 printf( "%s: invalid option \"-%c\"!\n", PACKAGE_NAME, argv[i][n] );
222 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
230 printf( "%s: invalid option \"%s\"!\n", PACKAGE_NAME, argv[i] );
231 printf( "Try \"%s --help\" for more information.\n", PACKAGE_NAME );
236 /* Debug-Level (for IRCs "VERSION" command) */
237 NGIRCd_DebugLevel[0] = '\0';
239 if( NGIRCd_Debug ) strcpy( NGIRCd_DebugLevel, "1" );
245 strcpy( NGIRCd_DebugLevel, "2" );
251 Show_Version( ); puts( "" );
255 while( ! NGIRCd_SignalQuit )
257 /* Initialize global variables */
258 NGIRCd_Start = time( NULL );
259 (void)strftime( NGIRCd_StartStr, 64, "%a %b %d %Y at %H:%M:%S (%Z)", localtime( &NGIRCd_Start ));
261 NGIRCd_SignalRestart = false;
262 NGIRCd_SignalQuit = false;
264 /* Initialize modules, part I */
265 Log_Init( ! NGIRCd_NoDaemon );
268 /* Initialize the "main program": chroot environment, user and
270 if (!NGIRCd_Init(NGIRCd_NoDaemon)) {
271 Log(LOG_ALERT, "Fatal: Initialization failed");
275 /* Initialize modules, part II: these functions are eventually
276 * called with already dropped privileges ... */
281 if (!io_library_init(CONNECTION_POOL)) {
282 Log(LOG_ALERT, "Fatal: Cannot initialize IO routines: %s", strerror(errno));
286 if (!Signals_Init()) {
287 Log(LOG_ALERT, "Fatal: Could not set up signal handlers: %s", strerror(errno));
292 * create protocol and server identification.
293 * The syntax used by ngIRCd in PASS commands and the extended flags
294 * are described in doc/Protocol.txt
297 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s", PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION, IRCPLUSFLAGS );
299 strcat( NGIRCd_ProtoID, "Z" );
301 if( Conf_OperCanMode ) strcat( NGIRCd_ProtoID, "o" );
303 snprintf( NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s", PROTOVER, PROTOIRC, PACKAGE_NAME, PACKAGE_VERSION );
305 strlcat( NGIRCd_ProtoID, " P", sizeof NGIRCd_ProtoID );
307 strlcat( NGIRCd_ProtoID, "Z", sizeof NGIRCd_ProtoID );
309 LogDebug("Protocol and server ID is \"%s\".", NGIRCd_ProtoID);
311 Channel_InitPredefined( );
313 if( Conn_InitListeners( ) < 1 )
315 Log( LOG_ALERT, "Server isn't listening on a single port!" );
316 Log( LOG_ALERT, "%s exiting due to fatal errors!", PACKAGE_NAME );
337 * Generate ngIRCd "version string".
338 * This string is generated once and then stored in NGIRCd_Version for
339 * further usage, for example by the IRC command VERSION and the --version
340 * command line switch.
345 NGIRCd_VersionAddition[0] = '\0';
348 strlcpy( NGIRCd_VersionAddition, "SYSLOG", sizeof NGIRCd_VersionAddition );
351 if( NGIRCd_VersionAddition[0] )
352 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
353 strlcat( NGIRCd_VersionAddition, "ZLIB", sizeof NGIRCd_VersionAddition );
356 if ( NGIRCd_VersionAddition[0] ) strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
357 strlcat( NGIRCd_VersionAddition, "SSL", sizeof NGIRCd_VersionAddition );
360 if( NGIRCd_VersionAddition[0] )
361 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
362 strlcat( NGIRCd_VersionAddition, "TCPWRAP", sizeof NGIRCd_VersionAddition );
365 if( NGIRCd_VersionAddition[0] )
366 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
367 strlcat( NGIRCd_VersionAddition, "IDENT", sizeof NGIRCd_VersionAddition );
370 if (NGIRCd_VersionAddition[0])
371 strlcat(NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition);
372 strlcat(NGIRCd_VersionAddition, "PAM", sizeof NGIRCd_VersionAddition);
375 if( NGIRCd_VersionAddition[0] )
376 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
377 strlcat( NGIRCd_VersionAddition, "DEBUG", sizeof NGIRCd_VersionAddition );
380 if( NGIRCd_VersionAddition[0] )
381 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
382 strlcat( NGIRCd_VersionAddition, "SNIFFER", sizeof NGIRCd_VersionAddition );
385 if( NGIRCd_VersionAddition[0] )
386 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
387 strlcat( NGIRCd_VersionAddition, "RFC", sizeof NGIRCd_VersionAddition );
390 if( NGIRCd_VersionAddition[0] )
391 strlcat( NGIRCd_VersionAddition, "+", sizeof NGIRCd_VersionAddition );
392 strlcat( NGIRCd_VersionAddition, "IRCPLUS", sizeof NGIRCd_VersionAddition );
395 if (NGIRCd_VersionAddition[0])
396 strlcat(NGIRCd_VersionAddition, "+", sizeof(NGIRCd_VersionAddition));
397 strlcat(NGIRCd_VersionAddition, "IPv6", sizeof(NGIRCd_VersionAddition));
399 if( NGIRCd_VersionAddition[0] )
400 strlcat( NGIRCd_VersionAddition, "-", sizeof( NGIRCd_VersionAddition ));
402 strlcat( NGIRCd_VersionAddition, TARGET_CPU, sizeof( NGIRCd_VersionAddition ));
403 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
404 strlcat( NGIRCd_VersionAddition, TARGET_VENDOR, sizeof( NGIRCd_VersionAddition ));
405 strlcat( NGIRCd_VersionAddition, "/", sizeof( NGIRCd_VersionAddition ));
406 strlcat( NGIRCd_VersionAddition, TARGET_OS, sizeof( NGIRCd_VersionAddition ));
408 snprintf(NGIRCd_Version, sizeof NGIRCd_Version, "%s %s-%s",
409 PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_VersionAddition);
414 * Display copyright and version information of ngIRCd on the console.
419 puts( NGIRCd_Version );
420 puts( "Copyright (c)2001-2011 Alexander Barton (<alex@barton.de>) and Contributors." );
421 puts( "Homepage: <http://ngircd.barton.de/>\n" );
422 puts( "This is free software; see the source for copying conditions. There is NO" );
423 puts( "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." );
428 * Display a short help text on the console.
429 * This help depends on the configuration of the executable and only shows
430 * options that are actually enabled.
436 puts( " -d, --debug log extra debug messages" );
438 puts( " -f, --config <f> use file <f> as configuration file" );
439 puts( " -n, --nodaemon don't fork and don't detach from controlling terminal" );
440 puts( " -p, --passive disable automatic connections to other servers" );
442 puts( " -s, --sniffer enable network sniffer and display all IRC traffic" );
444 puts( " -t, --configtest read, validate and display configuration; then exit" );
445 puts( " -V, --version output version information and exit" );
446 puts( " -h, --help display this help and exit" );
451 * Delete the file containing the process ID (PID).
454 Pidfile_Delete( void )
456 /* Pidfile configured? */
457 if( ! Conf_PidFile[0] ) return;
460 Log( LOG_DEBUG, "Removing PID file (%s) ...", Conf_PidFile );
463 if( unlink( Conf_PidFile ))
464 Log( LOG_ERR, "Error unlinking PID file (%s): %s", Conf_PidFile, strerror( errno ));
465 } /* Pidfile_Delete */
469 * Create the file containing the process ID of ngIRCd ("PID file").
470 * @param pid The process ID to be stored in this file.
473 Pidfile_Create(pid_t pid)
479 /* Pidfile configured? */
480 if( ! Conf_PidFile[0] ) return;
483 Log( LOG_DEBUG, "Creating PID file (%s) ...", Conf_PidFile );
486 pidfd = open( Conf_PidFile, O_RDWR|O_CREAT|O_EXCL, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
488 Log( LOG_ERR, "Error writing PID file (%s): %s", Conf_PidFile, strerror( errno ));
492 len = snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
493 if (len < 0 || len >= (int)sizeof pidbuf) {
494 Log( LOG_ERR, "Error converting pid");
498 if (write(pidfd, pidbuf, (size_t)len) != (ssize_t)len)
499 Log( LOG_ERR, "Can't write PID file (%s): %s", Conf_PidFile, strerror( errno ));
501 if( close(pidfd) != 0 )
502 Log( LOG_ERR, "Error closing PID file (%s): %s", Conf_PidFile, strerror( errno ));
503 } /* Pidfile_Create */
507 * Redirect stdin, stdout and stderr to apropriate file handles.
510 Setup_FDStreams(int fd)
518 /* Create new stdin(0), stdout(1) and stderr(2) descriptors */
519 dup2( fd, 0 ); dup2( fd, 1 ); dup2( fd, 2 );
520 } /* Setup_FDStreams */
524 NGIRCd_getNobodyID(uid_t *uid, gid_t *gid )
530 * It can return EINVAL instead of EPERM
531 * so, if we are already unprivileged,
532 * use id of current user.
534 if (geteuid() && getuid()) {
541 pwd = getpwnam("nobody");
542 if (!pwd) return false;
544 if ( !pwd->pw_uid || !pwd->pw_gid)
556 NGIRCd_Init( bool NGIRCd_NoDaemon )
558 static bool initialized;
559 bool chrooted = false;
562 int real_errno, fd = -1;
568 if (!NGIRCd_NoDaemon) {
569 /* open /dev/null before chroot() */
570 fd = open( "/dev/null", O_RDWR);
572 Log(LOG_WARNING, "Could not open /dev/null: %s", strerror(errno));
575 if (!ConnSSL_InitLibrary())
577 "Warning: Error during SSL initialization, continuing ...");
579 if( Conf_Chroot[0] ) {
580 if( chdir( Conf_Chroot ) != 0 ) {
581 Log( LOG_ERR, "Can't chdir() in ChrootDir (%s): %s", Conf_Chroot, strerror( errno ));
585 if( chroot( Conf_Chroot ) != 0 ) {
586 if (errno != EPERM) {
587 Log( LOG_ERR, "Can't change root directory to \"%s\": %s",
588 Conf_Chroot, strerror( errno ));
593 Log( LOG_INFO, "Changed root and working directory to \"%s\".", Conf_Chroot );
598 Log(LOG_INFO, "ServerUID must not be 0, using \"nobody\" instead.", Conf_UID);
600 if (! NGIRCd_getNobodyID(&Conf_UID, &Conf_GID)) {
601 Log(LOG_WARNING, "Could not get user/group ID of user \"nobody\": %s",
602 errno ? strerror(errno) : "not found" );
607 if (getgid() != Conf_GID) {
608 /* Change group ID */
609 if (setgid(Conf_GID) != 0) {
611 Log( LOG_ERR, "Can't change group ID to %u: %s", Conf_GID, strerror( errno ));
612 if (real_errno != EPERM)
617 if (getuid() != Conf_UID) {
619 if (setuid(Conf_UID) != 0) {
621 Log(LOG_ERR, "Can't change user ID to %u: %s", Conf_UID, strerror(errno));
622 if (real_errno != EPERM)
629 /* Normally a child process is forked which isn't any longer
630 * connected to ther controlling terminal. Use "--nodaemon"
631 * to disable this "daemon mode" (useful for debugging). */
632 if ( ! NGIRCd_NoDaemon ) {
635 /* "Old" process: exit. */
640 fprintf( stderr, "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
641 PACKAGE_NAME, strerror( errno ));
645 /* New child process */
649 setpgrp(0, getpid());
651 if (chdir( "/" ) != 0)
652 Log(LOG_ERR, "Can't change directory to '/': %s",
655 /* Detach stdin, stdout and stderr */
664 Pidfile_Create( pid );
666 /* Check UID/GID we are running as, can be different from values
667 * configured (e. g. if we were already started with a UID>0. */
671 pwd = getpwuid( Conf_UID );
672 grp = getgrgid( Conf_GID );
674 Log(LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
675 pwd ? pwd->pw_name : "unknown", (long)Conf_UID,
676 grp ? grp->gr_name : "unknown", (long)Conf_GID, (long)pid);
679 Log(LOG_INFO, "Running with root directory \"%s\".",
683 Log(LOG_INFO, "Not running with changed root directory.");
685 /* Change working directory to home directory of the user
686 * we are running as (only when running in daemon mode and not in chroot) */
689 if (!NGIRCd_NoDaemon ) {
690 if( chdir( pwd->pw_dir ) == 0 )
691 Log( LOG_DEBUG, "Changed working directory to \"%s\" ...", pwd->pw_dir );
693 Log( LOG_INFO, "Notice: Can't change working directory to \"%s\": %s",
694 pwd->pw_dir, strerror( errno ));
697 Log( LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID );