/*
* InspIRCd -- Internet Relay Chat Daemon
*
+ * Copyright (C) 2018 Chris Novakovic <chrisnovakovic@users.noreply.github.com>
+ * Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2013 Adam <Adam@anope.org>
+ * Copyright (C) 2012-2014, 2016, 2018 Attila Molnar <attilamolnar@hush.com>
* Copyright (C) 2012 William Pitcock <nenolod@dereferenced.org>
+ * Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2012 ChrisTX <xpipe@hotmail.de>
* Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
- * Copyright (C) 2003-2008 Craig Edwards <craigedwards@brainbox.cc>
- * Copyright (C) 2008 Uli Schlachter <psychon@znc.in>
- * Copyright (C) 2006-2008 Robin Burchell <robin+git@viroteck.net>
- * Copyright (C) 2006-2007 Oliver Lupton <oliverlupton@gmail.com>
+ * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ * Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
+ * Copyright (C) 2007-2008, 2010 Craig Edwards <brain@inspircd.org>
+ * Copyright (C) 2007-2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Oliver Lupton <om@inspircd.org>
* Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
- * Copyright (C) 2007 Burlex <???@???>
- * Copyright (C) 2003 Craig McLure <craig@chatspike.net>
- * Copyright (C) 2003 randomdan <???@???>
*
* This file is part of InspIRCd. InspIRCd is free software: you can
* redistribute it and/or modify it under the terms of the GNU General Public
#ifndef _WIN32
#include <unistd.h>
#include <sys/resource.h>
- #include <dlfcn.h>
#include <getopt.h>
#include <pwd.h> // setuid
#include <grp.h> // setgid
namespace
{
- // Deletes a pointer and then zeroes it.
- template<typename T>
- void DeleteZero(T*& pr)
+ void VoidSignalHandler(int);
+
+ // Warns a user running as root that they probably shouldn't.
+ void CheckRoot()
{
- T* p = pr;
- pr = NULL;
- delete p;
+#ifndef _WIN32
+ if (getegid() != 0 && geteuid() != 0)
+ return;
+
+ std::cout << con_red << "Warning!" << con_reset << " You have started as root. Running as root is generally not required" << std::endl
+ << "and may allow an attacker to gain access to your system if they find a way to" << std::endl
+ << "exploit your IRC server." << std::endl
+ << std::endl;
+ if (isatty(fileno(stdout)))
+ {
+ std::cout << "InspIRCd will start in 30 seconds. If you are sure that you need to run as root" << std::endl
+ << "then you can pass the " << con_bright << "--runasroot" << con_reset << " option to disable this wait." << std::endl;
+ sleep(30);
+ }
+ else
+ {
+ 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
+ << "option to disable this error." << std::endl;
+ ServerInstance->Exit(EXIT_STATUS_ROOT);
+ }
+#endif
+ }
+
+ // Collects performance statistics for the STATS command.
+ void CollectStats()
+ {
+#ifndef _WIN32
+ static rusage ru;
+ if (getrusage(RUSAGE_SELF, &ru) == -1)
+ return; // Should never happen.
+
+ ServerInstance->stats.LastSampled.tv_sec = ServerInstance->Time();
+ ServerInstance->stats.LastSampled.tv_nsec = ServerInstance->Time_ns();
+ ServerInstance->stats.LastCPU = ru.ru_utime;
+#else
+ if (!QueryPerformanceCounter(&ServerInstance->stats.LastSampled))
+ return; // Should never happen.
+
+ FILETIME CreationTime;
+ FILETIME ExitTime;
+ FILETIME KernelTime;
+ FILETIME UserTime;
+ GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
+
+ ServerInstance->stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
+ ServerInstance->stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
+#endif
}
// Drops to the unprivileged user/group specified in <security:runas{user,group}>.
#endif
}
+ // Expands a path relative to the current working directory.
+ std::string ExpandPath(const char* path)
+ {
+#ifdef _WIN32
+ TCHAR configPath[MAX_PATH + 1];
+ if (GetFullPathName(path, MAX_PATH, configPath, NULL) > 0)
+ return configPath;
+#else
+ char configPath[PATH_MAX + 1];
+ if (realpath(path, configPath))
+ return configPath;
+#endif
+ return path;
+ }
+
+ // Locates a config file on the file system.
+ bool FindConfigFile(std::string& path)
+ {
+ if (FileSystem::FileExists(path))
+ return true;
+
+#ifdef _WIN32
+ // Windows hides file extensions by default so try appending .txt to the path
+ // to help users who have that feature enabled and can't create .conf files.
+ const std::string txtpath = path + ".txt";
+ if (FileSystem::FileExists(txtpath))
+ {
+ path.assign(txtpath);
+ return true;
+ }
+#endif
+ return false;
+ }
+
+ // Attempts to fork into the background.
+ void ForkIntoBackground()
+ {
+#ifndef _WIN32
+ // We use VoidSignalHandler whilst forking to avoid breaking daemon scripts
+ // if the parent process exits with SIGTERM (15) instead of EXIT_STATUS_NOERROR (0).
+ signal(SIGTERM, VoidSignalHandler);
+
+ errno = 0;
+ int childpid = fork();
+ if (childpid < 0)
+ {
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "fork() failed: %s", strerror(errno));
+ std::cout << con_red << "Error:" << con_reset << " unable to fork into background: " << strerror(errno);
+ ServerInstance->Exit(EXIT_STATUS_FORK);
+ }
+ else if (childpid > 0)
+ {
+ // Wait until the child process kills the parent so that the shell prompt
+ // doesnt display over the output. Sending a kill with a signal of 0 just
+ // checks that the child pid is still running. If it is not then an error
+ // happened and the parent should exit.
+ while (kill(childpid, 0) != -1)
+ sleep(1);
+ exit(EXIT_STATUS_NOERROR);
+ }
+ else
+ {
+ setsid();
+ signal(SIGTERM, InspIRCd::SetSignal);
+ SocketEngine::RecoverFromFork();
+ }
+#endif
+ }
+
+ // Increase the size of a core dump file to improve debugging problems.
+ void IncreaseCoreDumpSize()
+ {
+#ifndef _WIN32
+ errno = 0;
+ rlimit rl;
+ if (getrlimit(RLIMIT_CORE, &rl) == -1)
+ {
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: getrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
+ return;
+ }
+
+ rl.rlim_cur = rl.rlim_max;
+ if (setrlimit(RLIMIT_CORE, &rl) == -1)
+ ServerInstance->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to increase core dump size: setrlimit(RLIMIT_CORE) failed: %s", strerror(errno));
+#endif
+ }
+
+ // Parses the command line options.
+ void ParseOptions()
+ {
+ int do_debug = 0, do_nofork = 0, do_nolog = 0;
+ int do_nopid = 0, do_runasroot = 0, do_version = 0;
+ struct option longopts[] =
+ {
+ { "config", required_argument, NULL, 'c' },
+ { "debug", no_argument, &do_debug, 1 },
+ { "nofork", no_argument, &do_nofork, 1 },
+ { "nolog", no_argument, &do_nolog, 1 },
+ { "nopid", no_argument, &do_nopid, 1 },
+ { "runasroot", no_argument, &do_runasroot, 1 },
+ { "version", no_argument, &do_version, 1 },
+ { 0, 0, 0, 0 }
+ };
+
+ char** argv = ServerInstance->Config->cmdline.argv;
+ int ret;
+ while ((ret = getopt_long(ServerInstance->Config->cmdline.argc, argv, ":c:", longopts, NULL)) != -1)
+ {
+ switch (ret)
+ {
+ case 0:
+ // A long option was specified.
+ break;
+
+ case 'c':
+ // The -c option was specified.
+ ServerInstance->ConfigFileName = ExpandPath(optarg);
+ break;
+
+ default:
+ // An unknown option was specified.
+ std::cout << con_red << "Error:" << con_reset << " unknown option '" << argv[optind - 1] << "'." << std::endl
+ << con_bright << "Usage: " << con_reset << argv[0] << " [--config <file>] [--debug] [--nofork] [--nolog]" << std::endl
+ << std::string(strlen(argv[0]) + 8, ' ') << "[--nopid] [--runasroot] [--version]" << std::endl;
+ ServerInstance->Exit(EXIT_STATUS_ARGV);
+ break;
+ }
+ }
+
+ if (do_version)
+ {
+ std::cout << std::endl << INSPIRCD_VERSION << std::endl;
+ ServerInstance->Exit(EXIT_STATUS_NOERROR);
+ }
+
+ // Store the relevant parsed arguments
+ ServerInstance->Config->cmdline.forcedebug = !!do_debug;
+ ServerInstance->Config->cmdline.nofork = !!do_nofork;
+ ServerInstance->Config->cmdline.runasroot = !!do_runasroot;
+ ServerInstance->Config->cmdline.writelog = !do_nolog;
+ ServerInstance->Config->cmdline.writepid = !do_nopid;
+ }
// Seeds the random number generator if applicable.
void SeedRng(timespec ts)
{
#endif
}
+ // Sets handlers for various process signals.
+ void SetSignals()
+ {
+#ifndef _WIN32
+ signal(SIGALRM, SIG_IGN);
+ signal(SIGCHLD, SIG_IGN);
+ signal(SIGHUP, InspIRCd::SetSignal);
+ signal(SIGPIPE, SIG_IGN);
+ signal(SIGUSR1, SIG_IGN);
+ signal(SIGUSR2, SIG_IGN);
+ signal(SIGXFSZ, SIG_IGN);
+#endif
+ signal(SIGTERM, InspIRCd::SetSignal);
+ }
+
+ void TryBindPorts()
+ {
+ FailedPortList pl;
+ ServerInstance->BindPorts(pl);
+
+ if (!pl.empty())
+ {
+ std::cout << con_red << "Warning!" << con_reset << " Some of your listener" << (pl.size() == 1 ? "s" : "") << " failed to bind:" << std::endl
+ << std::endl;
+
+ for (FailedPortList::const_iterator iter = pl.begin(); iter != pl.end(); ++iter)
+ {
+ const FailedPort& fp = *iter;
+ std::cout << " " << con_bright << fp.sa.str() << con_reset << ": " << strerror(fp.error) << '.' << std::endl
+ << " " << "Created from <bind> tag at " << fp.tag->getTagLocation() << std::endl
+ << std::endl;
+ }
+
+ std::cout << con_bright << "Hints:" << con_reset << std::endl
+ << "- For TCP/IP listeners try using a public IP address in <bind:address> instead" << std::endl
+ << " of * of leaving it blank." << std::endl
+ << "- For UNIX socket listeners try enabling <bind:rewrite> to replace old sockets." << std::endl;
+ }
+ }
+
// Required for returning the proper value of EXIT_SUCCESS for the parent process.
void VoidSignalHandler(int)
{
delete FakeClient->server;
FakeClient->cull();
}
- DeleteZero(this->FakeClient);
- DeleteZero(this->XLines);
- DeleteZero(this->Config);
+ stdalgo::delete_zero(this->FakeClient);
+ stdalgo::delete_zero(this->XLines);
+ stdalgo::delete_zero(this->Config);
SocketEngine::Deinit();
Logs->CloseLogs();
}
-void InspIRCd::SetSignals()
-{
-#ifndef _WIN32
- signal(SIGALRM, SIG_IGN);
- signal(SIGCHLD, SIG_IGN);
- signal(SIGHUP, InspIRCd::SetSignal);
- signal(SIGPIPE, SIG_IGN);
- signal(SIGUSR1, SIG_IGN);
- signal(SIGUSR2, SIG_IGN);
- signal(SIGXFSZ, SIG_IGN);
-#endif
- signal(SIGTERM, InspIRCd::SetSignal);
-}
-
-bool InspIRCd::DaemonSeed()
-{
-#ifdef _WIN32
- std::cout << "InspIRCd Process ID: " << con_green << GetCurrentProcessId() << con_reset << std::endl;
- return true;
-#else
- // Do not use exit() here: It will exit with status SIGTERM which would break e.g. daemon scripts
- signal(SIGTERM, VoidSignalHandler);
-
- int childpid = fork();
- if (childpid < 0)
- return false;
- else if (childpid > 0)
- {
- /* We wait here for the child process to kill us,
- * so that the shell prompt doesnt come back over
- * the output.
- * Sending a kill with a signal of 0 just checks
- * if the child pid is still around. If theyre not,
- * they threw an error and we should give up.
- */
- while (kill(childpid, 0) != -1)
- sleep(1);
- exit(EXIT_STATUS_NOERROR);
- }
- setsid ();
- std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
-
- signal(SIGTERM, InspIRCd::SetSignal);
-
- rlimit rl;
- if (getrlimit(RLIMIT_CORE, &rl) == -1)
- {
- this->Logs->Log("STARTUP", LOG_DEFAULT, "Failed to getrlimit()!");
- return false;
- }
- rl.rlim_cur = rl.rlim_max;
-
- if (setrlimit(RLIMIT_CORE, &rl) == -1)
- this->Logs->Log("STARTUP", LOG_DEFAULT, "setrlimit() failed, cannot increase coredump size.");
-
- return true;
-#endif
-}
-
void InspIRCd::WritePID(const std::string& filename, bool exitonfail)
{
#ifndef _WIN32
UpdateTime();
this->startup_time = TIME.tv_sec;
+ IncreaseCoreDumpSize();
SeedRng(TIME);
SocketEngine::Init();
Modules.AddServices(provs, sizeof(provs)/sizeof(provs[0]));
}
- // Flag variables passed to getopt_long() later
- int do_version = 0, do_nofork = 0, do_debug = 0,
- do_nolog = 0, do_nopid = 0, do_root = 0;
- struct option longopts[] =
- {
- { "nofork", no_argument, &do_nofork, 1 },
- { "config", required_argument, NULL, 'c' },
- { "debug", no_argument, &do_debug, 1 },
- { "nolog", no_argument, &do_nolog, 1 },
- { "nopid", no_argument, &do_nopid, 1 },
- { "runasroot", no_argument, &do_root, 1 },
- { "version", no_argument, &do_version, 1 },
- { 0, 0, 0, 0 }
- };
-
- int c;
- int index;
- while ((c = getopt_long(argc, argv, ":c:", longopts, &index)) != -1)
- {
- switch (c)
- {
- case 'c':
- /* Config filename was set */
- ConfigFileName = optarg;
-#ifdef _WIN32
- TCHAR configPath[MAX_PATH + 1];
- if (GetFullPathName(optarg, MAX_PATH, configPath, NULL) > 0)
- ConfigFileName = configPath;
-#else
- char configPath[PATH_MAX + 1];
- if (realpath(optarg, configPath))
- ConfigFileName = configPath;
-#endif
- break;
- case 0:
- /* getopt_long_only() set an int variable, just keep going */
- break;
- case '?':
- /* Unknown parameter */
- default:
- /* Fall through to handle other weird values too */
- std::cout << "Unknown parameter '" << argv[optind-1] << "'" << std::endl;
- std::cout << "Usage: " << argv[0] << " [--nofork] [--nolog] [--nopid] [--debug] [--config <config>]" << std::endl <<
- std::string(static_cast<size_t>(8+strlen(argv[0])), ' ') << "[--runasroot] [--version]" << std::endl;
- Exit(EXIT_STATUS_ARGV);
- break;
- }
- }
-
- if (do_version)
- {
- std::cout << std::endl << INSPIRCD_VERSION << std::endl;
- Exit(EXIT_STATUS_NOERROR);
- }
-
-#ifdef _WIN32
- // Set up winsock
- WSADATA wsadata;
- WSAStartup(MAKEWORD(2,2), &wsadata);
-#endif
+ std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl
+ << "See " << con_green << "/INFO" << con_reset << " for contributors & authors" << std::endl
+ << std::endl;
- /* Set the finished argument values */
- Config->cmdline.nofork = (do_nofork != 0);
- Config->cmdline.forcedebug = (do_debug != 0);
- Config->cmdline.writelog = !do_nolog;
- Config->cmdline.writepid = !do_nopid;
-
- if (do_debug)
+ ParseOptions();
+ if (Config->cmdline.forcedebug)
{
FileWriter* fw = new FileWriter(stdout, 1);
FileLogStream* fls = new FileLogStream(LOG_RAWIO, fw);
Logs->AddLogTypes("*", fls, true);
}
- if (!FileSystem::FileExists(ConfigFileName))
+ if (!FindConfigFile(ConfigFileName))
{
-#ifdef _WIN32
- /* Windows can (and defaults to) hide file extensions, so let's play a bit nice for windows users. */
- std::string txtconf = this->ConfigFileName;
- txtconf.append(".txt");
-
- if (FileSystem::FileExists(txtconf))
- {
- ConfigFileName = txtconf;
- }
- else
-#endif
- {
- std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
- this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
- Exit(EXIT_STATUS_CONFIG);
- }
- }
-
- std::cout << con_green << "InspIRCd - Internet Relay Chat Daemon" << con_reset << std::endl;
- std::cout << "For contributors & authors: " << con_green << "See /INFO Output" << con_reset << std::endl;
-
-#ifndef _WIN32
- if (!do_root)
- this->CheckRoot();
- else
- {
- std::cout << "* WARNING * WARNING * WARNING * WARNING * WARNING *" << std::endl
- << "YOU ARE RUNNING INSPIRCD AS ROOT. THIS IS UNSUPPORTED" << std::endl
- << "AND IF YOU ARE HACKED, CRACKED, SPINDLED OR MUTILATED" << std::endl
- << "OR ANYTHING ELSE UNEXPECTED HAPPENS TO YOU OR YOUR" << std::endl
- << "SERVER, THEN IT IS YOUR OWN FAULT. IF YOU DID NOT MEAN" << std::endl
- << "TO START INSPIRCD AS ROOT, HIT CTRL+C NOW AND RESTART" << std::endl
- << "THE PROGRAM AS A NORMAL USER. YOU HAVE BEEN WARNED!" << std::endl << std::endl
- << "InspIRCd starting in 20 seconds, ctrl+c to abort..." << std::endl;
- sleep(20);
+ this->Logs->Log("STARTUP", LOG_DEFAULT, "Unable to open config file %s", ConfigFileName.c_str());
+ std::cout << "ERROR: Cannot open config file: " << ConfigFileName << std::endl << "Exiting..." << std::endl;
+ Exit(EXIT_STATUS_CONFIG);
}
-#endif
-
- this->SetSignals();
+ SetSignals();
+ if (!Config->cmdline.runasroot)
+ CheckRoot();
if (!Config->cmdline.nofork)
- {
- if (!this->DaemonSeed())
- {
- std::cout << "ERROR: could not go into daemon mode. Shutting down." << std::endl;
- Logs->Log("STARTUP", LOG_DEFAULT, "ERROR: could not go into daemon mode. Shutting down.");
- Exit(EXIT_STATUS_FORK);
- }
- }
+ ForkIntoBackground();
- SocketEngine::RecoverFromFork();
+ std::cout << "InspIRCd Process ID: " << con_green << getpid() << con_reset << std::endl;
/* During startup we read the configuration now, not in
* a seperate thread
// This is needed as all new XLines are marked pending until ApplyLines() is called
this->XLines->ApplyLines();
- FailedPortList pl;
- int bounditems = BindPorts(pl);
-
std::cout << std::endl;
+ TryBindPorts();
+
this->Modules->LoadAll();
// Build ISupport as ModuleManager::LoadAll() does not do it
this->ISupport.Build();
- if (!pl.empty())
- {
- std::cout << std::endl << "WARNING: Not all your client ports could be bound -- " << std::endl << "starting anyway with " << bounditems
- << " of " << bounditems + (int)pl.size() << " client ports bound." << std::endl << std::endl;
- std::cout << "The following port(s) failed to bind:" << std::endl << std::endl;
- int j = 1;
- for (FailedPortList::iterator i = pl.begin(); i != pl.end(); i++, j++)
- {
- std::cout << j << ".\tAddress: " << i->first.str() << " \tReason: " << strerror(i->second) << std::endl;
- }
-
- std::cout << std::endl << "Hint: Try using a public IP instead of blank or *" << std::endl;
- }
-
std::cout << "InspIRCd is now running as '" << Config->ServerName << "'[" << Config->GetSID() << "] with " << SocketEngine::GetMaxFds() << " max open sockets" << std::endl;
#ifndef _WIN32
*
* -- nenolod
*/
- if ((!do_nofork) && (!Config->cmdline.forcedebug))
+ if ((!Config->cmdline.nofork) && (!Config->cmdline.forcedebug))
{
int fd = open("/dev/null", O_RDWR);
SetServiceRunning();
// Handle forking
- if(!do_nofork)
+ if(!Config->cmdline.nofork)
{
FreeConsole();
}
while (true)
{
-#ifndef _WIN32
- static rusage ru;
-#endif
-
/* Check if there is a config thread which has finished executing but has not yet been freed */
if (this->ConfigThread && this->ConfigThread->IsDone())
{
*/
if (TIME.tv_sec != OLDTIME)
{
-#ifndef _WIN32
- getrusage(RUSAGE_SELF, &ru);
- stats.LastSampled = TIME;
- stats.LastCPU = ru.ru_utime;
-#else
- if(QueryPerformanceCounter(&stats.LastSampled))
- {
- FILETIME CreationTime;
- FILETIME ExitTime;
- FILETIME KernelTime;
- FILETIME UserTime;
- GetProcessTimes(GetCurrentProcess(), &CreationTime, &ExitTime, &KernelTime, &UserTime);
- stats.LastCPU.dwHighDateTime = KernelTime.dwHighDateTime + UserTime.dwHighDateTime;
- stats.LastCPU.dwLowDateTime = KernelTime.dwLowDateTime + UserTime.dwLowDateTime;
- }
-#endif
+ CollectStats();
if (Config->TimeSkipWarn)
{
OLDTIME = TIME.tv_sec;
if ((TIME.tv_sec % 3600) == 0)
- {
FOREACH_MOD(OnGarbageCollect, ());
- // HACK: ELines are not expired properly at the moment but it can't be fixed as
- // the 2.0 XLine system is a spaghetti nightmare. Instead we skip over expired
- // ELines in XLineManager::CheckELines() and expire them here instead.
- XLines->GetAll("E");
- }
-
Timers.TickTimers(TIME.tv_sec);
Users->DoBackgroundUserStuff();