/* ngIRCd Protocol module for Anope IRC Services * * (C) 2011-2012, 2014 Alexander Barton * (C) 2011-2025 Anope Team * * Please read COPYING and README for further details. * * Based on the original code of Epona by Lara. * Based on the original code of Services by Andy Church. */ #include "module.h" #include "numeric.h" class ngIRCdProto final : public IRCDProto { void SendSVSKill(const MessageSource &source, User *user, const Anope::string &buf) override { IRCDProto::SendSVSKill(source, user, buf); user->KillInternal(source, buf); } public: ngIRCdProto(Module *creator) : IRCDProto(creator, "ngIRCd") { DefaultPseudoclientModes = "+oi"; CanCertFP = true; CanSVSNick = true; CanSetVHost = true; CanSetVIdent = true; MaxModes = 5; } void SendAkill(User *u, XLine *x) override { // Calculate the time left before this would expire time_t timeleft = x->expires ? x->expires - Anope::CurTime : x->expires; Uplink::Send("GLINE", x->mask, timeleft, x->GetReason() + " (" + x->by + ")"); } void SendAkillDel(const XLine *x) override { Uplink::Send("GLINE", x->mask); } void SendChannel(Channel *c) override { Uplink::Send("CHANINFO", c->name, "+" + c->GetModes(true, true)); } // Received: :dev.anope.de NICK DukeP 1 ~DukePyro p57ABF9C9.dip.t-dialin.net 1 +i :DukePyrolator void SendClientIntroduction(User *u) override { Uplink::Send("NICK", u->nick, 1, u->GetIdent(), u->host, 1, "+" + u->GetModes(), u->realname); } void SendConnect() override { Uplink::Send("PASS", Config->Uplinks[Anope::CurrentUplink].password, "0210-IRC+", "Anope|" + Anope::VersionShort() + ":CLHMSo P"); /* Make myself known to myself in the serverlist */ SendServer(Me); /* finish the enhanced server handshake and register the connection */ this->SendNumeric(RPL_ENDOFMOTD, "*", "End of MOTD command"); } void SendForceNickChange(User *u, const Anope::string &newnick, time_t when) override { Uplink::Send("SVSNICK", u->nick, newnick); } void SendGlobalNotice(BotInfo *bi, const Server *dest, const Anope::string &msg) override { Uplink::Send(bi, "NOTICE", "$" + dest->GetName(), msg); } void SendGlobalPrivmsg(BotInfo *bi, const Server *dest, const Anope::string &msg) override { Uplink::Send(bi, "PRIVMSG", "$" + dest->GetName(), msg); } void SendGlobops(const MessageSource &source, const Anope::string &buf) override { Uplink::Send(source, "WALLOPS", buf); } void SendJoin(User *user, Channel *c, const ChannelStatus *status) override { Uplink::Send(user, "JOIN", c->name); if (status) { /* First save the channel status incase uc->Status == status */ ChannelStatus cs = *status; /* If the user is internally on the channel with flags, kill them so that * the stacker will allow this. */ ChanUserContainer *uc = c->FindUser(user); if (uc != NULL) uc->status.Clear(); BotInfo *setter = BotInfo::Find(user->GetUID()); for (auto mode : cs.Modes()) c->SetMode(setter, ModeManager::FindChannelModeByChar(mode), user->GetUID(), false); if (uc != NULL) uc->status = cs; } } void SendLogin(User *u, NickAlias *na) override { Uplink::Send("METADATA", u->GetUID(), "accountname", na->nc->display); } void SendLogout(User *u) override { Uplink::Send("METADATA", u->GetUID(), "accountname", ""); } /* SERVER name hop descript */ void SendServer(const Server *server) override { Uplink::Send("SERVER", server->GetName(), server->GetHops(), server->GetDescription()); } void SendVHost(User *u, const Anope::string &vident, const Anope::string &vhost) override { if (!vident.empty()) Uplink::Send("METADATA", u->nick, "user", vident); Uplink::Send("METADATA", u->nick, "cloakhost", vhost); if (!u->HasMode("CLOAK")) { u->SetMode(Config->GetClient("HostServ"), "CLOAK"); ModeManager::ProcessModes(); } } void SendVHostDel(User *u) override { this->SendVHost(u, u->GetIdent(), ""); } bool Format(Anope::string &message, const Anope::map &tags, const MessageSource &source, const Anope::string &command, const std::vector ¶ms) override { return IRCDProto::Format(message, tags, source.GetSource().empty() ? Me : source, command, params); } }; struct IRCDMessage005 final : IRCDMessage { IRCDMessage005(Module *creator) : IRCDMessage(creator, "005", 1) { SetFlag(FLAG_SOFT_LIMIT); } // Please see for details. void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { size_t pos; Anope::string parameter, data; for (const auto ¶m : params) { pos = param.find('='); if (pos != Anope::string::npos) { parameter = param.substr(0, pos); data = param.substr(pos+1, param.length()); if (parameter == "MODES") { IRCD->MaxModes = Anope::Convert(data, IRCD->MaxModes); } else if (parameter == "NICKLEN") { IRCD->MaxNick = Anope::Convert(data, IRCD->MaxNick); } } } } }; struct IRCDMessage376 final : IRCDMessage { IRCDMessage376(Module *creator) : IRCDMessage(creator, "376", 2) { } /* * :ngircd.dev.anope.de 376 services.anope.de :End of MOTD command * * we do nothing here, this function exists only to * avoid the "unknown message from server" message. * */ void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { } }; struct IRCDMessageChaninfo final : IRCDMessage { IRCDMessageChaninfo(Module *creator) : IRCDMessage(creator, "CHANINFO", 2) { SetFlag(FLAG_SOFT_LIMIT); SetFlag(FLAG_REQUIRE_SERVER); } /* * CHANINFO is used by servers to inform each other about a channel: its * modes, channel key, user limits and its topic. The parameter combination * and is optional, as well as the parameter, so that * there are three possible forms of this command: * * CHANINFO + * CHANINFO + : * CHANINFO + : * * The parameter must be ignored if a channel has no key (the parameter * doesn't list the "k" channel mode). In this case should * contain "*" because the parameter is required by the CHANINFO syntax * and therefore can't be omitted. The parameter must be ignored when * a channel has no user limit (the parameter doesn't list the "l" * channel mode). In this case should be "0". */ void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { bool created; Channel *c = Channel::FindOrCreate(params[0], created); std::vector modeparams; if (params.size() == 3) { c->ChangeTopicInternal(NULL, source.GetName(), params[2], Anope::CurTime); } else if (params.size() == 5) { for (size_t i = 0, end = params[1].length(); i < end; ++i) { switch(params[1][i]) { case 'k': modeparams.push_back(params[2]); continue; case 'l': modeparams.push_back(params[3]); continue; } } c->ChangeTopicInternal(NULL, source.GetName(), params[4], Anope::CurTime); } c->SetModesInternal(source, params[1], modeparams); } }; struct IRCDMessageJoin final : Message::Join { IRCDMessageJoin(Module *creator) : Message::Join(creator, "JOIN") { SetFlag(FLAG_REQUIRE_USER); } /* * <@po||ux> DukeP: RFC 2813, 4.2.1: the JOIN command on server-server links * separates the modes ("o") with ASCII 7, not space. And you can't see ASCII 7. * * if a user joins a new channel, the ircd sends \7 */ void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { User *user = source.GetUser(); size_t pos = params[0].find('\7'); Anope::string channel, modes; std::vector modeparams; if (pos != Anope::string::npos) { channel = params[0].substr(0, pos); modes = '+' + params[0].substr(pos+1, params[0].length()); modeparams.push_back(user->nick); } else { channel = params[0]; } std::vector new_params; new_params.push_back(channel); Message::Join::Run(source, new_params, tags); if (!modes.empty()) { Channel *c = Channel::Find(channel); if (c) c->SetModesInternal(source, modes, modeparams); } } }; struct IRCDMessageMetadata final : IRCDMessage { IRCDMessageMetadata(Module *creator) : IRCDMessage(creator, "METADATA", 3) { SetFlag(FLAG_REQUIRE_SERVER); } /* * Received: :ngircd.dev.anope.de METADATA DukePyrolator host :anope-e2ee5c7d * * params[0] = nick of the user * params[1] = command * params[2] = data * * following commands are supported: * - "accountname": the account name of a client (can't be empty) * - "certfp": the certificate fingerprint of a client (can't be empty) * - "cloakhost" : the cloaked hostname of a client * - "host": the hostname of a client (can't be empty) * - "info": info text ("real name") of a client * - "user": the user name (ident) of a client (can't be empty) */ void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { User *u = User::Find(params[0]); if (!u) { Log(LOG_DEBUG) << "received METADATA for nonexistent user " << params[0]; return; } if (params[1].equals_cs("accountname")) { NickCore *nc = NickCore::Find(params[2]); if (nc) u->Login(nc); } else if (params[1].equals_cs("certfp")) { u->fingerprint = params[2]; FOREACH_MOD(OnFingerprint, (u)); } else if (params[1].equals_cs("cloakhost")) { if (!params[2].empty()) u->SetDisplayedHost(params[2]); } else if (params[1].equals_cs("host")) { u->SetCloakedHost(params[2]); } else if (params[1].equals_cs("info")) { u->SetRealname(params[2]); } else if (params[1].equals_cs("user")) { u->SetVIdent(params[2]); } } }; struct IRCDMessageMode final : IRCDMessage { IRCDMessageMode(Module *creator) : IRCDMessage(creator, "MODE", 2) { SetFlag(FLAG_SOFT_LIMIT); } /* * Received: :DukeP MODE #anope +b *!*@*.aol.com * Received: :DukeP MODE #anope +h DukeP * params[0] = channel or nick * params[1] = modes * params[n] = parameters */ void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { if (IRCD->IsChannelValid(params[0])) { Channel *c = Channel::Find(params[0]); if (c) c->SetModesInternal(source, params[1], { params.begin() + 2, params.end() }); } else { User *u = User::Find(params[0]); if (u) u->SetModesInternal(source, params[1]); } } }; struct IRCDMessageNick final : IRCDMessage { IRCDMessageNick(Module *creator) : IRCDMessage(creator, "NICK", 1) { SetFlag(FLAG_SOFT_LIMIT); } /* * NICK - NEW * Received: :dev.anope.de NICK DukeP_ 1 ~DukePyro ip-2-201-236-154.web.vodafone.de 1 + :DukePyrolator * Parameters: : * source = server * params[0] = nick * params[1] = hopcount * params[2] = username/ident * params[3] = host * params[4] = servertoken * params[5] = modes * params[6] = info * * NICK - change * Received: :DukeP_ NICK :test2 * source = oldnick * params[0] = newnick * */ void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { if (params.size() == 1) { User *u = source.GetUser(); // we have a nickchange if (u) u->ChangeNick(params[0]); } else if (params.size() == 7) { // a new user is connecting to the network Server *s = Server::Find(params[4]); if (s == NULL) { Log(LOG_DEBUG) << "User " << params[0] << " introduced from nonexistent server " << params[4] << "?"; return; } User::OnIntroduce(params[0], params[2], params[3], "", "", s, params[6], Anope::CurTime, params[5], "", NULL); Log(LOG_DEBUG) << "Registered nick \"" << params[0] << "\" on server " << s->GetName() << "."; } else { Log(LOG_DEBUG) << "Received NICK with invalid number of parameters. source = " << source.GetName() << "params[0] = " << params[0] << "params.size() = " << params.size(); } } }; struct IRCDMessageNJoin final : IRCDMessage { IRCDMessageNJoin(Module *creator) : IRCDMessage(creator, "NJOIN",2) { SetFlag(FLAG_REQUIRE_SERVER); }; /* * RFC 2813, 4.2.2: Njoin Message: * The NJOIN message is used between servers only. * It is used when two servers connect to each other to exchange * the list of channel members for each channel. * * Even though the same function can be performed by using a succession * of JOIN, this message SHOULD be used instead as it is more efficient. * * Received: :dev.anope.de NJOIN #test :DukeP2,@DukeP,%test,+test2 */ void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { std::list users; commasepstream sep(params[1]); Anope::string buf; while (sep.GetToken(buf)) { Message::Join::SJoinUser sju; /* Get prefixes from the nick */ for (char ch; (ch = ModeManager::GetStatusChar(buf[0]));) { buf.erase(buf.begin()); sju.first.AddMode(ch); } sju.second = User::Find(buf); if (!sju.second) { Log(LOG_DEBUG) << "NJOIN for nonexistent user " << buf << " on " << params[0]; continue; } users.push_back(sju); } Message::Join::SJoin(source, params[0], 0, "", {}, users); } }; struct IRCDMessagePong final : IRCDMessage { IRCDMessagePong(Module *creator) : IRCDMessage(creator, "PONG", 0) { SetFlag(FLAG_SOFT_LIMIT); SetFlag(FLAG_REQUIRE_SERVER); } /* * ngIRCd does not send an EOB, so we send a PING immediately * when receiving a new server and then finish sync once we * get a pong back from that server. */ void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { if (!source.GetServer()->IsSynced()) source.GetServer()->Sync(false); } }; struct IRCDMessageServer final : IRCDMessage { IRCDMessageServer(Module *creator) : IRCDMessage(creator, "SERVER", 3) { SetFlag(FLAG_SOFT_LIMIT); } /* * New directly linked server: * * SERVER tolsun.oulu.fi 1 :Experimental server * New server tolsun.oulu.fi introducing itself * and attempting to register. * * params[0] = servername * params[1] = hop count * params[2] = server description * * New remote server in the network: * * :tolsun.oulu.fi SERVER csd.bu.edu 5 34 :BU Central Server * Server tolsun.oulu.fi is our uplink for csd.bu.edu * which is 5 hops away. The token "34" will be used * by tolsun.oulu.fi when introducing new users or * services connected to csd.bu.edu. * * params[0] = servername * params[1] = hop count * params[2] = server numeric * params[3] = server description */ void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { if (params.size() == 3) { // our uplink is introducing itself new Server(Me, params[0], 1, params[2], "1"); } else { // our uplink is introducing a new server auto hops = Anope::Convert(params[1], 0); new Server(source.GetServer(), params[0], hops, params[3], params[2]); } /* * ngIRCd does not send an EOB, so we send a PING immediately * when receiving a new server and then finish sync once we * get a pong back from that server. */ IRCD->SendPing(Me->GetName(), params[0]); } }; struct IRCDMessageTopic final : IRCDMessage { IRCDMessageTopic(Module *creator) : IRCDMessage(creator, "TOPIC", 2) { SetFlag(FLAG_SOFT_LIMIT); } // Received: :DukeP TOPIC #anope :test void Run(MessageSource &source, const std::vector ¶ms, const Anope::map &tags) override { Channel *c = Channel::Find(params[0]); if (!c) { Log(LOG_DEBUG) << "TOPIC for nonexistent channel " << params[0]; return; } c->ChangeTopicInternal(source.GetUser(), source.GetName(), params[1], Anope::CurTime); } }; class ProtongIRCd final : public Module { ngIRCdProto ircd_proto; /* Core message handlers */ Message::Capab message_capab; Message::Error message_error; Message::Invite message_invite; Message::Kick message_kick; Message::Kill message_kill; Message::MOTD message_motd; Message::Notice message_notice; Message::Part message_part; Message::Ping message_ping; Message::Privmsg message_privmsg, message_squery; Message::Quit message_quit; Message::SQuit message_squit; Message::Stats message_stats; Message::Time message_time; Message::Version message_version; Message::Whois message_whois; /* Our message handlers */ IRCDMessage005 message_005; IRCDMessage376 message_376; IRCDMessageChaninfo message_chaninfo; IRCDMessageJoin message_join; IRCDMessageMetadata message_metadata; IRCDMessageMode message_mode; IRCDMessageNick message_nick; IRCDMessageNJoin message_njoin; IRCDMessagePong message_pong; IRCDMessageServer message_server; IRCDMessageTopic message_topic; static void AddModes() { /* Add user modes */ ModeManager::AddUserMode(new UserMode("NOCTCP", 'b')); ModeManager::AddUserMode(new UserMode("BOT", 'B')); ModeManager::AddUserMode(new UserMode("COMMONCHANS", 'C')); ModeManager::AddUserMode(new UserMode("INVIS", 'i')); ModeManager::AddUserMode(new UserModeOperOnly("OPER", 'o')); ModeManager::AddUserMode(new UserModeOperOnly("PROTECTED", 'q')); ModeManager::AddUserMode(new UserModeOperOnly("RESTRICTED", 'r')); ModeManager::AddUserMode(new UserModeNoone("REGISTERED", 'R')); ModeManager::AddUserMode(new UserModeOperOnly("SNOMASK", 's')); ModeManager::AddUserMode(new UserMode("WALLOPS", 'w')); ModeManager::AddUserMode(new UserMode("CLOAK", 'x')); /* Add modes for ban, exception, and invite lists */ ModeManager::AddChannelMode(new ChannelModeList("BAN", 'b')); ModeManager::AddChannelMode(new ChannelModeList("EXCEPT", 'e')); ModeManager::AddChannelMode(new ChannelModeList("INVITEOVERRIDE", 'I')); /* Add channel user modes */ ModeManager::AddChannelMode(new ChannelModeStatus("VOICE", 'v', '+', 0)); ModeManager::AddChannelMode(new ChannelModeStatus("HALFOP", 'h', '%', 1)); ModeManager::AddChannelMode(new ChannelModeStatus("OP", 'o', '@', 2)); ModeManager::AddChannelMode(new ChannelModeStatus("PROTECT", 'a', '&', 3)); ModeManager::AddChannelMode(new ChannelModeStatus("OWNER", 'q', '~', 4)); /* Add channel modes */ ModeManager::AddChannelMode(new ChannelMode("INVITE", 'i')); ModeManager::AddChannelMode(new ChannelModeKey('k')); ModeManager::AddChannelMode(new ChannelModeParam("LIMIT", 'l', true)); ModeManager::AddChannelMode(new ChannelMode("MODERATED", 'm')); ModeManager::AddChannelMode(new ChannelMode("REGMODERATED", 'M')); ModeManager::AddChannelMode(new ChannelMode("NOEXTERNAL", 'n')); ModeManager::AddChannelMode(new ChannelMode("OPERONLY", 'O')); ModeManager::AddChannelMode(new ChannelMode("PERM", 'P')); ModeManager::AddChannelMode(new ChannelMode("NOKICK", 'Q')); ModeManager::AddChannelMode(new ChannelModeNoone("REGISTERED", 'r')); ModeManager::AddChannelMode(new ChannelMode("REGISTEREDONLY", 'R')); ModeManager::AddChannelMode(new ChannelMode("SECRET", 's')); ModeManager::AddChannelMode(new ChannelMode("TOPIC", 't')); ModeManager::AddChannelMode(new ChannelMode("NOINVITE", 'V')); ModeManager::AddChannelMode(new ChannelMode("SSL", 'z')); } public: ProtongIRCd(const Anope::string &modname, const Anope::string &creator) : Module(modname, creator, PROTOCOL | VENDOR), ircd_proto(this), message_capab(this), message_error(this), message_invite(this), message_kick(this), message_kill(this), message_motd(this), message_notice(this), message_part(this), message_ping(this), message_privmsg(this), message_squery(this, "SQUERY"), message_quit(this), message_squit(this), message_stats(this), message_time(this), message_version(this), message_whois(this), message_005(this), message_376(this), message_chaninfo(this), message_join(this), message_metadata(this), message_mode(this), message_nick(this), message_njoin(this), message_pong(this), message_server(this), message_topic(this) { Servers::Capab.insert("QS"); this->AddModes(); } void OnUserNickChange(User *u, const Anope::string &) override { u->RemoveMode(Config->GetClient("NickServ"), "REGISTERED"); } }; MODULE_INIT(ProtongIRCd)