]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - src/modules/m_sslinfo.cpp
Make connect class debug logging more complete and consistent.
[user/henk/code/inspircd.git] / src / modules / m_sslinfo.cpp
index 427f3f71c46243b5dca0362a7e9b0189a94626de..0054e3ed7d46ec4e91aff47a311adad2dcf65de8 100644 (file)
@@ -1,7 +1,16 @@
 /*
  * 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-2020 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) 2008 Robin Burchell <robin+git@viroteck.net>
+ *   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
 
 
 #include "inspircd.h"
-#include "ssl.h"
+#include "modules/ssl.h"
+#include "modules/webirc.h"
+#include "modules/whois.h"
+#include "modules/who.h"
 
-/* $ModDesc: Provides SSL metadata, including /WHOIS information and /SSLINFO command */
+enum
+{
+       // From oftc-hybrid.
+       RPL_WHOISCERTFP = 276,
+
+       // From UnrealIRCd.
+       RPL_WHOISSECURE = 671
+};
 
-class SSLCertExt : public ExtensionItem {
+class SSLCertExt : public ExtensionItem
+{
  public:
-       SSLCertExt(Module* parent) : ExtensionItem("ssl_cert", parent) {}
+       SSLCertExt(Module* parent)
+               : ExtensionItem("ssl_cert", ExtensionItem::EXT_USER, parent)
+       {
+       }
+
        ssl_cert* get(const Extensible* item) const
        {
                return static_cast<ssl_cert*>(get_raw(item));
        }
+
        void set(Extensible* item, ssl_cert* value)
        {
                value->refcount_inc();
@@ -37,12 +62,17 @@ class SSLCertExt : public ExtensionItem {
                        delete old;
        }
 
-       std::string serialize(SerializeFormat format, const Extensible* container, void* item) const
+       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)
+       void FromNetwork(Extensible* container, const std::string& value) CXX11_OVERRIDE
        {
                ssl_cert* cert = new ssl_cert;
                set(container, cert);
@@ -67,7 +97,7 @@ class SSLCertExt : public ExtensionItem {
                }
        }
 
-       void free(void* item)
+       void free(Extensible* container, void* item) CXX11_OVERRIDE
        {
                ssl_cert* old = static_cast<ssl_cert*>(item);
                if (old && old->refcount_dec())
@@ -75,125 +105,172 @@ class SSLCertExt : public ExtensionItem {
        }
 };
 
-/** Handle /SSLINFO
- */
+class UserCertificateAPIImpl : public UserCertificateAPIBase
+{
+ public:
+       LocalIntExt nosslext;
+       SSLCertExt sslext;
+
+       UserCertificateAPIImpl(Module* mod)
+               : UserCertificateAPIBase(mod)
+               , nosslext("no_ssl_cert", ExtensionItem::EXT_USER, mod)
+               , sslext(mod)
+       {
+       }
+
+       ssl_cert* GetCertificate(User* user) CXX11_OVERRIDE
+       {
+               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;
+       }
+
+       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 Command
 {
  public:
-       SSLCertExt CertExt;
+       UserCertificateAPIImpl sslapi;
 
-       CommandSSLInfo(Module* Creator) : Command(Creator, "SSLINFO", 1), CertExt(Creator)
+       CommandSSLInfo(Module* Creator)
+               : Command(Creator, "SSLINFO", 1)
+               , sslapi(Creator)
        {
-               this->syntax = "<nick>";
+               syntax = "<nick>";
        }
 
-       CmdResult Handle (const std::vector<std::string> &parameters, User *user)
+       CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
        {
                User* target = ServerInstance->FindNickOnly(parameters[0]);
 
-               if (!target)
+               if ((!target) || (target->registered != REG_ALL))
                {
-                       user->WriteNumeric(ERR_NOSUCHNICK, "%s %s :No such nickname", user->nick.c_str(), parameters[0].c_str());
+                       user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
                        return CMD_FAILURE;
                }
+
                bool operonlyfp = ServerInstance->Config->ConfValue("sslinfo")->getBool("operonly");
-               if (operonlyfp && !IS_OPER(user) && target != user)
+               if (operonlyfp && !user->IsOper() && target != user)
                {
-                       user->WriteServ("NOTICE %s :*** You cannot view SSL certificate information for other users", user->nick.c_str());
+                       user->WriteNotice("*** You cannot view TLS (SSL) client certificate information for other users");
                        return CMD_FAILURE;
                }
-               ssl_cert* cert = CertExt.get(target);
+
+               ssl_cert* cert = sslapi.GetCertificate(target);
                if (!cert)
                {
-                       user->WriteServ("NOTICE %s :*** No SSL certificate for this user", user->nick.c_str());
+                       user->WriteNotice(InspIRCd::Format("*** %s is not connected using TLS (SSL).", target->nick.c_str()));
                }
                else if (cert->GetError().length())
                {
-                       user->WriteServ("NOTICE %s :*** No SSL certificate information for this user (%s).", user->nick.c_str(), cert->GetError().c_str());
+                       user->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
                {
-                       user->WriteServ("NOTICE %s :*** Distinguished Name: %s", user->nick.c_str(), cert->GetDN().c_str());
-                       user->WriteServ("NOTICE %s :*** Issuer:             %s", user->nick.c_str(), cert->GetIssuer().c_str());
-                       user->WriteServ("NOTICE %s :*** Key Fingerprint:    %s", user->nick.c_str(), cert->GetFingerprint().c_str());
+                       user->WriteNotice("*** Distinguished Name: " + cert->GetDN());
+                       user->WriteNotice("*** Issuer:             " + cert->GetIssuer());
+                       user->WriteNotice("*** Key Fingerprint:    " + cert->GetFingerprint());
                }
+
                return CMD_SUCCESS;
        }
 };
 
-class ModuleSSLInfo : public Module
+class ModuleSSLInfo
+       : public Module
+       , public WebIRC::EventListener
+       , public Whois::EventListener
+       , public Who::EventListener
 {
+ private:
        CommandSSLInfo cmd;
 
- public:
-       ModuleSSLInfo() : cmd(this)
+       bool MatchFP(ssl_cert* const cert, const std::string& fp) const
        {
+               return irc::spacesepstream(fp).Contains(cert->GetFingerprint());
        }
 
-       void init()
+ public:
+       ModuleSSLInfo()
+               : WebIRC::EventListener(this)
+               , Whois::EventListener(this)
+               , Who::EventListener(this)
+               , cmd(this)
        {
-               ServerInstance->AddCommand(&cmd);
-
-               ServerInstance->Extensions.Register(&cmd.CertExt);
-
-               Implementation eventlist[] = { I_OnWhois, I_OnPreCommand, I_OnSetConnectClass, I_OnUserConnect, I_OnPostConnect };
-               ServerInstance->Modules->Attach(eventlist, this, sizeof(eventlist)/sizeof(Implementation));
        }
 
-       Version GetVersion()
+       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(User* source, User* dest)
+       void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
        {
-               ssl_cert* cert = cmd.CertExt.get(dest);
+               ssl_cert* cert = cmd.sslapi.GetCertificate(whois.GetTarget());
                if (cert)
                {
-                       ServerInstance->SendWhoisLine(source, dest, 671, "%s %s :is using a secure connection", source->nick.c_str(), dest->nick.c_str());
+                       whois.SendLine(RPL_WHOISSECURE, "is using a secure connection");
                        bool operonlyfp = ServerInstance->Config->ConfValue("sslinfo")->getBool("operonly");
-                       if ((!operonlyfp || source == dest || IS_OPER(source)) && !cert->fingerprint.empty())
-                               ServerInstance->SendWhoisLine(source, dest, 276, "%s %s :has client certificate fingerprint %s",
-                                       source->nick.c_str(), dest->nick.c_str(), cert->fingerprint.c_str());
+                       if ((!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()));
                }
        }
 
-       bool OneOfMatches(const char* host, const char* ip, const char* hostlist)
+       ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) CXX11_OVERRIDE
        {
-               std::stringstream hl(hostlist);
-               std::string xhost;
-               while (hl >> xhost)
-               {
-                       if (InspIRCd::Match(host, xhost, ascii_case_insensitive_map) || InspIRCd::MatchCIDR(ip, xhost, ascii_case_insensitive_map))
-                       {
-                               return true;
-                       }
-               }
-               return false;
+               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, std::vector<std::string> &parameters, LocalUser *user, bool validated, const std::string &original_line)
+       ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
        {
                if ((command == "OPER") && (validated))
                {
-                       OperIndex::iterator i = ServerInstance->Config->oper_blocks.find(parameters[0]);
+                       ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.find(parameters[0]);
                        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(491, "%s :This oper login requires an SSL connection.", user->nick.c_str());
+                                       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(491, "%s :This oper login requires a matching SSL fingerprint.",user->nick.c_str());
+                                       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;
                                }
                        }
@@ -203,56 +280,98 @@ class ModuleSSLInfo : public Module
                return MOD_RES_PASSTHRU;
        }
 
-       void OnUserConnect(LocalUser* user)
+       void OnPostConnect(User* user) CXX11_OVERRIDE
        {
-               SocketCertificateRequest req(&user->eh, this);
-               if (!req.cert)
+               LocalUser* const localuser = IS_LOCAL(user);
+               if (!localuser)
                        return;
-               cmd.CertExt.set(user, req.cert);
-       }
 
-       void OnPostConnect(User* user)
-       {
-               ssl_cert *cert = cmd.CertExt.get(user);
-               if (!cert || cert->fingerprint.empty())
+               const SSLIOHook* const ssliohook = SSLIOHook::IsSSL(&localuser->eh);
+               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 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
-               for(OperIndex::iterator i = ServerInstance->Config->oper_blocks.begin(); i != ServerInstance->Config->oper_blocks.end(); i++)
+
+               // 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)
+       ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
        {
-               SocketCertificateRequest req(&user->eh, this);
-               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 = (req.cert && req.cert->IsCAVerified());
+                       if (!cert || !cert->IsCAVerified())
+                               error = "a trusted TLS (SSL) client certificate";
                }
                else if (myclass->config->getBool("requiressl"))
                {
-                       ok = (req.cert != NULL);
+                       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 OnRequest(Request& request)
+       void OnWebIRCAuth(LocalUser* user, const WebIRC::FlagMap* flags) CXX11_OVERRIDE
        {
-               if (strcmp("GET_USER_CERT", request.id) == 0)
+               // 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())
                {
-                       UserCertificateRequest& req = static_cast<UserCertificateRequest&>(request);
-                       req.cert = cmd.CertExt.get(req.user);
+                       // 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)
-