2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
5 * Copyright (C) 2018 Chris Novakovic <chrisnovakovic@users.noreply.github.com>
6 * Copyright (C) 2013, 2018-2021 Sadie Powell <sadie@witchery.services>
7 * Copyright (C) 2013 Adam <Adam@anope.org>
8 * Copyright (C) 2012-2014, 2016, 2018 Attila Molnar <attilamolnar@hush.com>
9 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
10 * Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
11 * Copyright (C) 2012 Ariadne Conill <ariadne@dereferenced.org>
12 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
13 * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
14 * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
15 * Copyright (C) 2007-2008, 2010 Craig Edwards <brain@inspircd.org>
16 * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
17 * Copyright (C) 2007 Oliver Lupton <om@inspircd.org>
18 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
20 * This file is part of InspIRCd. InspIRCd is free software: you can
21 * redistribute it and/or modify it under the terms of the GNU General Public
22 * License as published by the Free Software Foundation, version 2.
24 * This program is distributed in the hope that it will be useful, but WITHOUT
25 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
26 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
29 * You should have received a copy of the GNU General Public License
30 * along with this program. If not, see <http://www.gnu.org/licenses/>.
39 #include <sys/resource.h>
41 #include <pwd.h> // setuid
42 #include <grp.h> // setgid
44 WORD g_wOriginalColors;
45 WORD g_wBackgroundColor;
52 #include "exitcodes.h"
54 InspIRCd* ServerInstance = NULL;
56 /** Separate from the other casemap tables so that code *can* still exclusively rely on RFC casemapping
59 * This is provided as a pointer so that modules can change it to their custom mapping tables,
60 * e.g. for national character support.
62 unsigned const char *national_case_insensitive_map = rfc_case_insensitive_map;
65 /* Moved from exitcodes.h -- due to duplicate symbols -- Burlex
66 * XXX this is a bit ugly. -- w00t
68 const char* ExitCodes[] =
72 "Config file error", // 2
74 "POSIX fork failed", // 4
75 "Bad commandline parameters", // 5
76 "Can't write PID file", // 6
77 "SocketEngine could not initialize", // 7
78 "Refusing to start up as root", // 8
79 "Couldn't load module on startup", // 9
80 "Received SIGTERM" // 10
85 void VoidSignalHandler(int);
87 // Warns a user running as root that they probably shouldn't.
91 if (getegid() != 0 && geteuid() != 0)
94 std::cout << con_red << "Warning!" << con_reset << " You have started as root. Running as root is generally not required" << std::endl
95 << "and may allow an attacker to gain access to your system if they find a way to" << std::endl
96 << "exploit your IRC server." << std::endl
98 if (isatty(fileno(stdout)))
100 std::cout << "InspIRCd will start in 30 seconds. If you are sure that you need to run as root" << std::endl
101 << "then you can pass the " << con_bright << "--runasroot" << con_reset << " option to disable this wait." << std::endl;
106 std::cout << "If you are sure that you need to run as root then you can pass the " << con_bright << "--runasroot" << con_reset << std::endl
107 << "option to disable this error." << std::endl;
108 ServerInstance->Exit(EXIT_STATUS_ROOT);
113 // Collects performance statistics for the STATS command.
118 if (getrusage(RUSAGE_SELF, &ru) == -1)
119 return; // Should never happen.
121 ServerInstance->stats.LastSampled.tv_sec = ServerInstance->Time();
122 ServerInstance->stats.LastSampled.tv_nsec = ServerInstance->Time_ns();
123 ServerInstance->stats.LastCPU = ru.ru_utime;
125 if (!QueryPerformanceCounter(&ServerInstance->stats.LastSampled))
126 return; // Should never happen.
128 FILETIME CreationTime;
132 GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
134 ServerInstance->stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
135 ServerInstance->stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
139 // Checks whether the server clock has skipped too much and warn about it if it has.
140 void CheckTimeSkip(time_t oldtime, time_t newtime)
142 if (!ServerInstance->Config->TimeSkipWarn)
145 time_t timediff = newtime - oldtime;
147 if (timediff > ServerInstance->Config->TimeSkipWarn)
148 ServerInstance->SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped forwards by %lu seconds!", timediff);
150 else if (timediff < -ServerInstance->Config->TimeSkipWarn)
151 ServerInstance->SNO->WriteToSnoMask('a', "\002Performance warning!\002 Server clock jumped backwards by %lu seconds!", labs(timediff));
154 // Drops to the unprivileged user/group specified in <security:runas{user,group}>.
158 ConfigTag* security = ServerInstance->Config->ConfValue("security");
160 const std::string SetGroup = security->getString("runasgroup");
161 if (!SetGroup.empty())
164 if (setgroups(0, NULL) == -1)
166 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgroups() failed (wtf?): %s", strerror(errno));
167 exit(EXIT_STATUS_CONFIG);
170 struct group* g = getgrnam(SetGroup.c_str());
173 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getgrnam(%s) failed (wrong group?): %s", SetGroup.c_str(), strerror(errno));
174 exit(EXIT_STATUS_CONFIG);
177 if (setgid(g->gr_gid) == -1)
179 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setgid(%d) failed (wrong group?): %s", g->gr_gid, strerror(errno));
180 exit(EXIT_STATUS_CONFIG);
184 const std::string SetUser = security->getString("runasuser");
185 if (!SetUser.empty())
188 struct passwd* u = getpwnam(SetUser.c_str());
191 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "getpwnam(%s) failed (wrong user?): %s", SetUser.c_str(), strerror(errno));
192 exit(EXIT_STATUS_CONFIG);
195 if (setuid(u->pw_uid) == -1)
197 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "setuid(%d) failed (wrong user?): %s", u->pw_uid, strerror(errno));
198 exit(EXIT_STATUS_CONFIG);
204 // Expands a path relative to the current working directory.
205 std::string ExpandPath(const char* path)
208 TCHAR configPath[MAX_PATH + 1];
209 if (GetFullPathName(path, MAX_PATH, configPath, NULL) > 0)
212 char configPath[PATH_MAX + 1];
213 if (realpath(path, configPath))
219 // Locates a config file on the file system.
220 bool FindConfigFile(std::string& path)
222 if (FileSystem::FileExists(path))
226 // Windows hides file extensions by default so try appending .txt to the path
227 // to help users who have that feature enabled and can't create .conf files.
228 const std::string txtpath = path + ".txt";
229 if (FileSystem::FileExists(txtpath))
231 path.assign(txtpath);
238 // Attempts to fork into the background.
239 void ForkIntoBackground()
242 // We use VoidSignalHandler whilst forking to avoid breaking daemon scripts
243 // if the parent process exits with SIGTERM (15) instead of EXIT_STATUS_NOERROR (0).
244 signal(SIGTERM, VoidSignalHandler);
247 int childpid = fork();
250 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "fork() failed: %s", strerror(errno));
251 std::cout << con_red << "Error:" << con_reset << " unable to fork into background: " << strerror(errno);
252 ServerInstance->Exit(EXIT_STATUS_FORK);
254 else if (childpid > 0)
256 // Wait until the child process kills the parent so that the shell prompt
257 // doesnt display over the output. Sending a kill with a signal of 0 just
258 // checks that the child pid is still running. If it is not then an error
259 // happened and the parent should exit.
260 while (kill(childpid, 0) != -1)
262 exit(EXIT_STATUS_NOERROR);
267 signal(SIGTERM, InspIRCd::SetSignal);
268 SocketEngine::RecoverFromFork();
273 // Increase the size of a core dump file to improve debugging problems.
274 void IncreaseCoreDumpSize()
279 if (getrlimit(RLIMIT_CORE, &rl) == -1)
281 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: getrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
285 rl.rlim_cur = rl.rlim_max;
286 if (setrlimit(RLIMIT_CORE, &rl) == -1)
287 ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: setrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
291 // Parses the command line options.
294 int do_debug = 0, do_nofork = 0, do_nolog = 0;
295 int do_nopid = 0, do_runasroot = 0, do_version = 0;
296 struct option longopts[] =
298 { "config", required_argument, NULL, 'c' },
299 { "debug", no_argument, &do_debug, 1 },
300 { "nofork", no_argument, &do_nofork, 1 },
301 { "nolog", no_argument, &do_nolog, 1 },
302 { "nopid", no_argument, &do_nopid, 1 },
303 { "runasroot", no_argument, &do_runasroot, 1 },
304 { "version", no_argument, &do_version, 1 },
308 char** argv = ServerInstance->Config->cmdline.argv;
310 while ((ret = getopt_long(ServerInstance->Config->cmdline.argc, argv, ":c:", longopts, NULL)) != -1)
315 // A long option was specified.
319 // The -c option was specified.
320 ServerInstance->ConfigFileName = ExpandPath(optarg);
324 // An unknown option was specified.
325 std::cout << con_red << "Error:" << con_reset << " unknown option '" << argv[optind] << "'." << std::endl
326 << con_bright << "Usage: " << con_reset << argv[0] << " [--config <file>] [--debug] [--nofork] [--nolog]" << std::endl
327 << std::string(strlen(argv[0]) + 8, ' ') << "[--nopid] [--runasroot] [--version]" << std::endl;
328 ServerInstance->Exit(EXIT_STATUS_ARGV);
335 std::cout << INSPIRCD_VERSION << std::endl;
336 ServerInstance->Exit(EXIT_STATUS_NOERROR);
339 // Store the relevant parsed arguments
340 ServerInstance->Config->cmdline.forcedebug = !!do_debug;
341 ServerInstance->Config->cmdline.nofork = !!do_nofork;
342 ServerInstance->Config->cmdline.runasroot = !!do_runasroot;
343 ServerInstance->Config->cmdline.writelog = !do_nolog;
344 ServerInstance->Config->cmdline.writepid = !do_nopid;
346 // Seeds the random number generator if applicable.
347 void SeedRng(timespec ts)
350 srand(ts.tv_nsec ^ ts.tv_sec);
351 #elif !defined HAS_ARC4RANDOM_BUF
352 srandom(ts.tv_nsec ^ ts.tv_sec);
356 // Sets handlers for various process signals.
360 signal(SIGALRM, SIG_IGN);
361 signal(SIGCHLD, SIG_IGN);
362 signal(SIGHUP, InspIRCd::SetSignal);
363 signal(SIGPIPE, SIG_IGN);
364 signal(SIGUSR1, SIG_IGN);
365 signal(SIGUSR2, SIG_IGN);
366 signal(SIGXFSZ, SIG_IGN);
368 signal(SIGTERM, InspIRCd::SetSignal);
374 ServerInstance->BindPorts(pl);
378 std::cout << con_red << "Warning!" << con_reset << " Some of your listener" << (pl.size() == 1 ? "s" : "") << " failed to bind:" << std::endl
381 for (FailedPortList::const_iterator iter = pl.begin(); iter != pl.end(); ++iter)
383 const FailedPort& fp = *iter;
384 std::cout << " " << con_bright << fp.sa.str() << con_reset << ": " << strerror(fp.error) << '.' << std::endl
385 << " " << "Created from <bind> tag at " << fp.tag->getTagLocation() << std::endl
389 std::cout << con_bright << "Hints:" << con_reset << std::endl
390 << "- For TCP/IP listeners try using a public IP address in <bind:address> instead" << std::endl
391 << " of * or leaving it blank." << std::endl
392 << "- For UNIX socket listeners try enabling <bind:rewrite> to replace old sockets." << std::endl;
396 // Required for returning the proper value of EXIT_SUCCESS for the parent process.
397 void VoidSignalHandler(int)
399 exit(EXIT_STATUS_NOERROR);
403 void InspIRCd::Cleanup()
405 // Close all listening sockets
406 for (unsigned int i = 0; i < ports.size(); i++)
413 // Tell modules that we're shutting down.
414 const std::string quitmsg = "Server shutting down";
415 FOREACH_MOD(OnShutdown, (quitmsg));
417 // Disconnect all local users
418 const UserManager::LocalList& list = Users.GetLocalUsers();
419 while (!list.empty())
420 ServerInstance->Users.QuitUser(list.front(), quitmsg);
423 Modules->UnloadAll();
425 /* Delete objects dynamically allocated in constructor (destructor would be more appropriate, but we're likely exiting) */
426 /* Must be deleted before modes as it decrements modelines */
429 delete FakeClient->server;
432 stdalgo::delete_zero(this->FakeClient);
433 stdalgo::delete_zero(this->XLines);
434 stdalgo::delete_zero(this->Config);
435 SocketEngine::Deinit();
439 void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
442 if (!ServerInstance->Config->cmdline.writepid)
444 this->Logs->Log("STARTUP", LOG_DEFAULT, "--nopid specified on command line; PID file not written.");
448 std::string fname = ServerInstance->Config->Paths.PrependRuntime(filename.empty() ? "inspircd.pid" : filename);
449 std::ofstream outfile(fname.c_str());
450 if (outfile.is_open())
458 std::cout << "Failed to write PID-file '" << fname << "', exiting." << std::endl;
459 this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to write PID-file '%s'%s", fname.c_str(), (exitonfail ? ", exiting." : ""));
461 Exit(EXIT_STATUS_PID);
466 InspIRCd::InspIRCd(int argc, char** argv)
468 , ConfigFileName(INSPIRCD_CONFIG_PATH "/inspircd.conf")
472 , PI(&DefaultProtocolInterface)
473 , GenRandom(&DefaultGenRandom)
474 , IsChannel(&DefaultIsChannel)
475 , IsNick(&DefaultIsNick)
476 , IsIdent(&DefaultIsIdent)
478 ServerInstance = this;
481 this->startup_time = TIME.tv_sec;
483 IncreaseCoreDumpSize();
485 SocketEngine::Init();
487 this->Config = new ServerConfig;
488 dynamic_reference_base::reset_all();
489 this->XLines = new XLineManager;
491 this->Config->cmdline.argv = argv;
492 this->Config->cmdline.argc = argc;
496 // Initialize the console values
497 g_hStdout = GetStdHandle(STD_OUTPUT_HANDLE);
498 CONSOLE_SCREEN_BUFFER_INFO bufinf;
499 if(GetConsoleScreenBufferInfo(g_hStdout, &bufinf))
501 g_wOriginalColors = bufinf.wAttributes & 0x00FF;
502 g_wBackgroundColor = bufinf.wAttributes & 0x00F0;
506 g_wOriginalColors = FOREGROUND_RED|FOREGROUND_BLUE|FOREGROUND_GREEN;
507 g_wBackgroundColor = 0;
512 ServiceProvider* provs[] =
514 &rfcevents.numeric, &rfcevents.join, &rfcevents.part, &rfcevents.kick, &rfcevents.quit, &rfcevents.nick,
515 &rfcevents.mode, &rfcevents.topic, &rfcevents.privmsg, &rfcevents.invite, &rfcevents.ping, &rfcevents.pong,
518 Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
521 std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl
522 << "See " << con_green << "/INFO" << con_reset << " for contributors & authors" << std::endl
525 if (Config->cmdline.forcedebug)
527 FILE* newstdout = fdopen(dup(STDOUT_FILENO), "w");
528 FileWriter* fw = new FileWriter(newstdout, 1);
529 FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
530 Logs->AddLogTypes("*", fls, true);
533 if (!FindConfigFile(ConfigFileName))
535 this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
536 std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
537 Exit(EXIT_STATUS_CONFIG);
541 if (!Config->cmdline.runasroot)
543 if (!Config->cmdline.nofork)
544 ForkIntoBackground();
546 std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
548 /* During startup we read the configuration now, not in
551 this->Config->Read();
552 this->Config->Apply(NULL, "");
553 Logs->OpenFileLogs();
555 // If we don't have a SID, generate one based on the server name and the server description
556 if (Config->sid.empty())
557 Config->sid = UIDGenerator::GenerateSID(Config->ServerName, Config->ServerDesc);
559 // Initialize the UID generator with our sid
560 this->UIDGen.init(Config->sid);
562 // Create the server user for this server
563 this->FakeClient = new FakeUser(Config->sid, Config->ServerName, Config->ServerDesc);
565 // This is needed as all new XLines are marked pending until ApplyLines() is called
566 this->XLines->ApplyLines();
568 std::cout << std::endl;
572 this->Modules->LoadAll();
574 // Build ISupport as ModuleManager::LoadAll() does not do it
575 this->ISupport.Build();
577 std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
580 if (!Config->cmdline.nofork)
582 if (kill(getppid(), SIGTERM) == -1)
584 std::cout << "Error killing parent process: " << strerror(errno) << std::endl;
585 Logs->Log("STARTUP", LOG_DEFAULT, "Error killing parent process: %s",strerror(errno));
589 /* Explicitly shut down stdio's stdin/stdout/stderr.
591 * The previous logic here was to only do this if stdio was connected to a controlling
592 * terminal. However, we must do this always to avoid information leaks and other
593 * problems related to stdio.
595 * The only exception is if we are in debug mode.
599 if ((!Config->cmdline.nofork) && (!Config->cmdline.forcedebug))
601 int fd = open("/dev/null", O_RDWR);
607 if (dup2(fd, STDIN_FILENO) < 0)
608 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdin.");
609 if (dup2(fd, STDOUT_FILENO) < 0)
610 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stdout.");
611 if (dup2(fd, STDERR_FILENO) < 0)
612 Logs->Log("STARTUP", LOG_DEFAULT, "Failed to dup /dev/null to stderr.");
617 Logs->Log("STARTUP", LOG_DEFAULT, "Keeping pseudo-tty open as we are running in the foreground.");
620 /* Set win32 service as running, if we are running as a service */
624 if(!Config->cmdline.nofork)
629 QueryPerformanceFrequency(&stats.QPFrequency);
632 WritePID(Config->PID);
635 Logs->Log("STARTUP", LOG_DEFAULT, "Startup complete as '%s'[%s], %lu max open sockets", Config->ServerName.c_str(),Config->GetSID().c_str(), SocketEngine::GetMaxFds());
638 void InspIRCd::UpdateTime()
640 #if defined HAS_CLOCK_GETTIME
641 clock_gettime(CLOCK_REALTIME, &TIME);
646 TIME.tv_sec = time(NULL);
647 TIME.tv_nsec = st.wMilliseconds;
650 gettimeofday(&tv, NULL);
652 TIME.tv_sec = tv.tv_sec;
653 TIME.tv_nsec = tv.tv_usec * 1000;
660 time_t OLDTIME = TIME.tv_sec;
664 /* Check if there is a config thread which has finished executing but has not yet been freed */
665 if (this->ConfigThread && this->ConfigThread->IsDone())
667 /* Rehash has completed */
668 this->Logs->Log("CONFIG", LOG_DEBUG, "Detected ConfigThread exiting, tidying up...");
670 this->ConfigThread->Finish();
672 ConfigThread->join();
679 /* Run background module timers every few seconds
680 * (the docs say modules should not rely on accurate
681 * timing using this event, so we dont have to
682 * time this exactly).
684 if (TIME.tv_sec != OLDTIME)
687 CheckTimeSkip(OLDTIME, TIME.tv_sec);
689 OLDTIME = TIME.tv_sec;
691 if ((TIME.tv_sec % 3600) == 0)
692 FOREACH_MOD(OnGarbageCollect, ());
694 Timers.TickTimers(TIME.tv_sec);
695 Users->DoBackgroundUserStuff();
697 if ((TIME.tv_sec % 5) == 0)
699 FOREACH_MOD(OnBackgroundTimer, (TIME.tv_sec));
700 SNO->FlushSnotices();
704 /* Call the socket engine to wait on the active
705 * file descriptors. The socket engine has everything's
706 * descriptors in its list... dns, modules, users,
707 * servers... so its nice and easy, just one call.
708 * This will cause any read or write events to be
709 * dispatched to their handlers.
711 SocketEngine::DispatchTrialWrites();
712 SocketEngine::DispatchEvents();
714 /* if any users were quit, take them out */
720 this->SignalHandler(s_signal);
726 sig_atomic_t InspIRCd::s_signal = 0;
728 void InspIRCd::SetSignal(int signal)
733 /* On posix systems, the flow of the program starts right here, with
734 * ENTRYPOINT being a #define that defines main(). On Windows, ENTRYPOINT
735 * defines smain() and the real main() is in the service code under
736 * win32service.cpp. This allows the service control manager to control
737 * the process where we are running as a windows service.
741 new InspIRCd(argc, argv);
742 ServerInstance->Run();
743 delete ServerInstance;