-/* +------------------------------------+
- * | Inspire Internet Relay Chat Daemon |
- * +------------------------------------+
+/*
+ * InspIRCd -- Internet Relay Chat Daemon
*
- * InspIRCd: (C) 2002-2008 InspIRCd Development Team
- * See: http://www.inspircd.org/wiki/index.php/Credits
+ * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ * Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
*
- * 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 "inspircd.h"
-#include "m_cap.h"
-#include "account.h"
+#include "modules/cap.h"
+#include "modules/account.h"
+#include "modules/sasl.h"
+#include "modules/ssl.h"
+#include "modules/server.h"
+
+enum
+{
+ // From IRCv3 sasl-3.1
+ RPL_SASLSUCCESS = 903,
+ ERR_SASLFAIL = 904,
+ ERR_SASLTOOLONG = 905,
+ ERR_SASLABORTED = 906,
+ RPL_SASLMECHS = 908
+};
-/* $ModDesc: Provides support for atheme SASL via AUTHENTICATE. */
+static std::string sasl_target;
-class CommandAuthenticate : public Command
+class ServerTracker : public ServerEventListener
{
- Module* Creator;
+ bool online;
+
+ void Update(const Server* server, bool linked)
+ {
+ if (sasl_target == "*")
+ return;
+
+ if (InspIRCd::Match(server->GetName(), sasl_target))
+ {
+ ServerInstance->Logs->Log(MODNAME, LOG_VERBOSE, "SASL target server \"%s\" %s", sasl_target.c_str(), (linked ? "came online" : "went offline"));
+ online = linked;
+ }
+ }
+
+ void OnServerLink(const Server* server) CXX11_OVERRIDE
+ {
+ Update(server, true);
+ }
+
+ void OnServerSplit(const Server* server) CXX11_OVERRIDE
+ {
+ Update(server, false);
+ }
+
public:
- CommandAuthenticate (InspIRCd* Instance, Module* creator) : Command(Instance,"AUTHENTICATE", 0, 1, true), Creator(creator)
+ ServerTracker(Module* mod)
+ : ServerEventListener(mod)
{
- this->source = "m_sasl.so";
+ Reset();
}
- CmdResult Handle (const char* const* parameters, int pcnt, User *user)
+ void Reset()
{
- if (user->registered != REG_ALL)
+ if (sasl_target == "*")
{
- /* Only act if theyve enabled CAP REQ sasl */
- if (user->GetExt("sasl"))
- {
- /* Only allow AUTHENTICATE on unregistered clients */
- std::deque<std::string> params;
- params.push_back("*");
- params.push_back("AUTHENTICATE");
- params.push_back(user->uuid);
+ online = true;
+ return;
+ }
- for (int i = 0; i < pcnt; ++i)
- params.push_back(parameters[i]);
+ online = false;
- Event e((char*)¶ms, Creator, "send_encap");
- e.Send(ServerInstance);
+ ProtocolInterface::ServerList servers;
+ ServerInstance->PI->GetServerList(servers);
+ for (ProtocolInterface::ServerList::const_iterator i = servers.begin(); i != servers.end(); ++i)
+ {
+ const ProtocolInterface::ServerInfo& server = *i;
+ if (InspIRCd::Match(server.servername, sasl_target))
+ {
+ online = true;
+ break;
}
}
- return CMD_FAILURE;
}
+
+ bool IsOnline() const { return online; }
};
+class SASLCap : public Cap::Capability
+{
+ std::string mechlist;
+ const ServerTracker& servertracker;
+
+ bool OnRequest(LocalUser* user, bool adding) CXX11_OVERRIDE
+ {
+ // Requesting this cap is allowed anytime
+ if (adding)
+ return true;
-class ModuleSASL : public Module
+ // But removing it can only be done when unregistered
+ return (user->registered != REG_ALL);
+ }
+
+ bool OnList(LocalUser* user) CXX11_OVERRIDE
+ {
+ return servertracker.IsOnline();
+ }
+
+ const std::string* GetValue(LocalUser* user) const CXX11_OVERRIDE
+ {
+ return &mechlist;
+ }
+
+ public:
+ SASLCap(Module* mod, const ServerTracker& tracker)
+ : Cap::Capability(mod, "sasl")
+ , servertracker(tracker)
+ {
+ }
+
+ void SetMechlist(const std::string& newmechlist)
+ {
+ if (mechlist == newmechlist)
+ return;
+
+ mechlist = newmechlist;
+ NotifyValueChange();
+ }
+};
+
+enum SaslState { SASL_INIT, SASL_COMM, SASL_DONE };
+enum SaslResult { SASL_OK, SASL_FAIL, SASL_ABORT };
+
+static Events::ModuleEventProvider* saslevprov;
+
+static void SendSASL(LocalUser* user, const std::string& agent, char mode, const std::vector<std::string>& parameters)
+{
+ CommandBase::Params params(parameters.size() + 3);
+ params.push_back(user->uuid);
+ params.push_back(agent);
+ params.push_back(ConvToStr(mode));
+ params.insert(params.end(), parameters.begin(), parameters.end());
+
+ if (!ServerInstance->PI->SendEncapsulatedData(sasl_target, "SASL", params))
+ {
+ FOREACH_MOD_CUSTOM(*saslevprov, SASLEventListener, OnSASLAuth, (params));
+ }
+}
+
+/**
+ * Tracks SASL authentication state like charybdis does. --nenolod
+ */
+class SaslAuthenticator
{
- CommandAuthenticate* sasl;
+ private:
+ std::string agent;
+ LocalUser* user;
+ SaslState state;
+ SaslResult result;
+ bool state_announced;
+
+ void SendHostIP()
+ {
+ std::vector<std::string> params;
+ params.push_back(user->GetRealHost());
+ params.push_back(user->GetIPString());
+ params.push_back(SSLIOHook::IsSSL(&user->eh) ? "S" : "P");
+
+ SendSASL(user, "*", 'H', params);
+ }
+
public:
-
- ModuleSASL(InspIRCd* Me)
- : Module(Me)
+ SaslAuthenticator(LocalUser* user_, const std::string& method)
+ : user(user_), state(SASL_INIT), state_announced(false)
{
- Implementation eventlist[] = { I_OnEvent, I_OnUserRegister };
- ServerInstance->Modules->Attach(eventlist, this, 2);
+ SendHostIP();
- sasl = new CommandAuthenticate(ServerInstance, this);
- ServerInstance->AddCommand(sasl);
+ std::vector<std::string> params;
+ params.push_back(method);
- if (!ServerInstance->Modules->Find("m_services_account.so") || !ServerInstance->Modules->Find("m_cap.so"))
- ServerInstance->Logs->Log("m_sasl", DEFAULT, "WARNING: m_services_account.so and m_cap.so are not loaded! m_sasl.so will NOT function correctly until these two modules are loaded!");
+ const std::string fp = SSLClientCert::GetFingerprint(&user->eh);
+ if (fp.size())
+ params.push_back(fp);
+
+ SendSASL(user, "*", 'S', params);
+ }
+
+ SaslResult GetSaslResult(const std::string &result_)
+ {
+ if (result_ == "F")
+ return SASL_FAIL;
+
+ if (result_ == "A")
+ return SASL_ABORT;
+
+ return SASL_OK;
}
- virtual int OnUserRegister(User *user)
+ /* checks for and deals with a state change. */
+ SaslState ProcessInboundMessage(const CommandBase::Params& msg)
{
- if (user->GetExt("sasl"))
+ switch (this->state)
{
- user->WriteServ("906 %s :SASL authentication aborted", user->nick);
- user->Shrink("sasl");
+ case SASL_INIT:
+ this->agent = msg[0];
+ this->state = SASL_COMM;
+ /* fall through */
+ case SASL_COMM:
+ if (msg[0] != this->agent)
+ return this->state;
+
+ if (msg.size() < 4)
+ return this->state;
+
+ if (msg[2] == "C")
+ this->user->Write("AUTHENTICATE %s", msg[3].c_str());
+ else if (msg[2] == "D")
+ {
+ this->state = SASL_DONE;
+ this->result = this->GetSaslResult(msg[3]);
+ }
+ else if (msg[2] == "M")
+ this->user->WriteNumeric(RPL_SASLMECHS, msg[3], "are available SASL mechanisms");
+ else
+ ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "Services sent an unknown SASL message \"%s\" \"%s\"", msg[2].c_str(), msg[3].c_str());
+
+ break;
+ case SASL_DONE:
+ break;
+ default:
+ ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WTF: SaslState is not a known state (%d)", this->state);
+ break;
}
- return 0;
+
+ return this->state;
}
- virtual ~ModuleSASL()
+ bool SendClientMessage(const std::vector<std::string>& parameters)
{
+ if (this->state != SASL_COMM)
+ return true;
+
+ SendSASL(this->user, this->agent, 'C', parameters);
+
+ if (parameters[0].c_str()[0] == '*')
+ {
+ this->state = SASL_DONE;
+ this->result = SASL_ABORT;
+ return false;
+ }
+
+ return true;
}
- virtual Version GetVersion()
+ void AnnounceState(void)
{
- return Version(1,2,0,1,VF_VENDOR,API_VERSION);
+ if (this->state_announced)
+ return;
+
+ switch (this->result)
+ {
+ case SASL_OK:
+ this->user->WriteNumeric(RPL_SASLSUCCESS, "SASL authentication successful");
+ break;
+ case SASL_ABORT:
+ this->user->WriteNumeric(ERR_SASLABORTED, "SASL authentication aborted");
+ break;
+ case SASL_FAIL:
+ this->user->WriteNumeric(ERR_SASLFAIL, "SASL authentication failed");
+ break;
+ default:
+ break;
+ }
+
+ this->state_announced = true;
}
+};
- virtual void OnEvent(Event *ev)
+class CommandAuthenticate : public SplitCommand
+{
+ private:
+ // The maximum length of an AUTHENTICATE request.
+ static const size_t MAX_AUTHENTICATE_SIZE = 400;
+
+ public:
+ SimpleExtItem<SaslAuthenticator>& authExt;
+ Cap::Capability& cap;
+ CommandAuthenticate(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext, Cap::Capability& Cap)
+ : SplitCommand(Creator, "AUTHENTICATE", 1)
+ , authExt(ext)
+ , cap(Cap)
{
- GenericCapHandler(ev, "sasl", "sasl");
+ works_before_reg = true;
+ allow_empty_last_param = false;
+ }
- if (ev->GetEventID() == "encap_received")
+ CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
+ {
{
- /* Received encap reply, look for AUTHENTICATE */
- std::deque<std::string>* parameters = (std::deque<std::string>*)ev->GetData();
+ if (!cap.get(user))
+ return CMD_FAILURE;
- User* target = ServerInstance->FindNick((*parameters)[0]);
+ if (parameters[0].find(' ') != std::string::npos || parameters[0][0] == ':')
+ return CMD_FAILURE;
- if (target)
+ if (parameters[0].length() > MAX_AUTHENTICATE_SIZE)
{
- /* Found a user */
- parameters->pop_front();
- std::string line = irc::stringjoiner(" ", *parameters, 0, parameters->size() - 1).GetJoined();
- target->WriteServ("AUTHENTICATE %s", line.c_str());
+ user->WriteNumeric(ERR_SASLTOOLONG, "SASL message too long");
+ return CMD_FAILURE;
}
- }
- else if (ev->GetEventID() == "account_login")
- {
- AccountData* ac = (AccountData*)ev->GetData();
- if (ac->user->GetExt("sasl"))
+ SaslAuthenticator *sasl = authExt.get(user);
+ if (!sasl)
+ authExt.set(user, new SaslAuthenticator(user, parameters[0]));
+ else if (sasl->SendClientMessage(parameters) == false) // IAL abort extension --nenolod
{
- ac->user->WriteServ("903 %s :SASL authentication successful", ac->user->nick);
- ac->user->Shrink("sasl");
+ sasl->AnnounceState();
+ authExt.unset(user);
}
}
+ return CMD_FAILURE;
+ }
+};
+
+class CommandSASL : public Command
+{
+ public:
+ SimpleExtItem<SaslAuthenticator>& authExt;
+ CommandSASL(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext) : Command(Creator, "SASL", 2), authExt(ext)
+ {
+ this->flags_needed = FLAG_SERVERONLY; // should not be called by users
+ }
+
+ CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
+ {
+ User* target = ServerInstance->FindUUID(parameters[1]);
+ if (!target)
+ {
+ ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "User not found in sasl ENCAP event: %s", parameters[1].c_str());
+ return CMD_FAILURE;
+ }
+
+ SaslAuthenticator *sasl = authExt.get(target);
+ if (!sasl)
+ return CMD_FAILURE;
+
+ SaslState state = sasl->ProcessInboundMessage(parameters);
+ if (state == SASL_DONE)
+ {
+ sasl->AnnounceState();
+ authExt.unset(target);
+ }
+ return CMD_SUCCESS;
+ }
+
+ RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
+ {
+ return ROUTE_BROADCAST;
+ }
+};
+
+class ModuleSASL : public Module
+{
+ SimpleExtItem<SaslAuthenticator> authExt;
+ ServerTracker servertracker;
+ SASLCap cap;
+ CommandAuthenticate auth;
+ CommandSASL sasl;
+ Events::ModuleEventProvider sasleventprov;
+
+ public:
+ ModuleSASL()
+ : authExt("sasl_auth", ExtensionItem::EXT_USER, this)
+ , servertracker(this)
+ , cap(this, servertracker)
+ , auth(this, authExt, cap)
+ , sasl(this, authExt)
+ , sasleventprov(this, "event/sasl")
+ {
+ saslevprov = &sasleventprov;
+ }
+
+ void init() CXX11_OVERRIDE
+ {
+ if (!ServerInstance->Modules->Find("m_services_account.so") || !ServerInstance->Modules->Find("m_cap.so"))
+ ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WARNING: m_services_account and m_cap are not loaded! m_sasl will NOT function correctly until these two modules are loaded!");
+ }
+
+ void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
+ {
+ std::string target = ServerInstance->Config->ConfValue("sasl")->getString("target");
+ if (target.empty())
+ throw ModuleException("<sasl:target> must be set to the name of your services server!");
+
+ sasl_target = target;
+ servertracker.Reset();
+ }
+
+ void OnDecodeMetaData(Extensible* target, const std::string& extname, const std::string& extdata) CXX11_OVERRIDE
+ {
+ if ((target == NULL) && (extname == "saslmechlist"))
+ cap.SetMechlist(extdata);
+ }
+
+ Version GetVersion() CXX11_OVERRIDE
+ {
+ return Version("Provides support for IRC Authentication Layer (aka: SASL) via AUTHENTICATE.", VF_VENDOR);
}
};
projects / user / henk / code / inspircd.git / blobdiff