]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_sasl.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_sasl.cpp
index 2fc0725a98a4e1007fa7bef2d499d370b0c74844..57e605d61a0bcb59698a15caefb5ce4b7bc50a01 100644 (file)
@@ -1,8 +1,15 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2016 Adam <Adam@anope.org>
+ *   Copyright (C) 2014 Mantas Mikulėnas <grawity@gmail.com>
+ *   Copyright (C) 2013-2016, 2018 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2013 Daniel Vassdal <shutter@canternet.org>
+ *   Copyright (C) 2012, 2019 Robby <robby@chatbelgie.be>
  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
- *   Copyright (C) 2008 Craig Edwards <craigedwards@brainbox.cc>
+ *   Copyright (C) 2008, 2010 Craig Edwards <brain@inspircd.org>
+ *   Copyright (C) 2008 Thomas Stagner <aquanight@inspircd.org>
  *
  * 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
@@ -37,8 +44,12 @@ enum
 
 static std::string sasl_target;
 
-class ServerTracker : public ServerEventListener
+class ServerTracker
+       : public ServerProtocol::LinkEventListener
 {
+       // Stop GCC warnings about the deprecated OnServerSplit event.
+       using ServerProtocol::LinkEventListener::OnServerSplit;
+
        bool online;
 
        void Update(const Server* server, bool linked)
@@ -58,14 +69,14 @@ class ServerTracker : public ServerEventListener
                Update(server, true);
        }
 
-       void OnServerSplit(const Server* server) CXX11_OVERRIDE
+       void OnServerSplit(const Server* server, bool error) CXX11_OVERRIDE
        {
                Update(server, false);
        }
 
  public:
        ServerTracker(Module* mod)
-               : ServerEventListener(mod)
+               : ServerProtocol::LinkEventListener(mod)
        {
                Reset();
        }
@@ -98,21 +109,28 @@ class ServerTracker : public ServerEventListener
 
 class SASLCap : public Cap::Capability
 {
+ private:
        std::string mechlist;
        const ServerTracker& servertracker;
+       UserCertificateAPI sslapi;
 
        bool OnRequest(LocalUser* user, bool adding) CXX11_OVERRIDE
        {
-               // Requesting this cap is allowed anytime
-               if (adding)
-                       return true;
+               if (requiressl && sslapi && !sslapi->GetCertificate(user))
+                       return false;
 
-               // But removing it can only be done when unregistered
-               return (user->registered != REG_ALL);
+               // 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();
        }
 
@@ -122,9 +140,11 @@ class SASLCap : public Cap::Capability
        }
 
  public:
+       bool requiressl;
        SASLCap(Module* mod, const ServerTracker& tracker)
                : Cap::Capability(mod, "sasl")
                , servertracker(tracker)
+               , sslapi(mod)
        {
        }
 
@@ -143,9 +163,9 @@ enum SaslResult { SASL_OK, SASL_FAIL, SASL_ABORT };
 
 static Events::ModuleEventProvider* saslevprov;
 
-static void SendSASL(LocalUser* user, const std::string& agent, char mode, const parameterlist& parameters)
+static void SendSASL(LocalUser* user, const std::string& agent, char mode, const std::vector<std::string>& parameters)
 {
-       parameterlist params(parameters.size() + 3);
+       CommandBase::Params params;
        params.push_back(user->uuid);
        params.push_back(agent);
        params.push_back(ConvToStr(mode));
@@ -157,6 +177,8 @@ static void SendSASL(LocalUser* user, const std::string& agent, char mode, const
        }
 }
 
+static ClientProtocol::EventProvider* g_protoev;
+
 /**
  * Tracks SASL authentication state like charybdis does. --nenolod
  */
@@ -169,27 +191,29 @@ class SaslAuthenticator
        SaslResult result;
        bool state_announced;
 
-       void SendHostIP()
+       void SendHostIP(UserCertificateAPI& sslapi)
        {
-               parameterlist params;
+               std::vector<std::string> params;
                params.push_back(user->GetRealHost());
                params.push_back(user->GetIPString());
-               params.push_back(SSLIOHook::IsSSL(&user->eh) ? "S" : "P");
+               params.push_back(sslapi && sslapi->GetCertificate(user) ? "S" : "P");
 
                SendSASL(user, "*", 'H', params);
        }
 
  public:
-       SaslAuthenticator(LocalUser* user_, const std::string& method)
-               : 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)
        {
-               SendHostIP();
+               SendHostIP(sslapi);
 
-               parameterlist params;
+               std::vector<std::string> params;
                params.push_back(method);
 
-               const std::string fp = SSLClientCert::GetFingerprint(&user->eh);
-               if (fp.size())
+               const std::string fp = sslapi ? sslapi->GetFingerprint(user) : "";
+               if (!fp.empty())
                        params.push_back(fp);
 
                SendSASL(user, "*", 'S', params);
@@ -207,15 +231,15 @@ 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)
                {
-                case SASL_INIT:
+               case SASL_INIT:
                        this->agent = msg[0];
                        this->state = SASL_COMM;
                        /* fall through */
-                case SASL_COMM:
+               case SASL_COMM:
                        if (msg[0] != this->agent)
                                return this->state;
 
@@ -223,7 +247,15 @@ class SaslAuthenticator
                                return this->state;
 
                        if (msg[2] == "C")
-                               this->user->Write("AUTHENTICATE %s", msg[3].c_str());
+                       {
+                               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;
@@ -235,9 +267,9 @@ class SaslAuthenticator
                                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:
+               case SASL_DONE:
                        break;
-                default:
+               default:
                        ServerInstance->Logs->Log(MODNAME, LOG_DEFAULT, "WTF: SaslState is not a known state (%d)", this->state);
                        break;
                }
@@ -269,16 +301,16 @@ class SaslAuthenticator
 
                switch (this->result)
                {
-                case SASL_OK:
+               case SASL_OK:
                        this->user->WriteNumeric(RPL_SASLSUCCESS, "SASL authentication successful");
                        break;
-                case SASL_ABORT:
+               case SASL_ABORT:
                        this->user->WriteNumeric(ERR_SASLABORTED, "SASL authentication aborted");
                        break;
-                case SASL_FAIL:
+               case SASL_FAIL:
                        this->user->WriteNumeric(ERR_SASLFAIL, "SASL authentication failed");
                        break;
-                default:
+               default:
                        break;
                }
 
@@ -289,22 +321,25 @@ class SaslAuthenticator
 class CommandAuthenticate : public SplitCommand
 {
  private:
-        // The maximum length of an AUTHENTICATE request.
-        static const size_t MAX_AUTHENTICATE_SIZE = 400;
+       // The maximum length of an AUTHENTICATE request.
+       static const size_t MAX_AUTHENTICATE_SIZE = 400;
 
  public:
        SimpleExtItem<SaslAuthenticator>& authExt;
        Cap::Capability& cap;
+       UserCertificateAPI sslapi;
+
        CommandAuthenticate(Module* Creator, SimpleExtItem<SaslAuthenticator>& ext, Cap::Capability& Cap)
                : SplitCommand(Creator, "AUTHENTICATE", 1)
                , authExt(ext)
                , cap(Cap)
+               , sslapi(Creator)
        {
                works_before_reg = true;
                allow_empty_last_param = false;
        }
 
-       CmdResult HandleLocal(const std::vector<std::string>& parameters, LocalUser* user) CXX11_OVERRIDE
+       CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
        {
                {
                        if (!cap.get(user))
@@ -321,7 +356,7 @@ class CommandAuthenticate : public SplitCommand
 
                        SaslAuthenticator *sasl = authExt.get(user);
                        if (!sasl)
-                               authExt.set(user, new SaslAuthenticator(user, parameters[0]));
+                               authExt.set(user, new SaslAuthenticator(user, parameters[0], sslapi));
                        else if (sasl->SendClientMessage(parameters) == false)  // IAL abort extension --nenolod
                        {
                                sasl->AnnounceState();
@@ -341,7 +376,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) CXX11_OVERRIDE
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                User* target = ServerInstance->FindUUID(parameters[1]);
                if (!target)
@@ -363,7 +398,7 @@ class CommandSASL : public Command
                return CMD_SUCCESS;
        }
 
-       RouteDescriptor GetRouting(User* user, const std::vector<std::string>& parameters) CXX11_OVERRIDE
+       RouteDescriptor GetRouting(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                return ROUTE_BROADCAST;
        }
@@ -377,6 +412,7 @@ class ModuleSASL : public Module
        CommandAuthenticate auth;
        CommandSASL sasl;
        Events::ModuleEventProvider sasleventprov;
+       ClientProtocol::EventProvider protoev;
 
  public:
        ModuleSASL()
@@ -386,8 +422,10 @@ class ModuleSASL : public Module
                , auth(this, authExt, cap)
                , sasl(this, authExt)
                , sasleventprov(this, "event/sasl")
+               , protoev(this, auth.name)
        {
                saslevprov = &sasleventprov;
+               g_protoev = &protoev;
        }
 
        void init() CXX11_OVERRIDE
@@ -398,10 +436,13 @@ class ModuleSASL : public Module
 
        void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
        {
-               std::string target = ServerInstance->Config->ConfValue("sasl")->getString("target");
+               ConfigTag* tag = ServerInstance->Config->ConfValue("sasl");
+
+               const std::string target = tag->getString("target");
                if (target.empty())
                        throw ModuleException("<sasl:target> must be set to the name of your services server!");
 
+               cap.requiressl = tag->getBool("requiressl");
                sasl_target = target;
                servertracker.Reset();
        }
@@ -414,7 +455,7 @@ class ModuleSASL : public Module
 
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("Provides support for IRC Authentication Layer (aka: SASL) via AUTHENTICATE.", VF_VENDOR);
+               return Version("Provides the IRCv3 sasl client capability.", VF_VENDOR);
        }
 };