-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2007 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ * Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
+ * Copyright (C) 2012-2015 Attila Molnar <attilamolnar@hush.com>
+ * Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
+ * Copyright (C) 2012 Shawn Smith <ShawnSmith0828@gmail.com>
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2009 Uli Schlachter <psychon@inspircd.org>
+ * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
+ * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ * Copyright (C) 2006, 2008 Craig Edwards <brain@inspircd.org>
*
- * This program is free but copyrighted software; see
- * the file COPYING for details.
+ * 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
+ * License as published by the Free Software Foundation, version 2.
*
- * ---------------------------------------------------
+ * This program is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+ * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+ * details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
-#include "users.h"
-#include "channels.h"
-#include "modules.h"
-#include "hashcomp.h"
+
#include "inspircd.h"
+#include "modules/account.h"
+#include "modules/callerid.h"
+#include "modules/ctctags.h"
+#include "modules/exemption.h"
+#include "modules/whois.h"
+
+enum
+{
+ // From UnrealIRCd.
+ RPL_WHOISREGNICK = 307,
-/* $ModDesc: Povides support for ircu-style services accounts, including chmode +R, etc. */
+ // From ircu.
+ RPL_WHOISACCOUNT = 330,
+
+ // From ircd-hybrid?
+ ERR_NEEDREGGEDNICK = 477,
+
+ // From IRCv3 sasl-3.1.
+ RPL_LOGGEDIN = 900,
+ RPL_LOGGEDOUT = 901
+};
-/** Channel mode +R - unidentified users cannot join
+/** Channel mode +r - mark a channel as identified
*/
-class AChannel_R : public ModeHandler
+class Channel_r : public ModeHandler
{
public:
- AChannel_R(InspIRCd* Instance) : ModeHandler(Instance, 'R', 0, 0, false, MODETYPE_CHANNEL, false) { }
+ Channel_r(Module* Creator) : ModeHandler(Creator, "c_registered", 'r', PARAM_NONE, MODETYPE_CHANNEL) { }
- ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding)
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
{
- if (adding)
+ // Only a U-lined server may add or remove the +r mode.
+ if (!IS_LOCAL(source))
{
- if (!channel->IsModeSet('R'))
+ // Only change the mode if it's not redundant
+ if ((adding != channel->IsModeSet(this)))
{
- channel->SetMode('R',true);
+ channel->SetMode(this, adding);
return MODEACTION_ALLOW;
}
}
else
{
- if (channel->IsModeSet('R'))
- {
- channel->SetMode('R',false);
- return MODEACTION_ALLOW;
- }
+ source->WriteNumeric(ERR_NOPRIVILEGES, "Only a server may modify the +r channel mode");
}
-
return MODEACTION_DENY;
}
};
-/** User mode +R - unidentified users cannot message
+/** User mode +r - mark a user as identified
*/
-class AUser_R : public ModeHandler
+class User_r : public ModeHandler
{
+
public:
- AUser_R(InspIRCd* Instance) : ModeHandler(Instance, 'R', 0, 0, false, MODETYPE_USER, false) { }
+ User_r(Module* Creator) : ModeHandler(Creator, "u_registered", 'r', PARAM_NONE, MODETYPE_USER) { }
- ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding)
+ ModeAction OnModeChange(User* source, User* dest, Channel* channel, std::string& parameter, bool adding) CXX11_OVERRIDE
{
- if (adding)
+ if (!IS_LOCAL(source))
{
- if (!dest->IsModeSet('R'))
+ if ((adding != dest->IsModeSet(this)))
{
- dest->SetMode('R',true);
+ dest->SetMode(this, adding);
return MODEACTION_ALLOW;
}
}
else
{
- if (dest->IsModeSet('R'))
- {
- dest->SetMode('R',false);
- return MODEACTION_ALLOW;
- }
+ source->WriteNumeric(ERR_NOPRIVILEGES, "Only a server may modify the +r user mode");
}
-
return MODEACTION_DENY;
}
};
-/** Channel mode +M - unidentified users cannot message channel
- */
-class AChannel_M : public ModeHandler
+class AccountExtItemImpl : public AccountExtItem
{
+ Events::ModuleEventProvider eventprov;
+
public:
- AChannel_M(InspIRCd* Instance) : ModeHandler(Instance, 'M', 0, 0, false, MODETYPE_CHANNEL, false) { }
+ AccountExtItemImpl(Module* mod)
+ : AccountExtItem("accountname", ExtensionItem::EXT_USER, mod)
+ , eventprov(mod, "event/account")
+ {
+ }
+
+ void FromInternal(Extensible* container, const std::string& value) CXX11_OVERRIDE
+ {
+ StringExtItem::FromInternal(container, value);
+ }
- ModeAction OnModeChange(userrec* source, userrec* dest, chanrec* channel, std::string ¶meter, bool adding)
+ void FromNetwork(Extensible* container, const std::string& value) CXX11_OVERRIDE
{
- if (adding)
+ StringExtItem::FromNetwork(container, value);
+
+ User* user = static_cast<User*>(container);
+ if (IS_LOCAL(user))
{
- if (!channel->IsModeSet('M'))
+ if (value.empty())
{
- channel->SetMode('M',true);
- return MODEACTION_ALLOW;
+ // Logged out.
+ user->WriteNumeric(RPL_LOGGEDOUT, user->GetFullHost(), "You are now logged out");
}
- }
- else
- {
- if (channel->IsModeSet('M'))
+ else
{
- channel->SetMode('M',false);
- return MODEACTION_ALLOW;
+ // Logged in.
+ user->WriteNumeric(RPL_LOGGEDIN, user->GetFullHost(), value, InspIRCd::Format("You are now logged in as %s", value.c_str()));
}
}
- return MODEACTION_DENY;
+ FOREACH_MOD_CUSTOM(eventprov, AccountEventListener, OnAccountChange, (user, value));
}
};
-class ModuleServicesAccount : public Module
+class ModuleServicesAccount
+ : public Module
+ , public Whois::EventListener
+ , public CTCTags::EventListener
{
-
- AChannel_R* m1;
- AChannel_M* m2;
- AUser_R* m3;
+ private:
+ CallerID::API calleridapi;
+ CheckExemption::EventProvider exemptionprov;
+ SimpleChannelModeHandler reginvitemode;
+ SimpleChannelModeHandler regmoderatedmode;
+ SimpleUserModeHandler regdeafmode;
+ Channel_r chanregmode;
+ User_r userregmode;
+ AccountExtItemImpl accountname;
+ bool checking_ban;
+
public:
- ModuleServicesAccount(InspIRCd* Me) : Module::Module(Me)
+ ModuleServicesAccount()
+ : Whois::EventListener(this)
+ , CTCTags::EventListener(this)
+ , calleridapi(this)
+ , exemptionprov(this)
+ , reginvitemode(this, "reginvite", 'R')
+ , regmoderatedmode(this, "regmoderated", 'M')
+ , regdeafmode(this, "regdeaf", 'R')
+ , chanregmode(this)
+ , userregmode(this)
+ , accountname(this)
+ , checking_ban(false)
{
-
- m1 = new AChannel_R(ServerInstance);
- m2 = new AChannel_M(ServerInstance);
- m3 = new AUser_R(ServerInstance);
- if (!ServerInstance->AddMode(m1, 'R') || !ServerInstance->AddMode(m2, 'M') || !ServerInstance->AddMode(m3, 'R'))
- throw ModuleException("Could not add new modes!");
+ }
+
+ void On005Numeric(std::map<std::string, std::string>& tokens) CXX11_OVERRIDE
+ {
+ tokens["EXTBAN"].push_back('R');
+ tokens["EXTBAN"].push_back('U');
}
/* <- :twisted.oscnet.org 330 w00t2 w00t2 w00t :is logged in as */
- virtual void OnWhois(userrec* source, userrec* dest)
+ void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
{
- std::string *account;
- dest->GetExt("accountname", account);
+ std::string* account = accountname.get(whois.GetTarget());
if (account)
{
- ServerInstance->SendWhoisLine(source, dest, 330, "%s %s %s :is logged in as", source->nick, dest->nick, account->c_str());
+ whois.SendLine(RPL_WHOISACCOUNT, *account, "is logged in as");
+ }
+
+ if (whois.GetTarget()->IsModeSet(userregmode))
+ {
+ /* user is registered */
+ whois.SendLine(RPL_WHOISREGNICK, "is a registered nick");
}
}
- void Implements(char* List)
+ void OnUserPostNick(User* user, const std::string &oldnick) CXX11_OVERRIDE
{
- List[I_OnWhois] = List[I_OnUserPreMessage] = List[I_OnUserPreNotice] = List[I_OnUserPreJoin] = 1;
- List[I_OnSyncUserMetaData] = List[I_OnUserQuit] = List[I_OnCleanup] = List[I_OnDecodeMetaData] = 1;
+ /* On nickchange, if they have +r, remove it */
+ if ((user->IsModeSet(userregmode)) && (ServerInstance->FindNickOnly(oldnick) != user))
+ userregmode.RemoveMode(user);
}
- virtual int OnUserPreMessage(userrec* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
+ ModResult HandleMessage(User* user, const MessageTarget& target)
{
- std::string *account;
-
if (!IS_LOCAL(user))
- return 0;
+ return MOD_RES_PASSTHRU;
+
+ std::string *account = accountname.get(user);
+ bool is_registered = account && !account->empty();
- user->GetExt("accountname", account);
-
- if (target_type == TYPE_CHANNEL)
+ switch (target.type)
{
- chanrec* c = (chanrec*)dest;
-
- if ((c->IsModeSet('M')) && (!account))
+ case MessageTarget::TYPE_CHANNEL:
{
- if ((ServerInstance->ULine(user->nick)) || (ServerInstance->ULine(user->server)))
- {
- // user is ulined, can speak regardless
- return 0;
- }
+ Channel* targchan = target.Get<Channel>();
+
+ if (!targchan->IsModeSet(regmoderatedmode) || is_registered)
+ return MOD_RES_PASSTHRU;
+
+ if (CheckExemption::Call(exemptionprov, user, targchan, "regmoderated") == MOD_RES_ALLOW)
+ return MOD_RES_PASSTHRU;
- // user messaging a +M channel and is not registered
- user->WriteServ("477 "+std::string(user->nick)+" "+std::string(c->name)+" :You need to be identified to a registered account to message this channel");
- return 1;
+ // User is messaging a +M channel and is not registered or exempt.
+ user->WriteNumeric(ERR_NEEDREGGEDNICK, targchan->name, "You need to be identified to a registered account to message this channel");
+ return MOD_RES_DENY;
+ break;
}
- }
- if (target_type == TYPE_USER)
- {
- userrec* u = (userrec*)dest;
-
- if ((u->modes['R'-65]) && (!account))
+ case MessageTarget::TYPE_USER:
{
- if ((ServerInstance->ULine(user->nick)) || (ServerInstance->ULine(user->server)))
- {
- // user is ulined, can speak regardless
- return 0;
- }
+ User* targuser = target.Get<User>();
+ if (!targuser->IsModeSet(regdeafmode) || is_registered)
+ return MOD_RES_PASSTHRU;
+
+ if (calleridapi && calleridapi->IsOnAcceptList(user, targuser))
+ return MOD_RES_PASSTHRU;
- // user messaging a +R user and is not registered
- user->WriteServ("477 "+std::string(user->nick)+" "+std::string(u->nick)+" :You need to be identified to a registered account to message this user");
- return 1;
+ // User is messaging a +R user and is not registered or on an accept list.
+ user->WriteNumeric(ERR_NEEDREGGEDNICK, targuser->nick, "You need to be identified to a registered account to message this user");
+ return MOD_RES_DENY;
+ break;
}
+ case MessageTarget::TYPE_SERVER:
+ break;
}
- return 0;
+ return MOD_RES_PASSTHRU;
}
-
- virtual int OnUserPreNotice(userrec* user,void* dest,int target_type, std::string &text, char status, CUList &exempt_list)
+
+ ModResult OnUserPreMessage(User* user, const MessageTarget& target, MessageDetails& details) CXX11_OVERRIDE
{
- return OnUserPreMessage(user, dest, target_type, text, status, exempt_list);
+ return HandleMessage(user, target);
}
-
- virtual int OnUserPreJoin(userrec* user, chanrec* chan, const char* cname, std::string &privs)
+
+ ModResult OnUserPreTagMessage(User* user, const MessageTarget& target, CTCTags::TagMessageDetails& details) CXX11_OVERRIDE
{
- std::string *account;
- user->GetExt("accountname", account);
-
- if (chan)
- {
- if (chan->IsModeSet('R'))
- {
- if (!account)
- {
- if ((ServerInstance->ULine(user->nick)) || (ServerInstance->ULine(user->server)))
- {
- // user is ulined, won't be stopped from joining
- return 0;
- }
- // joining a +R channel and not identified
- user->WriteServ("477 "+std::string(user->nick)+" "+std::string(chan->name)+" :You need to be identified to a registered account to join this channel");
- return 1;
- }
- }
- }
- return 0;
+ return HandleMessage(user, target);
}
-
- // Whenever the linking module wants to send out data, but doesnt know what the data
- // represents (e.g. it is metadata, added to a userrec or chanrec by a module) then
- // this method is called. We should use the ProtoSendMetaData function after we've
- // corrected decided how the data should look, to send the metadata on its way if
- // it is ours.
- virtual void OnSyncUserMetaData(userrec* user, Module* proto, void* opaque, const std::string &extname)
+
+ ModResult OnCheckBan(User* user, Channel* chan, const std::string& mask) CXX11_OVERRIDE
{
- // check if the linking module wants to know about OUR metadata
- if (extname == "accountname")
+ if (checking_ban)
+ return MOD_RES_PASSTHRU;
+
+ if ((mask.length() > 2) && (mask[1] == ':'))
{
- // check if this user has an swhois field to send
- std::string* account;
- user->GetExt("accountname", account);
- if (account)
+ if (mask[0] == 'R')
{
- // remove any accidental leading/trailing spaces
- trim(*account);
-
- // call this function in the linking module, let it format the data how it
- // sees fit, and send it on its way. We dont need or want to know how.
- proto->ProtoSendMetaData(opaque,TYPE_USER,user,extname,*account);
+ std::string *account = accountname.get(user);
+ if (account && InspIRCd::Match(*account, mask.substr(2)))
+ return MOD_RES_DENY;
}
- }
- }
+ else if (mask[0] == 'U')
+ {
+ std::string *account = accountname.get(user);
+ /* If the user is registered we don't care. */
+ if (account)
+ return MOD_RES_PASSTHRU;
- // when a user quits, tidy up their metadata
- virtual void OnUserQuit(userrec* user, const std::string &message, const std::string &oper_message)
- {
- std::string* account;
- user->GetExt("accountname", account);
- if (account)
- {
- user->Shrink("accountname");
- delete account;
- }
- }
+ /* If we made it this far we know the user isn't registered
+ so just deny if it matches */
+ checking_ban = true;
+ bool result = chan->CheckBan(user, mask.substr(2));
+ checking_ban = false;
- // if the module is unloaded, tidy up all our dangling metadata
- virtual void OnCleanup(int target_type, void* item)
- {
- if (target_type == TYPE_USER)
- {
- userrec* user = (userrec*)item;
- std::string* account;
- user->GetExt("accountname", account);
- if (account)
- {
- user->Shrink("accountname");
- delete account;
+ if (result)
+ return MOD_RES_DENY;
}
}
+
+ /* If we made it this far then the ban wasn't an ExtBan
+ or the user we were checking for didn't match either ExtBan */
+ return MOD_RES_PASSTHRU;
}
- // Whenever the linking module receives metadata from another server and doesnt know what
- // to do with it (of course, hence the 'meta') it calls this method, and it is up to each
- // module in turn to figure out if this metadata key belongs to them, and what they want
- // to do with it.
- // In our case we're only sending a single string around, so we just construct a std::string.
- // Some modules will probably get much more complex and format more detailed structs and classes
- // in a textual way for sending over the link.
- virtual void OnDecodeMetaData(int target_type, void* target, const std::string &extname, const std::string &extdata)
+ ModResult OnUserPreJoin(LocalUser* user, Channel* chan, const std::string& cname, std::string& privs, const std::string& keygiven) CXX11_OVERRIDE
{
- // check if its our metadata key, and its associated with a user
- if ((target_type == TYPE_USER) && (extname == "accountname"))
- {
- userrec* dest = (userrec*)target;
-
- /* logging them out? */
- if (extdata.empty())
- {
- std::string* account;
- dest->GetExt("accountname", account);
- if (account)
- {
- dest->Shrink("accountname");
- delete account;
- }
- }
- else
+ std::string *account = accountname.get(user);
+ bool is_registered = account && !account->empty();
+
+ if (chan)
+ {
+ if (chan->IsModeSet(reginvitemode))
{
- // if they dont already have an accountname field, accept the remote server's
- std::string* text;
- if (!dest->GetExt("accountname", text))
+ if (!is_registered)
{
- text = new std::string(extdata);
- // remove any accidental leading/trailing spaces
- trim(*text);
- dest->Extend("accountname", text);
+ // joining a +R channel and not identified
+ user->WriteNumeric(ERR_NEEDREGGEDNICK, chan->name, "You need to be identified to a registered account to join this channel");
+ return MOD_RES_DENY;
}
}
}
+ return MOD_RES_PASSTHRU;
}
- virtual ~ModuleServicesAccount()
- {
- ServerInstance->Modes->DelMode(m1);
- ServerInstance->Modes->DelMode(m2);
- ServerInstance->Modes->DelMode(m3);
- DELETE(m1);
- DELETE(m2);
- DELETE(m3);
- }
-
- virtual Version GetVersion()
+ ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
{
- return Version(1,1,0,0,VF_COMMON|VF_VENDOR,API_VERSION);
+ if (myclass->config->getBool("requireaccount") && !accountname.get(user))
+ {
+ ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as it requires the user to be logged into an account",
+ myclass->GetName().c_str());
+ return MOD_RES_DENY;
+ }
+ return MOD_RES_PASSTHRU;
}
-};
-
-class ModuleServicesAccountFactory : public ModuleFactory
-{
- public:
- ModuleServicesAccountFactory()
+ Version GetVersion() CXX11_OVERRIDE
{
+ return Version("Adds various channel and user modes relating to services accounts.", VF_OPTCOMMON|VF_VENDOR);
}
-
- ~ModuleServicesAccountFactory()
- {
- }
-
- virtual Module * CreateModule(InspIRCd* Me)
- {
- return new ModuleServicesAccount(Me);
- }
-
};
-
-extern "C" void * init_module( void )
-{
- return new ModuleServicesAccountFactory;
-}
+MODULE_INIT(ModuleServicesAccount)