2 * ngIRCd -- The Next Generation IRC Daemon
3 * Copyright (c)2001-2024 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.
28 #include <sys/types.h>
34 #if defined(DEBUG) && defined(HAVE_MTRACE)
43 #include "sighandlers.h"
48 static void Show_Version PARAMS(( void ));
49 static void Show_Help PARAMS(( void ));
51 static void Pidfile_Create PARAMS(( pid_t pid ));
52 static void Pidfile_Delete PARAMS(( void ));
54 static void Fill_Version PARAMS(( void ));
56 static void Random_Init PARAMS(( void ));
58 static void Setup_FDStreams PARAMS(( int fd ));
60 static bool NGIRCd_Init PARAMS(( bool ));
64 * The main() function of ngIRCd.
66 * Here all starts: this function is called by the operating system loader,
67 * it is the first portion of code executed of ngIRCd.
69 * @param argc The number of arguments passed to ngIRCd on the command line.
70 * @param argv An array containing all the arguments passed to ngIRCd.
71 * @return Global exit code of ngIRCd, zero on success.
74 main(int argc, const char *argv[])
76 bool ok, configtest = false;
77 bool NGIRCd_NoDaemon = false, NGIRCd_NoSyslog = false;
81 #if defined(DEBUG) && defined(HAVE_MTRACE)
82 /* enable GNU libc memory tracing when running in debug mode
83 * and functionality available */
89 NGIRCd_SignalQuit = NGIRCd_SignalRestart = false;
90 NGIRCd_Passive = false;
93 NGIRCd_Sniffer = false;
95 strlcpy(NGIRCd_ConfFile, SYSCONFDIR, sizeof(NGIRCd_ConfFile));
96 strlcat(NGIRCd_ConfFile, CONFIG_FILE, sizeof(NGIRCd_ConfFile));
100 /* parse conmmand line */
101 for (i = 1; i < argc; i++) {
103 if (argv[i][0] == '-' && argv[i][1] == '-') {
105 if (strcmp(argv[i], "--config") == 0) {
107 /* Ok, there's an parameter left */
108 strlcpy(NGIRCd_ConfFile, argv[i+1],
109 sizeof(NGIRCd_ConfFile));
114 if (strcmp(argv[i], "--configtest") == 0) {
118 if (strcmp(argv[i], "--debug") == 0) {
122 if (strcmp(argv[i], "--help") == 0) {
124 puts(""); Show_Help( ); puts( "" );
127 if (strcmp(argv[i], "--nodaemon") == 0) {
128 NGIRCd_NoDaemon = true;
129 NGIRCd_NoSyslog = true;
132 if (strcmp(argv[i], "--passive") == 0) {
133 NGIRCd_Passive = true;
137 if (strcmp(argv[i], "--sniffer") == 0) {
138 NGIRCd_Sniffer = true;
143 if (strcmp(argv[i], "--syslog") == 0) {
144 NGIRCd_NoSyslog = false;
148 if (strcmp(argv[i], "--version") == 0) {
153 else if(argv[i][0] == '-' && argv[i][1] != '-') {
155 for (n = 1; n < strlen(argv[i]); n++) {
157 if (argv[i][n] == 'd') {
161 if (argv[i][n] == 'f') {
162 if (!argv[i][n+1] && i+1 < argc) {
163 /* Ok, next character is a blank */
164 strlcpy(NGIRCd_ConfFile, argv[i+1],
165 sizeof(NGIRCd_ConfFile));
167 /* go to the following parameter */
174 if (argv[i][n] == 'h') {
176 puts(""); Show_Help(); puts("");
180 if (argv[i][n] == 'n') {
181 NGIRCd_NoDaemon = true;
182 NGIRCd_NoSyslog = true;
185 if (argv[i][n] == 'p') {
186 NGIRCd_Passive = true;
190 if (argv[i][n] == 's') {
191 NGIRCd_Sniffer = true;
195 if (argv[i][n] == 't') {
200 if (argv[i][n] == 'V') {
205 if (argv[i][n] == 'y') {
206 NGIRCd_NoSyslog = false;
213 "%s: invalid option \"-%c\"!\n",
214 PACKAGE_NAME, argv[i][n]);
216 "Try \"%s --help\" for more information.\n",
224 fprintf(stderr, "%s: invalid option \"%s\"!\n",
225 PACKAGE_NAME, argv[i]);
226 fprintf(stderr, "Try \"%s --help\" for more information.\n",
232 /* Debug level for "VERSION" command */
233 NGIRCd_DebugLevel[0] = '\0';
235 strcpy(NGIRCd_DebugLevel, "1");
237 if (NGIRCd_Sniffer) {
239 strcpy(NGIRCd_DebugLevel, "2");
244 Show_Version(); puts("");
248 while (!NGIRCd_SignalQuit) {
249 /* Initialize global variables */
250 NGIRCd_Start = time(NULL);
251 (void)strftime(NGIRCd_StartStr, 64,
252 "%a %b %d %Y at %H:%M:%S (%Z)",
253 localtime(&NGIRCd_Start));
255 NGIRCd_SignalRestart = false;
256 NGIRCd_SignalQuit = false;
258 Log_Init(!NGIRCd_NoSyslog);
263 /* Initialize the "main program":
264 * chroot environment, user and group ID, ... */
265 if (!NGIRCd_Init(NGIRCd_NoDaemon)) {
266 Log(LOG_ALERT, "Fatal: Initialization failed, exiting!");
270 if (!io_library_init(CONNECTION_POOL)) {
272 "Fatal: Could not initialize IO routines: %s",
277 if (!Signals_Init()) {
279 "Fatal: Could not set up signal handlers: %s",
289 /* Create protocol and server identification. The syntax
290 * used by ngIRCd in PASS commands and the known "extended
291 * flags" are described in doc/Protocol.txt. */
293 snprintf(NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s:%s",
294 PROTOVER, PROTOIRCPLUS, PACKAGE_NAME, PACKAGE_VERSION,
297 strlcat(NGIRCd_ProtoID, "Z", sizeof NGIRCd_ProtoID);
299 if (Conf_OperCanMode)
300 strlcat(NGIRCd_ProtoID, "o", sizeof NGIRCd_ProtoID);
302 snprintf(NGIRCd_ProtoID, sizeof NGIRCd_ProtoID, "%s%s %s|%s",
303 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 "Server isn't listening on a single port!" );
317 "%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 if (NGIRCd_VersionAddition[0])
353 strlcat(NGIRCd_VersionAddition, "+",
354 sizeof NGIRCd_VersionAddition);
355 strlcat(NGIRCd_VersionAddition, "CHARCONV",
356 sizeof NGIRCd_VersionAddition);
359 if (NGIRCd_VersionAddition[0])
360 strlcat(NGIRCd_VersionAddition, "+",
361 sizeof NGIRCd_VersionAddition);
362 strlcat(NGIRCd_VersionAddition, "DEBUG",
363 sizeof NGIRCd_VersionAddition);
366 if (NGIRCd_VersionAddition[0])
367 strlcat(NGIRCd_VersionAddition, "+",
368 sizeof NGIRCd_VersionAddition);
369 strlcat(NGIRCd_VersionAddition, "IDENT",
370 sizeof NGIRCd_VersionAddition);
373 if (NGIRCd_VersionAddition[0])
374 strlcat(NGIRCd_VersionAddition, "+",
375 sizeof(NGIRCd_VersionAddition));
376 strlcat(NGIRCd_VersionAddition, "IPv6",
377 sizeof(NGIRCd_VersionAddition));
380 if (NGIRCd_VersionAddition[0])
381 strlcat(NGIRCd_VersionAddition, "+",
382 sizeof NGIRCd_VersionAddition);
383 strlcat(NGIRCd_VersionAddition, "IRCPLUS",
384 sizeof NGIRCd_VersionAddition);
387 if (NGIRCd_VersionAddition[0])
388 strlcat(NGIRCd_VersionAddition, "+",
389 sizeof NGIRCd_VersionAddition);
390 strlcat(NGIRCd_VersionAddition, "PAM",
391 sizeof NGIRCd_VersionAddition);
394 if (NGIRCd_VersionAddition[0])
395 strlcat(NGIRCd_VersionAddition, "+",
396 sizeof NGIRCd_VersionAddition);
397 strlcat(NGIRCd_VersionAddition, "RFC",
398 sizeof NGIRCd_VersionAddition);
401 if (NGIRCd_VersionAddition[0])
402 strlcat(NGIRCd_VersionAddition, "+",
403 sizeof NGIRCd_VersionAddition);
404 strlcat(NGIRCd_VersionAddition, "SNIFFER",
405 sizeof NGIRCd_VersionAddition);
408 if (NGIRCd_VersionAddition[0])
409 strlcat(NGIRCd_VersionAddition, "+",
410 sizeof NGIRCd_VersionAddition);
411 strlcat(NGIRCd_VersionAddition, "SSL",
412 sizeof NGIRCd_VersionAddition);
415 if (NGIRCd_VersionAddition[0])
416 strlcat(NGIRCd_VersionAddition, "+",
417 sizeof NGIRCd_VersionAddition);
418 strlcat(NGIRCd_VersionAddition, "SYSLOG",
419 sizeof NGIRCd_VersionAddition);
422 if (NGIRCd_VersionAddition[0])
423 strlcat(NGIRCd_VersionAddition, "+",
424 sizeof NGIRCd_VersionAddition);
425 strlcat(NGIRCd_VersionAddition, "TCPWRAP",
426 sizeof NGIRCd_VersionAddition);
429 if (NGIRCd_VersionAddition[0])
430 strlcat(NGIRCd_VersionAddition, "+",
431 sizeof NGIRCd_VersionAddition);
432 strlcat(NGIRCd_VersionAddition, "ZLIB",
433 sizeof NGIRCd_VersionAddition);
435 if (NGIRCd_VersionAddition[0])
436 strlcat(NGIRCd_VersionAddition, "-",
437 sizeof(NGIRCd_VersionAddition));
439 strlcat(NGIRCd_VersionAddition, HOST_CPU,
440 sizeof(NGIRCd_VersionAddition));
441 strlcat(NGIRCd_VersionAddition, "/", sizeof(NGIRCd_VersionAddition));
442 strlcat(NGIRCd_VersionAddition, HOST_VENDOR,
443 sizeof(NGIRCd_VersionAddition));
444 strlcat(NGIRCd_VersionAddition, "/", sizeof(NGIRCd_VersionAddition));
445 strlcat(NGIRCd_VersionAddition, HOST_OS,
446 sizeof(NGIRCd_VersionAddition));
448 snprintf(NGIRCd_Version, sizeof NGIRCd_Version, "%s %s-%s",
449 PACKAGE_NAME, PACKAGE_VERSION, NGIRCd_VersionAddition);
454 * Display copyright and version information of ngIRCd on the console.
459 puts( NGIRCd_Version );
460 puts( "Copyright (c)2001-2024 Alexander Barton (<alex@barton.de>) and Contributors." );
461 puts( "Homepage: <http://ngircd.barton.de/>\n" );
462 puts( "This is free software; see the source for copying conditions. There is NO" );
463 puts( "warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE." );
468 * Display a short help text on the console.
469 * This help depends on the configuration of the executable and only shows
470 * options that are actually enabled.
475 puts( " -d, --debug log extra debug messages" );
476 puts( " -f, --config <f> use file <f> as configuration file" );
477 puts( " -n, --nodaemon don't fork and don't detach from controlling terminal" );
478 puts( " -p, --passive disable automatic connections to other servers" );
480 puts( " -s, --sniffer enable network sniffer and display all IRC traffic" );
482 puts( " -t, --configtest read, validate and display configuration; then exit" );
483 puts( " -V, --version output version information and exit" );
485 puts( " -y, --syslog log to syslog even when running in the foreground (-n)" );
487 puts( " -h, --help display this help and exit" );
492 * Delete the file containing the process ID (PID).
495 Pidfile_Delete( void )
497 /* Pidfile configured? */
498 if( ! Conf_PidFile[0] ) return;
500 LogDebug( "Removing PID file (%s) ...", Conf_PidFile );
502 if( unlink( Conf_PidFile ))
503 Log( LOG_ERR, "Error unlinking PID file (%s): %s", Conf_PidFile, strerror( errno ));
504 } /* Pidfile_Delete */
508 * Create the file containing the process ID of ngIRCd ("PID file").
510 * @param pid The process ID to be stored in this file.
513 Pidfile_Create(pid_t pid)
519 /* Pidfile configured? */
520 if( ! Conf_PidFile[0] ) return;
522 LogDebug( "Creating PID file (%s) ...", Conf_PidFile );
524 pidfd = open( Conf_PidFile, O_RDWR|O_CREAT|O_EXCL, S_IRUSR|S_IWUSR|S_IRGRP|S_IROTH);
526 Log( LOG_ERR, "Error writing PID file (%s): %s", Conf_PidFile, strerror( errno ));
530 len = snprintf(pidbuf, sizeof pidbuf, "%ld\n", (long)pid);
531 if (len < 0 || len >= (int)sizeof pidbuf) {
532 Log(LOG_ERR, "Error converting process ID!");
537 if (write(pidfd, pidbuf, (size_t)len) != (ssize_t)len)
538 Log(LOG_ERR, "Can't write PID file (%s): %s!", Conf_PidFile,
541 if (close(pidfd) != 0)
542 Log(LOG_ERR, "Error closing PID file (%s): %s!", Conf_PidFile,
544 } /* Pidfile_Create */
548 * Redirect stdin, stdout and stderr to appropriate file handles.
550 * @param fd The file handle stdin, stdout and stderr should be redirected to.
553 Setup_FDStreams(int fd)
561 /* Create new stdin(0), stdout(1) and stderr(2) descriptors */
562 dup2( fd, 0 ); dup2( fd, 1 ); dup2( fd, 2 );
563 } /* Setup_FDStreams */
566 #if !defined(SINGLE_USER_OS)
569 * Get user and group ID of unprivileged "nobody" user.
572 * @param gid Group ID
573 * @return true on success.
576 NGIRCd_getNobodyID(uid_t *uid, gid_t *gid )
582 * It can return EINVAL instead of EPERM
583 * so, if we are already unprivileged,
584 * use id of current user.
586 if (geteuid() && getuid()) {
593 pwd = getpwnam("nobody");
597 if (!pwd->pw_uid || !pwd->pw_gid)
605 } /* NGIRCd_getNobodyID */
610 #ifdef HAVE_ARC4RANDOM
618 Random_Init_Kern(const char *file)
622 int fd = open(file, O_RDONLY);
624 if (read(fd, &seed, sizeof(seed)) == sizeof(seed))
633 * Initialize libc rand(3) number generator
638 if (Random_Init_Kern("/dev/urandom"))
640 if (Random_Init_Kern("/dev/random"))
642 if (Random_Init_Kern("/dev/arandom"))
644 srand(rand() ^ (unsigned)getpid() ^ (unsigned)time(NULL));
650 * Initialize ngIRCd daemon.
652 * @param NGIRCd_NoDaemon Set to true if ngIRCd should run in the
653 * foreground (and not as a daemon).
654 * @return true on success.
657 NGIRCd_Init(bool NGIRCd_NoDaemon)
659 static bool initialized;
660 bool chrooted = false;
663 int real_errno, fd = -1;
669 if (!NGIRCd_NoDaemon) {
670 /* open /dev/null before chroot() */
671 fd = open( "/dev/null", O_RDWR);
673 Log(LOG_WARNING, "Could not open /dev/null: %s",
677 /* SSL initialization */
678 if (!ConnSSL_InitLibrary()) {
679 Log(LOG_ERR, "Error during SSL initialization!");
684 if (Conf_Chroot[0]) {
685 if (chdir(Conf_Chroot) != 0) {
686 Log(LOG_ERR, "Can't chdir() in ChrootDir (%s): %s!",
687 Conf_Chroot, strerror(errno));
691 if (chroot(Conf_Chroot) != 0) {
693 "Can't change root directory to \"%s\": %s!",
694 Conf_Chroot, strerror(errno));
699 "Changed root and working directory to \"%s\".",
704 #if !defined(SINGLE_USER_OS)
709 "ServerUID must not be %s(0), using \"nobody\" instead.",
710 pwd ? pwd->pw_name : "?");
711 if (!NGIRCd_getNobodyID(&Conf_UID, &Conf_GID)) {
713 "Could not get user/group ID of user \"nobody\": %s",
714 errno ? strerror(errno) : "not found" );
719 /* Change group ID */
720 if (getgid() != Conf_GID) {
721 if (setgid(Conf_GID) != 0) {
723 grp = getgrgid(Conf_GID);
724 Log(LOG_ERR, "Can't change group ID to %s(%u): %s!",
725 grp ? grp->gr_name : "?", Conf_GID,
726 strerror(real_errno));
727 if (real_errno != EPERM)
730 #ifdef HAVE_SETGROUPS
731 if (setgroups(0, NULL) != 0) {
733 Log(LOG_ERR, "Can't drop supplementary group IDs: %s!",
735 if (real_errno != EPERM)
740 "Can't drop supplementary group IDs: setgroups(3) missing!");
746 if (getuid() != Conf_UID) {
747 if (setuid(Conf_UID) != 0) {
749 pwd = getpwuid(Conf_UID);
750 Log(LOG_ERR, "Can't change user ID to %s(%u): %s!",
751 pwd ? pwd->pw_name : "?", Conf_UID,
752 strerror(real_errno));
753 if (real_errno != EPERM)
760 /* Normally a child process is forked which isn't any longer
761 * connected to ther controlling terminal. Use "--nodaemon"
762 * to disable this "daemon mode" (useful for debugging). */
763 if (!NGIRCd_NoDaemon) {
766 /* "Old" process: exit. */
772 "%s: Can't fork: %s!\nFatal error, exiting now ...\n",
773 PACKAGE_NAME, strerror(errno));
777 /* New child process */
781 setpgrp(0, getpid());
784 Log(LOG_ERR, "Can't change directory to '/': %s!",
787 /* Detach stdin, stdout and stderr */
796 /* Check UID/GID we are running as, can be different from values
797 * configured (e. g. if we were already started with a UID>0. */
801 pwd = getpwuid(Conf_UID);
802 grp = getgrgid(Conf_GID);
804 Log(LOG_INFO, "Running as user %s(%ld), group %s(%ld), with PID %ld.",
805 pwd ? pwd->pw_name : "unknown", (long)Conf_UID,
806 grp ? grp->gr_name : "unknown", (long)Conf_GID, (long)pid);
809 Log(LOG_INFO, "Running with root directory \"%s\".",
813 Log(LOG_INFO, "Not running with changed root directory.");
815 /* Change working directory to home directory of the user we are
816 * running as (only when running in daemon mode and not in chroot) */
822 if (chdir(pwd->pw_dir) == 0)
824 "Changed working directory to \"%s\" ...",
828 "Can't change working directory to \"%s\": %s!",
829 pwd->pw_dir, strerror(errno));
831 Log(LOG_ERR, "Can't get user informaton for UID %d!?", Conf_UID);