2 * InspIRCd -- Internet Relay Chat Daemon
4 * Copyright (C) 2019 linuxdaemon <linuxdaemon.irc@gmail.com>
5 * Copyright (C) 2013, 2017-2019 Sadie Powell <sadie@witchery.services>
6 * Copyright (C) 2013 Christopher 'm4z' Holm <them4z@gmail.com>
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 SSL certificate for %s: %s",
142 user->GetFullHost().c_str(), cert->GetMetaLine().c_str());
143 sslext.set(user, cert);
147 class CommandSSLInfo : public Command
150 UserCertificateAPIImpl sslapi;
152 CommandSSLInfo(Module* Creator)
153 : Command(Creator, "SSLINFO", 1)
156 this->syntax = "<nick>";
159 CmdResult Handle(User* user, const Params& parameters) CXX11_OVERRIDE
161 User* target = ServerInstance->FindNickOnly(parameters[0]);
163 if ((!target) || (target->registered != REG_ALL))
165 user->WriteNumeric(Numerics::NoSuchNick(parameters[0]));
168 bool operonlyfp = ServerInstance->Config->ConfValue("sslinfo")->getBool("operonly");
169 if (operonlyfp && !user->IsOper() && target != user)
171 user->WriteNotice("*** You cannot view SSL certificate information for other users");
174 ssl_cert* cert = sslapi.GetCertificate(target);
177 user->WriteNotice("*** No SSL certificate for this user");
179 else if (cert->GetError().length())
181 user->WriteNotice("*** No SSL certificate information for this user (" + cert->GetError() + ").");
185 user->WriteNotice("*** Distinguished Name: " + cert->GetDN());
186 user->WriteNotice("*** Issuer: " + cert->GetIssuer());
187 user->WriteNotice("*** Key Fingerprint: " + cert->GetFingerprint());
195 , public WebIRC::EventListener
196 , public Whois::EventListener
197 , public Who::EventListener
202 bool MatchFP(ssl_cert* const cert, const std::string& fp) const
204 return irc::spacesepstream(fp).Contains(cert->GetFingerprint());
209 : WebIRC::EventListener(this)
210 , Whois::EventListener(this)
211 , Who::EventListener(this)
216 Version GetVersion() CXX11_OVERRIDE
218 return Version("Provides user SSL information and certificate utilities", VF_VENDOR);
221 void OnWhois(Whois::Context& whois) CXX11_OVERRIDE
223 ssl_cert* cert = cmd.sslapi.GetCertificate(whois.GetTarget());
226 whois.SendLine(RPL_WHOISSECURE, "is using a secure connection");
227 bool operonlyfp = ServerInstance->Config->ConfValue("sslinfo")->getBool("operonly");
228 if ((!operonlyfp || whois.IsSelfWhois() || whois.GetSource()->IsOper()) && !cert->fingerprint.empty())
229 whois.SendLine(RPL_WHOISCERTFP, InspIRCd::Format("has client certificate fingerprint %s", cert->fingerprint.c_str()));
233 ModResult OnWhoLine(const Who::Request& request, LocalUser* source, User* user, Membership* memb, Numeric::Numeric& numeric) CXX11_OVERRIDE
236 if (!request.GetFieldIndex('f', flag_index))
237 return MOD_RES_PASSTHRU;
239 ssl_cert* cert = cmd.sslapi.GetCertificate(user);
241 numeric.GetParams()[flag_index].push_back('s');
243 return MOD_RES_PASSTHRU;
246 ModResult OnPreCommand(std::string& command, CommandBase::Params& parameters, LocalUser* user, bool validated) CXX11_OVERRIDE
248 if ((command == "OPER") && (validated))
250 ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.find(parameters[0]);
251 if (i != ServerInstance->Config->oper_blocks.end())
253 OperInfo* ifo = i->second;
254 ssl_cert* cert = cmd.sslapi.GetCertificate(user);
256 if (ifo->oper_block->getBool("sslonly") && !cert)
258 user->WriteNumeric(ERR_NOOPERHOST, "This oper login requires an SSL connection.");
259 user->CommandFloodPenalty += 10000;
263 std::string fingerprint;
264 if (ifo->oper_block->readString("fingerprint", fingerprint) && (!cert || !MatchFP(cert, fingerprint)))
266 user->WriteNumeric(ERR_NOOPERHOST, "This oper login requires a matching SSL certificate fingerprint.");
267 user->CommandFloodPenalty += 10000;
273 // Let core handle it for extra stuff
274 return MOD_RES_PASSTHRU;
277 void OnPostConnect(User* user) CXX11_OVERRIDE
279 LocalUser* const localuser = IS_LOCAL(user);
283 const SSLIOHook* const ssliohook = SSLIOHook::IsSSL(&localuser->eh);
284 if (!ssliohook || cmd.sslapi.nosslext.get(localuser))
287 ssl_cert* const cert = ssliohook->GetCertificate();
290 std::string text = "*** You are connected to ";
291 if (!ssliohook->GetServerName(text))
292 text.append(ServerInstance->Config->ServerName);
293 text.append(" using SSL cipher '");
294 ssliohook->GetCiphersuite(text);
295 text.push_back('\'');
296 if ((cert) && (!cert->GetFingerprint().empty()))
297 text.append(" and your SSL certificate fingerprint is ").append(cert->GetFingerprint());
298 user->WriteNotice(text);
303 // find an auto-oper block for this user
304 for (ServerConfig::OperIndex::const_iterator i = ServerInstance->Config->oper_blocks.begin(); i != ServerInstance->Config->oper_blocks.end(); ++i)
306 OperInfo* ifo = i->second;
307 std::string fp = ifo->oper_block->getString("fingerprint");
308 if (MatchFP(cert, fp) && ifo->oper_block->getBool("autologin"))
313 ModResult OnSetConnectClass(LocalUser* user, ConnectClass* myclass) CXX11_OVERRIDE
315 ssl_cert* cert = cmd.sslapi.GetCertificate(user);
317 const std::string requiressl = myclass->config->getString("requiressl");
318 if (stdalgo::string::equalsci(requiressl, "trusted"))
320 ok = (cert && cert->IsCAVerified());
321 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class requires a trusted SSL cert. Client %s one.", (ok ? "has" : "does not have"));
323 else if (myclass->config->getBool("requiressl"))
326 ServerInstance->Logs->Log("CONNECTCLASS", LOG_DEBUG, "Class requires SSL. Client %s using SSL.", (ok ? "is" : "is not"));
331 return MOD_RES_PASSTHRU;
334 void OnWebIRCAuth(LocalUser* user, const WebIRC::FlagMap* flags) CXX11_OVERRIDE
336 // We are only interested in connection flags. If none have been
337 // given then we have nothing to do.
341 // We only care about the tls connection flag if the connection
342 // between the gateway and the server is secure.
343 if (!cmd.sslapi.GetCertificate(user))
346 WebIRC::FlagMap::const_iterator iter = flags->find("secure");
347 if (iter == flags->end())
349 // If this is not set then the connection between the client and
350 // the gateway is not secure.
351 cmd.sslapi.nosslext.set(user, 1);
352 cmd.sslapi.sslext.unset(user);
356 // Create a fake ssl_cert for the user.
357 ssl_cert* cert = new ssl_cert;
358 cert->error = "WebIRC users can not specify valid certs yet";
359 cert->invalid = true;
360 cert->revoked = true;
361 cert->trusted = false;
362 cert->unknownsigner = true;
363 cmd.sslapi.SetCertificate(user, cert);
367 MODULE_INIT(ModuleSSLInfo)