/* * InspIRCd -- Internet Relay Chat Daemon * * Copyright (C) 2021 Molly Miller * Copyright (C) 2020 Matt Schatz * Copyright (C) 2019 linuxdaemon * Copyright (C) 2013, 2017-2021 Sadie Powell * Copyright (C) 2012-2016 Attila Molnar * Copyright (C) 2012 Robby * Copyright (C) 2010 Adam * Copyright (C) 2009-2010 Daniel De Graaf * Copyright (C) 2007 Dennis Friis * Copyright (C) 2006-2007, 2009-2010 Craig Edwards * * 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 "modules/ssl.h" #include "modules/webirc.h" #include "modules/whois.h" #include "modules/who.h" class SSLCertExt : public ExtensionItem { public: SSLCertExt(Module* parent) : ExtensionItem(parent, "ssl_cert", ExtensionItem::EXT_USER) { } ssl_cert* Get(const Extensible* item) const { return static_cast(GetRaw(item)); } void Set(Extensible* item, ssl_cert* value, bool sync = true) { value->refcount_inc(); ssl_cert* old = static_cast(SetRaw(item, value)); if (old && old->refcount_dec()) delete old; if (sync) Sync(item, value); } void Unset(Extensible* container) { Delete(container, UnsetRaw(container)); } std::string ToNetwork(const Extensible* container, void* item) const noexcept override { const ssl_cert* cert = static_cast(item); std::stringstream value; value << (cert->IsInvalid() ? "v" : "V") << (cert->IsTrusted() ? "T" : "t") << (cert->IsRevoked() ? "R" : "r") << (cert->IsUnknownSigner() ? "s" : "S") << (cert->GetError().empty() ? "e" : "E") << " "; if (cert->GetError().empty()) value << cert->GetFingerprint() << " " << cert->GetDN() << " " << cert->GetIssuer(); else value << cert->GetError(); return value.str(); } void FromNetwork(Extensible* container, const std::string& value) noexcept override { ssl_cert* cert = new ssl_cert; Set(container, cert, false); std::stringstream s(value); std::string v; getline(s,v,' '); cert->invalid = (v.find('v') != std::string::npos); cert->trusted = (v.find('T') != std::string::npos); cert->revoked = (v.find('R') != std::string::npos); cert->unknownsigner = (v.find('s') != std::string::npos); if (v.find('E') != std::string::npos) { getline(s,cert->error,'\n'); } else { getline(s,cert->fingerprint,' '); getline(s,cert->dn,' '); getline(s,cert->issuer,'\n'); } } void Delete(Extensible* container, void* item) override { ssl_cert* old = static_cast(item); if (old && old->refcount_dec()) delete old; } }; class UserCertificateAPIImpl : public UserCertificateAPIBase { public: BoolExtItem nosslext; SSLCertExt sslext; UserCertificateAPIImpl(Module* mod) : UserCertificateAPIBase(mod) , nosslext(mod, "no_ssl_cert", ExtensionItem::EXT_USER) , sslext(mod) { } ssl_cert* GetCertificate(User* user) 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) override { ServerInstance->Logs.Log(MODNAME, LOG_DEBUG, "Setting TLS client certificate for %s: %s", user->GetFullHost().c_str(), sslext.ToNetwork(user, cert).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.", target->nick.c_str())); } else if (cert->GetError().length()) { source->WriteNotice(InspIRCd::Format("*** %s is connected using TLS 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 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->Users.FindNick(nick); if (!target || target->registered != REG_ALL) { source->WriteNumeric(Numerics::NoSuchNick(nick)); return CmdResult::FAILURE; } if (operonlyfp && !source->IsOper() && source != target) { source->WriteNumeric(ERR_NOPRIVILEGES, "You must be a server operator to view TLS client certificate information for other users."); return CmdResult::FAILURE; } HandleUserInternal(source, target, true); return CmdResult::SUCCESS; } CmdResult HandleChannel(LocalUser* source, const std::string& channel) { Channel* chan = ServerInstance->Channels.Find(channel); if (!chan) { source->WriteNumeric(Numerics::NoSuchChannel(channel)); return CmdResult::FAILURE; } if (operonlyfp && !source->IsOper()) { source->WriteNumeric(ERR_NOPRIVILEGES, "You must be a server operator to view TLS client certificate information for channels."); return CmdResult::FAILURE; } if (!source->IsOper() && chan->GetPrefixValue(source) < OP_VALUE) { source->WriteNumeric(ERR_CHANOPRIVSNEEDED, chan->name, "You must be a channel operator."); return CmdResult::FAILURE; } if (sslonlymode) { 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())); } for (const auto& [u, _] : chan->GetUsers()) { if (!u->server->IsService()) HandleUserInternal(source, u, false); } return CmdResult::SUCCESS; } public: UserCertificateAPIImpl sslapi; bool operonlyfp; CommandSSLInfo(Module* Creator) : SplitCommand(Creator, "SSLINFO", 1) , sslonlymode(Creator, "sslonly") , sslapi(Creator) { allow_empty_last_param = false; syntax = { "" }; } CmdResult HandleLocal(LocalUser* user, const Params& parameters) override { if (ServerInstance->Channels.IsPrefix(parameters[0][0])) return HandleChannel(user, parameters[0]); else return HandleUser(user, parameters[0]); } }; class ModuleSSLInfo : public Module , public WebIRC::EventListener , public Whois::EventListener , public Who::EventListener { private: CommandSSLInfo cmd; bool MatchFP(ssl_cert* const cert, const std::string& fp) const { return irc::spacesepstream(fp).Contains(cert->GetFingerprint()); } public: ModuleSSLInfo() : Module(VF_VENDOR, "Adds user facing TLS information, various TLS configuration options, and the /SSLINFO command to look up TLS certificate information for other users.") , WebIRC::EventListener(this) , Whois::EventListener(this) , Who::EventListener(this) , cmd(this) { } void ReadConfig(ConfigStatus& status) override { auto tag = ServerInstance->Config->ConfValue("sslinfo"); cmd.operonlyfp = tag->getBool("operonly"); } void OnWhois(Whois::Context& whois) override { ssl_cert* cert = cmd.sslapi.GetCertificate(whois.GetTarget()); if (cert) { whois.SendLine(RPL_WHOISSECURE, "is using a secure connection"); if ((!cmd.operonlyfp || whois.IsSelfWhois() || whois.GetSource()->IsOper()) && !cert->fingerprint.empty()) whois.SendLine(RPL_WHOISCERTFP, InspIRCd::Format("has TLS client certificate fingerprint %s", cert->fingerprint.c_str())); } } ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) 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) override { if ((command == "OPER") && (validated)) { ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.find(parameters[0]); if (i != ServerInstance->Config->oper_blocks.end()) { std::shared_ptr ifo = i->second; ssl_cert* cert = cmd.sslapi.GetCertificate(user); if (ifo->oper_block->getBool("sslonly") && !cert) { 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 || !MatchFP(cert, 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 client certificate fingerprint does not match.", user->GetFullRealHost().c_str(), parameters[0].c_str()); return MOD_RES_DENY; } } } // Let core handle it for extra stuff return MOD_RES_PASSTHRU; } void OnPostConnect(User* user) override { LocalUser* const localuser = IS_LOCAL(user); if (!localuser) return; 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->GetServerName()); text.append(" using TLS cipher '"); ssliohook->GetCiphersuite(text); text.push_back('\''); if (cert && !cert->GetFingerprint().empty()) text.append(" and your TLS client certificate fingerprint is ").append(cert->GetFingerprint()); user->WriteNotice(text); if (!cert) return; // Find an auto-oper block for this user for (const auto& [_, info] : ServerInstance->Config->oper_blocks) { auto oper = info->oper_block; if (!oper->getBool("autologin")) continue; // No autologin for this block. if (!InspIRCd::MatchMask(oper->getString("host"), localuser->MakeHost(), localuser->MakeHostIP())) continue; // Host doesn't match. if (!MatchFP(cert, oper->getString("fingerprint"))) continue; // Fingerprint doesn't match. user->Oper(info); } } ModResult OnSetConnectClass(LocalUser* user, std::shared_ptr myclass) override { 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")) { if (!cert || !cert->IsCAVerified()) error = "a trusted TLS client certificate"; } else if (myclass->config->getBool("requiressl")) { if (!cert) error = "a TLS connection"; } 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) 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); 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)