2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2020 Matt Schatz <genius3000@g3k.solutions>
5 * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
6 * Copyright (C) 2013, 2017-2020 Sadie Powell <sadie@witchery.services>
7 * Copyright (C) 2012-2016 Attila Molnar <attilamolnar@hush.com>
8 * Copyright (C) 2012 Robby <robby@chatbelgie.be>
9 * Copyright (C) 2010 Adam <Adam@anope.org>
10 * Copyright (C) 2009-2010 Daniel De Graaf <danieldg@inspircd.org>
11 * Copyright (C) 2008 Robin Burchell <robin+git@viroteck.net>
12 * Copyright (C) 2007 Dennis Friis <peavey@inspircd.org>
13 * Copyright (C) 2006-2007, 2009-2010 Craig Edwards <brain@inspircd.org>
15 * This file is part of InspIRCd. InspIRCd is free software: you can
16 * redistribute it and/or modify it under the terms of the GNU General Public
17 * License as published by the Free Software Foundation, version 2.
19 * This program is distributed in the hope that it will be useful, but WITHOUT
20 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
21 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
24 * You should have received a copy of the GNU General Public License
25 * along with this program. If not, see <http://www.gnu.org/licenses/>.
30 #include "modules/ssl.h"
31 #include "modules/webirc.h"
32 #include "modules/whois.h"
33 #include "modules/who.h"
38 RPL_WHOISCERTFP = 276,
44 class SSLCertExt : public ExtensionItem
47 SSLCertExt(Module* parent)
48 : ExtensionItem("ssl_cert", ExtensionItem::EXT_USER, parent)
52 ssl_cert* get(const Extensible* item) const
54 return static_cast<ssl_cert*>(get_raw(item));
57 void set(Extensible* item, ssl_cert* value)
59 value->refcount_inc();
60 ssl_cert* old = static_cast<ssl_cert*>(set_raw(item, value));
61 if (old && old->refcount_dec())
65 void unset(Extensible* container)
67 free(container, unset_raw(container));
70 std::string ToNetwork(const Extensible* container, void* item) const CXX11_OVERRIDE
72 return static_cast<ssl_cert*>(item)->GetMetaLine();
75 void FromNetwork(Extensible* container, const std::string& value) CXX11_OVERRIDE
77 ssl_cert* cert = new ssl_cert;
80 std::stringstream s(value);
84 cert->invalid = (v.find('v') != std::string::npos);
85 cert->trusted = (v.find('T') != std::string::npos);
86 cert->revoked = (v.find('R') != std::string::npos);
87 cert->unknownsigner = (v.find('s') != std::string::npos);
88 if (v.find('E') != std::string::npos)
90 getline(s,cert->error,'\n');
94 getline(s,cert->fingerprint,' ');
95 getline(s,cert->dn,' ');
96 getline(s,cert->issuer,'\n');
100 void free(Extensible* container, void* item) CXX11_OVERRIDE
102 ssl_cert* old = static_cast<ssl_cert*>(item);
103 if (old && old->refcount_dec())
108 class UserCertificateAPIImpl : public UserCertificateAPIBase
111 LocalIntExt nosslext;
114 UserCertificateAPIImpl(Module* mod)
115 : UserCertificateAPIBase(mod)
116 , nosslext("no_ssl_cert", ExtensionItem::EXT_USER, mod)
121 ssl_cert* GetCertificate(User* user) CXX11_OVERRIDE
123 ssl_cert* cert = sslext.get(user);
127 LocalUser* luser = IS_LOCAL(user);
128 if (!luser || nosslext.get(luser))
131 cert = SSLClientCert::GetCertificate(&luser->eh);
135 SetCertificate(user, cert);
139 void SetCertificate(User* user, ssl_cert* cert) CXX11_OVERRIDE
141 ServerInstance->Logs->Log(MODNAME, LOG_DEBUG, "Setting TLS (SSL) client certificate for %s: %s",
142 user->GetFullHost().c_str(), cert->GetMetaLine().c_str());
143 sslext.set(user, cert);
147 class CommandSSLInfo : public SplitCommand
150 ChanModeReference sslonlymode;
152 void HandleUserInternal(LocalUser* source, User* target, bool verbose)
154 ssl_cert* cert = sslapi.GetCertificate(target);
157 source->WriteNotice(InspIRCd::Format("*** %s is not connected using TLS (SSL).", target->nick.c_str()));
159 else if (cert->GetError().length())
161 source->WriteNotice(InspIRCd::Format("*** %s is connected using TLS (SSL) but has not specified a valid client certificate (%s).",
162 target->nick.c_str(), cert->GetError().c_str()));
166 source->WriteNotice(InspIRCd::Format("*** %s is connected using TLS (SSL) with a valid client certificate (%s).",
167 target->nick.c_str(), cert->GetFingerprint().c_str()));
171 source->WriteNotice("*** Distinguished Name: " + cert->GetDN());
172 source->WriteNotice("*** Issuer: " + cert->GetIssuer());
173 source->WriteNotice("*** Key Fingerprint: " + cert->GetFingerprint());
177 CmdResult HandleChannel(LocalUser* source, const std::string& channel)
179 Channel* chan = ServerInstance->FindChan(channel);
182 source->WriteNumeric(Numerics::NoSuchChannel(channel));
186 if (operonlyfp && !source->IsOper())
188 source->WriteNumeric(ERR_NOPRIVILEGES, "You must be a server operator to view TLS (SSL) client certificate information for channels.");
192 if (!source->IsOper() && chan->GetPrefixValue(source) < OP_VALUE)
194 source->WriteNumeric(ERR_CHANOPRIVSNEEDED, chan->name, "You must be a channel operator.");
200 source->WriteNotice(InspIRCd::Format("*** %s %s have channel mode +%c (%s) set.",
201 chan->name.c_str(), chan->IsModeSet(sslonlymode) ? "does" : "does not",
202 sslonlymode->GetModeChar(), sslonlymode->name.c_str()));
205 const Channel::MemberMap& userlist = chan->GetUsers();
206 for (Channel::MemberMap::const_iterator i = userlist.begin(); i != userlist.end(); ++i)
207 HandleUserInternal(source, i->first, false);
213 UserCertificateAPIImpl sslapi;
216 CommandSSLInfo(Module* Creator)
217 : SplitCommand(Creator, "SSLINFO", 1)
218 , sslonlymode(Creator, "sslonly")
221 allow_empty_last_param = false;
222 syntax = "<channel|nick>";
225 CmdResult HandleLocal(LocalUser* user, const Params& parameters) CXX11_OVERRIDE
227 if (ServerInstance->IsChannel(parameters[0]))
228 return HandleChannel(user, parameters[0]);
230 User* target = ServerInstance->FindNickOnly(parameters[0]);
231 if ((!target) || (target->registered != REG_ALL))
233 user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
237 if (operonlyfp && !user->IsOper() && target != user)
239 user->WriteNotice("*** You cannot view TLS (SSL) client certificate information for other users");
243 HandleUserInternal(user, target, true);
250 , public WebIRC::EventListener
251 , public Whois::EventListener
252 , public Who::EventListener
257 bool MatchFP(ssl_cert* const cert, const std::string& fp) const
259 return irc::spacesepstream(fp).Contains(cert->GetFingerprint());
264 : WebIRC::EventListener(this)
265 , Whois::EventListener(this)
266 , Who::EventListener(this)
271 void ReadConfig(ConfigStatus& status) CXX11_OVERRIDE
273 ConfigTag* tag = ServerInstance->Config->ConfValue("sslinfo");
274 cmd.operonlyfp = tag->getBool("operonly");
277 Version GetVersion() CXX11_OVERRIDE
279 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);
282 void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
284 ssl_cert* cert = cmd.sslapi.GetCertificate(whois.GetTarget());
287 whois.SendLine(RPL_WHOISSECURE, "is using a secure connection");
288 if ((!cmd.operonlyfp || whois.IsSelfWhois() || whois.GetSource()->IsOper()) && !cert->fingerprint.empty())
289 whois.SendLine(RPL_WHOISCERTFP, InspIRCd::Format("has TLS (SSL) client certificate fingerprint %s", cert->fingerprint.c_str()));
293 ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) CXX11_OVERRIDE
296 if (!request.GetFieldIndex('f', flag_index))
297 return MOD_RES_PASSTHRU;
299 ssl_cert* cert = cmd.sslapi.GetCertificate(user);
301 numeric.GetParams()[flag_index].push_back('s');
303 return MOD_RES_PASSTHRU;
306 ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
308 if ((command == "OPER") && (validated))
310 ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.find(parameters[0]);
311 if (i != ServerInstance->Config->oper_blocks.end())
313 OperInfo* ifo = i->second;
314 ssl_cert* cert = cmd.sslapi.GetCertificate(user);
316 if (ifo->oper_block->getBool("sslonly") && !cert)
318 user->WriteNumeric(ERR_NOOPERHOST, "Invalid oper credentials");
319 user->CommandFloodPenalty += 10000;
320 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());
324 std::string fingerprint;
325 if (ifo->oper_block->readString("fingerprint", fingerprint) && (!cert || !MatchFP(cert, fingerprint)))
327 user->WriteNumeric(ERR_NOOPERHOST, "Invalid oper credentials");
328 user->CommandFloodPenalty += 10000;
329 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());
335 // Let core handle it for extra stuff
336 return MOD_RES_PASSTHRU;
339 void OnPostConnect(User* user) CXX11_OVERRIDE
341 LocalUser* const localuser = IS_LOCAL(user);
345 const SSLIOHook* const ssliohook = SSLIOHook::IsSSL(&localuser->eh);
346 if (!ssliohook || cmd.sslapi.nosslext.get(localuser))
349 ssl_cert* const cert = ssliohook->GetCertificate();
351 std::string text = "*** You are connected to ";
352 if (!ssliohook->GetServerName(text))
353 text.append(ServerInstance->Config->GetServerName());
354 text.append(" using TLS (SSL) cipher '");
355 ssliohook->GetCiphersuite(text);
356 text.push_back('\'');
357 if (cert && !cert->GetFingerprint().empty())
358 text.append(" and your TLS (SSL) client certificate fingerprint is ").append(cert->GetFingerprint());
359 user->WriteNotice(text);
364 // Find an auto-oper block for this user
365 for (ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.begin(); i != ServerInstance->Config->oper_blocks.end(); ++i)
367 OperInfo* ifo = i->second;
368 std::string fp = ifo->oper_block->getString("fingerprint");
369 if (MatchFP(cert, fp) && ifo->oper_block->getBool("autologin"))
374 ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
376 ssl_cert* cert = cmd.sslapi.GetCertificate(user);
377 const char* error = NULL;
378 const std::string requiressl = myclass->config->getString("requiressl");
379 if (stdalgo::string::equalsci(requiressl, "trusted"))
381 if (!cert || !cert->IsCAVerified())
382 error = "a trusted TLS (SSL) client certificate";
384 else if (myclass->config->getBool("requiressl"))
387 error = "a TLS (SSL) connection";
392 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "The %s connect class is not suitable as it requires %s",
393 myclass->GetName().c_str(), error);
397 return MOD_RES_PASSTHRU;
400 void OnWebIRCAuth(LocalUser* user, const WebIRC::FlagMap* flags) CXX11_OVERRIDE
402 // We are only interested in connection flags. If none have been
403 // given then we have nothing to do.
407 // We only care about the tls connection flag if the connection
408 // between the gateway and the server is secure.
409 if (!cmd.sslapi.GetCertificate(user))
412 WebIRC::FlagMap::const_iterator iter = flags->find("secure");
413 if (iter == flags->end())
415 // If this is not set then the connection between the client and
416 // the gateway is not secure.
417 cmd.sslapi.nosslext.set(user, 1);
418 cmd.sslapi.sslext.unset(user);
422 // Create a fake ssl_cert for the user.
423 ssl_cert* cert = new ssl_cert;
424 cert->error = "WebIRC users can not specify valid certs yet";
425 cert->invalid = true;
426 cert->revoked = true;
427 cert->trusted = false;
428 cert->unknownsigner = true;
429 cmd.sslapi.SetCertificate(user, cert);
433 MODULE_INIT(ModuleSSLInfo)