X-Git-Url: https://git.netwichtig.de/gitweb/?a=blobdiff_plain;f=src%2Fmodules%2Fm_sasl.cpp;h=6aaa83f3371abf10cbc6392aec7bb9cf59f9677c;hb=f3f2388a81b6463e1229fa5bf2b8c427440bf406;hp=08f1363741fa8ab4e3509d68dfb8428b87de6fd7;hpb=f25c4b7a2263f5f3ce9bb41ba56b43c0d3a6d124;p=user%2Fhenk%2Fcode%2Finspircd.git diff --git a/src/modules/m_sasl.cpp b/src/modules/m_sasl.cpp index 08f136374..6aaa83f33 100644 --- a/src/modules/m_sasl.cpp +++ b/src/modules/m_sasl.cpp @@ -1,54 +1,222 @@ -/* +------------------------------------+ - * | Inspire Internet Relay Chat Daemon | - * +------------------------------------+ +/* + * InspIRCd -- Internet Relay Chat Daemon * - * InspIRCd: (C) 2002-2009 InspIRCd Development Team - * See: http://wiki.inspircd.org/Credits + * Copyright (C) 2016 Adam + * Copyright (C) 2014 Mantas Mikulėnas + * Copyright (C) 2013-2016, 2018 Attila Molnar + * Copyright (C) 2013, 2017-2020 Sadie Powell + * Copyright (C) 2013 Daniel Vassdal + * Copyright (C) 2012, 2019 Robby + * Copyright (C) 2009-2010 Daniel De Graaf + * Copyright (C) 2008, 2010 Craig Edwards + * Copyright (C) 2008 Thomas Stagner * - * 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 . */ + #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 +}; + +static std::string sasl_target; + +class ServerTracker + : public ServerProtocol::LinkEventListener +{ + // Stop GCC warnings about the deprecated OnServerSplit event. + using ServerProtocol::LinkEventListener::OnServerSplit; + + bool online; -/* $ModDesc: Provides support for IRC Authentication Layer (aka: atheme SASL) via AUTHENTICATE. */ + 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, bool error) CXX11_OVERRIDE + { + Update(server, false); + } + + public: + ServerTracker(Module* mod) + : ServerProtocol::LinkEventListener(mod) + { + Reset(); + } + + void Reset() + { + if (sasl_target == "*") + { + online = true; + return; + } + + online = false; + + 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; + } + } + } + + bool IsOnline() const { return online; } +}; + +class SASLCap : public Cap::Capability +{ + private: + std::string mechlist; + const ServerTracker& servertracker; + UserCertificateAPI sslapi; + + bool OnRequest(LocalUser* user, bool adding) CXX11_OVERRIDE + { + if (requiressl && sslapi && !sslapi->GetCertificate(user)) + return false; + + // Servers MUST NAK any sasl capability request if the authentication layer + // is unavailable. + return servertracker.IsOnline(); + } + + bool OnList(LocalUser* user) CXX11_OVERRIDE + { + if (requiressl && sslapi && !sslapi->GetCertificate(user)) + return false; + + // Servers MUST NOT advertise the sasl capability if the authentication layer + // is unavailable. + return servertracker.IsOnline(); + } + + const std::string* GetValue(LocalUser* user) const CXX11_OVERRIDE + { + return &mechlist; + } + + public: + bool requiressl; + SASLCap(Module* mod, const ServerTracker& tracker) + : Cap::Capability(mod, "sasl") + , servertracker(tracker) + , sslapi(mod) + { + } + + 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& parameters) +{ + CommandBase::Params params; + 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)); + } +} + +static ClientProtocol::EventProvider* g_protoev; + /** * Tracks SASL authentication state like charybdis does. --nenolod */ -class SaslAuthenticator : public classbase +class SaslAuthenticator { private: - InspIRCd *ServerInstance; - Module *Creator; std::string agent; - User *user; + LocalUser* user; SaslState state; SaslResult result; bool state_announced; + void SendHostIP(UserCertificateAPI& sslapi) + { + std::vector params; + params.push_back(user->GetRealHost()); + params.push_back(user->GetIPString()); + params.push_back(sslapi && sslapi->GetCertificate(user) ? "S" : "P"); + + SendSASL(user, "*", 'H', params); + } + public: - SaslAuthenticator(User *user_, std::string method, InspIRCd *instance, Module *ctor) - : ServerInstance(instance), Creator(ctor), user(user_), state(SASL_INIT), state_announced(false) + SaslAuthenticator(LocalUser* user_, const std::string& method, UserCertificateAPI& sslapi) + : user(user_) + , state(SASL_INIT) + , state_announced(false) { - this->user->Extend("sasl_authenticator", this); - - parameterlist params; - params.push_back("*"); - params.push_back("SASL"); - params.push_back(user->uuid); - params.push_back("*"); - params.push_back("S"); + SendHostIP(sslapi); + + std::vector params; params.push_back(method); - ServerInstance->PI->SendEncapsulatedData(params); + const std::string fp = sslapi ? sslapi->GetFingerprint(user) : ""; + if (fp.size()) + params.push_back(fp); + + SendSASL(user, "*", 'S', params); } SaslResult GetSaslResult(const std::string &result_) @@ -63,63 +231,63 @@ class SaslAuthenticator : public classbase } /* checks for and deals with a state change. */ - SaslState ProcessInboundMessage(const std::vector &msg) + SaslState ProcessInboundMessage(const CommandBase::Params& msg) { switch (this->state) { case SASL_INIT: this->agent = msg[0]; - this->user->Write("AUTHENTICATE %s", msg[3].c_str()); this->state = SASL_COMM; - break; + /* fall through */ case SASL_COMM: if (msg[0] != this->agent) return this->state; - if (msg[2] != "D") - this->user->Write("AUTHENTICATE %s", msg[3].c_str()); - else + if (msg.size() < 4) + return this->state; + + if (msg[2] == "C") + { + ClientProtocol::Message authmsg("AUTHENTICATE"); + authmsg.PushParamRef(msg[3]); + + ClientProtocol::Event authevent(*g_protoev, authmsg); + LocalUser* const localuser = IS_LOCAL(user); + if (localuser) + localuser->Send(authevent); + } + 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("m_sasl", DEFAULT, "WTF: SaslState is not a known state (%d)", this->state); + ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WTF: SaslState is not a known state (%d)", this->state); break; } return this->state; } - void Abort(void) - { - this->state = SASL_DONE; - this->result = SASL_ABORT; - } - bool SendClientMessage(const std::vector& parameters) { if (this->state != SASL_COMM) return true; - parameterlist params; - params.push_back("*"); - params.push_back("SASL"); - params.push_back(this->user->uuid); - params.push_back(this->agent); - params.push_back("C"); + SendSASL(this->user, this->agent, 'C', parameters); - params.insert(params.end(), parameters.begin(), parameters.end()); - - ServerInstance->PI->SendEncapsulatedData(params); - - if (parameters[0][0] == '*') + if (parameters[0].c_str()[0] == '*') { - this->Abort(); + this->state = SASL_DONE; + this->result = SASL_ABORT; return false; } @@ -134,13 +302,13 @@ class SaslAuthenticator : public classbase switch (this->result) { case SASL_OK: - this->user->WriteNumeric(903, "%s :SASL authentication successful", this->user->nick.c_str()); + this->user->WriteNumeric(RPL_SASLSUCCESS, "SASL authentication successful"); break; - case SASL_ABORT: - this->user->WriteNumeric(906, "%s :SASL authentication aborted", this->user->nick.c_str()); + case SASL_ABORT: + this->user->WriteNumeric(ERR_SASLABORTED, "SASL authentication aborted"); break; case SASL_FAIL: - this->user->WriteNumeric(904, "%s :SASL authentication failed", this->user->nick.c_str()); + this->user->WriteNumeric(ERR_SASLFAIL, "SASL authentication failed"); break; default: break; @@ -148,36 +316,52 @@ class SaslAuthenticator : public classbase this->state_announced = true; } - - ~SaslAuthenticator() - { - this->user->Shrink("sasl_authenticator"); - this->AnnounceState(); - } }; -class CommandAuthenticate : public Command +class CommandAuthenticate : public SplitCommand { - Module* Creator; + private: + // The maximum length of an AUTHENTICATE request. + static const size_t MAX_AUTHENTICATE_SIZE = 400; + public: - CommandAuthenticate (InspIRCd* Instance, Module* creator) : Command(Instance,"AUTHENTICATE", 0, 1, true), Creator(creator) + SimpleExtItem& authExt; + Cap::Capability& cap; + UserCertificateAPI sslapi; + + CommandAuthenticate(Module* Creator, SimpleExtItem& ext, Cap::Capability& Cap) + : SplitCommand(Creator, "AUTHENTICATE", 1) + , authExt(ext) + , cap(Cap) + , sslapi(Creator) { - this->source = "m_sasl.so"; + works_before_reg = true; + allow_empty_last_param = false; } - CmdResult Handle (const std::vector& parameters, User *user) + CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE { - /* Only allow AUTHENTICATE on unregistered clients */ - if (user->registered != REG_ALL) { - if (!user->GetExt("sasl")) + if (!cap.get(user)) + return CMD_FAILURE; + + if (parameters[0].find(' ') != std::string::npos || parameters[0][0] == ':') + return CMD_FAILURE; + + if (parameters[0].length() > MAX_AUTHENTICATE_SIZE) + { + user->WriteNumeric(ERR_SASLTOOLONG, "SASL message too long"); return CMD_FAILURE; + } - SaslAuthenticator *sasl; - if (!(user->GetExt("sasl_authenticator", sasl))) - sasl = new SaslAuthenticator(user, parameters[0], ServerInstance, Creator); + SaslAuthenticator *sasl = authExt.get(user); + if (!sasl) + authExt.set(user, new SaslAuthenticator(user, parameters[0], sslapi)); else if (sasl->SendClientMessage(parameters) == false) // IAL abort extension --nenolod - delete sasl; + { + sasl->AnnounceState(); + authExt.unset(user); + } } return CMD_FAILURE; } @@ -185,110 +369,93 @@ class CommandAuthenticate : public Command class CommandSASL : public Command { - Module* Creator; public: - CommandSASL(InspIRCd* Instance, Module* creator) : Command(Instance, "SASL", 0, 2), Creator(creator) + SimpleExtItem& authExt; + CommandSASL(Module* Creator, SimpleExtItem& ext) : Command(Creator, "SASL", 2), authExt(ext) { - this->source = "m_sasl.so"; - this->disabled = true; // should not be called by users + this->flags_needed = FLAG_SERVERONLY; // should not be called by users } - CmdResult Handle(const std::vector& parameters, User *user) + CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE { - User* target = ServerInstance->FindNick(parameters[1]); + User* target = ServerInstance->FindUUID(parameters[1]); if (!target) { - ServerInstance->Logs->Log("m_sasl", DEBUG,"User not found in sasl ENCAP event: %s", parameters[1].c_str()); + ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "User not found in sasl ENCAP event: %s", parameters[1].c_str()); return CMD_FAILURE; } - SaslAuthenticator *sasl; - if (!target->GetExt("sasl_authenticator", sasl)) + SaslAuthenticator *sasl = authExt.get(target); + if (!sasl) return CMD_FAILURE; SaslState state = sasl->ProcessInboundMessage(parameters); if (state == SASL_DONE) { - delete sasl; - target->Shrink("sasl"); + 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 authExt; + ServerTracker servertracker; + SASLCap cap; CommandAuthenticate auth; CommandSASL sasl; - public: - - ModuleSASL(InspIRCd* Me) - : Module(Me), auth(Me, this), sasl(Me, this) - { - Implementation eventlist[] = { I_OnEvent, I_OnUserRegister, I_OnPostConnect, I_OnUserDisconnect, I_OnCleanup }; - ServerInstance->Modules->Attach(eventlist, this, 5); - - ServerInstance->AddCommand(&auth); - ServerInstance->AddCommand(&sasl); - - 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!"); - } - - virtual int OnUserRegister(User *user) - { - SaslAuthenticator *sasl_; - if (user->GetExt("sasl_authenticator", sasl_)) - { - sasl_->Abort(); - delete sasl_; - user->Shrink("sasl_authenticator"); - } - - return 0; - } + Events::ModuleEventProvider sasleventprov; + ClientProtocol::EventProvider protoev; - virtual void OnCleanup(int target_type, void *item) + 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") + , protoev(this, auth.name) { - if (target_type == TYPE_USER) - OnUserDisconnect((User*)item); + saslevprov = &sasleventprov; + g_protoev = &protoev; } - virtual void OnUserDisconnect(User *user) + void init() CXX11_OVERRIDE { - SaslAuthenticator *sasl_; - if (user->GetExt("sasl_authenticator", sasl_)) - { - delete sasl_; - user->Shrink("sasl_authenticator"); - } + 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!"); } - virtual void OnPostConnect(User* user) + void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE { - if (!IS_LOCAL(user)) - return; + ConfigTag* tag = ServerInstance->Config->ConfValue("sasl"); - std::string* str = NULL; + const std::string target = tag->getString("target"); + if (target.empty()) + throw ModuleException(" must be set to the name of your services server!"); - if (user->GetExt("accountname", str)) - ServerInstance->PI->SendMetaData(user, "accountname", *str); - - return; - } - - virtual ~ModuleSASL() - { + cap.requiressl = tag->getBool("requiressl"); + sasl_target = target; + servertracker.Reset(); } - virtual Version GetVersion() + void OnDecodeMetaData(Extensible* target, const std::string& extname, const std::string& extdata) CXX11_OVERRIDE { - return Version("$Id$",VF_VENDOR,API_VERSION); + if ((target == NULL) && (extname == "saslmechlist")) + cap.SetMechlist(extdata); } - virtual void OnEvent(Event *ev) + Version GetVersion() CXX11_OVERRIDE { - GenericCapHandler(ev, "sasl", "sasl"); + return Version("Provides the IRCv3 sasl client capability.", VF_VENDOR); } };