]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_sasl.cpp
Use CommandBase::Params instead of std::vector<std::string>.
[user/henk/code/inspircd.git] / src / modules / m_sasl.cpp
index 639fe677863ece5a76dd5c39448393298cce6813..d37e1c90f8a0f93f3a50ddf891d627352b95c06d 100644 (file)
 #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 ServerEventListener
+{
+       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:
+       ServerTracker(Module* mod)
+               : ServerEventListener(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
 {
        std::string mechlist;
+       const ServerTracker& servertracker;
 
        bool OnRequest(LocalUser* user, bool adding) CXX11_OVERRIDE
        {
@@ -38,14 +111,20 @@ class SASLCap : public Cap::Capability
                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)
+       SASLCap(Module* mod, const ServerTracker& tracker)
                : Cap::Capability(mod, "sasl")
+               , servertracker(tracker)
        {
        }
 
@@ -62,11 +141,16 @@ class SASLCap : public Cap::Capability
 enum SaslState { SASL_INIT, SASL_COMM, SASL_DONE };
 enum SaslResult { SASL_OK, SASL_FAIL, SASL_ABORT };
 
-static std::string sasl_target = "*";
 static Events::ModuleEventProvider* saslevprov;
 
-static void SendSASL(const parameterlist& params)
+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));
@@ -80,31 +164,35 @@ class SaslAuthenticator
 {
  private:
        std::string agent;
-       User *user;
+       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:
-       SaslAuthenticator(User* user_, const std::string& method)
+       SaslAuthenticator(LocalUser* user_, const std::string& method)
                : user(user_), state(SASL_INIT), state_announced(false)
        {
-               parameterlist params;
-               params.push_back(user->uuid);
-               params.push_back("*");
-               params.push_back("S");
-               params.push_back(method);
+               SendHostIP();
 
-               LocalUser* localuser = IS_LOCAL(user);
-               if (method == "EXTERNAL" && localuser)
-               {
-                       std::string fp = SSLClientCert::GetFingerprint(&localuser->eh);
+               std::vector<std::string> params;
+               params.push_back(method);
 
-                       if (fp.size())
-                               params.push_back(fp);
-               }
+               const std::string fp = SSLClientCert::GetFingerprint(&user->eh);
+               if (fp.size())
+                       params.push_back(fp);
 
-               SendSASL(params);
+               SendSASL(user, "*", 'S', params);
        }
 
        SaslResult GetSaslResult(const std::string &result_)
@@ -119,7 +207,7 @@ class SaslAuthenticator
        }
 
        /* checks for and deals with a state change. */
-       SaslState ProcessInboundMessage(const std::vector<std::string> &msg)
+       SaslState ProcessInboundMessage(const CommandBase::Params& msg)
        {
                switch (this->state)
                {
@@ -142,7 +230,7 @@ class SaslAuthenticator
                                this->result = this->GetSaslResult(msg[3]);
                        }
                        else if (msg[2] == "M")
-                               this->user->WriteNumeric(908, msg[3], "are available SASL mechanisms");
+                               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());
 
@@ -157,29 +245,17 @@ class SaslAuthenticator
                return this->state;
        }
 
-       void Abort(void)
-       {
-               this->state = SASL_DONE;
-               this->result = SASL_ABORT;
-       }
-
        bool SendClientMessage(const std::vector<std::string>& parameters)
        {
                if (this->state != SASL_COMM)
                        return true;
 
-               parameterlist params;
-               params.push_back(this->user->uuid);
-               params.push_back(this->agent);
-               params.push_back("C");
-
-               params.insert(params.end(), parameters.begin(), parameters.end());
+               SendSASL(this->user, this->agent, 'C', parameters);
 
-               SendSASL(params);
-
-               if (parameters[0][0] == '*')
+               if (parameters[0].c_str()[0] == '*')
                {
-                       this->Abort();
+                       this->state = SASL_DONE;
+                       this->result = SASL_ABORT;
                        return false;
                }
 
@@ -194,13 +270,13 @@ class SaslAuthenticator
                switch (this->result)
                {
                 case SASL_OK:
-                       this->user->WriteNumeric(903, "SASL authentication successful");
+                       this->user->WriteNumeric(RPL_SASLSUCCESS, "SASL authentication successful");
                        break;
                 case SASL_ABORT:
-                       this->user->WriteNumeric(906, "SASL authentication aborted");
+                       this->user->WriteNumeric(ERR_SASLABORTED, "SASL authentication aborted");
                        break;
                 case SASL_FAIL:
-                       this->user->WriteNumeric(904, "SASL authentication failed");
+                       this->user->WriteNumeric(ERR_SASLFAIL, "SASL authentication failed");
                        break;
                 default:
                        break;
@@ -210,23 +286,39 @@ class SaslAuthenticator
        }
 };
 
-class CommandAuthenticate : public Command
+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)
-               : Command(Creator, "AUTHENTICATE", 1), authExt(ext), cap(Cap)
+               : SplitCommand(Creator, "AUTHENTICATE", 1)
+               , authExt(ext)
+               , cap(Cap)
        {
                works_before_reg = true;
+               allow_empty_last_param = false;
        }
 
-       CmdResult Handle (const std::vector<std::string>& parameters, User *user)
+       CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
        {
                {
                        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 = authExt.get(user);
                        if (!sasl)
                                authExt.set(user, new SaslAuthenticator(user, parameters[0]));
@@ -249,7 +341,7 @@ class CommandSASL : public Command
                this->flags_needed = FLAG_SERVERONLY; // should not be called by users
        }
 
-       CmdResult Handle(const std::vector<std::string>& parameters, User *user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                User* target = ServerInstance->FindUUID(parameters[1]);
                if (!target)
@@ -271,7 +363,7 @@ class CommandSASL : public Command
                return CMD_SUCCESS;
        }
 
-       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters)
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                return ROUTE_BROADCAST;
        }
@@ -280,6 +372,7 @@ class CommandSASL : public Command
 class ModuleSASL : public Module
 {
        SimpleExtItem<SaslAuthenticator> authExt;
+       ServerTracker servertracker;
        SASLCap cap;
        CommandAuthenticate auth;
        CommandSASL sasl;
@@ -288,7 +381,8 @@ class ModuleSASL : public Module
  public:
        ModuleSASL()
                : authExt("sasl_auth", ExtensionItem::EXT_USER, this)
-               , cap(this)
+               , servertracker(this)
+               , cap(this, servertracker)
                , auth(this, authExt, cap)
                , sasl(this, authExt)
                , sasleventprov(this, "event/sasl")
@@ -299,24 +393,17 @@ class ModuleSASL : public Module
        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.so and m_cap.so are not loaded! m_sasl.so will NOT function correctly until these two modules are loaded!");
+                       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
        {
-               sasl_target = ServerInstance->Config->ConfValue("sasl")->getString("target", "*");
-       }
-
-       ModResult OnUserRegister(LocalUser *user) CXX11_OVERRIDE
-       {
-               SaslAuthenticator *sasl_ = authExt.get(user);
-               if (sasl_)
-               {
-                       sasl_->Abort();
-                       authExt.unset(user);
-               }
+               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!");
 
-               return MOD_RES_PASSTHRU;
+               sasl_target = target;
+               servertracker.Reset();
        }
 
        void OnDecodeMetaData(Extensible* target, const std::string& extname, const std::string& extdata) CXX11_OVERRIDE