]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_sslinfo.cpp
Sync helpop chmodes s and p with docs
[user/henk/code/inspircd.git] / src / modules / m_sslinfo.cpp
index 85e7b77dd3f560ddbefdd02d3f232cf0e6a47731..ae3d2b7b63ce1cd3f467beafb91eadbfb517aabb 100644 (file)
@@ -1,7 +1,15 @@
 /*
  * InspIRCd -- Internet Relay Chat Daemon
  *
+ *   Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
+ *   Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
+ *   Copyright (C) 2013, 2017-2021 Sadie Powell <sadie@witchery.services>
+ *   Copyright (C) 2012-2016 Attila Molnar <attilamolnar@hush.com>
+ *   Copyright (C) 2012 Robby <robby@chatbelgie.be>
+ *   Copyright (C) 2010 Adam <Adam@anope.org>
  *   Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
+ *   Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
+ *   Copyright (C) 2006-2007, 2009-2010 Craig Edwards <brain@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
@@ -19,7 +27,9 @@
 
 #include "inspircd.h"
 #include "modules/ssl.h"
+#include "modules/webirc.h"
 #include "modules/whois.h"
+#include "modules/who.h"
 
 enum
 {
@@ -30,7 +40,8 @@ enum
        RPL_WHOISSECURE = 671
 };
 
-class SSLCertExt : public ExtensionItem {
+class SSLCertExt : public ExtensionItem
+{
  public:
        SSLCertExt(Module* parent)
                : ExtensionItem("ssl_cert", ExtensionItem::EXT_USER, parent)
@@ -41,6 +52,7 @@ class SSLCertExt : public ExtensionItem {
        {
                return static_cast<ssl_cert*>(get_raw(item));
        }
+
        void set(Extensible* item, ssl_cert* value)
        {
                value->refcount_inc();
@@ -49,12 +61,17 @@ class SSLCertExt : public ExtensionItem {
                        delete old;
        }
 
-       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const CXX11_OVERRIDE
+       void unset(Extensible* container)
+       {
+               free(container, unset_raw(container));
+       }
+
+       std::string ToNetwork(const Extensible* container, void* item) const CXX11_OVERRIDE
        {
                return static_cast<ssl_cert*>(item)->GetMetaLine();
        }
 
-       void unserialize(SerializeFormat format, Extensible* container, const std::string& value) CXX11_OVERRIDE
+       void FromNetwork(Extensible* container, const std::string& value) CXX11_OVERRIDE
        {
                ssl_cert* cert = new ssl_cert;
                set(container, cert);
@@ -79,7 +96,7 @@ class SSLCertExt : public ExtensionItem {
                }
        }
 
-       void free(void* item) CXX11_OVERRIDE
+       void free(Extensible* container, void* item) CXX11_OVERRIDE
        {
                ssl_cert* old = static_cast<ssl_cert*>(item);
                if (old && old->refcount_dec())
@@ -87,99 +104,213 @@ class SSLCertExt : public ExtensionItem {
        }
 };
 
-/** Handle /SSLINFO
- */
-class CommandSSLInfo : public Command
+class UserCertificateAPIImpl : public UserCertificateAPIBase
 {
  public:
-       SSLCertExt CertExt;
+       LocalIntExt nosslext;
+       SSLCertExt sslext;
 
-       CommandSSLInfo(Module* Creator) : Command(Creator, "SSLINFO", 1), CertExt(Creator)
+       UserCertificateAPIImpl(Module* mod)
+               : UserCertificateAPIBase(mod)
+               , nosslext("no_ssl_cert", ExtensionItem::EXT_USER, mod)
+               , sslext(mod)
        {
-               this->syntax = "<nick>";
        }
 
-       CmdResult Handle(const std::vector<std::string>& parameters, User* user) CXX11_OVERRIDE
+       ssl_cert* GetCertificate(User* user) CXX11_OVERRIDE
        {
-               User* target = ServerInstance->FindNickOnly(parameters[0]);
+               ssl_cert* cert = sslext.get(user);
+               if (cert)
+                       return cert;
+
+               LocalUser* luser = IS_LOCAL(user);
+               if (!luser || nosslext.get(luser))
+                       return NULL;
+
+               cert = SSLClientCert::GetCertificate(&luser->eh);
+               if (!cert)
+                       return NULL;
+
+               SetCertificate(user, cert);
+               return cert;
+       }
 
-               if ((!target) || (target->registered != REG_ALL))
+       void SetCertificate(User* user, ssl_cert* cert) CXX11_OVERRIDE
+       {
+               ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Setting TLS (SSL) client certificate for %s: %s",
+                       user->GetFullHost().c_str(), cert->GetMetaLine().c_str());
+               sslext.set(user, cert);
+       }
+};
+
+class CommandSSLInfo : public SplitCommand
+{
+ private:
+       ChanModeReference sslonlymode;
+
+       void HandleUserInternal(LocalUser* source, User* target, bool verbose)
+       {
+               ssl_cert* cert = sslapi.GetCertificate(target);
+               if (!cert)
+               {
+                       source->WriteNotice(InspIRCd::Format("*** %s is not connected using TLS (SSL).", target->nick.c_str()));
+               }
+               else if (cert->GetError().length())
                {
-                       user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
+                       source->WriteNotice(InspIRCd::Format("*** %s is connected using TLS (SSL) but has not specified a valid client certificate (%s).",
+                               target->nick.c_str(), cert->GetError().c_str()));
+               }
+               else if (!verbose)
+               {
+                       source->WriteNotice(InspIRCd::Format("*** %s is connected using TLS (SSL) with a valid client certificate (%s).",
+                               target->nick.c_str(), cert->GetFingerprint().c_str()));
+               }
+               else
+               {
+                       source->WriteNotice("*** Distinguished Name: " + cert->GetDN());
+                       source->WriteNotice("*** Issuer:             " + cert->GetIssuer());
+                       source->WriteNotice("*** Key Fingerprint:    " + cert->GetFingerprint());
+               }
+       }
+
+       CmdResult HandleUser(LocalUser* source, const std::string& nick)
+       {
+               User* target = ServerInstance->FindNickOnly(nick);
+               if (!target || target->registered != REG_ALL)
+               {
+                       source->WriteNumeric(Numerics::NoSuchNick(nick));
                        return CMD_FAILURE;
                }
-               bool operonlyfp = ServerInstance->Config->ConfValue("sslinfo")->getBool("operonly");
-               if (operonlyfp && !user->IsOper() && target != user)
+
+               if (operonlyfp && !source->IsOper() && source != target)
                {
-                       user->WriteNotice("*** You cannot view SSL certificate information for other users");
+                       source->WriteNumeric(ERR_NOPRIVILEGES, "You must be a server operator to view TLS (SSL) client certificate information for other users.");
                        return CMD_FAILURE;
                }
-               ssl_cert* cert = CertExt.get(target);
-               if (!cert)
+
+               HandleUserInternal(source, target, true);
+               return CMD_SUCCESS;
+       }
+
+       CmdResult HandleChannel(LocalUser* source, const std::string& channel)
+       {
+               Channel* chan = ServerInstance->FindChan(channel);
+               if (!chan)
                {
-                       user->WriteNotice("*** No SSL certificate for this user");
+                       source->WriteNumeric(Numerics::NoSuchChannel(channel));
+                       return CMD_FAILURE;
                }
-               else if (cert->GetError().length())
+
+               if (operonlyfp && !source->IsOper())
                {
-                       user->WriteNotice("*** No SSL certificate information for this user (" + cert->GetError() + ").");
+                       source->WriteNumeric(ERR_NOPRIVILEGES, "You must be a server operator to view TLS (SSL) client certificate information for channels.");
+                       return CMD_FAILURE;
                }
-               else
+
+               if (!source->IsOper() && chan->GetPrefixValue(source) < OP_VALUE)
+               {
+                       source->WriteNumeric(ERR_CHANOPRIVSNEEDED, chan->name, "You must be a channel operator.");
+                       return CMD_FAILURE;
+               }
+
+               if (sslonlymode)
                {
-                       user->WriteNotice("*** Distinguished Name: " + cert->GetDN());
-                       user->WriteNotice("*** Issuer:             " + cert->GetIssuer());
-                       user->WriteNotice("*** Key Fingerprint:    " + cert->GetFingerprint());
+                       source->WriteNotice(InspIRCd::Format("*** %s %s have channel mode +%c (%s) set.",
+                               chan->name.c_str(), chan->IsModeSet(sslonlymode) ? "does" : "does not",
+                               sslonlymode->GetModeChar(), sslonlymode->name.c_str()));
                }
+
+               const Channel::MemberMap& userlist = chan->GetUsers();
+               for (Channel::MemberMap::const_iterator i = userlist.begin(); i != userlist.end(); ++i)
+               {
+                       if (!i->first->server->IsULine())
+                               HandleUserInternal(source, i->first, false);
+               }
+
                return CMD_SUCCESS;
        }
-};
-
-class UserCertificateAPIImpl : public UserCertificateAPIBase
-{
-       SSLCertExt& ext;
 
  public:
-       UserCertificateAPIImpl(Module* mod, SSLCertExt& certext)
-               : UserCertificateAPIBase(mod), ext(certext)
+       UserCertificateAPIImpl sslapi;
+       bool operonlyfp;
+
+       CommandSSLInfo(Module* Creator)
+               : SplitCommand(Creator, "SSLINFO", 1)
+               , sslonlymode(Creator, "sslonly")
+               , sslapi(Creator)
        {
+               allow_empty_last_param = false;
+               syntax = "<channel|nick>";
        }
 
-       ssl_cert* GetCertificate(User* user) CXX11_OVERRIDE
-       {
-               return ext.get(user);
-       }
+       CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
+       {
+               if (ServerInstance->IsChannel(parameters[0]))
+                       return HandleChannel(user, parameters[0]);
+               else
+                       return HandleUser(user, parameters[0]);
+       }
 };
 
-class ModuleSSLInfo : public Module, public Whois::EventListener
+class ModuleSSLInfo
+       : public Module
+       , public WebIRC::EventListener
+       , public Whois::EventListener
+       , public Who::EventListener
 {
+ private:
        CommandSSLInfo cmd;
-       UserCertificateAPIImpl APIImpl;
+
+       bool MatchFP(ssl_cert* const cert, const std::string& fp) const
+       {
+               return irc::spacesepstream(fp).Contains(cert->GetFingerprint());
+       }
 
  public:
        ModuleSSLInfo()
-               : Whois::EventListener(this)
+               : WebIRC::EventListener(this)
+               , Whois::EventListener(this)
+               , Who::EventListener(this)
                , cmd(this)
-               , APIImpl(this, cmd.CertExt)
        {
        }
 
+       void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
+       {
+               ConfigTag* tag = ServerInstance->Config->ConfValue("sslinfo");
+               cmd.operonlyfp = tag->getBool("operonly");
+       }
+
        Version GetVersion() CXX11_OVERRIDE
        {
-               return Version("SSL Certificate Utilities", VF_VENDOR);
+               return Version("Adds user facing TLS (SSL) information, various TLS (SSL) configuration options, and the /SSLINFO command to look up TLS (SSL) certificate information for other users.", VF_VENDOR);
        }
 
        void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
        {
-               ssl_cert* cert = cmd.CertExt.get(whois.GetTarget());
+               ssl_cert* cert = cmd.sslapi.GetCertificate(whois.GetTarget());
                if (cert)
                {
                        whois.SendLine(RPL_WHOISSECURE, "is using a secure connection");
-                       bool operonlyfp = ServerInstance->Config->ConfValue("sslinfo")->getBool("operonly");
-                       if ((!operonlyfp || whois.IsSelfWhois() || whois.GetSource()->IsOper()) && !cert->fingerprint.empty())
-                               whois.SendLine(RPL_WHOISCERTFP, InspIRCd::Format("has client certificate fingerprint %s", cert->fingerprint.c_str()));
+                       if ((!cmd.operonlyfp || whois.IsSelfWhois() || whois.GetSource()->IsOper()) && !cert->fingerprint.empty())
+                               whois.SendLine(RPL_WHOISCERTFP, InspIRCd::Format("has TLS (SSL) client certificate fingerprint %s", cert->fingerprint.c_str()));
                }
        }
 
-       ModResult OnPreCommand(std::string &command, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line) CXX11_OVERRIDE
+       ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) CXX11_OVERRIDE
+       {
+               size_t flag_index;
+               if (!request.GetFieldIndex('f', flag_index))
+                       return MOD_RES_PASSTHRU;
+
+               ssl_cert* cert = cmd.sslapi.GetCertificate(user);
+               if (cert)
+                       numeric.GetParams()[flag_index].push_back('s');
+
+               return MOD_RES_PASSTHRU;
+       }
+
+       ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
        {
                if ((command == "OPER") && (validated))
                {
@@ -187,20 +318,22 @@ class ModuleSSLInfo : public Module, public Whois::EventListener
                        if (i != ServerInstance->Config->oper_blocks.end())
                        {
                                OperInfo* ifo = i->second;
-                               ssl_cert* cert = cmd.CertExt.get(user);
+                               ssl_cert* cert = cmd.sslapi.GetCertificate(user);
 
                                if (ifo->oper_block->getBool("sslonly") && !cert)
                                {
-                                       user->WriteNumeric(ERR_NOOPERHOST, "This oper login requires an SSL connection.");
+                                       user->WriteNumeric(ERR_NOOPERHOST, "Invalid oper credentials");
                                        user->CommandFloodPenalty += 10000;
+                                       ServerInstance->SNO->WriteGlobalSno('o', "WARNING! Failed oper attempt by %s using login '%s': a secure connection is required.", user->GetFullRealHost().c_str(), parameters[0].c_str());
                                        return MOD_RES_DENY;
                                }
 
                                std::string fingerprint;
-                               if (ifo->oper_block->readString("fingerprint", fingerprint) && (!cert || cert->GetFingerprint() != fingerprint))
+                               if (ifo->oper_block->readString("fingerprint", fingerprint) && (!cert || !MatchFP(cert, fingerprint)))
                                {
-                                       user->WriteNumeric(ERR_NOOPERHOST, "This oper login requires a matching SSL certificate fingerprint.");
+                                       user->WriteNumeric(ERR_NOOPERHOST, "Invalid oper credentials");
                                        user->CommandFloodPenalty += 10000;
+                                       ServerInstance->SNO->WriteGlobalSno('o', "WARNING! Failed oper attempt by %s using login '%s': their TLS (SSL) client certificate fingerprint does not match.", user->GetFullRealHost().c_str(), parameters[0].c_str());
                                        return MOD_RES_DENY;
                                }
                        }
@@ -210,13 +343,6 @@ class ModuleSSLInfo : public Module, public Whois::EventListener
                return MOD_RES_PASSTHRU;
        }
 
-       void OnUserConnect(LocalUser* user) CXX11_OVERRIDE
-       {
-               ssl_cert* cert = SSLClientCert::GetCertificate(&user->eh);
-               if (cert)
-                       cmd.CertExt.set(user, cert);
-       }
-
        void OnPostConnect(User* user) CXX11_OVERRIDE
        {
                LocalUser* const localuser = IS_LOCAL(user);
@@ -224,54 +350,91 @@ class ModuleSSLInfo : public Module, public Whois::EventListener
                        return;
 
                const SSLIOHook* const ssliohook = SSLIOHook::IsSSL(&localuser->eh);
-               if (!ssliohook)
+               if (!ssliohook || cmd.sslapi.nosslext.get(localuser))
                        return;
 
                ssl_cert* const cert = ssliohook->GetCertificate();
 
-               {
-                       std::string text = "*** You are connected to ";
-                       if (!ssliohook->GetServerName(text))
-                               text.append(ServerInstance->Config->ServerName);
-                       text.append(" using SSL cipher '");
-                       ssliohook->GetCiphersuite(text);
-                       text.push_back('\'');
-                       if ((cert) && (!cert->GetFingerprint().empty()))
-                               text.append(" and your SSL certificate fingerprint is ").append(cert->GetFingerprint());
-                       user->WriteNotice(text);
-               }
+               std::string text = "*** You are connected to ";
+               if (!ssliohook->GetServerName(text))
+                       text.append(ServerInstance->Config->GetServerName());
+               text.append(" using TLS (SSL) cipher '");
+               ssliohook->GetCiphersuite(text);
+               text.push_back('\'');
+               if (cert && !cert->GetFingerprint().empty())
+                       text.append(" and your TLS (SSL) client certificate fingerprint is ").append(cert->GetFingerprint());
+               user->WriteNotice(text);
 
                if (!cert)
                        return;
-               // find an auto-oper block for this user
+
+               // Find an auto-oper block for this user
                for (ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.begin(); i != ServerInstance->Config->oper_blocks.end(); ++i)
                {
                        OperInfo* ifo = i->second;
                        std::string fp = ifo->oper_block->getString("fingerprint");
-                       if (fp == cert->fingerprint && ifo->oper_block->getBool("autologin"))
+                       if (MatchFP(cert, fp) && ifo->oper_block->getBool("autologin"))
                                user->Oper(ifo);
                }
        }
 
        ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
        {
-               ssl_cert* cert = SSLClientCert::GetCertificate(&user->eh);
-               bool ok = true;
-               if (myclass->config->getString("requiressl") == "trusted")
+               ssl_cert* cert = cmd.sslapi.GetCertificate(user);
+               const char* error = NULL;
+               const std::string requiressl = myclass->config->getString("requiressl");
+               if (stdalgo::string::equalsci(requiressl, "trusted"))
                {
-                       ok = (cert && cert->IsCAVerified());
-                       ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class requires a trusted SSL cert. Client %s one.", (ok ? "has" : "does not have"));
+                       if (!cert || !cert->IsCAVerified())
+                               error = "a trusted TLS (SSL) client certificate";
                }
                else if (myclass->config->getBool("requiressl"))
                {
-                       ok = (cert != NULL);
-                       ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class requires any SSL cert. Client %s one.", (ok ? "has" : "does not have"));
+                       if (!cert)
+                               error = "a TLS (SSL) connection";
                }
 
-               if (!ok)
+               if (error)
+               {
+                       ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as it requires %s",
+                               myclass->GetName().c_str(), error);
                        return MOD_RES_DENY;
+               }
+
                return MOD_RES_PASSTHRU;
        }
+
+       void OnWebIRCAuth(LocalUser* user, const WebIRC::FlagMap* flags) CXX11_OVERRIDE
+       {
+               // We are only interested in connection flags. If none have been
+               // given then we have nothing to do.
+               if (!flags)
+                       return;
+
+               // We only care about the tls connection flag if the connection
+               // between the gateway and the server is secure.
+               if (!cmd.sslapi.GetCertificate(user))
+                       return;
+
+               WebIRC::FlagMap::const_iterator iter = flags->find("secure");
+               if (iter == flags->end())
+               {
+                       // If this is not set then the connection between the client and
+                       // the gateway is not secure.
+                       cmd.sslapi.nosslext.set(user, 1);
+                       cmd.sslapi.sslext.unset(user);
+                       return;
+               }
+
+               // Create a fake ssl_cert for the user.
+               ssl_cert* cert = new ssl_cert;
+               cert->error = "WebIRC users can not specify valid certs yet";
+               cert->invalid = true;
+               cert->revoked = true;
+               cert->trusted = false;
+               cert->unknownsigner = true;
+               cmd.sslapi.SetCertificate(user, cert);
+       }
 };
 
 MODULE_INIT(ModuleSSLInfo)