anope/modules/operserv/os_session.cpp

// Anope IRC Services <https://www.anope.org/>
//
// Copyright (C) 2003-2026 Anope Contributors
//
// Anope is free software. You can use, modify, and/or distribute it under the
// terms of version 2 of the GNU General Public License. See docs/LICENSE.txt
// for the complete terms of this license and docs/AUTHORS.txt for a list of
// contributors.
//
// Based on the original code of Epona by Lara
// Based on the original code of Services by Andy Church
//
// SPDX-License-Identifier: GPL-2.0-only

#include "module.h"
#include "modules/operserv/session.h"

namespace
{
	/* The default session limit */
	unsigned session_limit;
	/* How many times to kill before adding an AKILL */
	unsigned max_session_kill;
	/* How long session akills should last */
	time_t session_autokill_expiry;
	/* Reason to use for session kills */
	Anope::string sle_reason;
	/* Optional second reason */
	Anope::string sle_detailsloc;

	/* Max limit that can be used for exceptions */
	unsigned max_exception_limit;
	/* How long before exceptions expire by default */
	time_t exception_expiry;

	/* Number of bits to use when comparing session IPs */
	unsigned ipv4_cidr;
	unsigned ipv6_cidr;
}

struct ExceptionType final
	: public Serialize::Type
{
	ExceptionType()
		: Serialize::Type(OPERSERV_SESSION_EXCEPTION_TYPE)
	{
	}

	void Serialize(Serializable *obj, Serialize::Data &data) const override
	{
		const auto *ex = static_cast<const OperServ::Exception *>(obj);
		data.Store("mask", ex->mask);
		data.Store("limit", ex->limit);
		data.Store("who", ex->who);
		data.Store("reason", ex->reason);
		data.Store("time", ex->time);
	}

	Serializable *Unserialize(Serializable *obj, Serialize::Data &data) const override
	{
		if (!OperServ::session_service)
			return NULL;

		OperServ::Exception *ex;
		if (obj)
			ex = anope_dynamic_static_cast<OperServ::Exception *>(obj);
		else
			ex = new OperServ::Exception();

		ex->mask = data.Load("mask");
		ex->limit = data.Load<unsigned>("limit");
		ex->who = data.Load("who");
		ex->reason = data.Load("reason");
		ex->time = data.Load<time_t>("time");
		ex->expires = data.Load<time_t>("expires");

		if (!obj)
			OperServ::session_service->AddException(ex);
		return ex;
	}
};

class MySessionService final
	: public OperServ::SessionService
{
private:
	OperServ::SessionMap Sessions;
	Serialize::Checker<OperServ::ExceptionVector> Exceptions;

public:
	MySessionService(Module *m)
		: OperServ::SessionService(m)
		, Exceptions(OPERSERV_SESSION_EXCEPTION_TYPE)
	{
	}

	OperServ::Exception *CreateException() override
	{
		return new OperServ::Exception();
	}

	void AddException(OperServ::Exception *e) override
	{
		this->Exceptions->push_back(e);
	}

	void DelException(OperServ::Exception *e) override
	{
		auto it = std::find(this->Exceptions->begin(), this->Exceptions->end(), e);
		if (it != this->Exceptions->end())
			this->Exceptions->erase(it);
	}

	OperServ::Exception *FindException(User *u) override
	{
		for (auto *e : *this->Exceptions)
		{
			if (Anope::Match(u->host, e->mask) || Anope::Match(u->ip.addr(), e->mask))
				return e;

			if (cidr(e->mask).match(u->ip))
				return e;
		}
		return NULL;
	}

	OperServ::Exception *FindException(const Anope::string &host) override
	{
		for (auto *e : *this->Exceptions)
		{
			if (Anope::Match(host, e->mask))
				return e;

			if (cidr(e->mask).match(sockaddrs(host)))
				return e;
		}

		return NULL;
	}

	OperServ::ExceptionVector &GetExceptions() override
	{
		return this->Exceptions;
	}

	void DelSession(OperServ::Session *s)
	{
		this->Sessions.erase(s->addr);
	}

	OperServ::Session *FindSession(const Anope::string &ip) override
	{
		cidr c(ip, ip.find(':') != Anope::string::npos ? ipv6_cidr : ipv4_cidr);
		if (!c.valid())
			return NULL;
		auto it = this->Sessions.find(c);
		if (it != this->Sessions.end())
			return it->second;
		return NULL;
	}

	OperServ::SessionMap::iterator FindSessionIterator(const sockaddrs &ip)
	{
		cidr c(ip, ip.ipv6() ? ipv6_cidr : ipv4_cidr);
		if (!c.valid())
			return this->Sessions.end();
		return this->Sessions.find(c);
	}

	OperServ::Session *&FindOrCreateSession(const cidr &ip)
	{
		return this->Sessions[ip];
	}

	OperServ::SessionMap &GetSessions() override
	{
		return this->Sessions;
	}
};

class ExceptionDelCallback final
	: public NumberList
{
protected:
	CommandSource &source;
	unsigned deleted = 0;
	Anope::string lastdeleted;
	Command *cmd;
public:
	ExceptionDelCallback(CommandSource &_source, const Anope::string &numlist, Command *c) : NumberList(numlist, true), source(_source), cmd(c)
	{
	}

	~ExceptionDelCallback() override
	{
		switch (deleted)
		{
			case 0:
				source.Reply(_("No matching entries on session-limit exception list."));
				break;

			case 1:
				source.Reply(_("Deleted %s from session-limit exception list."), lastdeleted.c_str());
				break;

			default:
				source.Reply(deleted, N_("Deleted %d entry from session-limit exception list.", "Deleted %d entries from session-limit exception list."), deleted);
				break;
		}
	}

	void HandleNumber(unsigned number) override
	{
		if (!number || number > OperServ::session_service->GetExceptions().size())
			return;

		lastdeleted = OperServ::session_service->GetExceptions()[number - 1]->mask;
		Log(LOG_ADMIN, source, cmd) << "to remove the session limit exception for " << lastdeleted;

		++deleted;
		DoDel(source, number - 1);
	}

	static void DoDel(CommandSource &source, unsigned index)
	{
		auto *e = OperServ::session_service->GetExceptions()[index];
		FOREACH_MOD(OnExceptionDel, (source, e));

		OperServ::session_service->DelException(e);
		delete e;
	}
};

class CommandOSSession final
	: public Command
{
private:
	static void DoList(CommandSource &source, const std::vector<Anope::string> &params)
	{
		Anope::string param = params[1];

		auto mincount = Anope::Convert<unsigned>(param, 0);
		if (mincount <= 1)
			source.Reply(_("Invalid threshold value. It must be a valid integer greater than 1."));
		else
		{
			ListFormatter list(source.GetAccount());
			list.AddColumn(_("Session")).AddColumn(_("Host"));
			list.SetFlexible(_("\002{host}\002: {session} sessions"));

			for (const auto &[_, session] : OperServ::session_service->GetSessions())
			{
				if (session->count >= mincount)
				{
					ListFormatter::ListEntry entry;
					entry["Session"] = Anope::ToString(session->count);
					entry["Host"] = session->addr.mask();
					list.AddEntry(entry);
				}
			}

			source.Reply(_("Hosts with at least \002%d\002 sessions:"), mincount);
			list.SendTo(source);
		}
	}

	static void DoView(CommandSource &source, const std::vector<Anope::string> &params)
	{
		Anope::string param = params[1];
		auto *session = OperServ::session_service->FindSession(param);

		auto *exception = OperServ::session_service->FindException(param);
		Anope::string entry = "no entry";
		unsigned limit = session_limit;
		if (exception)
		{
			if (!exception->limit)
				limit = 0;
			else if (exception->limit > limit)
				limit = exception->limit;
			entry = exception->mask;
		}

		if (!session)
			source.Reply(_("\002%s\002 not found on session list, but has a limit of \002%d\002 because it matches entry: \002%s\002."), param.c_str(), limit, entry.c_str());
		else
			source.Reply(_("The host \002%s\002 currently has \002%d\002 sessions with a limit of \002%d\002 because it matches entry: \002%s\002."), session->addr.mask().c_str(), session->count, limit, entry.c_str());
	}
public:
	CommandOSSession(Module *creator) : Command(creator, "operserv/session", 2, 2)
	{
		this->SetDesc(_("View the list of host sessions"));
		this->SetSyntax(_("LIST \037threshold\037"));
		this->SetSyntax(_("VIEW \037host\037"));
	}

	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
	{
		const Anope::string &cmd = params[0];

		Log(LOG_ADMIN, source, this) << cmd << " " << params[1];

		if (!session_limit)
			source.Reply(_("Session limiting is disabled."));
		else if (cmd.equals_ci("LIST"))
			return this->DoList(source, params);
		else if (cmd.equals_ci("VIEW"))
			return this->DoView(source, params);
		else
			this->OnSyntaxError(source, "");
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) override
	{
		this->SendSyntax(source);
		source.Reply(" ");
		source.Reply(_(
				"Allows Services Operators to view the session list."
				"\n\n"
				"\002%s\033LIST\002 lists hosts with at least \037threshold\037 sessions. "
				"The threshold must be a number greater than 1. This is to "
				"prevent accidental listing of the large number of single "
				"session hosts."
				"\n\n"
				"\002%s\033VIEW\002 displays detailed information about a specific "
				"host - including the current session count and session limit. "
				"The \037host\037 value may not include wildcards. "
				"\n\n"
				"See the \002EXCEPTION\002 help for more information about session "
				"limiting and how to set session limits specific to certain "
				"hosts and groups thereof."
			),
			source.command.nobreak().c_str(),
			source.command.nobreak().c_str());
		return true;
	}
};

class CommandOSException final
	: public Command
{
private:
	void DoAdd(CommandSource &source, const std::vector<Anope::string> &params)
	{
		Anope::string mask, expiry, limitstr;
		unsigned last_param = 3;

		mask = params.size() > 1 ? params[1] : "";
		if (!mask.empty() && mask[0] == '+')
		{
			expiry = mask;
			mask = params.size() > 2 ? params[2] : "";
			last_param = 4;
		}

		limitstr = params.size() > last_param - 1 ? params[last_param - 1] : "";

		if (params.size() <= last_param)
		{
			this->OnSyntaxError(source, "ADD");
			return;
		}

		Anope::string reason = params[last_param];
		if (last_param == 3 && params.size() > 4)
			reason += " " + params[4];
		if (reason.empty())
		{
			this->OnSyntaxError(source, "ADD");
			return;
		}

		time_t expires = !expiry.empty() ? Anope::DoTime(expiry) : exception_expiry;
		if (expires < 0)
		{
			source.Reply(BAD_EXPIRY_TIME);
			return;
		}
		else if (expires > 0)
			expires += Anope::CurTime;

		auto limit = Anope::Convert<unsigned>(limitstr, -1);
		if (limit > max_exception_limit)
		{
			source.Reply(_("Invalid session limit. It must be a valid integer greater than or equal to zero and less than \002%d\002."), max_exception_limit);
			return;
		}
		else
		{
			if (mask.find('!') != Anope::string::npos || mask.find('@') != Anope::string::npos)
			{
				source.Reply(_("Invalid hostmask. Only real hostmasks are valid, as exceptions are not matched against nicks or usernames."));
				return;
			}

			for (auto *e : OperServ::session_service->GetExceptions())
			{
				if (e->mask.equals_ci(mask))
				{
					if (e->limit != limit)
					{
						e->limit = limit;
						source.Reply(_("Exception for \002%s\002 has been updated to %d."), mask.c_str(), e->limit);
					}
					else
						source.Reply(_("\002%s\002 already exists on the EXCEPTION list."), mask.c_str());
					return;
				}
			}

			auto *exception = new OperServ::Exception();
			exception->mask = mask;
			exception->limit = limit;
			exception->reason = reason;
			exception->time = Anope::CurTime;
			exception->who = source.GetNick();
			exception->expires = expires;

			EventReturn MOD_RESULT;
			FOREACH_RESULT(OnExceptionAdd, MOD_RESULT, (exception));
			if (MOD_RESULT == EVENT_STOP)
				delete exception;
			else
			{
				Log(LOG_ADMIN, source, this) << "to set the session limit for " << mask << " to " << limit;
				OperServ::session_service->AddException(exception);
				source.Reply(_("Session limit for \002%s\002 set to \002%d\002."), mask.c_str(), limit);
				if (Anope::ReadOnly)
					source.Reply(READ_ONLY_MODE);
			}
		}
	}

	void DoDel(CommandSource &source, const std::vector<Anope::string> &params)
	{
		const Anope::string &mask = params.size() > 1 ? params[1] : "";

		if (mask.empty())
		{
			this->OnSyntaxError(source, "DEL");
			return;
		}

		if (isdigit(mask[0]) && mask.find_first_not_of("1234567890,-") == Anope::string::npos)
		{
			ExceptionDelCallback list(source, mask, this);
			list.Process();
		}
		else
		{
			unsigned i = 0, end = OperServ::session_service->GetExceptions().size();
			for (; i < end; ++i)
				if (mask.equals_ci(OperServ::session_service->GetExceptions()[i]->mask))
				{
					Log(LOG_ADMIN, source, this) << "to remove the session limit exception for " << mask;
					ExceptionDelCallback::DoDel(source, i);
					source.Reply(_("\002%s\002 deleted from session-limit exception list."), mask.c_str());
					break;
				}
			if (i == end)
				source.Reply(_("\002%s\002 not found on session-limit exception list."), mask.c_str());
		}

		if (Anope::ReadOnly)
			source.Reply(READ_ONLY_MODE);
	}

	void ProcessList(CommandSource &source, const std::vector<Anope::string> &params, ListFormatter &list)
	{
		const Anope::string &mask = params.size() > 1 ? params[1] : "";

		if (OperServ::session_service->GetExceptions().empty())
		{
			source.Reply(_("The session exception list is empty."));
			return;
		}

		if (!mask.empty() && mask.find_first_not_of("1234567890,-") == Anope::string::npos)
		{
			class ExceptionListCallback final
				: public NumberList
			{
				CommandSource &source;
				ListFormatter &list;
			public:
				ExceptionListCallback(CommandSource &_source, ListFormatter &_list, const Anope::string &numlist) : NumberList(numlist, false), source(_source), list(_list)
				{
				}

				void HandleNumber(unsigned Number) override
				{
					if (!Number || Number > OperServ::session_service->GetExceptions().size())
						return;

					auto *e = OperServ::session_service->GetExceptions()[Number - 1];

					ListFormatter::ListEntry entry;
					entry["Number"] = Anope::ToString(Number);
					entry["Mask"] = e->mask;
					entry["Creator"] = e->who;
					entry["Created"] = Anope::strftime(e->time, NULL, true);
					entry["Expires"] = Anope::Expires(e->expires, source.GetAccount());
					entry["Limit"] = Anope::ToString(e->limit);
					entry["Reason"] = e->reason;
					this->list.AddEntry(entry);
				}
			}
			nl_list(source, list, mask);
			nl_list.Process();
		}
		else
		{
			for (unsigned i = 0, end = OperServ::session_service->GetExceptions().size(); i < end; ++i)
			{
				auto *e = OperServ::session_service->GetExceptions()[i];
				if (mask.empty() || Anope::Match(e->mask, mask))
				{
					ListFormatter::ListEntry entry;
					entry["Number"] = Anope::ToString(i + 1);
					entry["Mask"] = e->mask;
					entry["Creator"] = e->who;
					entry["Created"] = Anope::strftime(e->time, NULL, true);
					entry["Expires"] = Anope::Expires(e->expires, source.GetAccount());
					entry["Limit"] = Anope::ToString(e->limit);
					entry["Reason"] = e->reason;
					list.AddEntry(entry);
				}
			}
		}

		if (list.IsEmpty())
			source.Reply(_("No matching entries on session-limit exception list."));
		else
		{
			source.Reply(_("Current Session Limit Exception list:"));
			list.SendTo(source);
		}
	}

	void DoList(CommandSource &source, const std::vector<Anope::string> &params)
	{
		ListFormatter list(source.GetAccount());
		list.AddColumn(_("Number")).AddColumn(_("Limit")).AddColumn(_("Mask")).AddColumn(_("Reason"));
		list.SetFlexible(_("{number}: \002{mask}\002 -- {limit} sessions ({reason})"));

		this->ProcessList(source, params, list);
	}

	void DoView(CommandSource &source, const std::vector<Anope::string> &params)
	{
		ListFormatter list(source.GetAccount());
		list.AddColumn(_("Number")).AddColumn(_("Mask")).AddColumn(_("Creator")).AddColumn(_("Created")).AddColumn(_("Expires")).AddColumn(_("Limit")).AddColumn(_("Reason"));
		list.SetFlexible(_("{number}: \002{mask}\002 -- {limit} sessions; created by {creator} on {created}; {expires} ({reason})"));

		this->ProcessList(source, params, list);
	}

public:
	CommandOSException(Module *creator) : Command(creator, "operserv/exception", 1, 5)
	{
		this->SetDesc(_("Modify the session-limit exception list"));
		this->SetSyntax(_("ADD [\037+expiry\037] \037mask\037 \037limit\037 \037reason\037"));
		this->SetSyntax(_("DEL {\037mask\037 | \037entry-num\037 | \037list\037}"));
		this->SetSyntax(_("LIST [\037mask\037 | \037list\037]"));
		this->SetSyntax(_("VIEW [\037mask\037 | \037list\037]"));
	}

	void Execute(CommandSource &source, const std::vector<Anope::string> &params) override
	{
		const Anope::string &cmd = params[0];

		if (!session_limit)
			source.Reply(_("Session limiting is disabled."));
		else if (cmd.equals_ci("ADD"))
			return this->DoAdd(source, params);
		else if (cmd.equals_ci("DEL"))
			return this->DoDel(source, params);
		else if (cmd.equals_ci("LIST"))
			return this->DoList(source, params);
		else if (cmd.equals_ci("VIEW"))
			return this->DoView(source, params);
		else
			this->OnSyntaxError(source, "");
	}

	bool OnHelp(CommandSource &source, const Anope::string &subcommand) override
	{
		this->SendSyntax(source);
		source.Reply(" ");
		source.Reply(_(
				"Allows Services Operators to manipulate the list of hosts that "
				"have specific session limits - allowing certain machines, "
				"such as shell servers, to carry more than the default number "
				"of clients at a time. Once a host reaches its session limit, "
				"all clients attempting to connect from that host will be "
				"killed. Before the user is killed, they are notified, of a "
				"source of help regarding session limiting. The content of "
				"this notice is a config setting."
				"\n\n"
				"\002%s\033ADD\002 adds the given host mask to the exception list. "
				"Note that \002nick!user@host\002 and \002user@host\002 masks are invalid! "
				"Only real host masks, such as \002box.host.dom\002 and \002*.host.dom\002, "
				"are allowed because sessions limiting does not take nick or "
				"user names into account. \037limit\037 must be a number greater than "
				"or equal to zero. This determines how many sessions this host "
				"may carry at a time. A value of zero means the host has an "
				"unlimited session limit. See the \002AKILL\002 help for details about "
				"the format of the optional \037expiry\037 parameter. "
				"\n\n"
				"\002%s\033DEL\002 removes the given mask from the exception list."
				"\n\n"
				"\002%s\033LIST\002 and \002%s\033VIEW\002 show all current "
				"sessions if the optional mask is given, the list is limited "
				"to those sessions matching the mask. The difference is that "
				"\002%s\033VIEW\002 is more verbose, displaying the name of the "
				"person who added the exception, its session limit, reason, "
				"host mask and the expiry date and time. "
				"\n\n"
				"Note that a connecting client will \"use\" the first exception "
				"their host matches."
			),
			source.command.nobreak().c_str(),
			source.command.nobreak().c_str(),
			source.command.nobreak().c_str(),
			source.command.nobreak().c_str(),
			source.command.nobreak().c_str());
		return true;
	}
};

class OSSession final
	: public Module
{
	ExceptionType exception_type;
	MySessionService ss;
	CommandOSSession commandossession;
	CommandOSException commandosexception;
	ServiceReference<XLineManager> akills;

public:
	OSSession(const Anope::string &modname, const Anope::string &creator)
		: Module(modname, creator, VENDOR)
		, ss(this)
		, commandossession(this)
		, commandosexception(this)
		, akills("XLineManager", "xlinemanager/sgline")
	{
		this->SetPermanent(true);
	}

	void Prioritize() override
	{
		ModuleManager::SetPriority(this, PRIORITY_FIRST);
	}

	void OnReload(Configuration::Conf &conf) override
	{
		const auto &block = Config->GetModule(this);

		session_limit = block.Get<unsigned>("defaultsessionlimit");
		max_session_kill = block.Get<unsigned>("maxsessionkill");
		session_autokill_expiry = block.Get<time_t>("sessionautokillexpiry");
		sle_reason = block.Get<const Anope::string>("sessionlimitexceeded");
		sle_detailsloc = block.Get<const Anope::string>("sessionlimitdetailsloc");

		max_exception_limit = block.Get<unsigned>("maxsessionlimit");
		exception_expiry = block.Get<time_t>("exceptionexpiry");

		ipv4_cidr = block.Get<unsigned>("session_ipv4_cidr", "32");
		ipv6_cidr = block.Get<unsigned>("session_ipv6_cidr", "128");

		if (ipv4_cidr > 32 || ipv6_cidr > 128)
			throw ConfigException(this->name + ": session CIDR value out of range");
	}

	void OnUserConnect(User *u, bool &exempt) override
	{
		if (u->Quitting() || !session_limit || exempt || !u->server || u->server->IsULined())
			return;

		cidr u_ip(u->ip, u->ip.ipv6() ? ipv6_cidr : ipv4_cidr);
		if (!u_ip.valid())
			return;

		auto *&session = this->ss.FindOrCreateSession(u_ip);

		if (session)
		{
			bool kill = false;
			if (session->count >= session_limit)
			{
				kill = true;
				auto *exception = this->ss.FindException(u);
				if (exception)
				{
					kill = false;
					if (exception->limit && session->count >= exception->limit)
						kill = true;
				}
			}

			/* Previously on IRCds that send a QUIT (InspIRCD) when a user is killed, the session for a host was
			 * decremented in do_quit, which caused problems and fixed here
			 *
			 * Now, we create the user struture before calling this to fix some user tracking issues,
			 * so we must increment this here no matter what because it will either be
			 * decremented when the user is killed or quits - Adam
			 */
			++session->count;

			if (kill && !exempt)
			{
				BotInfo *OperServ = Config->GetClient("OperServ");
				if (OperServ)
				{
					if (!sle_reason.empty())
					{
						auto message = Anope::Template(sle_reason, {
							{ "ip", u->ip.addr() },
						});
						u->SendMessage(OperServ, message);
					}
					if (!sle_detailsloc.empty())
						u->SendMessage(OperServ, sle_detailsloc);
				}

				++session->hits;

				const Anope::string &akillmask = "*@" + session->addr.mask();
				if (max_session_kill && session->hits >= max_session_kill && akills && !akills->HasEntry(akillmask))
				{
					auto *x = new XLine(akillmask, OperServ ? OperServ->nick : "", Anope::CurTime + session_autokill_expiry, "Session limit exceeded", XLineManager::GenerateUID());
					akills->AddXLine(x);
					akills->Send(NULL, x);
					Log(OperServ, "akill/session") << "Added a temporary AKILL for \002" << akillmask << "\002 due to excessive connections";
				}
				else
				{
					u->Kill(OperServ, "Session limit exceeded");
				}
			}
		}
		else
		{
			session = new OperServ::Session(u->ip, u->ip.ipv6() ? ipv6_cidr : ipv4_cidr);
		}
	}

	void OnUserQuit(User *u, const Anope::string &msg) override
	{
		if (!session_limit || !u->server || u->server->IsULined())
			return;

		auto &sessions = this->ss.GetSessions();
		auto sit = this->ss.FindSessionIterator(u->ip);

		if (sit == sessions.end())
			return;

		auto *session = sit->second;

		if (session->count > 1)
		{
			--session->count;
			return;
		}

		delete session;
		sessions.erase(sit);
	}

	void OnExpireTick() override
	{
		if (Anope::NoExpire)
			return;
		for (unsigned i = this->ss.GetExceptions().size(); i > 0; --i)
		{
			auto *e = this->ss.GetExceptions()[i - 1];

			if (!e->expires || e->expires > Anope::CurTime)
				continue;
			BotInfo *OperServ = Config->GetClient("OperServ");
			Log(OperServ, "expire/exception") << "Session exception for " << e->mask << " has expired.";
			this->ss.DelException(e);
			delete e;
		}
	}
};

MODULE_INIT(OSSession)